Release 2.3.99.1
[abcde.git] / abcde
1 #!/bin/bash
2 # Copyright (c) 1998-2001 Robert Woodcock <rcw@debian.org>
3 # Copyright (c) 2003-2005 Jesus Climent <jesus.climent@hispalinux.es>
4 # This code is hereby licensed for public consumption under either the
5 # GNU GPL v2 or greater, or Larry Wall's Artistic license - your choice.
6 #
7 # You should have received a copy of the GNU General Public License
8 # along with this program; if not, write to the Free Software
9 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
10 #
11 # Copyright for this work is to expire January 1, 2010, after which it
12 # shall be public domain.
13 #
14 # $Id$
15
16 VERSION='2.3.99-$Revision$'
17
18 usage ()
19 {
20 echo "This is abcde v$VERSION."
21 echo "Usage: abcde [options] [tracks]"
22 echo "Options:"
23 echo "-1     Encode the whole CD in a single file"
24 echo "-a <action1[,action2]...>"
25 echo "       Actions to perform (cddb,read,normalize,encode,tag,move,replaygain,playlist,clean)"
26 #echo "-A     Experimental actions (retag, transcode)"
27 echo "-b     Enable batch normalization"
28 #echo "-B     Disable batch replaygain (do file by file)"
29 echo "-c <file>"
30 echo "       Specify a configuration file (overrides system and user config files)"
31 echo "-C <discid#>"
32 echo "       Specify discid to resume from (only needed if you no longer have the cd)"
33 echo "-d <device>"
34 echo "       Specify CDROM device to grab (flac uses a single-track flac file)"
35 echo "-D     Debugging mode (equivalent to sh -x abcde)"
36 echo "-e     Erase encoded track information from status file"
37 echo "-f     Force operations that otherwise are considered harmful. Read \"man abcde\""
38 echo "-g     Use \"lame --nogap\" for MP3 encoding. Disables low disk and pipes flags"
39 echo "-h     This help information"
40 #echo "-i    Tag files while encoding, when possible (local only) -NWY-"
41 echo "-j <#> Number of encoder processes to run at once (localhost)"
42 echo "-k     Keep the wav tracks for later use"
43 echo "-l     Use low disk space algorithm"
44 echo "-L     Use local CDDB storage directory"
45 echo "-n     No lookup. Don't query CDDB, just create and use template"
46 echo "-N     Noninteractive. Never prompt for anything"
47 echo "-m     Modify playlist to include CRLF endings, to comply with some players"
48 echo "-M     Create a CUE file"
49 echo "-o <type1[,type2]...>"
50 echo "       Output file type(s) (vorbis,mp3,flac,spx,mpc,wav). Defaults to vorbis"
51 echo "-p     Pad track numbers with 0's (if less than 10 tracks)"
52 echo "-P     Use UNIX pipes to read+encode without wav files"
53 echo "-r <host1[,host2]...>"
54 echo "       Also encode on these remote hosts"
55 #echo "-R     Add replaygain values to the tag info (only for vorbis,flac,mp3)"
56 echo "-s <field>"
57 echo "       Show dielfs from the CDDB info (year,genre)"
58 echo "-S <#> Set the CD speed"
59 echo "-t <#> Start the track numbering at a given number"
60 echo "-T <#> Same as -t but modifies tag numbering"
61 echo "-u     Use UNICODE tags and comments"
62 echo "-v     Show version number and exit"
63 echo "-V     Be a bit more verbose about what is happening behind the scenes"
64 echo "-x     Eject CD after all tracks are read"
65 echo "-w <comment>"
66 echo "       Add a comment to the CD tracks"
67 echo "-W <#> Contatenate CDs: -T #01 -w \"CD #\"" 
68 echo "-z     Use debug CDROMREADERSYNTAX option (needs cdparanoia)"
69 echo ""
70 echo "Tracks is a space-delimited list of tracks to grab."
71 echo "Ranges specified with hyphens are allowed (i.e., 1-5)."
72 echo ""
73 #echo "Double hyphens are used to concatenate tracks"
74 }
75
76 addstatus ()
77 {
78         echo "$@" >> "$ABCDETEMPDIR/status"
79 }
80
81 # log [level] [message]
82
83 # log outputs the right message in a common format
84 log ()
85 {
86         BLURB="$1"
87         shift
88         case $BLURB in
89                 error)   echo "[ERROR] abcde: $@" >&2 ;;
90                 warning) echo "[WARNING] $@" >&2 ;;
91                 info)    echo "[INFO] $@" ;;
92         esac
93 }
94
95 # Funtions to replace the need of seq, which is too distribution dependant.
96 f_seq_row ()
97 {
98         i=$1
99         while [ $i -ne `expr $2 + 1` ]
100         do
101                 echo $i
102                 i=`expr $i + 1`
103         done
104 }
105
106 f_seq_line ()
107 {
108         i=$1
109         if echo i | grep -q "[[:digit:]]" ; then
110                 while [ $i -ne `expr $2 + 1` ]
111                 do
112                         printf $i" "
113                         i=`expr $i + 1`
114                 done
115                 echo
116         else
117                 log error "syntax error while processing track numbers"
118                 exit 1
119         fi
120 }
121
122 # Functions to replace the need of awk {print $1} and {print $NF}
123 get_first()
124 {
125 if [ X"$1" = "X" ]; then
126         for first in `cat`; do
127                 break
128         done
129 else
130         first=$1
131 fi
132 echo $first
133 }
134
135 get_last()
136 {
137 if [ X"$1" = "X" ]; then
138         for stdin in `cat`; do
139                 last=$stdin
140         done
141 else
142         for last in $@ ; do :; done
143 fi
144 echo $last
145 }
146
147 # checkstatus [blurb]
148 # Returns "0" if the blurb was found, returns 1 if it wasn't
149 # Puts the blurb content, if available, on stdout.
150 # Otherwise, returns "".
151 checkstatus ()
152 {
153         # Take the last line in the status file if there's multiple matches
154         PATTERN="^$1(=.*)?$"
155         BLURB=$(egrep $PATTERN "$ABCDETEMPDIR/status" | tail -n 1)
156
157         if [ -z "$BLURB" ]; then
158                 # No matches found
159                 return 1
160         else
161                 # Matches found
162                 # See if there's a = in it
163                 if [ "$(echo $BLURB | grep -c =)" != "0" ]; then
164                         echo "$(echo $BLURB | cut -f2- -d=)"
165                 fi
166                 return 0
167         fi
168 }
169
170 # chechwarnings [blurb]
171 # Returns "0" if the blurb was found (meaning there was an warning),
172 # returns 1 if it wasn't (yes this is a little backwards).
173 # Does not print the blurb on stdout.
174 # Otherwise, returns "".
175 checkwarnings ()
176 {
177         if [ -e "$ABCDETEMPDIR/warnings" ]; then :; else
178                 return 1
179         fi
180         # Take the last line in the status file if there's multiple matches
181         PATTERN="^$1(:.*)?$"
182         BLURB="$(egrep $PATTERN "$ABCDETEMPDIR/warnings" | tail -n 1)"
183
184         if [ -z "$BLURB" ]; then
185                 # negative, we did not have a negative...
186                 return 1
187         else
188                 # affirmative, we had a negative...
189                 return 0
190         fi
191 }
192
193 # checkerrors [blurb]
194 # Returns "0" if the blurb was found (meaning there was an error),
195 # returns 1 if it wasn't (yes this is a little backwards).
196 # Does not print the blurb on stdout.
197 # Otherwise, returns "".
198 checkerrors ()
199 {
200         if [ -e "$ABCDETEMPDIR/errors" ]; then :; else
201                 return 1
202         fi
203         # Take the last line in the status file if there's multiple matches
204         PATTERN="^$1(:.*)?$"
205         BLURB="$(egrep $PATTERN "$ABCDETEMPDIR/errors" | tail -n 1)"
206
207         if [ -z "$BLURB" ]; then
208                 # negative, we did not have a negative...
209                 return 1
210         else
211                 # affirmative, we had a negative...
212                 return 0
213         fi
214 }
215
216 # page [file]
217 # Finds the right pager in the system to display a file
218 page ()
219 {
220         PAGEFILE="$1"
221         # Use the debian sensible-pager wrapper to pick the pager
222         # user has requested via their $PAGER environment variable
223         if [ -x "/usr/bin/sensible-pager" ]; then
224                 /usr/bin/sensible-pager "$PAGEFILE"
225         elif [ -x "$PAGER" ]; then
226                 # That failed, try to load the preferred editor, starting
227                 # with their PAGER variable
228                 $PAGER "$PAGEFILE"
229                 # If that fails, check for less
230         elif [ -x /usr/bin/less ]; then
231                 /usr/bin/less -f "$PAGEFILE"
232                 # more should be on all UNIX systems
233         elif [ -x /bin/more ]; then
234                 /bin/more "$PAGEFILE"
235         else
236                 # No bananas, just cat the thing
237                 cat "$PAGEFILE" >&2
238         fi
239 }
240
241 # run_command [blurb] [command...]
242 # Runs a command, silently if necessary, and updates the status file
243 run_command ()
244 {
245         BLURB="$1"
246         shift
247         # See if this is supposed to be silent
248         if [ "$(checkstatus encode-output)" = "loud" ]; then
249                 "$@" >&2
250                 RETURN=$?
251         else
252                 # Special case for SMP, since
253                 # encoder output is never displayed, don't mute echos
254                 if [ -z "$BLURB" -a "$MAXPROCS" != "1" ]; then
255                         "$@" >&2
256                         RETURN=$?
257                 else
258                         "$@" >/dev/null 2>&1
259                         RETURN=$?
260                 fi
261         fi
262         case "$1" in
263         normalize|normalize-audio)
264                 if [ "$RETURN" = "2" ]; then
265                         # File was already normalized.
266                         RETURN=0
267                 fi
268                 ;;
269         esac
270         if [ "$RETURN" != "0" ]; then
271                 # Put an error in the errors file. For various reasons we
272                 # can't capture a copy of the program's output but we can
273                 # log what we attempted to execute and the error code
274                 # returned by the program.
275                 if [ "$BLURB" ]; then
276                         TWEAK="$BLURB: "
277                 fi
278                 echo "${TWEAK}returned code $RETURN: $@" >> "$ABCDETEMPDIR/errors"
279                 return $RETURN # Do not pass go, do not update the status file
280         fi
281         if [ "$BLURB" ]; then
282                 echo $BLURB >> "$ABCDETEMPDIR/status"
283         fi
284 }
285
286 # relpath() and slash() are Copyright (c) 1999 Stuart Ballard and
287 # distributed under the terms of the GNU GPL v2 or later, at your option
288
289 # Function to determine if a word contains a slash.
290 slash ()
291 {
292         case "$1" in
293         */*) return 0;;
294         *) return 1;;
295         esac
296 }
297
298 # Function to give the relative path from one file to another.
299 # Usage: relpath fromfile tofile
300 # eg relpath music/Artist/Album.m3u music/Artist/Album/Song.mp3
301 # (the result would be Album/Song.mp3)
302 # Output is relative path to $2 from $1 on stdout
303
304 # This code has the following restrictions:
305 # Multiple ////s are not collapsed into single /s, with strange effects.
306 # Absolute paths and ../s are handled wrong in FR (but they work in TO)
307 # If FR is a directory it must have a trailing /
308
309 relpath ()
310 {
311         FR="$1"
312         TO="$2"
313
314         case "$TO" in
315         /*) ;; # No processing is needed for absolute paths
316         *)
317                 # Loop through common prefixes, ignoring them.
318                 while slash "$FR" && [ "$(echo "$FR" | cut -d/ -f1)" = "$(echo "$TO" | cut -d/ -f1)" ]
319                 do
320                         FR="$(echo "$FR" | cut -d/ -f2-)"
321                         TO="$(echo "$TO" | cut -d/ -f2-)"
322                 done
323                 # Loop through directory portions left in FR, adding appropriate ../s.
324                 while slash "$FR"
325                 do
326                         FR="$(echo "$FR" | cut -d/ -f2-)"
327                         TO="../$TO"
328                 done
329                 ;;
330         esac
331
332         echo $TO
333 }
334
335 # do_getcddbinfo
336 # Finds an specific field from cddbinfo
337 do_getcddbinfo()
338 {
339         case $1 in
340         TRACKNAME1)
341                 TRACKNAME="$(grep ^TTITLE$CDDBTRACKNUM= "$CDDBDATA" | head -n 1 | cut -f2- -d= | tr -d \[:cntrl:\] | sed 's/\ \+$//')"
342                 ;;
343         TRACKNAME)
344                 TRACKNAME="$(grep ^TTITLE$CDDBTRACKNUM= "$CDDBDATA" | cut -f2- -d= | tr -d \[:cntrl:\] | sed 's/\ \+$//')"
345                 ;;
346         esac
347 }
348
349 # do_gettracknum
350 # Get the track number we are going to use for different actions
351 do_gettracknum()
352 {
353         if [ -n "$STARTTRACKNUMBER" ] ; then
354                 # Get the trackpadding from the current track
355                 CURRENTTRACKPADDING=$(echo -n $UTRACKNUM | wc -c)
356                 TRACKNUM=$( printf %0.${CURRENTTRACKPADDING}d $(expr ${UTRACKNUM} + ${STARTTRACKNUMBER} - $FIRSTTRACK ))
357         else
358                 TRACKNUM=${UTRACKNUM}
359         fi
360 }
361
362 do_replaygain()
363 {
364         if checkstatus replaygain; then :; else
365                 run_command "" echo "Adding replygain information..."
366                 for OUTPUT in $( echo $OUTPUTTYPE | tr , \ )
367                 do
368                         case $OUTPUT in
369                                 vorbis|ogg)
370                                         OUTPUT=$OGGOUTPUTCONTAINER
371                                         ;;
372                                 flac)
373                                         OUTPUT=$FLACOUTPUTCONTAINER
374                                         ;;
375                         esac
376                         OUTPUTFILES=""
377                         REPLAYINDEX=0
378                         for UTRACKNUM in $TRACKQUEUE
379                         do
380                                 CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
381                                 do_getcddbinfo TRACKNAME
382                                 splitvarious
383                                 TRACKFILE="$(mungefilename "$TRACKNAME")"
384                                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
385                                 ALBUMFILE="$(mungefilename "$DALBUM")"
386                                 do_gettracknum
387                                 if [ "$VARIOUSARTISTS" = "y" ]; then
388                                         OUTPUTFILE="$(eval echo $VAOUTPUTFORMAT)"
389                                 else
390                                         OUTPUTFILE="$(eval echo $OUTPUTFORMAT)"
391                                 fi
392                                 OUTPUTFILES[$REPLAYINDEX]="$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
393                                 (( REPLAYINDEX = $REPLAYINDEX + 1 ))
394                         done
395                         case "$OUTPUT" in
396                                 flac)
397                                         run_command replaygain-flac $METAFLAC --add-replay-gain "${OUTPUTFILES[@]}"
398                                         ;;
399                                 vorbis|ogg)
400                                         run_command replaygain-vorbis $VORBISGAIN --album "${OUTPUTFILES[@]}"
401                                         ;;
402                                 mp3)
403                                         run_command replaygain-mp3 $MP3GAIN -a "${OUTPUTFILES[@]}"
404                                         ;;
405                                 mpc)
406                                         run_command replaygain-mpc $MPPGAIN --auto "${OUTPUTFILES[@]}"
407                                         ;;
408                                 *);;
409                         esac
410                 done
411                 if checkerrors "replaygain-.{3,6}"; then :; else
412                         run_command replaygain true
413                 fi
414         fi
415 }
416
417 # This code splits the a Various Artist track name from one of the following
418 # forms:
419 #
420 #  forward:        Artist / Track
421 #  forward-dash:   Artist - Track
422 #  reverse:        Track / Artist
423 #  reverse-dash:   Track - Artist
424 #  colon:          Artist: Track
425 #  trailing-paren: Artist (Track)
426 #
427 # variables used:
428 # VARIOUSARTISTS, VARIOUSARTISTSTYLE, TRACKNAME, TRACKARTIST
429 splitvarious ()
430 {
431         if [ "$VARIOUSARTISTS" = "y" ] && [ ! "$ONETRACK" = "y" ]; then
432                 case "$VARIOUSARTISTSTYLE" in
433                 forward)
434                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's- / -~-g')"
435                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
436                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
437                         ;;
438                 forward-dash)
439                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's, - ,~,g')"
440                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
441                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
442                         ;;
443                 reverse)
444                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's- / -~-g')"
445                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
446                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
447                         ;;
448                 reverse-dash)
449                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's, - ,~,g')"
450                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
451                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
452                         ;;
453                 colon)
454                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's-: -~-g')"
455                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
456                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
457                         ;;
458                 trailing-paren)
459                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's,^\(.*\) (\(.*\)),\1~\2,')"
460                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
461                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
462                         ;;
463                 esac
464         elif [ "$VARIOUSARTISTS" = "y" ] && [ "$ONETRACK" = "y" ]; then
465                 TRACKARTIST="Various"
466         else
467                 TRACKARTIST="$DARTIST"
468         fi
469 }
470
471 do_getgenreid () {
472 local genre=$(echo "${@}" | tr '[A-Z]' '[a-z]')
473 local id=""
474         case ${genre} in
475                 "blues")                 id=0 ;;
476                 "classic rock")          id=1 ;;
477                 "country")               id=2 ;;
478                 "dance")                 id=3 ;;
479                 "disco")                 id=4 ;;
480                 "funk")                  id=5 ;;
481                 "grunge")                id=6 ;;
482                 "hip-hop")               id=7 ;;
483                 "jazz")                  id=8 ;;
484                 "metal")                 id=9 ;;
485                 "new age")               id=10 ;;
486                 "oldies")                id=11 ;;
487                 "other")                 id=12 ;;
488                 "pop")                   id=13 ;;
489                 "r&b")                   id=14 ;;
490                 "rap")                   id=15 ;;
491                 "reggae")                id=16 ;;
492                 "rock")                  id=17 ;;
493                 "techno")                id=18 ;;
494                 "industrial")            id=19 ;;
495                 "alternative")           id=20 ;;
496                 "ska")                   id=21 ;;
497                 "death metal")           id=22 ;;
498                 "pranks")                id=23 ;;
499                 "soundtrack")            id=24 ;;
500                 "euro-techno")           id=25 ;;
501                 "ambient")               id=26 ;;
502                 "trip-hop")              id=27 ;;
503                 "vocal")                 id=28 ;;
504                 "jazz+funk")             id=29 ;;
505                 "fusion")                id=30 ;;
506                 "trance")                id=31 ;;
507                 "classical")             id=32 ;;
508                 "instrumental")          id=33 ;;
509                 "acid")                  id=34 ;;
510                 "house")                 id=35 ;;
511                 "game")                  id=36 ;;
512                 "sound clip")            id=37 ;;
513                 "gospel")                id=38 ;;
514                 "noise")                 id=39 ;;
515                 "alt. rock")             id=40 ;;
516                 "bass")                  id=41 ;;
517                 "soul")                  id=42 ;;
518                 "punk")                  id=43 ;;
519                 "space")                 id=44 ;;
520                 "meditative")            id=45 ;;
521                 "instrum. pop")          id=46 ;;
522                 "instrum. rock")         id=47 ;;
523                 "ethnic")                id=48 ;;
524                 "gothic")                id=49 ;;
525                 "darkwave")              id=50 ;;
526                 "techno-indust.")        id=51 ;;
527                 "electronic")            id=52 ;;
528                 "pop-folk")              id=53 ;;
529                 "eurodance")             id=54 ;;
530                 "dream")                 id=55 ;;
531                 "southern rock")         id=56 ;;
532                 "comedy")                id=57 ;;
533                 "cult")                  id=58 ;;
534                 "gangsta")               id=59 ;;
535                 "top 40")                id=60 ;;
536                 "christian rap")         id=61 ;;
537                 "pop/funk"|"pop / funk") id=62 ;;
538                 "jungle")                id=63 ;;
539                 "native american")       id=64 ;;
540                 "cabaret")               id=65 ;;
541                 "new wave")              id=66 ;;
542                 "psychadelic")           id=67 ;;
543                 "rave")                  id=68 ;;
544                 "showtunes")             id=69 ;;
545                 "trailer")               id=70 ;;
546                 "lo-fi")                 id=71 ;;
547                 "tribal")                id=72 ;;
548                 "acid punk")             id=73 ;;
549                 "acid jazz")             id=74 ;;
550                 "polka")                 id=75 ;;
551                 "retro")                 id=76 ;;
552                 "musical")               id=77 ;;
553                 "rock & roll")           id=78 ;;
554                 "hard rock")             id=79 ;;
555                 "folk")                  id=80 ;;
556                 "folk/rock")             id=81 ;;
557                 "national folk")         id=82 ;;
558                 "swing")                 id=83 ;;
559                 "fusion")                id=84 ;;
560                 "bebob")                 id=85 ;;
561                 "latin")                 id=86 ;;
562                 "revival")               id=87 ;;
563                 "celtic")                id=88 ;;
564                 "bluegrass")             id=89 ;;
565                 "avantgarde")            id=90 ;;
566                 "gothic rock")           id=91 ;;
567                 "progress. rock")        id=92 ;;
568                 "psychadel. rock")       id=93 ;;
569                 "symphonic rock")        id=94 ;;
570                 "slow rock")             id=95 ;;
571                 "big band")              id=96 ;;
572                 "chorus")                id=97 ;;
573                 "easy listening")        id=98 ;;
574                 "acoustic")              id=99 ;;
575                 "humour")                id=100 ;;
576                 "speech")                id=101 ;;
577                 "chanson")               id=102 ;;
578                 "opera")                 id=103 ;;
579                 "chamber music")         id=104 ;;
580                 "sonata")                id=105 ;;
581                 "symphony")              id=106 ;;
582                 "booty bass")            id=107 ;;
583                 "primus")                id=108 ;;
584                 "porn groove")           id=109 ;;
585                 "satire")                id=110 ;;
586                 "slow jam")              id=111 ;;
587                 "club")                  id=112 ;;
588                 "tango")                 id=113 ;;
589                 "samba")                 id=114 ;;
590                 "folklore")              id=115 ;;
591                 "ballad")                id=116 ;;
592                 "power ballad")          id=117 ;;
593                 "rhythmic soul")         id=118 ;;
594                 "freestyle")             id=119 ;;
595                 "duet")                  id=120 ;;
596                 "punk rock")             id=121 ;;
597                 "drum solo")             id=122 ;;
598                 "a capella")             id=123 ;;
599                 "euro-house")            id=124 ;;
600                 "dance hall")            id=125 ;;
601                 "goa")                   id=126 ;;
602                 "drum & bass")           id=127 ;;
603                 "club-house")            id=128 ;;
604                 "hardcore")              id=129 ;;
605                 "terror")                id=130 ;;
606                 "indie")                 id=131 ;;
607                 "britpop")               id=132 ;;
608                 "negerpunk")             id=133 ;;
609                 "polsk punk")            id=134 ;;
610                 "beat")                  id=135 ;;
611                 "christian gangsta rap") id=136 ;;
612                 "heavy metal")           id=137 ;;
613                 "black metal")           id=138 ;;
614                 "crossover")             id=139 ;;
615                 "contemporary christian")id=140 ;;
616                 "christian rock")        id=141 ;;
617                 "merengue")              id=142 ;;
618                 "salsa")                 id=143 ;;
619                 "thrash metal")          id=144 ;;
620                 "anime")                 id=145 ;;
621                 "jpop")                  id=146 ;;
622                 "synthpop")              id=147 ;;
623                 "rock/pop"|"rock / pop") id=148 ;;
624                 *)                       return 1 ;;
625         esac
626 echo ${id}
627 return 0
628 }
629
630 # do_tag [tracknumber]
631 # id3 tags a filename
632 # variables used:
633 # TRACKS, TRACKNAME, TRACKARTIST, TAGGER, TAGGEROPTS, VORBISCOMMENT, METAFLAC, 
634 # COMMENT, DALBUM, DARTIST, CDYEAR, CDGENRE (and temporarily) ID3TAGV
635 do_tag ()
636 {
637         COMMENTOUTPUT="$(eval echo ${COMMENT})"
638         CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
639         run_command '' echo "Tagging track $1 of $TRACKS: $TRACKNAME..."
640         # If we want to start the tracks with a given number, we need to modify the
641         # TRACKNUM value before evaluation
642         if [ -n "$STARTTRACKNUMBERTAG" ] ; then
643                 do_gettracknum
644         fi
645         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
646         do
647                 case "$OUTPUT" in
648                 mp3)
649                         # id3v2 v0.1.9 claims to have solved the -c bug, so we merge both id3 and id3v2
650                         GENREID=$(do_getgenreid "${CDGENRE}")
651         
652                         case "$ID3SYNTAX" in
653                                 id3);;
654                                 eyed3)
655                                         # FIXME # track numbers in mp3 come with 1/10, so we cannot happily substitute them with $TRACKNUM
656                                         run_command tagtrack-$OUTPUT-$1 $TAGGER $TAGGEROPTS --commen=::"$COMMENTOUTPUT" \
657                                                 -A "$DALBUM" -a "$TRACKARTIST" -t "$TRACKNAME" -Y "$CDYEAR" \
658                                                 -G "$GENREID" -n "${TRACKNUM:-$1}" "${TRACKNUM:+-N $TRACKS}" \
659                                                 "${ENCODING:+--set-encoding=$ENCODING}"
660                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
661                                         ;;
662                                 *)
663                                         # FIXME # track numbers in mp3 come with 1/10, so we cannot happily substitute them with $TRACKNUM
664                                         run_command tagtrack-$OUTPUT-$1 $TAGGER $TAGGEROPTS -c "$COMMENTOUTPUT" \
665                                                 -A "$DALBUM" -a "$TRACKARTIST" -t "$TRACKNAME" -y "$CDYEAR" \
666                                                 -g "$GENREID" -T "${TRACKNUM:-$1/$TRACKS}" \
667                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
668                                         ;;
669                         esac
670                         ;;
671                 vorbis|ogg)
672                         case "$OGGENCODERSYNTAX" in
673                                 vorbize|oggenc)
674                                         # vorbiscomment can't do in-place modification, mv the file first
675                                         if [ -f "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" -a ! -f "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" ]; then
676                                                 mv "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER"
677                                         fi
678                                         (
679                                         # These are from http://www.xiph.org/ogg/vorbis/doc/v-comment.html
680                                         echo ARTIST="$TRACKARTIST"
681                                         echo ALBUM="$DALBUM"
682                                         echo TITLE="$TRACKNAME"
683                                         if [ -n "$CDYEAR" ]; then
684                                                 echo DATE="$CDYEAR"
685                                         fi
686                                         if [ -n "$CDGENRE" ]; then
687                                                 echo GENRE="$CDGENRE"
688                                         fi      
689                                         echo TRACKNUMBER=${TRACKNUM:-$1}
690                                         echo CDDB=$CDDBDISCID
691                                         if [ "$(eval echo ${COMMENT})" != "" ]; then
692                                                 case "$COMMENTOUTPUT" in
693                                                         *=*) echo "$COMMENTOUTPUT";;
694                                                         *)   echo COMMENT="$COMMENTOUTPUT";;
695                                                 esac    
696                                         fi
697                                         ) | run_command tagtrack-$OUTPUT-$1 $VORBISCOMMENT $VORBISCOMMENTOPTS -w \
698                                                 "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
699                                         # Doublecheck that the commented file was created successfully before wiping the original
700                                         if [ -f "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" ]; then
701                                                 rm -f "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER"
702                                         else
703                                                 mv "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
704                                         fi
705                                         ;;
706                         esac
707                         ;;
708                 flac)
709                         (
710                         echo ARTIST="$TRACKARTIST"
711                         echo ALBUM="$DALBUM"
712                         echo TITLE="$TRACKNAME"
713                         if [ -n "$CDYEAR" ]; then
714                                 echo DATE="$CDYEAR"
715                         fi
716                         if [ -n "$CDGENRE" ]; then
717                                 echo GENRE="$CDGENRE"
718                         fi      
719                         echo TRACKNUMBER="${TRACKNUM:-$1}"
720                         echo CDDB="$CDDBDISCID"
721                         if [ "$(eval echo ${COMMENT})" != "" ]; then
722                                 case "$COMMENTOUTPUT" in
723                                         *=*) echo "$COMMENTOUTPUT";;
724                                         *)   echo COMMENT="$COMMENTOUTPUT";;
725                                 esac    
726                         fi
727                         ) | run_command tagtrack-$OUTPUT-$1 $METAFLAC $METAFLACOPTS --import-tags-from=- "$ABCDETEMPDIR/track$1.$FLACOUTPUTCONTAINER"
728                         ;;
729                 spx)
730                         run_command tagtrack-$OUTPUT-$1 true
731                         ;;
732                 mpc)
733                         run_command tagtrack-$OUTPUT-$1 true
734                         ;;
735                 wav)
736                         run_command tagtrack-$OUTPUT-$1 true
737                         ;;
738                 esac
739         done
740         if checkerrors "tagtrack-(.{3,6})-$1"; then :; else
741                 run_command tagtrack-$1 true
742         fi
743
744 }
745
746 # do_nogap_encode
747 # variables used:
748 # OUTPUTTYPE, {FOO}ENCODERSYNTAX, ENCNICE, ENCODER, ENCODEROPTS
749 do_nogap_encode ()
750 {
751         # The commands here don't go through run_command because they're never supposed to be silenced
752         echo "Encoding gapless MP3 tracks: $TRACKQUEUE"
753         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
754         do
755                 case "$OUTPUT" in
756                 mp3)
757                         case "$MP3ENCODERSYNTAX" in
758                         lame)
759                                 (
760                                 cd "$ABCDETEMPDIR"
761                                 TRACKFILES=
762                                 for UTRACKNUM in $TRACKQUEUE
763                                 do
764                                         TRACKFILES="$TRACKFILES track$UTRACKNUM.wav"
765                                 done
766                                 nice $ENCNICE $MP3ENCODER $MP3ENCODEROPTS --nogap $TRACKFILES
767                                 RETURN=$?
768                                 if [ "$RETURN" != "0" ]; then
769                                         echo "nogap-encode: $ENCODER returned code $RETURN" >> errors
770                                 else
771                                         for UTRACKNUM in $TRACKQUEUE
772                                         do
773                                                 run_command encodetrack-$OUTPUT-$UTRACKNUM true
774                                                 #run_command encodetrack-$UTRACKNUM true
775                                         done
776                                 fi
777                                 )
778                                 ;;
779                         esac
780                         ;;
781                 esac
782         done            
783         if checkerrors "nogap-encode"; then :; else
784                 if [ ! "$KEEPWAVS" = "y" ] ; then
785                         if [ ! "$KEEPWAVS" = "move" ] ; then
786                                 rm -f "$IN"
787                         fi
788                 fi
789         fi
790         # Other encoders fall through to normal encoding as the tracks
791         # have not been entered in the status file.
792 }
793
794 # do_encode [tracknumber] [hostname]
795 # If no hostname is specified, encode locally
796 # variables used:
797 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
798 do_encode ()
799 {
800         if [ "$USEPIPES" = "y" ]; then
801                 case "$OUTPUT" in
802                         mp3)
803                                 TEMPARG="PIPE_$MP3ENCODERSYNTAX"
804                                 ;;
805                         vorbis|ogg)
806                                 TEMPARG="PIPE_$OGGENCODERSYNTAX"
807                                 ;;
808                         flac)
809                                 TEMPARG="PIPE_$FLACENCODERSYNTAX"
810                                 ;;
811                         spx)
812                                 TEMPARG="PIPE_$SPEEXENCODER"
813                                 ;;
814                         mpc)
815                                 TEMPARG="PIPE_$MPPENCODER"
816                                 ;;
817                 esac
818                 IN="$( eval echo "\$$TEMPARG" )"
819         else
820                 IN="$ABCDETEMPDIR/track$1.wav"
821                 case "$OUTPUT" in
822                         mp3)
823                                 case "$MP3ENCODERSYNTAX" in
824                                         # FIXME # check if mp3enc needs -if for pipes
825                                         # FIXME # I have not been able to find a working mp3enc binary
826                                         mp3enc)
827                                                 FILEARG="-if $IN"
828                                                 ;;
829                                         *)
830                                                 FILEARG="$IN"
831                                                 ;;
832                                 esac
833                                 ;;
834                         *)
835                                 FILEARG="$IN"
836                                 ;;
837                 esac
838         fi
839         # We need IN to proceed, if we are not using pipes.
840         if [ -s "$IN" -o X"$USEPIPES" = "Xy" ] ; then
841                 for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
842                 do
843                         case "$OUTPUT" in
844                                 vorbis|ogg)
845                                         OUT="$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
846                                         OUTPUT=$OGGOUTPUTCONTAINER
847                                         ;;
848                                 flac)
849                                         OUT="$ABCDETEMPDIR/track$1.$FLACOUTPUTCONTAINER"
850                                         OUTPUT=$FLACOUTPUTCONTAINER
851                                         ;;
852                                 *)
853                                         OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
854                                         ;;
855                         esac
856                         if [ "$NOGAP" = "y" ] && checkstatus encodetrack-$OUTPUT-$1 ; then 
857                                 continue
858                         fi
859                         if [ X"$USEPIPES" = "Xy" ]; then
860                                 RUN_COMMAND=""
861                                 # We need a way to store the creation of the files when using PIPES
862                                 RUN_COMMAND_PIPES="run_command encodetrack-$OUTPUT-$1 true"
863                         else
864                                 run_command '' echo "Encoding track $1 of $TRACKS: $TRACKNAME..."
865                                 RUN_COMMAND="run_command encodetrack-$OUTPUT-$1"
866                         fi
867                         case "$OUTPUT" in
868                         mp3)
869                                 case "$2" in
870                                 %local*%)
871                                         case "$MP3ENCODERSYNTAX" in
872                                         lame|gogo) $RUN_COMMAND nice $ENCNICE $MP3ENCODER $MP3ENCODEROPTS "$IN" "$OUT" ;;
873                                         bladeenc) $RUN_COMMAND nice $ENCNICE $MP3ENCODER $MP3ENCODEROPTS -quit "$IN" ;;
874                                         l3enc|xingmp3enc) $RUN_COMMAND nice $ENCNICE $MP3ENCODER "$IN" "$OUT" $MP3ENCODEROPTS ;;
875                                         # FIXME # Relates to the previous FIXME since it might need the "-if" removed.
876                                         mp3enc) $RUN_COMMAND nice $ENCNICE $MP3ENCODER -if "$IN" -of "$OUT" $MP3ENCODEROPTS ;;
877                                         esac
878                                         ;;
879                                 *)
880                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
881                                         ;;
882                                 esac
883                                 ;;
884                         vorbis|ogg)
885                                 case "$2" in
886                                 %local*%)
887                                         case "$OGGENCODERSYNTAX" in
888                                         vorbize) $RUN_COMMAND nice $ENCNICE $OGGENCODER $OGGENCODEROPTS -w "$OUT" "$IN" ;;
889                                         oggenc) $RUN_COMMAND nice $ENCNICE $OGGENCODER $OGGENCODEROPTS -o "$OUT" "$IN" ;;
890                                         esac
891                                         ;;
892                                 *)
893                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
894                                         ;;
895                                 esac
896                                 ;;
897                         flac)
898                                 case "$2" in
899                                 %local*%)
900                                         case "$FLACENCODERSYNTAX" in
901                                         flac) $RUN_COMMAND nice $ENCNICE $FLACENCODER -f $FLACENCODEROPTS -o "$OUT" "$IN" ;; 
902                                         esac
903                                                 ;;
904                                         *)
905                                                 vecho -n "DISTMP3:"
906                                                 vecho "$DISTMP3 $DISTMP3OPTS $2 $IN $OUT >/dev/null 2>&1"
907                                                 $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" > /dev/null 2>&1
908                                         ;;
909                                 esac
910                                 ;;
911                         spx)
912                                 if [ "$(eval echo ${COMMENT})" != "" ]; then
913                                         case "$COMMENT" in
914                                                 *=*) ;;
915                                                 *)   COMMENT="COMMENT=$COMMENT" ;;
916                                         esac    
917                                         COMMENT="--comment \"$COMMENT\""
918                                 fi
919                                 # Quick hack to avoid tagging Ogg/Speex, since there is no other way to tag than inline tagging
920                                 if [ ! "$DOTAG" = "y" ]; then
921                                         $RUN_COMMAND nice $ENCNICE $SPEEXENCODER $SPEEXENCODEROPTS --author "$TRACKARTIST" --title "$TRACKNAME" "$COMMENT" "$IN" "$OUT"
922                                 else
923                                         $RUN_COMMAND nice $ENCNICE $SPEEXENCODER $SPEEXENCODEROPTS "$IN" "$OUT"
924                                 fi
925                                 ;;
926                         mpc)    
927                                 # MPP/MP+(Musepack) format (.mpc) is done locally, with inline
928                                 # tagging.
929                                 # I tried compiling the mppenc from corecodecs.org and got some
930                                 # errors, so I have not tried it myself.
931                                 ## FIXME ## Needs some cleanup to determine if an empty tag sent
932                                 ## FIXME ## to the encoder ends up empty.
933                                 $RUN_COMMAND nice $ENCNICE $MPPENCODER $MPPENCODEROPTS --artist "$TRACKARTIST" --album "$DALBUM" --title "$TRACKNAME" --track "$1" --genre "$CDGENRE" --year "$CDYEAR" --comment "$COMMENT" "$IN" "$OUT"
934                                 ;;
935                         wav)
936                                 # In case of wav output we need nothing. Just keep the wavs.
937                                 ;;
938                         esac
939                         $RUN_COMMAND_PIPES
940                 done
941                 # Only remove .wav if the encoding succeeded
942                 if checkerrors "encodetrack-(.{3,6})-$1"; then :; else
943                         run_command encodetrack-$1 true
944                         if [ ! "$KEEPWAVS" = "y" ] ; then
945                                 if [ ! "$KEEPWAVS" = "move" ] ; then
946                                         rm -f "$IN"
947                                 fi
948                         fi
949                 fi
950         else
951                 run_command "" echo "HEH! The file we were about to encode disappeared:"
952                 run_command "" echo ">> $IN"
953                 run_command encodetrack-$1 false
954         fi
955 }
956
957 # do_preprocess [tracknumber]
958 # variables used:
959 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
960 #do_preprocess ()
961 #{
962 #       IN="$ABCDETEMPDIR/track$1.wav"
963 #       # We need IN to proceed.
964 #       if [ -s "$IN" ] ; then
965 #               for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
966 #               do
967 #                       #OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
968 #                       run_command '' echo "Pre-processing track $1 of $TRACKS..."
969 #                       case "$POSTPROCESSFORMAT" in
970 #                       all|wav*)
971 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $WAV_PRE $IF $OF ;;
972 #                       mp3)
973 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $MP3_PRE $IF $OF ;;
974 #                       ogg)
975 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $OGG_PRE $IF $OF ;;
976 #                       flac)
977 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $FLAC_PRE $IF $OF ;;
978 #                       spx)
979 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $SPX_PRE $IF $OF ;;
980 #                       esac
981 #               done
982 #               # Only remove .wav if the encoding succeeded
983 #               if checkerrors "preprocess-(.{3,4})-$1"; then 
984 #                       run_command preprocess-$1 false
985 #               else
986 #                       run_command preprocess-$1 true
987 #               fi
988 #       else
989 #               if [ "$(checkstatus encode-output)" = "loud" ]; then
990 #                       echo "HEH! The file we were about to pre-process disappeared:"
991 #                       echo ">> $IN"
992 #               fi
993 #               run_command preprocess-$1 false
994 #       fi
995 #}
996
997
998 # do_postprocess [tracknumber]
999 # variables used:
1000 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
1001 #do_postprocess ()
1002 #{
1003 #       for POSTPROCESSFORMAT in $(echo $POSTPROCESSFORMATS | tr , \ )
1004 #       do
1005 #               IN="$ABCDETEMPDIR/track$1.$POSTPROCESSFORMAT"
1006 #               # We need IN to proceed.
1007 #               if [ -s "$IN" ] ; then
1008 #                       #OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
1009 #                       run_command '' echo "Post-processing track $1 of $TRACKS..."
1010 #                       case "$POSTPROCESSFORMAT" in
1011 #                               mp3)
1012 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $MP3_POST $IF $OF ;;
1013 #                               ogg)
1014 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $OGG_POST $IF $OF ;;
1015 #                               flac)
1016 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $FLAC_POST $IF $OF ;;
1017 #                               spx)
1018 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $SPX_POST $IF $OF ;;
1019 #                       esac
1020 #                       # Only remove .wav if the encoding succeeded
1021 #                       if checkerrors "postprocess-(.{3,4})-$1"; then 
1022 #                               run_command postprocess-$1 false
1023 #                       else
1024 #                               run_command postprocess-$1 true
1025 #                       fi
1026 #               else
1027 #                       if [ "$(checkstatus encode-output)" = "loud" ]; then
1028 #                               echo "HEH! The file we were about to post-process disappeared:"
1029 #                               echo ">> $IN"
1030 #                       fi
1031 #                       run_command postprocess-$1 false
1032 #               fi
1033 #       done
1034 #}
1035
1036 # do_single_gain
1037 # variables used:
1038 # FIXME #
1039 do_single_gain ()
1040 {
1041 :
1042 }
1043
1044 # do_batch_gain
1045 # variables used:
1046 # MP3GAIN, MP3GAINOPTS, VORBISGAIN, VORBISGAINOPTS, MPPGAIN, MPPGAINOPTS
1047 # FIXME #
1048 do_batch_gain ()
1049 {
1050         # The commands here don't go through run_command because they're never supposed to be silenced
1051         echo "Batch analizing gain in tracks: $TRACKQUEUE"
1052         (
1053         cd "$ABCDETEMPDIR"
1054         BLURB=
1055         TRACKFILES=
1056         for UTRACKNUM in $TRACKQUEUE
1057         do
1058                 MP3FILES="$TRACKFILES track$UTRACKNUM.mp3"
1059         done
1060         # FIXME # Hard-coded batch option!
1061         $NORMALIZER -b $NORMALIZEROPTS $TRACKFILES
1062         RETURN=$?
1063         if [ "$RETURN" != "0" ]; then
1064                 echo "batch-normalize: $NORMALIZER returned code $RETURN" >> errors
1065         else
1066                 for UTRACKNUM in $TRACKQUEUE
1067                 do
1068                         echo normalizetrack-$UTRACKNUM >> status
1069                 done
1070         fi
1071         )
1072 }
1073
1074 # do_batch_normalize
1075 # variables used:
1076 # NORMALIZER, NORMALIZEROPTS
1077 do_batch_normalize ()
1078 {
1079         # The commands here don't go through run_command because they're never supposed to be silenced
1080         echo "Batch normalizing tracks: $TRACKQUEUE"
1081         (
1082         cd "$ABCDETEMPDIR"
1083         BLURB=
1084         TRACKFILES=
1085         for UTRACKNUM in $TRACKQUEUE
1086         do
1087                 TRACKFILES="$TRACKFILES track$UTRACKNUM.wav"
1088         done
1089         # XXX: Hard-coded batch option!
1090         $NORMALIZER -b $NORMALIZEROPTS $TRACKFILES
1091         RETURN=$?
1092         if [ "$RETURN" != "0" ]; then
1093                 echo "batch-normalize: $NORMALIZER returned code $RETURN" >> errors
1094         else
1095                 for UTRACKNUM in $TRACKQUEUE
1096                 do
1097                         echo normalizetrack-$UTRACKNUM >> status
1098                 done
1099         fi
1100         )
1101 }
1102
1103 # do_normalize [tracknumber]
1104 # variables used:
1105 # TRACKS, TRACKNAME, NORMALIZER, NORMALIZEROPTS
1106 do_normalize ()
1107 {
1108         IN="$ABCDETEMPDIR/track$1.wav"
1109         if [ -e "$IN" ] ; then
1110                 run_command '' echo "Normalizing track $1 of $TRACKS: $TRACKNAME..."
1111                 run_command normalizetrack-$1 $NORMALIZER $NORMALIZEROPTS "$IN"
1112         else
1113                 if [ "$(checkstatus encode-output)" = "loud" ]; then
1114                         echo "HEH! The file we were about to normalize disappeared:"
1115                         echo ">> $IN"
1116                 fi
1117                 run_command normalizetrack-$1 false "File $IN was not found"
1118         fi
1119 }
1120
1121 # do_move [tracknumber]
1122 # Deduces the outfile from environment variables
1123 # Creates directory if necessary
1124 # variables used:
1125 # TRACKNUM, TRACKNAME, TRACKARTIST, DALBUM, OUTPUTFORMAT, CDGENRE, CDYEAR
1126 do_move ()
1127 {
1128         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1129         do
1130                 # Create ALBUMFILE, ARTISTFILE, TRACKFILE
1131                 # Munge filenames as follows:
1132                 # ' ' -> '_'
1133                 # '/' -> '_'
1134                 # ''' -> ''
1135                 # '?' -> ''
1136                 # Eat control characters
1137                 ALBUMFILE="$(mungefilename "$DALBUM")"
1138                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1139                 TRACKFILE="$(mungefilename "$TRACKNAME")"
1140                 GENRE="$(mungegenre "$GENRE")"
1141                 YEAR="$(echo $CDYEAR)"
1142                 # If we want to start the tracks with a given number, we need to modify the
1143                 # TRACKNUM value before evaluation
1144                 do_gettracknum
1145                 # Supported variables for OUTPUTFORMAT are GENRE, ALBUMFILE, ARTISTFILE,
1146                 # TRACKFILE, and TRACKNUM.
1147                 if [ "$VARIOUSARTISTS" = "y" ]; then
1148                         OUTPUTFILE="$(eval echo "$VAOUTPUTFORMAT")"
1149                 else
1150                         OUTPUTFILE="$(eval echo "$OUTPUTFORMAT")"
1151                 fi
1152                 if checkerrors "tagtrack-$OUTPUT-$1"; then :; else
1153                         # Once we know the specific output was successful, we can change the OUTPUT to the value containing the container
1154                         case $OUTPUT in
1155                                 vorbis|ogg)
1156                                         OUTPUT=$OGGOUTPUTCONTAINER
1157                                         ;;
1158                                 flac)
1159                                         OUTPUT=$FLACOUTPUTCONTAINER
1160                                         ;;
1161                         esac
1162                         # Check that the directory for OUTPUTFILE exists, if it doesn't, create it
1163                         OUTPUTFILEDIR="$(dirname "$OUTPUTDIR/$OUTPUTFILE")"
1164                         case $OUTPUT in
1165                                 wav)
1166                                         if [ "$DOCLEAN" != "y" ] && [ "$FORCE" != "y" ]; then
1167                                                 # FIXME # introduce warnings?
1168                                                 :
1169                                         else
1170                                                 # mkdir -p shouldn't return an error if the directory already exists
1171                                                 mkdir -p "$OUTPUTFILEDIR"
1172                                                 run_command movetrack-$1 mv "$ABCDETEMPDIR/track$1.$OUTPUT" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
1173                                                 if checkstatus movetrack-output-$OUTPUT; then :; else
1174                                                         run_command movetrack-output-$OUTPUT true
1175                                                 fi
1176                                         fi
1177                                         ;;
1178                                 *)
1179                                         # mkdir -p shouldn't return an error if the directory already exists
1180                                         mkdir -p "$OUTPUTFILEDIR"
1181                                         run_command movetrack-$1 mv "$ABCDETEMPDIR/track$1.$OUTPUT" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
1182                                         if checkstatus movetrack-output-$OUTPUT; then :; else
1183                                                 run_command movetrack-output-$OUTPUT true
1184                                         fi
1185                                         ;;
1186                         esac
1187                         # Lets move the cue file
1188                         if CUEFILE=$(checkstatus cuefile) >/dev/null ; then 
1189                                 if [ -r "$ABCDETEMPDIR/$CUEFILE" ]; then
1190                                         if checkstatus movecue-$OUTPUT; then :; else
1191                                                 # Silence the Copying output since it overlaps with encoding processes...
1192                                                 #run_command '' vecho "Copying cue file to its destination directory..."
1193                                                 if checkstatus onetrack >/dev/null ; then
1194                                                         case $OUTPUT in
1195                                                                 wav)
1196                                                                         if [ "$DOCLEAN" != "y" ] && [ "$FORCE" != "y" ]; then
1197                                                                                 # We dont have the dir, since it was not created before.
1198                                                                                 :
1199                                                                         else
1200                                                                                 run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.cue"
1201                                                                         fi
1202                                                                         ;;
1203                                                                 # NOTE: Creating a cue file with the 3-char-extension files is to comply with
1204                                                                 # http://brianvictor.tripod.com/mp3cue.htm#details
1205                                                                 [a-z0-9][a-z0-9][a-z0-9])
1206                                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.cue"
1207                                                                         ;;
1208                                                                 *)
1209                                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT.cue"
1210                                                                         ;;
1211                                                         esac
1212                                                 else
1213                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTFILEDIR/$CUEFILE"
1214                                                 fi
1215                                                 echo movecue-$OUTPUT >> "$ABCDETEMPDIR/status"
1216                                         fi
1217                                 fi
1218                         fi
1219                 fi
1220         done
1221 }
1222
1223 # do_playlist
1224 # Create the playlist if wanted
1225 # Variables used:
1226 # PLAYLISTFORMAT, PLAYLISTDATAPREFIX, VAPLAYLISTFORMAT, VAPLAYLISTDATAPREFIX,
1227 # VARIOUSARTISTS, OUTPUTDIR
1228 do_playlist ()
1229 {
1230         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1231         do
1232                 case $OUTPUT in
1233                         vorbis|ogg)
1234                                 OUTPUT=$OGGOUTPUTCONTAINER
1235                                 ;;
1236                         flac)
1237                                 OUTPUT=$FLACOUTPUTCONTAINER
1238                                 ;;
1239                 esac
1240                 # Create a playlist file for the playlist data to go into.
1241                 # We used to wipe it out if it existed. Now we request permision if interactive.
1242                 for LASTTRACK in $TRACKQUEUE; do :; done
1243                 ALBUMFILE="$(mungefilename "$DALBUM")"
1244                 ARTISTFILE="$(mungefilename "$DARTIST")"
1245                 GENRE=$(mungegenre "$GENRE")
1246                 YEAR=${CDYEAR:-$CDYEAR}
1247                 if [ "$VARIOUSARTISTS" = "y" ] ; then
1248                         PLAYLISTFILE=$(eval echo $VAPLAYLISTFORMAT)
1249                 else
1250                         PLAYLISTFILE=$(eval echo $PLAYLISTFORMAT)
1251                 fi
1252                 FINALPLAYLISTDIR=$(dirname "$OUTPUTDIR/$PLAYLISTFILE")
1253                 mkdir -p "$FINALPLAYLISTDIR"
1254                 if [ -s "$OUTPUTDIR/$PLAYLISTFILE" ]; then
1255                         echo -n "Erase, Append to, or Keep the existing playlist file? [e/a/k] (e): " >&2
1256                         if [ "$INTERACTIVE" = "y" ]; then
1257                                 while [ "$DONE" != "y" ]; do
1258                                         read ERASEPLAYLIST
1259                                         case $ERASEPLAYLIST in
1260                                                 e|E|a|A|k|K) DONE=y ;;
1261                                                 *) ;;
1262                                         esac
1263                                 done
1264                         else
1265                                 echo e >&2
1266                                 ERASEPLAYLIST=e
1267                         fi
1268                         # Once we erase the playlist, we use append to create the new one.
1269                         [ "$ERASEPLAYLIST" = "e" -o "$ERASEPLAYLIST" = "E" ] && rm -f "$OUTPUTDIR/$PLAYLISTFILE" && ERASEPLAYLIST=a
1270                 else
1271                         # The playlist does not exist, so we can safelly use append to create the new list
1272                         ERASEPLAYLIST=a
1273                 fi
1274                 if [ "$ERASEPLAYLIST" = "a" -o "$ERASEPLAYLIST" = "A" ]; then
1275                         touch "$OUTPUTDIR/$PLAYLISTFILE"
1276                         for UTRACKNUM in $TRACKQUEUE
1277                         do
1278                                 # Shares some code with do_move since the filenames have to match
1279                                 CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
1280                                 do_getcddbinfo TRACKNAME
1281                                 splitvarious
1282                                 TRACKFILE="$(mungefilename "$TRACKNAME")"
1283                                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1284                                 ALBUMFILE="$(mungefilename "$DALBUM")"
1285                                 # If we want to start the tracks with a given number, we need to modify the
1286                                 # TRACKNUM value before evaluation
1287                                 do_gettracknum
1288                                 if [ "$VARIOUSARTISTS" = "y" ]; then
1289                                         OUTPUTFILE=$(eval echo $VAOUTPUTFORMAT)
1290                                 else
1291                                         OUTPUTFILE=$(eval echo $OUTPUTFORMAT)
1292                                 fi
1293                                 if [ "$VARIOUSARTISTS" = "y" ]; then
1294                                         if [ "$VAPLAYLISTDATAPREFIX" ] ; then
1295                                                 echo ${VAPLAYLISTDATAPREFIX}$OUTPUTFILE.$OUTPUT >> "$OUTPUTDIR/$PLAYLISTFILE"
1296                                         else
1297                                                 relpath "$PLAYLISTFILE", "$OUTPUTFILE.$OUTPUT" >> "$OUTPUTDIR/$PLAYLISTFILE"
1298                                         fi
1299                                 else
1300                                         if [ "$PLAYLISTDATAPREFIX" ]; then
1301                                                 echo ${PLAYLISTDATAPREFIX}$OUTPUTFILE.$OUTPUT >> "$OUTPUTDIR/$PLAYLISTFILE"
1302                                         else
1303                                                 relpath "$PLAYLISTFILE", "$OUTPUTFILE.$OUTPUT" >> "$OUTPUTDIR/$PLAYLISTFILE"
1304                                         fi
1305                                 fi
1306                         done
1307                 fi
1308                 ## this will convert the playlist to have CRLF line-endings, if specified
1309                 ## (some hardware players insist on CRLF endings)
1310                 if [ "$DOSPLAYLIST" = "y" ]; then
1311                         awk '{substr("\r",""); printf "%s\r\n", $0}' "$OUTPUTDIR/$PLAYLISTFILE" > "$ABCDETEMPDIR/PLAYLISTFILE.tmp"
1312 #                       mv -f "$ABCDETEMPDIR/PLAYLISTFILE.tmp" "$OUTPUTDIR/$PLAYLISTFILE"
1313                         cat "$ABCDETEMPDIR/PLAYLISTFILE.tmp" | sed 's/\//\\/' > "$OUTPUTDIR/$PLAYLISTFILE"
1314                 fi
1315                 echo "playlistcomplete" >> "$ABCDETEMPDIR/status"
1316         done
1317 }
1318
1319 # do_discid
1320 # This essentially the start of things
1321 do_discid ()
1322 {
1323         # Query the CD to get the track info, unless the user specified -C
1324         # or we are using some actions which do not need the CDDB data at all
1325         #if [ ! X"$EXPACTIONS" = "X" ]; then
1326         #       :
1327         #elif [ -z "$DISCID" ]; then
1328         if [ -z "$DISCID" ]; then
1329                 vecho -n "Getting CD track info... "
1330                 # In OSX, unmount the disc before a query
1331                 if [ "$OSFLAVOUR" = "OSX" ]; then
1332                         disktool -u ${CDROM#/dev/}
1333                 fi
1334                 if [ "$CDROMREADERSYNTAX" = "flac" ] ; then
1335                         TRACKINFO=$($METAFLAC $METAFLACOPTS --export-cuesheet-to=- $CDROM | $CUE2DISCID)
1336                 else
1337                         TRACKINFO=$($CDDISCID $CDROM)
1338                 fi
1339                 # Make sure there's a CD in there by checking cd-discid's return code
1340                 if [ ! "$?" = "0" ]; then
1341                         if [ "$CDROMREADERSYNTAX" = "flac" ] ; then
1342                                 log error "cuesheet information from the flac file could not be read."
1343                                 log error "Perhaps the flac file does not contain a cuesheet?."
1344                                 exit 1
1345                         else
1346                                 log error "CD could not be read. Perhaps there's no CD in the drive?"
1347                                 exit 1
1348                         fi
1349                 fi
1350                 # In OSX, remount the disc again
1351                 if [ "$OSFLAVOUR" = "OSX" ]; then
1352                         disktool -m ${CDROM#/dev/}
1353                 fi
1354                 WEHAVEACD=y
1355                 DISCID=$(echo $TRACKINFO | cut -f1 -d' ')
1356         else
1357                 TRACKINFO=$(cat "$WAVOUTPUTDIR/abcde.$DISCID/discid")
1358         fi
1359
1360         # Get a full enumeration of tracks, sort it, and put it in the TRACKQUEUE.
1361         # This needs to be done now because a section of the resuming code will need
1362         # it later.
1363
1364         # get the number of digits to pad TRACKNUM with - we'll use this later
1365         # a CD can only hold 99 tracks, but since we support a feature for starting
1366         # numbering the tracks from a given number, we might need to set it as a
1367         # variable for the user to define... or obtain it somehow.
1368         if [ "$PADTRACKS" = "y" ] ; then
1369                 TRACKNUMPADDING=2
1370         fi
1371
1372         ABCDETEMPDIR="$WAVOUTPUTDIR/abcde.$(echo $TRACKINFO | cut -f1 -d' ')"
1373         if [ -z "$TRACKQUEUE" ]; then
1374                 if [ ! "$STRIPDATATRACKS" = "y" ]; then
1375                         case "$CDROMREADERSYNTAX" in
1376                                 cdparanoia|debug)
1377                                         if [ "$WEHAVEACD" = "y" ]; then
1378                                                 vecho "Querying the CD for audio tracks..."
1379                                                 CDPARANOIAOUTPUT="$( $CDROMREADER -$CDPARANOIACDROMBUS $CDROM -Q --verbose 2>&1 )"
1380                                                 RET=$?
1381                                                 if [ ! "$RET" = "0" ];then
1382                                                         log warning "something went wrong while querying the CD... Maybe a DATA CD?"
1383                                                 fi
1384                                                 TRACKS="$(echo "$CDPARANOIAOUTPUT" | egrep '^[[:space:]]+[[:digit:]]' | tail -n 1 | get_first | tr -d "." | tr '\n' ' ')"
1385                                                 CDPARANOIAAUDIOTRACKS="$TRACKS"
1386                                         else
1387                                                 # Previous versions of abcde would store the tracks on a file, instead of the status record.
1388                                                 if [ -f "$ABCDETEMPDIR/cdparanoia-audio-tracks" ]; then
1389                                                         echo cdparanoia-audio-tracks=$( cat "$ABCDETEMPDIR/cdparanoia-audio-tracks" ) >> "$ABCDETEMPDIR/status"
1390                                                         rm -f "$ABCDETEMPDIR/cdparanoia-audio-tracks"
1391                                                 fi
1392                                                 if [ -f "$ABCDETEMPDIR/status" ] && TRACKS=$(checkstatus cdparanoia-audio-tracks); then :; else
1393                                                         TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1394                                                 fi
1395                                         fi
1396                                         ;;
1397                                 *)      TRACKS=$(echo $TRACKINFO | cut -f2 -d' ') ;;
1398                         esac
1399                 else
1400                         TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1401                 fi
1402                 if echo "$TRACKS" | grep "[[:digit:]]" > /dev/null 2>&1 ;then :;else
1403                         log info "The disc does not contain any tracks. Giving up..."
1404                         exit 0
1405                 fi
1406                 echo -n "Grabbing entire CD - tracks: "
1407                 if [ ! "$PADTRACKS" = "y" ] ; then
1408                         TRACKNUMPADDING=$(echo -n $TRACKS | wc -c | tr -d ' ')
1409                 fi
1410                 TRACKS=$(printf "%0.${TRACKNUMPADDING}d" $TRACKS)
1411                 X=0
1412                 while [ "$X" -ne "$TRACKS" ]
1413                 do
1414                         X=$(printf "%0.${TRACKNUMPADDING}d" $(expr $X + 1))
1415                         TRACKQUEUE=$(echo $TRACKQUEUE $X)
1416                 done
1417                 echo $TRACKQUEUE
1418         else
1419                 TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1420                 # User-supplied track queue.
1421                 # Weed out non-numbers, whitespace, then sort and weed out duplicates
1422                 TRACKQUEUE=$(echo $TRACKQUEUE | sed 's-[^0-9 ]--g' | tr ' ' '\n' | grep -v ^$ | sort -n | uniq | tr '\n' ' ' | sed 's- $--g')
1423                 # Once cleaned, obtain the highest value in the trackqueue for number padding
1424                 for LASTTRACK in $TRACKQUEUE; do :; done
1425                 if [ ! "$PADTRACKS" = "y" ] ; then
1426                         TRACKNUMPADDING=$(echo -n $LASTTRACK | wc -c | tr -d ' ')
1427                 fi
1428                 # Now we normalize the trackqueue
1429                 for TRACK in $TRACKQUEUE ; do
1430                         TRACKNUM=$(printf %0.${TRACKNUMPADDING}d $(expr ${TRACK} + 0 ))
1431                         PADTRACKQUEUE=$(echo $PADTRACKQUEUE $TRACKNUM)
1432                 done
1433                 TRACKQUEUE=$PADTRACKQUEUE
1434                 echo Grabbing tracks: "$TRACKQUEUE"
1435         fi
1436
1437         QUEUEDTRACKS=$(echo $TRACKQUEUE | wc -w | tr -d ' ')
1438
1439         # We have the discid, create a temp directory after it to store all the temp
1440         # info
1441
1442         if [ -e "$ABCDETEMPDIR" ]; then
1443                 echo -n "abcde: attempting to resume from $ABCDETEMPDIR"
1444                 # It already exists, see if it's a directory
1445                 if [ ! -d "$ABCDETEMPDIR" ]; then
1446                         # This is a file/socket/fifo/device/etc, not a directory
1447                         # Complain and exit
1448                         echo >&2
1449                         echo "abcde: file $ABCDETEMPDIR already exists and does not belong to abcde." >&2
1450                         echo "Please investigate, remove it, and rerun abcde." >&2
1451                         exit 1
1452                 fi
1453                 echo -n .
1454                 # It's a directory, let's see if it's owned by us
1455                 if [ ! -O "$ABCDETEMPDIR" ]; then
1456                         # Nope, complain and exit
1457                         echo >&2
1458                         echo "abcde: directory $ABCDETEMPDIR already exists and is not owned by you." >&2
1459                         echo "Please investigate, remove it, and rerun abcde." >&2
1460                         exit 1
1461                 fi
1462                 echo .
1463                 # See if it's populated
1464                 if [ ! -f "$ABCDETEMPDIR/discid" ]; then
1465                         # Wipe and start fresh
1466                         echo "abcde: $ABCDETEMPDIR/discid not found. Abcde must remove and recreate" >&2
1467                         echo -n "this directory to continue. Continue? [y/n] (n)" >&2
1468                         if [ "$INTERACTIVE" = "y" ]; then
1469                                 read ANSWER
1470                         else
1471                                 echo y >&2
1472                                 ANSWER=y
1473                         fi
1474                         if [ "$ANSWER" != "y" ]; then
1475                                 exit 1
1476                         fi
1477                         rm -rf "$ABCDETEMPDIR" || exit 1
1478                         mkdir "$ABCDETEMPDIR"
1479                         if [ "$?" -gt "0" ]; then
1480                                 # Directory already exists or could not be created
1481                                 echo "abcde: Temp directory $ABCDETEMPDIR could not be created." >&2
1482                                 exit 1
1483                         fi
1484                 else
1485                         # Everything is fine. Check for ^encodetracklocation-
1486                         # and encode-output entries in the status file and
1487                         # remove them. These are not relevant across sessions.
1488                         if [ -f "$ABCDETEMPDIR/status" ]; then
1489                                 mv "$ABCDETEMPDIR/status" "$ABCDETEMPDIR/status.old"
1490                                 grep -v ^encodetracklocation- < "$ABCDETEMPDIR/status.old" \
1491                                         | grep -v ^encode-output > "$ABCDETEMPDIR/status"
1492                         fi
1493                         # Remove old error messages
1494                         if [ -f "$ABCDETEMPDIR/errors" ]; then
1495                                 rm -f "$ABCDETEMPDIR/errors"
1496                         fi
1497                 fi
1498         else
1499                 # We are starting from scratch
1500                 mkdir "$ABCDETEMPDIR"
1501                 if [ "$?" -gt "0" ]; then
1502                         # Directory already exists or could not be created
1503                         echo "abcde: Temp directory $ABCDETEMPDIR could not be created." >&2
1504                         exit 1
1505                 fi
1506                 cat /dev/null > "$ABCDETEMPDIR/status"
1507                 # Store the abcde version in the status file.
1508                 echo "abcde-version=$VERSION" >> "$ABCDETEMPDIR/status"
1509         fi
1510         if [ X"$MAKECUEFILE" = "Xy" -a X"$WEHAVEACD" = "Xy" ]; then
1511                 if checkstatus cuefile > /dev/null 2>&1 ; then :; else
1512                         CUEFILE=cue-$(echo "$TRACKINFO" | cut -f1 -d' ').txt
1513                         vecho "Creating cue file..."
1514                         if $CUEREADER $CUEREADEROPTS > "$ABCDETEMPDIR/$CUEFILE"; then
1515                                 echo cuefile=$CUEFILE >> "$ABCDETEMPDIR/status"
1516                         else
1517                                 log warning "reading the CUE sheet with mkcue is still considered experimental"
1518                                 log warning "and there was a problem with the CD reading. abcde will continue,"
1519                                 log warning "but consider reporting the problem to the abcde author"
1520                         fi
1521                 fi
1522         fi
1523         # If we got the CDPARANOIA status and it is not recorded, save it now
1524         if [ -n "$CDPARANOIAAUDIOTRACKS" ]; then
1525                 if checkstatus cdparanoia-audio-tracks > /dev/null 2>&1; then :; else
1526                         echo cdparanoia-audio-tracks=$CDPARANOIAAUDIOTRACKS >> "$ABCDETEMPDIR/status"
1527                 fi
1528         fi
1529         
1530         # Create the discid file
1531         echo "$TRACKINFO" > "$ABCDETEMPDIR/discid"
1532 }
1533
1534 # do_cleancue
1535 # Create a proper CUE file based on the CUE file we created before.
1536 do_cleancue()
1537 {
1538         if CUEFILE_IN="$ABCDETEMPDIR"/$(checkstatus cuefile); then
1539                 CUEFILE_OUT=$CUEFILE_IN.out
1540                 ### FIXME ### checkstatus cddb
1541                 if [ -e "$CDDBDATA" ]; then
1542                         vecho "Adding metadata to the cue file..."
1543                         # FIXME It doesn't preserve spaces! Why?
1544                         # FIXME parse $track into PERFORMER and TITLE - abcde already has code for this?
1545                         n=1
1546                         echo "PERFORMER \"$DARTIST\"" >> "$CUEFILE_OUT"
1547                         echo "TITLE \"$DALBUM\"" >> "$CUEFILE_OUT"
1548                         cat "$CUEFILE_IN" | while read line
1549                         do
1550                                 if echo "$line" | grep -q "INDEX"
1551                                 then
1552                                         eval track="\$TRACK$n"
1553                                         n=$(expr $n + 1)
1554                                         echo "TITLE \"$track\"" >> "$CUEFILE_OUT"
1555                                 fi
1556                                 echo "$line" >> "$CUEFILE_OUT"
1557                         done
1558                         mv "$CUEFILE_OUT" "$CUEFILE_IN"
1559                         echo "cleancuefile" >> "$ABCDETEMPDIR/status"
1560                 fi
1561         fi
1562 }
1563
1564 # do_cddbparse
1565 # Parses a CDDB file and outputs the title and the track names.
1566 # Variables: CDDBFILE
1567 do_cddbparse ()
1568 {
1569         CDDBPARSEFILE="$1"
1570         # List out disc title/author and contents
1571         if [ "$ONETRACK" = "y" ]; then
1572                 vecho "ONETRACK mode selected: displaying only the title of the CD..."
1573         fi
1574         echo "---- $(grep DTITLE "${CDDBPARSEFILE}" | cut '-d=' -f2- | tr -d \\r\\n ) ----"
1575         if [ X"$SHOWCDDBYEAR" = "Xy" ]; then
1576                 PARSEDYEAR=$(grep DYEAR "${CDDBPARSEFILE}" | cut '-d=' -f2-)
1577                 if [ ! X"$PARSEDYEAR" = "X" ]; then
1578                         echo "Year: $PARSEDYEAR"
1579                 fi
1580         fi
1581         if [ X"$SHOWCDDBGENRE" = "Xy" ]; then
1582                 PARSEDGENRE=$(grep DGENRE "${CDDBPARSEFILE}" | cut '-d=' -f2-)
1583                 if [ ! X"$PARSEDGENRE" = "X" ]; then
1584                         echo "Genre: $PARSEDGENRE"
1585                 fi
1586         fi
1587         if [ ! "$ONETRACK" = "y" ]; then
1588                 for TRACK in $(f_seq_row 1 $TRACKS)
1589                 do
1590                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "${CDDBPARSEFILE}" | cut -f2- -d= | tr -d \\r\\n)"
1591                 done
1592         fi
1593 }
1594
1595 # do_localcddb
1596 # Check for a local CDDB file, and report success
1597 do_localcddb ()
1598 {
1599         if checkstatus cddb-readcomplete && checkstatus cddb-choice >/dev/null; then :; else
1600         
1601                 CDDBLOCALSUCCESS="n"
1602                 CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
1603                 CDDBLOCALFILE="${CDDBLOCALDIR}/${CDDBDISCID}"
1604                 USELOCALRESP="y"
1605                 
1606                 # If the user has selected to check a local CDDB repo, we proceed with it
1607                 if [ -r "${CDDBLOCALFILE}" ]; then
1608                         # List out disc title/author and contents
1609                         do_cddbparse "${CDDBLOCALFILE}"
1610                         echo -n "Locally cached CDDB entry found, use it? [y/n] (y): "
1611                         if [ "$INTERACTIVE" = "y" ]; then
1612                                 read USELOCALRESP
1613                                 while [ "$USELOCALRESP" != "y" ] && [ "$USELOCALRESP" != "n" ] && [ "$USELOCALRESP" != "" ] ; do
1614                                         echo -n 'Invalid selection. Please answer "y" or "n": '
1615                                         read USELOCALRESP
1616                                 done
1617                                 [ x"$USELOCALRESP" = "x" ] && USELOCALRESP="y"
1618                         else
1619                                 echo "y" >&2
1620                         fi
1621                         if [ "$USELOCALRESP" = "y" ]; then
1622                                 #echo "Using local copy of CDDB data"
1623                                 echo "# DO NOT ERASE THIS LINE! Added by abcde to imitate cddb output" > "$ABCDETEMPDIR/cddbread.1"
1624                                 cat "${CDDBLOCALFILE}" >> "$ABCDETEMPDIR/cddbread.1"
1625                                 echo 999 > "$ABCDETEMPDIR/cddbquery" # Assuming 999 isn't used by CDDB
1626                                 echo cddb-readcomplete >> "$ABCDETEMPDIR/status"
1627                                 do_cddbparse "${CDDBLOCALFILE}" > "$ABCDETEMPDIR/cddbchoices"
1628                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
1629                                 CDDBLOCALSUCCESS="y"
1630                         else
1631                                 #echo "Not using local copy of CDDB data"
1632                                 CDDBLOCALSUCCESS="n"
1633                         fi
1634                 else
1635                         CDDBLOCALSUCCESS="n"
1636                 fi
1637         fi
1638 }
1639
1640 # do_cddbstat
1641 do_cddbstat ()
1642 {
1643         # Perform CDDB protocol version check if it hasn't already been done
1644         if checkstatus cddb-statcomplete; then :; else
1645                 if [ "$CDDBAVAIL" = "n" ]; then
1646                         ERRORCODE=no_query
1647                         echo 503 > "$ABCDETEMPDIR/cddbstat"
1648                 else
1649                         rc=1
1650                         CDDBUSER=$(echo $HELLOINFO | cut -f1 -d'@')
1651                         CDDBHOST=$(echo $HELLOINFO | cut -f2- -d'@')
1652                         while test $rc -eq 1 -a $CDDBPROTO -ge 3; do
1653                                 vecho "Checking CDDB server status..."
1654                                 $CDDBTOOL stat $CDDBURL $CDDBUSER $CDDBHOST $CDDBPROTO > "$ABCDETEMPDIR/cddbstat"
1655                                 RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbstat" | cut -f1 -d' ')
1656                                 case "$RESPONSECODE" in
1657                                 210)    # 210 OK, status information follows (until terminating `.')
1658                                         rc=0;
1659                                         ;;
1660                                 501|*)  # 501 Illegal CDDB protocol level: <n>. 
1661                                         CDDBPROTO=`expr $CDDBPROTO - 1`
1662                                         ;;
1663                                 esac 
1664                         done
1665                         if test $rc -eq 1; then
1666                                 CDDBAVAIL="n" 
1667                         fi
1668                 fi
1669                 echo cddb-statcomplete >> "$ABCDETEMPDIR/status"
1670         fi
1671 }
1672
1673
1674 # do_cddbquery
1675 do_cddbquery ()
1676 {
1677         CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
1678         CDDBLOCALFILE="${CDDBLOCALDIR}/${CDDBDISCID}"
1679         
1680         # Perform CDDB query if it hasn't already been done
1681         if checkstatus cddb-querycomplete; then :; else
1682                 if [ "$CDDBAVAIL" = "n" ]; then
1683                         ERRORCODE=no_query
1684                         echo 503 > "$ABCDETEMPDIR/cddbquery"
1685                 # The default CDDBLOCALSUCCESS is "n"
1686                 # This part will be triggered if the user CDDB repo does not 
1687                 # contain the entry, or if we are not trying to use the repo.
1688                 else
1689                         vecho "Querying the CDDB server..."
1690                         CDDBUSER=$(echo $HELLOINFO | cut -f1 -d'@')
1691                         CDDBHOST=$(echo $HELLOINFO | cut -f2- -d'@')
1692                         $CDDBTOOL query $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $TRACKINFO > "$ABCDETEMPDIR/cddbquery"
1693                         ERRORCODE=$?
1694                         case $ERRORCODE in
1695                                 0)  # success
1696                                 ;;
1697                                 12|13|14)
1698                                         # no match found in database,
1699                                         # wget/fetch error, or user requested not to use CDDB
1700                                         # Make up an error code (503) that abcde
1701                                         # will recognize in do_cddbread
1702                                         # and compensate by making a template
1703                                         echo 503 > "$ABCDETEMPDIR/cddbquery"
1704                                 ;;
1705                                 *) # strange and unknown error
1706                                         echo ERRORCODE=$ERRORCODE
1707                                         echo "abcde: $CDDBTOOL returned unknown error code"
1708                                 ;;
1709                         esac
1710                 fi
1711                 echo cddb-querycomplete >> "$ABCDETEMPDIR/status"
1712         fi
1713 }
1714
1715 # do_cddbread
1716 do_cddbread ()
1717 {
1718         # If it's not to be used, generate a template.
1719         # Then, display it (or them) and let the user choose/edit it
1720         if checkstatus cddb-readcomplete; then :; else
1721                 vecho "Obtaining CDDB results..."
1722                 # If CDDB is to be used, interpret the query results and read all
1723                 # the available entries.
1724                 rm -f "$ABCDETEMPDIR/cddbchoices"
1725                 CDDBCHOICES=1 # Overridden by multiple matches
1726                 RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbquery" | cut -f1 -d' ')
1727                 case "$RESPONSECODE" in
1728                 200)
1729                         # One exact match, retrieve it
1730                         # 200 [section] [discid] [artist] / [title]
1731                         if checkstatus cddb-read-1-complete; then :; else
1732                                 echo -n "Retrieving 1 CDDB match..." >> "$ABCDETEMPDIR/cddbchoices"
1733                                 $CDDBTOOL read $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $(cut -f2,3 -d' ' "$ABCDETEMPDIR/cddbquery") > "$ABCDETEMPDIR/cddbread.1"
1734                                 echo "done." >> "$ABCDETEMPDIR/cddbchoices"
1735                                 echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
1736                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
1737                         fi
1738                         # List out disc title/author and contents
1739                         echo ---- "$(cut '-d ' -f4- "$ABCDETEMPDIR/cddbquery")" ---- >> "$ABCDETEMPDIR/cddbchoices"
1740                         for TRACK in $(f_seq_row 1 $TRACKS)
1741                         do
1742                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
1743                         done
1744                         echo >> "$ABCDETEMPDIR/cddbchoices"
1745                         ;;
1746                 202|403|409|503)
1747                         # No match
1748                         case "$RESPONSECODE" in
1749                         202) echo "No CDDB match." >> "$ABCDETEMPDIR/cddbchoices" ;;
1750                         403|409) echo "CDDB entry is corrupt, or the handshake failed." >> "$ABCDETEMPDIR/cddbchoices" ;;
1751                         503) echo "CDDB unavailable." >> "$ABCDETEMPDIR/cddbchoices" ;;
1752                         esac
1753                         $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
1754                         # List out disc title/author and contents of template
1755                         echo ---- Unknown Artist / Unknown Album ---- >> "$ABCDETEMPDIR/cddbchoices"
1756                         UNKNOWNDISK=y
1757                         for TRACK in $(f_seq_row 1 $TRACKS)
1758                         do
1759                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.0" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
1760                         done
1761                         echo >> "$ABCDETEMPDIR/cddbchoices"
1762                         echo cddb-read-0-complete >> "$ABCDETEMPDIR/status"
1763                         echo cddb-choice=0 >> "$ABCDETEMPDIR/status"
1764                         ;;
1765                 210|211)
1766                         # Multiple exact, (possibly multiple) inexact matches
1767                         IN=
1768                         if [ "$RESPONSECODE" = "211" ]; then IN=in; fi
1769                         if [ "$(wc -l < "$ABCDETEMPDIR/cddbquery" | tr -d ' ')" -eq 3 ]; then
1770                                 echo "One ${IN}exact match:" >> "$ABCDETEMPDIR/cddbchoices"
1771                                 tail -n +2 "$ABCDETEMPDIR/cddbquery" | head -n 1 >> "$ABCDETEMPDIR/cddbchoices"
1772                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
1773                         else
1774                                 echo "Multiple ${IN}exact matches:" >> "$ABCDETEMPDIR/cddbchoices"
1775                         fi
1776                         vecho -n "Retrieving multiple matches... "
1777                         grep -v ^[.]$ "$ABCDETEMPDIR/cddbquery" | ( X=0
1778                         read DISCINFO # eat top line
1779                         while read DISCINFO
1780                         do
1781                                 X=$(expr $X + 1)
1782                                 if checkstatus cddb-read-$X-complete; then :; else
1783                                         $CDDBTOOL read $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $(echo $DISCINFO | cut -f1,2 -d' ') > "$ABCDETEMPDIR/cddbread.$X"
1784                                         echo cddb-read-$X-complete >> "$ABCDETEMPDIR/status"
1785                                 fi
1786                                 # List out disc title/author and contents
1787                                 echo \#$X: ---- "$DISCINFO" ---- >> "$ABCDETEMPDIR/cddbchoices"
1788                                 for TRACK in $(f_seq_row 1 $TRACKS)
1789                                 do
1790                                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.$X" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
1791                                 done
1792                                 echo >> "$ABCDETEMPDIR/cddbchoices"
1793                         done )
1794                         vecho "done."
1795                         CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
1796                         ;;
1797                 999)
1798                         # Using local copy.
1799                         for TRACK in $(f_seq_row 1 $TRACKS)
1800                         do
1801                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
1802                         done
1803                         echo >> "$ABCDETEMPDIR/cddbchoices"
1804                         echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
1805                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
1806                         ;;
1807                 esac    
1808                 echo "cddb-readcomplete" >> "$ABCDETEMPDIR/status"
1809         fi
1810 }
1811
1812 # do_cddbedit
1813 do_cddbedit ()
1814 {
1815         if checkstatus cddb-edit >/dev/null; then
1816                 CDDBDATA="$ABCDETEMPDIR/cddbread.$(checkstatus cddb-choice)"
1817                 VARIOUSARTISTS="$(checkstatus variousartists)"
1818                 VARIOUSARTISTSTYLE="$(checkstatus variousartiststyle)"
1819                 return 0
1820         fi
1821         if [ "$INTERACTIVE" = "y" ]; then
1822                 # We should show the CDDB results both when we are not using the local CDDB repo
1823                 # or when we are using it but we could not find a proper match
1824                 if [ "$CDDBUSELOCAL" = "y" ] && [ ! "$CDDBLOCALSUCCESS" = "y" ] || [ ! "$CDDBUSELOCAL" = "y" ]; then
1825                         # Display the $ABCDETEMPDIR/cddbchoices file created above
1826                         # Pick a pager so that if the tracks overflow the screen the user can still view everything
1827                         if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
1828                                 CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
1829                                 CHOICE=$(checkstatus cddb-choice)
1830                                 if [ -n "$CHOICE" ] ; then
1831                                         case $CDDBCHOICES in
1832                                                 1) cat "$ABCDETEMPDIR/cddbchoices" ;;
1833                                                 *)
1834                                                 echo "Selected: #$CHOICE"
1835                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$CHOICE"
1836                                                 ;;
1837                                         esac
1838                                 else
1839                                         # The user has a choice to make, display the info in a pager if necessary
1840                                         if [ $(cat "$ABCDETEMPDIR/cddbchoices" | wc -l) -ge 24 ]; then
1841                                                 page "$ABCDETEMPDIR/cddbchoices"
1842                                         else
1843                                                 # It's all going to fit in one page, cat it
1844                                                 cat "$ABCDETEMPDIR/cddbchoices" >&2
1845                                         fi
1846                                         
1847                                         CDDBCHOICENUM=""
1848                                         # Setting the choice to an impossible integer to avoid errors in the numeric comparisons
1849                                         CDCHOICENUM=-1
1850                                         # I'll take CDDB read #3 for $400, Alex
1851                                         while [ $CDCHOICENUM -lt 0 ] || [ $CDCHOICENUM -gt $CDDBCHOICES ]; do
1852                                                 echo -n "Which entry would you like abcde to use (0 for none)? [0-$CDDBCHOICES]: " >&2
1853                                                 read CDDBCHOICE
1854                                                 [ X"$CDDBCHOICE" = "X" ] && CDDBCHOICE=1
1855                                                 if echo $CDDBCHOICE | egrep -q "[[:digit:]]+,[[:digit:]]+" ; then
1856                                                         if [ ! X"$DIFF" = "X" ]; then
1857                                                                 PARSECHOICE1=$(echo $CDDBCHOICE | cut -d"," -f1)
1858                                                                 PARSECHOICE2=$(echo $CDDBCHOICE | cut -d"," -f2)
1859                                                                 if [ $PARSECHOICE1 -lt 1 ] || [ $PARSECHOICE1 -gt $CDDBCHOICES ] || \
1860                                                                    [ $PARSECHOICE2 -lt 1 ] || [ $PARSECHOICE2 -gt $CDDBCHOICES ] || \
1861                                                                    [ $PARSECHOICE1 -eq $PARSECHOICE2 ]; then 
1862                                                                         echo "Invalid diff range. Please select two coma-separated numbers between 1 and $CDDBCHOICES" >&2
1863                                                                 else
1864
1865                                                                         # We parse the 2 choices to diff, store them in temporary files and diff them.
1866                                                                         for PARSECHOICE in $(echo $CDDBCHOICE | tr , \ ); do
1867                                                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$PARSECHOICE" > "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE"
1868                                                                         done
1869                                                                         echo "Showing diff between choices $PARSECHOICE1 and $PARSECHOICE2..." > "$ABCDETEMPDIR/cddbread.diff"
1870                                                                         $DIFF $DIFFOPTS "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE1" "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE2" >> "$ABCDETEMPDIR/cddbread.diff"
1871                                                                         if [ $(cat "$ABCDETEMPDIR/cddbread.diff" | wc -l) -ge 24 ]; then
1872                                                                                 page "$ABCDETEMPDIR/cddbread.diff"
1873                                                                         else
1874                                                                                 cat "$ABCDETEMPDIR/cddbread.diff" >&2
1875                                                                         fi
1876                                                                 fi
1877                                                         else
1878                                                                 echo "The diff program was not found in your path. Please choose a number between 0 and $CDDBCHOICES." >&2
1879                                                         fi
1880                                                 else
1881                                                         if [ $CDCHOICENUM -lt 0 ] || [ $CDCHOICENUM -gt $CDDBCHOICES ]; then
1882                                                                 # Make sure we get a valid choice
1883                                                                 CDCHOICENUM=$(echo $CDDBCHOICE | xargs printf %d 2>/dev/null)
1884                                                                 echo "Invalid selection. Please choose a number between 0 and $CDDBCHOICES." >&2
1885                                                         fi
1886                                                 fi
1887                                         done
1888                                         if [ "$CDCHOICENUM" = "0" ]; then
1889                                                 vecho "Creating empty CDDB template..."
1890                                                 UNKNOWNDISK=y
1891                                                 $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
1892                                         else
1893                                                 echo "Selected: #$CDCHOICENUM ($(grep ^DTITLE= "$ABCDETEMPDIR/cddbread.$CDCHOICENUM" | cut -f2- -d= | tr -d \\r\\n))" >&2
1894                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$CDCHOICENUM"
1895                                         fi
1896                                         echo "cddb-choice=$CDCHOICENUM" >> "$ABCDETEMPDIR/status"
1897                                 fi
1898                         fi
1899                 else
1900                         # We need some code to show the selected option when local repository is selected and we have found a match
1901                         vecho "Using cached CDDB match..." >&2
1902                         # Display the $ABCDETEMPDIR/cddbchoices file created above
1903                         # Pick a pager so that if the tracks overflow the screen the user can still view everything
1904                         if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
1905                                 CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
1906                                 CHOICE=$(checkstatus cddb-choice)
1907                                 if [ "$USELOCALRESP" = "y" ]; then :; else
1908                                         if [ -n "$CHOICE" ] ; then
1909                                                 case $CDDBCHOICES in
1910                                                         0) 
1911                                                         UNKNOWNDISK=y
1912                                                         echo "Selected template."
1913                                                         ;;
1914                                                         1) cat "$ABCDETEMPDIR/cddbchoices" ;;
1915                                                         *)
1916                                                         echo "Selected: #$CHOICE"
1917                                                         do_cddbparse "$ABCDETEMPDIR/cddbread.$CHOICE"
1918                                                         ;;
1919                                                 esac
1920                                         fi
1921                                 fi
1922                         fi
1923                 fi
1924         else
1925                 # We're noninteractive - pick the first choice.
1926                 # But in case we run a previous instance and selected a choice, use it.
1927                 if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
1928                         # Show the choice if we are not using the locally stored one
1929                         # or when the local search failed to find a match.
1930                         PREVIOUSCHOICE=$(checkstatus cddb-choice)
1931                         if [ "$CDDBUSELOCAL" = "y" ] && [ "$CDDBLOCALSUCCESS" = "n" ] || [ ! "$CDDBUSELOCAL" = "y" ]; then
1932                                 #if [ "$PREVIOUSCHOICE" ]; then
1933                                         cat "$ABCDETEMPDIR/cddbchoices"
1934                                 #fi
1935                         fi
1936                         if [ ! -z "$PREVIOUSCHOICE" ] ; then
1937                                 CDCHOICENUM=$PREVIOUSCHOICE
1938                         else
1939                                 CDCHOICENUM=1
1940                                 echo "cddb-choice=$CDCHOICENUM" >> "$ABCDETEMPDIR/status"
1941                         fi
1942                         echo "Selected: #$CDCHOICENUM ($(grep ^DTITLE= "$ABCDETEMPDIR/cddbread.$CDCHOICENUM" | cut -f2- -d= | tr -d \\r\\n))" >&2
1943                 fi
1944         fi
1945
1946         # sanity check
1947         if checkstatus cddb-choice >/dev/null; then :; else
1948                 echo "abcde: internal error: cddb-choice not recorded." >&2
1949                 exit 1
1950         fi
1951         CDDBDATA="$ABCDETEMPDIR/cddbread.$(checkstatus cddb-choice)"
1952         echo -n "Edit selected CDDB data? [y/n] (" >&2
1953         if [ "$INTERACTIVE" = "y" ]; then
1954                 if [ "$UNKNOWNDISK" = "y" ]; then
1955                         echo -n "y): " >&2
1956                         read EDITCDDB
1957                         [ "$EDITCDDB" != "n" ] && EDITCDDB=y
1958                 else
1959                         echo -n "n): " >&2
1960                         read EDITCDDB
1961                 fi
1962         else
1963                 echo "n): n" >&2
1964                 EDITCDDB=n
1965         fi
1966         if [ "$EDITCDDB" = "y" ]; then
1967                 CDDBDATAMD5SUM=$($MD5SUM "$CDDBDATA" | cut -d " " -f 1);
1968                 
1969                 # Use the debian sensible-editor wrapper to pick the editor that the
1970                 # user has requested via their $EDITOR environment variable
1971                 if [ -x "/usr/bin/sensible-editor" ]; then
1972                         /usr/bin/sensible-editor "$CDDBDATA"
1973                 elif [ -n "$EDITOR" ]; then
1974                         if [ -x $(which "${EDITOR%%\ *}") ]; then
1975                                 # That failed, try to load the preferred editor, starting
1976                                 # with their EDITOR variable
1977                                 eval $(echo "$EDITOR") \"$CDDBDATA\"
1978                         fi
1979                 # If that fails, check for a vi
1980                 elif which vi >/dev/null 2>&1; then
1981                         vi "$CDDBDATA"
1982                 elif [ -x /usr/bin/vim ]; then
1983                         /usr/bin/vim "$CDDBDATA"
1984                 elif [ -x /usr/bin/vi ]; then
1985                         /usr/bin/vi "$CDDBDATA"
1986                 elif [ -x /bin/vi ]; then
1987                         /bin/vi "$CDDBDATA"
1988                 # nano should be on all (modern, i.e., sarge) debian systems
1989                 elif which nano >/dev/null 2>&1 ; then
1990                         nano "$CDDBDATA"
1991                 elif [ -x /usr/bin/nano ]; then
1992                         /usr/bin/nano "$CDDBDATA"
1993                 # mg should be on all OpenBSD systems
1994                 elif which mg >/dev/null 2>&1 ; then
1995                         mg "$CDDBDATA"
1996                 elif [ -x /usr/bin/mg ]; then
1997                         /usr/bin/mg "$CDDBDATA"
1998                 # bomb out
1999                 else
2000                         log warning "no editor available. Check your EDITOR environment variable."
2001                 fi
2002                 # delete editor backup file if it exists
2003                 if [ -w "$CDDBDATA~" ]; then
2004                         rm -f "$CDDBDATA~"
2005                 fi
2006         fi
2007
2008         # Some heuristics first. Look at Disc Title, and if it starts with
2009         # "Various", then we'll assume Various Artists
2010         if [ "$(grep ^DTITLE= "$CDDBDATA" | cut -f2- -d= | egrep -ci '^(various|soundtrack|varios|sonora|ost)')" != "0" ]; then
2011                 echo "Looks like a Multi-Artist CD" >&2
2012                 VARIOUSARTISTS=y
2013         else
2014                 echo -n "Is the CD multi-artist? [y/n] (n): " >&2
2015                 if [ "$INTERACTIVE" = "y" ]; then
2016                         read VARIOUSARTISTS
2017                 else
2018                         echo n >&2
2019                         VARIOUSARTISTS=n
2020                 fi
2021         fi
2022         if [ "$VARIOUSARTISTS" = "y" ] && [ ! "$ONETRACK" = "y" ]; then
2023                 # Set a default
2024                 DEFAULTSTYLE=1
2025                 # Need NUMTRACKS before cddb-tool will return it:
2026                 NUMTRACKS=$(egrep '^TTITLE[0-9]+=' "$CDDBDATA" | wc -l)
2027                 if [ "$(grep -c "^TTITLE.*\/" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2028                         # More than 1/2 tracks contain a "/", so guess forward
2029                         DEFAULTSTYLE=1
2030                 elif [ "$(grep -c "^TTITLE.*\-" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2031                         # More than 1/2 contain a "-", so guess forward-dash
2032                         DEFAULTSTYLE=2
2033                 elif [ "$(grep -c "^TTITLE.*(.*)" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2034                         # More than 1/2 contain something in parens, so guess trailing-paren
2035                         DEFAULTSTYLE=6
2036                 fi
2037
2038                 echo "1) Artist / Title" >&2
2039                 echo "2) Artist - Title" >&2
2040                 echo "3) Title / Artist" >&2
2041                 echo "4) Title - Artist" >&2
2042                 echo "5) Artist: Title" >&2
2043                 echo "6) Title (Artist)" >&2
2044                 echo "7) This is a single-artist CD" >&2
2045                 echo -n "Which style of multiple artist entries is it? [1-7] ($DEFAULTSTYLE): " >&2
2046                 if [ "$INTERACTIVE" = "y" ]; then
2047                         read VARIOUSARTISTSTYLE
2048                 else
2049                         echo $DEFAULTSTYLE >&2
2050                         VARIOUSARTISTSTYLE=$DEFAULTSTYLE
2051                 fi
2052                 VARIOUSARTISTSTYLE=$(echo 0$VARIOUSARTISTSTYLE | xargs printf %d)
2053                 # If they press Enter, then the default style (0) was chosen
2054                 while [ $VARIOUSARTISTSTYLE -lt 0 ] || [ $VARIOUSARTISTSTYLE -gt 7 ]; do
2055                         echo "Invalid selection. Please choose a number between 1 and 7."
2056                         echo -n "Selection [1-7]: "
2057                         read VARIOUSARTISTSTYLE
2058                         VARIOUSARTISTSTYLE=$(echo 0$VARIOUSARTISTSTYLE | xargs printf %d)
2059                 done
2060                 if [ "$VARIOUSARTISTSTYLE" = "0" ]; then
2061                         VARIOUSARTISTSTYLE=$DEFAULTSTYLE
2062                 fi
2063                 vecho "Selected: $VARIOUSARTISTSTYLE"
2064                 case "$VARIOUSARTISTSTYLE" in
2065                 1) # Artist / Title
2066                         VARIOUSARTISTSTYLE=forward
2067                         ;;
2068                 2) # Artist - Title
2069                         VARIOUSARTISTSTYLE=forward-dash
2070                         ;;
2071                 3) # Title / Artist
2072                         VARIOUSARTISTSTYLE=reverse
2073                         ;;
2074                 4) # Title - Artist
2075                         VARIOUSARTISTSTYLE=reverse-dash
2076                         ;;
2077                 5) # Artist: Title
2078                         VARIOUSARTISTSTYLE=colon
2079                         ;;
2080                 6) # Title (Artist)
2081                         VARIOUSARTISTSTYLE=trailing-paren
2082                         ;;
2083                 7) # Single Artist
2084                         VARIOUSARTISTS=n
2085                         ;;
2086                 esac
2087         fi
2088
2089         echo "variousartists=$VARIOUSARTISTS" >> "$ABCDETEMPDIR/status"
2090         echo "variousartiststyle=$VARIOUSARTISTSTYLE" >> "$ABCDETEMPDIR/status"
2091
2092         if [ "$EDITCDDB" = "y" ] && [ "$UNINTENTIONALLY_ANGER_THE_FREEDB_PEOPLE" = "y" ]; then
2093                 if [ "$CDDBDATAMD5SUM" != "" ]  && [ "$CDDBDATAMD5SUM" != "$($MD5SUM "$CDDBDATA" | cut -d " " -f 1)" ]; then
2094                         # This works but does not have the necessary error checking
2095                         # yet. If you are familiar with the CDDB spec
2096                         # (see http://www.freedb.org/src/latest/DBFORMAT) 
2097                         # and can create an error-free entry on your own, then put
2098                         # UNINTENTIONALLY_ANGER_THE_FREEDB_PEOPLE=y in your
2099                         # abcde.conf to enable it. Put CDDBSUBMIT=email@address in
2100                         # your abcde.conf to change the email address submissions are
2101                         # sent to.
2102
2103                         # submit the modified file, if they want
2104                         if [ "$NOSUBMIT" != "y" ]; then
2105                                 echo -n "Do you want to submit this entry to $CDDBSUBMIT? [y/n] (n): "
2106                                 read YESNO
2107                                 while [ "$YESNO" != "y" ] && [ "$YESNO" != "n" ] && [ "$YESNO" != "Y" ] && \
2108                                         [ "$YESNO" != "N" ] && [ "$YESNO" != "" ]
2109                                 do
2110                                         echo -n 'Invalid selection. Please answer "y" or "n": '
2111                                         read YESNO
2112                                 done
2113                                 if [ "$YESNO" = "y" ] || [ "$YESNO" = "Y" ]; then
2114                                         echo -n "Sending..."
2115                                         $CDDBTOOL send "$CDDBDATA" $CDDBSUBMIT
2116                                         echo "done."
2117                                 fi
2118                         fi
2119                 fi
2120         fi
2121         # Make sure the cache directory exists
2122         mkdir -p $CDDBLOCALDIR
2123         # Cache edited CDDB entry in the user's cddb dir
2124         if [ "$CDDBCOPYLOCAL" = "y" ] || [ "$COPYCDDBLOCAL" = "Y" ]; then
2125                 cat "$CDDBDATA" | tail -n $(expr $(cat "$CDDBDATA" | wc -l ) - 1 ) > ${CDDBLOCALDIR}/$(echo "$TRACKINFO" | cut -d' ' -f1)
2126         fi
2127
2128         echo "cddb-edit" >> "$ABCDETEMPDIR/status"
2129 }
2130
2131 # do_cdread [tracknumber]
2132 # do_cdread onetrack [firsttrack] [lasttrack]
2133
2134 do_cdread ()
2135 {
2136         # The commands here don't go through run_command because they're never supposed to be silenced
2137         # return codes need to be doublechecked anyway, however
2138         if [ "$1" = "onetrack" ]; then
2139                 # FIXME # Add the possibility of grabbing ranges of tracks in onetrack
2140                 # FIXME # Until then, we grab the whole CD in one track, no matter what
2141                 # the user said
2142                 # We need the first and last track for cdda2wav
2143                 FIRSTTRACK=$2
2144                 LASTTRACK=$3
2145                 UTRACKNUM=$FIRSTTRACK
2146         else
2147                 UTRACKNUM=$1
2148         fi
2149         CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
2150         if [ "$USEPIPES" = "y" ]; then
2151                 TEMPARG="PIPERIPPER_$CDROMREADERSYNTAX"
2152                 FILEARG="$( eval echo "\$$TEMPARG" )"
2153                 REDIR=""
2154                 PIPE_MESSAGE="and encoding "
2155         else
2156                 WAVDATA="$ABCDETEMPDIR/track$UTRACKNUM.wav"
2157                 case "$CDROMREADERSYNTAX" in
2158                 ## FIXME ## Find the cases for dagrab and flac, to avoid exceptions
2159                         flac)
2160                                 FILEARG="--output-name=$WAVDATA"
2161                                 ;;
2162                         dagrab)
2163                                 FILEARG="-f $WAVDATA"
2164                                 ;;
2165                         *)
2166                                 FILEARG="$WAVDATA"
2167                                 ;;
2168                 esac
2169                 REDIR=">&2"
2170         fi
2171         if [ "$1" = "onetrack" ]; then
2172                 echo "Grabbing ${PIPE_MESSAGE}tracks $UTRACKNUM - $LASTTRACK as one track ..." >&2
2173         else
2174                 if [ -r "$CDDBDATA" ]; then
2175                         do_getcddbinfo TRACKNAME
2176                         echo "Grabbing ${PIPE_MESSAGE}track $UTRACKNUM: $TRACKNAME..." >&2
2177                 else
2178                         echo "Grabbing ${PIPE_MESSAGE}track $UTRACKNUM..." >&2
2179                 fi
2180         fi
2181         case "$CDROMREADERSYNTAX" in
2182                 ### FIXME ### use an exception for flac, since it uses -o
2183                 ### FIXME ### Shall we just use -o $FILEARG ??
2184                 flac)
2185                         nice $READNICE $FLAC -d --cue=${READTRACKNUMS:-$UTRACKNUM.1-$(($UTRACKNUM + 1)).0} "$FILEARG" "$CDROM" ;;
2186                 cdparanoia) 
2187                         nice $READNICE $CDROMREADER -$CDPARANOIACDROMBUS $CDROM ${READTRACKNUMS:-$UTRACKNUM} "$FILEARG" $REDIR ;;
2188                 cdda2wav)
2189                         if [ "$OSFLAVOUR" = "OSX" ] ; then
2190                                 # Hei, we have to unmount the device before running anything like cdda2wav in OSX
2191                                 disktool -u ${CDROM#/dev/} 0
2192                                 # Also, in OSX the cdrom device for cdda2wav changes...
2193                                 CDDA2WAVCDROM="IODVDServices"
2194                         elif [ "$OSFLAVOUR" = "FBSD" ] ; then
2195                                 CDDA2WAVCDROM="$CDROMID"
2196                         else
2197                                 if [ "$CDROMID" = "" ]; then
2198                                         CDDA2WAVCDROM="$CDROM"
2199                                 else
2200                                         CDDA2WAVCDROM="$CDROMID"
2201                                 fi
2202                         fi
2203                         nice $READNICE $CDROMREADER -D $CDDA2WAVCDROM -t ${READTRACKNUMS:-$UTRACKNUM} "$FILEARG" $REDIR
2204                         ;;
2205                 ## FIXME ## We have an exception for dagrab, since it uses -f
2206                 ## FIXME ## Shall we just use -f $FILEARG ??
2207                 dagrab) nice $READNICE $CDROMREADER -d $CDROM -v $UTRACKNUM "$FILEARG" $REDIR
2208                         ;;
2209                 cddafs)
2210                         # Find the track's mounted path
2211                         REALTRACKNUM=$(expr $UTRACKNUM + 0)
2212                         FILEPATH=$(mount | grep "$CDROM on" | sed 's/^[^ ]* on \(.*\) (.*/\1/')
2213                         FILEPATH=$(find "$FILEPATH" | grep "/$REALTRACKNUM ");
2214                         # If the file exists, copy it
2215                         if [ -e "$FILEPATH" ] ; then
2216                                 nice $READNICE $CDROMREADER "$FILEPATH" "$FILEARG" $REDIR
2217                         else
2218                                 false
2219                         fi ;;
2220                 debug) nice $READNICE $CDROMREADER -$CDPARANOIACDROMBUS $CDROM -w $UTRACKNUM-[:1] "$FILEARG" $REDIR
2221                         ;;
2222         esac
2223         RETURN=$?
2224         # If we get some error or we get some missing wav 
2225         # (as long as we dont use pipes)
2226         if [ "$RETURN" != "0" -o \( ! -s "$WAVDATA" -a X"$USEPIPES" != "Xy" \) ]; then
2227                 # Thank goodness errors is only machine-parseable up to the
2228                 # first colon, otherwise this woulda sucked
2229                 if [ "$RETURN" = "0" -a ! -s "$WAVDATA" ]; then
2230                         RETURN=73 # fake a return code as cdparanoia return 0 also on aborted reads
2231                 fi
2232                 if [ "$USEPIPES" = "y" ]; then
2233                         echo "readencodetrack-$UTRACKNUM: $CDROMREADER returned code $RETURN" >> "$ABCDETEMPDIR/errors"
2234                 else
2235                         echo "readtrack-$UTRACKNUM: $CDROMREADER returned code $RETURN" >> "$ABCDETEMPDIR/errors"
2236                 fi
2237                 return $RETURN
2238         else
2239                 if [ "$USEPIPES" = "y" ]; then
2240                         echo readencodetrack-$UTRACKNUM >> "$ABCDETEMPDIR/status"
2241                 else
2242                         echo readtrack-$UTRACKNUM >> "$ABCDETEMPDIR/status"
2243                         if [ "$1" = "onetrack" ]; then
2244                                 echo onetrack >> "$ABCDETEMPDIR/status"
2245                         fi
2246                 fi
2247         fi
2248 }
2249
2250 # do_cdspeed
2251 # No values accepted, only uses env variables
2252 do_cdspeed () 
2253 {
2254         if "$CDSPEED" "$CDSPEEDOPTS" "$CDSPEEDVALUE" >/dev/null ; then
2255                 vecho "Setting CD speed to ${CDSPEEDVALUE}x"
2256         else
2257                 echo "abcde: unable to set the device speed" >&2
2258         fi
2259 }
2260
2261 # vecho [message]
2262 #
2263 # vecho outputs a message if EXTRAVERBOSE is selected
2264 vecho ()
2265 {
2266 if [ x"$EXTRAVERBOSE" != "x" ]; then
2267         case $1 in
2268                 warning) log warning "$@" ;;
2269                 *) echo "$@" ;;
2270         esac
2271 fi
2272 }
2273
2274 # decho [message]
2275 #
2276 # decho outputs a debug message if DEBUG is selected
2277 decho ()
2278 {
2279 if [ x"$DEBUG" != "x" ]; then
2280         if echo $1 | grep -q "^\[" ; then
2281                 DEBUGECHO=$(echo "$@" | tr -d '[]')
2282                 echo "[DEBUG] $DEBUGECHO: `eval echo \\$${DEBUGECHO}`"
2283         else
2284                 echo "[DEBUG] $1"
2285         fi
2286 fi
2287 }
2288
2289 # User-redefinable functions
2290 # Custom filename munging:
2291 mungefilename ()
2292 {
2293         #echo "$@" | sed s,:,\ -,g | tr \ /\* __+ | tr -d \'\"\?\[:cntrl:\]
2294         echo "$@" | sed s,:,\ -,g | tr \ / __ | tr -d \'\"\?\[:cntrl:\]
2295 }
2296
2297 # Custom genre munging:
2298 mungegenre ()
2299 {
2300         echo $CDGENRE | tr "[:upper:]" "[:lower:]"
2301 }
2302
2303 # pre_read
2304 # Empty pre_read function, to be defined in the configuration file.
2305 pre_read ()
2306 {
2307 :
2308 }
2309
2310 # post_read
2311 # Empty post_read function, to be defined in the configuration file.
2312 post_read ()
2313 {
2314 :
2315 }
2316
2317 ###############################################################################
2318 # End of functions
2319 #
2320 # Start of execution
2321 ###############################################################################
2322
2323 # Builtin defaults
2324 CDDBURL="http://freedb.freedb.org/~cddb/cddb.cgi"
2325 CDDBSUBMIT=freedb-submit@freedb.org
2326 CDDBPROTO=5
2327 HELLOINFO="$(whoami)@$(hostname)"
2328 CDDBCOPYLOCAL="n"
2329 CDDBLOCALDIR="$HOME/.cddb"
2330 CDDBUSELOCAL="n"
2331
2332 # List of fields we parse and show during the CDDB parsing...
2333 SHOWCDDBFIELDS="year,genre"
2334
2335 INTERACTIVE=y
2336 CDROMREADERSYNTAX=cdparanoia
2337 ENCODERSYNTAX=default
2338
2339 MP3ENCODERSYNTAX=default
2340 OGGENCODERSYNTAX=default
2341 FLACENCODERSYNTAX=default
2342 SPEEXENCODERSYNTAX=default
2343 MPPENCODERSYNTAX=default
2344 NORMALIZERSYNTAX=default
2345 CUEREADERSYNTAX=default
2346
2347 OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
2348 # Use the following VAOUTPUTFORMAT to revert to 2.0.x VA format:
2349 #VAOUTPUTFORMAT=${OUTPUTFORMAT}
2350 VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
2351 ONETRACKOUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
2352 VAONETRACKOUTPUTFORMAT='Various-${ALBUMFILE}/${ALBUMFILE}'
2353 PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
2354 PLAYLISTDATAPREFIX=''
2355 VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
2356 VAPLAYLISTDATAPREFIX=''
2357 DOSPLAYLIST=n
2358 COMMENT=''
2359 ID3TAGV=2
2360 ENCNICE=10
2361 READNICE=10
2362 DISTMP3NICE=10
2363 VARIOUSARTISTS=n
2364 VARIOUSARTISTSTYLE=forward
2365 KEEPWAVS=n
2366 PADTRACKS=n
2367 NOGAP=n
2368 BATCHNORM=n
2369
2370 # If using scsi devices, cdda2wav needs a CDROMID, instead of a device node
2371 # i.e. CDROMID="1,0,0"
2372 CDROMID=""
2373 # If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
2374 # If we are using the ide-scsi emulation layer, we need to define a "g"
2375 CDPARANOIACDROMBUS="d"
2376
2377 # program paths - defaults to checking your $PATH
2378 # mp3
2379 LAME=lame
2380 TOOLAME=toolame
2381 GOGO=gogo
2382 BLADEENC=bladeenc
2383 L3ENC=l3enc
2384 XINGMP3ENC=xingmp3enc
2385 MP3ENC=mp3enc
2386 # ogg
2387 VORBIZE=vorbize
2388 OGGENC=oggenc
2389 # flac
2390 FLAC=flac
2391 # speex
2392 SPEEXENC=speexenc
2393 # mpp (Musepack)
2394 MPPENC=mppenc
2395
2396 ID3=id3
2397 ID3V2=id3v2
2398 EYED3=eyeD3
2399 CDPARANOIA=cdparanoia
2400 CDDA2WAV=cdda2wav
2401 DAGRAB=dagrab
2402 CDDAFS=cp
2403 CDDISCID=cd-discid
2404 CDDBTOOL=cddb-tool
2405 EJECT=eject
2406 MD5SUM=md5sum
2407 DISTMP3=distmp3
2408 VORBISCOMMENT=vorbiscomment
2409 METAFLAC=metaflac
2410 NORMALIZE=normalize-audio
2411 CDSPEED=eject
2412 VORBISGAIN=vorbisgain
2413 MP3GAIN=mp3gain
2414 MPPGAIN=replaygain
2415 MKCUE=mkcue
2416 MKTOC=cdrdao
2417 DIFF=diff
2418 CUE2DISCID=cue2discid
2419
2420 # Options for programs called from abcde
2421 # mp3
2422 LAMEOPTS=
2423 TOOLAMEOPTS=
2424 GOGOOPTS=
2425 BLADEENCOPTS=
2426 L3ENCOPTS=
2427 XINGMP3ENCOPTS=
2428 MP3ENCOPTS=
2429 # ogg
2430 VORBIZEOPTS=
2431 OGGENCOPTS=
2432 # flac
2433 FLACOPTS=
2434 # speex
2435 SPEEXENCOPTS=
2436 # mpc
2437 MPPENCOPTS=
2438
2439 ID3OPTS=
2440 ID3V2OPTS=
2441 CDPARANOIAOPTS=
2442 CDDA2WAVOPTS=
2443 DAGRABOPTS=
2444 CDDAFSOPTS="-f"
2445 CDDBTOOLOPTS=
2446 EJECTOPTS=
2447 DISTMP3OPTS=
2448 NORMALIZEOPTS=
2449 CDSPEEDOPTS="-x"
2450 CDSPEEDVALUE=
2451 MKCUEOPTS=
2452 MKTOCOPTS=""
2453 VORBISCOMMENTOPTS="-R"
2454 METAFLACOPTS="--no-utf8-convert"
2455 DIFFOPTS=
2456
2457 # Default to one process if -j isn't specified
2458 MAXPROCS=1
2459
2460 # List of actions to perform - by default, run to completion
2461 ACTIONS=cddb,read,encode,tag,move,clean
2462
2463 # List of prefered outputs - by default, run with whatever we have in the path
2464 # This option is basicaly for Debian package dependencies
2465 DEFAULT_OUTPUT_BINARIES=vorbis:oggenc,flac:flac,mp3:lame,mp3:bladeenc,spx:speex
2466
2467 # Asume fetch if under FreeBSD. curl is used for Mac OS X. wget is used for Linux/OpenBSD/NetBSD.
2468 # Let's use these checkings to determine the OS flavour, which will be used later
2469 if [ X$(uname) = "XFreeBSD" ] ; then
2470         HTTPGET=fetch
2471         MD5SUM=md5
2472         NEEDCDROMID=y
2473         OSFLAVOUR=FBSD
2474 elif [ X$(uname) = "XDarwin" ] ; then
2475         HTTPGET=curl
2476         OSFLAVOUR=OSX
2477         # We should have disktool in OSX, but let's be sure...
2478         NEEDDISKTOOL=y
2479         CDROMREADERSYNTAX=cddafs
2480 elif [ X$(uname) = "XOpenBSD" ] ; then
2481         HTTPGET=wget
2482         MD5SUM=md5
2483 elif [ X$(uname) = "XNetBSD" ] ; then
2484         HTTPGET=ftp
2485         MD5SUM=md5
2486 else
2487         HTTPGET=wget
2488 fi
2489
2490 # If CDDBAVAIL is set to n, no CDDB read is done
2491 # If USEID3 is set to n, no ID3 tagging is done
2492 CDDBAVAIL=y
2493 USEID3=y
2494 USEID3V2=y
2495
2496 if [ -z "$OUTPUTDIR" ]; then
2497         OUTPUTDIR=$(pwd)
2498 fi
2499
2500 if [ -z "$WAVOUTPUTDIR" ]; then
2501         WAVOUTPUTDIR="$OUTPUTDIR"
2502 fi
2503
2504 # Load system defaults
2505 if [ -r /etc/abcde.conf ]; then
2506         . /etc/abcde.conf
2507 fi
2508 # Load user preference defaults
2509 if [ -r $HOME/.abcde.conf ]; then
2510         . $HOME/.abcde.conf
2511 fi
2512
2513 # By this time, we need some HTTPGETOPTS already defined.
2514 # If the user has defined a non-default HTTPGET method, we should not be empty.
2515
2516 if [ "$HTTPGETOPTS" = "" ] ; then
2517         case $HTTPGET in
2518                 wget) HTTPGETOPTS="-q -O -";;
2519                 curl) HTTPGETOPTS="-f -s";;
2520                 fetch)HTTPGETOPTS="-q -o -";;
2521                 ftp)  HTTPGETOPTS="-q -o -";;
2522                 *) log warning "HTTPGET in non-standard and HTTPGETOPTS are not defined." ;;
2523         esac
2524 fi
2525
2526 # If the CDROM has not been set yet, find a suitable one.
2527 # If this is a devfs system, default to /dev/cdroms/cdrom0
2528 # instead of /dev/cdrom
2529 if [ "$CDROM" = "" ] ; then
2530         if [ -e /dev/cdroms/cdrom0 ]; then
2531                 CDROM=/dev/cdroms/cdrom0
2532         elif [ -e /dev/cdrom ]; then
2533                 CDROM=/dev/cdrom
2534         elif [ -e /dev/cd0c ]; then
2535                 CDROM=/dev/cd0c
2536         elif [ -e /dev/acd0c ]; then
2537                 CDROM=/dev/acd0c
2538         elif [ -e /dev/disk1 ]; then
2539                 CDROM=/dev/disk1
2540         fi
2541 fi
2542
2543 # Parse command line options
2544 #while getopts 1a:bc:C:d:Dehj:klLmMnNo:pPr:Rs:S:t:T:vVxw:W: opt ; do
2545 while getopts 1a:bBc:C:d:Defghj:klLmMnNo:pPr:s:S:t:T:uvVxw:W:z opt ; do
2546         case "$opt" in
2547                 1) ONETRACK=y ;;
2548                 a) ACTIONS="$OPTARG" ;;
2549                 A) EXPACTIONS="$OPTARG" ;;
2550                 b) BATCHNORM=y ;;
2551                 B) NOBATCHREPLAYGAIN=y ;;
2552                 c) if [ -e "$OPTARG" ] ; then . "$OPTARG" ; else log error "config file \"$OPTARG\" cannot be found." ; exit 1 ; fi ;;
2553                 C) DISCID="$( echo ${OPTARG#abcde.} | tr -d /)" ;;
2554                 d) CDROM="$OPTARG" ;;
2555                 D) set -x ;;
2556                 e) ERASEENCODEDSTATUS=y ;;
2557                 h) usage; exit ;;
2558                 e) ERASEENCODEDSTATUS=y ;;
2559                 E) ENCODING="$OPTARG" ;;
2560                 f) FORCE=y ;;
2561                 g) NOGAP=y ;;
2562                 i) INLINETAG=y ;;
2563                 j) MAXPROCS="$OPTARG" ;;
2564                 k) KEEPWAVS=y ;;
2565                 l) LOWDISK=y ;;
2566                 L) CDDBUSELOCAL=y ;;
2567                 n) CDDBAVAIL=n ;;
2568                 N) INTERACTIVE=n ;;
2569                 m) DOSPLAYLIST=y ;;
2570                 M) MAKECUEFILE=y ;;
2571                 o) OUTPUTTYPE="$OPTARG" ;;
2572                 p) PADTRACKS=y ;;
2573                 P) USEPIPES=y ;;
2574                 r) REMOTEHOSTS="$OPTARG" ;;
2575                 R) DOREPLAYGAIN=y ;;
2576                 s) SHOWCDDBFIELDS="$OPTARG" ;;
2577                 S) CDSPEEDVALUE="$OPTARG" ;;
2578                 t) STARTTRACKNUMBER="$OPTARG" ;;
2579                 T) STARTTRACKNUMBER="$OPTARG" ; STARTTRACKNUMBERTAG="y" ;;
2580                 u) CDDBPROTO=6 ;;
2581                 v) 
2582                    echo "This is abcde v$VERSION."
2583                    echo "Usage: abcde [options] [tracks]"
2584                    echo "abcde -h for extra help"
2585                    exit
2586                    ;;
2587                 V) EXTRAVERBOSE="y" ;;
2588                 x) EJECTCD="y" ;;
2589                 w) COMMENT="$OPTARG" ;;
2590                 W) if echo $OPTARG | grep -q "[[:digit:]]" ; then 
2591                      STARTTRACKNUMBER="${OPTARG}01" ; STARTTRACKNUMBERTAG="y" ; COMMENT="CD${OPTARG}"
2592                    else
2593                      log error "argument of -W must be integer"
2594                          exit 1
2595                    fi
2596                    ;;
2597                 z) DEBUG=y ; CDROMREADERSYNTAX=debug ; EJECTCD="n" ;;
2598                 ?) usage; exit ;;
2599         esac
2600 done
2601
2602 shift $(($OPTIND - 1))
2603
2604 # If the user specified a flac file, then switch to special flac mode
2605 if echo $CDROM | grep -i -q '.flac$'; then
2606         vecho "abcde: switching to flac CDROMREADERSYNTAX..."
2607         CDROMREADERSYNTAX=flac
2608         if [ "$EJECTCD" = "y" ];then
2609                 vecho "abcde: CDROM flac mode, deactivating EJECTCD..."
2610                 EJECTCD=n
2611         fi
2612 fi
2613
2614 # If the user provided a DISCID, disable eject
2615 if [ -n "$DISCID" ]; then EJECTCD=n ; fi
2616
2617 # Decide if we can continue.
2618 if [ "$ONETRACK" = "y" ]; then 
2619         # FIXME # remove check as soon as we find out about the other readers
2620         case "$CDROMREADERSYNTAX" in
2621                 flac) ;;
2622                 cdparanoia) ;;
2623                 cdda2wav) ;;
2624                 *) log error "$CDROMREADERSYNTAX does not support ONETRACK mode"
2625                    exit 1 ;;
2626         esac
2627         if [ "$BATCHNORM" = "y" ]; then
2628                 log warning "BATCHNORM mode is not compatible with ONETRACK mode. Disabling..."
2629                 BATCHNORM=n
2630         fi
2631         if [ "$NOGAP" = "y" ]; then
2632                 log warning "NOGAP mode is not compatible with ONETRACK mode. Disabling..."
2633                 NOGAP=n
2634         fi
2635         # It does not matter how many tracks we want. In ONETRACK mode we grab them all
2636         # FIXME # allow ranges of tracks to be selected for onetrack ripping
2637         if [ $# -gt 0 ]; then
2638                 log warning "ONETRACK mode selected, grabbing all tracks..."
2639         fi
2640 else
2641         while [ $# -gt 0 ]; do
2642                 # Range parsing code courtesy of Vincent Ho
2643                 RSTART=$(echo $1 | cut -f1 -d-)
2644                 REND=$(echo $1 | cut -f2 -d-)
2645                 if [ "$RSTART" = "$REND" ]; then
2646                         NEWTRACKS="$RSTART"
2647                 else
2648                         NEWTRACKS=$(f_seq_line $RSTART $REND)
2649                 fi
2650                 TRACKQUEUE=$(echo "$TRACKQUEUE" "$NEWTRACKS")
2651                 shift
2652         done
2653 fi
2654
2655 # List of valid actions: cddb,read,normalize,encode,tag,move,playlist,clean
2656 # List of experimental actions: retag,transcode
2657
2658 # Determine what actions are to be done from $ACTIONS and set the
2659 # following environment variables for them:
2660 DOCDDB=n
2661 DOREAD=n
2662 DONORMALIZE=n
2663 DOPREPROCESS=n
2664 DOENCODE=n
2665 DOPOSTPROCESS=n
2666 DOTAG=n
2667 DOMOVE=n
2668 DOREPLAYGAIN=n
2669 DOPLAYLIST=n
2670 DOCLEAN=n
2671
2672 for ACTION in $(echo $ACTIONS | tr , \ )
2673 do
2674         case $ACTION in
2675                 cddb) DOCDDB=y;;
2676                 read) DOREAD=y;;
2677                 normalize) DONORMALIZE=y; DOREAD=y;;
2678 #               preprocess) DOPREPROCESS=y; DOREAD=y;;
2679                 encode) DOENCODE=y; DOREAD=y;;
2680 #               postprocess) DOPREPROCESS=y; DOENCODE=y; DOREAD=y;;
2681                 tag) DOTAG=y; DOREAD=y; DOENCODE=y; DOCDDB=y;;
2682                 move) DOMOVE=y; DOTAG=y; DOREAD=y; DOENCODE=y; DOCDDB=y;;
2683                 replaygain) DOCDDB=y; DOREAD=y; DOENCODE=y; DOTAG=y; DOMOVE=y; DOREPLAYGAIN=y;;
2684                 playlist) DOCDDB=y; DOPLAYLIST=y;;
2685                 clean) DOCLEAN=y;;
2686         esac
2687 done
2688
2689 if [ "$DONORMALIZE" = "y" ] && [ "$DOREPLAYGAIN" = "y" ]; then
2690         # FIXME # should we abort on error or just inform the user?
2691         log warning "selected both normalize and replaygain actions"
2692 fi
2693
2694 for SHOWCDDBFIELD in $(echo $SHOWCDDBFIELDS | tr , \ ); do
2695         case $SHOWCDDBFIELD in
2696                 y*|Y*) SHOWCDDBYEAR="y";;
2697                 g*|G*) SHOWCDDBGENRE="y";;
2698                 *) ;;
2699         esac
2700 done
2701
2702 # Sanity checks:
2703
2704 # At this point a CDROM has to be defined, so we check it exists.
2705 if [ X"$CDROM" != "X" ] ; then 
2706         if [ "$CDROMREADERSYNTAX" = "cdda2wav" ] && [ "$NEEDCDROMID" = "y" ] ; then
2707                 if [ "$OSFLAVOUR" = "FBSD" ]; then
2708                         if ! echo "$CDROMID" | grep "^[0-9],[0-9],[0-9]$" >/dev/null 2>&1 ; then
2709                                 log error "CDROMID not in the right format for $CDROMREADERSYNTAX"
2710                                 log error "Use \"cdrecord -scanbus\" to obtain a adecuate ID an set CDROMID accordingly"
2711                                 exit 1
2712                         fi
2713                 fi
2714         elif [ ! -e "$CDROM" -a X"$DOREAD" = "Xy" ]; then
2715                 log error "CDROM device cannot be found."
2716                 exit 1
2717         fi
2718 # avoid processing if we are not going to hit the CDROM.
2719 elif [ X"$DOREAD" = "Xy" ]; then
2720         log error "CDROM has not been defined or cannot be found"
2721         exit 1
2722 fi
2723
2724 # USEPIPES pre-tests, before we get into more serious stuff
2725 # Not compatible with:
2726 # - multiple outputs
2727 # - normalize
2728 # - lowdisk algorithm
2729 # - anything else?
2730 if [ X"$USEPIPES" = "Xy" ]; then
2731         if [ $(echo "$OUTPUTTYPE" | tr , \  | wc -w ) -gt 1 ]; then
2732                 log error "Unix pipes not compatible with multiple outputs"
2733                 exit 1
2734         fi
2735         if [ X"$DONORMALIZE" = "Xy" ]; then
2736                 log error "Unix pipes not compatible with normalizer"
2737                 # FIXME # Do we need to exit or shall we just disable the mode?
2738                 exit 1
2739         fi
2740         if [ X"$BATCHNORM" = "Xy" ]; then
2741                 log error "Unix pipes not compatible with BATCHNORM encoding"
2742                 exit 1
2743         fi
2744         if [ X"$NOGAP" = "Xy" ]; then
2745                 log error "Unix pipes not compatible with NOGAP encoding"
2746                 exit 1
2747         fi
2748         if [ X"$DOENCODE" = "Xn" ]; then
2749                 vecho warning "Disabling Unix pipes since we are not encoding!"
2750                 USEPIPES=n
2751         fi
2752         if [ X"$LOWDISK" = "Xy" ]; then
2753                 log error "Unix pipes not compatible with lowdisk algorithm"
2754                 exit 1
2755         fi
2756 fi
2757
2758 # LOWDISK pre-tests, before we get into more problematic stuff
2759 # Not compatible with anything that needs all the files in the hard disc:
2760 # - BATCHNORM
2761 # - NOGAP lame mode
2762 if [ X"$LOWDISK" = "Xy" ]; then
2763         if [ X"$BATCHNORM" = "Xy" ]; then
2764                 log error "Unix pipes not compatible with BATCHNORM encoding"
2765                 exit 1
2766         fi
2767         if [ X"$NOGAP" = "Xy" ]; then
2768                 log error "Unix pipes not compatible with NOGAP encoding"
2769                 exit 1
2770         fi
2771 fi
2772
2773 # BATCHNORM pre-tests, before we get into serious problems
2774 # Not compatible with 
2775 if [ "$BATCHNORM" = "y" ] && [ "$DONORMALIZE" = "n" ]; then
2776         vecho warning "Disabling BATCHNORM since we are not normalizing!"
2777         BATCHNORM=n
2778 fi
2779
2780 # Check the encoding format from the ones available in the system, if nothing has been configured in the system.
2781 if [ X"$OUTPUTTYPE" = "X" ]; then
2782         for DEFAULT_OUTPUT in $( echo "$DEFAULT_OUTPUT_BINARIES" | tr , \ ); do
2783                 DEFAULT_OUTPUT_FORMAT="$(echo $DEFAULT_OUTPUT | cut -d ":" -f 1)"
2784                 DEFAULT_OUTPUT_BINARY="$(echo $DEFAULT_OUTPUT | cut -d ":" -f 2)"
2785                 if [ -x $(which $DEFAULT_OUTPUT_BINARY) ] ; then
2786                         OUTPUTTYPE=$DEFAULT_OUTPUT_FORMAT
2787                         vecho "No default output type defined. Autoselecting $OUTPUTTYPE..." >&2
2788                         break
2789                 fi
2790         done
2791         if [ X"$OUTPUTTYPE" = "X" ]; then
2792                 log error "no encoder found in the PATH"
2793                 log error "hints: are all dependencies installed? has the \$PATH been modified?"
2794                 exit 1
2795         fi
2796 fi
2797
2798 # Decide which CDROM reader we're gonna use
2799 case "$CDROMREADERSYNTAX" in
2800         cdparanoia|debug)
2801                 CDROMREADER="$CDPARANOIA"
2802                 CDROMREADEROPTS="$CDPARANOIAOPTS"
2803                 ;;
2804         cdda2wav)
2805                 CDROMREADER="$CDDA2WAV"
2806                 CDROMREADEROPTS="$CDDA2WAVOPTS"
2807                 ;;
2808         dagrab)
2809                 CDROMREADER="$DAGRAB"
2810                 CDROMREADEROPTS="$DAGRABOPTS"
2811                 ;;
2812         cddafs)
2813                 CDROMREADER="$CDDAFS"
2814                 CDROMREADEROPTS="$CDDAFSOPTS"
2815                 ;;
2816         flac)
2817                 CDROMREADER="$FLAC"
2818                 CDROMREADEROPTS="$FLACOPTS"
2819                 ;;
2820 esac
2821
2822 # There's only one normalize...
2823 case "$NORMALIZERSYNTAX" in
2824         default|normalize)
2825                 NORMALIZER="$NORMALIZE"
2826                 NORMALIZEROPTS="$NORMALIZEOPTS"
2827                 ;;
2828 esac
2829
2830 # Allow -o OUTPUT(1):OPTIONS(1),...,OUTPUT(N):OPTIONS(N) mode of operation
2831 if echo "$OUTPUTTYPE" | grep ":" > /dev/null 2>&1 ; then
2832         for OUTPUT in "$(echo "$OUTPUTTYPE" | tr , \ )"; do
2833                 case "$OUTPUT" in
2834                         vorbis:*|ogg:*) OGGENCODEROPTSCLI="$( echo $OUTPUT | cut -d: -f2- )" ;;
2835                         mp3:*)  MP3ENCODEROPTSCLI="$( echo $OUTPUT | cut -d: -f2- )" ;;
2836                         flac:*) FLACENCODEROPTSCLI="$( echo $OUTPUT | cut -d: -f2- )" ;;
2837                         spx:*)  SPEEXENCODEROPTSCLI="$( echo $OUTPUT | cut -d: -f2- )" ;;
2838                         mpc:*)  MPPENCODEROPTSCLI="$( echo $OUTPUT | cut -d: -f2- )" ;;
2839                 esac
2840         done
2841         for OUTPUT in "$(echo "$OUTPUTTYPE" | tr , \ )"; do
2842                 TEMPOUTPUT=$( echo "$OUTPUT" | cut -d: -f1 )
2843                 TEMPOUTPUTTYPE="${TEMPOUTPUTTYPE:+$TEMPOUTPUTTYPE,}$TEMPOUTPUT"
2844         done
2845         OUTPUTTYPE="$TEMPOUTPUTTYPE"
2846 fi
2847
2848 # If nothing has been specified, use oggenc for oggs and lame for mp3s and flac for flacs and speexenc for speex and mppenc for mpps
2849
2850 # Getting ready for multiple output changes
2851 for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
2852 do
2853         case $OUTPUT in
2854                 vorbis|ogg)
2855                         [ "$OGGENCODERSYNTAX" = "default" ] && OGGENCODERSYNTAX=oggenc
2856                         [ "$DOTAG" = "y" ] && NEEDCOMMENTER=y
2857                         [ "$DOREPLAYGAIN" = "y" ] && NEEDVORBISGAIN=y
2858                         OGGOUTPUTCONTAINER=ogg
2859                         ;;
2860                 mp3)
2861                         [ "$MP3ENCODERSYNTAX" = "default" ] && MP3ENCODERSYNTAX=lame
2862                         [ "$DOTAG" = "y" ] && NEEDTAGGER=y
2863                         [ "$DOREPLAYGAIN" = "y" ] && NEEDMP3GAIN=y
2864                         ;;
2865                 flac)
2866                         [ "$FLACENCODERSYNTAX" = "default" ] && FLACENCODERSYNTAX=flac