836c4d9708a939b6428dcadb350280518a04a637
[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 # Copyright (c) 2009-2012 Colin Tuckley <colint@debian.org>
5 # Copyright (c) 2012      Steve McIntyre <93sam@@debian.org>
6 # This code is hereby licensed for public consumption under either the
7 # GNU GPL v2 or greater, or Larry Wall's Artistic license - your choice.
8 #
9 # You should have received a copy of the GNU General Public License along
10 # with this program; if not, write to the Free Software Foundation, Inc.,
11 # 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
12 #
13 # Copyright for this work is to expire January 1, 2010, after which it
14 # shall be public domain.
15
16 VERSION='2.6.1-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 "-c <file>"
30 echo "       Specify a configuration file (overrides system and user config files)"
31 echo "-C <discid#>"
32 echo "       Specify discid to resume from (only needed if you no longer have the cd)"
33 echo "-d <device>"
34 echo "       Specify CDROM device to grab (flac uses a single-track flac file)"
35 echo "-D     Debugging mode (equivalent to sh -x abcde)"
36 echo "-e     Erase encoded track information from status file"
37 echo "-f     Force operations that otherwise are considered harmful. Read \"man abcde\""
38 echo "-g     Use \"lame --nogap\" for MP3 encoding. Disables low disk and pipes flags"
39 echo "-h     This help information"
40 #echo "-i    Tag files while encoding, when possible (local only) -NWY-"
41 echo "-j <#> Number of encoder processes to run at once (localhost)"
42 echo "-k     Keep the wav tracks for later use"
43 echo "-l     Use low disk space algorithm"
44 echo "-L     Use local CDDB storage directory"
45 echo "-m     Modify playlist to include CRLF endings, to comply with some players"
46 #echo "       WARNING: Deprecated. Use \"cue\" action"
47 #echo "-M     Create a CUE file"
48 echo "-n     No lookup. Don't query CDDB, just create and use template"
49 echo "-N     Noninteractive. Never prompt for anything"
50 echo "-o <type1[,type2]...>"
51 echo "       Output file type(s) (vorbis,mp3,flac,spx,mpc,wav,m4a,opus). Defaults to vorbis"
52 echo "-p     Pad track numbers with 0's (if less than 10 tracks)"
53 echo "-P     Use UNIX pipes to read+encode without wav files"
54 echo "-r <host1[,host2]...>"
55 echo "       Also encode on these remote hosts"
56 echo "-s <field>"
57 echo "       Show fields from the CDDB info (year,genre)"
58 echo "-S <#> Set the CD speed"
59 echo "-t <#> Start the track numbering at a given number"
60 echo "-T <#> Same as -t but modifies tag numbering"
61 echo "-U     Do NOT use UNICODE (UTF8) tags and comments"
62 echo "-v     Show version number and exit"
63 echo "-V     Be a bit more verbose about what is happening behind the scenes"
64 echo "-x     Eject CD after all tracks are read"
65 echo "-w <comment>"
66 echo "       Add a comment to the CD tracks"
67 echo "-W <#> Concatenate CDs: -T #01 -w \"CD #\""
68 echo "-z     Use debug CDROMREADERSYNTAX option (needs cdparanoia)"
69 echo ""
70 echo "Tracks is a space-delimited list of tracks to grab."
71 echo "Ranges specified with hyphens are allowed (i.e., 1-5)."
72 echo ""
73 #echo "Double hyphens are used to concatenate tracks"
74 }
75
76 addstatus ()
77 {
78         echo "$@" >> "$ABCDETEMPDIR/status"
79 }
80
81 # log [level] [message]
82 #
83 # log outputs the right message in a common format
84 log ()
85 {
86         BLURB="$1"
87         shift
88         case $BLURB in
89                 error)   echo "[ERROR] abcde: $@" >&2 ;;
90                 warning) echo "[WARNING] $@" >&2 ;;
91                 info)    echo "[INFO] $@" ;;
92         esac
93 }
94
95 # Functions to replace the need of seq, which is too distribution dependent.
96 f_seq_row ()
97 {
98         i=$1
99         while [ $i -ne `expr $2 + 1` ]
100         do
101                 echo $i
102                 i=`expr $i + 1`
103         done
104 }
105
106 f_seq_line ()
107 {
108         i=$1
109         if echo $i | grep "[[:digit:]]" > /dev/null 2>&1 ; then
110                 while [ $i -ne `expr $2 + 1` ]
111                 do
112                         printf $i" "
113                         i=`expr $i + 1`
114                 done
115                 echo
116         else
117                 log error "syntax error while processing track numbers ($i)"
118                 exit 1
119         fi
120 }
121
122 # Functions to replace the need of awk {print $1} and {print $NF}
123 get_first()
124 {
125 if [ X"$1" = "X" ]; then
126         for first in `cat`; do
127                 break
128         done
129 else
130         first=$1
131 fi
132 echo $first
133 }
134
135 get_last()
136 {
137 if [ X"$1" = "X" ]; then
138         for stdin in `cat`; do
139                 last=$stdin
140         done
141 else
142         for last in $@ ; do :; done
143 fi
144 echo $last
145 }
146
147 # checkstatus [blurb]
148 # Returns "0" if the blurb was found, returns 1 if it wasn't
149 # Puts the blurb content, if available, on stdout.
150 # Otherwise, returns "".
151 checkstatus ()
152 {
153         # Take the last line in the status file if there's multiple matches
154         PATTERN="^$1(=.*)?$"
155         BLURB=$(grep -E $PATTERN "$ABCDETEMPDIR/status" | tail -n 1)
156
157         if [ -z "$BLURB" ]; then
158                 # No matches found
159                 return 1
160         else
161                 # Matches found
162                 # See if there's a = in it
163                 if [ "$(echo $BLURB | grep -c =)" != "0" ]; then
164                         echo "$(echo $BLURB | cut -f2- -d=)"
165                 fi
166                 return 0
167         fi
168 }
169
170 # checkwarnings [blurb]
171 # Returns "0" if the blurb was found (meaning there was an warning),
172 # returns 1 if it wasn't (yes this is a little backwards).
173 # Does not print the blurb on stdout.
174 # Otherwise, returns "".
175 checkwarnings ()
176 {
177         if [ -e "$ABCDETEMPDIR/warnings" ]; then :; else
178                 return 1
179         fi
180         # Take the last line in the status file if there's multiple matches
181         PATTERN="^$1(:.*)?$"
182         BLURB="$(grep -E $PATTERN "$ABCDETEMPDIR/warnings" | tail -n 1)"
183
184         if [ -z "$BLURB" ]; then
185                 # negative, we did not have a negative...
186                 return 1
187         else
188                 # affirmative, we had a negative...
189                 return 0
190         fi
191 }
192
193 # checkerrors [blurb]
194 # Returns "0" if the blurb was found (meaning there was an error),
195 # returns 1 if it wasn't (yes this is a little backwards).
196 # Does not print the blurb on stdout.
197 # Otherwise, returns "".
198 checkerrors ()
199 {
200         if [ -e "$ABCDETEMPDIR/errors" ]; then :; else
201                 return 1
202         fi
203         # Take the last line in the status file if there's multiple matches
204         PATTERN="^$1(:.*)?$"
205         BLURB="$(grep -E $PATTERN "$ABCDETEMPDIR/errors" | tail -n 1)"
206
207         if [ -z "$BLURB" ]; then
208                 # negative, we did not have a negative...
209                 return 1
210         else
211                 # affirmative, we had a negative...
212                 return 0
213         fi
214 }
215
216 # page [file]
217 # Finds the right pager in the system to display a file
218 page ()
219 {
220         PAGEFILE="$1"
221         # Use the debian sensible-pager wrapper to pick the pager
222         # user has requested via their $PAGER environment variable
223         if [ -x "/usr/bin/sensible-pager" ]; then
224                 /usr/bin/sensible-pager "$PAGEFILE"
225         elif [ -x "$PAGER" ]; then
226                 # That failed, try to load the preferred editor, starting
227                 # with their PAGER variable
228                 $PAGER "$PAGEFILE"
229                 # If that fails, check for less
230         elif [ -x /usr/bin/less ]; then
231                 /usr/bin/less -f "$PAGEFILE"
232                 # more should be on all UNIX systems
233         elif [ -x /bin/more ]; then
234                 /bin/more "$PAGEFILE"
235         else
236                 # No bananas, just cat the thing
237                 cat "$PAGEFILE" >&2
238         fi
239 }
240
241 # run_command [blurb] [command...]
242 # Runs a command, silently if necessary, and updates the status file
243 run_command ()
244 {
245         vvecho "$@"
246         BLURB="$1"
247         shift
248         # See if this is supposed to be silent
249         if [ "$(checkstatus encode-output)" = "loud" ]; then
250                 "$@" >&2
251                 RETURN=$?
252         else
253                 # Special case for SMP, since
254                 # encoder output is never displayed, don't mute echos
255                 if [ -z "$BLURB" -a "$MAXPROCS" != "1" ]; then
256                         "$@" >&2
257                         RETURN=$?
258                 else
259                         "$@" >/dev/null 2>&1
260                         RETURN=$?
261                 fi
262         fi
263         case "$1" in
264         normalize|normalize-audio)
265                 if [ "$RETURN" = "2" ]; then
266                         # File was already normalized.
267                         RETURN=0
268                 fi
269                 ;;
270         esac
271         if [ "$RETURN" != "0" ]; then
272                 # Put an error in the errors file. For various reasons we
273                 # can't capture a copy of the program's output but we can
274                 # log what we attempted to execute and the error code
275                 # returned by the program.
276                 if [ "$BLURB" ]; then
277                         TWEAK="$BLURB: "
278                 fi
279                 echo "${TWEAK}returned code $RETURN: $@" >> "$ABCDETEMPDIR/errors"
280                 return $RETURN # Do not pass go, do not update the status file
281         fi
282         if [ "$BLURB" ]; then
283                 echo $BLURB >> "$ABCDETEMPDIR/status"
284         fi
285 }
286
287 # relpath() and slash() are Copyright (c) 1999 Stuart Ballard and
288 # distributed under the terms of the GNU GPL v2 or later, at your option
289
290 # Function to determine if a word contains a slash.
291 slash ()
292 {
293         case "$1" in
294         */*) return 0;;
295         *) return 1;;
296         esac
297 }
298
299 # Function to give the relative path from one file to another.
300 # Usage: relpath fromfile tofile
301 # eg relpath music/Artist/Album.m3u music/Artist/Album/Song.mp3
302 # (the result would be Album/Song.mp3)
303 # Output is relative path to $2 from $1 on stdout
304
305 # This code has the following restrictions:
306 # Multiple ////s are not collapsed into single /s, with strange effects.
307 # Absolute paths and ../s are handled wrong in FR (but they work in TO)
308 # If FR is a directory it must have a trailing /
309
310 relpath ()
311 {
312         FR="$1"
313         TO="$2"
314
315         case "$TO" in
316         /*) ;; # No processing is needed for absolute paths
317         *)
318                 # Loop through common prefixes, ignoring them.
319                 while slash "$FR" && [ "$(echo "$FR" | cut -d/ -f1)" = "$(echo "$TO" | cut -d/ -f1)" ]
320                 do
321                         FR="$(echo "$FR" | cut -d/ -f2-)"
322                         TO="$(echo "$TO" | cut -d/ -f2-)"
323                 done
324                 # Loop through directory portions left in FR, adding appropriate ../s.
325                 while slash "$FR"
326                 do
327                         FR="$(echo "$FR" | cut -d/ -f2-)"
328                         TO="../$TO"
329                 done
330                 ;;
331         esac
332
333         echo $TO
334 }
335
336 new_checkexec ()
337 {
338         if [ ! "$@" = "" ]; then
339                 # Cut off any command-line option we added in
340                 X=$(echo $@ | cut -d' ' -f2)
341                 if [ "$(which $X)" = "" ]; then
342                         return 1
343                 elif [ ! -x $(which $X) ]; then
344                         return 2
345                 fi
346         fi
347         return 0
348 }
349
350 checkexec ()
351 {
352         if [ ! "$@" = "" ]; then
353                 # Cut off any command-line option we added in
354                 X=$(echo $@ | cut -d' ' -f2)
355                 # Test for built-in abcde.function
356                 [ "$X" != "${X#abcde.}" ] && type $X >/dev/null 2>&1 && return
357                 if [ "$(which $X)" = "" ]; then
358                         log error "$X is not in your path." >&2
359                         log info  "Define the full path to the executable if it exists on your system." >&2
360                         if [ -e /etc/debian_release ] ; then
361                                 case $X in
362                                         oggenc)         MISSING_PACKAGE=vorbis-tools ;;
363                                         lame|flac)      MISSING_PACKAGE=$X ;;
364                                 esac
365                                 log info "Hint: apt-get install $MISSING_PACKAGE" >&2
366                         fi
367                         exit 1
368                 elif [ ! -x "$(which $X)" ]; then
369                         log error "$X is not executable." >&2
370                         exit 1
371                 fi
372         fi
373 }
374
375 # diffentries <filename> <max_value> <entry1>,<entry2>
376 # max_value: the range of entries goes from 1 to <max_value>
377 diffentries ()
378 {
379         FILENAME=$1
380         shift
381         local CDDBDIFFCHOICES=$1
382         shift
383         local CDDBDIFFCHOICE="$@"
384         if [ ! X"$DIFF" = "X" ]; then
385                 PARSECHOICE1=$(echo $CDDBDIFFCHOICE | cut -d"," -f1 | xargs printf %d 2>/dev/null)
386                 PARSECHOICE2=$(echo $CDDBDIFFCHOICE | cut -d"," -f2 | xargs printf %d 2>/dev/null)
387                 if [ $PARSECHOICE1 -lt 1 ] || [ $PARSECHOICE1 -gt $CDDBDIFFCHOICES ] || \
388                    [ $PARSECHOICE2 -lt 1 ] || [ $PARSECHOICE2 -gt $CDDBDIFFCHOICES ] || \
389                    [ $PARSECHOICE1 -eq $PARSECHOICE2 ]; then
390                         echo "Invalid diff range. Please select two comma-separated numbers between 1 and $CDDBDIFFCHOICES" >&2
391                 else
392                         # We parse the 2 choices to diff, store them in temporary files and diff them.
393                         for PARSECHOICE in $(echo $CDDBDIFFCHOICE | tr , \ ); do
394                                 do_cddbparse "$ABCDETEMPDIR/$FILENAME.$PARSECHOICE" > "$ABCDETEMPDIR/$FILENAME.parsechoice.$PARSECHOICE"
395                         done
396                         echo "Showing diff between choices $PARSECHOICE1 and $PARSECHOICE2..." > "$ABCDETEMPDIR/$FILENAME.diff"
397                         $DIFF $DIFFOPTS "$ABCDETEMPDIR/$FILENAME.parsechoice.$PARSECHOICE1" "$ABCDETEMPDIR/$FILENAME.parsechoice.$PARSECHOICE2" >> "$ABCDETEMPDIR/$FILENAME.diff"
398                         if [ $(cat "$ABCDETEMPDIR/$FILENAME.diff" | wc -l) -ge 24 ]; then
399                                 page "$ABCDETEMPDIR/$FILENAME.diff"
400                         else
401                                 cat "$ABCDETEMPDIR/$FILENAME.diff" >&2
402                         fi
403                 fi
404         else
405                 echo "The diff program was not found in your path. Please choose a number between 0 and $CDDBDIFFCHOICES." >&2
406         fi
407 }
408
409 # getcddbinfo
410 # Finds an specific field from cddbinfo
411 getcddbinfo()
412 {
413         case $1 in
414         TRACKNAME1)
415                 TRACKNAME="$(grep ^TTITLE$CDDBTRACKNUM= "$CDDBDATA" | head -n 1 | cut -f2- -d= | tr -d \[:cntrl:\] | sed 's/\ \+$//')"
416                 ;;
417         TRACKNAME)
418                 TRACKNAME="$(grep ^TTITLE$CDDBTRACKNUM= "$CDDBDATA" | cut -f2- -d= | tr -d \[:cntrl:\] | sed 's/\ \+$//')"
419                 ;;
420         TRACK-INFO)
421                 grep ^EXTT$CDDBTRACKNUM= "$CDDBDATA" | cut -f2- -d= | tr -d \[:cntrl:\] | sed 's/\\n/\n/g'
422                 ;;
423         esac
424 }
425
426 # gettracknum
427 # Get the track number we are going to use for different actions
428 gettracknum()
429 {
430         if [ -n "$STARTTRACKNUMBER" ] ; then
431                 # Get the trackpadding from the current track, also trim whitespace for MacOSX
432                 CURRENTTRACKPADDING=$(echo -n $UTRACKNUM | wc -c | tr -d ' ')
433                 TRACKNUM=$( printf %0.${CURRENTTRACKPADDING}d $(expr ${UTRACKNUM} + ${STARTTRACKNUMBER} - $FIRSTTRACK ))
434         else
435                 TRACKNUM=${UTRACKNUM}
436         fi
437 }
438
439 # makeids
440 #
441 # Calculate cddb disc ids without requiring specialized helper programs.
442 # largely copied from cd-discid and musicbrainz examples.  some of the steps
443 # don't make sense, but they're necessary to match the ids generated by other
444 # programs.
445 #
446 ## FIXME ## Right now, we get 2 frames more than with cue2discid ??
447 # data@petit:~$ sh /tmp/cue2discid /home/data/tmp/flac/01.Roisin_Murphy--Ruby_Blue.flac
448 # 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
449 # 980b4b0c 12 150 21685 37687 53146 80061 97782 124071 144448 160603 173208 197438 201334 2895
450 # data@petit:~$ metaflac --export-cuesheet-to=- /home/data/tmp/flac/01.Roisin_Murphy--Ruby_Blue.flac| python /home/data/sources/abcde/trunk/examples/cue2discid
451 # 980b4b0c 12 150 21685 37687 53146 80061 97782 124071 144448 160603 173208 197438 201334 2893
452 #
453 # Variables: OFFSETS, TRACKS, LEADOUT, [LEADIN]
454 makeids ()
455 {
456         if [ X"$LEADOUT" = "X" ]; then
457                 log warning "Error trying to calculate disc ids without lead-out information."
458                 exit 1
459         fi
460
461         # default to a two second lead-in
462         IDMAGICNUM=150
463         LEADIN=${LEADIN:=150}
464
465         # number of cdframes per second
466         CDFRAMES=75
467
468         # reset cddb checksum for cddb disc-id calululation
469         CDDBCKSUM=0
470
471         COOKEDOFFSETS=""
472         for OFFSET in $(echo $OFFSETS)
473         do
474                 COOKEDOFFSETS="${COOKEDOFFSETS} $(($OFFSET + $LEADIN))"
475
476                 OFFSETTIME=$(( ($OFFSET + $LEADIN) / $CDFRAMES  ))
477                 while [ $OFFSETTIME -gt 0 ]; do
478                         CDDBCKSUM=$(($CDDBCKSUM + $OFFSETTIME % 10))
479                         OFFSETTIME=$(($OFFSETTIME / 10))
480                 done
481
482         done
483
484         COOKEDOFFSETS="${COOKEDOFFSETS:1}"  # eat the leading space
485
486         PREGAP=$(($(echo $OFFSETS | cut -f1 -d' ')))
487         TOTALTIME=$(( (($LEADOUT + $LEADIN + $PREGAP) / $CDFRAMES) - (($LEADIN + $PREGAP) / $CDFRAMES)))
488
489         case "$CDDBMETHOD" in
490                 cddb)
491                         printf -v DISCID "%08lx" $(( ($CDDBCKSUM % 0xff) * 16777216 | $TOTALTIME * 256 | $TRACKS))
492                         ;;
493                 musicbrainz)
494                         # FIXME: don't assume the first track is 1
495                         echo "dasd: 1 $TRACKS $LEADIN $LEADOUT $OFFSETS "
496                         DISCID=$($MUSICBRAINZ --command calcid --discinfo 1 $TRACKS $LEADIN $LEADOUT $OFFSETS)
497                         ;;
498         esac
499
500         TRACKINFO="${DISCID} $((TRACKS)) ${COOKEDOFFSETS} $((($LEADOUT + $LEADIN + $IDMAGICNUM) / $CDFRAMES))"
501 }
502
503 do_replaygain()
504 {
505         if checkstatus replaygain; then :; else
506                 run_command "" echo "Adding replaygain information..."
507                 for TMPOUTPUT in $( echo $OUTPUTTYPE | tr , \ )
508                 do
509                         case $TMPOUTPUT in
510                                 vorbis|ogg)
511                                         OUTPUT=$OGGOUTPUTCONTAINER
512                                         ;;
513                                 opus)
514                                         OUTPUT=$OPUSOUTPUTCONTAINER
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,
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                                         case "$ID3SYNTAX" in
826                                                 eyed3_06) addopts=( \
827                                                         ${ENCODING:+--set-encoding="$ENCODING"} \
828                                                         ${TPE2:+--set-text-frame=TPE2:"$TPE2"} \
829                                                         ${COMMENTOUTPUT:+--comment=::"$COMMENTOUTPUT"} \
830                                                         );;
831                                                 *) addopts=( \
832                                                         ${ENCODING:+--encoding="$ENCODING"} \
833                                                         ${TPE2:+--text-frame=TPE2:"$TPE2"} \
834                                                         ${COMMENTOUTPUT:+--comment "$COMMENTOUTPUT"} \
835                                                         );;
836                                         esac
837                                         run_command tagtrack-$OUTPUT-$1 nice $ENCNICE $TAGGER $TAGGEROPTS \
838                                             -A "$DALBUM" \
839                                                 -a "$TRACKARTIST" -t "$TRACKNAME" ${CDYEAR:+-Y "$CDYEAR"} \
840                                                 -G "$GENREID" -n "${TRACKNUM:-$1}" \
841                                                 ${TRACKNUM:+-N "$TRACKS"} \
842                                                 "${addopts[@]}" \
843                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
844                                         ;;
845                                 # FIXME # Still not activated...
846                                 id3ed)
847                                         run_command tagtrack-$OUTPUT-$1 nice $ENCNICE \
848                                                 $TAGGER $TAGGEROPTS -c "$COMMENTOUTPUT" \
849                                                 -a "$DALBUM" -n "$TRACKARTIST" -s "$TRACKNAME" \
850                                                 -y "$CDYEAR" -g "$GENREID" -k "${TRACKNUM:-$1}" \
851                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
852                                         ;;
853                                 *)
854                                         # FIXME # track numbers in mp3 come with 1/10, so we cannot
855                                         # happily substitute them with $TRACKNUM
856                                         run_command tagtrack-$OUTPUT-$1 nice $ENCNICE \
857                                                 $TAGGER $TAGGEROPTS -c "$COMMENTOUTPUT" \
858                                                 -A "$DALBUM" -a "$TRACKARTIST" -t "$TRACKNAME" \
859                                                 -y "$CDYEAR" -g "$GENREID" \
860                                                 -T "${TRACKNUM:-$1}/$TRACKS" \
861                                                 ${TPE2:+--TPE2 "$TPE2"} \
862                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
863                                         ;;
864                         esac
865                         ;;
866                 vorbis|ogg)
867                         case "$OGGENCODERSYNTAX" in
868                                 vorbize|oggenc)
869                                         # vorbiscomment can't do in-place modification, mv the file first
870                                         if [ -f "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" -a ! -f "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" ]; then
871                                                 mv "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER"
872                                         fi
873                                         (
874                                         # These are from
875                                         # http://www.xiph.org/ogg/vorbis/doc/v-comment.html
876
877                                         echo ARTIST="$TRACKARTIST"
878                                         echo ALBUM="$DALBUM"
879                                         echo TITLE="$TRACKNAME"
880                                         if [ -n "$CDYEAR" ]; then
881                                                 echo DATE="$CDYEAR"
882                                         fi
883                                         if [ -n "$CDGENRE" ]; then
884                                                 echo GENRE="$CDGENRE"
885                                         fi
886                                         echo TRACKNUMBER=${TRACKNUM:-$1}
887                                         if [ -n "$DISCNUMBER" ]; then
888                                                 echo DISCNUMBER="$DISCNUMBER"
889                                         fi
890                                         echo CDDB=$CDDBDISCID
891                                         if [ "$(eval echo ${COMMENT})" != "" ]; then
892                                                 case "$COMMENTOUTPUT" in
893                                                         *=*) echo "$COMMENTOUTPUT";;
894                                                         *)   echo COMMENT="$COMMENTOUTPUT";;
895                                                 esac
896                                         fi
897                                         ) | run_command tagtrack-$OUTPUT-$1 nice $ENCNICE \
898                                                 $VORBISCOMMENT $VORBISCOMMENTOPTS -w \
899                                                 "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
900                                         # Doublecheck that the commented file was created
901                                         # successfully before wiping the original
902                                         if [ -f "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" ]; then
903                                                 rm -f "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER"
904                                         else
905                                                 mv "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
906                                         fi
907                                         ;;
908                         esac
909                         ;;
910                 opus)
911                         run_command tagtrack-$OUTPUT-$1 true
912                         ;;
913
914                 flac)
915                         (
916                         echo ARTIST="$TRACKARTIST"
917                         echo ALBUM="$DALBUM"
918                         echo TITLE="$TRACKNAME"
919                         if [ -n "$CDYEAR" ]; then
920                                 echo DATE="$CDYEAR"
921                         fi
922                         if [ -n "$CDGENRE" ]; then
923                                 echo GENRE="$CDGENRE"
924                         fi
925                         echo TRACKNUMBER="${TRACKNUM:-$1}"
926                         if [ -n "$DISCNUMBER" ]; then
927                                 echo DISCNUMBER="$DISCNUMBER"
928                         fi
929                         echo CDDB="$CDDBDISCID"
930                         if [ "$(eval echo ${COMMENT})" != "" ]; then
931                                 case "$COMMENTOUTPUT" in
932                                         *=*) echo "$COMMENTOUTPUT";;
933                                         *)   echo COMMENT="$COMMENTOUTPUT";;
934                                 esac
935                         fi
936                         ) | run_command tagtrack-$OUTPUT-$1 nice $ENCNICE $METAFLAC $METAFLACOPTS ${IMPORTCUESHEET:+--import-cuesheet-from="$ABCDETEMPDIR/$CUEFILE"} --import-tags-from=- "$ABCDETEMPDIR/track$1.$FLACOUTPUTCONTAINER"
937                         ;;
938                 spx)
939                         run_command tagtrack-$OUTPUT-$1 true
940                         ;;
941                 mpc)
942                         run_command tagtrack-$OUTPUT-$1 true
943                         ;;
944                 aac)
945                         run_command tagtrack-$OUTPUT-$1 true
946                 ;;
947                 m4a)
948                   case "$AACENCODERSYNTAX" in
949                     fdkaac) # We will use inline tagging...
950                         run_command tagtrack-$OUTPUT-$1 true
951                         ;;
952                     neroAacEnc) # Tag post encode with neroAacTag...
953                      run_command tagtrack-$OUTPUT-$1 nice $ENCNICE "$NEROAACTAG" "$ABCDETEMPDIR/track$1.m4a" \
954                      -meta:artist="$TRACKARTIST" -meta:album="$DALBUM" -meta:title="$TRACKNAME" -meta:track=${TRACKNUM:-$1} \
955                      -meta:year="$CDYEAR" -meta:genre="$CDGENRE" -meta:comment="$COMMENT"
956                       ;;
957                    faac)
958                      run_command tagtrack-$OUTPUT-$1 true                   
959                         ;;
960                 esac                    
961                         ;;
962                 wav)
963                         run_command tagtrack-$OUTPUT-$1 true
964                         ;;
965                 esac
966         done
967         if checkerrors "tagtrack-(.{3,6})-$1"; then :; else
968                 run_command tagtrack-$1 true
969         fi
970
971 }
972
973 # do_nogap_encode
974 # variables used:
975 # OUTPUTTYPE, {FOO}ENCODERSYNTAX, ENCNICE, ENCODER, ENCODEROPTS
976 do_nogap_encode ()
977 {
978         # The commands here don't go through run_command because they're never
979         # supposed to be silenced
980         echo "Encoding gapless MP3 tracks: $TRACKQUEUE"
981         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
982         do
983                 case "$OUTPUT" in
984                 mp3)
985                         case "$MP3ENCODERSYNTAX" in
986                         lame|toolame)
987                                 (
988                                 cd "$ABCDETEMPDIR"
989                                 TRACKFILES=
990                                 for UTRACKNUM in $TRACKQUEUE
991                                 do
992                                         TRACKFILES="$TRACKFILES track$UTRACKNUM.wav"
993                                 done
994                                 nice $ENCNICE $MP3ENCODER $MP3ENCODEROPTS --nogap $TRACKFILES
995                                 RETURN=$?
996                                 if [ "$RETURN" != "0" ]; then
997                                         echo "nogap-encode: $ENCODER returned code $RETURN" >> errors
998                                 else
999                                         for UTRACKNUM in $TRACKQUEUE
1000                                         do
1001                                                 run_command encodetrack-$OUTPUT-$UTRACKNUM true
1002                                                 #run_command encodetrack-$UTRACKNUM true
1003                                         done
1004                                 fi
1005                                 )
1006                                 ;;
1007                         esac
1008                         ;;
1009                 esac
1010         done
1011         if checkerrors "nogap-encode"; then :; else
1012                 if [ ! "$KEEPWAVS" = "y" ] ; then
1013                         if [ ! "$KEEPWAVS" = "move" ] ; then
1014                                 rm -f "$IN"
1015                         fi
1016                 fi
1017         fi
1018         # Other encoders fall through to normal encoding as the tracks have not
1019         # been entered in the status file.
1020 }
1021
1022 # do_encode [tracknumber] [hostname]
1023 # If no hostname is specified, encode locally
1024 # variables used:
1025 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
1026 do_encode ()
1027 {
1028         if [ "$USEPIPES" = "y" ]; then
1029                 case "$OUTPUT" in
1030                         mp3)
1031                                 TEMPARG="PIPE_$MP3ENCODERSYNTAX"
1032                                 ;;
1033                         vorbis|ogg)
1034                                 TEMPARG="PIPE_$OGGENCODERSYNTAX"
1035                                 ;;
1036                         opus)
1037                                 TEMPARG="PIPE_$OPUSENCODERSYNTAX"
1038                                 ;;
1039                         flac)
1040                                 TEMPARG="PIPE_$FLACENCODERSYNTAX"
1041                                 ;;
1042                         spx)
1043                                 TEMPARG="PIPE_$SPEEXENCODER"
1044                                 ;;
1045                         mpc)
1046                                 TEMPARG="PIPE_$MPCENCODER"
1047                                 ;;
1048                         aac)
1049                                 TEMPARG="PIPE_$AACENCODERSYNTAX"
1050                                 ;;
1051                         m4a)
1052                                 TEMPARG="PIPE_$AACENCODERSYNTAX"
1053                                 ;;
1054                 esac
1055                 IN="$( eval echo "\$$TEMPARG" )"
1056         else
1057                 IN="$ABCDETEMPDIR/track$1.wav"
1058                 case "$OUTPUT" in
1059                         mp3)
1060                                 case "$MP3ENCODERSYNTAX" in
1061                                         # FIXME # check if mp3enc needs -if for pipes
1062                                         # FIXME # I have not been able to find a working mp3enc binary
1063                                         mp3enc)
1064                                                 FILEARG="-if $IN"
1065                                                 ;;
1066                                         *)
1067                                                 FILEARG="$IN"
1068                                                 ;;
1069                                 esac
1070                                 ;;
1071                         *)
1072                                 FILEARG="$IN"
1073                                 ;;
1074                 esac
1075         fi
1076         # We need IN to proceed, if we are not using pipes.
1077         if [ -s "$IN" -o X"$USEPIPES" = "Xy" ] ; then
1078                 for TMPOUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1079                 do
1080                         case "$TMPOUTPUT" in
1081                                 vorbis|ogg)
1082                                         OUTPUT=$OGGOUTPUTCONTAINER
1083                                         ;;
1084                                 opus)
1085                                         OUTPUT=$OPUSOUTPUTCONTAINER
1086                                         ;;
1087                                 flac)
1088                                         OUTPUT=$FLACOUTPUTCONTAINER
1089                                         ;;
1090                                 *)
1091                                         OUTPUT=$TMPOUTPUT
1092                                         ;;
1093                         esac
1094                         OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
1095                         if [ "$NOGAP" = "y" ] && checkstatus encodetrack-$OUTPUT-$1 ; then
1096                                 continue
1097                         fi
1098                         if [ X"$USEPIPES" = "Xy" ]; then
1099                                 RUN_COMMAND=""
1100                                 # We need a way to store the creation of the files when using PIPES
1101                                 RUN_COMMAND_PIPES="run_command encodetrack-$OUTPUT-$1 true"
1102                                 # When pipping it does not make sense to have a higher nice for
1103                                 # reading than for encoding, since it will be hold by the
1104                                 # encoding process. Setting an effective nice, to calm down a
1105                                 # bit the reading process.
1106                                 EFFECTIVE_NICE=$READNICE
1107                         else
1108                                 run_command '' echo "Encoding track $1 of $TRACKS: $TRACKNAME..."
1109                                 RUN_COMMAND="run_command encodetrack-$OUTPUT-$1"
1110                                 EFFECTIVE_NICE=$ENCNICE
1111                         fi
1112                         case "$OUTPUT" in
1113                         mp3)
1114                                 case "$2" in
1115                                 %local*%)
1116                                         case "$MP3ENCODERSYNTAX" in
1117                                         lame|toolame|gogo) $RUN_COMMAND nice $EFFECTIVE_NICE $MP3ENCODER $MP3ENCODEROPTS "$IN" "$OUT" ;;
1118                                         bladeenc) $RUN_COMMAND nice $EFFECTIVE_NICE $MP3ENCODER $MP3ENCODEROPTS -quit "$IN" ;;
1119                                         l3enc|xingmp3enc) $RUN_COMMAND nice $EFFECTIVE_NICE $MP3ENCODER "$IN" "$OUT" $MP3ENCODEROPTS ;;
1120                                         # FIXME # Relates to the previous FIXME since it might need the "-if" removed.
1121                                         mp3enc) $RUN_COMMAND nice $EFFECTIVE_NICE $MP3ENCODER -if "$IN" -of "$OUT" $MP3ENCODEROPTS ;;
1122                                         esac
1123                                         ;;
1124                                 *)
1125                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
1126                                         ;;
1127                                 esac
1128                                 ;;
1129                         vorbis|ogg)
1130                                 case "$2" in
1131                                 %local*%)
1132                                         case "$OGGENCODERSYNTAX" in
1133                                         vorbize) $RUN_COMMAND nice $EFFECTIVE_NICE $OGGENCODER $OGGENCODEROPTS -w "$OUT" "$IN" ;;
1134                                         oggenc) $RUN_COMMAND nice $EFFECTIVE_NICE $OGGENCODER $OGGENCODEROPTS -o "$OUT" "$IN" ;;
1135                                         esac
1136                                         ;;
1137                                 *)
1138                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
1139                                         ;;
1140                                 esac
1141                                 ;;
1142                         opus)
1143                                 case "$2" in
1144                                 %local*%)
1145                                         case "$OPUSENCODERSYNTAX" in
1146                                         opusenc)
1147
1148                                             if [ "$(eval echo ${COMMENT})" != "" ]; then
1149                                                 case "$COMMENT" in
1150                                                     *=*) ;;
1151                                                      *)   COMMENT="COMMENT=$COMMENT" ;;
1152                                                 esac
1153                                             fi
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 $OPUSENCODER $OPUSENCODEROPTS --artist "$TRACKARTIST" --album "$DALBUM" --title "$TRACKNAME" --genre "$CDGENRE" --date "$CDYEAR" --comment TRACKNUMBER="$1" ${COMMENT:+--comment "$COMMENT"} "$IN" "$OUT"
1157                                             else
1158                                               $RUN_COMMAND nice $EFFECTIVE_NICE $OPUSENCODER $OPUSENCODEROPTS "$IN" "$OUT"
1159                                             fi
1160                                               ;;
1161                                         esac
1162                                         ;;
1163                                 *)
1164                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
1165                                         ;;
1166                                 esac
1167                                 ;;
1168                         flac)
1169                                 case "$2" in
1170                                 %local*%)
1171                                         case "$FLACENCODERSYNTAX" in
1172                                         flac) $RUN_COMMAND nice $EFFECTIVE_NICE $FLACENCODER -f $FLACENCODEROPTS -o "$OUT" "$IN" ;;
1173                                                 esac
1174                                                 ;;
1175                                         *)
1176                                                 vecho -n "DISTMP3:"
1177                                                 vecho "$DISTMP3 $DISTMP3OPTS $2 $IN $OUT >/dev/null 2>&1"
1178                                                 $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" > /dev/null 2>&1
1179                                         ;;
1180                                 esac
1181                                 ;;
1182                         spx)
1183                                 if [ "$(eval echo ${COMMENT})" != "" ]; then
1184                                         case "$COMMENT" in
1185                                                 *=*) ;;
1186                                                 *)   COMMENT="COMMENT=$COMMENT" ;;
1187                                         esac
1188                                 fi
1189                                 # Tag the file at encode time, as it can't be done after encoding.
1190                                 if [ "$DOTAG" = "y" ]; then
1191                                         $RUN_COMMAND nice $EFFECTIVE_NICE $SPEEXENCODER $SPEEXENCODEROPTS --author "$TRACKARTIST" --title "$TRACKNAME" ${COMMENT:+--comment "$COMMENT"} "$IN" "$OUT"
1192                                 else
1193                                         $RUN_COMMAND nice $EFFECTIVE_NICE $SPEEXENCODER $SPEEXENCODEROPTS "$IN" "$OUT"
1194                                 fi
1195                                 ;;
1196                         mpc)
1197                                 # MPP/MP+(Musepack) format (.mpc) is done locally, with inline
1198                                 # tagging. Uses mpcenc for Musepack SV8 encoding, changed from
1199                                 # Musepack SV7 which used mppenc....
1200                                 $RUN_COMMAND nice $EFFECTIVE_NICE $MPCENCODER $MPCENCODEROPTS --artist "$TRACKARTIST" --album "$DALBUM" --title "$TRACKNAME" --track "$1" --genre "$CDGENRE" --year "$CDYEAR" --comment "$COMMENT" "$IN" "$OUT"
1201                                 ;;
1202                         aac)
1203                         # aac container is only used to catch faac encoded files where faac 
1204                         # is compiled without mp4 support (with libmp4v2).           Andrew.
1205                           $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS -o "$OUT" "$IN"
1206                          ;;
1207                         m4a)
1208                          case "$AACENCODERSYNTAX" in
1209                            faac)
1210                              if [ "$DOTAG" = "y" ]; then
1211                    $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS  --artist "$TRACKARTIST" \
1212                    --album "$DALBUM" --title "$TRACKNAME" --track ${TRACKNUM:-$1} --year "$CDYEAR" \
1213                    --genre "$CDGENRE" --comment "$COMMENT" -o "$OUT" "$IN"                                
1214                  else                    
1215                    $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS -o "$OUT" "$IN"        
1216                  fi
1217                            ;;
1218                            neroAacEnc)
1219                     $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS -if "$IN" -of "$OUT"
1220                            ;;
1221                          fdkaac)                     
1222                         if [ "$DOTAG" = "y" ]; then
1223                           $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS --artist "$TRACKARTIST" --album "$DALBUM" \
1224                           --title "$TRACKNAME" --track "$1" --genre "$CDGENRE" --long-tag Year:"$CDYEAR" --comment "$COMMENT" "$IN" -o "$OUT"
1225                             else
1226                      $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS "$IN" -o "$OUT"      
1227                             fi
1228                  ;;
1229                           esac  
1230                                 ;;
1231                         wav)
1232                                 # In case of wav output we need nothing. Just keep the wavs.
1233                                 ;;
1234                         esac
1235                         $RUN_COMMAND_PIPES
1236                 done
1237                 # Only remove .wav if the encoding succeeded
1238                 if checkerrors "encodetrack-(.{3,6})-$1"; then :; else
1239                         run_command encodetrack-$1 true
1240                         if [ ! "$KEEPWAVS" = "y" ] ; then
1241                                 if [ ! "$KEEPWAVS" = "move" ] ; then
1242                                         rm -f "$IN"
1243                                 fi
1244                         fi
1245                 fi
1246         else
1247                 run_command "" echo "HEH! The file we were about to encode disappeared:"
1248                 run_command "" echo ">> $IN"
1249                 run_command encodetrack-$1 false
1250         fi
1251 }
1252
1253 # do_preprocess [tracknumber]
1254 # variables used:
1255 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
1256 #do_preprocess ()
1257 #{
1258 #       IN="$ABCDETEMPDIR/track$1.wav"
1259 #       # We need IN to proceed.
1260 #       if [ -s "$IN" ] ; then
1261 #               for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1262 #               do
1263 #                       #OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
1264 #                       run_command '' echo "Pre-processing track $1 of $TRACKS..."
1265 #                       case "$POSTPROCESSFORMAT" in
1266 #                       all|wav*)
1267 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $WAV_PRE $IF $OF ;;
1268 #                       mp3)
1269 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $MP3_PRE $IF $OF ;;
1270 #                       ogg)
1271 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $OGG_PRE $IF $OF ;;
1272 #                       flac)
1273 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $FLAC_PRE $IF $OF ;;
1274 #                       spx)
1275 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $SPX_PRE $IF $OF ;;
1276 #                       esac
1277 #               done
1278 #               # Only remove .wav if the encoding succeeded
1279 #               if checkerrors "preprocess-(.{3,4})-$1"; then
1280 #                       run_command preprocess-$1 false
1281 #               else
1282 #                       run_command preprocess-$1 true
1283 #               fi
1284 #       else
1285 #               if [ "$(checkstatus encode-output)" = "loud" ]; then
1286 #                       echo "HEH! The file we were about to pre-process disappeared:"
1287 #                       echo ">> $IN"
1288 #               fi
1289 #               run_command preprocess-$1 false
1290 #       fi
1291 #}
1292
1293
1294 # do_postprocess [tracknumber]
1295 # variables used:
1296 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
1297 #do_postprocess ()
1298 #{
1299 #       for POSTPROCESSFORMAT in $(echo $POSTPROCESSFORMATS | tr , \ )
1300 #       do
1301 #               IN="$ABCDETEMPDIR/track$1.$POSTPROCESSFORMAT"
1302 #               # We need IN to proceed.
1303 #               if [ -s "$IN" ] ; then
1304 #                       #OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
1305 #                       run_command '' echo "Post-processing track $1 of $TRACKS..."
1306 #                       case "$POSTPROCESSFORMAT" in
1307 #                               mp3)
1308 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $MP3_POST $IF $OF ;;
1309 #                               ogg)
1310 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $OGG_POST $IF $OF ;;
1311 #                               flac)
1312 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $FLAC_POST $IF $OF ;;
1313 #                               spx)
1314 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $SPX_POST $IF $OF ;;
1315 #                       esac
1316 #                       # Only remove .wav if the encoding succeeded
1317 #                       if checkerrors "postprocess-(.{3,4})-$1"; then
1318 #                               run_command postprocess-$1 false
1319 #                       else
1320 #                               run_command postprocess-$1 true
1321 #                       fi
1322 #               else
1323 #                       if [ "$(checkstatus encode-output)" = "loud" ]; then
1324 #                               echo "HEH! The file we were about to post-process disappeared:"
1325 #                               echo ">> $IN"
1326 #                       fi
1327 #                       run_command postprocess-$1 false
1328 #               fi
1329 #       done
1330 #}
1331
1332 # do_single_gain
1333 # variables used:
1334 # FIXME #
1335 do_single_gain ()
1336 {
1337 :
1338 }
1339
1340 # do_batch_gain
1341 # variables used:
1342 # MP3GAIN, MP3GAINOPTS, VORBISGAIN, VORBISGAINOPTS, MPPGAIN, MPPGAINOPTS
1343 # FIXME #
1344 do_batch_gain ()
1345 {
1346         # The commands here don't go through run_command because they're never supposed to be silenced
1347         echo "Batch analizing gain in tracks: $TRACKQUEUE"
1348         (
1349         cd "$ABCDETEMPDIR"
1350         BLURB=
1351         TRACKFILES=
1352         for UTRACKNUM in $TRACKQUEUE
1353         do
1354                 MP3FILES="$TRACKFILES track$UTRACKNUM.mp3"
1355         done
1356         # FIXME # Hard-coded batch option!
1357         $NORMALIZER -b $NORMALIZEROPTS $TRACKFILES
1358         RETURN=$?
1359         if [ "$RETURN" != "0" ]; then
1360                 echo "batch-normalize: $NORMALIZER returned code $RETURN" >> errors
1361         else
1362                 for UTRACKNUM in $TRACKQUEUE
1363                 do
1364                         echo normalizetrack-$UTRACKNUM >> status
1365                 done
1366         fi
1367         )
1368 }
1369
1370 # do_batch_normalize
1371 # variables used:
1372 # NORMALIZER, NORMALIZEROPTS
1373 do_batch_normalize ()
1374 {
1375         # The commands here don't go through run_command because they're never supposed to be silenced
1376         echo "Batch normalizing tracks: $TRACKQUEUE"
1377         (
1378         cd "$ABCDETEMPDIR"
1379         BLURB=
1380         TRACKFILES=
1381         for UTRACKNUM in $TRACKQUEUE
1382         do
1383                 TRACKFILES="$TRACKFILES track$UTRACKNUM.wav"
1384         done
1385         # XXX: Hard-coded batch option!
1386         $NORMALIZER -b $NORMALIZEROPTS $TRACKFILES
1387         RETURN=$?
1388         if [ "$RETURN" != "0" ]; then
1389                 echo "batch-normalize: $NORMALIZER returned code $RETURN" >> errors
1390         else
1391                 for UTRACKNUM in $TRACKQUEUE
1392                 do
1393                         echo normalizetrack-$UTRACKNUM >> status
1394                 done
1395         fi
1396         )
1397 }
1398
1399 # do_normalize [tracknumber]
1400 # variables used:
1401 # TRACKS, TRACKNAME, NORMALIZER, NORMALIZEROPTS
1402 do_normalize ()
1403 {
1404         IN="$ABCDETEMPDIR/track$1.wav"
1405         if [ -e "$IN" ] ; then
1406                 run_command '' echo "Normalizing track $1 of $TRACKS: $TRACKNAME..."
1407                 run_command normalizetrack-$1 $NORMALIZER $NORMALIZEROPTS "$IN"
1408         else
1409                 if [ "$(checkstatus encode-output)" = "loud" ]; then
1410                         echo "HEH! The file we were about to normalize disappeared:"
1411                         echo ">> $IN"
1412                 fi
1413                 run_command normalizetrack-$1 false "File $IN was not found"
1414         fi
1415 }
1416
1417 # do_move [tracknumber]
1418 # Deduces the outfile from environment variables
1419 # Creates directory if necessary
1420 # variables used:
1421 # TRACKNUM, TRACKNAME, TRACKARTIST, DALBUM, OUTPUTFORMAT, CDGENRE, CDYEAR
1422 do_move ()
1423 {
1424         for TMPOUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1425         do
1426                 # For now, set OUTPUT as TMPOUTPUT, and then change it once we have
1427                 # defined the OUTPUTFILE:
1428                 OUTPUT="$TMPOUTPUT"
1429
1430                 # Create ALBUMFILE, ARTISTFILE, TRACKFILE
1431                 # Munge filenames as follows:
1432                 # ' ' -> '_'
1433                 # '/' -> '_'
1434                 # ''' -> ''
1435                 # '?' -> ''
1436                 # Eat control characters
1437                 ALBUMFILE="$(mungefilename "$DALBUM")"
1438                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1439                 TRACKFILE="$(mungefilename "$TRACKNAME")"
1440                 GENRE="$(mungegenre "$GENRE")"
1441                 YEAR=${CDYEAR:-$CDYEAR}
1442                 # If we want to start the tracks with a given number, we need to modify
1443                 # the TRACKNUM value before evaluation
1444                 gettracknum
1445                 # Supported variables for OUTPUTFORMAT are GENRE, YEAR, ALBUMFILE,
1446                 # ARTISTFILE, TRACKFILE, and TRACKNUM.
1447                 if [ "$ONETRACK" = "y" ]; then
1448                         if [ "$VARIOUSARTISTS" = "y" ]; then
1449                                 OUTPUTFILE="$(eval echo \""$VAONETRACKOUTPUTFORMAT"\")"
1450                         else
1451                                 OUTPUTFILE="$(eval echo \""$ONETRACKOUTPUTFORMAT"\")"
1452                         fi
1453                 else
1454                         if [ "$VARIOUSARTISTS" = "y" ]; then
1455                                 OUTPUTFILE="$(eval echo \""$VAOUTPUTFORMAT"\")"
1456                         else
1457                                 OUTPUTFILE="$(eval echo \""$OUTPUTFORMAT"\")"
1458                         fi
1459                 fi
1460                 if checkerrors "tagtrack-$OUTPUT-$1"; then :; else
1461                         # Once we know the specific output was successful, we can change
1462                         # the OUTPUT to the value containing the container
1463                         case $TMPOUTPUT in
1464                                 vorbis|ogg)
1465                                         OUTPUT=$OGGOUTPUTCONTAINER
1466                                         ;;
1467                                 opus)
1468                                         OUTPUT=$OPUSOUTPUTCONTAINER
1469                                         ;;
1470                                 flac)
1471                                         OUTPUT=$FLACOUTPUTCONTAINER
1472                                         ;;
1473                                 *)
1474                                         OUTPUT=$TMPOUTPUT
1475                                         ;;
1476                         esac
1477                         # Check that the directory for OUTPUTFILE exists, if it doesn't, create it
1478                         OUTPUTFILEDIR="$(dirname "$OUTPUTDIR/$OUTPUTFILE")"
1479                         case $OUTPUT in
1480                                 wav)
1481                                         if [ "$DOCLEAN" != "y" ] && [ "$FORCE" != "y" ]; then
1482                                                 # FIXME # introduce warnings?
1483                                                 :
1484                                         else
1485                                                 # mkdir -p shouldn't return an error if the directory already exists
1486                                                 mkdir -p "$OUTPUTFILEDIR"
1487                                                 run_command movetrack-$1 mv "$ABCDETEMPDIR/track$1.$OUTPUT" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
1488                                                 if checkstatus movetrack-output-$OUTPUT; then :; else
1489                                                         run_command movetrack-output-$OUTPUT true
1490                                                 fi
1491                                         fi
1492                                         ;;
1493                                 *)
1494                                         # mkdir -p shouldn't return an error if the directory already exists
1495                                         mkdir -p "$OUTPUTFILEDIR"
1496                                         run_command movetrack-$1 mv "$ABCDETEMPDIR/track$1.$OUTPUT" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
1497                                         if checkstatus movetrack-output-$OUTPUT; then :; else
1498                                                 run_command movetrack-output-$OUTPUT true
1499                                         fi
1500                                         ;;
1501                         esac
1502                         # Lets move the cue file
1503                         if CUEFILE=$(checkstatus cuefile) >/dev/null ; then
1504                                 if [ -r "$ABCDETEMPDIR/$CUEFILE" ]; then
1505                                         if checkstatus movecue-$OUTPUT; then :; else
1506                                                 # Silence the Copying output since it overlaps with encoding processes...
1507                                                 #run_command '' vecho "Copying cue file to its destination directory..."
1508                                                 if checkstatus onetrack >/dev/null ; then
1509                                                         case $OUTPUT in
1510                                                                 wav)
1511                                                                         if [ "$DOCLEAN" != "y" ] && [ "$FORCE" != "y" ]; then
1512                                                                                 # We dont have the dir, since it was not created before.
1513                                                                                 :
1514                                                                         else
1515                                                                                 run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.cue"
1516                                                                         fi
1517                                                                         ;;
1518                                                                 # NOTE: Creating a cue file with the 3-char-extension files is to comply with
1519                                                                 # http://brianvictor.tripod.com/mp3cue.htm#details
1520                                                                 [a-z0-9][a-z0-9][a-z0-9])
1521                                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.cue"
1522                                                                         ;;
1523                                                                 *)
1524                                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT.cue"
1525                                                                         ;;
1526                                                         esac
1527                                                 else
1528                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTFILEDIR/$CUEFILE"
1529                                                 fi
1530                                                 echo movecue-$OUTPUT >> "$ABCDETEMPDIR/status"
1531                                         fi
1532                                 fi
1533                         fi
1534                 fi
1535         done
1536 }
1537
1538 # do_playlist
1539 # Create the playlist if wanted
1540 # Variables used:
1541 # PLAYLISTFORMAT, PLAYLISTDATAPREFIX, VAPLAYLISTFORMAT, VAPLAYLISTDATAPREFIX,
1542 # VARIOUSARTISTS, OUTPUTDIR
1543 do_playlist ()
1544 {
1545         for TMPOUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1546         do
1547                 case $TMPOUTPUT in
1548                         vorbis|ogg)
1549                                 OUTPUT=$OGGOUTPUTCONTAINER
1550                                 ;;
1551                         opus)
1552                                 OUTPUT=$OPUSOUTPUTCONTAINER
1553                                 ;;
1554                         flac)
1555                                 OUTPUT=$FLACOUTPUTCONTAINER
1556                                 ;;
1557                         *)
1558                                 OUTPUT=$TMPOUTPUT
1559                                 ;;
1560                 esac
1561                 # Create a playlist file for the playlist data to go into.
1562                 # We used to wipe it out if it existed. Now we request permission if interactive.
1563                 for LASTTRACK in $TRACKQUEUE; do :; done
1564                 ALBUMFILE="$(mungefilename "$DALBUM")"
1565                 ARTISTFILE="$(mungefilename "$DARTIST")"
1566                 GENRE="$(mungegenre "$GENRE")"
1567                 YEAR=${CDYEAR:-$CDYEAR}
1568                 if [ "$VARIOUSARTISTS" = "y" ] ; then
1569                         PLAYLISTFILE="$(eval echo "$VAPLAYLISTFORMAT")"
1570                 else
1571                         PLAYLISTFILE="$(eval echo "$PLAYLISTFORMAT")"
1572                 fi
1573                 FINALPLAYLISTDIR="$(dirname "$OUTPUTDIR/$PLAYLISTFILE")"
1574                 mkdir -p "$FINALPLAYLISTDIR"
1575                 if [ -s "$OUTPUTDIR/$PLAYLISTFILE" ]; then
1576                         echo -n "Erase, Append to, or Keep the existing playlist file? [e/a/k] (e): " >&2
1577                         if [ "$INTERACTIVE" = "y" ]; then
1578                                 while [ "$DONE" != "y" ]; do
1579                                         read ERASEPLAYLIST
1580                                         case $ERASEPLAYLIST in
1581                                                 e|E|a|A|k|K) DONE=y ;;
1582                                                 "") ERASEPLAYLIST=e ; DONE=y ;;
1583                                                 *) ;;
1584                                         esac
1585                                 done
1586                         else
1587                                 echo e >&2
1588                                 ERASEPLAYLIST=e
1589                         fi
1590                         # Once we erase the playlist, we use append to create the new one.
1591                         [ "$ERASEPLAYLIST" = "e" -o "$ERASEPLAYLIST" = "E" ] && rm -f "$OUTPUTDIR/$PLAYLISTFILE" && ERASEPLAYLIST=a
1592                 else
1593                         # The playlist does not exist, so we can safelly use append to create the new list
1594                         ERASEPLAYLIST=a
1595                 fi
1596                 if [ "$ERASEPLAYLIST" = "a" -o "$ERASEPLAYLIST" = "A" ]; then
1597                         touch "$OUTPUTDIR/$PLAYLISTFILE"
1598                         for UTRACKNUM in $TRACKQUEUE
1599                         do
1600                                 # Shares some code with do_move since the filenames have to match
1601                                 CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
1602                                 getcddbinfo TRACKNAME
1603                                 splitvarious
1604                                 TRACKFILE="$(mungefilename "$TRACKNAME")"
1605                                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1606                                 ALBUMFILE="$(mungefilename "$DALBUM")"
1607                                 # If we want to start the tracks with a given number, we need to modify the
1608                                 # TRACKNUM value before evaluation
1609                                 gettracknum
1610                                 if [ "$VARIOUSARTISTS" = "y" ]; then
1611                                         OUTPUTFILE="$(eval echo \""$VAOUTPUTFORMAT\"")"
1612                                 else
1613                                         OUTPUTFILE="$(eval echo \""$OUTPUTFORMAT\"")"
1614                                 fi
1615                                 if [ "$VARIOUSARTISTS" = "y" ]; then
1616                                         if [ "$VAPLAYLISTDATAPREFIX" ] ; then
1617                                                 echo ${VAPLAYLISTDATAPREFIX}$OUTPUTFILE.$OUTPUT >> "$OUTPUTDIR/$PLAYLISTFILE"
1618                                         else
1619                                                 relpath "$PLAYLISTFILE", "$OUTPUTFILE.$OUTPUT" >> "$OUTPUTDIR/$PLAYLISTFILE"
1620                                         fi
1621                                 else
1622                                         if [ "$PLAYLISTDATAPREFIX" ]; then
1623                                                 echo ${PLAYLISTDATAPREFIX}$OUTPUTFILE.$OUTPUT >> "$OUTPUTDIR/$PLAYLISTFILE"
1624                                         else
1625                                                 relpath "$PLAYLISTFILE", "$OUTPUTFILE.$OUTPUT" >> "$OUTPUTDIR/$PLAYLISTFILE"
1626                                         fi
1627                                 fi
1628                         done
1629                 fi
1630                 ## this will convert the playlist to have CRLF line-endings, if specified
1631                 ## (some hardware players insist on CRLF endings)
1632                 if [ "$DOSPLAYLIST" = "y" ]; then
1633                         awk '{sub("\r$",""); printf "%s\r\n", $0}' "$OUTPUTDIR/$PLAYLISTFILE" > "$ABCDETEMPDIR/PLAYLISTFILE.tmp"
1634 #                       mv -f "$ABCDETEMPDIR/PLAYLISTFILE.tmp" "$OUTPUTDIR/$PLAYLISTFILE"
1635                         cat "$ABCDETEMPDIR/PLAYLISTFILE.tmp" | sed 's/\//\\/' > "$OUTPUTDIR/$PLAYLISTFILE"
1636                 fi
1637                 echo "playlistcomplete" >> "$ABCDETEMPDIR/status"
1638         done
1639 }
1640
1641 # abcde.cue2discid
1642 # This function reads a cuefile on stdin and writes an extended
1643 # cddb query on stdout.  Any PREGAP for track 1 is properly
1644 # handled, although cue files embedded in FLAC files do not
1645 # appear to properly store the PREGAP setting. :(
1646 abcde.cue2discid () {
1647
1648         cddb_sum () {
1649                 val=$1
1650                 ret=0
1651                 while [ $val -gt 0 ] ; do
1652                         ret=$(( $ret + ( $val % 10) ))
1653                         val=$(( $val / 10 ))
1654                 done
1655                 echo $ret
1656         }
1657
1658         msf2lba () {
1659                 OIFS="$IFS"
1660                 IFS=":"
1661                 set -- $1
1662                 IFS="$OIFS"
1663                 local first second third
1664                 first=$(expr ${1} + 0 )
1665                 second=$(expr ${2} + 0 )
1666                 third=$(expr ${3} + 0 )
1667
1668                 echo $(( ((($first * 60) + $second) * 75) + $third ))
1669         }
1670
1671         OFFSET=150
1672         PREGAP=0
1673         LEADOUT=0
1674         LEADIN=88200
1675         i=0
1676         N=0
1677
1678         while read line ; do
1679                 set -- $line
1680                 case "$1" in
1681                 TRACK)  i=$(( i + 1 ))
1682                         ;;
1683                 INDEX)  if [ "$2" -eq 1 ] ; then
1684                                 LBA=$(msf2lba $3)
1685                                 START=$(( $LBA + $PREGAP + $OFFSET ))
1686                                 eval TRACK$i=$START
1687                                 X=$(cddb_sum $(( $START / 75 )) )
1688                                 N=$(( $N + $X ))
1689                         fi
1690                         ;;
1691                 PREGAP) PREGAP=$(msf2lba $2)
1692                         ;;
1693                 REM)    case "$2" in
1694                         FLAC__lead-out)
1695                                 LEADOUT=$(( $4 / 588 ))
1696                                 ;;
1697                         FLAC__lead-in)
1698                                 LEADIN=$(( $3 / 588 ))
1699                                 ;;
1700                         esac
1701                         ;;
1702                 esac
1703
1704         done
1705
1706         TRACKS=$i
1707         LEADOUT=$(( $LEADOUT + $LEADIN ))
1708
1709         LENGTH=$(( $LEADOUT/75 - $TRACK1/75 ))
1710         DISCID=$(( ( $N % 255 ) * 2**24 | $LENGTH * 2**8 | $TRACKS ))
1711         printf "%08x %i" $DISCID $TRACKS
1712
1713         j=1
1714         while [ $j -le $TRACKS ] ; do
1715                 eval echo -n "\" \$TRACK$j\""
1716                 j=$((j+1))
1717         done
1718         echo " $(( $LEADOUT / 75 ))"
1719 }
1720
1721 # abcde.mkcue
1722 # abcde.mkcue [--wholedisk]
1723 # This creates a cuefile directly from the extended discid information
1724 # The --wholedisk option controls whether we're ripping data from the
1725 # start of track one or from the start of the disk (usually, but not
1726 # always the same thing!)
1727 #
1728 # Track one leadin/pregap (if any) handeling:
1729 # --wholedisk specified:
1730 #   TRACK 01 AUDIO
1731 #     INDEX 00 00:00:00
1732 #     INDEX 01 <pregap value>
1733 #   Remaining track index values unchanged from disc TOC
1734 #
1735 # --wholedisk not specified
1736 #   TRACK 01 AUDIO
1737 #     PREGAP <pregap value>
1738 #     INDEX 01 00:00:00
1739 #   Remaining track index values offset by <pregap value>
1740 #
1741 # Variables used:
1742 # TRACKINFO
1743 abcde.mkcue () {
1744
1745         echomsf () {
1746                 printf "$1%02i:%02i:%02i\n" $(($2/4500)) $((($2/75)%60)) $(($2%75))
1747         }
1748
1749         local MODE DISCID TRACKS
1750         local i OFFSET LBA
1751         local CUEWAVFILE
1752
1753         if [ "$1" = --wholedisc ] ; then
1754                 MODE=INDEX
1755         else
1756                 MODE=PREGAP
1757         fi
1758
1759         vecho "One track is $ONETRACK"
1760         TRACKFILE="$(mungefilename "$TRACKNAME")"
1761         ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1762         ALBUMFILE="$(mungefilename "$DALBUM")"
1763         if [ "$ONETRACK" = "y" ]; then
1764                 if [ "$VARIOUSARTISTS" = "y" ]; then
1765                         CUEWAVFILE="$(eval echo \""$VAONETRACKOUTPUTFORMAT"\" | sed -e 's@^.*/@@').$OUTPUT"
1766                 else
1767                         CUEWAVFILE="$(eval echo \""$ONETRACKOUTPUTFORMAT"\" | sed -e 's@^.*/@@').$OUTPUT"
1768                 fi
1769                 vecho "Cue wav file is $CUEWAVFILE"
1770         else
1771                 CUEWAVFILE="dummy.wav"
1772         fi
1773
1774         set -- $TRACKINFO
1775
1776         DISCID=$1
1777         TRACKS=$2
1778         shift 2
1779
1780         echo REM DISCID $DISCID
1781         echo FILE \""$CUEWAVFILE"\" WAVE
1782
1783         if [ $1 -ne 150 ] && [ $MODE = "PREGAP" ] ; then
1784                 OFFSET=$1
1785         else
1786                 OFFSET=150
1787         fi
1788
1789         i=1
1790         while [ $i -le "$TRACKS" ] ; do
1791                 LBA=$(( $1 - $OFFSET ))
1792                 printf "  TRACK %02i AUDIO\n" $i
1793                 if [ $i -eq 1 -a $1 -ne 150 ] ; then
1794                         if [ $MODE = PREGAP ] ; then
1795                                 echomsf "    PREGAP " $(($OFFSET-150))
1796                         else
1797                                 echo    "    INDEX 00 00:00:00"
1798                         fi
1799                 fi
1800                 echomsf "    INDEX 01 " $LBA
1801                 i=$(($i+1))
1802                 shift
1803         done
1804 }
1805
1806 # do_discid
1807 # This essentially the start of things
1808 do_discid ()
1809 {
1810         # Query the CD to get the track info, unless the user specified -C
1811         # or we are using some actions which do not need the CDDB data at all
1812         #if [ ! X"$EXPACTIONS" = "X" ]; then
1813         #       :
1814         #elif [ -z "$DISCID" ]; then
1815         if [ -z "$DISCID" ]; then
1816                 vecho -n "Getting CD track info... "
1817                 # In OSX, unmount the disc before a query
1818                 if [ "$OSFLAVOUR" = "OSX" ]; then
1819                         diskutil unmount ${CDROM#/dev/}
1820                 fi
1821                 case "$CDROMREADERSYNTAX" in
1822                         flac)
1823                                 if $METAFLAC $METAFLACOPTS --export-cuesheet-to=- "$CDROM" > /dev/null 2>&1 ; then
1824                                         case "$CUE2DISCID" in
1825                                                 # FIXME # right now we have 2 cue2discid internal
1826                                                 # implementations: builtin and abcde.cue2discid. Test
1827                                                 # both of them and decide which one we want to use.
1828                                                 builtin)
1829                                                         #vecho "Using builtin cue2discid implementation..."
1830                                                         CUESHEET="$(metaflac $METAFLACOPTS --export-cuesheet-to=- "$CDROM")"
1831
1832                                                         #TRACKS=$(echo $CUESHEET | grep -E "TRACK \+[[:digit:]]\+ \+AUDIO" |wc -l)
1833                                                         #TRACKS=0
1834                                                         OFFSETTIMES=( $(echo "$CUESHEET" | sed -n -e's/\ *INDEX 01\ \+//p' ) )
1835                                                         TRACKS=${#OFFSETTIMES[@]}
1836                                                         unset OFFSETS
1837                                                         #echo "processing offsetimes ${OFFSETTIMES[@]}"
1838                                                         for OFFSETTIME in ${OFFSETTIMES[@]}; do
1839                                                                 OFFSETS="$OFFSETS $(( 10#${OFFSETTIME:0:2} * 4500 + 10#${OFFSETTIME:3:2} * 75 + 10#${OFFSETTIME:6:2} ))"
1840                                                                 #OFFSETS[${#OFFSETS[*]}]=$(( 10#${OFFSETTIME:0:2} * 4500 + 10#${OFFSETTIME:3:2} * 75 + 10#${OFFSETTIME:6:2} ))
1841                                                         done
1842
1843                                                         LEADOUT=$(( $(echo "$CUESHEET" | grep lead-out | get_last) * 75 / 44100 ))
1844                                                         LEADIN=$(( $(echo "$CUESHEET" | grep lead-in | get_last) * 75 / 44100 ))
1845                                                         makeids
1846                                                 ;;
1847                                                 *)
1848                                                         #vecho "Using external python cue2discid implementation..."
1849                                                         TRACKINFO=$($METAFLAC $METAFLACOPTS --export-cuesheet-to=- "$CDROM" | $CUE2DISCID)
1850                                                 ;;
1851                                         esac
1852                                 else
1853                                         log error "the input flac file does not contain a cuesheet."
1854                                         exit 1
1855                                 fi
1856                                 ;;
1857 #                       cdparanoia|debug)
1858 #                               CDPARANOIAOUTPUT="$( $CDROMREADER -$CDPARANOIACDROMBUS "$CDROM" -Q --verbose 2>&1 )"
1859 #                               RET=$?
1860 #                               if [ ! "$RET" = "0" ];then
1861 #                                       log warning "something went wrong while querying the CD... Maybe a DATA CD?"
1862 #                               fi
1863 #
1864 #                               TRACKS="$(echo "$CDPARANOIAOUTPUT" | grep -E '^[[:space:]]+[[:digit:]]' | tail -n 1 | get_first | tr -d "." | tr '\n' ' ')"
1865 #                               CDPARANOIAAUDIOTRACKS="$TRACKS"
1866 #
1867 #                               LEADOUT="$(echo "$CDPARANOIAOUTPUT" | grep -Eo '^TOTAL[[:space:]]+([[:digit:]]+)' | get_last)"
1868 #                               OFFSETS="$(echo "$CDPARANOIAOUTPUT" | sed -n -e's/^ .* \([0-9]\+\) \[.*/\1/p')"
1869 #                               makeids
1870 #                               ;;
1871                         *)
1872                                 case "$CDDBMETHOD" in
1873                                         cddb) TRACKINFO=$($CDDISCID "$CDROM") ;;
1874                                         musicbrainz) TRACKINFO=$($MUSICBRAINZ --command id --device "$CDROM") ;;
1875                                 esac
1876                                 ;;
1877                 esac
1878                 # Make sure there's a CD in there by checking cd-discid's return code
1879                 if [ ! "$?" = "0" ]; then
1880                         if [ "$CDROMREADERSYNTAX" = "flac" ] ; then
1881                                 log error "cuesheet information from the flac file could not be read."
1882                                 log error "Perhaps the flac file does not contain a cuesheet?."
1883                                 exit 1
1884                         else
1885                                 log error "CD could not be read. Perhaps there's no CD in the drive?"
1886                                 exit 1
1887                         fi
1888                 fi
1889                 # In OSX, remount the disc again
1890                 if [ "$OSFLAVOUR" = "OSX" ]; then
1891                         diskutil mount ${CDROM#/dev/}
1892                 fi
1893                 WEHAVEACD=y
1894                 DISCID=$(echo $TRACKINFO | cut -f1 -d' ')
1895         else
1896                 TRACKINFO=$(cat "$WAVOUTPUTDIR/abcde.$DISCID/discid")
1897         fi
1898
1899         # Get a full enumeration of tracks, sort it, and put it in the TRACKQUEUE.
1900         # This needs to be done now because a section of the resuming code will need
1901         # it later.
1902
1903         # get the number of digits to pad TRACKNUM with - we'll use this later
1904         # a CD can only hold 99 tracks, but since we support a feature for starting
1905         # numbering the tracks from a given number, we might need to set it as a
1906         # variable for the user to define... or obtain it somehow.
1907         if [ "$PADTRACKS" = "y" ] ; then
1908                 TRACKNUMPADDING=2
1909         fi
1910
1911         ABCDETEMPDIR="$WAVOUTPUTDIR/abcde.$(echo $TRACKINFO | cut -f1 -d' ')"
1912         if [ -z "$TRACKQUEUE" ]; then
1913                 if [ ! "$STRIPDATATRACKS" = "n" ]; then
1914                         case "$CDROMREADERSYNTAX" in
1915                                 cdparanoia|debug)
1916                                         if [ "$WEHAVEACD" = "y" ]; then
1917                                                 vecho "Querying the CD for audio tracks..."
1918                                                 CDPARANOIAOUTPUT="$( $CDROMREADER -$CDPARANOIACDROMBUS "$CDROM" -Q --verbose 2>&1 )"
1919                                                 RET=$?
1920                                                 if [ ! "$RET" = "0" ];then
1921                                                         log warning "something went wrong while querying the CD... Maybe a DATA CD?"
1922                                                 fi
1923                                                 TRACKS="$(echo "$CDPARANOIAOUTPUT" | grep -E '^[[:space:]]+[[:digit:]]' | tail -n 1 | get_first | tr -d "." | tr '\n' ' ')"
1924                                                 CDPARANOIAAUDIOTRACKS="$TRACKS"
1925                                         else
1926                                                 # Previous versions of abcde would store the tracks on a file, instead of the status record.
1927                                                 if [ -f "$ABCDETEMPDIR/cdparanoia-audio-tracks" ]; then
1928                                                         echo cdparanoia-audio-tracks=$( cat "$ABCDETEMPDIR/cdparanoia-audio-tracks" ) >> "$ABCDETEMPDIR/status"
1929                                                         rm -f "$ABCDETEMPDIR/cdparanoia-audio-tracks"
1930                                                 fi
1931                                                 if [ -f "$ABCDETEMPDIR/status" ] && TRACKS=$(checkstatus cdparanoia-audio-tracks); then :; else
1932                                                         TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1933                                                 fi
1934                                         fi
1935                                         ;;
1936                                 *)      TRACKS=$(echo $TRACKINFO | cut -f2 -d' ') ;;
1937                         esac
1938                 else
1939                         TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1940                 fi
1941                 if echo "$TRACKS" | grep "[[:digit:]]" > /dev/null 2>&1 ;then :;else
1942                         log info "The disc does not contain any tracks. Giving up..."
1943                         exit 0
1944                 fi
1945                 echo -n "Grabbing entire CD - tracks: "
1946                 if [ ! "$PADTRACKS" = "y" ] ; then
1947                         TRACKNUMPADDING=$(echo -n $TRACKS | wc -c | tr -d ' ')
1948                 fi
1949                 TRACKS=$(printf "%0.${TRACKNUMPADDING}d" $TRACKS)
1950                 X=0
1951                 while [ "$X" -ne "$TRACKS" ]
1952                 do
1953                         X=$(printf "%0.${TRACKNUMPADDING}d" $(expr $X + 1))
1954                         TRACKQUEUE=$(echo $TRACKQUEUE $X)
1955                 done
1956                 echo $TRACKQUEUE
1957         else
1958                 TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1959                 # User-supplied track queue.
1960                 # Weed out non-numbers, whitespace, then sort and weed out duplicates
1961                 TRACKQUEUE=$(echo $TRACKQUEUE | sed 's-[^0-9 ]--g' | tr ' ' '\n' | grep -v ^$ | sort -n | uniq | tr '\n' ' ' | sed 's- $--g')
1962                 # Once cleaned, obtain the highest value in the trackqueue for number padding
1963                 for LASTTRACK in $TRACKQUEUE; do :; done
1964                 if [ ! "$PADTRACKS" = "y" ] ; then
1965                         TRACKNUMPADDING=$(echo -n $LASTTRACK | wc -c | tr -d ' ')
1966                 fi
1967                 # Now we normalize the trackqueue
1968                 for TRACK in $TRACKQUEUE ; do
1969                         TRACKNUM=$(printf %0.${TRACKNUMPADDING}d $(expr ${TRACK} + 0 ))
1970                         PADTRACKQUEUE=$(echo $PADTRACKQUEUE $TRACKNUM)
1971                 done
1972                 TRACKQUEUE=$PADTRACKQUEUE
1973                 echo Grabbing tracks: "$TRACKQUEUE"
1974         fi
1975
1976         QUEUEDTRACKS=$(echo $TRACKQUEUE | wc -w | tr -d ' ')
1977
1978         # We have the discid, create a temp directory after it to store all the temp
1979         # info
1980
1981         if [ -e "$ABCDETEMPDIR" ]; then
1982                 echo -n "abcde: attempting to resume from $ABCDETEMPDIR"
1983                 # It already exists, see if it's a directory
1984                 if [ ! -d "$ABCDETEMPDIR" ]; then
1985                         # This is a file/socket/fifo/device/etc, not a directory
1986                         # Complain and exit
1987                         echo >&2
1988                         echo "abcde: file $ABCDETEMPDIR already exists and does not belong to abcde." >&2
1989                         echo "Please investigate, remove it, and rerun abcde." >&2
1990                         exit 1
1991                 fi
1992                 echo -n .
1993                 # It's a directory, let's see if it's writable by us
1994                 if [ ! -r "$ABCDETEMPDIR" ] || [ ! -w "$ABCDETEMPDIR" ] || [ ! -x "$ABCDETEMPDIR" ]; then
1995                         # Nope, complain and exit
1996                         echo >&2
1997                         echo "abcde: directory $ABCDETEMPDIR already exists and is not writeable." >&2
1998                         echo "Please investigate, remove it, and rerun abcde." >&2
1999                         exit 1
2000                 fi
2001                 echo .
2002                 # See if it's populated
2003                 if [ ! -f "$ABCDETEMPDIR/discid" ]; then
2004                         # Wipe and start fresh
2005                         echo "abcde: $ABCDETEMPDIR/discid not found. Abcde must remove and recreate" >&2
2006                         echo -n "this directory to continue. Continue [y/N]? " >&2
2007                         if [ "$INTERACTIVE" = "y" ]; then
2008                                 read ANSWER
2009                         else
2010                                 echo y >&2
2011                                 ANSWER=y
2012                         fi
2013                         if [ "$ANSWER" != "y" ]; then
2014                                 exit 1
2015                         fi
2016                         rm -rf "$ABCDETEMPDIR" || exit 1
2017                         mkdir -p "$ABCDETEMPDIR"
2018                         if [ "$?" -gt "0" ]; then
2019                                 # Directory already exists or could not be created
2020                                 echo "abcde: Temp directory $ABCDETEMPDIR could not be created." >&2
2021                                 exit 1
2022                         fi
2023                 else
2024                         # Everything is fine. Check for ^encodetracklocation-
2025                         # and encode-output entries in the status file and
2026                         # remove them. These are not relevant across sessions.
2027                         if [ -f "$ABCDETEMPDIR/status" ]; then
2028                                 mv "$ABCDETEMPDIR/status" "$ABCDETEMPDIR/status.old"
2029                                 grep -v ^encodetracklocation- < "$ABCDETEMPDIR/status.old" \
2030                                         | grep -v ^encode-output > "$ABCDETEMPDIR/status"
2031                         fi
2032                         # Remove old error messages
2033                         if [ -f "$ABCDETEMPDIR/errors" ]; then
2034                                 rm -f "$ABCDETEMPDIR/errors"
2035                         fi
2036                 fi
2037         else
2038                 # We are starting from scratch
2039                 mkdir -p "$ABCDETEMPDIR"
2040                 if [ "$?" -gt "0" ]; then
2041                         # Directory already exists or could not be created
2042                         echo "abcde: Temp directory $ABCDETEMPDIR could not be created." >&2
2043                         exit 1
2044                 fi
2045                 cat /dev/null > "$ABCDETEMPDIR/status"
2046                 # Store the abcde version in the status file.
2047                 echo "abcde-version=$VERSION" >> "$ABCDETEMPDIR/status"
2048         fi
2049         if [ X"$DOCUE" = "Xy" -a X"$WEHAVEACD" = "Xy" ]; then
2050                 if checkstatus cuefile > /dev/null 2>&1 ; then :; else
2051                         CUEFILE=cue-$(echo "$TRACKINFO" | cut -f1 -d' ').txt
2052                         vecho "Creating cue file..."
2053                         case $CDROMREADERSYNTAX in
2054                                 flac)
2055                                         if $METAFLAC --export-cuesheet-to=- "$CDROM" > "$ABCDETEMPDIR/$CUEFILE"; then
2056                                                 echo cuefile=$CUEFILE >> "$ABCDETEMPDIR/status"
2057                                         else
2058                                                 log warning "the input flac file does not contain a cuesheet."
2059                                         fi
2060                                         ;;
2061                                 *)
2062                                         if $CUEREADER $CUEREADEROPTS > "$ABCDETEMPDIR/$CUEFILE"; then
2063                                                 echo cuefile=$CUEFILE >> "$ABCDETEMPDIR/status"
2064                                         else
2065                                                 log warning "reading the CUE sheet is still considered experimental"
2066                                                 log warning "and there was a problem with the CD reading. abcde will continue,"
2067                                                 log warning "but consider reporting the problem to the abcde author"
2068                                         fi
2069                                         ;;
2070                         esac
2071                 fi
2072         fi
2073         # If we got the CDPARANOIA status and it is not recorded, save it now
2074         if [ -n "$CDPARANOIAAUDIOTRACKS" ]; then
2075                 if checkstatus cdparanoia-audio-tracks > /dev/null 2>&1; then :; else
2076                         echo cdparanoia-audio-tracks=$CDPARANOIAAUDIOTRACKS >> "$ABCDETEMPDIR/status"
2077                 fi
2078         fi
2079
2080         # Create the discid file
2081         echo "$TRACKINFO" > "$ABCDETEMPDIR/discid"
2082         if checkstatus cddbmethod > /dev/null 2>&1 ; then :; else
2083                 echo "cddbmethod=$CDDBMETHOD" >> "$ABCDETEMPDIR/status"
2084         fi
2085 }
2086
2087 # do_cleancue
2088 # Create a proper CUE file based on the CUE file we created before.
2089 do_cleancue()
2090 {
2091         if CUEFILE_IN="$ABCDETEMPDIR"/$(checkstatus cuefile); then
2092                 CUEFILE_OUT=$CUEFILE_IN.out
2093                 ### FIXME ### checkstatus cddb
2094                 if [ -e "$CDDBDATA" ]; then
2095                         vecho "Adding metadata to the cue file..."
2096                         # FIXME It doesn't preserve spaces! Why?
2097                         # FIXME parse $track into PERFORMER and TITLE - abcde already has code for this?
2098                         n=1
2099                         echo "PERFORMER \"$DARTIST\"" >> "$CUEFILE_OUT"
2100                         echo "TITLE \"$DALBUM\"" >> "$CUEFILE_OUT"
2101                         # Set IFS to <newline> to prevent read from swallowing spaces and tabs
2102                         OIFS="$IFS"
2103                         IFS='
2104 '
2105                         cat "$CUEFILE_IN" | while read line
2106                         do
2107                                 if echo "$line" | grep "INDEX 01" > /dev/null 2>&1 ; then
2108 # FIXME # Possible patch: remove the line above, uncomment the 2 lines below.
2109 #                               echo "$line" >> "$CUEFILE_OUT"
2110 #                               if echo "$line" | grep "^[[:space:]]*TRACK" > /dev/null 2>&1 ; then
2111                                         eval track="\$TRACK$n"
2112                                         n=$(expr $n + 1)
2113                                         echo "    TITLE \"$track\"" >> "$CUEFILE_OUT"
2114                                 # When making a single-track rip, put the
2115                                 # actual file name into the file declaration
2116                                 # in the cue file so that it is usable by
2117                                 # music players and the like
2118                                 elif [ "$ONETRACK" = "y" ] &&
2119                                                 echo "$line" | grep '^FILE "dummy.wav" WAVE' > /dev/null 2>&1 ; then
2120
2121                                         TRACKFILE="$(mungefilename "$TRACKNAME")"
2122                                         ARTISTFILE="$(mungefilename "$TRACKARTIST")"
2123                                         ALBUMFILE="$(mungefilename "$DALBUM")"
2124
2125                                         if [ "$VARIOUSARTISTS" = "y" ]; then
2126                                                 OUTPUTFILE="$(eval echo \""$VAONETRACKOUTPUTFORMAT"\" | sed -e 's@^.*/@@').$OUTPUT"
2127                                         else
2128                                                 OUTPUTFILE="$(eval echo \""$ONETRACKOUTPUTFORMAT"\" | sed -e 's@^.*/@@').$OUTPUT"
2129                                         fi
2130
2131                                         echo "FILE \"$OUTPUTFILE\" WAVE" >> "$CUEFILE_OUT"
2132                                         continue
2133                                 fi
2134 # FIXME # If the lines above are uncommented, remove the line below.
2135                                 echo "$line" >> "$CUEFILE_OUT"
2136                         done
2137                         IFS="$OIFS"
2138                         mv "$CUEFILE_OUT" "$CUEFILE_IN"
2139                         echo "cleancuefile" >> "$ABCDETEMPDIR/status"
2140                 fi
2141         fi
2142 }
2143
2144 # do_cddbparse
2145 # Parses a CDDB file and outputs the title and the track names.
2146 # Variables: CDDBFILE
2147 do_cddbparse ()
2148 {
2149         CDDBPARSEFILE="$1"
2150         # List out disc title/author and contents
2151         if [ "$ONETRACK" = "y" ]; then
2152                 vecho "ONETRACK mode selected: displaying only the title of the CD..."
2153         fi
2154         echo "---- $(grep DTITLE "${CDDBPARSEFILE}" | cut '-d=' -f2- | tr -d \\r\\n ) ----"
2155         if [ X"$SHOWCDDBYEAR" = "Xy" ]; then
2156                 PARSEDYEAR=$(grep DYEAR "${CDDBPARSEFILE}" | cut '-d=' -f2-)
2157                 if [ ! X"$PARSEDYEAR" = "X" ]; then
2158                         echo "Year: $PARSEDYEAR"
2159                 fi
2160         fi
2161         if [ X"$SHOWCDDBGENRE" = "Xy" ]; then
2162                 PARSEDGENRE=$(grep DGENRE "${CDDBPARSEFILE}" | cut '-d=' -f2-)
2163                 if [ ! X"$PARSEDGENRE" = "X" ]; then
2164                         echo "Genre: $PARSEDGENRE"
2165                 fi
2166         fi
2167         if [ ! "$ONETRACK" = "y" ]; then
2168                 for TRACK in $(f_seq_row 1 $TRACKS)
2169                 do
2170                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "${CDDBPARSEFILE}" | cut -f2- -d= | tr -d \\r\\n)"
2171                 done
2172         fi
2173 }
2174
2175 # do_localcddb
2176 # Check for a local CDDB file, and report success
2177 do_localcddb ()
2178 {
2179         if checkstatus cddb-readcomplete && checkstatus cddb-choice >/dev/null; then :; else
2180
2181                 CDDBLOCALSTATUS="notfound"
2182                 CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
2183                 USELOCALRESP="y"
2184
2185                 if [ "$CDDBLOCALRECURSIVE" = "y" ]; then
2186                         CDDBLOCALRESULTS="$(find ${CDDBLOCALDIR} -name "${CDDBDISCID}" -type f 2> /dev/null)"
2187                         if [ ! "${CDDBLOCALRESULTS}" = "" ]; then
2188                                 if   (( $(echo "${CDDBLOCALRESULTS}" | wc -l) == 1 )); then
2189                                         CDDBLOCALFILE="${CDDBLOCALRESULTS}"
2190                                         CDDBLOCALMATCH=single
2191                                 elif (( $(echo "${CDDBLOCALRESULTS}" | wc -l) > 1 )); then
2192                                         CDDBLOCALMATCH=multiple
2193                                 fi
2194                         else
2195                                 CDDBLOCALMATCH=none
2196                         fi
2197                 elif [ "$CDDBLOCALMATCH" = "none" ] && [ -r "${CDDBLOCALDIR}/${CDDBDISCID}" ]; then
2198                         CDDBLOCALFILE="${CDDBLOCALDIR}/${CDDBDISCID}"
2199                         CDDBLOCALMATCH=single
2200                 else
2201                         CDDBLOCALMATCH=none
2202                 fi
2203
2204                 # If the user has selected to check a local CDDB repo, we proceed with it
2205                 case $CDDBLOCALMATCH in
2206                         multiple)
2207                                 echo "Processing multiple matching CDDB entries..." > "$ABCDETEMPDIR/cddblocalchoices"
2208                                 X=0
2209                                 echo "$CDDBLOCALRESULTS" | while read RESULT ; do
2210                                         X=$(expr $X + 1)
2211                                         # List out disc title/author and contents
2212                                         CDDBLOCALREAD="$ABCDETEMPDIR/cddblocalread.$X"
2213                                         cat "$RESULT" > "${CDDBLOCALREAD}"
2214                                         {
2215                                                 echo -n "#$X: "
2216                                                 do_cddbparse "${CDDBLOCALREAD}"
2217                                                 echo ""
2218                                                 ##FIXME## QUICK HACK !!!!
2219                                                 if [ ! "$INTERACTIVE" = "y" ]; then break ; fi
2220                                         } >> "$ABCDETEMPDIR/cddblocalchoices"
2221                                 done
2222                                 if [ $(cat "$ABCDETEMPDIR/cddblocalchoices" | wc -l) -ge 24 ] && [ "$INTERACTIVE" = "y" ]; then
2223                                         page "$ABCDETEMPDIR/cddblocalchoices"
2224                                 else
2225                                         # It's all going to fit in one page, cat it
2226                                         cat "$ABCDETEMPDIR/cddblocalchoices" >&2
2227                                 fi
2228                                 CDDBLOCALCHOICES=$( echo "$CDDBLOCALRESULTS" | wc -l )
2229                                 # Setting the choice to an impossible integer to avoid errors in the numeric comparisons
2230                                 CDDBLOCALCHOICENUM=-1
2231                                 if [ "$INTERACTIVE" = "y" ]; then
2232                                         while [ $CDDBLOCALCHOICENUM -lt 0 ] || [ $CDDBLOCALCHOICENUM -gt $CDDBLOCALCHOICES ]; do
2233                                                 echo -n "Locally cached CDDB entries found. Which one would you like to use (0 for none)? [0-$CDDBLOCALCHOICES]: " >&2
2234                                                 read CDDBLOCALCHOICE
2235                                                 [ x"$CDDBLOCALCHOICE" = "x" ] && CDDBLOCALCHOICE="1"
2236                                                 # FIXME # Introduce diff's
2237                                                 if echo $CDDBLOCALCHOICE | grep -E "[[:space:]]*[[:digit:]]+,[[:digit:]]+[[:space:]]*" > /dev/null 2>&1 ; then
2238                                                         diffentries cddblocalread "$CDDBLOCALCHOICES" "$CDDBLOCALCHOICE"
2239                                                 elif echo $CDDBLOCALCHOICE | grep -E "[[:space:]]*[[:digit:]]+[[:space:]]*" > /dev/null 2>&1 ; then
2240                                                         # Make sure we get a valid choice
2241                                                         CDDBLOCALCHOICENUM=$(echo $CDDBLOCALCHOICE | xargs printf %d 2>/dev/null)
2242                                                         if [ $CDDBLOCALCHOICENUM -lt 0 ] || [ $CDDBLOCALCHOICENUM -gt $CDDBLOCALCHOICES ]; then
2243                                                                 echo "Invalid selection. Please choose a number between 0 and $CDDBLOCALCHOICES." >&2
2244                                                         fi
2245                                                 fi
2246                                         done
2247                                 else
2248                                         ### FIXME ###
2249                                         #echo "Selected ..."
2250                                         CDDBLOCALRESP=y
2251                                         CDDBLOCALCHOICENUM=1
2252                                 fi
2253                                 if [ ! "$CDDBLOCALCHOICENUM" = "0" ]; then
2254                                         #echo "Using local copy of CDDB data"
2255                                         echo "# DO NOT ERASE THIS LINE! Added by abcde to imitate cddb output" > "$ABCDETEMPDIR/cddbread.1"
2256                                         cat "$ABCDETEMPDIR/cddblocalread.$CDDBLOCALCHOICENUM" >> "$ABCDETEMPDIR/cddbread.1"
2257                                         echo 999 > "$ABCDETEMPDIR/cddbquery" # Assuming 999 isn't used by CDDB
2258                                         echo cddb-readcomplete >> "$ABCDETEMPDIR/status"
2259                                         do_cddbparse "$ABCDETEMPDIR/cddbread.1" > "$ABCDETEMPDIR/cddbchoices"
2260                                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2261                                         CDDBLOCALSTATUS="found"
2262                                 else
2263                                         #echo "Not using local copy of CDDB data"
2264                                         CDDBLOCALSTATUS="notfound"
2265                                 fi
2266                                 ;;
2267                         single)
2268                                 # List out disc title/author and contents
2269                                 do_cddbparse "${CDDBLOCALFILE}"
2270                                 #if [ "$CDROMREADERSYNTAX" = "flac" ] ; then
2271                                 #       echo -n "Embedded cuesheet entry found, use it [Y/n]? " >&2
2272                                 #else
2273                                         echo -n "Locally cached CDDB entry found, use it [Y/n]? " >&2
2274                                 #fi
2275                                 if [ "$INTERACTIVE" = "y" ]; then
2276                                         read USELOCALRESP
2277                                         while [ "$USELOCALRESP" != "y" ] && [ "$USELOCALRESP" != "n" ] && [ "$USELOCALRESP" != "" ] ; do
2278                                                 echo -n 'Invalid selection. Please answer "y" or "n": ' >&2
2279                                                 read USELOCALRESP
2280                                         done
2281                                         [ x"$USELOCALRESP" = "x" ] && USELOCALRESP="y"
2282                                 else
2283                                         echo "y" >&2
2284                                 fi
2285                                 if [ "$USELOCALRESP" = "y" ]; then
2286                                         #echo "Using local copy of CDDB data"
2287                                         echo "# DO NOT ERASE THIS LINE! Added by abcde to imitate cddb output" > "$ABCDETEMPDIR/cddbread.1"
2288                                         cat "${CDDBLOCALFILE}" >> "$ABCDETEMPDIR/cddbread.1"
2289                                         echo 999 > "$ABCDETEMPDIR/cddbquery" # Assuming 999 isn't used by CDDB
2290                                         echo cddb-readcomplete >> "$ABCDETEMPDIR/status"
2291                                         do_cddbparse "${CDDBLOCALFILE}" > "$ABCDETEMPDIR/cddbchoices"
2292                                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2293                                         CDDBLOCALSTATUS="single"
2294                                 else
2295                                         #echo "Not using local copy of CDDB data"
2296                                         CDDBLOCALSTATUS="notfound"
2297                                 fi
2298                                 ;;
2299                         none)
2300                                 CDDBLOCALSTATUS="notfound"
2301                                 ;;
2302                 esac
2303         fi
2304 }
2305
2306 # do_cdtext
2307 # Try to read CD-Text from the drive using icedax / cdda2wav
2308 do_cdtext ()
2309 {
2310         if new_checkexec icedax; then
2311                 CDTEXT_READER=icedax
2312         elif new_checkexec cdda2wav; then
2313                 CDTEXT_READER=cdda2wav
2314     else
2315                 # Didn't find either, bail
2316                 return 0
2317         fi
2318
2319         if [ "$OSFLAVOUR" = "OSX" ] ; then
2320                 # Hei, we have to unmount the device before running anything like cdda2wav/icedax in OSX
2321                 diskutil unmount ${CDROM#/dev/}
2322                 # Also, in OSX the cdrom device for cdda2wav/icedax changes...
2323                 CDDA2WAVCDROM="IODVDServices"
2324         elif [ "$OSFLAVOUR" = "FBSD" ] ; then
2325                 CDDA2WAVCDROM="$CDROMID"
2326         else
2327                 if [ "$CDROMID" = "" ]; then
2328                         CDDA2WAVCDROM="$CDROM"
2329                 else
2330                         CDDA2WAVCDROM="$CDROMID"
2331                 fi
2332         fi
2333
2334         # Do we have CD-Text on the disc (and can the drive read it?)
2335         ${CDTEXT_READER} -J -N -D ${CDDA2WAVCDROM} > "$ABCDETEMPDIR/cd-text" 2>&1
2336         grep -q '^CD-Text: detected' "$ABCDETEMPDIR/cd-text"
2337         ERRORCODE=$?
2338         if [ $ERRORCODE -ne 0 ]; then
2339                 # No CD-Text found, bail
2340                 return 0
2341         fi
2342
2343         rm -f "$ABCDETEMPDIR/cddbchoices"
2344         CDDBCHOICES=1
2345         # Make an empty template
2346         $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.1"
2347         echo -n "Retrieved 1 CD-Text match..." >> "$ABCDETEMPDIR/cddbchoices"
2348         echo "done." >> "$ABCDETEMPDIR/cddbchoices"
2349         echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
2350         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2351         ATITLE=$(grep -e '^Album title:' "${ABCDETEMPDIR}/cd-text" | cut -c14- )
2352         echo "200 none ${ATITLE}" >> "$ABCDETEMPDIR/cddbquery"
2353         # List out disc title/author and contents
2354         echo ---- ${ATITLE} ---- >> "$ABCDETEMPDIR/cddbchoices"
2355         for TRACK in $(f_seq_row 1 $TRACKS)
2356         do
2357                 TRACKM1=$(($TRACK - 1))
2358                 TITLE="$(grep -E ^Track\ +$TRACK: "$ABCDETEMPDIR/cd-text" | tr -d \\r\\n | sed 's~^Track ..: .~~g;'"s~'$~~g")"
2359                 echo "$TRACK: $TITLE" >> "$ABCDETEMPDIR/cddbchoices"
2360                 sed "s~^TTITLE${TRACKM1}=.*~TTITLE${TRACKM1}=${TITLE}~" "$ABCDETEMPDIR/cddbread.1" > "$ABCDETEMPDIR/cddbread.new"
2361         mv -f "$ABCDETEMPDIR/cddbread.new" "$ABCDETEMPDIR/cddbread.1"
2362         done
2363         sed "s~^DTITLE=.*~DTITLE=${ATITLE}~" "$ABCDETEMPDIR/cddbread.1" > "$ABCDETEMPDIR/cddbread.new"
2364     mv -f "$ABCDETEMPDIR/cddbread.new" "$ABCDETEMPDIR/cddbread.1"
2365         echo >> "$ABCDETEMPDIR/cddbchoices"
2366         echo "cdtext-readcomplete" >> "$ABCDETEMPDIR/status"
2367 }
2368
2369 # do_musicbrainz
2370 # Work with the musicbrainz WS API, then transform the results here so
2371 # they look (very) like the results from CDDB. Maybe not the best way
2372 # to go, but it Works For Me (TM)
2373
2374 do_musicbrainz ()
2375 {
2376         if checkstatus musicbrainz-readcomplete; then :; else
2377                 vecho "Obtaining Musicbrainz results..."
2378                 # If MB is to be used, interpret the query results and read all
2379                 # the available entries.
2380                 rm -f "$ABCDETEMPDIR/cddbchoices"
2381                 CDDBCHOICES=1 # Overridden by multiple matches
2382                 MBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
2383                 ${MUSICBRAINZ} --command data --discid "$MBDISCID" --workdir "$ABCDETEMPDIR"
2384
2385                 # The helper script will write disc matches out to
2386                 # cddbread.*. Count how many we have
2387                 if [ ! -f "${ABCDETEMPDIR}/cddbread.1" ] ; then
2388                         # No matches. Use the normal cddb template for the user to
2389                         # fill in
2390                         echo "No Musicbrainz match." >> "$ABCDETEMPDIR/cddbchoices"
2391                         $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
2392                         # List out disc title/author and contents of template
2393                         echo ---- Unknown Artist / Unknown Album ---- >> "$ABCDETEMPDIR/cddbchoices"
2394                         UNKNOWNDISK=y
2395                         for TRACK in $(f_seq_row 1 $TRACKS)
2396                         do
2397                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.0" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2398                         done
2399                         echo >> "$ABCDETEMPDIR/cddbchoices"
2400                         echo cddb-read-0-complete >> "$ABCDETEMPDIR/status"
2401                         echo cddb-choice=0 >> "$ABCDETEMPDIR/status"
2402                         echo 503 > "$ABCDETEMPDIR/cddbquery"
2403                 else
2404                         # We have some matches
2405                         NUM_RESPONSES=$(echo "${ABCDETEMPDIR}"/cddbread.* | wc -w)
2406                         if [ "$NUM_RESPONSES" -eq 1 ] ; then
2407                                 # One exact match
2408                                 echo -n "Retrieved 1 Musicbrainz match..." >> "$ABCDETEMPDIR/cddbchoices"
2409                                 echo "done." >> "$ABCDETEMPDIR/cddbchoices"
2410                                 echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
2411                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2412                                 ATITLE=$(grep -e '^DTITLE=' "${ABCDETEMPDIR}/cddbread.1" | cut -c8- )
2413                                 echo "200 none ${ATITLE}" >> "$ABCDETEMPDIR/cddbquery"
2414                                 # List out disc title/author and contents
2415                                 echo ---- ${ATITLE} ---- >> "$ABCDETEMPDIR/cddbchoices"
2416                                 for TRACK in $(f_seq_row 1 $TRACKS)
2417                                 do
2418                                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2419                                 done
2420                                 echo >> "$ABCDETEMPDIR/cddbchoices"
2421                         else
2422                                 echo "210 Found exact matches, list follows (until terminating .)" > "$ABCDETEMPDIR/cddbquery"
2423                                 echo "Multiple Musicbrainz matches:" >> "$ABCDETEMPDIR/cddbchoices"
2424                                 for file in "$ABCDETEMPDIR"/cddbread.*
2425                                 do
2426                                         X=$(echo $file | sed 's/^.*cddbread\.//g')
2427                                         echo cddb-read-$X-complete >> "$ABCDETEMPDIR/status"
2428                                         ATITLE=$(grep -e '^DTITLE=' "${ABCDETEMPDIR}"/cddbread.$X | cut -c8- )
2429                                         echo "none ${ATITLE}" >> "$ABCDETEMPDIR/cddbquery"
2430                                         # List out disc title/author and contents
2431                                         echo "#$X: ---- ${ATITLE} ----" >> "$ABCDETEMPDIR/cddbchoices"
2432                                         for TRACK in $(f_seq_row 1 $TRACKS)
2433                                         do
2434                                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.$X" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2435                                         done
2436                                         echo >> "$ABCDETEMPDIR/cddbchoices"
2437                                 done
2438                                 echo "." >> "$ABCDETEMPDIR/cddbquery"
2439                         fi
2440                 fi
2441                 echo "musicbrainz-readcomplete" >> "$ABCDETEMPDIR/status"
2442         fi
2443 }
2444
2445 # do_cddbstat
2446 do_cddbstat ()
2447 {
2448         # Perform CDDB protocol version check if it hasn't already been done
2449         if checkstatus cddb-statcomplete; then :; else
2450                 if [ "$CDDBAVAIL" = "n" ]; then
2451                         ERRORCODE=no_query
2452                         echo 503 > "$ABCDETEMPDIR/cddbstat"
2453                 else
2454                         rc=1
2455                         CDDBUSER=$(echo $HELLOINFO | cut -f1 -d'@')
2456                         CDDBHOST=$(echo $HELLOINFO | cut -f2- -d'@')
2457                         while test $rc -eq 1 -a $CDDBPROTO -ge 3; do
2458                                 vecho "Checking CDDB server status..."
2459                                 $CDDBTOOL stat $CDDBURL $CDDBUSER $CDDBHOST $CDDBPROTO > "$ABCDETEMPDIR/cddbstat"
2460                                 RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbstat" | cut -f1 -d' ')
2461                                 case "$RESPONSECODE" in
2462                                 210)    # 210 OK, status information follows (until terminating `.')
2463                                         rc=0
2464                                         ;;
2465                                 501)  # 501 Illegal CDDB protocol level: <n>.
2466                                         CDDBPROTO=`expr $CDDBPROTO - 1`
2467                                         ;;
2468                                 *)      # Try a cddb query, since freedb2.org doesn't support the stat or ver commands
2469                                         # FreeDB TESTCD disc-id is used for query
2470                                         $CDDBTOOL query $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST 03015501 1 296 344 > "$ABCDETEMPDIR/cddbstat"
2471                                         RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbstat" | cut -f1 -d' ')
2472                                         case "$RESPONSECODE" in
2473                                                 2??)    # Server responded, everything seems OK
2474                                                         rc=0
2475                                                         ;;
2476                                                 *)      # unknown error
2477                                                         break
2478                                                         ;;
2479                                         esac
2480                                         ;;
2481                                 esac
2482                         done
2483                         if test $rc -eq 1; then
2484                                 CDDBAVAIL="n"
2485                         fi
2486                 fi
2487                 echo cddb-statcomplete >> "$ABCDETEMPDIR/status"
2488         fi
2489 }
2490
2491
2492 # do_cddbquery
2493 do_cddbquery ()
2494 {
2495         CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
2496         CDDBLOCALFILE="${CDDBLOCALDIR}/${CDDBDISCID}"
2497
2498         # Perform CDDB query if it hasn't already been done
2499         if checkstatus cddb-querycomplete; then :; else
2500                 if [ "$CDDBAVAIL" = "n" ]; then
2501                         ERRORCODE=no_query
2502                         echo 503 > "$ABCDETEMPDIR/cddbquery"
2503                 # The default CDDBLOCALSTATUS is "notfound"
2504                 # This part will be triggered if the user CDDB repo does not
2505                 # contain the entry, or if we are not trying to use the repo.
2506                 else
2507                         vecho "Querying the CDDB server..."
2508                         CDDBUSER=$(echo $HELLOINFO | cut -f1 -d'@')
2509                         CDDBHOST=$(echo $HELLOINFO | cut -f2- -d'@')
2510                         $CDDBTOOL query $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $TRACKINFO > "$ABCDETEMPDIR/cddbquery"
2511                         ERRORCODE=$?
2512                         case $ERRORCODE in
2513                                 0)  # success
2514                                 ;;
2515                                 12|13|14)
2516                                         # no match found in database,
2517                                         # wget/fetch error, or user requested not to use CDDB
2518                                         # Make up an error code (503) that abcde
2519                                         # will recognize in do_cddbread
2520                                         # and compensate by making a template
2521                                         echo 503 > "$ABCDETEMPDIR/cddbquery"
2522                                 ;;
2523                                 *) # strange and unknown error
2524                                         echo ERRORCODE=$ERRORCODE
2525                                         echo "abcde: $CDDBTOOL returned unknown error code"
2526                                 ;;
2527                         esac
2528                 fi
2529                 echo cddb-querycomplete >> "$ABCDETEMPDIR/status"
2530         fi
2531 }
2532
2533 # do_cddbread
2534 do_cddbread ()
2535 {
2536         # If it's not to be used, generate a template.
2537         # Then, display it (or them) and let the user choose/edit it
2538         if checkstatus cddb-readcomplete; then :; else
2539                 vecho "Obtaining CDDB results..."
2540                 # If CDDB is to be used, interpret the query results and read all
2541                 # the available entries.
2542                 rm -f "$ABCDETEMPDIR/cddbchoices"
2543                 CDDBCHOICES=1 # Overridden by multiple matches
2544                 RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbquery" | cut -f1 -d' ')
2545                 case "$RESPONSECODE" in
2546                 200)
2547                         # One exact match, retrieve it
2548                         # 200 [section] [discid] [artist] / [title]
2549                         if checkstatus cddb-read-1-complete; then :; else
2550                                 echo -n "Retrieving 1 CDDB match..." >> "$ABCDETEMPDIR/cddbchoices"
2551                                 $CDDBTOOL read $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $(cut -f2,3 -d' ' "$ABCDETEMPDIR/cddbquery") > "$ABCDETEMPDIR/cddbread.1"
2552                                 echo "done." >> "$ABCDETEMPDIR/cddbchoices"
2553                                 echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
2554                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2555                         fi
2556                         # List out disc title/author and contents
2557                         echo ---- "$(cut '-d ' -f4- "$ABCDETEMPDIR/cddbquery")" ---- >> "$ABCDETEMPDIR/cddbchoices"
2558                         for TRACK in $(f_seq_row 1 $TRACKS)
2559                         do
2560                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2561                         done
2562                         echo >> "$ABCDETEMPDIR/cddbchoices"
2563                         ;;
2564                 202|403|409|503)
2565                         # No match
2566                         case "$RESPONSECODE" in
2567                         202) echo "No CDDB match." >> "$ABCDETEMPDIR/cddbchoices" ;;
2568                         403|409) echo "CDDB entry is corrupt, or the handshake failed." >> "$ABCDETEMPDIR/cddbchoices" ;;
2569                         503) echo "CDDB unavailable." >> "$ABCDETEMPDIR/cddbchoices" ;;
2570                         esac
2571                         $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
2572                         # List out disc title/author and contents of template
2573                         echo ---- Unknown Artist / Unknown Album ---- >> "$ABCDETEMPDIR/cddbchoices"
2574                         UNKNOWNDISK=y
2575                         for TRACK in $(f_seq_row 1 $TRACKS)
2576                         do
2577                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.0" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2578                         done
2579                         echo >> "$ABCDETEMPDIR/cddbchoices"
2580                         echo cddb-read-0-complete >> "$ABCDETEMPDIR/status"
2581                         echo cddb-choice=0 >> "$ABCDETEMPDIR/status"
2582                         ;;
2583                 210|211)
2584                         # Multiple exact, (possibly multiple) inexact matches
2585                         IN=
2586                         if [ "$RESPONSECODE" = "211" ]; then IN=in; fi
2587                         if [ "$(wc -l < "$ABCDETEMPDIR/cddbquery" | tr -d ' ')" -eq 3 ]; then
2588                                 echo "One ${IN}exact match:" >> "$ABCDETEMPDIR/cddbchoices"
2589                                 tail -n +2 "$ABCDETEMPDIR/cddbquery" | head -n 1 >> "$ABCDETEMPDIR/cddbchoices"
2590                                                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2591                         else
2592                                 echo "Multiple ${IN}exact matches:" >> "$ABCDETEMPDIR/cddbchoices"
2593                         fi
2594                         vecho -n "Retrieving multiple matches... "
2595                         grep -v ^[.]$ "$ABCDETEMPDIR/cddbquery" | ( X=0
2596                         read DISCINFO # eat top line
2597                         while read DISCINFO
2598                         do
2599                                 X=$(expr $X + 1)
2600                                 if checkstatus cddb-read-$X-complete; then :; else
2601                                         $CDDBTOOL read $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $(echo $DISCINFO | cut -f1,2 -d' ') > "$ABCDETEMPDIR/cddbread.$X"
2602                                         echo cddb-read-$X-complete >> "$ABCDETEMPDIR/status"
2603                                 fi
2604                                 # List out disc title/author and contents
2605                                 echo \#$X: ---- "$DISCINFO" ---- >> "$ABCDETEMPDIR/cddbchoices"
2606                                 for TRACK in $(f_seq_row 1 $TRACKS)
2607                                 do
2608                                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.$X" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2609                                 done
2610                                 echo >> "$ABCDETEMPDIR/cddbchoices"
2611                         done )
2612                         vecho "done."
2613                         CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
2614                         ;;
2615                 999)
2616                         # Using local copy.
2617                         for TRACK in $(f_seq_row 1 $TRACKS)
2618                         do
2619                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2620                         done
2621                         echo >> "$ABCDETEMPDIR/cddbchoices"
2622                         echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
2623                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2624                         ;;
2625                 esac
2626                 echo "cddb-readcomplete" >> "$ABCDETEMPDIR/status"
2627         fi
2628 }
2629
2630 # do_cddbedit
2631 do_cddbedit ()
2632 {
2633         if checkstatus cddb-edit >/dev/null; then
2634                 CDDBDATA="$ABCDETEMPDIR/cddbread.$(checkstatus cddb-choice)"
2635                 VARIOUSARTISTS="$(checkstatus variousartists)"
2636                 VARIOUSARTISTSTYLE="$(checkstatus variousartiststyle)"
2637                 return 0
2638         fi
2639         if [ "$INTERACTIVE" = "y" ]; then
2640                 # We should show the CDDB results both when we are not using the local CDDB repo
2641                 # or when we are using it but we could not find a proper match
2642                 if [ "$CDDBUSELOCAL" = "y" ] && [ "$CDDBLOCALSTATUS" = "notfound" ] || [ ! "$CDDBUSELOCAL" = "y" ]; then
2643                         # Display the $ABCDETEMPDIR/cddbchoices file created above
2644                         # Pick a pager so that if the tracks overflow the screen the user can still view everything
2645                         if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
2646                                 CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
2647                                 CHOICE=$(checkstatus cddb-choice)
2648                                 if [ -n "$CHOICE" ] ; then
2649                                         case $CDDBCHOICES in
2650                                                 -1) if head -1 "$ABCDETEMPDIR/cddbquery" | grep "^$" > /dev/null 2>&1 ; then
2651                                                                 log error "CDDB query failed!"
2652                                                                 exit 1
2653                                                         else
2654                                                                 cat "$ABCDETEMPDIR/cddbchoices"
2655                                                         fi
2656                                                         ;;
2657                                                 1) cat "$ABCDETEMPDIR/cddbchoices" ;;
2658                                                 *)
2659                                                 echo "Selected: #$CHOICE"
2660                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$CHOICE"
2661                                                 ;;
2662                                         esac
2663                                 else
2664                                         # The user has a choice to make, display the info in a pager if necessary
2665                                         if [ $(cat "$ABCDETEMPDIR/cddbchoices" | wc -l) -ge 24 ]; then
2666                                                 page "$ABCDETEMPDIR/cddbchoices"
2667                                         else
2668                                                 # It's all going to fit in one page, cat it
2669                                                 cat "$ABCDETEMPDIR/cddbchoices" >&2
2670                                         fi
2671
2672                                         CDDBCHOICENUM=""
2673                                         # Setting the choice to an impossible integer to avoid errors in the numeric comparisons
2674                                         CDCHOICENUM=-1
2675                                         # I'll take CDDB read #3 for $400, Alex
2676                                         while [ $CDCHOICENUM -lt 0 ] || [ $CDCHOICENUM -gt $CDDBCHOICES ]; do
2677                                                 echo -n "Which entry would you like abcde to use (0 for none)? [0-$CDDBCHOICES]: " >&2
2678                                                 read CDDBCHOICE
2679                                                 [ X"$CDDBCHOICE" = "X" ] && CDDBCHOICE=1
2680                                                 if echo $CDDBCHOICE | grep -E "[[:space:]]*[[:digit:]]+,[[:digit:]]+[[:space:]]*" > /dev/null 2>&1 ; then
2681                                                         if [ ! X"$DIFF" = "X" ]; then
2682                                                                 PARSECHOICE1=$(echo $CDDBCHOICE | cut -d"," -f1 | xargs printf %d 2>/dev/null)
2683                                                                 PARSECHOICE2=$(echo $CDDBCHOICE | cut -d"," -f2 | xargs printf %d 2>/dev/null)
2684                                                                 if [ $PARSECHOICE1 -lt 1 ] || [ $PARSECHOICE1 -gt $CDDBCHOICES ] || \
2685                                                                    [ $PARSECHOICE2 -lt 1 ] || [ $PARSECHOICE2 -gt $CDDBCHOICES ] || \
2686                                                                    [ $PARSECHOICE1 -eq $PARSECHOICE2 ]; then
2687                                                                         echo "Invalid diff range. Please select two comma-separated numbers between 1 and $CDDBCHOICES" >&2
2688                                                                 else
2689                                                                         # We parse the 2 choices to diff, store them in temporary files and diff them.
2690                                                                         for PARSECHOICE in $(echo $CDDBCHOICE | tr , \ ); do
2691                                                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$PARSECHOICE" > "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE"
2692                                                                         done
2693                                                                         echo "Showing diff between choices $PARSECHOICE1 and $PARSECHOICE2..." > "$ABCDETEMPDIR/cddbread.diff"
2694                                                                         $DIFF $DIFFOPTS "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE1" "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE2" >> "$ABCDETEMPDIR/cddbread.diff"
2695                                                                         if [ $(cat "$ABCDETEMPDIR/cddbread.diff" | wc -l) -ge 24 ]; then
2696                                                                                 page "$ABCDETEMPDIR/cddbread.diff"
2697                                                                         else
2698                                                                                 cat "$ABCDETEMPDIR/cddbread.diff" >&2
2699                                                                         fi
2700                                                                 fi
2701                                                         else
2702                                                                 echo "The diff program was not found in your path. Please choose a number between 0 and $CDDBCHOICES." >&2
2703                                                         fi
2704                                                 elif echo $CDDBCHOICE | grep -E "[[:space:]]*[[:digit:]]+[[:space:]]*" > /dev/null 2>&1 ; then
2705                                                         # Make sure we get a valid choice
2706                                                         CDCHOICENUM=$(echo $CDDBCHOICE | xargs printf %d 2>/dev/null)
2707                                                         if [ $CDCHOICENUM -lt 0 ] || [ $CDCHOICENUM -gt $CDDBCHOICES ]; then
2708                                                                 echo "Invalid selection. Please choose a number between 0 and $CDDBCHOICES." >&2
2709                                                         fi
2710                                                 fi
2711                                         done
2712                                         if [ "$CDCHOICENUM" = "0" ]; then
2713                                                 vecho "Creating empty CDDB template..."
2714                                                 UNKNOWNDISK=y
2715                                                 $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
2716                                         else
2717                                                 echo "Selected: #$CDCHOICENUM ($(grep ^DTITLE= "$ABCDETEMPDIR/cddbread.$CDCHOICENUM" | cut -f2- -d= | tr -d \\r\\n))" >&2
2718                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$CDCHOICENUM"
2719                                         fi
2720                                         echo "cddb-choice=$CDCHOICENUM" >> "$ABCDETEMPDIR/status"
2721                                 fi
2722                         fi
2723                 else
2724                         # We need some code to show the selected option when local repository is selected and we have found a match
2725                         vecho "Using cached CDDB match..." >&2
2726                         # Display the $ABCDETEMPDIR/cddbchoices file created above
2727                         # Pick a pager so that if the tracks overflow the screen the user can still view everything
2728                         if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
2729                                 CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
2730                                 CHOICE=$(checkstatus cddb-choice)
2731                                 if [ "$USELOCALRESP" = "y" ]; then :; else
2732                                         if [ -n "$CHOICE" ] ; then
2733                                                 case $CDDBCHOICES in
2734                                                         0)
2735                                                         UNKNOWNDISK=y
2736                                                         echo "Selected template."
2737                                                         ;;
2738                                                         1) cat "$ABCDETEMPDIR/cddbchoices" ;;
2739                                                         *)
2740                                                         echo "Selected: #$CHOICE"
2741                                                         do_cddbparse "$ABCDETEMPDIR/cddbread.$CHOICE"
2742                                                         ;;
2743                                                 esac
2744                                         fi
2745                                 fi
2746                         fi
2747                 fi
2748         else
2749                 # We're noninteractive - pick the first choice.
2750                 # But in case we run a previous instance and selected a choice, use it.
2751                 if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
2752                         # Show the choice if we are not using the locally stored one
2753                         # or when the local search failed to find a match.
2754                         PREVIOUSCHOICE=$(checkstatus cddb-choice)
2755                         if [ "$CDDBUSELOCAL" = "y" ] && [ "$CDDBLOCALSTATUS" = "notfound" ] || [ ! "$CDDBUSELOCAL" = "y" ]; then
2756                                 #if [ "$PREVIOUSCHOICE" ]; then
2757                                         cat "$ABCDETEMPDIR/cddbchoices"
2758                                 #fi
2759                         fi
2760                         if [ ! -z "$PREVIOUSCHOICE" ] ; then
2761                                 CDCHOICENUM=$PREVIOUSCHOICE
2762                         else
2763                                 CDCHOICENUM=1
2764                                 echo "cddb-choice=$CDCHOICENUM" >> "$ABCDETEMPDIR/status"
2765                         fi
2766                         echo "Selected: #$CDCHOICENUM ($(grep ^DTITLE= "$ABCDETEMPDIR/cddbread.$CDCHOICENUM" | cut -f2- -d= | tr -d \\r\\n))" >&2
2767                 fi
2768         fi
2769
2770         # sanity check
2771         if checkstatus cddb-choice >/dev/null; then :; else
2772                 echo "abcde: internal error: cddb-choice not recorded." >&2
2773                 exit 1
2774         fi
2775         CDDBDATA="$ABCDETEMPDIR/cddbread.$(checkstatus cddb-choice)"
2776         echo -n "Edit selected CDDB data " >&2
2777         if [ "$INTERACTIVE" = "y" ]; then
2778                 if [ "$UNKNOWNDISK" = "y" ]; then
2779                         echo -n "[Y/n]? " >&2
2780                         read EDITCDDB
2781                         [ "$EDITCDDB" != "n" ] && EDITCDDB=y
2782                 else
2783                         echo -n "[y/N]? " >&2
2784                         read EDITCDDB
2785                 fi
2786         else
2787                 echo "[y/N]? " >&2
2788                 EDITCDDB=n
2789         fi
2790         if [ "$EDITCDDB" = "y" ]; then
2791                 CDDBDATAMD5SUM=$($MD5SUM "$CDDBDATA" | cut -d " " -f 1);
2792
2793                 # Use the debian sensible-editor wrapper to pick the editor that the
2794                 # user has requested via their $EDITOR environment variable
2795                 if [ -x "/usr/bin/sensible-editor" ]; then
2796                         /usr/bin/sensible-editor "$CDDBDATA"
2797                 elif [ -n "$EDITOR" ]; then
2798                         if [ -x $(which "${EDITOR%%\ *}") ]; then
2799                                 # That failed, try to load the preferred editor, starting
2800                                 # with their EDITOR variable
2801                                 eval $(echo "$EDITOR") \"$CDDBDATA\"
2802                         fi
2803                 # If that fails, check for a vi
2804                 elif which vi >/dev/null 2>&1; then
2805                         vi "$CDDBDATA"
2806                 elif [ -x /usr/bin/vim ]; then
2807                         /usr/bin/vim "$CDDBDATA"
2808                 elif [ -x /usr/bin/vi ]; then
2809                         /usr/bin/vi "$CDDBDATA"
2810                 elif [ -x /bin/vi ]; then
2811                         /bin/vi "$CDDBDATA"
2812                 # nano should be on all (modern, i.e., sarge) debian systems
2813                 elif which nano >/dev/null 2>&1 ; then
2814                         nano "$CDDBDATA"
2815                 elif [ -x /usr/bin/nano ]; then
2816                         /usr/bin/nano "$CDDBDATA"
2817                 # mg should be on all OpenBSD systems
2818                 elif which mg >/dev/null 2>&1 ; then
2819                         mg "$CDDBDATA"
2820                 elif [ -x /usr/bin/mg ]; then
2821                         /usr/bin/mg "$CDDBDATA"
2822                 # bomb out
2823                 else
2824                         log warning "no editor available. Check your EDITOR environment variable."
2825                 fi
2826                 # delete editor backup file if it exists
2827                 if [ -w "$CDDBDATA~" ]; then
2828                         rm -f "$CDDBDATA~"
2829                 fi
2830         fi
2831
2832         # Some heuristics first. Look at Disc Title, and if it starts with
2833         # "Various", then we'll assume Various Artists
2834         if [ "$(grep ^DTITLE= "$CDDBDATA" | cut -f2- -d= | grep -Eci '^(various|soundtrack|varios|sonora|ost)')" != "0" ]; then
2835                 echo "Looks like a Multi-Artist CD" >&2
2836                 VARIOUSARTISTS=y
2837         else
2838                 echo -n "Is the CD multi-artist [y/N]? " >&2
2839                 if [ "$INTERACTIVE" = "y" ]; then
2840                         read VARIOUSARTISTS
2841                 else
2842                         echo n >&2
2843                         VARIOUSARTISTS=n
2844                 fi
2845         fi
2846         if [ "$VARIOUSARTISTS" = "y" ] && [ ! "$ONETRACK" = "y" ]; then
2847                 # Set a default
2848                 DEFAULTSTYLE=1
2849                 # Need NUMTRACKS before cddb-tool will return it:
2850                 NUMTRACKS=$(grep -E '^TTITLE[0-9]+=' "$CDDBDATA" | wc -l)
2851                 if [ "$(grep -c "^TTITLE.*\/" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2852                         # More than 1/2 tracks contain a "/", so guess forward
2853                         DEFAULTSTYLE=1
2854                 elif [ "$(grep -c "^TTITLE.*\-" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2855                         # More than 1/2 contain a "-", so guess forward-dash
2856                         DEFAULTSTYLE=2
2857                 elif [ "$(grep -c "^TTITLE.*(.*)" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2858                         # More than 1/2 contain something in parens, so guess trailing-paren
2859                         DEFAULTSTYLE=6
2860                 fi
2861
2862                 echo "1) Artist / Title" >&2
2863                 echo "2) Artist - Title" >&2
2864                 echo "3) Title / Artist" >&2
2865                 echo "4) Title - Artist" >&2
2866                 echo "5) Artist: Title" >&2
2867                 echo "6) Title (Artist)" >&2
2868                 echo "7) This is a single-artist CD" >&2
2869                 echo -n "Which style of multiple artist entries is it? [1-7] ($DEFAULTSTYLE): " >&2
2870                 if [ "$INTERACTIVE" = "y" ]; then
2871                         read VARIOUSARTISTSTYLE
2872                 else
2873                         echo $DEFAULTSTYLE >&2
2874                         VARIOUSARTISTSTYLE=$DEFAULTSTYLE
2875                 fi
2876                 VARIOUSARTISTSTYLE=$(echo 0$VARIOUSARTISTSTYLE | xargs printf %d)
2877                 # If they press Enter, then the default style (0) was chosen
2878                 while [ $VARIOUSARTISTSTYLE -lt 0 ] || [ $VARIOUSARTISTSTYLE -gt 7 ]; do
2879                         echo "Invalid selection. Please choose a number between 1 and 7."
2880                         echo -n "Selection [1-7]: "
2881                         read VARIOUSARTISTSTYLE
2882                         VARIOUSARTISTSTYLE=$(echo 0$VARIOUSARTISTSTYLE | xargs printf %d)
2883                 done
2884                 if [ "$VARIOUSARTISTSTYLE" = "0" ]; then
2885                         VARIOUSARTISTSTYLE=$DEFAULTSTYLE
2886                 fi
2887                 vecho "Selected: $VARIOUSARTISTSTYLE"
2888                 case "$VARIOUSARTISTSTYLE" in
2889                 1) # Artist / Title
2890                         VARIOUSARTISTSTYLE=forward
2891                         ;;
2892                 2) # Artist - Title
2893                         VARIOUSARTISTSTYLE=forward-dash
2894                         ;;
2895                 3) # Title / Artist
2896                         VARIOUSARTISTSTYLE=reverse
2897                         ;;
2898                 4) # Title - Artist
2899                         VARIOUSARTISTSTYLE=reverse-dash
2900                         ;;
2901                 5) # Artist: Title
2902                         VARIOUSARTISTSTYLE=colon
2903                         ;;
2904                 6) # Title (Artist)
2905                         VARIOUSARTISTSTYLE=trailing-paren
2906                         ;;
2907                 7) # Single Artist
2908                         VARIOUSARTISTS=n
2909                         ;;
2910                 esac
2911         fi
2912
2913         echo "variousartists=$VARIOUSARTISTS" >> "$ABCDETEMPDIR/status"
2914         echo "variousartiststyle=$VARIOUSARTISTSTYLE" >> "$ABCDETEMPDIR/status"
2915
2916         if [ "$EDITCDDB" = "y" ] && [ "$CDDBMETHOD" = "cddb" ] && [ "$UNINTENTIONALLY_ANGER_THE_FREEDB_PEOPLE" = "y" ]; then
2917                 if [ "$CDDBDATAMD5SUM" != "" ]  && [ "$CDDBDATAMD5SUM" != "$($MD5SUM "$CDDBDATA" | cut -d " " -f 1)" ]; then
2918                         # This works but does not have the necessary error checking
2919                         # yet. If you are familiar with the CDDB spec
2920                         # (see http://www.freedb.org/src/latest/DBFORMAT)
2921                         # and can create an error-free entry on your own, then put
2922                         # UNINTENTIONALLY_ANGER_THE_FREEDB_PEOPLE=y in your
2923                         # abcde.conf to enable it. Put CDDBSUBMIT=email@address in
2924                         # your abcde.conf to change the email address submissions are
2925                         # sent to.
2926
2927                         # submit the modified file, if they want
2928                         if [ "$NOSUBMIT" != "y" ]; then
2929                                 echo -n "Do you want to submit this entry to $CDDBSUBMIT [y/N]? "
2930                                 read YESNO
2931                                 while [ "$YESNO" != "y" ] && [ "$YESNO" != "n" ] && [ "$YESNO" != "Y" ] && \
2932                                         [ "$YESNO" != "N" ] && [ "$YESNO" != "" ]
2933                                 do
2934                                         echo -n 'Invalid selection. Please answer "y" or "n": '
2935                                         read YESNO
2936                                 done
2937                                 if [ "$YESNO" = "y" ] || [ "$YESNO" = "Y" ]; then
2938                                         echo -n "Sending..."
2939                                         $CDDBTOOL send "$CDDBDATA" $CDDBSUBMIT
2940                                         echo "done."
2941                                 fi
2942                         fi
2943                 fi
2944         fi
2945         ### FIXME ###
2946         # User CDDBLOCALPOLICY to find out if we store the file or not...
2947         # Cache edited CDDB entry in the user's cddb dir
2948         if [ "$CDDBCOPYLOCAL" = "y" ]; then
2949                 # Make sure the cache directory exists
2950                 mkdir -p $CDDBLOCALDIR
2951                 cat "$CDDBDATA" | tail -n $(expr $(cat "$CDDBDATA" | wc -l ) - 1 ) > ${CDDBLOCALDIR}/$(echo "$TRACKINFO" | cut -d' ' -f1)
2952         fi
2953
2954         echo "cddb-edit" >> "$ABCDETEMPDIR/status"
2955 }
2956
2957 # do_cdread [tracknumber]
2958 # do_cdread onetrack [firsttrack] [lasttrack]
2959 #
2960 do_cdread ()
2961 {
2962         # The commands here don't go through run_command because they're never supposed to be silenced
2963         # return codes need to be doublechecked anyway, however
2964         if [ "$1" = "onetrack" ]; then
2965                 # FIXME # Add the possibility of grabbing ranges of tracks in onetrack
2966                 # FIXME # Until then, we grab the whole CD in one track, no matter what
2967                 # the user said
2968                 # We need the first and last track for cdda2wav/icedax
2969                 FIRSTTRACK=$2
2970                 LASTTRACK=$(expr $3 + 0)
2971                 UTRACKNUM=$FIRSTTRACK
2972                 case "$CDROMREADERSYNTAX" in
2973                         flac) READTRACKNUMS="$FIRSTTRACK.1-$(($LASTTRACK + 1)).0" ;;
2974                         cdparanoia)
2975                                 #XX FIXME XX
2976                                 # Add a variable to check if tracks are provided in command line and if not, use "0-" to rip the tracks
2977                                 READTRACKNUMS="$FIRSTTRACK-$LASTTRACK" ;;
2978                         cdda2wav | icedax) READTRACKNUMS="$FIRSTTRACK+$LASTTRACK" ;;
2979                         pird) READTRACKNUMS="$FIRSTTRACK..$LASTTRACK" ;;
2980                         *) echo "abcde error: $CDROMREADERSYNTAX does not support ONETRACK mode"
2981                                 exit 1 ;;
2982                 esac
2983         else
2984                 UTRACKNUM=$1
2985         fi
2986         CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
2987         if [ "$USEPIPES" = "y" ]; then
2988                 TEMPARG="PIPERIPPER_$CDROMREADERSYNTAX"
2989                 FILEARG="$( eval echo "\$$TEMPARG" )"
2990                 REDIR="y"
2991                 PIPE_MESSAGE="and encoding "
2992         else
2993                 WAVDATA="$ABCDETEMPDIR/track$UTRACKNUM.wav"
2994                 case "$CDROMREADERSYNTAX" in
2995                 ## FIXME ## Find the cases for dagrab and flac, to avoid exceptions
2996                         flac)
2997                                 FILEARG="--output-name=$WAVDATA"
2998                                 ;;
2999                         dagrab)
3000                                 FILEARG="-f $WAVDATA"
3001                                 ;;
3002                         *)
3003                                 FILEARG="$WAVDATA"
3004                                 ;;
3005                 esac
3006                 REDIR="n"
3007         fi
3008         if [ "$1" = "onetrack" ]; then
3009                 echo "Grabbing ${PIPE_MESSAGE}tracks $UTRACKNUM - $LASTTRACK as one track ..." >&2
3010         else
3011                 if [ -r "$CDDBDATA" ]; then
3012                         getcddbinfo TRACKNAME
3013                         echo "Grabbing ${PIPE_MESSAGE}track $UTRACKNUM: $TRACKNAME..." >&2
3014                 else
3015                         echo "Grabbing ${PIPE_MESSAGE}track $UTRACKNUM..." >&2
3016                 fi
3017         fi
3018         case "$CDROMREADERSYNTAX" in
3019                 ### FIXME ### use an exception for flac, since it uses -o
3020                 ### FIXME ### Shall we just use -o $FILEARG ??
3021                 flac)
3022                         # Avoid problems wit math expressions by unpadding the given UTRACKNUM
3023                         STRIPTRACKNUM=$(expr $UTRACKNUM + 0)