Doc bits.
authorJesus Climent <mooch@debian.org>
Mon, 17 Apr 2006 22:47:23 +0000 (22:47 +0000)
committerJesus Climent <mooch@debian.org>
Mon, 17 Apr 2006 22:47:23 +0000 (22:47 +0000)
Default to builtin implementation of cue2discid.
debian/* updates.

FAQ
README
abcde
abcde.1
debian/changelog

diff --git a/FAQ b/FAQ
index a0a1baf..3c054dc 100644 (file)
--- a/FAQ
+++ b/FAQ
@@ -114,13 +114,13 @@ A. Use the OUTPUT variable in PLAYLISTFORMAT and OUTPUTFORMAT. It holds the
 
 Q. I have a CD with a data track, and abcde complaints it cannot read/encode
    it.
 
 Q. I have a CD with a data track, and abcde complaints it cannot read/encode
    it.
-A. It is not easy to find a data track on a CD. Right now, I can only think
+A. From version 2.2 onwards, abcde includes some checkings with cdparanoia, to
+   try to get this right.
+   (It is not easy to find a data track on a CD. Right now, I can only think
    of getting the track info from CDDB and ask the user for continuing should
    a "data" track name is found. But the solution is far from been optimal.
    For now, if you find a "data" track and you know the number, restart abcde
    of getting the track info from CDDB and ask the user for continuing should
    a "data" track name is found. But the solution is far from been optimal.
    For now, if you find a "data" track and you know the number, restart abcde
-   specifying the tracks to be encoded, leaving out the data one.
-   From version 2.2 onwards, abcde includes some checkings with cdparanoia, to
-   try to get this right.
+   specifying the tracks to be encoded, leaving out the data one).
 
 Q. I am requested to have "eject" when setting the speed although I do not use
    it for anything.
 
 Q. I am requested to have "eject" when setting the speed although I do not use
    it for anything.
@@ -149,6 +149,13 @@ Q. I have a live concert. I want to encode it in a single file. How do i do it?
 A. Use "-1" and it will be encoded in a single file. Use "-M" to make a CUE
    sheet file where the information about the tracks is stored.
 
 A. Use "-1" and it will be encoded in a single file. Use "-M" to make a CUE
    sheet file where the information about the tracks is stored.
 
+Q. Can I use abcde to take a backup of my CD collection?
+A. Yes. Use "abcde -1 -o flac -M" and it will create a single-track FLAC file
+   with an embedded cuesheet. Later on, you can use the command
+   "abcde -o vorbis -d flac-file.flac" to extract the individual tracks in
+   Ogg/Vorbis format. Of course you can select whatever format you want.
+   
+
 3. CDDB
    ====
 
 3. CDDB
    ====
 
diff --git a/README b/README
index 65393ba..dec7fd8 100644 (file)
--- a/README
+++ b/README
@@ -31,13 +31,15 @@ Changes in 2.4:
   single BACKUP flag is most likely needed to use all the needed flags:
   "abcde -1 -M -o flac"
 * Added the possibility of using a singletrack flac file with an embeded
   single BACKUP flag is most likely needed to use all the needed flags:
   "abcde -1 -M -o flac"
 * Added the possibility of using a singletrack flac file with an embeded
-  cuesheet as a source to extract tracks from.
+  cuesheet as a source to extract tracks from (use -X to specify an external
+  CUE2DISCID implementation; check under examples in the distributed source
+  code or package).
 * Added replaygain for Ogg/Vorbis and Ogg/FLAC.
 * Added M4A encoding.
 * Uses the default found $CDROMREADER instead of forcing cdparanoia when
   cdda2wav is installed.
 * BATCH mode has been splitted into two options: BATCHNORM and NOGAP.
 * Added replaygain for Ogg/Vorbis and Ogg/FLAC.
 * Added M4A encoding.
 * Uses the default found $CDROMREADER instead of forcing cdparanoia when
   cdda2wav is installed.
 * BATCH mode has been splitted into two options: BATCHNORM and NOGAP.
-* Added -u option for UNICODE (UTF-8) tag encoding.
+* Added -U option for non-UNICODE (UTF-8) tag encoding.
 * Added -z for debug.
 * Added -f to force the removal of left files.
  
 * Added -z for debug.
 * Added -f to force the removal of left files.
  
@@ -200,11 +202,12 @@ abcde requires the following backend tools to work:
     http://www.iis.fhg.de/amm/download/ or:
 * FLAC encoder (flac) or:
 * Ogg/Speex encoder (speexenc) or:
     http://www.iis.fhg.de/amm/download/ or:
 * FLAC encoder (flac) or:
 * Ogg/Speex encoder (speexenc) or:
-* MPP/MP+(Musepack) encoder (mppenc)
+* MPP/MP+(Musepack) encoder (mppenc) or:
+* AAC encoder (faac)
 * normalize-audio for volume normalization.
 * normalize-audio for volume normalization.
-* CD Paranoia, an audio CD reading utility,
-* Or cdda2wav, the audio CD reading utility cdparanoia was born from,
-* Or dagrab, another audio CD reading utility.
+* CD Paranoia, an audio CD reading utility or:
+* cdda2wav, the audio CD reading utility cdparanoia was born from or:
+* dagrab, another audio CD reading utility.
 * cd-discid, a CDDB DiscID reading program. Formerly bundled with abcde.
   It's available in Debian or http://www.hispalinux.es/~data/files/cd-discid/
 * An HTTP retrieval program: wget, fetch (FreeBSD) or curl (MacOSX)
 * cd-discid, a CDDB DiscID reading program. Formerly bundled with abcde.
   It's available in Debian or http://www.hispalinux.es/~data/files/cd-discid/
 * An HTTP retrieval program: wget, fetch (FreeBSD) or curl (MacOSX)
diff --git a/abcde b/abcde
index c7f5642..1ad68b6 100755 (executable)
--- a/abcde
+++ b/abcde
@@ -1510,6 +1510,7 @@ do_discid ()
                                if $METAFLAC $METAFLACOPTS --export-cuesheet-to=- "$CDROM" > /dev/null 2>&1 ; then
                                        case "$CUE2DISCID" in
                                                builtin)
                                if $METAFLAC $METAFLACOPTS --export-cuesheet-to=- "$CDROM" > /dev/null 2>&1 ; then
                                        case "$CUE2DISCID" in
                                                builtin)
+                                                       #vecho "Using builtin cue2discid implementation..."
                                                        CUESHEET="$(metaflac $METAFLACOPTS --export-cuesheet-to=- "$CDROM")"
 
                                                        #TRACKS=$(echo $CUESHEET | egrep "TRACK \+[[:digit:]]\+ \+AUDIO" |wc -l)
                                                        CUESHEET="$(metaflac $METAFLACOPTS --export-cuesheet-to=- "$CDROM")"
 
                                                        #TRACKS=$(echo $CUESHEET | egrep "TRACK \+[[:digit:]]\+ \+AUDIO" |wc -l)
@@ -1528,6 +1529,7 @@ do_discid ()
                                                        makeids
                                                ;;
                                                *)
                                                        makeids
                                                ;;
                                                *)
+                                                       #vecho "Using external python cue2discid implementation..."
                                                        TRACKINFO=$($METAFLAC $METAFLACOPTS --export-cuesheet-to=- "$CDROM" | $CUE2DISCID)
                                                ;;
                                        esac
                                                        TRACKINFO=$($METAFLAC $METAFLACOPTS --export-cuesheet-to=- "$CDROM" | $CUE2DISCID)
                                                ;;
                                        esac
@@ -2771,7 +2773,7 @@ MPPGAIN=replaygain
 MKCUE=mkcue
 MKTOC=cdrdao
 DIFF=diff
 MKCUE=mkcue
 MKTOC=cdrdao
 DIFF=diff
-CUE2DISCID=cue2discid
+CUE2DISCID=builtin
 
 # Options for programs called from abcde
 # mp3
 
 # Options for programs called from abcde
 # mp3
@@ -2911,7 +2913,7 @@ fi
 
 # Parse command line options
 #while getopts 1a:bc:C:d:Dehj:klLmMnNo:pPr:Rs:S:t:T:vVxw:W: opt ; do
 
 # Parse command line options
 #while getopts 1a:bc:C:d:Dehj:klLmMnNo:pPr:Rs:S:t:T:vVxw:W: opt ; do
-while getopts 1a:bBc:C:d:Defghj:klLmMnNo:pPr:s:S:t:T:uvVxw:W:z opt ; do
+while getopts 1a:bBc:C:d:Defghj:klLmMnNo:pPr:s:S:t:T:uvVxX:w:W:z opt ; do
        case "$opt" in
                1) ONETRACK=y ;;
                a) ACTIONS="$OPTARG" ;;
        case "$opt" in
                1) ONETRACK=y ;;
                a) ACTIONS="$OPTARG" ;;
@@ -2955,6 +2957,7 @@ while getopts 1a:bBc:C:d:Defghj:klLmMnNo:pPr:s:S:t:T:uvVxw:W:z opt ; do
                   ;;
                V) EXTRAVERBOSE="y" ;;
                x) EJECTCD="y" ;;
                   ;;
                V) EXTRAVERBOSE="y" ;;
                x) EJECTCD="y" ;;
+               X) CUE2DISCID="$OPTARG" ;;
                w) COMMENT="$OPTARG" ;;
                W) if echo $OPTARG | grep "[[:digit:]]" > /dev/null 2>&1 ; then 
                     STARTTRACKNUMBER="${OPTARG}01" ; STARTTRACKNUMBERTAG="y" ; COMMENT="CD${OPTARG}"
                w) COMMENT="$OPTARG" ;;
                W) if echo $OPTARG | grep "[[:digit:]]" > /dev/null 2>&1 ; then 
                     STARTTRACKNUMBER="${OPTARG}01" ; STARTTRACKNUMBERTAG="y" ; COMMENT="CD${OPTARG}"
@@ -2964,7 +2967,6 @@ while getopts 1a:bBc:C:d:Defghj:klLmMnNo:pPr:s:S:t:T:uvVxw:W:z opt ; do
                   fi
                   ;;
                z) DEBUG=y ; CDROMREADERSYNTAX=debug ; EJECTCD="n" ;;
                   fi
                   ;;
                z) DEBUG=y ; CDROMREADERSYNTAX=debug ; EJECTCD="n" ;;
-               Z) CUE2DISCID=builtin;;
                ?) usage; exit ;;
        esac
 done
                ?) usage; exit ;;
        esac
 done
diff --git a/abcde.1 b/abcde.1
index 1e720ff..a43810c 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -39,6 +39,14 @@ Delete the intermediate WAV file (or save it for later use)
 .TP
 .B *
 Repeat until finished
 .TP
 .B *
 Repeat until finished
+.P
+Alternatively, 
+.B abcde
+can also grab a CD and turn it into a single FLAC file with an embedded
+cuesheet which can be user later on as a source for other formats, and will be
+treated as if it was the original CD. In a way,
+.B abcde
+can take a compressed backup of your CD collection.
 .SH OPTIONS
 .TP
 .B \-1
 .SH OPTIONS
 .TP
 .B \-1
@@ -130,7 +138,7 @@ endings. Some hardware players insist on having those to work.
 Create a CUE file with information about the CD. Together with the possibility
 of creating a single file (see option "\-1"), one can recreate the original CD.
 If the cuesheet is embedded in a flac single file it can be used as source for
 Create a CUE file with information about the CD. Together with the possibility
 of creating a single file (see option "\-1"), one can recreate the original CD.
 If the cuesheet is embedded in a flac single file it can be used as source for
-encoding other formats.
+encoding other formats (see option "\-d").
 .TP
 .B \-o [filetype][:filetypeoptions]
 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc",
 .TP
 .B \-o [filetype][:filetypeoptions]
 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc",
@@ -187,6 +195,12 @@ sensation nothing is happening.
 Eject the CD when all tracks have been read. See the EJECTCD configuration
 variable.
 .TP
 Eject the CD when all tracks have been read. See the EJECTCD configuration
 variable.
 .TP
+.B \-X [cue2discid]
+Use an alternative "cue2discid" implementation. The name of the binary must be
+exactly that. abcde comes with an implementation in python under the examples
+directory. The special keyword "builtin" forces the usage of the internal
+(default) implementation in shell script.
+.TP
 .B \-w [comment]
 Add a comment to the tracks ripped from the CD.
 .TP
 .B \-w [comment]
 Add a comment to the tracks ripped from the CD.
 .TP
@@ -350,7 +364,7 @@ respective utilities: LAME, TOOLAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
 VORBIZE, OGGENC, FLAC, SPEEXENC, MPPENC, AACEND, ID3, ID3V2, EYED3, METAFLAC,
 CDPARANOIA, CDDA2WAV, CDDAFS, CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3,
 VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, MPPGAIN, MKCUE, MKTOC,
 VORBIZE, OGGENC, FLAC, SPEEXENC, MPPENC, AACEND, ID3, ID3V2, EYED3, METAFLAC,
 CDPARANOIA, CDDA2WAV, CDDAFS, CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3,
 VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, MPPGAIN, MKCUE, MKTOC,
-DIFF and HTTPGET.
+CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
 .TP
 .B COMMAND-LINE OPTIONS
 If you wish to specify command-line options to any of the programs abcde uses,
 .TP
 .B COMMAND-LINE OPTIONS
 If you wish to specify command-line options to any of the programs abcde uses,
@@ -413,8 +427,13 @@ you can force with
 '-p' in the command line.
 .TP
 .B VAOUTPUTFORMAT
 '-p' in the command line.
 .TP
 .B VAOUTPUTFORMAT
-Just like OUTPUTFORMAT but for Various Artists discs. Default is whatever
-OUTPUTFORMAT is set to.
+Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
+.TP
+.B ONETRACKOUTPUTFORMAT
+Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
+.TP
+.B VAONETRACKOUTPUTFORMAT
+Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
 .TP
 .B MAXPROCS
 Defines how many encoders to run at once. This makes for huge speedups
 .TP
 .B MAXPROCS
 Defines how many encoders to run at once. This makes for huge speedups
index c9d781e..5d6d659 100644 (file)
@@ -12,8 +12,11 @@ abcde (2.3.99.6-1) unstable; urgency=low
   * Updated config file with some new AAC bits.
   * Updated FSF address.
   * Corrected NetBSD options for ftp (Thanks to Marius).
   * Updated config file with some new AAC bits.
   * Updated FSF address.
   * Corrected NetBSD options for ftp (Thanks to Marius).
+  * Added an internal implementation of cue2discid, so there is no need for an
+    external program to do the conversion. Thanks to Michael (sorry, his mail
+    does not have a surname).
 
 
- -- Jesus Climent <jesus.climent@hispalinux.es>  Tue, 11 Apr 2006 14:56:44 +0300
+ -- Jesus Climent <jesus.climent@hispalinux.es>  Tue, 18 Apr 2006 01:09:32 +0300
 
 abcde (2.3.99.5-1) unstable; urgency=low
 
 
 abcde (2.3.99.5-1) unstable; urgency=low