Readability: white space fixes
[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,wv,ape). 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 $MPCGAIN "${OUTPUTFILES[@]}"
565                                         ;;
566                                 wv)
567                                         run_command replaygain-wv nice $ENCNICE $WVGAIN $WVGAINOPTS "${OUTPUTFILES[@]}"
568                                         ;;
569                                 *);;
570                         esac
571                 done
572                 if checkerrors "replaygain-.{3,6}"; then :; else
573                         run_command replaygain true
574                 fi
575         fi
576 }
577
578 # This code splits the a Various Artist track name from one of the following
579 # forms:
580 #
581 #  forward:        Artist / Track
582 #  forward-dash:   Artist - Track
583 #  reverse:        Track / Artist
584 #  reverse-dash:   Track - Artist
585 #  colon:          Artist: Track
586 #  trailing-paren: Artist (Track)
587 #
588 # variables used:
589 # VARIOUSARTISTS, VARIOUSARTISTSTYLE, TRACKNAME, TRACKARTIST
590 splitvarious ()
591 {
592         if [ "$VARIOUSARTISTS" = "y" ] && [ ! "$ONETRACK" = "y" ]; then
593                 case "$VARIOUSARTISTSTYLE" in
594                 forward)
595                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's- / -~-g')"
596                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
597                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
598                         ;;
599                 forward-dash)
600                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's, - ,~,g')"
601                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
602                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
603                         ;;
604                 reverse)
605                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's- / -~-g')"
606                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
607                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
608                         ;;
609                 reverse-dash)
610                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's, - ,~,g')"
611                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
612                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
613                         ;;
614                 colon)
615                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's-: -~-g')"
616                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
617                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
618                         ;;
619                 trailing-paren)
620                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's,^\(.*\) (\(.*\)),\1~\2,')"
621                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
622                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
623                         ;;
624                 esac
625         elif [ "$VARIOUSARTISTS" = "y" ] && [ "$ONETRACK" = "y" ]; then
626                 TRACKARTIST="Various"
627         else
628                 TRACKARTIST="$DARTIST"
629         fi
630 }
631
632 do_getgenreid () {
633 local genre=$(echo "${@}" | tr '[A-Z]' '[a-z]')
634 local id=""
635         case ${genre} in
636                 "blues")                 id=0 ;;
637                 "classic rock")          id=1 ;;
638                 "country")               id=2 ;;
639                 "dance")                 id=3 ;;
640                 "disco")                 id=4 ;;
641                 "funk")                  id=5 ;;
642                 "grunge")                id=6 ;;
643                 "hip-hop")               id=7 ;;
644                 "jazz")                  id=8 ;;
645                 "metal")                 id=9 ;;
646                 "new age")               id=10 ;;
647                 "oldies")                id=11 ;;
648                 "other")                 id=12 ;;
649                 "pop")                   id=13 ;;
650                 "r&b")                   id=14 ;;
651                 "rap")                   id=15 ;;
652                 "reggae")                id=16 ;;
653                 "rock")                  id=17 ;;
654                 "techno")                id=18 ;;
655                 "industrial")            id=19 ;;
656                 "alternative")           id=20 ;;
657                 "ska")                   id=21 ;;
658                 "death metal")           id=22 ;;
659                 "pranks")                id=23 ;;
660                 "soundtrack")            id=24 ;;
661                 "euro-techno")           id=25 ;;
662                 "ambient")               id=26 ;;
663                 "trip-hop")              id=27 ;;
664                 "vocal")                 id=28 ;;
665                 "jazz+funk")             id=29 ;;
666                 "fusion")                id=30 ;;
667                 "trance")                id=31 ;;
668                 "classical")             id=32 ;;
669                 "instrumental")          id=33 ;;
670                 "acid")                  id=34 ;;
671                 "house")                 id=35 ;;
672                 "game")                  id=36 ;;
673                 "sound clip")            id=37 ;;
674                 "gospel")                id=38 ;;
675                 "noise")                 id=39 ;;
676                 "alt. rock")             id=40 ;;
677                 "bass")                  id=41 ;;
678                 "soul")                  id=42 ;;
679                 "punk")                  id=43 ;;
680                 "space")                 id=44 ;;
681                 "meditative")            id=45 ;;
682                 "instrum. pop")          id=46 ;;
683                 "instrum. rock")         id=47 ;;
684                 "ethnic")                id=48 ;;
685                 "gothic")                id=49 ;;
686                 "darkwave")              id=50 ;;
687                 "techno-indust.")        id=51 ;;
688                 "electronic")            id=52 ;;
689                 "pop-folk")              id=53 ;;
690                 "eurodance")             id=54 ;;
691                 "dream")                 id=55 ;;
692                 "southern rock")         id=56 ;;
693                 "comedy")                id=57 ;;
694                 "cult")                  id=58 ;;
695                 "gangsta")               id=59 ;;
696                 "top 40")                id=60 ;;
697                 "christian rap")         id=61 ;;
698                 "pop/funk"|"pop / funk") id=62 ;;
699                 "jungle")                id=63 ;;
700                 "native american")       id=64 ;;
701                 "cabaret")               id=65 ;;
702                 "new wave")              id=66 ;;
703                 "psychadelic")           id=67 ;;
704                 "rave")                  id=68 ;;
705                 "showtunes")             id=69 ;;
706                 "trailer")               id=70 ;;
707                 "lo-fi")                 id=71 ;;
708                 "tribal")                id=72 ;;
709                 "acid punk")             id=73 ;;
710                 "acid jazz")             id=74 ;;
711                 "polka")                 id=75 ;;
712                 "retro")                 id=76 ;;
713                 "musical")               id=77 ;;
714                 "rock & roll")           id=78 ;;
715                 "hard rock")             id=79 ;;
716                 "folk")                  id=80 ;;
717                 "folk/rock")             id=81 ;;
718                 "national folk")         id=82 ;;
719                 "swing")                 id=83 ;;
720                 "fusion")                id=84 ;;
721                 "bebob")                 id=85 ;;
722                 "latin")                 id=86 ;;
723                 "revival")               id=87 ;;
724                 "celtic")                id=88 ;;
725                 "bluegrass")             id=89 ;;
726                 "avantgarde")            id=90 ;;
727                 "gothic rock")           id=91 ;;
728                 "progress. rock")        id=92 ;;
729                 "psychadel. rock")       id=93 ;;
730                 "symphonic rock")        id=94 ;;
731                 "slow rock")             id=95 ;;
732                 "big band")              id=96 ;;
733                 "chorus")                id=97 ;;
734                 "easy listening")        id=98 ;;
735                 "acoustic")              id=99 ;;
736                 "humour")                id=100 ;;
737                 "speech")                id=101 ;;
738                 "chanson")               id=102 ;;
739                 "opera")                 id=103 ;;
740                 "chamber music")         id=104 ;;
741                 "sonata")                id=105 ;;
742                 "symphony")              id=106 ;;
743                 "booty bass")            id=107 ;;
744                 "primus")                id=108 ;;
745                 "porn groove")           id=109 ;;
746                 "satire")                id=110 ;;
747                 "slow jam")              id=111 ;;
748                 "club")                  id=112 ;;
749                 "tango")                 id=113 ;;
750                 "samba")                 id=114 ;;
751                 "folklore")              id=115 ;;
752                 "ballad")                id=116 ;;
753                 "power ballad")          id=117 ;;
754                 "rhythmic soul")         id=118 ;;
755                 "freestyle")             id=119 ;;
756                 "duet")                  id=120 ;;
757                 "punk rock")             id=121 ;;
758                 "drum solo")             id=122 ;;
759                 "a capella")             id=123 ;;
760                 "euro-house")            id=124 ;;
761                 "dance hall")            id=125 ;;
762                 "goa")                   id=126 ;;
763                 "drum & bass")           id=127 ;;
764                 "club-house")            id=128 ;;
765                 "hardcore")              id=129 ;;
766                 "terror")                id=130 ;;
767                 "indie")                 id=131 ;;
768                 "britpop")               id=132 ;;
769                 "negerpunk")             id=133 ;;
770                 "polsk punk")            id=134 ;;
771                 "beat")                  id=135 ;;
772                 "christian gangsta rap") id=136 ;;
773                 "heavy metal")           id=137 ;;
774                 "black metal")           id=138 ;;
775                 "crossover")             id=139 ;;
776                 "contemporary christian")id=140 ;;
777                 "christian rock")        id=141 ;;
778                 "merengue")              id=142 ;;
779                 "salsa")                 id=143 ;;
780                 "thrash metal")          id=144 ;;
781                 "anime")                 id=145 ;;
782                 "jpop")                  id=146 ;;
783                 "synthpop")              id=147 ;;
784                 "rock/pop"|"rock / pop") id=148 ;;
785                 *)                       return 1 ;;
786         esac
787 echo ${id}
788 return 0
789 }
790
791 # do_tag [tracknumber]
792 # id3 tags a filename
793 # variables used:
794 # TRACKS, TRACKNAME, TRACKARTIST, TAGGER, TAGGEROPTS, VORBISCOMMENT, METAFLAC,
795 # COMMENT, DALBUM, DARTIST, CDYEAR, CDGENRE
796 do_tag ()
797 {
798         COMMENTOUTPUT="$(eval echo ${COMMENT})"
799         if [ -z "$COMMENTOUTPUT" ]; then
800                 COMMENTOUTPUT="$(getcddbinfo TRACK-INFO)"
801         fi
802         if [ "$CDDBMETHOD" = "cddb" ]; then
803                 CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
804         fi
805         run_command '' echo "Tagging track $1 of $TRACKS: $TRACKNAME..."
806         # If we want to start the tracks with a given number, we need to modify the
807         # TRACKNUM value before evaluation
808         if [ -n "$STARTTRACKNUMBERTAG" ] ; then
809                 gettracknum
810         fi
811         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
812         do
813                 case "$OUTPUT" in
814                 mp3)
815                         # id3v2 v0.1.9 claims to have solved the -c bug, so we merge both id3 and id3v2
816                         GENREID=$(do_getgenreid "${CDGENRE}")
817                         # Set TPE2 in case we have a Various Artists rip.
818                         TPE2=""
819                         if [ "$VARIOUSARTISTS" = "y" ]; then
820                                 TPE2="Various"
821                         fi
822
823
824                         case "$ID3SYNTAX" in
825                                 id3)
826                                         run_command tagtrack-$OUTPUT-$1 nice $ENCNICE \
827                                                 $TAGGER $TAGGEROPTS -c "$COMMENTOUTPUT" \
828                                                 -A "$DALBUM" -a "$TRACKARTIST" -t "$TRACKNAME" \
829                                                 -y "$CDYEAR" -g "$GENREID" \
830                                                 -T "${TRACKNUM:-$1}" \
831                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
832                                         ;;
833                                 id3v2)
834                                         # FIXME # track numbers in mp3 come with 1/10, so we cannot
835                                         # happily substitute them with $TRACKNUM
836                                         run_command tagtrack-$OUTPUT-$1 nice $ENCNICE \
837                                                 $TAGGER $TAGGEROPTS -c "$COMMENTOUTPUT" \
838                                                 -A "$DALBUM" -a "$TRACKARTIST" -t "$TRACKNAME" \
839                                                 -y "$CDYEAR" -g "$GENREID" \
840                                                 -T "${TRACKNUM:-$1}/$TRACKS" \
841                                                 ${TPE2:+--TPE2 "$TPE2"} \
842                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
843                                         ;;
844                                 eyed3*)
845                                         # FIXME # track numbers in mp3 come with 1/10, so we cannot
846                                         # happily substitute them with $TRACKNUM
847                                         case "$ID3SYNTAX" in
848                                                 eyed3_06) addopts=( \
849                                                         ${ENCODING:+--set-encoding="$ENCODING"} \
850                                                         ${TPE2:+--set-text-frame=TPE2:"$TPE2"} \
851                                         # We set 'recording-date' so the date tag will show 
852                                         # in Audacious, vlc and friends...          Andrew.
853                                                         ${CDYEAR:+--set-text-frame="TDRC:$CDYEAR"} \
854                                                         ${COMMENTOUTPUT:+--comment=::"$COMMENTOUTPUT"} \
855                                                         );;
856                                                 *) addopts=( \
857                                                         ${ENCODING:+--encoding="$ENCODING"} \
858                                                         ${TPE2:+--text-frame=TPE2:"$TPE2"} \
859                                         # We set 'recording-date' so the date tag will show 
860                                         # in Audacious, vlc and friends...           Andrew.
861                                                         ${CDYEAR:+--text-frame="TDRC:$CDYEAR"} \
862                                                         ${COMMENTOUTPUT:+--comment "$COMMENTOUTPUT"} \
863                                                         );;
864                                         esac
865                                         run_command tagtrack-$OUTPUT-$1 nice $ENCNICE $TAGGER $TAGGEROPTS \
866                                             -A "$DALBUM" \
867                                                 -a "$TRACKARTIST" -t "$TRACKNAME" \
868                                                 -G "$GENREID" -n "${TRACKNUM:-$1}" \
869                                                 ${TRACKNUM:+-N "$TRACKS"} \
870                                                 "${addopts[@]}" \
871                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
872                                         ;;
873                                 *)
874                                         log error "Internal error: ID3SYNTAX has an illegal value"
875                                         exit 1
876                                         ;;
877                         esac
878                         ;;
879                 vorbis|ogg)
880                         case "$OGGENCODERSYNTAX" in
881                                 vorbize|oggenc)
882                                         # vorbiscomment can't do in-place modification, mv the file first
883                                         if [ -f "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" -a ! -f "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" ]; then
884                                                 mv "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER"
885                                         fi
886                                         (
887                                         # These are from
888                                         # http://www.xiph.org/ogg/vorbis/doc/v-comment.html
889
890                                         echo ARTIST="$TRACKARTIST"
891                                         echo ALBUM="$DALBUM"
892                                         echo TITLE="$TRACKNAME"
893                                         if [ -n "$CDYEAR" ]; then
894                                                 echo DATE="$CDYEAR"
895                                         fi
896                                         if [ -n "$CDGENRE" ]; then
897                                                 echo GENRE="$CDGENRE"
898                                         fi
899                                         echo TRACKNUMBER=${TRACKNUM:-$1}
900                                         if [ -n "$DISCNUMBER" ]; then
901                                                 echo DISCNUMBER="$DISCNUMBER"
902                                         fi
903                                         echo CDDB=$CDDBDISCID
904                                         if [ "$(eval echo ${COMMENT})" != "" ]; then
905                                                 case "$COMMENTOUTPUT" in
906                                                         *=*) echo "$COMMENTOUTPUT";;
907                                                         *)   echo COMMENT="$COMMENTOUTPUT";;
908                                                 esac
909                                         fi
910                                         ) | run_command tagtrack-$OUTPUT-$1 nice $ENCNICE \
911                                                 $VORBISCOMMENT $VORBISCOMMENTOPTS -w \
912                                                 "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
913                                         # Doublecheck that the commented file was created
914                                         # successfully before wiping the original
915                                         if [ -f "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" ]; then
916                                                 rm -f "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER"
917                                         else
918                                                 mv "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
919                                         fi
920                                         ;;
921                         esac
922                         ;;
923                 opus)
924                         run_command tagtrack-$OUTPUT-$1 true
925                         ;;
926
927                 flac)
928                         (
929                         echo ARTIST="$TRACKARTIST"
930                         echo ALBUM="$DALBUM"
931                         echo TITLE="$TRACKNAME"
932                         if [ -n "$CDYEAR" ]; then
933                                 echo DATE="$CDYEAR"
934                         fi
935                         if [ -n "$CDGENRE" ]; then
936                                 echo GENRE="$CDGENRE"
937                         fi
938                         echo TRACKNUMBER="${TRACKNUM:-$1}"
939                         if [ -n "$DISCNUMBER" ]; then
940                                 echo DISCNUMBER="$DISCNUMBER"
941                         fi
942                         echo CDDB="$CDDBDISCID"
943                         if [ "$(eval echo ${COMMENT})" != "" ]; then
944                                 case "$COMMENTOUTPUT" in
945                                         *=*) echo "$COMMENTOUTPUT";;
946                                         *)   echo COMMENT="$COMMENTOUTPUT";;
947                                 esac
948                         fi
949                         ) | run_command tagtrack-$OUTPUT-$1 nice $ENCNICE $METAFLAC $METAFLACOPTS ${IMPORTCUESHEET:+--import-cuesheet-from="$ABCDETEMPDIR/$CUEFILE"} --import-tags-from=- "$ABCDETEMPDIR/track$1.$FLACOUTPUTCONTAINER"
950                         ;;
951                 spx)
952                         run_command tagtrack-$OUTPUT-$1 true
953                         ;;
954                 mpc)
955                         run_command tagtrack-$OUTPUT-$1 true
956                         ;;
957         wv)
958             run_command tagtrack-$OUTPUT-$1 true
959                         ;;
960         ape) # This tagging syntax is suitable for Robert Muth's application 'apetag', the Monkey's Audio 
961              # Console port (mac) used for encoding does not have the ability to tag.              Andrew.
962             run_command tagtrack-$OUTPUT-$1 nice $ENCNICE "$APETAG" -i "$ABCDETEMPDIR/track$1.ape" -m overwrite \
963                      -p artist="$TRACKARTIST" -p album="$DALBUM" -p title="$TRACKNAME" -p track=${TRACKNUM:-$1} \
964                      -p year="$CDYEAR" -p genre="$CDGENRE" ${COMMENTOUTPUT:+-p comment="$COMMENTOUTPUT"} 
965                         ;;
966                 aac)
967                         run_command tagtrack-$OUTPUT-$1 true
968                 ;;
969                 m4a)
970                   case "$AACENCODERSYNTAX" in
971                     fdkaac) # We will use inline tagging...
972                         run_command tagtrack-$OUTPUT-$1 true
973                         ;;
974                     neroAacEnc) # Tag post encode with neroAacTag...
975                      run_command tagtrack-$OUTPUT-$1 nice $ENCNICE "$NEROAACTAG" "$ABCDETEMPDIR/track$1.m4a" \
976                      -meta:artist="$TRACKARTIST" -meta:album="$DALBUM" -meta:title="$TRACKNAME" -meta:track=${TRACKNUM:-$1} \
977                      -meta:year="$CDYEAR" -meta:genre="$CDGENRE" -meta:comment="$COMMENT"
978                       ;;
979                    faac)
980                      run_command tagtrack-$OUTPUT-$1 true                   
981                         ;;
982                 esac                    
983                         ;;
984                 wav)
985                         run_command tagtrack-$OUTPUT-$1 true
986                         ;;
987                 esac
988         done
989         if checkerrors "tagtrack-(.{3,6})-$1"; then :; else
990                 run_command tagtrack-$1 true
991         fi
992
993 }
994
995 # do_nogap_encode
996 # variables used:
997 # OUTPUTTYPE, {FOO}ENCODERSYNTAX, ENCNICE, ENCODER, ENCODEROPTS
998 do_nogap_encode ()
999 {
1000         # The commands here don't go through run_command because they're never
1001         # supposed to be silenced
1002         echo "Encoding gapless MP3 tracks: $TRACKQUEUE"
1003         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1004         do
1005                 case "$OUTPUT" in
1006                 mp3)
1007                         case "$MP3ENCODERSYNTAX" in
1008                         lame|toolame)
1009                                 (
1010                                 cd "$ABCDETEMPDIR"
1011                                 TRACKFILES=
1012                                 for UTRACKNUM in $TRACKQUEUE
1013                                 do
1014                                         TRACKFILES="$TRACKFILES track$UTRACKNUM.wav"
1015                                 done
1016                                 nice $ENCNICE $MP3ENCODER $MP3ENCODEROPTS --nogap $TRACKFILES
1017                                 RETURN=$?
1018                                 if [ "$RETURN" != "0" ]; then
1019                                         echo "nogap-encode: $ENCODER returned code $RETURN" >> errors
1020                                 else
1021                                         for UTRACKNUM in $TRACKQUEUE
1022                                         do
1023                                                 run_command encodetrack-$OUTPUT-$UTRACKNUM true
1024                                                 #run_command encodetrack-$UTRACKNUM true
1025                                         done
1026                                 fi
1027                                 )
1028                                 ;;
1029                         esac
1030                         ;;
1031                 esac
1032         done
1033         if checkerrors "nogap-encode"; then :; else
1034                 if [ ! "$KEEPWAVS" = "y" ] ; then
1035                         if [ ! "$KEEPWAVS" = "move" ] ; then
1036                                 rm -f "$IN"
1037                         fi
1038                 fi
1039         fi
1040         # Other encoders fall through to normal encoding as the tracks have not
1041         # been entered in the status file.
1042 }
1043
1044 # do_encode [tracknumber] [hostname]
1045 # If no hostname is specified, encode locally
1046 # variables used:
1047 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
1048 do_encode ()
1049 {
1050         if [ "$USEPIPES" = "y" ]; then
1051                 case "$OUTPUT" in
1052                         mp3)
1053                                 TEMPARG="PIPE_$MP3ENCODERSYNTAX"
1054                                 ;;
1055                         vorbis|ogg)
1056                                 TEMPARG="PIPE_$OGGENCODERSYNTAX"
1057                                 ;;
1058                         opus)
1059                                 TEMPARG="PIPE_$OPUSENCODERSYNTAX"
1060                                 ;;
1061                         flac)
1062                                 TEMPARG="PIPE_$FLACENCODERSYNTAX"
1063                                 ;;
1064                         spx)
1065                                 TEMPARG="PIPE_$SPEEXENCODER"
1066                                 ;;
1067                         mpc)
1068                                 TEMPARG="PIPE_$MPCENCODER"
1069                                 ;;
1070                         wv)
1071                                 TEMPARG="PIPE_$WVENCODERSYNTAX"
1072                                 ;;
1073                         aac)
1074                                 TEMPARG="PIPE_$AACENCODERSYNTAX"
1075                                 ;;
1076                         m4a)
1077                                 TEMPARG="PIPE_$AACENCODERSYNTAX"
1078                                 ;;
1079                 esac
1080                 IN="$( eval echo "\$$TEMPARG" )"
1081         else
1082                 IN="$ABCDETEMPDIR/track$1.wav"
1083         fi
1084         # We need IN to proceed, if we are not using pipes.
1085         if [ -s "$IN" -o X"$USEPIPES" = "Xy" ] ; then
1086                 for TMPOUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1087                 do
1088                         case "$TMPOUTPUT" in
1089                                 vorbis|ogg)
1090                                         OUTPUT=$OGGOUTPUTCONTAINER
1091                                         ;;
1092                                 opus)
1093                                         OUTPUT=$OPUSOUTPUTCONTAINER
1094                                         ;;
1095                                 flac)
1096                                         OUTPUT=$FLACOUTPUTCONTAINER
1097                                         ;;
1098                                 *)
1099                                         OUTPUT=$TMPOUTPUT
1100                                         ;;
1101                         esac
1102                         OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
1103                         if [ "$NOGAP" = "y" ] && checkstatus encodetrack-$OUTPUT-$1 ; then
1104                                 continue
1105                         fi
1106                         if [ X"$USEPIPES" = "Xy" ]; then
1107                                 RUN_COMMAND=""
1108                                 # We need a way to store the creation of the files when using PIPES
1109                                 RUN_COMMAND_PIPES="run_command encodetrack-$OUTPUT-$1 true"
1110                                 # When pipping it does not make sense to have a higher nice for
1111                                 # reading than for encoding, since it will be hold by the
1112                                 # encoding process. Setting an effective nice, to calm down a
1113                                 # bit the reading process.
1114                                 EFFECTIVE_NICE=$READNICE
1115                         else
1116                                 run_command '' echo "Encoding track $1 of $TRACKS: $TRACKNAME..."
1117                                 RUN_COMMAND="run_command encodetrack-$OUTPUT-$1"
1118                                 EFFECTIVE_NICE=$ENCNICE
1119                         fi
1120                         case "$OUTPUT" in
1121                         mp3)
1122                                 case "$2" in
1123                                 %local*%)
1124                                         case "$MP3ENCODERSYNTAX" in
1125                                         lame|toolame|gogo) $RUN_COMMAND nice $EFFECTIVE_NICE $MP3ENCODER $MP3ENCODEROPTS "$IN" "$OUT" ;;
1126                                         bladeenc) $RUN_COMMAND nice $EFFECTIVE_NICE $MP3ENCODER $MP3ENCODEROPTS -quit "$IN" ;;
1127                                         l3enc|xingmp3enc) $RUN_COMMAND nice $EFFECTIVE_NICE $MP3ENCODER "$IN" "$OUT" $MP3ENCODEROPTS ;;
1128                                         mp3enc) $RUN_COMMAND nice $EFFECTIVE_NICE $MP3ENCODER -if "$IN" -of "$OUT" $MP3ENCODEROPTS ;;
1129                                         esac
1130                                         ;;
1131                                 *)
1132                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
1133                                         ;;
1134                                 esac
1135                                 ;;
1136                         vorbis|ogg)
1137                                 case "$2" in
1138                                 %local*%)
1139                                         case "$OGGENCODERSYNTAX" in
1140                                         vorbize) $RUN_COMMAND nice $EFFECTIVE_NICE $OGGENCODER $OGGENCODEROPTS -w "$OUT" "$IN" ;;
1141                                         oggenc) $RUN_COMMAND nice $EFFECTIVE_NICE $OGGENCODER $OGGENCODEROPTS -o "$OUT" "$IN" ;;
1142                                         esac
1143                                         ;;
1144                                 *)
1145                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
1146                                         ;;
1147                                 esac
1148                                 ;;
1149                         opus)
1150                                 case "$2" in
1151                                 %local*%)
1152                                         case "$OPUSENCODERSYNTAX" in
1153                                         opusenc)
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" \
1157                                                --genre "$CDGENRE" --date "$CDYEAR" --comment TRACKNUMBER="$1" ${COMMENT:+--comment COMMENT="$COMMENT"} "$IN" "$OUT"
1158                                             else
1159                                               $RUN_COMMAND nice $EFFECTIVE_NICE $OPUSENCODER $OPUSENCODEROPTS "$IN" "$OUT"
1160                                             fi
1161                                               ;;
1162                                         esac
1163                                         ;;
1164                                 *)
1165                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
1166                                         ;;
1167                                 esac
1168                                 ;;
1169                         flac)
1170                                 case "$2" in
1171                                 %local*%)
1172                                         case "$FLACENCODERSYNTAX" in
1173                                         flac) $RUN_COMMAND nice $EFFECTIVE_NICE $FLACENCODER -f $FLACENCODEROPTS -o "$OUT" "$IN" ;;
1174                                                 esac
1175                                                 ;;
1176                                         *)
1177                                                 vecho -n "DISTMP3:"
1178                                                 vecho "$DISTMP3 $DISTMP3OPTS $2 $IN $OUT >/dev/null 2>&1"
1179                                                 $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" > /dev/null 2>&1
1180                                         ;;
1181                                 esac
1182                                 ;;
1183                         spx)
1184                                 if [ "$(eval echo ${COMMENT})" != "" ]; then
1185                                         case "$COMMENT" in
1186                                                 *=*) ;;
1187                                                 *)   COMMENT="COMMENT=$COMMENT" ;;
1188                                         esac
1189                                 fi
1190                                 # Tag the file at encode time, as it can't be done after encoding.
1191                                 if [ "$DOTAG" = "y" ]; then
1192                                         $RUN_COMMAND nice $EFFECTIVE_NICE $SPEEXENCODER $SPEEXENCODEROPTS --author "$TRACKARTIST" --title "$TRACKNAME" ${COMMENT:+--comment "$COMMENT"} "$IN" "$OUT"
1193                                 else
1194                                         $RUN_COMMAND nice $EFFECTIVE_NICE $SPEEXENCODER $SPEEXENCODEROPTS "$IN" "$OUT"
1195                                 fi
1196                                 ;;
1197                         mpc)
1198                         # Tag the file inline at encode time.
1199                           if [ "$DOTAG" = "y" ]; then
1200                                  $RUN_COMMAND nice $EFFECTIVE_NICE $MPCENCODER $MPCENCODEROPTS --artist "$TRACKARTIST" --album "$DALBUM" --title "$TRACKNAME" \
1201                                 --track "$1" --genre "$CDGENRE" --year "$CDYEAR" ${COMMENT:+--comment "$COMMENT"} "$IN" "$OUT"
1202                                 else
1203                                  $RUN_COMMAND nice $EFFECTIVE_NICE $MPCENCODER $MPCENCODEROPTS "$IN" "$OUT"
1204                                 fi
1205                                 ;;
1206                         wv)
1207                          if [ "$DOTAG" = "y" ]; then
1208              # wavpack tagging is done inline using Apev2 tags:
1209                                 $RUN_COMMAND nice $EFFECTIVE_NICE $WVENCODER $WVENCODEROPTS -w Artist="$TRACKARTIST" -w Album="$DALBUM" -w Title="$TRACKNAME" \
1210                                 -w Track="$1" -w Genre="$CDGENRE" -w Year="$CDYEAR" ${COMMENT:+-w Comment="$COMMENT"} "$IN" -o "$OUT"
1211                         else
1212                            $RUN_COMMAND nice $EFFECTIVE_NICE $WVENCODER $WVENCODEROPTS "$IN" -o "$OUT"
1213                          fi
1214                                 ;;
1215                         ape)
1216                           $RUN_COMMAND nice $EFFECTIVE_NICE $APENCODER "$IN" "$OUT" $APENCODEROPTS
1217                          ;;
1218                         aac)
1219                         # aac container is only used to catch faac encoded files where faac 
1220                         # is compiled without mp4 support (with libmp4v2).           Andrew.
1221                           $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS -o "$OUT" "$IN"
1222                          ;;
1223                         m4a)
1224                          case "$AACENCODERSYNTAX" in
1225                            faac)
1226                              if [ "$DOTAG" = "y" ]; then
1227                    $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS  --artist "$TRACKARTIST" \
1228                    --album "$DALBUM" --title "$TRACKNAME" --track ${TRACKNUM:-$1} --year "$CDYEAR" \
1229                    --genre "$CDGENRE" --comment "$COMMENT" -o "$OUT" "$IN"                                
1230                  else                    
1231                    $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS -o "$OUT" "$IN"        
1232                  fi
1233                            ;;
1234                            neroAacEnc)
1235                     $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS -if "$IN" -of "$OUT"
1236                            ;;
1237                          fdkaac)                     
1238                         if [ "$DOTAG" = "y" ]; then
1239                           $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS --artist "$TRACKARTIST" --album "$DALBUM" \
1240                           --title "$TRACKNAME" --track "$1" --genre "$CDGENRE" --date "$CDYEAR" --comment "$COMMENT" "$IN" -o "$OUT"
1241                             else
1242                      $RUN_COMMAND nice $EFFECTIVE_NICE $AACENCODER $AACENCODEROPTS "$IN" -o "$OUT"      
1243                             fi
1244                  ;;
1245                           esac  
1246                                 ;;
1247                         wav)
1248                                 # In case of wav output we need nothing. Just keep the wavs.
1249                                 # But we need the following to allow full logging and subsequent 
1250                                 # successful cleaning of $ABCDETEMPDIR. Andrew.
1251              echo "encodetrack-$OUTPUT-$UTRACKNUM" >> "$ABCDETEMPDIR/status"
1252                                 ;;
1253                         esac
1254                         $RUN_COMMAND_PIPES
1255                 done
1256                 # Only remove .wav if the encoding succeeded
1257                 if checkerrors "encodetrack-(.{3,6})-$1"; then :; else
1258                         run_command encodetrack-$1 true
1259                         if [ ! "$KEEPWAVS" = "y" ] ; then
1260                                 if [ ! "$KEEPWAVS" = "move" ] ; then
1261                                         rm -f "$IN"
1262                                 fi
1263                         fi
1264                 fi
1265         else
1266                 run_command "" echo "HEH! The file we were about to encode disappeared:"
1267                 run_command "" echo ">> $IN"
1268                 run_command encodetrack-$1 false
1269         fi
1270 }
1271
1272 # do_preprocess [tracknumber]
1273 # variables used:
1274 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
1275 #do_preprocess ()
1276 #{
1277 #       IN="$ABCDETEMPDIR/track$1.wav"
1278 #       # We need IN to proceed.
1279 #       if [ -s "$IN" ] ; then
1280 #               for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1281 #               do
1282 #                       #OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
1283 #                       run_command '' echo "Pre-processing track $1 of $TRACKS..."
1284 #                       case "$POSTPROCESSFORMAT" in
1285 #                       all|wav*)
1286 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $WAV_PRE $IF $OF ;;
1287 #                       mp3)
1288 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $MP3_PRE $IF $OF ;;
1289 #                       ogg)
1290 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $OGG_PRE $IF $OF ;;
1291 #                       flac)
1292 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $FLAC_PRE $IF $OF ;;
1293 #                       spx)
1294 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $SPX_PRE $IF $OF ;;
1295 #                       esac
1296 #               done
1297 #               # Only remove .wav if the encoding succeeded
1298 #               if checkerrors "preprocess-(.{3,4})-$1"; then
1299 #                       run_command preprocess-$1 false
1300 #               else
1301 #                       run_command preprocess-$1 true
1302 #               fi
1303 #       else
1304 #               if [ "$(checkstatus encode-output)" = "loud" ]; then
1305 #                       echo "HEH! The file we were about to pre-process disappeared:"
1306 #                       echo ">> $IN"
1307 #               fi
1308 #               run_command preprocess-$1 false
1309 #       fi
1310 #}
1311
1312
1313 # do_postprocess [tracknumber]
1314 # variables used:
1315 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
1316 #do_postprocess ()
1317 #{
1318 #       for POSTPROCESSFORMAT in $(echo $POSTPROCESSFORMATS | tr , \ )
1319 #       do
1320 #               IN="$ABCDETEMPDIR/track$1.$POSTPROCESSFORMAT"
1321 #               # We need IN to proceed.
1322 #               if [ -s "$IN" ] ; then
1323 #                       #OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
1324 #                       run_command '' echo "Post-processing track $1 of $TRACKS..."
1325 #                       case "$POSTPROCESSFORMAT" in
1326 #                               mp3)
1327 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $MP3_POST $IF $OF ;;
1328 #                               ogg)
1329 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $OGG_POST $IF $OF ;;
1330 #                               flac)
1331 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $FLAC_POST $IF $OF ;;
1332 #                               spx)
1333 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $SPX_POST $IF $OF ;;
1334 #                       esac
1335 #                       # Only remove .wav if the encoding succeeded
1336 #                       if checkerrors "postprocess-(.{3,4})-$1"; then
1337 #                               run_command postprocess-$1 false
1338 #                       else
1339 #                               run_command postprocess-$1 true
1340 #                       fi
1341 #               else
1342 #                       if [ "$(checkstatus encode-output)" = "loud" ]; then
1343 #                               echo "HEH! The file we were about to post-process disappeared:"
1344 #                               echo ">> $IN"
1345 #                       fi
1346 #                       run_command postprocess-$1 false
1347 #               fi
1348 #       done
1349 #}
1350
1351 # do_single_gain
1352 # variables used:
1353 # FIXME #
1354 do_single_gain ()
1355 {
1356 :
1357 }
1358
1359 # do_batch_gain
1360 # variables used:
1361 # MP3GAIN, MP3GAINOPTS, VORBISGAIN, VORBISGAINOPTS, MPCGAIN
1362 # FIXME #
1363 do_batch_gain ()
1364 {
1365         # The commands here don't go through run_command because they're never supposed to be silenced
1366         echo "Batch analizing gain in tracks: $TRACKQUEUE"
1367         (
1368         cd "$ABCDETEMPDIR"
1369         BLURB=
1370         TRACKFILES=
1371         for UTRACKNUM in $TRACKQUEUE
1372         do
1373                 MP3FILES="$TRACKFILES track$UTRACKNUM.mp3"
1374         done
1375         # FIXME # Hard-coded batch option!
1376         $NORMALIZER -b $NORMALIZEROPTS $TRACKFILES
1377         RETURN=$?
1378         if [ "$RETURN" != "0" ]; then
1379                 echo "batch-normalize: $NORMALIZER returned code $RETURN" >> errors
1380         else
1381                 for UTRACKNUM in $TRACKQUEUE
1382                 do
1383                         echo normalizetrack-$UTRACKNUM >> status
1384                 done
1385         fi
1386         )
1387 }
1388
1389 # do_batch_normalize
1390 # variables used:
1391 # NORMALIZER, NORMALIZEROPTS
1392 do_batch_normalize ()
1393 {
1394         # The commands here don't go through run_command because they're never supposed to be silenced
1395         echo "Batch normalizing tracks: $TRACKQUEUE"
1396         (
1397         cd "$ABCDETEMPDIR"
1398         BLURB=
1399         TRACKFILES=
1400         for UTRACKNUM in $TRACKQUEUE
1401         do
1402                 TRACKFILES="$TRACKFILES track$UTRACKNUM.wav"
1403         done
1404         # XXX: Hard-coded batch option!
1405         $NORMALIZER -b $NORMALIZEROPTS $TRACKFILES
1406         RETURN=$?
1407         if [ "$RETURN" != "0" ]; then
1408                 echo "batch-normalize: $NORMALIZER returned code $RETURN" >> errors
1409         else
1410                 for UTRACKNUM in $TRACKQUEUE
1411                 do
1412                         echo normalizetrack-$UTRACKNUM >> status
1413                 done
1414         fi
1415         )
1416 }
1417
1418 # do_normalize [tracknumber]
1419 # variables used:
1420 # TRACKS, TRACKNAME, NORMALIZER, NORMALIZEROPTS
1421 do_normalize ()
1422 {
1423         IN="$ABCDETEMPDIR/track$1.wav"
1424         if [ -e "$IN" ] ; then
1425                 run_command '' echo "Normalizing track $1 of $TRACKS: $TRACKNAME..."
1426                 run_command normalizetrack-$1 $NORMALIZER $NORMALIZEROPTS "$IN"
1427         else
1428                 if [ "$(checkstatus encode-output)" = "loud" ]; then
1429                         echo "HEH! The file we were about to normalize disappeared:"
1430                         echo ">> $IN"
1431                 fi
1432                 run_command normalizetrack-$1 false "File $IN was not found"
1433         fi
1434 }
1435
1436 # do_move [tracknumber]
1437 # Deduces the outfile from environment variables
1438 # Creates directory if necessary
1439 # variables used:
1440 # TRACKNUM, TRACKNAME, TRACKARTIST, DALBUM, OUTPUTFORMAT, CDGENRE, CDYEAR
1441 do_move ()
1442 {
1443         for TMPOUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1444         do
1445                 # For now, set OUTPUT as TMPOUTPUT, and then change it once we have
1446                 # defined the OUTPUTFILE:
1447                 OUTPUT="$TMPOUTPUT"
1448
1449                 # Create ALBUMFILE, ARTISTFILE, TRACKFILE
1450                 # Munge filenames as follows:
1451                 # ' ' -> '_'
1452                 # '/' -> '_'
1453                 # ''' -> ''
1454                 # '?' -> ''
1455                 # Eat control characters
1456                 ALBUMFILE="$(mungefilename "$DALBUM")"
1457                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1458                 TRACKFILE="$(mungefilename "$TRACKNAME")"
1459                 GENRE="$(mungegenre "$GENRE")"
1460                 YEAR=${CDYEAR:-$CDYEAR}
1461                 # If we want to start the tracks with a given number, we need to modify
1462                 # the TRACKNUM value before evaluation
1463                 gettracknum
1464                 # Supported variables for OUTPUTFORMAT are GENRE, YEAR, ALBUMFILE,
1465                 # ARTISTFILE, TRACKFILE, and TRACKNUM.
1466                 if [ "$ONETRACK" = "y" ]; then
1467                         if [ "$VARIOUSARTISTS" = "y" ]; then
1468                                 OUTPUTFILE="$(eval echo \""$VAONETRACKOUTPUTFORMAT"\")"
1469                         else
1470                                 OUTPUTFILE="$(eval echo \""$ONETRACKOUTPUTFORMAT"\")"
1471                         fi
1472                 else
1473                         if [ "$VARIOUSARTISTS" = "y" ]; then
1474                                 OUTPUTFILE="$(eval echo \""$VAOUTPUTFORMAT"\")"
1475                         else
1476                                 OUTPUTFILE="$(eval echo \""$OUTPUTFORMAT"\")"
1477                         fi
1478                 fi
1479                 if checkerrors "tagtrack-$OUTPUT-$1"; then :; else
1480                         # Once we know the specific output was successful, we can change
1481                         # the OUTPUT to the value containing the container
1482                         case $TMPOUTPUT in
1483                                 vorbis|ogg)
1484                                         OUTPUT=$OGGOUTPUTCONTAINER
1485                                         ;;
1486                                 opus)
1487                                         OUTPUT=$OPUSOUTPUTCONTAINER
1488                                         ;;
1489                                 flac)
1490                                         OUTPUT=$FLACOUTPUTCONTAINER
1491                                         ;;
1492                                 *)
1493                                         OUTPUT=$TMPOUTPUT
1494                                         ;;
1495                         esac
1496                         # Check that the directory for OUTPUTFILE exists, if it doesn't, create it
1497                         OUTPUTFILEDIR="$(dirname "$OUTPUTDIR/$OUTPUTFILE")"
1498                         case $OUTPUT in
1499                                 wav)
1500                                         if [ "$DOCLEAN" != "y" ] && [ "$FORCE" != "y" ]; then
1501                                                 # FIXME # introduce warnings?
1502                                                 :
1503                                         else
1504                                                 # mkdir -p shouldn't return an error if the directory already exists
1505                                                 mkdir -p "$OUTPUTFILEDIR"
1506                                                 run_command movetrack-$1 mv "$ABCDETEMPDIR/track$1.$OUTPUT" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
1507                                                 if checkstatus movetrack-output-$OUTPUT; then :; else
1508                                                         run_command movetrack-output-$OUTPUT true
1509                                                 fi
1510                                         fi
1511                                         ;;
1512                                 *)
1513                                         # mkdir -p shouldn't return an error if the directory already exists
1514                                         mkdir -p "$OUTPUTFILEDIR"
1515                                         run_command movetrack-$1 mv "$ABCDETEMPDIR/track$1.$OUTPUT" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
1516                                         if checkstatus movetrack-output-$OUTPUT; then :; else
1517                                                 run_command movetrack-output-$OUTPUT true
1518                                         fi
1519                                         ;;
1520                         esac
1521                         # Lets move the cue file
1522                         if CUEFILE=$(checkstatus cuefile) >/dev/null ; then
1523                                 if [ -r "$ABCDETEMPDIR/$CUEFILE" ]; then
1524                                         if checkstatus movecue-$OUTPUT; then :; else
1525                                                 # Silence the Copying output since it overlaps with encoding processes...
1526                                                 #run_command '' vecho "Copying cue file to its destination directory..."
1527                                                 if checkstatus onetrack >/dev/null ; then
1528                                                         case $OUTPUT in
1529                                                                 wav)
1530                                                                         if [ "$DOCLEAN" != "y" ] && [ "$FORCE" != "y" ]; then
1531                                                                                 # We dont have the dir, since it was not created before.
1532                                                                                 :
1533                                                                         else
1534                                                                                 run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.cue"
1535                                                                         fi
1536                                                                         ;;
1537                                                                 # NOTE: Creating a cue file with the 3-char-extension files is to comply with
1538                                                                 # http://brianvictor.tripod.com/mp3cue.htm#details
1539                                                                 [a-z0-9][a-z0-9][a-z0-9])
1540                                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.cue"
1541                                                                         ;;
1542                                                                 *)
1543                                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT.cue"
1544                                                                         ;;
1545                                                         esac
1546                                                 else
1547                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTFILEDIR/$CUEFILE"
1548                                                 fi
1549                                                 echo movecue-$OUTPUT >> "$ABCDETEMPDIR/status"
1550                                         fi
1551                                 fi
1552                         fi
1553                 fi
1554         done
1555 }
1556
1557 # do_playlist
1558 # Create the playlist if wanted
1559 # Variables used:
1560 # PLAYLISTFORMAT, PLAYLISTDATAPREFIX, VAPLAYLISTFORMAT, VAPLAYLISTDATAPREFIX,
1561 # VARIOUSARTISTS, OUTPUTDIR
1562 do_playlist ()
1563 {
1564         for TMPOUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1565         do
1566                 case $TMPOUTPUT in
1567                         vorbis|ogg)
1568                                 OUTPUT=$OGGOUTPUTCONTAINER
1569                                 ;;
1570                         opus)
1571                                 OUTPUT=$OPUSOUTPUTCONTAINER
1572                                 ;;
1573                         flac)
1574                                 OUTPUT=$FLACOUTPUTCONTAINER
1575                                 ;;
1576                         *)
1577                                 OUTPUT=$TMPOUTPUT
1578                                 ;;
1579                 esac
1580                 # Create a playlist file for the playlist data to go into.
1581                 # We used to wipe it out if it existed. Now we request permission if interactive.
1582                 for LASTTRACK in $TRACKQUEUE; do :; done
1583                 ALBUMFILE="$(mungefilename "$DALBUM")"
1584                 ARTISTFILE="$(mungefilename "$DARTIST")"
1585                 GENRE="$(mungegenre "$GENRE")"
1586                 YEAR=${CDYEAR:-$CDYEAR}
1587                 if [ "$VARIOUSARTISTS" = "y" ] ; then
1588                         PLAYLISTFILE="$(eval echo "$VAPLAYLISTFORMAT")"
1589                 else
1590                         PLAYLISTFILE="$(eval echo "$PLAYLISTFORMAT")"
1591                 fi
1592                 FINALPLAYLISTDIR="$(dirname "$OUTPUTDIR/$PLAYLISTFILE")"
1593                 mkdir -p "$FINALPLAYLISTDIR"
1594                 if [ -s "$OUTPUTDIR/$PLAYLISTFILE" ]; then
1595                         echo -n "Erase, Append to, or Keep the existing playlist file? [e/a/k] (e): " >&2
1596                         if [ "$INTERACTIVE" = "y" ]; then
1597                                 while [ "$DONE" != "y" ]; do
1598                                         read ERASEPLAYLIST
1599                                         case $ERASEPLAYLIST in
1600                                                 e|E|a|A|k|K) DONE=y ;;
1601                                                 "") ERASEPLAYLIST=e ; DONE=y ;;
1602                                                 *) ;;
1603                                         esac
1604                                 done
1605                         else
1606                                 echo e >&2
1607                                 ERASEPLAYLIST=e
1608                         fi
1609                         # Once we erase the playlist, we use append to create the new one.
1610                         [ "$ERASEPLAYLIST" = "e" -o "$ERASEPLAYLIST" = "E" ] && rm -f "$OUTPUTDIR/$PLAYLISTFILE" && ERASEPLAYLIST=a
1611                 else
1612                         # The playlist does not exist, so we can safelly use append to create the new list
1613                         ERASEPLAYLIST=a
1614                 fi
1615                 if [ "$ERASEPLAYLIST" = "a" -o "$ERASEPLAYLIST" = "A" ]; then
1616                         touch "$OUTPUTDIR/$PLAYLISTFILE"
1617                         for UTRACKNUM in $TRACKQUEUE
1618                         do
1619                                 # Shares some code with do_move since the filenames have to match
1620                                 CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
1621                                 getcddbinfo TRACKNAME
1622                                 splitvarious
1623                                 TRACKFILE="$(mungefilename "$TRACKNAME")"
1624                                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1625                                 ALBUMFILE="$(mungefilename "$DALBUM")"
1626                                 # If we want to start the tracks with a given number, we need to modify the
1627                                 # TRACKNUM value before evaluation
1628                                 gettracknum
1629                                 if [ "$VARIOUSARTISTS" = "y" ]; then
1630                                         OUTPUTFILE="$(eval echo \""$VAOUTPUTFORMAT\"")"
1631                                 else
1632                                         OUTPUTFILE="$(eval echo \""$OUTPUTFORMAT\"")"
1633                                 fi
1634                                 if [ "$VARIOUSARTISTS" = "y" ]; then
1635                                         if [ "$VAPLAYLISTDATAPREFIX" ] ; then
1636                                                 echo ${VAPLAYLISTDATAPREFIX}$OUTPUTFILE.$OUTPUT >> "$OUTPUTDIR/$PLAYLISTFILE"
1637                                         else
1638                                                 relpath "$PLAYLISTFILE", "$OUTPUTFILE.$OUTPUT" >> "$OUTPUTDIR/$PLAYLISTFILE"
1639                                         fi
1640                                 else
1641                                         if [ "$PLAYLISTDATAPREFIX" ]; then
1642                                                 echo ${PLAYLISTDATAPREFIX}$OUTPUTFILE.$OUTPUT >> "$OUTPUTDIR/$PLAYLISTFILE"
1643                                         else
1644                                                 relpath "$PLAYLISTFILE", "$OUTPUTFILE.$OUTPUT" >> "$OUTPUTDIR/$PLAYLISTFILE"
1645                                         fi
1646                                 fi
1647                         done
1648                 fi
1649                 ## this will convert the playlist to have CRLF line-endings, if specified
1650                 ## (some hardware players insist on CRLF endings)
1651                 if [ "$DOSPLAYLIST" = "y" ]; then
1652                         awk '{sub("\r$",""); printf "%s\r\n", $0}' "$OUTPUTDIR/$PLAYLISTFILE" > "$ABCDETEMPDIR/PLAYLISTFILE.tmp"
1653 #                       mv -f "$ABCDETEMPDIR/PLAYLISTFILE.tmp" "$OUTPUTDIR/$PLAYLISTFILE"
1654                         cat "$ABCDETEMPDIR/PLAYLISTFILE.tmp" | sed 's/\//\\/' > "$OUTPUTDIR/$PLAYLISTFILE"
1655                 fi
1656                 echo "playlistcomplete" >> "$ABCDETEMPDIR/status"
1657         done
1658 }
1659
1660 # abcde.cue2discid
1661 # This function reads a cuefile on stdin and writes an extended
1662 # cddb query on stdout.  Any PREGAP for track 1 is properly
1663 # handled, although cue files embedded in FLAC files do not
1664 # appear to properly store the PREGAP setting. :(
1665 abcde.cue2discid () {
1666
1667         cddb_sum () {
1668                 val=$1
1669                 ret=0
1670                 while [ $val -gt 0 ] ; do
1671                         ret=$(( $ret + ( $val % 10) ))
1672                         val=$(( $val / 10 ))
1673                 done
1674                 echo $ret
1675         }
1676
1677         msf2lba () {
1678                 OIFS="$IFS"
1679                 IFS=":"
1680                 set -- $1
1681                 IFS="$OIFS"
1682                 local first second third
1683                 first=$(expr ${1} + 0 )
1684                 second=$(expr ${2} + 0 )
1685                 third=$(expr ${3} + 0 )
1686
1687                 echo $(( ((($first * 60) + $second) * 75) + $third ))
1688         }
1689
1690         OFFSET=150
1691         PREGAP=0
1692         LEADOUT=0
1693         LEADIN=88200
1694         i=0
1695         N=0
1696
1697         while read line ; do
1698                 set -- $line
1699                 case "$1" in
1700                 TRACK)  i=$(( i + 1 ))
1701                         ;;
1702                 INDEX)  if [ "$2" -eq 1 ] ; then
1703                                 LBA=$(msf2lba $3)
1704                                 START=$(( $LBA + $PREGAP + $OFFSET ))
1705                                 eval TRACK$i=$START
1706                                 X=$(cddb_sum $(( $START / 75 )) )
1707                                 N=$(( $N + $X ))
1708                         fi
1709                         ;;
1710                 PREGAP) PREGAP=$(msf2lba $2)
1711                         ;;
1712                 REM)    case "$2" in
1713                         FLAC__lead-out)
1714                                 LEADOUT=$(( $4 / 588 ))
1715                                 ;;
1716                         FLAC__lead-in)
1717                                 LEADIN=$(( $3 / 588 ))
1718                                 ;;
1719                         esac
1720                         ;;
1721                 esac
1722
1723         done
1724
1725         TRACKS=$i
1726         LEADOUT=$(( $LEADOUT + $LEADIN ))
1727
1728         LENGTH=$(( $LEADOUT/75 - $TRACK1/75 ))
1729         DISCID=$(( ( $N % 255 ) * 2**24 | $LENGTH * 2**8 | $TRACKS ))
1730         printf "%08x %i" $DISCID $TRACKS
1731
1732         j=1
1733         while [ $j -le $TRACKS ] ; do
1734                 eval echo -n "\" \$TRACK$j\""
1735                 j=$((j+1))
1736         done
1737         echo " $(( $LEADOUT / 75 ))"
1738 }
1739
1740 # abcde.mkcue
1741 # abcde.mkcue [--wholedisk]
1742 # This creates a cuefile directly from the extended discid information
1743 # The --wholedisk option controls whether we're ripping data from the
1744 # start of track one or from the start of the disk (usually, but not
1745 # always the same thing!)
1746 #
1747 # Track one leadin/pregap (if any) handeling:
1748 # --wholedisk specified:
1749 #   TRACK 01 AUDIO
1750 #     INDEX 00 00:00:00
1751 #     INDEX 01 <pregap value>
1752 #   Remaining track index values unchanged from disc TOC
1753 #
1754 # --wholedisk not specified
1755 #   TRACK 01 AUDIO
1756 #     PREGAP <pregap value>
1757 #     INDEX 01 00:00:00
1758 #   Remaining track index values offset by <pregap value>
1759 #
1760 # Variables used:
1761 # TRACKINFO
1762 abcde.mkcue () {
1763
1764         echomsf () {
1765                 printf "$1%02i:%02i:%02i\n" $(($2/4500)) $((($2/75)%60)) $(($2%75))
1766         }
1767
1768         local MODE DISCID TRACKS
1769         local i OFFSET LBA
1770         local CUEWAVFILE
1771
1772         if [ "$1" = --wholedisc ] ; then
1773                 MODE=INDEX
1774         else
1775                 MODE=PREGAP
1776         fi
1777
1778         vecho "One track is $ONETRACK"
1779         TRACKFILE="$(mungefilename "$TRACKNAME")"
1780         ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1781         ALBUMFILE="$(mungefilename "$DALBUM")"
1782         if [ "$ONETRACK" = "y" ]; then
1783                 if [ "$VARIOUSARTISTS" = "y" ]; then
1784                         CUEWAVFILE="$(eval echo \""$VAONETRACKOUTPUTFORMAT"\" | sed -e 's@^.*/@@').$OUTPUT"
1785                 else
1786                         CUEWAVFILE="$(eval echo \""$ONETRACKOUTPUTFORMAT"\" | sed -e 's@^.*/@@').$OUTPUT"
1787                 fi
1788                 vecho "Cue wav file is $CUEWAVFILE"
1789         else
1790                 CUEWAVFILE="dummy.wav"
1791         fi
1792
1793         set -- $TRACKINFO
1794
1795         DISCID=$1
1796         TRACKS=$2
1797         shift 2
1798
1799         echo REM DISCID $DISCID
1800         echo FILE \""$CUEWAVFILE"\" WAVE
1801
1802         if [ $1 -ne 150 ] && [ $MODE = "PREGAP" ] ; then
1803                 OFFSET=$1
1804         else
1805                 OFFSET=150
1806         fi
1807
1808         i=1
1809         while [ $i -le "$TRACKS" ] ; do
1810                 LBA=$(( $1 - $OFFSET ))
1811                 printf "  TRACK %02i AUDIO\n" $i
1812                 if [ $i -eq 1 -a $1 -ne 150 ] ; then
1813                         if [ $MODE = PREGAP ] ; then
1814                                 echomsf "    PREGAP " $(($OFFSET-150))
1815                         else
1816                                 echo    "    INDEX 00 00:00:00"
1817                         fi
1818                 fi
1819                 echomsf "    INDEX 01 " $LBA
1820                 i=$(($i+1))
1821                 shift
1822         done
1823 }
1824
1825 # do_discid
1826 # This essentially the start of things
1827 do_discid ()
1828 {
1829         # Query the CD to get the track info, unless the user specified -C
1830         # or we are using some actions which do not need the CDDB data at all
1831         #if [ ! X"$EXPACTIONS" = "X" ]; then
1832         #       :
1833         #elif [ -z "$DISCID" ]; then
1834         if [ -z "$DISCID" ]; then
1835                 vecho -n "Getting CD track info... "
1836                 # In OSX, unmount the disc before a query
1837                 if [ "$OSFLAVOUR" = "OSX" ]; then
1838                         diskutil unmount ${CDROM#/dev/}
1839                 fi
1840                 case "$CDROMREADERSYNTAX" in
1841                         flac)
1842                                 if $METAFLAC $METAFLACOPTS --export-cuesheet-to=- "$CDROM" > /dev/null 2>&1 ; then
1843                                         case "$CUE2DISCID" in
1844                                                 # FIXME # right now we have 2 cue2discid internal
1845                                                 # implementations: builtin and abcde.cue2discid. Test
1846                                                 # both of them and decide which one we want to use.
1847                                                 builtin)
1848                                                         #vecho "Using builtin cue2discid implementation..."
1849                                                         CUESHEET="$(metaflac $METAFLACOPTS --export-cuesheet-to=- "$CDROM")"
1850
1851                                                         #TRACKS=$(echo $CUESHEET | grep -E "TRACK \+[[:digit:]]\+ \+AUDIO" |wc -l)
1852                                                         #TRACKS=0
1853                                                         OFFSETTIMES=( $(echo "$CUESHEET" | sed -n -e's/\ *INDEX 01\ \+//p' ) )
1854                                                         TRACKS=${#OFFSETTIMES[@]}
1855                                                         unset OFFSETS
1856                                                         #echo "processing offsetimes ${OFFSETTIMES[@]}"
1857                                                         for OFFSETTIME in ${OFFSETTIMES[@]}; do
1858                                                                 OFFSETS="$OFFSETS $(( 10#${OFFSETTIME:0:2} * 4500 + 10#${OFFSETTIME:3:2} * 75 + 10#${OFFSETTIME:6:2} ))"
1859                                                                 #OFFSETS[${#OFFSETS[*]}]=$(( 10#${OFFSETTIME:0:2} * 4500 + 10#${OFFSETTIME:3:2} * 75 + 10#${OFFSETTIME:6:2} ))
1860                                                         done
1861
1862                                                         LEADOUT=$(( $(echo "$CUESHEET" | grep lead-out | get_last) * 75 / 44100 ))
1863                                                         LEADIN=$(( $(echo "$CUESHEET" | grep lead-in | get_last) * 75 / 44100 ))
1864                                                         makeids
1865                                                 ;;
1866                                                 *)
1867                                                         #vecho "Using external python cue2discid implementation..."
1868                                                         TRACKINFO=$($METAFLAC $METAFLACOPTS --export-cuesheet-to=- "$CDROM" | $CUE2DISCID)
1869                                                 ;;
1870                                         esac
1871                                 else
1872                                         log error "the input flac file does not contain a cuesheet."
1873                                         exit 1
1874                                 fi
1875                                 ;;
1876 #                       cdparanoia|debug)
1877 #                               CDPARANOIAOUTPUT="$( $CDROMREADER -$CDPARANOIACDROMBUS "$CDROM" -Q --verbose 2>&1 )"
1878 #                               RET=$?
1879 #                               if [ ! "$RET" = "0" ];then
1880 #                                       log warning "something went wrong while querying the CD... Maybe a DATA CD?"
1881 #                               fi
1882 #
1883 #                               TRACKS="$(echo "$CDPARANOIAOUTPUT" | grep -E '^[[:space:]]+[[:digit:]]' | tail -n 1 | get_first | tr -d "." | tr '\n' ' ')"
1884 #                               CDPARANOIAAUDIOTRACKS="$TRACKS"
1885 #
1886 #                               LEADOUT="$(echo "$CDPARANOIAOUTPUT" | grep -Eo '^TOTAL[[:space:]]+([[:digit:]]+)' | get_last)"
1887 #                               OFFSETS="$(echo "$CDPARANOIAOUTPUT" | sed -n -e's/^ .* \([0-9]\+\) \[.*/\1/p')"
1888 #                               makeids
1889 #                               ;;
1890                         *)
1891                                 case "$CDDBMETHOD" in
1892                                         cddb) TRACKINFO=$($CDDISCID "$CDROM") ;;
1893                                         musicbrainz) TRACKINFO=$($MUSICBRAINZ --command id --device "$CDROM") ;;
1894                                 esac
1895                                 ;;
1896                 esac
1897                 # Make sure there's a CD in there by checking cd-discid's return code
1898                 if [ ! "$?" = "0" ]; then
1899                         if [ "$CDROMREADERSYNTAX" = "flac" ] ; then
1900                                 log error "cuesheet information from the flac file could not be read."
1901                                 log error "Perhaps the flac file does not contain a cuesheet?."
1902                                 exit 1
1903                         else
1904                                 log error "CD could not be read. Perhaps there's no CD in the drive?"
1905                                 exit 1
1906                         fi
1907                 fi
1908                 # In OSX, remount the disc again
1909                 if [ "$OSFLAVOUR" = "OSX" ]; then
1910                         diskutil mount ${CDROM#/dev/}
1911                 fi
1912                 WEHAVEACD=y
1913                 DISCID=$(echo $TRACKINFO | cut -f1 -d' ')
1914         else
1915                 TRACKINFO=$(cat "$WAVOUTPUTDIR/abcde.$DISCID/discid")
1916         fi
1917
1918         # Get a full enumeration of tracks, sort it, and put it in the TRACKQUEUE.
1919         # This needs to be done now because a section of the resuming code will need
1920         # it later.
1921
1922         # get the number of digits to pad TRACKNUM with - we'll use this later
1923         # a CD can only hold 99 tracks, but since we support a feature for starting
1924         # numbering the tracks from a given number, we might need to set it as a
1925         # variable for the user to define... or obtain it somehow.
1926         if [ "$PADTRACKS" = "y" ] ; then
1927                 TRACKNUMPADDING=2
1928         fi
1929
1930         ABCDETEMPDIR="$WAVOUTPUTDIR/abcde.$(echo $TRACKINFO | cut -f1 -d' ')"
1931         if [ -z "$TRACKQUEUE" ]; then
1932                 if [ ! "$STRIPDATATRACKS" = "n" ]; then
1933                         case "$CDROMREADERSYNTAX" in
1934                                 cdparanoia|debug)
1935                                         if [ "$WEHAVEACD" = "y" ]; then
1936                                                 vecho "Querying the CD for audio tracks..."
1937                                                 CDPARANOIAOUTPUT="$( $CDROMREADER -$CDPARANOIACDROMBUS "$CDROM" -Q --verbose 2>&1 )"
1938                                                 RET=$?
1939                                                 if [ ! "$RET" = "0" ];then
1940                                                         log warning "something went wrong while querying the CD... Maybe a DATA CD?"
1941                                                 fi
1942                                                 TRACKS="$(echo "$CDPARANOIAOUTPUT" | grep -E '^[[:space:]]+[[:digit:]]' | tail -n 1 | get_first | tr -d "." | tr '\n' ' ')"
1943                                                 CDPARANOIAAUDIOTRACKS="$TRACKS"
1944                                         else
1945                                                 # Previous versions of abcde would store the tracks on a file, instead of the status record.
1946                                                 if [ -f "$ABCDETEMPDIR/cdparanoia-audio-tracks" ]; then
1947                                                         echo cdparanoia-audio-tracks=$( cat "$ABCDETEMPDIR/cdparanoia-audio-tracks" ) >> "$ABCDETEMPDIR/status"
1948                                                         rm -f "$ABCDETEMPDIR/cdparanoia-audio-tracks"
1949                                                 fi
1950                                                 if [ -f "$ABCDETEMPDIR/status" ] && TRACKS=$(checkstatus cdparanoia-audio-tracks); then :; else
1951                                                         TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1952                                                 fi
1953                                         fi
1954                                         ;;
1955                                 *)      TRACKS=$(echo $TRACKINFO | cut -f2 -d' ') ;;
1956                         esac
1957                 else
1958                         TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1959                 fi
1960                 if echo "$TRACKS" | grep "[[:digit:]]" > /dev/null 2>&1 ;then :;else
1961                         log info "The disc does not contain any tracks. Giving up..."
1962                         exit 0
1963                 fi
1964                 echo -n "Grabbing entire CD - tracks: "
1965                 if [ ! "$PADTRACKS" = "y" ] ; then
1966                         TRACKNUMPADDING=$(echo -n $TRACKS | wc -c | tr -d ' ')
1967                 fi
1968                 TRACKS=$(printf "%0.${TRACKNUMPADDING}d" $TRACKS)
1969                 X=0
1970                 while [ "$X" -ne "$TRACKS" ]
1971                 do
1972                         X=$(printf "%0.${TRACKNUMPADDING}d" $(expr $X + 1))
1973                         TRACKQUEUE=$(echo $TRACKQUEUE $X)
1974                 done
1975                 echo $TRACKQUEUE
1976         else
1977                 TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1978                 # User-supplied track queue.
1979                 # Weed out non-numbers, whitespace, then sort and weed out duplicates
1980                 TRACKQUEUE=$(echo $TRACKQUEUE | sed 's-[^0-9 ]--g' | tr ' ' '\n' | grep -v ^$ | sort -n | uniq | tr '\n' ' ' | sed 's- $--g')
1981                 # Once cleaned, obtain the highest value in the trackqueue for number padding
1982                 for LASTTRACK in $TRACKQUEUE; do :; done
1983                 if [ ! "$PADTRACKS" = "y" ] ; then
1984                         TRACKNUMPADDING=$(echo -n $LASTTRACK | wc -c | tr -d ' ')
1985                 fi
1986                 # Now we normalize the trackqueue
1987                 for TRACK in $TRACKQUEUE ; do
1988                         TRACKNUM=$(printf %0.${TRACKNUMPADDING}d $(expr ${TRACK} + 0 ))
1989                         PADTRACKQUEUE=$(echo $PADTRACKQUEUE $TRACKNUM)
1990                 done
1991                 TRACKQUEUE=$PADTRACKQUEUE
1992                 echo Grabbing tracks: "$TRACKQUEUE"
1993         fi
1994
1995         QUEUEDTRACKS=$(echo $TRACKQUEUE | wc -w | tr -d ' ')
1996
1997         # We have the discid, create a temp directory after it to store all the temp
1998         # info
1999
2000         if [ -e "$ABCDETEMPDIR" ]; then
2001                 echo -n "abcde: attempting to resume from $ABCDETEMPDIR"
2002                 # It already exists, see if it's a directory
2003                 if [ ! -d "$ABCDETEMPDIR" ]; then
2004                         # This is a file/socket/fifo/device/etc, not a directory
2005                         # Complain and exit
2006                         echo >&2
2007                         echo "abcde: file $ABCDETEMPDIR already exists and does not belong to abcde." >&2
2008                         echo "Please investigate, remove it, and rerun abcde." >&2
2009                         exit 1
2010                 fi
2011                 echo -n .
2012                 # It's a directory, let's see if it's writable by us
2013                 if [ ! -r "$ABCDETEMPDIR" ] || [ ! -w "$ABCDETEMPDIR" ] || [ ! -x "$ABCDETEMPDIR" ]; then
2014                         # Nope, complain and exit
2015                         echo >&2
2016                         echo "abcde: directory $ABCDETEMPDIR already exists and is not writeable." >&2
2017                         echo "Please investigate, remove it, and rerun abcde." >&2
2018                         exit 1
2019                 fi
2020                 echo .
2021                 # See if it's populated
2022                 if [ ! -f "$ABCDETEMPDIR/discid" ]; then
2023                         # Wipe and start fresh
2024                         echo "abcde: $ABCDETEMPDIR/discid not found. Abcde must remove and recreate" >&2
2025                         echo -n "this directory to continue. Continue [y/N]? " >&2
2026                         if [ "$INTERACTIVE" = "y" ]; then
2027                                 read ANSWER
2028                         else
2029                                 echo y >&2
2030                                 ANSWER=y
2031                         fi
2032                         if [ "$ANSWER" != "y" ]; then
2033                                 exit 1
2034                         fi
2035                         rm -rf "$ABCDETEMPDIR" || exit 1
2036                         mkdir -p "$ABCDETEMPDIR"
2037                         if [ "$?" -gt "0" ]; then
2038                                 # Directory already exists or could not be created
2039                                 echo "abcde: Temp directory $ABCDETEMPDIR could not be created." >&2
2040                                 exit 1
2041                         fi
2042                 else
2043                         # Everything is fine. Check for ^encodetracklocation-
2044                         # and encode-output entries in the status file and
2045                         # remove them. These are not relevant across sessions.
2046                         if [ -f "$ABCDETEMPDIR/status" ]; then
2047                                 mv "$ABCDETEMPDIR/status" "$ABCDETEMPDIR/status.old"
2048                                 grep -v ^encodetracklocation- < "$ABCDETEMPDIR/status.old" \
2049                                         | grep -v ^encode-output > "$ABCDETEMPDIR/status"
2050                         fi
2051                         # Remove old error messages
2052                         if [ -f "$ABCDETEMPDIR/errors" ]; then
2053                                 rm -f "$ABCDETEMPDIR/errors"
2054                         fi
2055                 fi
2056         else
2057                 # We are starting from scratch
2058                 mkdir -p "$ABCDETEMPDIR"
2059                 if [ "$?" -gt "0" ]; then
2060                         # Directory already exists or could not be created
2061                         echo "abcde: Temp directory $ABCDETEMPDIR could not be created." >&2
2062                         exit 1
2063                 fi
2064                 cat /dev/null > "$ABCDETEMPDIR/status"
2065                 # Store the abcde version in the status file.
2066                 echo "abcde-version=$VERSION" >> "$ABCDETEMPDIR/status"
2067         fi
2068         if [ X"$DOCUE" = "Xy" -a X"$WEHAVEACD" = "Xy" ]; then
2069                 if checkstatus cuefile > /dev/null 2>&1 ; then :; else
2070                         CUEFILE=cue-$(echo "$TRACKINFO" | cut -f1 -d' ').txt
2071                         vecho "Creating cue file..."
2072                         case $CDROMREADERSYNTAX in
2073                                 flac)
2074                                         if $METAFLAC --export-cuesheet-to=- "$CDROM" > "$ABCDETEMPDIR/$CUEFILE"; then
2075                                                 echo cuefile=$CUEFILE >> "$ABCDETEMPDIR/status"
2076                                         else
2077                                                 log warning "the input flac file does not contain a cuesheet."
2078                                         fi
2079                                         ;;
2080                                 *)
2081                                         if $CUEREADER $CUEREADEROPTS > "$ABCDETEMPDIR/$CUEFILE"; then
2082                                                 echo cuefile=$CUEFILE >> "$ABCDETEMPDIR/status"
2083                                         else
2084                                                 log warning "reading the CUE sheet is still considered experimental"
2085                                                 log warning "and there was a problem with the CD reading. abcde will continue,"
2086                                                 log warning "but consider reporting the problem to the abcde author"
2087                                         fi
2088                                         ;;
2089                         esac
2090                 fi
2091         fi
2092         # If we got the CDPARANOIA status and it is not recorded, save it now
2093         if [ -n "$CDPARANOIAAUDIOTRACKS" ]; then
2094                 if checkstatus cdparanoia-audio-tracks > /dev/null 2>&1; then :; else
2095                         echo cdparanoia-audio-tracks=$CDPARANOIAAUDIOTRACKS >> "$ABCDETEMPDIR/status"
2096                 fi
2097         fi
2098
2099         # Create the discid file
2100         echo "$TRACKINFO" > "$ABCDETEMPDIR/discid"
2101         if checkstatus cddbmethod > /dev/null 2>&1 ; then :; else
2102                 echo "cddbmethod=$CDDBMETHOD" >> "$ABCDETEMPDIR/status"
2103         fi
2104 }
2105
2106 # do_cleancue
2107 # Create a proper CUE file based on the CUE file we created before.
2108 do_cleancue()
2109 {
2110         if CUEFILE_IN="$ABCDETEMPDIR"/$(checkstatus cuefile); then
2111                 CUEFILE_OUT=$CUEFILE_IN.out
2112                 ### FIXME ### checkstatus cddb
2113                 if [ -e "$CDDBDATA" ]; then
2114                         vecho "Adding metadata to the cue file..."
2115                         # FIXME It doesn't preserve spaces! Why?
2116                         # FIXME parse $track into PERFORMER and TITLE - abcde already has code for this?
2117                         n=1
2118                         echo "PERFORMER \"$DARTIST\"" >> "$CUEFILE_OUT"
2119                         echo "TITLE \"$DALBUM\"" >> "$CUEFILE_OUT"
2120                         # Set IFS to <newline> to prevent read from swallowing spaces and tabs
2121                         OIFS="$IFS"
2122                         IFS='
2123 '
2124                         cat "$CUEFILE_IN" | while read line
2125                         do
2126                                 if echo "$line" | grep "INDEX 01" > /dev/null 2>&1 ; then
2127 # FIXME # Possible patch: remove the line above, uncomment the 2 lines below.
2128 #                               echo "$line" >> "$CUEFILE_OUT"
2129 #                               if echo "$line" | grep "^[[:space:]]*TRACK" > /dev/null 2>&1 ; then
2130                                         eval track="\$TRACK$n"
2131                                         n=$(expr $n + 1)
2132                                         echo "    TITLE \"$track\"" >> "$CUEFILE_OUT"
2133                                 # When making a single-track rip, put the
2134                                 # actual file name into the file declaration
2135                                 # in the cue file so that it is usable by
2136                                 # music players and the like
2137                                 elif [ "$ONETRACK" = "y" ] &&
2138                                                 echo "$line" | grep '^FILE "dummy.wav" WAVE' > /dev/null 2>&1 ; then
2139
2140                                         TRACKFILE="$(mungefilename "$TRACKNAME")"
2141                                         ARTISTFILE="$(mungefilename "$TRACKARTIST")"
2142                                         ALBUMFILE="$(mungefilename "$DALBUM")"
2143
2144                                         if [ "$VARIOUSARTISTS" = "y" ]; then
2145                                                 OUTPUTFILE="$(eval echo \""$VAONETRACKOUTPUTFORMAT"\" | sed -e 's@^.*/@@').$OUTPUT"
2146                                         else
2147                                                 OUTPUTFILE="$(eval echo \""$ONETRACKOUTPUTFORMAT"\" | sed -e 's@^.*/@@').$OUTPUT"
2148                                         fi
2149
2150                                         echo "FILE \"$OUTPUTFILE\" WAVE" >> "$CUEFILE_OUT"
2151                                         continue
2152                                 fi
2153 # FIXME # If the lines above are uncommented, remove the line below.
2154                                 echo "$line" >> "$CUEFILE_OUT"
2155                         done
2156                         IFS="$OIFS"
2157                         mv "$CUEFILE_OUT" "$CUEFILE_IN"
2158                         echo "cleancuefile" >> "$ABCDETEMPDIR/status"
2159                 fi
2160         fi
2161 }
2162
2163 # do_cddbparse
2164 # Parses a CDDB file and outputs the title and the track names.
2165 # Variables: CDDBFILE
2166 do_cddbparse ()
2167 {
2168         CDDBPARSEFILE="$1"
2169         # List out disc title/author and contents
2170         if [ "$ONETRACK" = "y" ]; then
2171                 vecho "ONETRACK mode selected: displaying only the title of the CD..."
2172         fi
2173         echo "---- $(grep DTITLE "${CDDBPARSEFILE}" | cut '-d=' -f2- | tr -d \\r\\n ) ----"
2174         if [ X"$SHOWCDDBYEAR" = "Xy" ]; then
2175                 PARSEDYEAR=$(grep DYEAR "${CDDBPARSEFILE}" | cut '-d=' -f2-)
2176                 if [ ! X"$PARSEDYEAR" = "X" ]; then
2177                         echo "Year: $PARSEDYEAR"
2178                 fi
2179         fi
2180         if [ X"$SHOWCDDBGENRE" = "Xy" ]; then
2181                 PARSEDGENRE=$(grep DGENRE "${CDDBPARSEFILE}" | cut '-d=' -f2-)
2182                 if [ ! X"$PARSEDGENRE" = "X" ]; then
2183                         echo "Genre: $PARSEDGENRE"
2184                 fi
2185         fi
2186         if [ ! "$ONETRACK" = "y" ]; then
2187                 for TRACK in $(f_seq_row 1 $TRACKS)
2188                 do
2189                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "${CDDBPARSEFILE}" | cut -f2- -d= | tr -d \\r\\n)"
2190                 done
2191         fi
2192 }
2193
2194 # do_localcddb
2195 # Check for a local CDDB file, and report success
2196 do_localcddb ()
2197 {
2198         if checkstatus cddb-readcomplete && checkstatus cddb-choice >/dev/null; then :; else
2199
2200                 CDDBLOCALSTATUS="notfound"
2201                 CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
2202                 USELOCALRESP="y"
2203
2204                 if [ "$CDDBLOCALRECURSIVE" = "y" ]; then
2205                         CDDBLOCALRESULTS="$(find ${CDDBLOCALDIR} -name "${CDDBDISCID}" -type f 2> /dev/null)"
2206                         if [ ! "${CDDBLOCALRESULTS}" = "" ]; then
2207                                 if   (( $(echo "${CDDBLOCALRESULTS}" | wc -l) == 1 )); then
2208                                         CDDBLOCALFILE="${CDDBLOCALRESULTS}"
2209                                         CDDBLOCALMATCH=single
2210                                 elif (( $(echo "${CDDBLOCALRESULTS}" | wc -l) > 1 )); then
2211                                         CDDBLOCALMATCH=multiple
2212                                 fi
2213                         else
2214                                 CDDBLOCALMATCH=none
2215                         fi
2216                 elif [ "$CDDBLOCALMATCH" = "none" ] && [ -r "${CDDBLOCALDIR}/${CDDBDISCID}" ]; then
2217                         CDDBLOCALFILE="${CDDBLOCALDIR}/${CDDBDISCID}"
2218                         CDDBLOCALMATCH=single
2219                 else
2220                         CDDBLOCALMATCH=none
2221                 fi
2222
2223                 # If the user has selected to check a local CDDB repo, we proceed with it
2224                 case $CDDBLOCALMATCH in
2225                         multiple)
2226                                 echo "Processing multiple matching CDDB entries..." > "$ABCDETEMPDIR/cddblocalchoices"
2227                                 X=0
2228                                 echo "$CDDBLOCALRESULTS" | while read RESULT ; do
2229                                         X=$(expr $X + 1)
2230                                         # List out disc title/author and contents
2231                                         CDDBLOCALREAD="$ABCDETEMPDIR/cddblocalread.$X"
2232                                         cat "$RESULT" > "${CDDBLOCALREAD}"
2233                                         {
2234                                                 echo -n "#$X: "
2235                                                 do_cddbparse "${CDDBLOCALREAD}"
2236                                                 echo ""
2237                                                 ##FIXME## QUICK HACK !!!!
2238                                                 if [ ! "$INTERACTIVE" = "y" ]; then break ; fi
2239                                         } >> "$ABCDETEMPDIR/cddblocalchoices"
2240                                 done
2241                                 if [ $(cat "$ABCDETEMPDIR/cddblocalchoices" | wc -l) -ge 24 ] && [ "$INTERACTIVE" = "y" ]; then
2242                                         page "$ABCDETEMPDIR/cddblocalchoices"
2243                                 else
2244                                         # It's all going to fit in one page, cat it
2245                                         cat "$ABCDETEMPDIR/cddblocalchoices" >&2
2246                                 fi
2247                                 CDDBLOCALCHOICES=$( echo "$CDDBLOCALRESULTS" | wc -l )
2248                                 # Setting the choice to an impossible integer to avoid errors in the numeric comparisons
2249                                 CDDBLOCALCHOICENUM=-1
2250                                 if [ "$INTERACTIVE" = "y" ]; then
2251                                         while [ $CDDBLOCALCHOICENUM -lt 0 ] || [ $CDDBLOCALCHOICENUM -gt $CDDBLOCALCHOICES ]; do
2252                                                 echo -n "Locally cached CDDB entries found. Which one would you like to use (0 for none)? [0-$CDDBLOCALCHOICES]: " >&2
2253                                                 read CDDBLOCALCHOICE
2254                                                 [ x"$CDDBLOCALCHOICE" = "x" ] && CDDBLOCALCHOICE="1"
2255                                                 # FIXME # Introduce diff's
2256                                                 if echo $CDDBLOCALCHOICE | grep -E "[[:space:]]*[[:digit:]]+,[[:digit:]]+[[:space:]]*" > /dev/null 2>&1 ; then
2257                                                         diffentries cddblocalread "$CDDBLOCALCHOICES" "$CDDBLOCALCHOICE"
2258                                                 elif echo $CDDBLOCALCHOICE | grep -E "[[:space:]]*[[:digit:]]+[[:space:]]*" > /dev/null 2>&1 ; then
2259                                                         # Make sure we get a valid choice
2260                                                         CDDBLOCALCHOICENUM=$(echo $CDDBLOCALCHOICE | xargs printf %d 2>/dev/null)
2261                                                         if [ $CDDBLOCALCHOICENUM -lt 0 ] || [ $CDDBLOCALCHOICENUM -gt $CDDBLOCALCHOICES ]; then
2262                                                                 echo "Invalid selection. Please choose a number between 0 and $CDDBLOCALCHOICES." >&2
2263                                                         fi
2264                                                 fi
2265                                         done
2266                                 else
2267                                         ### FIXME ###
2268                                         #echo "Selected ..."
2269                                         CDDBLOCALRESP=y
2270                                         CDDBLOCALCHOICENUM=1
2271                                 fi
2272                                 if [ ! "$CDDBLOCALCHOICENUM" = "0" ]; then
2273                                         #echo "Using local copy of CDDB data"
2274                                         echo "# DO NOT ERASE THIS LINE! Added by abcde to imitate cddb output" > "$ABCDETEMPDIR/cddbread.1"
2275                                         cat "$ABCDETEMPDIR/cddblocalread.$CDDBLOCALCHOICENUM" >> "$ABCDETEMPDIR/cddbread.1"
2276                                         echo 999 > "$ABCDETEMPDIR/cddbquery" # Assuming 999 isn't used by CDDB
2277                                         echo cddb-readcomplete >> "$ABCDETEMPDIR/status"
2278                                         do_cddbparse "$ABCDETEMPDIR/cddbread.1" > "$ABCDETEMPDIR/cddbchoices"
2279                                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2280                                         CDDBLOCALSTATUS="found"
2281                                 else
2282                                         #echo "Not using local copy of CDDB data"
2283                                         CDDBLOCALSTATUS="notfound"
2284                                 fi
2285                                 ;;
2286                         single)
2287                                 # List out disc title/author and contents
2288                                 do_cddbparse "${CDDBLOCALFILE}"
2289                                 #if [ "$CDROMREADERSYNTAX" = "flac" ] ; then
2290                                 #       echo -n "Embedded cuesheet entry found, use it [Y/n]? " >&2
2291                                 #else
2292                                         echo -n "Locally cached CDDB entry found, use it [Y/n]? " >&2
2293                                 #fi
2294                                 if [ "$INTERACTIVE" = "y" ]; then
2295                                         read USELOCALRESP
2296                                         while [ "$USELOCALRESP" != "y" ] && [ "$USELOCALRESP" != "n" ] && [ "$USELOCALRESP" != "" ] ; do
2297                                                 echo -n 'Invalid selection. Please answer "y" or "n": ' >&2
2298                                                 read USELOCALRESP
2299                                         done
2300                                         [ x"$USELOCALRESP" = "x" ] && USELOCALRESP="y"
2301                                 else
2302                                         echo "y" >&2
2303                                 fi
2304                                 if [ "$USELOCALRESP" = "y" ]; then
2305                                         #echo "Using local copy of CDDB data"
2306                                         echo "# DO NOT ERASE THIS LINE! Added by abcde to imitate cddb output" > "$ABCDETEMPDIR/cddbread.1"
2307                                         cat "${CDDBLOCALFILE}" >> "$ABCDETEMPDIR/cddbread.1"
2308                                         echo 999 > "$ABCDETEMPDIR/cddbquery" # Assuming 999 isn't used by CDDB
2309                                         echo cddb-readcomplete >> "$ABCDETEMPDIR/status"
2310                                         do_cddbparse "${CDDBLOCALFILE}" > "$ABCDETEMPDIR/cddbchoices"
2311                                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2312                                         CDDBLOCALSTATUS="single"
2313                                 else
2314                                         #echo "Not using local copy of CDDB data"
2315                                         CDDBLOCALSTATUS="notfound"
2316                                 fi
2317                                 ;;
2318                         none)
2319                                 CDDBLOCALSTATUS="notfound"
2320                                 ;;
2321                 esac
2322         fi
2323 }
2324
2325 # do_cdtext
2326 # Try to read CD-Text from the drive using icedax / cdda2wav
2327 do_cdtext ()
2328 {
2329         if new_checkexec icedax; then
2330                 CDTEXT_READER=icedax
2331         elif new_checkexec cdda2wav; then
2332                 CDTEXT_READER=cdda2wav
2333     else
2334                 # Didn't find either, bail
2335                 return 0
2336         fi
2337
2338         if [ "$OSFLAVOUR" = "OSX" ] ; then
2339                 # Hei, we have to unmount the device before running anything like cdda2wav/icedax in OSX
2340                 diskutil unmount ${CDROM#/dev/}
2341                 # Also, in OSX the cdrom device for cdda2wav/icedax changes...
2342                 CDDA2WAVCDROM="IODVDServices"
2343         elif [ "$OSFLAVOUR" = "FBSD" ] ; then
2344                 CDDA2WAVCDROM="$CDROMID"
2345         else
2346                 if [ "$CDROMID" = "" ]; then
2347                         CDDA2WAVCDROM="$CDROM"
2348                 else
2349                         CDDA2WAVCDROM="$CDROMID"
2350                 fi
2351         fi
2352
2353         # Do we have CD-Text on the disc (and can the drive read it?)
2354         ${CDTEXT_READER} -J -N -D ${CDDA2WAVCDROM} > "$ABCDETEMPDIR/cd-text" 2>&1
2355         grep -q '^CD-Text: detected' "$ABCDETEMPDIR/cd-text"
2356         ERRORCODE=$?
2357         if [ $ERRORCODE -ne 0 ]; then
2358                 # No CD-Text found, bail
2359                 return 0
2360         fi
2361
2362         rm -f "$ABCDETEMPDIR/cddbchoices"
2363         CDDBCHOICES=1
2364         # Make an empty template
2365         $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.1"
2366         echo -n "Retrieved 1 CD-Text match..." >> "$ABCDETEMPDIR/cddbchoices"
2367         echo "done." >> "$ABCDETEMPDIR/cddbchoices"
2368         echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
2369         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2370         ATITLE=$(grep -e '^Album title:' "${ABCDETEMPDIR}/cd-text" | cut -c14- )
2371         echo "200 none ${ATITLE}" >> "$ABCDETEMPDIR/cddbquery"
2372         # List out disc title/author and contents
2373         echo ---- ${ATITLE} ---- >> "$ABCDETEMPDIR/cddbchoices"
2374         for TRACK in $(f_seq_row 1 $TRACKS)
2375         do
2376                 TRACKM1=$(($TRACK - 1))
2377                 TITLE="$(grep -E ^Track\ +$TRACK: "$ABCDETEMPDIR/cd-text" | tr -d \\r\\n | sed 's~^Track ..: .~~g;'"s~'$~~g")"
2378                 echo "$TRACK: $TITLE" >> "$ABCDETEMPDIR/cddbchoices"
2379                 sed "s~^TTITLE${TRACKM1}=.*~TTITLE${TRACKM1}=${TITLE}~" "$ABCDETEMPDIR/cddbread.1" > "$ABCDETEMPDIR/cddbread.new"
2380         mv -f "$ABCDETEMPDIR/cddbread.new" "$ABCDETEMPDIR/cddbread.1"
2381         done
2382         sed "s~^DTITLE=.*~DTITLE=${ATITLE}~" "$ABCDETEMPDIR/cddbread.1" > "$ABCDETEMPDIR/cddbread.new"
2383     mv -f "$ABCDETEMPDIR/cddbread.new" "$ABCDETEMPDIR/cddbread.1"
2384         echo >> "$ABCDETEMPDIR/cddbchoices"
2385         echo "cdtext-readcomplete" >> "$ABCDETEMPDIR/status"
2386 }
2387
2388 # do_musicbrainz
2389 # Work with the musicbrainz WS API, then transform the results here so
2390 # they look (very) like the results from CDDB. Maybe not the best way
2391 # to go, but it Works For Me (TM)
2392
2393 do_musicbrainz ()
2394 {
2395         if checkstatus musicbrainz-readcomplete; then :; else
2396                 vecho "Obtaining Musicbrainz results..."
2397                 # If MB is to be used, interpret the query results and read all
2398                 # the available entries.
2399                 rm -f "$ABCDETEMPDIR/cddbchoices"
2400                 CDDBCHOICES=1 # Overridden by multiple matches
2401                 MBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
2402                 ${MUSICBRAINZ} --command data --discid "$MBDISCID" --workdir "$ABCDETEMPDIR"
2403
2404                 # The helper script will write disc matches out to
2405                 # cddbread.*. Count how many we have
2406                 if [ ! -f "${ABCDETEMPDIR}/cddbread.1" ] ; then
2407                         # No matches. Use the normal cddb template for the user to
2408                         # fill in
2409                         echo "No Musicbrainz match." >> "$ABCDETEMPDIR/cddbchoices"
2410                         $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
2411                         # List out disc title/author and contents of template
2412                         echo ---- Unknown Artist / Unknown Album ---- >> "$ABCDETEMPDIR/cddbchoices"
2413                         UNKNOWNDISK=y
2414                         for TRACK in $(f_seq_row 1 $TRACKS)
2415                         do
2416                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.0" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2417                         done
2418                         echo >> "$ABCDETEMPDIR/cddbchoices"
2419                         echo cddb-read-0-complete >> "$ABCDETEMPDIR/status"
2420                         echo cddb-choice=0 >> "$ABCDETEMPDIR/status"
2421                         echo 503 > "$ABCDETEMPDIR/cddbquery"
2422                 else
2423                         # We have some matches
2424                         NUM_RESPONSES=$(echo "${ABCDETEMPDIR}"/cddbread.* | wc -w)
2425                         if [ "$NUM_RESPONSES" -eq 1 ] ; then
2426                                 # One exact match
2427                                 echo -n "Retrieved 1 Musicbrainz match..." >> "$ABCDETEMPDIR/cddbchoices"
2428                                 echo "done." >> "$ABCDETEMPDIR/cddbchoices"
2429                                 echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
2430                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2431                                 ATITLE=$(grep -e '^DTITLE=' "${ABCDETEMPDIR}/cddbread.1" | cut -c8- )
2432                                 echo "200 none ${ATITLE}" >> "$ABCDETEMPDIR/cddbquery"
2433                                 # List out disc title/author and contents
2434                                 echo ---- ${ATITLE} ---- >> "$ABCDETEMPDIR/cddbchoices"
2435                                 for TRACK in $(f_seq_row 1 $TRACKS)
2436                                 do
2437                                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2438                                 done
2439                                 echo >> "$ABCDETEMPDIR/cddbchoices"
2440                         else
2441                                 echo "210 Found exact matches, list follows (until terminating .)" > "$ABCDETEMPDIR/cddbquery"
2442                                 echo "Multiple Musicbrainz matches:" >> "$ABCDETEMPDIR/cddbchoices"
2443                                 for file in "$ABCDETEMPDIR"/cddbread.*
2444                                 do
2445                                         X=$(echo $file | sed 's/^.*cddbread\.//g')
2446                                         echo cddb-read-$X-complete >> "$ABCDETEMPDIR/status"
2447                                         ATITLE=$(grep -e '^DTITLE=' "${ABCDETEMPDIR}"/cddbread.$X | cut -c8- )
2448                                         echo "none ${ATITLE}" >> "$ABCDETEMPDIR/cddbquery"
2449                                         # List out disc title/author and contents
2450                                         echo "#$X: ---- ${ATITLE} ----" >> "$ABCDETEMPDIR/cddbchoices"
2451                                         for TRACK in $(f_seq_row 1 $TRACKS)
2452                                         do
2453                                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.$X" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2454                                         done
2455                                         echo >> "$ABCDETEMPDIR/cddbchoices"
2456                                 done
2457                                 echo "." >> "$ABCDETEMPDIR/cddbquery"
2458                         fi
2459                 fi
2460                 echo "musicbrainz-readcomplete" >> "$ABCDETEMPDIR/status"
2461         fi
2462 }
2463
2464 # do_cddbstat
2465 do_cddbstat ()
2466 {
2467         # Perform CDDB protocol version check if it hasn't already been done
2468         if checkstatus cddb-statcomplete; then :; else
2469                 if [ "$CDDBAVAIL" = "n" ]; then
2470                         ERRORCODE=no_query
2471                         echo 503 > "$ABCDETEMPDIR/cddbstat"
2472                 else
2473                         rc=1
2474                         CDDBUSER=$(echo $HELLOINFO | cut -f1 -d'@')
2475                         CDDBHOST=$(echo $HELLOINFO | cut -f2- -d'@')
2476                         while test $rc -eq 1 -a $CDDBPROTO -ge 3; do
2477                                 vecho "Checking CDDB server status..."
2478                                 $CDDBTOOL stat $CDDBURL $CDDBUSER $CDDBHOST $CDDBPROTO > "$ABCDETEMPDIR/cddbstat"
2479                                 RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbstat" | cut -f1 -d' ')
2480                                 case "$RESPONSECODE" in
2481                                 210)    # 210 OK, status information follows (until terminating `.')
2482                                         rc=0
2483                                         ;;
2484                                 501)  # 501 Illegal CDDB protocol level: <n>.
2485                                         CDDBPROTO=`expr $CDDBPROTO - 1`
2486                                         ;;
2487                                 *)      # Try a cddb query, since freedb2.org doesn't support the stat or ver commands
2488                                         # FreeDB TESTCD disc-id is used for query
2489                                         $CDDBTOOL query $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST 03015501 1 296 344 > "$ABCDETEMPDIR/cddbstat"
2490                                         RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbstat" | cut -f1 -d' ')
2491                                         case "$RESPONSECODE" in
2492                                                 2??)    # Server responded, everything seems OK
2493                                                         rc=0
2494                                                         ;;
2495                                                 *)      # unknown error
2496                                                         break
2497                                                         ;;
2498                                         esac
2499                                         ;;
2500                                 esac
2501                         done
2502                         if test $rc -eq 1; then
2503                                 CDDBAVAIL="n"
2504                         fi
2505                 fi
2506                 echo cddb-statcomplete >> "$ABCDETEMPDIR/status"
2507         fi
2508 }
2509
2510
2511 # do_cddbquery
2512 do_cddbquery ()
2513 {
2514         CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
2515         CDDBLOCALFILE="${CDDBLOCALDIR}/${CDDBDISCID}"
2516
2517         # Perform CDDB query if it hasn't already been done
2518         if checkstatus cddb-querycomplete; then :; else
2519                 if [ "$CDDBAVAIL" = "n" ]; then
2520                         ERRORCODE=no_query
2521                         echo 503 > "$ABCDETEMPDIR/cddbquery"
2522                 # The default CDDBLOCALSTATUS is "notfound"
2523                 # This part will be triggered if the user CDDB repo does not
2524                 # contain the entry, or if we are not trying to use the repo.
2525                 else
2526                         vecho "Querying the CDDB server..."
2527                         CDDBUSER=$(echo $HELLOINFO | cut -f1 -d'@')
2528                         CDDBHOST=$(echo $HELLOINFO | cut -f2- -d'@')
2529                         $CDDBTOOL query $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $TRACKINFO > "$ABCDETEMPDIR/cddbquery"
2530                         ERRORCODE=$?
2531                         case $ERRORCODE in
2532                                 0)  # success
2533                                 ;;
2534                                 12|13|14)
2535                                         # no match found in database,
2536                                         # wget/fetch error, or user requested not to use CDDB
2537                                         # Make up an error code (503) that abcde
2538                                         # will recognize in do_cddbread
2539                                         # and compensate by making a template
2540                                         echo 503 > "$ABCDETEMPDIR/cddbquery"
2541                                 ;;
2542                                 *) # strange and unknown error
2543                                         echo ERRORCODE=$ERRORCODE
2544                                         echo "abcde: $CDDBTOOL returned unknown error code"
2545                                 ;;
2546                         esac
2547                 fi
2548                 echo cddb-querycomplete >> "$ABCDETEMPDIR/status"
2549         fi
2550 }
2551
2552 # do_cddbread
2553 do_cddbread ()
2554 {
2555         # If it's not to be used, generate a template.
2556         # Then, display it (or them) and let the user choose/edit it
2557         if checkstatus cddb-readcomplete; then :; else
2558                 vecho "Obtaining CDDB results..."
2559                 # If CDDB is to be used, interpret the query results and read all
2560                 # the available entries.
2561                 rm -f "$ABCDETEMPDIR/cddbchoices"
2562                 CDDBCHOICES=1 # Overridden by multiple matches
2563                 RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbquery" | cut -f1 -d' ')
2564                 case "$RESPONSECODE" in
2565                 200)
2566                         # One exact match, retrieve it
2567                         # 200 [section] [discid] [artist] / [title]
2568                         if checkstatus cddb-read-1-complete; then :; else
2569                                 echo -n "Retrieving 1 CDDB match..." >> "$ABCDETEMPDIR/cddbchoices"
2570                                 $CDDBTOOL read $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $(cut -f2,3 -d' ' "$ABCDETEMPDIR/cddbquery") > "$ABCDETEMPDIR/cddbread.1"
2571                                 echo "done." >> "$ABCDETEMPDIR/cddbchoices"
2572                                 echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
2573                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2574                         fi
2575                         # List out disc title/author and contents
2576                         echo ---- "$(cut '-d ' -f4- "$ABCDETEMPDIR/cddbquery")" ---- >> "$ABCDETEMPDIR/cddbchoices"
2577                         for TRACK in $(f_seq_row 1 $TRACKS)
2578                         do
2579                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2580                         done
2581                         echo >> "$ABCDETEMPDIR/cddbchoices"
2582                         ;;
2583                 202|403|409|503)
2584                         # No match
2585                         case "$RESPONSECODE" in
2586                         202) echo "No CDDB match." >> "$ABCDETEMPDIR/cddbchoices" ;;
2587                         403|409) echo "CDDB entry is corrupt, or the handshake failed." >> "$ABCDETEMPDIR/cddbchoices" ;;
2588                         503) echo "CDDB unavailable." >> "$ABCDETEMPDIR/cddbchoices" ;;
2589                         esac
2590                         $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
2591                         # List out disc title/author and contents of template
2592                         echo ---- Unknown Artist / Unknown Album ---- >> "$ABCDETEMPDIR/cddbchoices"
2593                         UNKNOWNDISK=y
2594                         for TRACK in $(f_seq_row 1 $TRACKS)
2595                         do
2596                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.0" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2597                         done
2598                         echo >> "$ABCDETEMPDIR/cddbchoices"
2599                         echo cddb-read-0-complete >> "$ABCDETEMPDIR/status"
2600                         echo cddb-choice=0 >> "$ABCDETEMPDIR/status"
2601                         ;;
2602                 210|211)
2603                         # Multiple exact, (possibly multiple) inexact matches
2604                         IN=
2605                         if [ "$RESPONSECODE" = "211" ]; then IN=in; fi
2606                         if [ "$(wc -l < "$ABCDETEMPDIR/cddbquery" | tr -d ' ')" -eq 3 ]; then
2607                                 echo "One ${IN}exact match:" >> "$ABCDETEMPDIR/cddbchoices"
2608                                 tail -n +2 "$ABCDETEMPDIR/cddbquery" | head -n 1 >> "$ABCDETEMPDIR/cddbchoices"
2609                                                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2610                         else
2611                                 echo "Multiple ${IN}exact matches:" >> "$ABCDETEMPDIR/cddbchoices"
2612                         fi
2613                         vecho -n "Retrieving multiple matches... "
2614                         grep -v ^[.]$ "$ABCDETEMPDIR/cddbquery" | ( X=0
2615                         read DISCINFO # eat top line
2616                         while read DISCINFO
2617                         do
2618                                 X=$(expr $X + 1)
2619                                 if checkstatus cddb-read-$X-complete; then :; else
2620                                         $CDDBTOOL read $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $(echo $DISCINFO | cut -f1,2 -d' ') > "$ABCDETEMPDIR/cddbread.$X"
2621                                         echo cddb-read-$X-complete >> "$ABCDETEMPDIR/status"
2622                                 fi
2623                                 # List out disc title/author and contents
2624                                 echo \#$X: ---- "$DISCINFO" ---- >> "$ABCDETEMPDIR/cddbchoices"
2625                                 for TRACK in $(f_seq_row 1 $TRACKS)
2626                                 do
2627                                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.$X" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2628                                 done
2629                                 echo >> "$ABCDETEMPDIR/cddbchoices"
2630                         done )
2631                         vecho "done."
2632                         CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
2633                         ;;
2634                 999)
2635                         # Using local copy.
2636                         for TRACK in $(f_seq_row 1 $TRACKS)
2637                         do
2638                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
2639                         done
2640                         echo >> "$ABCDETEMPDIR/cddbchoices"
2641                         echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
2642                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
2643                         ;;
2644                 esac
2645                 echo "cddb-readcomplete" >> "$ABCDETEMPDIR/status"
2646         fi
2647 }
2648
2649 # do_cddbedit
2650 do_cddbedit ()
2651 {
2652         if checkstatus cddb-edit >/dev/null; then
2653                 CDDBDATA="$ABCDETEMPDIR/cddbread.$(checkstatus cddb-choice)"
2654                 VARIOUSARTISTS="$(checkstatus variousartists)"
2655                 VARIOUSARTISTSTYLE="$(checkstatus variousartiststyle)"
2656                 return 0
2657         fi
2658         if [ "$INTERACTIVE" = "y" ]; then
2659                 # We should show the CDDB results both when we are not using the local CDDB repo
2660                 # or when we are using it but we could not find a proper match
2661                 if [ "$CDDBUSELOCAL" = "y" ] && [ "$CDDBLOCALSTATUS" = "notfound" ] || [ ! "$CDDBUSELOCAL" = "y" ]; then
2662                         # Display the $ABCDETEMPDIR/cddbchoices file created above
2663                         # Pick a pager so that if the tracks overflow the screen the user can still view everything
2664                         if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
2665                                 CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
2666                                 CHOICE=$(checkstatus cddb-choice)
2667                                 if [ -n "$CHOICE" ] ; then
2668                                         case $CDDBCHOICES in
2669                                                 -1) if head -1 "$ABCDETEMPDIR/cddbquery" | grep "^$" > /dev/null 2>&1 ; then
2670                                                                 log error "CDDB query failed!"
2671                                                                 exit 1
2672                                                         else
2673                                                                 cat "$ABCDETEMPDIR/cddbchoices"
2674                                                         fi
2675                                                         ;;
2676                                                 1) cat "$ABCDETEMPDIR/cddbchoices" ;;
2677                                                 *)
2678                                                 echo "Selected: #$CHOICE"
2679                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$CHOICE"
2680                                                 ;;
2681                                         esac
2682                                 else
2683                                         # The user has a choice to make, display the info in a pager if necessary
2684                                         if [ $(cat "$ABCDETEMPDIR/cddbchoices" | wc -l) -ge 24 ]; then
2685                                                 page "$ABCDETEMPDIR/cddbchoices"
2686                                         else
2687                                                 # It's all going to fit in one page, cat it
2688                                                 cat "$ABCDETEMPDIR/cddbchoices" >&2
2689                                         fi
2690
2691                                         CDDBCHOICENUM=""
2692                                         # Setting the choice to an impossible integer to avoid errors in the numeric comparisons
2693                                         CDCHOICENUM=-1
2694                                         # I'll take CDDB read #3 for $400, Alex
2695                                         while [ $CDCHOICENUM -lt 0 ] || [ $CDCHOICENUM -gt $CDDBCHOICES ]; do
2696                                                 echo -n "Which entry would you like abcde to use (0 for none)? [0-$CDDBCHOICES]: " >&2
2697                                                 read CDDBCHOICE
2698                                                 [ X"$CDDBCHOICE" = "X" ] && CDDBCHOICE=1
2699                                                 if echo $CDDBCHOICE | grep -E "[[:space:]]*[[:digit:]]+,[[:digit:]]+[[:space:]]*" > /dev/null 2>&1 ; then
2700                                                         if [ ! X"$DIFF" = "X" ]; then
2701                                                                 PARSECHOICE1=$(echo $CDDBCHOICE | cut -d"," -f1 | xargs printf %d 2>/dev/null)
2702                                                                 PARSECHOICE2=$(echo $CDDBCHOICE | cut -d"," -f2 | xargs printf %d 2>/dev/null)
2703                                                                 if [ $PARSECHOICE1 -lt 1 ] || [ $PARSECHOICE1 -gt $CDDBCHOICES ] || \
2704                                                                    [ $PARSECHOICE2 -lt 1 ] || [ $PARSECHOICE2 -gt $CDDBCHOICES ] || \
2705                                                                    [ $PARSECHOICE1 -eq $PARSECHOICE2 ]; then
2706                                                                         echo "Invalid diff range. Please select two comma-separated numbers between 1 and $CDDBCHOICES" >&2
2707                                                                 else
2708                                                                         # We parse the 2 choices to diff, store them in temporary files and diff them.
2709                                                                         for PARSECHOICE in $(echo $CDDBCHOICE | tr , \ ); do
2710                                                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$PARSECHOICE" > "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE"
2711                                                                         done
2712                                                                         echo "Showing diff between choices $PARSECHOICE1 and $PARSECHOICE2..." > "$ABCDETEMPDIR/cddbread.diff"
2713                                                                         $DIFF $DIFFOPTS "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE1" "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE2" >> "$ABCDETEMPDIR/cddbread.diff"
2714                                                                         if [ $(cat "$ABCDETEMPDIR/cddbread.diff" | wc -l) -ge 24 ]; then
2715                                                                                 page "$ABCDETEMPDIR/cddbread.diff"
2716                                                                         else
2717                                                                                 cat "$ABCDETEMPDIR/cddbread.diff" >&2
2718                                                                         fi
2719                                                                 fi
2720                                                         else
2721                                                                 echo "The diff program was not found in your path. Please choose a number between 0 and $CDDBCHOICES." >&2
2722                                                         fi
2723                                                 elif echo $CDDBCHOICE | grep -E "[[:space:]]*[[:digit:]]+[[:space:]]*" > /dev/null 2>&1 ; then
2724                                                         # Make sure we get a valid choice
2725                                                         CDCHOICENUM=$(echo $CDDBCHOICE | xargs printf %d 2>/dev/null)
2726                                                         if [ $CDCHOICENUM -lt 0 ] || [ $CDCHOICENUM -gt $CDDBCHOICES ]; then
2727                                                                 echo "Invalid selection. Please choose a number between 0 and $CDDBCHOICES." >&2
2728                                                         fi
2729                                                 fi
2730                                         done
2731                                         if [ "$CDCHOICENUM" = "0" ]; then
2732                                                 vecho "Creating empty CDDB template..."
2733                                                 UNKNOWNDISK=y
2734                                                 $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
2735                                         else
2736                                                 echo "Selected: #$CDCHOICENUM ($(grep ^DTITLE= "$ABCDETEMPDIR/cddbread.$CDCHOICENUM" | cut -f2- -d= | tr -d \\r\\n))" >&2
2737                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$CDCHOICENUM"
2738                                         fi
2739                                         echo "cddb-choice=$CDCHOICENUM" >> "$ABCDETEMPDIR/status"
2740                                 fi
2741                         fi
2742                 else
2743                         # We need some code to show the selected option when local repository is selected and we have found a match
2744                         vecho "Using cached CDDB match..." >&2
2745                         # Display the $ABCDETEMPDIR/cddbchoices file created above
2746                         # Pick a pager so that if the tracks overflow the screen the user can still view everything
2747                         if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
2748                                 CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
2749                                 CHOICE=$(checkstatus cddb-choice)
2750                                 if [ "$USELOCALRESP" = "y" ]; then :; else
2751                                         if [ -n "$CHOICE" ] ; then
2752                                                 case $CDDBCHOICES in
2753                                                         0)
2754                                                         UNKNOWNDISK=y
2755                                                         echo "Selected template."
2756                                                         ;;
2757                                                         1) cat "$ABCDETEMPDIR/cddbchoices" ;;
2758                                                         *)
2759                                                         echo "Selected: #$CHOICE"
2760                                                         do_cddbparse "$ABCDETEMPDIR/cddbread.$CHOICE"
2761                                                         ;;
2762                                                 esac
2763                                         fi
2764                                 fi
2765                         fi
2766                 fi
2767         else
2768                 # We're noninteractive - pick the first choice.
2769                 # But in case we run a previous instance and selected a choice, use it.
2770                 if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
2771                         # Show the choice if we are not using the locally stored one
2772                         # or when the local search failed to find a match.
2773                         PREVIOUSCHOICE=$(checkstatus cddb-choice)
2774                         if [ "$CDDBUSELOCAL" = "y" ] && [ "$CDDBLOCALSTATUS" = "notfound" ] || [ ! "$CDDBUSELOCAL" = "y" ]; then
2775                                 #if [ "$PREVIOUSCHOICE" ]; then
2776                                         cat "$ABCDETEMPDIR/cddbchoices"
2777                                 #fi
2778                         fi
2779                         if [ ! -z "$PREVIOUSCHOICE" ] ; then
2780                                 CDCHOICENUM=$PREVIOUSCHOICE
2781                         else
2782                                 CDCHOICENUM=1
2783                                 echo "cddb-choice=$CDCHOICENUM" >> "$ABCDETEMPDIR/status"
2784                         fi
2785                         echo "Selected: #$CDCHOICENUM ($(grep ^DTITLE= "$ABCDETEMPDIR/cddbread.$CDCHOICENUM" | cut -f2- -d= | tr -d \\r\\n))" >&2
2786                 fi
2787         fi
2788
2789         # sanity check
2790         if checkstatus cddb-choice >/dev/null; then :; else
2791                 echo "abcde: internal error: cddb-choice not recorded." >&2
2792                 exit 1
2793         fi
2794         CDDBDATA="$ABCDETEMPDIR/cddbread.$(checkstatus cddb-choice)"
2795         echo -n "Edit selected CDDB data " >&2
2796         if [ "$INTERACTIVE" = "y" ]; then
2797                 if [ "$UNKNOWNDISK" = "y" ]; then
2798                         echo -n "[Y/n]? " >&2
2799                         read EDITCDDB
2800                         [ "$EDITCDDB" != "n" ] && EDITCDDB=y
2801                 else
2802                         echo -n "[y/N]? " >&2
2803                         read EDITCDDB
2804                 fi
2805         else
2806                 echo "[y/N]? " >&2
2807                 EDITCDDB=n
2808         fi
2809         if [ "$EDITCDDB" = "y" ]; then
2810                 CDDBDATAMD5SUM=$($MD5SUM "$CDDBDATA" | cut -d " " -f 1);
2811
2812                 # Use the debian sensible-editor wrapper to pick the editor that the
2813                 # user has requested via their $EDITOR environment variable
2814                 if [ -x "/usr/bin/sensible-editor" ]; then
2815                         /usr/bin/sensible-editor "$CDDBDATA"
2816                 elif [ -n "$EDITOR" ]; then
2817                         if [ -x $(which "${EDITOR%%\ *}") ]; then
2818                                 # That failed, try to load the preferred editor, starting
2819                                 # with their EDITOR variable
2820                                 eval $(echo "$EDITOR") \"$CDDBDATA\"
2821                         fi
2822                 # If that fails, check for a vi
2823                 elif which vi >/dev/null 2>&1; then
2824                         vi "$CDDBDATA"
2825                 elif [ -x /usr/bin/vim ]; then
2826                         /usr/bin/vim "$CDDBDATA"
2827                 elif [ -x /usr/bin/vi ]; then
2828                         /usr/bin/vi "$CDDBDATA"
2829                 elif [ -x /bin/vi ]; then
2830                         /bin/vi "$CDDBDATA"
2831                 # nano should be on all (modern, i.e., sarge) debian systems
2832                 elif which nano >/dev/null 2>&1 ; then
2833                         nano "$CDDBDATA"
2834                 elif [ -x /usr/bin/nano ]; then
2835                         /usr/bin/nano "$CDDBDATA"
2836                 # mg should be on all OpenBSD systems
2837                 elif which mg >/dev/null 2>&1 ; then
2838                         mg "$CDDBDATA"
2839                 elif [ -x /usr/bin/mg ]; then
2840                         /usr/bin/mg "$CDDBDATA"
2841                 # bomb out
2842                 else
2843                         log warning "no editor available. Check your EDITOR environment variable."
2844                 fi
2845                 # delete editor backup file if it exists
2846                 if [ -w "$CDDBDATA~" ]; then
2847                         rm -f "$CDDBDATA~"
2848                 fi
2849         fi
2850
2851         # Some heuristics first. Look at Disc Title, and if it starts with
2852         # "Various", then we'll assume Various Artists
2853         if [ "$(grep ^DTITLE= "$CDDBDATA" | cut -f2- -d= | grep -Eci '^(various|soundtrack|varios|sonora|ost)')" != "0" ]; then
2854                 echo "Looks like a Multi-Artist CD" >&2
2855                 VARIOUSARTISTS=y
2856         else
2857                 echo -n "Is the CD multi-artist [y/N]? " >&2
2858                 if [ "$INTERACTIVE" = "y" ]; then
2859                         read VARIOUSARTISTS
2860                 else
2861                         echo n >&2
2862                         VARIOUSARTISTS=n
2863                 fi
2864         fi
2865         if [ "$VARIOUSARTISTS" = "y" ] && [ ! "$ONETRACK" = "y" ]; then
2866                 # Set a default
2867                 DEFAULTSTYLE=1
2868                 # Need NUMTRACKS before cddb-tool will return it:
2869                 NUMTRACKS=$(grep -E '^TTITLE[0-9]+=' "$CDDBDATA" | wc -l)
2870                 if [ "$(grep -c "^TTITLE.*\/" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2871                         # More than 1/2 tracks contain a "/", so guess forward
2872                         DEFAULTSTYLE=1
2873                 elif [ "$(grep -c "^TTITLE.*\-" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2874                         # More than 1/2 contain a "-", so guess forward-dash
2875                         DEFAULTSTYLE=2
2876                 elif [ "$(grep -c "^TTITLE.*(.*)" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2877                         # More than 1/2 contain something in parens, so guess trailing-paren
2878                         DEFAULTSTYLE=6
2879                 fi
2880
2881                 echo "1) Artist / Title" >&2
2882                 echo "2) Artist - Title" >&2
2883                 echo "3) Title / Artist" >&2
2884                 echo "4) Title - Artist" >&2
2885                 echo "5) Artist: Title" >&2
2886                 echo "6) Title (Artist)" >&2
2887                 echo "7) This is a single-artist CD" >&2
2888                 echo -n "Which style of multiple artist entries is it? [1-7] ($DEFAULTSTYLE): " >&2
2889                 if [ "$INTERACTIVE" = "y" ]; then
2890                         read VARIOUSARTISTSTYLE
2891                 else
2892                         echo $DEFAULTSTYLE >&2
2893                         VARIOUSARTISTSTYLE=$DEFAULTSTYLE
2894                 fi
2895                 VARIOUSARTISTSTYLE=$(echo 0$VARIOUSARTISTSTYLE | xargs printf %d)
2896                 # If they press Enter, then the default style (0) was chosen
2897                 while [ $VARIOUSARTISTSTYLE -lt 0 ] || [ $VARIOUSARTISTSTYLE -gt 7 ]; do
2898                         echo "Invalid selection. Please choose a number between 1 and 7."
2899                         echo -n "Selection [1-7]: "
2900                         read VARIOUSARTISTSTYLE
2901                         VARIOUSARTISTSTYLE=$(echo 0$VARIOUSARTISTSTYLE | xargs printf %d)
2902                 done
2903                 if [ "$VARIOUSARTISTSTYLE" = "0" ]; then
2904                         VARIOUSARTISTSTYLE=$DEFAULTSTYLE
2905                 fi
2906                 vecho "Selected: $VARIOUSARTISTSTYLE"
2907                 case "$VARIOUSARTISTSTYLE" in
2908                 1) # Artist / Title
2909                         VARIOUSARTISTSTYLE=forward
2910                         ;;
2911                 2) # Artist - Title
2912                         VARIOUSARTISTSTYLE=forward-dash
2913                         ;;
2914                 3) # Title / Artist
2915                         VARIOUSARTISTSTYLE=reverse
2916                         ;;
2917                 4) # Title - Artist
2918                         VARIOUSARTISTSTYLE=reverse-dash
2919                         ;;
2920                 5) # Artist: Title
2921                         VARIOUSARTISTSTYLE=colon
2922                         ;;
2923                 6) # Title (Artist)
2924                         VARIOUSARTISTSTYLE=trailing-paren
2925                         ;;
2926                 7) # Single Artist
2927                         VARIOUSARTISTS=n
2928                         ;;
2929                 esac
2930         fi
2931
2932         echo "variousartists=$VARIOUSARTISTS" >> "$ABCDETEMPDIR/status"
2933         echo "variousartiststyle=$VARIOUSARTISTSTYLE" >> "$ABCDETEMPDIR/status"
2934
2935         if [ "$EDITCDDB" = "y" ] && [ "$CDDBMETHOD" = "cddb" ] && [ "$UNINTENTIONALLY_ANGER_THE_FREEDB_PEOPLE" = "y" ]; then
2936                 if [ "$CDDBDATAMD5SUM" != "" ]  && [ "$CDDBDATAMD5SUM" != "$($MD5SUM "$CDDBDATA" | cut -d " " -f 1)" ]; then
2937                         # This works but does not have the necessary error checking
2938                         # yet. If you are familiar with the CDDB spec
2939                         # (see http://www.freedb.org/src/latest/DBFORMAT)
2940                         # and can create an error-free entry on your own, then put
2941                         # UNINTENTIONALLY_ANGER_THE_FREEDB_PEOPLE=y in your
2942                         # abcde.conf to enable it. Put CDDBSUBMIT=email@address in
2943                         # your abcde.conf to change the email address submissions are
2944                         # sent to.
2945
2946                         # submit the modified file, if they want
2947                         if [ "$NOSUBMIT" != "y" ]; then
2948                                 echo -n "Do you want to submit this entry to $CDDBSUBMIT [y/N]? "
2949                                 read YESNO
2950                                 while [ "$YESNO" != "y" ] && [ "$YESNO" != "n" ] && [ "$YESNO" != "Y" ] && \
2951                                         [ "$YESNO" != "N" ] && [ "$YESNO" != "" ]
2952                                 do
2953                                         echo -n 'Invalid selection. Please answer "y" or "n": '
2954                                         read YESNO
2955                                 done
2956                                 if [ "$YESNO" = "y" ] || [ "$YESNO" = "Y" ]; then
2957                                         echo -n "Sending..."
2958                                         $CDDBTOOL send "$CDDBDATA" $CDDBSUBMIT
2959                                         echo "done."
2960                                 fi
2961                         fi
2962                 fi
2963         fi
2964         ### FIXME ###
2965         # User CDDBLOCALPOLICY to find out if we store the file or not...
2966         # Cache edited CDDB entry in the user's cddb dir
2967         if [ "$CDDBCOPYLOCAL" = "y" ]; then
2968                 # Make sure the cache directory exists
2969                 mkdir -p $CDDBLOCALDIR
2970                 cat "$CDDBDATA" | tail -n $(expr $(cat "$CDDBDATA" | wc -l ) - 1 ) > ${CDDBLOCALDIR}/$(echo "$TRACKINFO" | cut -d' ' -f1)
2971         fi
2972
2973         echo "cddb-edit" >> "$ABCDETEMPDIR/status"
2974 }
2975
2976 # do_cdread [tracknumber]
2977 # do_cdread onetrack [firsttrack] [lasttrack]
2978 #
2979 do_cdread ()
2980 {
2981         # The commands here don't go through run_command because they're never supposed to be silenced
2982         # return codes need to be doublechecked anyway, however
2983         if [ "$1" = "onetrack" ]; then
2984                 # FIXME # Add the possibility of grabbing ranges of tracks in onetrack
2985                 # FIXME # Until then, we grab the whole CD in one track, no matter what
2986                 # the user said
2987                 # We need the first and last track for cdda2wav/icedax
2988                 FIRSTTRACK=$2
2989                 LASTTRACK=$(expr $3 + 0)
2990                 UTRACKNUM=$FIRSTTRACK
2991                 case "$CDROMREADERSYNTAX" in
2992                         flac) READTRACKNUMS="$FIRSTTRACK.1-$(($LASTTRACK + 1)).0" ;;
2993                         cdparanoia)
2994                                 #XX FIXME XX
2995                                 # Add a variable to check if tracks are provided in command line and if not, use "0-" to rip the tracks
2996                                 READTRACKNUMS="$FIRSTTRACK-$LASTTRACK" ;;
2997                         cdda2wav | icedax) READTRACKNUMS="$FIRSTTRACK+$LASTTRACK" ;;
2998                         pird) READTRACKNUMS="$FIRSTTRACK..$LASTTRACK" ;;
2999                         *) echo "abcde error: $CDROMREADERSYNTAX does not support ONETRACK mode"
3000                                 exit 1 ;;
3001                 esac
3002         else
3003                 UTRACKNUM=$1
3004         fi
3005         CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
3006         if [ "$USEPIPES" = "y" ]; then
3007                 TEMPARG="PI