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