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