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