abcde

   1 #!/bin/bash
   2 # Copyright (c) 1998-2001 Robert Woodcock <rcw@debian.org>
   3 # Copyright (c) 2003-2005 Jesus Climent <jesus.climent@hispalinux.es>
   4 # This code is hereby licensed for public consumption under either the
   5 # GNU GPL v2 or greater, or Larry Wall's Artistic license - your choice.
   6 #
   7 # You should have received a copy of the GNU General Public License
   8 # along with this program; if not, write to the Free Software
   9 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  10 #
  11 # Copyright for this work is to expire January 1, 2010, after which it
  12 # shall be public domain.
  13 #
  14 # $Id$
  15
  16 VERSION='2.3.99-$Revision$'
  17
  18 usage ()
  19 {
  20 echo "This is abcde v$VERSION."
  21 echo "Usage: abcde [options] [tracks]"
  22 echo "Options:"
  23 echo "-1     Encode the whole CD in a single file"
  24 echo "-a <action1[,action2]...>"
  25 echo "       Actions to perform:"
  26 echo "       cddb,read,normalize,encode,tag,move,replaygain,playlist,clean"
  27 #echo "-A     Experimental actions (retag, transcode)"
  28 echo "-b     Enable batch normalization"
  29 #echo "-B     Disable batch replaygain (do file by file)"
  30 echo "-c <file>"
  31 echo "       Specify a configuration file (overrides system and user config files)"
  32 echo "-C <discid#>"
  33 echo "       Specify discid to resume from (only needed if you no longer have the cd)"
  34 echo "-d <device>"
  35 echo "       Specify CDROM device to grab (flac uses a single-track flac file)"
  36 echo "-D     Debugging mode (equivalent to sh -x abcde)"
  37 echo "-e     Erase encoded track information from status file"
  38 echo "-f     Force operations that otherwise are considered harmful. Read \"man abcde\""
  39 echo "-g     Use \"lame --nogap\" for MP3 encoding. Disables low disk and pipes flags"
  40 echo "-h     This help information"
  41 #echo "-i    Tag files while encoding, when possible (local only) -NWY-"
  42 echo "-j <#> Number of encoder processes to run at once (localhost)"
  43 echo "-k     Keep the wav tracks for later use"
  44 echo "-l     Use low disk space algorithm"
  45 echo "-L     Use local CDDB storage directory"
  46 echo "-n     No lookup. Don't query CDDB, just create and use template"
  47 echo "-N     Noninteractive. Never prompt for anything"
  48 echo "-m     Modify playlist to include CRLF endings, to comply with some players"
  49 echo "-M     Create a CUE file"
  50 echo "-o <type1[,type2]...>"
  51 echo "       Output file type(s) (vorbis,mp3,flac,spx,mpc,wav,m4a). 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 "-R     Add replaygain values to the tag info (only for vorbis,flac,mp3)"
  57 echo "-s <field>"
  58 echo "       Show dielfs from the CDDB info (year,genre)"
  59 echo "-S <#> Set the CD speed"
  60 echo "-t <#> Start the track numbering at a given number"
  61 echo "-T <#> Same as -t but modifies tag numbering"
  62 echo "-u     Use UNICODE tags and comments"
  63 echo "-v     Show version number and exit"
  64 echo "-V     Be a bit more verbose about what is happening behind the scenes"
  65 echo "-x     Eject CD after all tracks are read"
  66 echo "-w <comment>"
  67 echo "       Add a comment to the CD tracks"
  68 echo "-W <#> Contatenate CDs: -T #01 -w \"CD #\""
  69 echo "-z     Use debug CDROMREADERSYNTAX option (needs cdparanoia)"
  70 echo ""
  71 echo "Tracks is a space-delimited list of tracks to grab."
  72 echo "Ranges specified with hyphens are allowed (i.e., 1-5)."
  73 echo ""
  74 #echo "Double hyphens are used to concatenate tracks"
  75 }
  76
  77 addstatus ()
  78 {
  79         echo "$@" >> "$ABCDETEMPDIR/status"
  80 }
  81
  82 # log [level] [message]
  83 #
  84 # log outputs the right message in a common format
  85 log ()
  86 {
  87         BLURB="$1"
  88         shift
  89         case $BLURB in
  90                 error)   echo "[ERROR] abcde: $@" >&2 ;;
  91                 warning) echo "[WARNING] $@" >&2 ;;
  92                 info)    echo "[INFO] $@" ;;
  93         esac
  94 }
  95
  96 # Funtions to replace the need of seq, which is too distribution dependant.
  97 f_seq_row ()
  98 {
  99         i=$1
 100         while [ $i -ne `expr $2 + 1` ]
 101         do
 102                 echo $i
 103                 i=`expr $i + 1`
 104         done
 105 }
 106
 107 f_seq_line ()
 108 {
 109         i=$1
 110         if echo i | grep -q "[[:digit:]]" ; then
 111                 while [ $i -ne `expr $2 + 1` ]
 112                 do
 113                         printf $i" "
 114                         i=`expr $i + 1`
 115                 done
 116                 echo
 117         else
 118                 log error "syntax error while processing track numbers"
 119                 exit 1
 120         fi
 121 }
 122
 123 # Functions to replace the need of awk {print $1} and {print $NF}
 124 get_first()
 125 {
 126 if [ X"$1" = "X" ]; then
 127         for first in `cat`; do
 128                 break
 129         done
 130 else
 131         first=$1
 132 fi
 133 echo $first
 134 }
 135
 136 get_last()
 137 {
 138 if [ X"$1" = "X" ]; then
 139         for stdin in `cat`; do
 140                 last=$stdin
 141         done
 142 else
 143         for last in $@ ; do :; done
 144 fi
 145 echo $last
 146 }
 147
 148 # checkstatus [blurb]
 149 # Returns "0" if the blurb was found, returns 1 if it wasn't
 150 # Puts the blurb content, if available, on stdout.
 151 # Otherwise, returns "".
 152 checkstatus ()
 153 {
 154         # Take the last line in the status file if there's multiple matches
 155         PATTERN="^$1(=.*)?$"
 156         BLURB=$(egrep $PATTERN "$ABCDETEMPDIR/status" | tail -n 1)
 157
 158         if [ -z "$BLURB" ]; then
 159                 # No matches found
 160                 return 1
 161         else
 162                 # Matches found
 163                 # See if there's a = in it
 164                 if [ "$(echo $BLURB | grep -c =)" != "0" ]; then
 165                         echo "$(echo $BLURB | cut -f2- -d=)"
 166                 fi
 167                 return 0
 168         fi
 169 }
 170
 171 # chechwarnings [blurb]
 172 # Returns "0" if the blurb was found (meaning there was an warning),
 173 # returns 1 if it wasn't (yes this is a little backwards).
 174 # Does not print the blurb on stdout.
 175 # Otherwise, returns "".
 176 checkwarnings ()
 177 {
 178         if [ -e "$ABCDETEMPDIR/warnings" ]; then :; else
 179                 return 1
 180         fi
 181         # Take the last line in the status file if there's multiple matches
 182         PATTERN="^$1(:.*)?$"
 183         BLURB="$(egrep $PATTERN "$ABCDETEMPDIR/warnings" | tail -n 1)"
 184
 185         if [ -z "$BLURB" ]; then
 186                 # negative, we did not have a negative...
 187                 return 1
 188         else
 189                 # affirmative, we had a negative...
 190                 return 0
 191         fi
 192 }
 193
 194 # checkerrors [blurb]
 195 # Returns "0" if the blurb was found (meaning there was an error),
 196 # returns 1 if it wasn't (yes this is a little backwards).
 197 # Does not print the blurb on stdout.
 198 # Otherwise, returns "".
 199 checkerrors ()
 200 {
 201         if [ -e "$ABCDETEMPDIR/errors" ]; then :; else
 202                 return 1
 203         fi
 204         # Take the last line in the status file if there's multiple matches
 205         PATTERN="^$1(:.*)?$"
 206         BLURB="$(egrep $PATTERN "$ABCDETEMPDIR/errors" | tail -n 1)"
 207
 208         if [ -z "$BLURB" ]; then
 209                 # negative, we did not have a negative...
 210                 return 1
 211         else
 212                 # affirmative, we had a negative...
 213                 return 0
 214         fi
 215 }
 216
 217 # page [file]
 218 # Finds the right pager in the system to display a file
 219 page ()
 220 {
 221         PAGEFILE="$1"
 222         # Use the debian sensible-pager wrapper to pick the pager
 223         # user has requested via their $PAGER environment variable
 224         if [ -x "/usr/bin/sensible-pager" ]; then
 225                 /usr/bin/sensible-pager "$PAGEFILE"
 226         elif [ -x "$PAGER" ]; then
 227                 # That failed, try to load the preferred editor, starting
 228                 # with their PAGER variable
 229                 $PAGER "$PAGEFILE"
 230                 # If that fails, check for less
 231         elif [ -x /usr/bin/less ]; then
 232                 /usr/bin/less -f "$PAGEFILE"
 233                 # more should be on all UNIX systems
 234         elif [ -x /bin/more ]; then
 235                 /bin/more "$PAGEFILE"
 236         else
 237                 # No bananas, just cat the thing
 238                 cat "$PAGEFILE" >&2
 239         fi
 240 }
 241
 242 # run_command [blurb] [command...]
 243 # Runs a command, silently if necessary, and updates the status file
 244 run_command ()
 245 {
 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 # do_getcddbinfo
 337 # Finds an specific field from cddbinfo
 338 do_getcddbinfo()
 339 {
 340         case $1 in
 341         TRACKNAME1)
 342                 TRACKNAME="$(grep ^TTITLE$CDDBTRACKNUM= "$CDDBDATA" | head -n 1 | cut -f2- -d= | tr -d \[:cntrl:\] | sed 's/\ \+$//')"
 343                 ;;
 344         TRACKNAME)
 345                 TRACKNAME="$(grep ^TTITLE$CDDBTRACKNUM= "$CDDBDATA" | cut -f2- -d= | tr -d \[:cntrl:\] | sed 's/\ \+$//')"
 346                 ;;
 347         esac
 348 }
 349
 350 # do_gettracknum
 351 # Get the track number we are going to use for different actions
 352 do_gettracknum()
 353 {
 354         if [ -n "$STARTTRACKNUMBER" ] ; then
 355                 # Get the trackpadding from the current track
 356                 CURRENTTRACKPADDING=$(echo -n $UTRACKNUM | wc -c)
 357                 TRACKNUM=$( printf %0.${CURRENTTRACKPADDING}d $(expr ${UTRACKNUM} + ${STARTTRACKNUMBER} - $FIRSTTRACK ))
 358         else
 359                 TRACKNUM=${UTRACKNUM}
 360         fi
 361 }
 362
 363 do_replaygain()
 364 {
 365         if checkstatus replaygain; then :; else
 366                 run_command "" echo "Adding replygain information..."
 367                 for OUTPUT in $( echo $OUTPUTTYPE | tr , \ )
 368                 do
 369                         case $OUTPUT in
 370                                 vorbis|ogg)
 371                                         OUTPUT=$OGGOUTPUTCONTAINER
 372                                         ;;
 373                                 flac)
 374                                         OUTPUT=$FLACOUTPUTCONTAINER
 375                                         ;;
 376                         esac
 377                         OUTPUTFILES=""
 378                         REPLAYINDEX=0
 379                         for UTRACKNUM in $TRACKQUEUE
 380                         do
 381                                 CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
 382                                 do_getcddbinfo TRACKNAME
 383                                 splitvarious
 384                                 TRACKFILE="$(mungefilename "$TRACKNAME")"
 385                                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
 386                                 ALBUMFILE="$(mungefilename "$DALBUM")"
 387                                 do_gettracknum
 388                                 if [ "$VARIOUSARTISTS" = "y" ]; then
 389                                         OUTPUTFILE="$(eval echo $VAOUTPUTFORMAT)"
 390                                 else
 391                                         OUTPUTFILE="$(eval echo $OUTPUTFORMAT)"
 392                                 fi
 393                                 OUTPUTFILES[$REPLAYINDEX]="$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
 394                                 (( REPLAYINDEX = $REPLAYINDEX + 1 ))
 395                         done
 396                         case "$OUTPUT" in
 397                                 flac)
 398                                         run_command replaygain-flac $METAFLAC --add-replay-gain "${OUTPUTFILES[@]}"
 399                                         ;;
 400                                 vorbis|ogg)
 401                                         run_command replaygain-vorbis $VORBISGAIN --album "${OUTPUTFILES[@]}"
 402                                         ;;
 403                                 mp3)
 404                                         run_command replaygain-mp3 $MP3GAIN -a "${OUTPUTFILES[@]}"
 405                                         ;;
 406                                 mpc)
 407                                         run_command replaygain-mpc $MPPGAIN --auto "${OUTPUTFILES[@]}"
 408                                         ;;
 409                                 *);;
 410                         esac
 411                 done
 412                 if checkerrors "replaygain-.{3,6}"; then :; else
 413                         run_command replaygain true
 414                 fi
 415         fi
 416 }
 417
 418 # This code splits the a Various Artist track name from one of the following
 419 # forms:
 420 #
 421 #  forward:        Artist / Track
 422 #  forward-dash:   Artist - Track
 423 #  reverse:        Track / Artist
 424 #  reverse-dash:   Track - Artist
 425 #  colon:          Artist: Track
 426 #  trailing-paren: Artist (Track)
 427 #
 428 # variables used:
 429 # VARIOUSARTISTS, VARIOUSARTISTSTYLE, TRACKNAME, TRACKARTIST
 430 splitvarious ()
 431 {
 432         if [ "$VARIOUSARTISTS" = "y" ] && [ ! "$ONETRACK" = "y" ]; then
 433                 case "$VARIOUSARTISTSTYLE" in
 434                 forward)
 435                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's- / -~-g')"
 436                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
 437                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
 438                         ;;
 439                 forward-dash)
 440                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's, - ,~,g')"
 441                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
 442                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
 443                         ;;
 444                 reverse)
 445                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's- / -~-g')"
 446                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
 447                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
 448                         ;;
 449                 reverse-dash)
 450                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's, - ,~,g')"
 451                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
 452                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
 453                         ;;
 454                 colon)
 455                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's-: -~-g')"
 456                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
 457                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
 458                         ;;
 459                 trailing-paren)
 460                         DTITLEARTIST="$(echo "$TRACKNAME" | sed 's,^\(.*\) (\(.*\)),\1~\2,')"
 461                         TRACKARTIST="$(echo "$DTITLEARTIST" | cut -f2 -d~)"
 462                         TRACKNAME="$(echo "$DTITLEARTIST" | cut -f1 -d~)"
 463                         ;;
 464                 esac
 465         elif [ "$VARIOUSARTISTS" = "y" ] && [ "$ONETRACK" = "y" ]; then
 466                 TRACKARTIST="Various"
 467         else
 468                 TRACKARTIST="$DARTIST"
 469         fi
 470 }
 471
 472 do_getgenreid () {
 473 local genre=$(echo "${@}" | tr '[A-Z]' '[a-z]')
 474 local id=""
 475         case ${genre} in
 476                 "blues")                 id=0 ;;
 477                 "classic rock")          id=1 ;;
 478                 "country")               id=2 ;;
 479                 "dance")                 id=3 ;;
 480                 "disco")                 id=4 ;;
 481                 "funk")                  id=5 ;;
 482                 "grunge")                id=6 ;;
 483                 "hip-hop")               id=7 ;;
 484                 "jazz")                  id=8 ;;
 485                 "metal")                 id=9 ;;
 486                 "new age")               id=10 ;;
 487                 "oldies")                id=11 ;;
 488                 "other")                 id=12 ;;
 489                 "pop")                   id=13 ;;
 490                 "r&b")                   id=14 ;;
 491                 "rap")                   id=15 ;;
 492                 "reggae")                id=16 ;;
 493                 "rock")                  id=17 ;;
 494                 "techno")                id=18 ;;
 495                 "industrial")            id=19 ;;
 496                 "alternative")           id=20 ;;
 497                 "ska")                   id=21 ;;
 498                 "death metal")           id=22 ;;
 499                 "pranks")                id=23 ;;
 500                 "soundtrack")            id=24 ;;
 501                 "euro-techno")           id=25 ;;
 502                 "ambient")               id=26 ;;
 503                 "trip-hop")              id=27 ;;
 504                 "vocal")                 id=28 ;;
 505                 "jazz+funk")             id=29 ;;
 506                 "fusion")                id=30 ;;
 507                 "trance")                id=31 ;;
 508                 "classical")             id=32 ;;
 509                 "instrumental")          id=33 ;;
 510                 "acid")                  id=34 ;;
 511                 "house")                 id=35 ;;
 512                 "game")                  id=36 ;;
 513                 "sound clip")            id=37 ;;
 514                 "gospel")                id=38 ;;
 515                 "noise")                 id=39 ;;
 516                 "alt. rock")             id=40 ;;
 517                 "bass")                  id=41 ;;
 518                 "soul")                  id=42 ;;
 519                 "punk")                  id=43 ;;
 520                 "space")                 id=44 ;;
 521                 "meditative")            id=45 ;;
 522                 "instrum. pop")          id=46 ;;
 523                 "instrum. rock")         id=47 ;;
 524                 "ethnic")                id=48 ;;
 525                 "gothic")                id=49 ;;
 526                 "darkwave")              id=50 ;;
 527                 "techno-indust.")        id=51 ;;
 528                 "electronic")            id=52 ;;
 529                 "pop-folk")              id=53 ;;
 530                 "eurodance")             id=54 ;;
 531                 "dream")                 id=55 ;;
 532                 "southern rock")         id=56 ;;
 533                 "comedy")                id=57 ;;
 534                 "cult")                  id=58 ;;
 535                 "gangsta")               id=59 ;;
 536                 "top 40")                id=60 ;;
 537                 "christian rap")         id=61 ;;
 538                 "pop/funk"|"pop / funk") id=62 ;;
 539                 "jungle")                id=63 ;;
 540                 "native american")       id=64 ;;
 541                 "cabaret")               id=65 ;;
 542                 "new wave")              id=66 ;;
 543                 "psychadelic")           id=67 ;;
 544                 "rave")                  id=68 ;;
 545                 "showtunes")             id=69 ;;
 546                 "trailer")               id=70 ;;
 547                 "lo-fi")                 id=71 ;;
 548                 "tribal")                id=72 ;;
 549                 "acid punk")             id=73 ;;
 550                 "acid jazz")             id=74 ;;
 551                 "polka")                 id=75 ;;
 552                 "retro")                 id=76 ;;
 553                 "musical")               id=77 ;;
 554                 "rock & roll")           id=78 ;;
 555                 "hard rock")             id=79 ;;
 556                 "folk")                  id=80 ;;
 557                 "folk/rock")             id=81 ;;
 558                 "national folk")         id=82 ;;
 559                 "swing")                 id=83 ;;
 560                 "fusion")                id=84 ;;
 561                 "bebob")                 id=85 ;;
 562                 "latin")                 id=86 ;;
 563                 "revival")               id=87 ;;
 564                 "celtic")                id=88 ;;
 565                 "bluegrass")             id=89 ;;
 566                 "avantgarde")            id=90 ;;
 567                 "gothic rock")           id=91 ;;
 568                 "progress. rock")        id=92 ;;
 569                 "psychadel. rock")       id=93 ;;
 570                 "symphonic rock")        id=94 ;;
 571                 "slow rock")             id=95 ;;
 572                 "big band")              id=96 ;;
 573                 "chorus")                id=97 ;;
 574                 "easy listening")        id=98 ;;
 575                 "acoustic")              id=99 ;;
 576                 "humour")                id=100 ;;
 577                 "speech")                id=101 ;;
 578                 "chanson")               id=102 ;;
 579                 "opera")                 id=103 ;;
 580                 "chamber music")         id=104 ;;
 581                 "sonata")                id=105 ;;
 582                 "symphony")              id=106 ;;
 583                 "booty bass")            id=107 ;;
 584                 "primus")                id=108 ;;
 585                 "porn groove")           id=109 ;;
 586                 "satire")                id=110 ;;
 587                 "slow jam")              id=111 ;;
 588                 "club")                  id=112 ;;
 589                 "tango")                 id=113 ;;
 590                 "samba")                 id=114 ;;
 591                 "folklore")              id=115 ;;
 592                 "ballad")                id=116 ;;
 593                 "power ballad")          id=117 ;;
 594                 "rhythmic soul")         id=118 ;;
 595                 "freestyle")             id=119 ;;
 596                 "duet")                  id=120 ;;
 597                 "punk rock")             id=121 ;;
 598                 "drum solo")             id=122 ;;
 599                 "a capella")             id=123 ;;
 600                 "euro-house")            id=124 ;;
 601                 "dance hall")            id=125 ;;
 602                 "goa")                   id=126 ;;
 603                 "drum & bass")           id=127 ;;
 604                 "club-house")            id=128 ;;
 605                 "hardcore")              id=129 ;;
 606                 "terror")                id=130 ;;
 607                 "indie")                 id=131 ;;
 608                 "britpop")               id=132 ;;
 609                 "negerpunk")             id=133 ;;
 610                 "polsk punk")            id=134 ;;
 611                 "beat")                  id=135 ;;
 612                 "christian gangsta rap") id=136 ;;
 613                 "heavy metal")           id=137 ;;
 614                 "black metal")           id=138 ;;
 615                 "crossover")             id=139 ;;
 616                 "contemporary christian")id=140 ;;
 617                 "christian rock")        id=141 ;;
 618                 "merengue")              id=142 ;;
 619                 "salsa")                 id=143 ;;
 620                 "thrash metal")          id=144 ;;
 621                 "anime")                 id=145 ;;
 622                 "jpop")                  id=146 ;;
 623                 "synthpop")              id=147 ;;
 624                 "rock/pop"|"rock / pop") id=148 ;;
 625                 *)                       return 1 ;;
 626         esac
 627 echo ${id}
 628 return 0
 629 }
 630
 631 # do_tag [tracknumber]
 632 # id3 tags a filename
 633 # variables used:
 634 # TRACKS, TRACKNAME, TRACKARTIST, TAGGER, TAGGEROPTS, VORBISCOMMENT, METAFLAC,
 635 # COMMENT, DALBUM, DARTIST, CDYEAR, CDGENRE (and temporarily) ID3TAGV
 636 do_tag ()
 637 {
 638         COMMENTOUTPUT="$(eval echo ${COMMENT})"
 639         CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
 640         run_command '' echo "Tagging track $1 of $TRACKS: $TRACKNAME..."
 641         # If we want to start the tracks with a given number, we need to modify the
 642         # TRACKNUM value before evaluation
 643         if [ -n "$STARTTRACKNUMBERTAG" ] ; then
 644                 do_gettracknum
 645         fi
 646         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
 647         do
 648                 case "$OUTPUT" in
 649                 mp3)
 650                         # id3v2 v0.1.9 claims to have solved the -c bug, so we merge both id3 and id3v2
 651                         GENREID=$(do_getgenreid "${CDGENRE}")
 652
 653                         case "$ID3SYNTAX" in
 654                                 id3);;
 655                                 eyed3)
 656                                         # FIXME # track numbers in mp3 come with 1/10, so we cannot happily substitute them with $TRACKNUM
 657                                         run_command tagtrack-$OUTPUT-$1 $TAGGER $TAGGEROPTS --commen=::"$COMMENTOUTPUT" \
 658                                                 -A "$DALBUM" -a "$TRACKARTIST" -t "$TRACKNAME" -Y "$CDYEAR" \
 659                                                 -G "$GENREID" -n "${TRACKNUM:-$1}" "${TRACKNUM:+-N $TRACKS}" \
 660                                                 "${ENCODING:+--set-encoding=$ENCODING}"
 661                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
 662                                         ;;
 663                                 *)
 664                                         # FIXME # track numbers in mp3 come with 1/10, so we cannot happily substitute them with $TRACKNUM
 665                                         run_command tagtrack-$OUTPUT-$1 $TAGGER $TAGGEROPTS -c "$COMMENTOUTPUT" \
 666                                                 -A "$DALBUM" -a "$TRACKARTIST" -t "$TRACKNAME" -y "$CDYEAR" \
 667                                                 -g "$GENREID" -T "${TRACKNUM:-$1/$TRACKS}" \
 668                                                 "$ABCDETEMPDIR/track$1.$OUTPUT"
 669                                         ;;
 670                         esac
 671                         ;;
 672                 vorbis|ogg)
 673                         case "$OGGENCODERSYNTAX" in
 674                                 vorbize|oggenc)
 675                                         # vorbiscomment can't do in-place modification, mv the file first
 676                                         if [ -f "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" -a ! -f "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" ]; then
 677                                                 mv "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER"
 678                                         fi
 679                                         (
 680                                         # These are from http://www.xiph.org/ogg/vorbis/doc/v-comment.html
 681                                         echo ARTIST="$TRACKARTIST"
 682                                         echo ALBUM="$DALBUM"
 683                                         echo TITLE="$TRACKNAME"
 684                                         if [ -n "$CDYEAR" ]; then
 685                                                 echo DATE="$CDYEAR"
 686                                         fi
 687                                         if [ -n "$CDGENRE" ]; then
 688                                                 echo GENRE="$CDGENRE"
 689                                         fi
 690                                         echo TRACKNUMBER=${TRACKNUM:-$1}
 691                                         echo CDDB=$CDDBDISCID
 692                                         if [ "$(eval echo ${COMMENT})" != "" ]; then
 693                                                 case "$COMMENTOUTPUT" in
 694                                                         *=*) echo "$COMMENTOUTPUT";;
 695                                                         *)   echo COMMENT="$COMMENTOUTPUT";;
 696                                                 esac
 697                                         fi
 698                                         ) | run_command tagtrack-$OUTPUT-$1 $VORBISCOMMENT $VORBISCOMMENTOPTS -w \
 699                                                 "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
 700                                         # Doublecheck that the commented file was created successfully before wiping the original
 701                                         if [ -f "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER" ]; then
 702                                                 rm -f "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER"
 703                                         else
 704                                                 mv "$ABCDETEMPDIR/track$1.uncommented.$OGGOUTPUTCONTAINER" "$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
 705                                         fi
 706                                         ;;
 707                         esac
 708                         ;;
 709                 flac)
 710                         (
 711                         echo ARTIST="$TRACKARTIST"
 712                         echo ALBUM="$DALBUM"
 713                         echo TITLE="$TRACKNAME"
 714                         if [ -n "$CDYEAR" ]; then
 715                                 echo DATE="$CDYEAR"
 716                         fi
 717                         if [ -n "$CDGENRE" ]; then
 718                                 echo GENRE="$CDGENRE"
 719                         fi
 720                         echo TRACKNUMBER="${TRACKNUM:-$1}"
 721                         echo CDDB="$CDDBDISCID"
 722                         if [ "$(eval echo ${COMMENT})" != "" ]; then
 723                                 case "$COMMENTOUTPUT" in
 724                                         *=*) echo "$COMMENTOUTPUT";;
 725                                         *)   echo COMMENT="$COMMENTOUTPUT";;
 726                                 esac
 727                         fi
 728                         ) | run_command tagtrack-$OUTPUT-$1 $METAFLAC $METAFLACOPTS --import-tags-from=- "$ABCDETEMPDIR/track$1.$FLACOUTPUTCONTAINER"
 729                         ;;
 730                 spx)
 731                         run_command tagtrack-$OUTPUT-$1 true
 732                         ;;
 733                 mpc)
 734                         run_command tagtrack-$OUTPUT-$1 true
 735                         ;;
 736                 m4a)
 737                         run_command tagtrack-$OUTPUT-$1 true
 738                         ;;
 739                 wav)
 740                         run_command tagtrack-$OUTPUT-$1 true
 741                         ;;
 742                 esac
 743         done
 744         if checkerrors "tagtrack-(.{3,6})-$1"; then :; else
 745                 run_command tagtrack-$1 true
 746         fi
 747
 748 }
 749
 750 # do_nogap_encode
 751 # variables used:
 752 # OUTPUTTYPE, {FOO}ENCODERSYNTAX, ENCNICE, ENCODER, ENCODEROPTS
 753 do_nogap_encode ()
 754 {
 755         # The commands here don't go through run_command because they're never supposed to be silenced
 756         echo "Encoding gapless MP3 tracks: $TRACKQUEUE"
 757         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
 758         do
 759                 case "$OUTPUT" in
 760                 mp3)
 761                         case "$MP3ENCODERSYNTAX" in
 762                         lame)
 763                                 (
 764                                 cd "$ABCDETEMPDIR"
 765                                 TRACKFILES=
 766                                 for UTRACKNUM in $TRACKQUEUE
 767                                 do
 768                                         TRACKFILES="$TRACKFILES track$UTRACKNUM.wav"
 769                                 done
 770                                 nice $ENCNICE $MP3ENCODER $MP3ENCODEROPTS --nogap $TRACKFILES
 771                                 RETURN=$?
 772                                 if [ "$RETURN" != "0" ]; then
 773                                         echo "nogap-encode: $ENCODER returned code $RETURN" >> errors
 774                                 else
 775                                         for UTRACKNUM in $TRACKQUEUE
 776                                         do
 777                                                 run_command encodetrack-$OUTPUT-$UTRACKNUM true
 778                                                 #run_command encodetrack-$UTRACKNUM true
 779                                         done
 780                                 fi
 781                                 )
 782                                 ;;
 783                         esac
 784                         ;;
 785                 esac
 786         done
 787         if checkerrors "nogap-encode"; then :; else
 788                 if [ ! "$KEEPWAVS" = "y" ] ; then
 789                         if [ ! "$KEEPWAVS" = "move" ] ; then
 790                                 rm -f "$IN"
 791                         fi
 792                 fi
 793         fi
 794         # Other encoders fall through to normal encoding as the tracks
 795         # have not been entered in the status file.
 796 }
 797
 798 # do_encode [tracknumber] [hostname]
 799 # If no hostname is specified, encode locally
 800 # variables used:
 801 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
 802 do_encode ()
 803 {
 804         if [ "$USEPIPES" = "y" ]; then
 805                 case "$OUTPUT" in
 806                         mp3)
 807                                 TEMPARG="PIPE_$MP3ENCODERSYNTAX"
 808                                 ;;
 809                         vorbis|ogg)
 810                                 TEMPARG="PIPE_$OGGENCODERSYNTAX"
 811                                 ;;
 812                         flac)
 813                                 TEMPARG="PIPE_$FLACENCODERSYNTAX"
 814                                 ;;
 815                         spx)
 816                                 TEMPARG="PIPE_$SPEEXENCODER"
 817                                 ;;
 818                         mpc)
 819                                 TEMPARG="PIPE_$MPPENCODER"
 820                                 ;;
 821                         m4a)
 822                                 TEMPARG="PIPE_$MPPENCODER"
 823                                 ;;
 824                 esac
 825                 IN="$( eval echo "\$$TEMPARG" )"
 826         else
 827                 IN="$ABCDETEMPDIR/track$1.wav"
 828                 case "$OUTPUT" in
 829                         mp3)
 830                                 case "$MP3ENCODERSYNTAX" in
 831                                         # FIXME # check if mp3enc needs -if for pipes
 832                                         # FIXME # I have not been able to find a working mp3enc binary
 833                                         mp3enc)
 834                                                 FILEARG="-if $IN"
 835                                                 ;;
 836                                         *)
 837                                                 FILEARG="$IN"
 838                                                 ;;
 839                                 esac
 840                                 ;;
 841                         *)
 842                                 FILEARG="$IN"
 843                                 ;;
 844                 esac
 845         fi
 846         # We need IN to proceed, if we are not using pipes.
 847         if [ -s "$IN" -o X"$USEPIPES" = "Xy" ] ; then
 848                 for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
 849                 do
 850                         case "$OUTPUT" in
 851                                 vorbis|ogg)
 852                                         OUT="$ABCDETEMPDIR/track$1.$OGGOUTPUTCONTAINER"
 853                                         OUTPUT=$OGGOUTPUTCONTAINER
 854                                         ;;
 855                                 flac)
 856                                         OUT="$ABCDETEMPDIR/track$1.$FLACOUTPUTCONTAINER"
 857                                         OUTPUT=$FLACOUTPUTCONTAINER
 858                                         ;;
 859                                 *)
 860                                         OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
 861                                         ;;
 862                         esac
 863                         if [ "$NOGAP" = "y" ] && checkstatus encodetrack-$OUTPUT-$1 ; then
 864                                 continue
 865                         fi
 866                         if [ X"$USEPIPES" = "Xy" ]; then
 867                                 RUN_COMMAND=""
 868                                 # We need a way to store the creation of the files when using PIPES
 869                                 RUN_COMMAND_PIPES="run_command encodetrack-$OUTPUT-$1 true"
 870                         else
 871                                 run_command '' echo "Encoding track $1 of $TRACKS: $TRACKNAME..."
 872                                 RUN_COMMAND="run_command encodetrack-$OUTPUT-$1"
 873                         fi
 874                         case "$OUTPUT" in
 875                         mp3)
 876                                 case "$2" in
 877                                 %local*%)
 878                                         case "$MP3ENCODERSYNTAX" in
 879                                         lame|gogo) $RUN_COMMAND nice $ENCNICE $MP3ENCODER $MP3ENCODEROPTS "$IN" "$OUT" ;;
 880                                         bladeenc) $RUN_COMMAND nice $ENCNICE $MP3ENCODER $MP3ENCODEROPTS -quit "$IN" ;;
 881                                         l3enc|xingmp3enc) $RUN_COMMAND nice $ENCNICE $MP3ENCODER "$IN" "$OUT" $MP3ENCODEROPTS ;;
 882                                         # FIXME # Relates to the previous FIXME since it might need the "-if" removed.
 883                                         mp3enc) $RUN_COMMAND nice $ENCNICE $MP3ENCODER -if "$IN" -of "$OUT" $MP3ENCODEROPTS ;;
 884                                         esac
 885                                         ;;
 886                                 *)
 887                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
 888                                         ;;
 889                                 esac
 890                                 ;;
 891                         vorbis|ogg)
 892                                 case "$2" in
 893                                 %local*%)
 894                                         case "$OGGENCODERSYNTAX" in
 895                                         vorbize) $RUN_COMMAND nice $ENCNICE $OGGENCODER $OGGENCODEROPTS -w "$OUT" "$IN" ;;
 896                                         oggenc) $RUN_COMMAND nice $ENCNICE $OGGENCODER $OGGENCODEROPTS -o "$OUT" "$IN" ;;
 897                                         esac
 898                                         ;;
 899                                 *)
 900                                         $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" >/dev/null 2>&1
 901                                         ;;
 902                                 esac
 903                                 ;;
 904                         flac)
 905                                 case "$2" in
 906                                 %local*%)
 907                                         case "$FLACENCODERSYNTAX" in
 908                                         flac) $RUN_COMMAND nice $ENCNICE $FLACENCODER -f $FLACENCODEROPTS -o "$OUT" "$IN" ;;
 909                                         esac
 910                                                 ;;
 911                                         *)
 912                                                 vecho -n "DISTMP3:"
 913                                                 vecho "$DISTMP3 $DISTMP3OPTS $2 $IN $OUT >/dev/null 2>&1"
 914                                                 $RUN_COMMAND nice $DISTMP3NICE $DISTMP3 $DISTMP3OPTS "$2" "$IN" "$OUT" > /dev/null 2>&1
 915                                         ;;
 916                                 esac
 917                                 ;;
 918                         spx)
 919                                 if [ "$(eval echo ${COMMENT})" != "" ]; then
 920                                         case "$COMMENT" in
 921                                                 *=*) ;;
 922                                                 *)   COMMENT="COMMENT=$COMMENT" ;;
 923                                         esac
 924                                         COMMENT="--comment \"$COMMENT\""
 925                                 fi
 926                                 # Quick hack to avoid tagging Ogg/Speex, since there is no other way to tag than inline tagging
 927                                 if [ ! "$DOTAG" = "y" ]; then
 928                                         $RUN_COMMAND nice $ENCNICE $SPEEXENCODER $SPEEXENCODEROPTS --author "$TRACKARTIST" --title "$TRACKNAME" "$COMMENT" "$IN" "$OUT"
 929                                 else
 930                                         $RUN_COMMAND nice $ENCNICE $SPEEXENCODER $SPEEXENCODEROPTS "$IN" "$OUT"
 931                                 fi
 932                                 ;;
 933                         mpc)
 934                                 # MPP/MP+(Musepack) format (.mpc) is done locally, with inline
 935                                 # tagging.
 936                                 # I tried compiling the mppenc from corecodecs.org and got some
 937                                 # errors, so I have not tried it myself.
 938                                 ## FIXME ## Needs some cleanup to determine if an empty tag sent
 939                                 ## FIXME ## to the encoder ends up empty.
 940                                 $RUN_COMMAND nice $ENCNICE $MPPENCODER $MPPENCODEROPTS --artist "$TRACKARTIST" --album "$DALBUM" --title "$TRACKNAME" --track "$1" --genre "$CDGENRE" --year "$CDYEAR" --comment "$COMMENT" "$IN" "$OUT"
 941                                 ;;
 942                         m4a)
 943                                 # Quick hack to avoid tagging Ogg/Speex, since there is no other way to tag than inline tagging
 944                                 if [ ! "$DOTAG" = "y" ]; then
 945                                         $RUN_COMMAND nice $ENCNICE $AACENCODER $AACENCODEROPTS --artist "$TRACKARTIST" --album "$DALBUM" --title "$TRACKNAME" --track "$1" --genre "$CDGENRE" --year "$CDYEAR" --comment "$COMMENT" -o "$OUT" "$IN"
 946
 947                                 else
 948                                         $RUN_COMMAND nice $ENCNICE $AACENCODER $AACENCODEROPTS -o "$OUT" "$IN"
 949                                 fi
 950                                 ;;
 951                         wav)
 952                                 # In case of wav output we need nothing. Just keep the wavs.
 953                                 ;;
 954                         esac
 955                         $RUN_COMMAND_PIPES
 956                 done
 957                 # Only remove .wav if the encoding succeeded
 958                 if checkerrors "encodetrack-(.{3,6})-$1"; then :; else
 959                         run_command encodetrack-$1 true
 960                         if [ ! "$KEEPWAVS" = "y" ] ; then
 961                                 if [ ! "$KEEPWAVS" = "move" ] ; then
 962                                         rm -f "$IN"
 963                                 fi
 964                         fi
 965                 fi
 966         else
 967                 run_command "" echo "HEH! The file we were about to encode disappeared:"
 968                 run_command "" echo ">> $IN"
 969                 run_command encodetrack-$1 false
 970         fi
 971 }
 972
 973 # do_preprocess [tracknumber]
 974 # variables used:
 975 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
 976 #do_preprocess ()
 977 #{
 978 #       IN="$ABCDETEMPDIR/track$1.wav"
 979 #       # We need IN to proceed.
 980 #       if [ -s "$IN" ] ; then
 981 #               for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
 982 #               do
 983 #                       #OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
 984 #                       run_command '' echo "Pre-processing track $1 of $TRACKS..."
 985 #                       case "$POSTPROCESSFORMAT" in
 986 #                       all|wav*)
 987 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $WAV_PRE $IF $OF ;;
 988 #                       mp3)
 989 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $MP3_PRE $IF $OF ;;
 990 #                       ogg)
 991 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $OGG_PRE $IF $OF ;;
 992 #                       flac)
 993 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $FLAC_PRE $IF $OF ;;
 994 #                       spx)
 995 #                               run_command preprocess-$OUTPUT-$1 nice $PRENICE $SPX_PRE $IF $OF ;;
 996 #                       esac
 997 #               done
 998 #               # Only remove .wav if the encoding succeeded
 999 #               if checkerrors "preprocess-(.{3,4})-$1"; then
1000 #                       run_command preprocess-$1 false
1001 #               else
1002 #                       run_command preprocess-$1 true
1003 #               fi
1004 #       else
1005 #               if [ "$(checkstatus encode-output)" = "loud" ]; then
1006 #                       echo "HEH! The file we were about to pre-process disappeared:"
1007 #                       echo ">> $IN"
1008 #               fi
1009 #               run_command preprocess-$1 false
1010 #       fi
1011 #}
1012
1013
1014 # do_postprocess [tracknumber]
1015 # variables used:
1016 # TRACKS, TRACKNAME, TRACKARTIST, DISTMP3, DISTMP3OPTS, {FOO}ENCODERSYNTAX, OUTPUTTYPE, ENCODEROPTS, DALBUM, DARTIST, ENCNICE, CDYEAR, CDGENRE, COMMENT
1017 #do_postprocess ()
1018 #{
1019 #       for POSTPROCESSFORMAT in $(echo $POSTPROCESSFORMATS | tr , \ )
1020 #       do
1021 #               IN="$ABCDETEMPDIR/track$1.$POSTPROCESSFORMAT"
1022 #               # We need IN to proceed.
1023 #               if [ -s "$IN" ] ; then
1024 #                       #OUT="$ABCDETEMPDIR/track$1.$OUTPUT"
1025 #                       run_command '' echo "Post-processing track $1 of $TRACKS..."
1026 #                       case "$POSTPROCESSFORMAT" in
1027 #                               mp3)
1028 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $MP3_POST $IF $OF ;;
1029 #                               ogg)
1030 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $OGG_POST $IF $OF ;;
1031 #                               flac)
1032 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $FLAC_POST $IF $OF ;;
1033 #                               spx)
1034 #                                       run_command postprocess-$OUTPUT-$1 nice $POSTNICE $SPX_POST $IF $OF ;;
1035 #                       esac
1036 #                       # Only remove .wav if the encoding succeeded
1037 #                       if checkerrors "postprocess-(.{3,4})-$1"; then
1038 #                               run_command postprocess-$1 false
1039 #                       else
1040 #                               run_command postprocess-$1 true
1041 #                       fi
1042 #               else
1043 #                       if [ "$(checkstatus encode-output)" = "loud" ]; then
1044 #                               echo "HEH! The file we were about to post-process disappeared:"
1045 #                               echo ">> $IN"
1046 #                       fi
1047 #                       run_command postprocess-$1 false
1048 #               fi
1049 #       done
1050 #}
1051
1052 # do_single_gain
1053 # variables used:
1054 # FIXME #
1055 do_single_gain ()
1056 {
1057 :
1058 }
1059
1060 # do_batch_gain
1061 # variables used:
1062 # MP3GAIN, MP3GAINOPTS, VORBISGAIN, VORBISGAINOPTS, MPPGAIN, MPPGAINOPTS
1063 # FIXME #
1064 do_batch_gain ()
1065 {
1066         # The commands here don't go through run_command because they're never supposed to be silenced
1067         echo "Batch analizing gain in tracks: $TRACKQUEUE"
1068         (
1069         cd "$ABCDETEMPDIR"
1070         BLURB=
1071         TRACKFILES=
1072         for UTRACKNUM in $TRACKQUEUE
1073         do
1074                 MP3FILES="$TRACKFILES track$UTRACKNUM.mp3"
1075         done
1076         # FIXME # Hard-coded batch option!
1077         $NORMALIZER -b $NORMALIZEROPTS $TRACKFILES
1078         RETURN=$?
1079         if [ "$RETURN" != "0" ]; then
1080                 echo "batch-normalize: $NORMALIZER returned code $RETURN" >> errors
1081         else
1082                 for UTRACKNUM in $TRACKQUEUE
1083                 do
1084                         echo normalizetrack-$UTRACKNUM >> status
1085                 done
1086         fi
1087         )
1088 }
1089
1090 # do_batch_normalize
1091 # variables used:
1092 # NORMALIZER, NORMALIZEROPTS
1093 do_batch_normalize ()
1094 {
1095         # The commands here don't go through run_command because they're never supposed to be silenced
1096         echo "Batch normalizing tracks: $TRACKQUEUE"
1097         (
1098         cd "$ABCDETEMPDIR"
1099         BLURB=
1100         TRACKFILES=
1101         for UTRACKNUM in $TRACKQUEUE
1102         do
1103                 TRACKFILES="$TRACKFILES track$UTRACKNUM.wav"
1104         done
1105         # XXX: Hard-coded batch option!
1106         $NORMALIZER -b $NORMALIZEROPTS $TRACKFILES
1107         RETURN=$?
1108         if [ "$RETURN" != "0" ]; then
1109                 echo "batch-normalize: $NORMALIZER returned code $RETURN" >> errors
1110         else
1111                 for UTRACKNUM in $TRACKQUEUE
1112                 do
1113                         echo normalizetrack-$UTRACKNUM >> status
1114                 done
1115         fi
1116         )
1117 }
1118
1119 # do_normalize [tracknumber]
1120 # variables used:
1121 # TRACKS, TRACKNAME, NORMALIZER, NORMALIZEROPTS
1122 do_normalize ()
1123 {
1124         IN="$ABCDETEMPDIR/track$1.wav"
1125         if [ -e "$IN" ] ; then
1126                 run_command '' echo "Normalizing track $1 of $TRACKS: $TRACKNAME..."
1127                 run_command normalizetrack-$1 $NORMALIZER $NORMALIZEROPTS "$IN"
1128         else
1129                 if [ "$(checkstatus encode-output)" = "loud" ]; then
1130                         echo "HEH! The file we were about to normalize disappeared:"
1131                         echo ">> $IN"
1132                 fi
1133                 run_command normalizetrack-$1 false "File $IN was not found"
1134         fi
1135 }
1136
1137 # do_move [tracknumber]
1138 # Deduces the outfile from environment variables
1139 # Creates directory if necessary
1140 # variables used:
1141 # TRACKNUM, TRACKNAME, TRACKARTIST, DALBUM, OUTPUTFORMAT, CDGENRE, CDYEAR
1142 do_move ()
1143 {
1144         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1145         do
1146                 # Create ALBUMFILE, ARTISTFILE, TRACKFILE
1147                 # Munge filenames as follows:
1148                 # ' ' -> '_'
1149                 # '/' -> '_'
1150                 # ''' -> ''
1151                 # '?' -> ''
1152                 # Eat control characters
1153                 ALBUMFILE="$(mungefilename "$DALBUM")"
1154                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1155                 TRACKFILE="$(mungefilename "$TRACKNAME")"
1156                 GENRE="$(mungegenre "$GENRE")"
1157                 YEAR="$(echo $CDYEAR)"
1158                 # If we want to start the tracks with a given number, we need to modify the
1159                 # TRACKNUM value before evaluation
1160                 do_gettracknum
1161                 # Supported variables for OUTPUTFORMAT are GENRE, ALBUMFILE, ARTISTFILE,
1162                 # TRACKFILE, and TRACKNUM.
1163                 if [ "$VARIOUSARTISTS" = "y" ]; then
1164                         OUTPUTFILE="$(eval echo "$VAOUTPUTFORMAT")"
1165                 else
1166                         OUTPUTFILE="$(eval echo "$OUTPUTFORMAT")"
1167                 fi
1168                 if checkerrors "tagtrack-$OUTPUT-$1"; then :; else
1169                         # Once we know the specific output was successful, we can change the OUTPUT to the value containing the container
1170                         case $OUTPUT in
1171                                 vorbis|ogg)
1172                                         OUTPUT=$OGGOUTPUTCONTAINER
1173                                         ;;
1174                                 flac)
1175                                         OUTPUT=$FLACOUTPUTCONTAINER
1176                                         ;;
1177                         esac
1178                         # Check that the directory for OUTPUTFILE exists, if it doesn't, create it
1179                         OUTPUTFILEDIR="$(dirname "$OUTPUTDIR/$OUTPUTFILE")"
1180                         case $OUTPUT in
1181                                 wav)
1182                                         if [ "$DOCLEAN" != "y" ] && [ "$FORCE" != "y" ]; then
1183                                                 # FIXME # introduce warnings?
1184                                                 :
1185                                         else
1186                                                 # mkdir -p shouldn't return an error if the directory already exists
1187                                                 mkdir -p "$OUTPUTFILEDIR"
1188                                                 run_command movetrack-$1 mv "$ABCDETEMPDIR/track$1.$OUTPUT" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
1189                                                 if checkstatus movetrack-output-$OUTPUT; then :; else
1190                                                         run_command movetrack-output-$OUTPUT true
1191                                                 fi
1192                                         fi
1193                                         ;;
1194                                 *)
1195                                         # mkdir -p shouldn't return an error if the directory already exists
1196                                         mkdir -p "$OUTPUTFILEDIR"
1197                                         run_command movetrack-$1 mv "$ABCDETEMPDIR/track$1.$OUTPUT" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT"
1198                                         if checkstatus movetrack-output-$OUTPUT; then :; else
1199                                                 run_command movetrack-output-$OUTPUT true
1200                                         fi
1201                                         ;;
1202                         esac
1203                         # Lets move the cue file
1204                         if CUEFILE=$(checkstatus cuefile) >/dev/null ; then
1205                                 if [ -r "$ABCDETEMPDIR/$CUEFILE" ]; then
1206                                         if checkstatus movecue-$OUTPUT; then :; else
1207                                                 # Silence the Copying output since it overlaps with encoding processes...
1208                                                 #run_command '' vecho "Copying cue file to its destination directory..."
1209                                                 if checkstatus onetrack >/dev/null ; then
1210                                                         case $OUTPUT in
1211                                                                 wav)
1212                                                                         if [ "$DOCLEAN" != "y" ] && [ "$FORCE" != "y" ]; then
1213                                                                                 # We dont have the dir, since it was not created before.
1214                                                                                 :
1215                                                                         else
1216                                                                                 run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.cue"
1217                                                                         fi
1218                                                                         ;;
1219                                                                 # NOTE: Creating a cue file with the 3-char-extension files is to comply with
1220                                                                 # http://brianvictor.tripod.com/mp3cue.htm#details
1221                                                                 [a-z0-9][a-z0-9][a-z0-9])
1222                                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.cue"
1223                                                                         ;;
1224                                                                 *)
1225                                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTDIR/$OUTPUTFILE.$OUTPUT.cue"
1226                                                                         ;;
1227                                                         esac
1228                                                 else
1229                                                         run_command movecue-$OUTPUT cp "$ABCDETEMPDIR/$CUEFILE" "$OUTPUTFILEDIR/$CUEFILE"
1230                                                 fi
1231                                                 echo movecue-$OUTPUT >> "$ABCDETEMPDIR/status"
1232                                         fi
1233                                 fi
1234                         fi
1235                 fi
1236         done
1237 }
1238
1239 # do_playlist
1240 # Create the playlist if wanted
1241 # Variables used:
1242 # PLAYLISTFORMAT, PLAYLISTDATAPREFIX, VAPLAYLISTFORMAT, VAPLAYLISTDATAPREFIX,
1243 # VARIOUSARTISTS, OUTPUTDIR
1244 do_playlist ()
1245 {
1246         for OUTPUT in $(echo $OUTPUTTYPE | tr , \ )
1247         do
1248                 case $OUTPUT in
1249                         vorbis|ogg)
1250                                 OUTPUT=$OGGOUTPUTCONTAINER
1251                                 ;;
1252                         flac)
1253                                 OUTPUT=$FLACOUTPUTCONTAINER
1254                                 ;;
1255                 esac
1256                 # Create a playlist file for the playlist data to go into.
1257                 # We used to wipe it out if it existed. Now we request permision if interactive.
1258                 for LASTTRACK in $TRACKQUEUE; do :; done
1259                 ALBUMFILE="$(mungefilename "$DALBUM")"
1260                 ARTISTFILE="$(mungefilename "$DARTIST")"
1261                 GENRE=$(mungegenre "$GENRE")
1262                 YEAR=${CDYEAR:-$CDYEAR}
1263                 if [ "$VARIOUSARTISTS" = "y" ] ; then
1264                         PLAYLISTFILE=$(eval echo $VAPLAYLISTFORMAT)
1265                 else
1266                         PLAYLISTFILE=$(eval echo $PLAYLISTFORMAT)
1267                 fi
1268                 FINALPLAYLISTDIR=$(dirname "$OUTPUTDIR/$PLAYLISTFILE")
1269                 mkdir -p "$FINALPLAYLISTDIR"
1270                 if [ -s "$OUTPUTDIR/$PLAYLISTFILE" ]; then
1271                         echo -n "Erase, Append to, or Keep the existing playlist file? [e/a/k] (e): " >&2
1272                         if [ "$INTERACTIVE" = "y" ]; then
1273                                 while [ "$DONE" != "y" ]; do
1274                                         read ERASEPLAYLIST
1275                                         case $ERASEPLAYLIST in
1276                                                 e|E|a|A|k|K) DONE=y ;;
1277                                                 *) ;;
1278                                         esac
1279                                 done
1280                         else
1281                                 echo e >&2
1282                                 ERASEPLAYLIST=e
1283                         fi
1284                         # Once we erase the playlist, we use append to create the new one.
1285                         [ "$ERASEPLAYLIST" = "e" -o "$ERASEPLAYLIST" = "E" ] && rm -f "$OUTPUTDIR/$PLAYLISTFILE" && ERASEPLAYLIST=a
1286                 else
1287                         # The playlist does not exist, so we can safelly use append to create the new list
1288                         ERASEPLAYLIST=a
1289                 fi
1290                 if [ "$ERASEPLAYLIST" = "a" -o "$ERASEPLAYLIST" = "A" ]; then
1291                         touch "$OUTPUTDIR/$PLAYLISTFILE"
1292                         for UTRACKNUM in $TRACKQUEUE
1293                         do
1294                                 # Shares some code with do_move since the filenames have to match
1295                                 CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
1296                                 do_getcddbinfo TRACKNAME
1297                                 splitvarious
1298                                 TRACKFILE="$(mungefilename "$TRACKNAME")"
1299                                 ARTISTFILE="$(mungefilename "$TRACKARTIST")"
1300                                 ALBUMFILE="$(mungefilename "$DALBUM")"
1301                                 # If we want to start the tracks with a given number, we need to modify the
1302                                 # TRACKNUM value before evaluation
1303                                 do_gettracknum
1304                                 if [ "$VARIOUSARTISTS" = "y" ]; then
1305                                         OUTPUTFILE=$(eval echo $VAOUTPUTFORMAT)
1306                                 else
1307                                         OUTPUTFILE=$(eval echo $OUTPUTFORMAT)
1308                                 fi
1309                                 if [ "$VARIOUSARTISTS" = "y" ]; then
1310                                         if [ "$VAPLAYLISTDATAPREFIX" ] ; then
1311                                                 echo ${VAPLAYLISTDATAPREFIX}$OUTPUTFILE.$OUTPUT >> "$OUTPUTDIR/$PLAYLISTFILE"
1312                                         else
1313                                                 relpath "$PLAYLISTFILE", "$OUTPUTFILE.$OUTPUT" >> "$OUTPUTDIR/$PLAYLISTFILE"
1314                                         fi
1315                                 else
1316                                         if [ "$PLAYLISTDATAPREFIX" ]; then
1317                                                 echo ${PLAYLISTDATAPREFIX}$OUTPUTFILE.$OUTPUT >> "$OUTPUTDIR/$PLAYLISTFILE"
1318                                         else
1319                                                 relpath "$PLAYLISTFILE", "$OUTPUTFILE.$OUTPUT" >> "$OUTPUTDIR/$PLAYLISTFILE"
1320                                         fi
1321                                 fi
1322                         done
1323                 fi
1324                 ## this will convert the playlist to have CRLF line-endings, if specified
1325                 ## (some hardware players insist on CRLF endings)
1326                 if [ "$DOSPLAYLIST" = "y" ]; then
1327                         awk '{substr("\r",""); printf "%s\r\n", $0}' "$OUTPUTDIR/$PLAYLISTFILE" > "$ABCDETEMPDIR/PLAYLISTFILE.tmp"
1328 #                       mv -f "$ABCDETEMPDIR/PLAYLISTFILE.tmp" "$OUTPUTDIR/$PLAYLISTFILE"
1329                         cat "$ABCDETEMPDIR/PLAYLISTFILE.tmp" | sed 's/\//\\/' > "$OUTPUTDIR/$PLAYLISTFILE"
1330                 fi
1331                 echo "playlistcomplete" >> "$ABCDETEMPDIR/status"
1332         done
1333 }
1334
1335 # do_discid
1336 # This essentially the start of things
1337 do_discid ()
1338 {
1339         # Query the CD to get the track info, unless the user specified -C
1340         # or we are using some actions which do not need the CDDB data at all
1341         #if [ ! X"$EXPACTIONS" = "X" ]; then
1342         #       :
1343         #elif [ -z "$DISCID" ]; then
1344         if [ -z "$DISCID" ]; then
1345                 vecho -n "Getting CD track info... "
1346                 # In OSX, unmount the disc before a query
1347                 if [ "$OSFLAVOUR" = "OSX" ]; then
1348                         disktool -u ${CDROM#/dev/}
1349                 fi
1350                 if [ "$CDROMREADERSYNTAX" = "flac" ] ; then
1351                         TRACKINFO=$($METAFLAC $METAFLACOPTS --export-cuesheet-to=- $CDROM | $CUE2DISCID)
1352                 else
1353                         case "$CDDBMETHOD" in
1354                                 cddb) TRACKINFO=$($CDDISCID $CDROM) ;;
1355                                 # FIXME # musicbrainz needs a cleanup
1356                                 musicbrainz) TRACKINFO=$($MUSICBRAINZ -c $CDROM ) ;;
1357                         esac
1358                 fi
1359                 # Make sure there's a CD in there by checking cd-discid's return code
1360                 if [ ! "$?" = "0" ]; then
1361                         if [ "$CDROMREADERSYNTAX" = "flac" ] ; then
1362                                 log error "cuesheet information from the flac file could not be read."
1363                                 log error "Perhaps the flac file does not contain a cuesheet?."
1364                                 exit 1
1365                         else
1366                                 log error "CD could not be read. Perhaps there's no CD in the drive?"
1367                                 exit 1
1368                         fi
1369                 fi
1370                 # In OSX, remount the disc again
1371                 if [ "$OSFLAVOUR" = "OSX" ]; then
1372                         disktool -m ${CDROM#/dev/}
1373                 fi
1374                 WEHAVEACD=y
1375                 DISCID=$(echo $TRACKINFO | cut -f1 -d' ')
1376         else
1377                 TRACKINFO=$(cat "$WAVOUTPUTDIR/abcde.$DISCID/discid")
1378         fi
1379
1380         # Get a full enumeration of tracks, sort it, and put it in the TRACKQUEUE.
1381         # This needs to be done now because a section of the resuming code will need
1382         # it later.
1383
1384         # get the number of digits to pad TRACKNUM with - we'll use this later
1385         # a CD can only hold 99 tracks, but since we support a feature for starting
1386         # numbering the tracks from a given number, we might need to set it as a
1387         # variable for the user to define... or obtain it somehow.
1388         if [ "$PADTRACKS" = "y" ] ; then
1389                 TRACKNUMPADDING=2
1390         fi
1391
1392         ABCDETEMPDIR="$WAVOUTPUTDIR/abcde.$(echo $TRACKINFO | cut -f1 -d' ')"
1393         if [ -z "$TRACKQUEUE" ]; then
1394                 if [ ! "$STRIPDATATRACKS" = "y" ]; then
1395                         case "$CDROMREADERSYNTAX" in
1396                                 cdparanoia|debug)
1397                                         if [ "$WEHAVEACD" = "y" ]; then
1398                                                 vecho "Querying the CD for audio tracks..."
1399                                                 CDPARANOIAOUTPUT="$( $CDROMREADER -$CDPARANOIACDROMBUS $CDROM -Q --verbose 2>&1 )"
1400                                                 RET=$?
1401                                                 if [ ! "$RET" = "0" ];then
1402                                                         log warning "something went wrong while querying the CD... Maybe a DATA CD?"
1403                                                 fi
1404                                                 TRACKS="$(echo "$CDPARANOIAOUTPUT" | egrep '^[[:space:]]+[[:digit:]]' | tail -n 1 | get_first | tr -d "." | tr '\n' ' ')"
1405                                                 CDPARANOIAAUDIOTRACKS="$TRACKS"
1406                                         else
1407                                                 # Previous versions of abcde would store the tracks on a file, instead of the status record.
1408                                                 if [ -f "$ABCDETEMPDIR/cdparanoia-audio-tracks" ]; then
1409                                                         echo cdparanoia-audio-tracks=$( cat "$ABCDETEMPDIR/cdparanoia-audio-tracks" ) >> "$ABCDETEMPDIR/status"
1410                                                         rm -f "$ABCDETEMPDIR/cdparanoia-audio-tracks"
1411                                                 fi
1412                                                 if [ -f "$ABCDETEMPDIR/status" ] && TRACKS=$(checkstatus cdparanoia-audio-tracks); then :; else
1413                                                         TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1414                                                 fi
1415                                         fi
1416                                         ;;
1417                                 *)      TRACKS=$(echo $TRACKINFO | cut -f2 -d' ') ;;
1418                         esac
1419                 else
1420                         TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1421                 fi
1422                 if echo "$TRACKS" | grep "[[:digit:]]" > /dev/null 2>&1 ;then :;else
1423                         log info "The disc does not contain any tracks. Giving up..."
1424                         exit 0
1425                 fi
1426                 echo -n "Grabbing entire CD - tracks: "
1427                 if [ ! "$PADTRACKS" = "y" ] ; then
1428                         TRACKNUMPADDING=$(echo -n $TRACKS | wc -c | tr -d ' ')
1429                 fi
1430                 TRACKS=$(printf "%0.${TRACKNUMPADDING}d" $TRACKS)
1431                 X=0
1432                 while [ "$X" -ne "$TRACKS" ]
1433                 do
1434                         X=$(printf "%0.${TRACKNUMPADDING}d" $(expr $X + 1))
1435                         TRACKQUEUE=$(echo $TRACKQUEUE $X)
1436                 done
1437                 echo $TRACKQUEUE
1438         else
1439                 TRACKS=$(echo $TRACKINFO | cut -f2 -d' ')
1440                 # User-supplied track queue.
1441                 # Weed out non-numbers, whitespace, then sort and weed out duplicates
1442                 TRACKQUEUE=$(echo $TRACKQUEUE | sed 's-[^0-9 ]--g' | tr ' ' '\n' | grep -v ^$ | sort -n | uniq | tr '\n' ' ' | sed 's- $--g')
1443                 # Once cleaned, obtain the highest value in the trackqueue for number padding
1444                 for LASTTRACK in $TRACKQUEUE; do :; done
1445                 if [ ! "$PADTRACKS" = "y" ] ; then
1446                         TRACKNUMPADDING=$(echo -n $LASTTRACK | wc -c | tr -d ' ')
1447                 fi
1448                 # Now we normalize the trackqueue
1449                 for TRACK in $TRACKQUEUE ; do
1450                         TRACKNUM=$(printf %0.${TRACKNUMPADDING}d $(expr ${TRACK} + 0 ))
1451                         PADTRACKQUEUE=$(echo $PADTRACKQUEUE $TRACKNUM)
1452                 done
1453                 TRACKQUEUE=$PADTRACKQUEUE
1454                 echo Grabbing tracks: "$TRACKQUEUE"
1455         fi
1456
1457         QUEUEDTRACKS=$(echo $TRACKQUEUE | wc -w | tr -d ' ')
1458
1459         # We have the discid, create a temp directory after it to store all the temp
1460         # info
1461
1462         if [ -e "$ABCDETEMPDIR" ]; then
1463                 echo -n "abcde: attempting to resume from $ABCDETEMPDIR"
1464                 # It already exists, see if it's a directory
1465                 if [ ! -d "$ABCDETEMPDIR" ]; then
1466                         # This is a file/socket/fifo/device/etc, not a directory
1467                         # Complain and exit
1468                         echo >&2
1469                         echo "abcde: file $ABCDETEMPDIR already exists and does not belong to abcde." >&2
1470                         echo "Please investigate, remove it, and rerun abcde." >&2
1471                         exit 1
1472                 fi
1473                 echo -n .
1474                 # It's a directory, let's see if it's owned by us
1475                 if [ ! -O "$ABCDETEMPDIR" ]; then
1476                         # Nope, complain and exit
1477                         echo >&2
1478                         echo "abcde: directory $ABCDETEMPDIR already exists and is not owned by you." >&2
1479                         echo "Please investigate, remove it, and rerun abcde." >&2
1480                         exit 1
1481                 fi
1482                 echo .
1483                 # See if it's populated
1484                 if [ ! -f "$ABCDETEMPDIR/discid" ]; then
1485                         # Wipe and start fresh
1486                         echo "abcde: $ABCDETEMPDIR/discid not found. Abcde must remove and recreate" >&2
1487                         echo -n "this directory to continue. Continue? [y/n] (n)" >&2
1488                         if [ "$INTERACTIVE" = "y" ]; then
1489                                 read ANSWER
1490                         else
1491                                 echo y >&2
1492                                 ANSWER=y
1493                         fi
1494                         if [ "$ANSWER" != "y" ]; then
1495                                 exit 1
1496                         fi
1497                         rm -rf "$ABCDETEMPDIR" || exit 1
1498                         mkdir "$ABCDETEMPDIR"
1499                         if [ "$?" -gt "0" ]; then
1500                                 # Directory already exists or could not be created
1501                                 echo "abcde: Temp directory $ABCDETEMPDIR could not be created." >&2
1502                                 exit 1
1503                         fi
1504                 else
1505                         # Everything is fine. Check for ^encodetracklocation-
1506                         # and encode-output entries in the status file and
1507                         # remove them. These are not relevant across sessions.
1508                         if [ -f "$ABCDETEMPDIR/status" ]; then
1509                                 mv "$ABCDETEMPDIR/status" "$ABCDETEMPDIR/status.old"
1510                                 grep -v ^encodetracklocation- < "$ABCDETEMPDIR/status.old" \
1511                                         | grep -v ^encode-output > "$ABCDETEMPDIR/status"
1512                         fi
1513                         # Remove old error messages
1514                         if [ -f "$ABCDETEMPDIR/errors" ]; then
1515                                 rm -f "$ABCDETEMPDIR/errors"
1516                         fi
1517                 fi
1518         else
1519                 # We are starting from scratch
1520                 mkdir "$ABCDETEMPDIR"
1521                 if [ "$?" -gt "0" ]; then
1522                         # Directory already exists or could not be created
1523                         echo "abcde: Temp directory $ABCDETEMPDIR could not be created." >&2
1524                         exit 1
1525                 fi
1526                 cat /dev/null > "$ABCDETEMPDIR/status"
1527                 # Store the abcde version in the status file.
1528                 echo "abcde-version=$VERSION" >> "$ABCDETEMPDIR/status"
1529         fi
1530         if [ X"$MAKECUEFILE" = "Xy" -a X"$WEHAVEACD" = "Xy" ]; then
1531                 if checkstatus cuefile > /dev/null 2>&1 ; then :; else
1532                         CUEFILE=cue-$(echo "$TRACKINFO" | cut -f1 -d' ').txt
1533                         vecho "Creating cue file..."
1534                         if $CUEREADER $CUEREADEROPTS > "$ABCDETEMPDIR/$CUEFILE"; then
1535                                 echo cuefile=$CUEFILE >> "$ABCDETEMPDIR/status"
1536                         else
1537                                 log warning "reading the CUE sheet with mkcue is still considered experimental"
1538                                 log warning "and there was a problem with the CD reading. abcde will continue,"
1539                                 log warning "but consider reporting the problem to the abcde author"
1540                         fi
1541                 fi
1542         fi
1543         # If we got the CDPARANOIA status and it is not recorded, save it now
1544         if [ -n "$CDPARANOIAAUDIOTRACKS" ]; then
1545                 if checkstatus cdparanoia-audio-tracks > /dev/null 2>&1; then :; else
1546                         echo cdparanoia-audio-tracks=$CDPARANOIAAUDIOTRACKS >> "$ABCDETEMPDIR/status"
1547                 fi
1548         fi
1549
1550         # Create the discid file
1551         echo "$TRACKINFO" > "$ABCDETEMPDIR/discid"
1552         if checkstatus cddbmethod > /dev/null 2>&1 ; then :; else
1553                 echo "cddbmethod=$CDDBMETHOD" >> "$ABCDETEMPDIR/status"
1554         fi
1555 }
1556
1557 # do_cleancue
1558 # Create a proper CUE file based on the CUE file we created before.
1559 do_cleancue()
1560 {
1561         if CUEFILE_IN="$ABCDETEMPDIR"/$(checkstatus cuefile); then
1562                 CUEFILE_OUT=$CUEFILE_IN.out
1563                 ### FIXME ### checkstatus cddb
1564                 if [ -e "$CDDBDATA" ]; then
1565                         vecho "Adding metadata to the cue file..."
1566                         # FIXME It doesn't preserve spaces! Why?
1567                         # FIXME parse $track into PERFORMER and TITLE - abcde already has code for this?
1568                         n=1
1569                         echo "PERFORMER \"$DARTIST\"" >> "$CUEFILE_OUT"
1570                         echo "TITLE \"$DALBUM\"" >> "$CUEFILE_OUT"
1571                         cat "$CUEFILE_IN" | while read line
1572                         do
1573                                 if echo "$line" | grep -q "INDEX"
1574                                 then
1575                                         eval track="\$TRACK$n"
1576                                         n=$(expr $n + 1)
1577                                         echo "TITLE \"$track\"" >> "$CUEFILE_OUT"
1578                                 fi
1579                                 echo "$line" >> "$CUEFILE_OUT"
1580                         done
1581                         mv "$CUEFILE_OUT" "$CUEFILE_IN"
1582                         echo "cleancuefile" >> "$ABCDETEMPDIR/status"
1583                 fi
1584         fi
1585 }
1586
1587 # do_cddbparse
1588 # Parses a CDDB file and outputs the title and the track names.
1589 # Variables: CDDBFILE
1590 do_cddbparse ()
1591 {
1592         CDDBPARSEFILE="$1"
1593         # List out disc title/author and contents
1594         if [ "$ONETRACK" = "y" ]; then
1595                 vecho "ONETRACK mode selected: displaying only the title of the CD..."
1596         fi
1597         echo "---- $(grep DTITLE "${CDDBPARSEFILE}" | cut '-d=' -f2- | tr -d \\r\\n ) ----"
1598         if [ X"$SHOWCDDBYEAR" = "Xy" ]; then
1599                 PARSEDYEAR=$(grep DYEAR "${CDDBPARSEFILE}" | cut '-d=' -f2-)
1600                 if [ ! X"$PARSEDYEAR" = "X" ]; then
1601                         echo "Year: $PARSEDYEAR"
1602                 fi
1603         fi
1604         if [ X"$SHOWCDDBGENRE" = "Xy" ]; then
1605                 PARSEDGENRE=$(grep DGENRE "${CDDBPARSEFILE}" | cut '-d=' -f2-)
1606                 if [ ! X"$PARSEDGENRE" = "X" ]; then
1607                         echo "Genre: $PARSEDGENRE"
1608                 fi
1609         fi
1610         if [ ! "$ONETRACK" = "y" ]; then
1611                 for TRACK in $(f_seq_row 1 $TRACKS)
1612                 do
1613                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "${CDDBPARSEFILE}" | cut -f2- -d= | tr -d \\r\\n)"
1614                 done
1615         fi
1616 }
1617
1618 # do_localcddb
1619 # Check for a local CDDB file, and report success
1620 do_localcddb ()
1621 {
1622         if checkstatus cddb-readcomplete && checkstatus cddb-choice >/dev/null; then :; else
1623
1624                 CDDBLOCALSUCCESS="n"
1625                 CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
1626                 CDDBLOCALFILE="${CDDBLOCALDIR}/${CDDBDISCID}"
1627                 USELOCALRESP="y"
1628
1629                 # If the user has selected to check a local CDDB repo, we proceed with it
1630                 if [ -r "${CDDBLOCALFILE}" ]; then
1631                         # List out disc title/author and contents
1632                         do_cddbparse "${CDDBLOCALFILE}"
1633                         echo -n "Locally cached CDDB entry found, use it? [y/n] (y): "
1634                         if [ "$INTERACTIVE" = "y" ]; then
1635                                 read USELOCALRESP
1636                                 while [ "$USELOCALRESP" != "y" ] && [ "$USELOCALRESP" != "n" ] && [ "$USELOCALRESP" != "" ] ; do
1637                                         echo -n 'Invalid selection. Please answer "y" or "n": '
1638                                         read USELOCALRESP
1639                                 done
1640                                 [ x"$USELOCALRESP" = "x" ] && USELOCALRESP="y"
1641                         else
1642                                 echo "y" >&2
1643                         fi
1644                         if [ "$USELOCALRESP" = "y" ]; then
1645                                 #echo "Using local copy of CDDB data"
1646                                 echo "# DO NOT ERASE THIS LINE! Added by abcde to imitate cddb output" > "$ABCDETEMPDIR/cddbread.1"
1647                                 cat "${CDDBLOCALFILE}" >> "$ABCDETEMPDIR/cddbread.1"
1648                                 echo 999 > "$ABCDETEMPDIR/cddbquery" # Assuming 999 isn't used by CDDB
1649                                 echo cddb-readcomplete >> "$ABCDETEMPDIR/status"
1650                                 do_cddbparse "${CDDBLOCALFILE}" > "$ABCDETEMPDIR/cddbchoices"
1651                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
1652                                 CDDBLOCALSUCCESS="y"
1653                         else
1654                                 #echo "Not using local copy of CDDB data"
1655                                 CDDBLOCALSUCCESS="n"
1656                         fi
1657                 else
1658                         CDDBLOCALSUCCESS="n"
1659                 fi
1660         fi
1661 }
1662
1663 do_musicbrainzstat ()
1664 {
1665         :
1666 }
1667
1668 do_musizbrainz ()
1669 {
1670         :
1671 }
1672
1673 # do_cddbstat
1674 do_cddbstat ()
1675 {
1676         # Perform CDDB protocol version check if it hasn't already been done
1677         if checkstatus cddb-statcomplete; then :; else
1678                 if [ "$CDDBAVAIL" = "n" ]; then
1679                         ERRORCODE=no_query
1680                         echo 503 > "$ABCDETEMPDIR/cddbstat"
1681                 else
1682                         rc=1
1683                         CDDBUSER=$(echo $HELLOINFO | cut -f1 -d'@')
1684                         CDDBHOST=$(echo $HELLOINFO | cut -f2- -d'@')
1685                         while test $rc -eq 1 -a $CDDBPROTO -ge 3; do
1686                                 vecho "Checking CDDB server status..."
1687                                 $CDDBTOOL stat $CDDBURL $CDDBUSER $CDDBHOST $CDDBPROTO > "$ABCDETEMPDIR/cddbstat"
1688                                 RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbstat" | cut -f1 -d' ')
1689                                 case "$RESPONSECODE" in
1690                                 210)    # 210 OK, status information follows (until terminating `.')
1691                                         rc=0;
1692                                         ;;
1693                                 501|*)  # 501 Illegal CDDB protocol level: <n>.
1694                                         CDDBPROTO=`expr $CDDBPROTO - 1`
1695                                         ;;
1696                                 esac
1697                         done
1698                         if test $rc -eq 1; then
1699                                 CDDBAVAIL="n"
1700                         fi
1701                 fi
1702                 echo cddb-statcomplete >> "$ABCDETEMPDIR/status"
1703         fi
1704 }
1705
1706
1707 # do_cddbquery
1708 do_cddbquery ()
1709 {
1710         CDDBDISCID=$(echo $TRACKINFO | cut -d' ' -f1)
1711         CDDBLOCALFILE="${CDDBLOCALDIR}/${CDDBDISCID}"
1712
1713         # Perform CDDB query if it hasn't already been done
1714         if checkstatus cddb-querycomplete; then :; else
1715                 if [ "$CDDBAVAIL" = "n" ]; then
1716                         ERRORCODE=no_query
1717                         echo 503 > "$ABCDETEMPDIR/cddbquery"
1718                 # The default CDDBLOCALSUCCESS is "n"
1719                 # This part will be triggered if the user CDDB repo does not
1720                 # contain the entry, or if we are not trying to use the repo.
1721                 else
1722                         vecho "Querying the CDDB server..."
1723                         CDDBUSER=$(echo $HELLOINFO | cut -f1 -d'@')
1724                         CDDBHOST=$(echo $HELLOINFO | cut -f2- -d'@')
1725                         $CDDBTOOL query $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $TRACKINFO > "$ABCDETEMPDIR/cddbquery"
1726                         ERRORCODE=$?
1727                         case $ERRORCODE in
1728                                 0)  # success
1729                                 ;;
1730                                 12|13|14)
1731                                         # no match found in database,
1732                                         # wget/fetch error, or user requested not to use CDDB
1733                                         # Make up an error code (503) that abcde
1734                                         # will recognize in do_cddbread
1735                                         # and compensate by making a template
1736                                         echo 503 > "$ABCDETEMPDIR/cddbquery"
1737                                 ;;
1738                                 *) # strange and unknown error
1739                                         echo ERRORCODE=$ERRORCODE
1740                                         echo "abcde: $CDDBTOOL returned unknown error code"
1741                                 ;;
1742                         esac
1743                 fi
1744                 echo cddb-querycomplete >> "$ABCDETEMPDIR/status"
1745         fi
1746 }
1747
1748 # do_cddbread
1749 do_cddbread ()
1750 {
1751         # If it's not to be used, generate a template.
1752         # Then, display it (or them) and let the user choose/edit it
1753         if checkstatus cddb-readcomplete; then :; else
1754                 vecho "Obtaining CDDB results..."
1755                 # If CDDB is to be used, interpret the query results and read all
1756                 # the available entries.
1757                 rm -f "$ABCDETEMPDIR/cddbchoices"
1758                 CDDBCHOICES=1 # Overridden by multiple matches
1759                 RESPONSECODE=$(head -n 1 "$ABCDETEMPDIR/cddbquery" | cut -f1 -d' ')
1760                 case "$RESPONSECODE" in
1761                 200)
1762                         # One exact match, retrieve it
1763                         # 200 [section] [discid] [artist] / [title]
1764                         if checkstatus cddb-read-1-complete; then :; else
1765                                 echo -n "Retrieving 1 CDDB match..." >> "$ABCDETEMPDIR/cddbchoices"
1766                                 $CDDBTOOL read $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $(cut -f2,3 -d' ' "$ABCDETEMPDIR/cddbquery") > "$ABCDETEMPDIR/cddbread.1"
1767                                 echo "done." >> "$ABCDETEMPDIR/cddbchoices"
1768                                 echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
1769                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
1770                         fi
1771                         # List out disc title/author and contents
1772                         echo ---- "$(cut '-d ' -f4- "$ABCDETEMPDIR/cddbquery")" ---- >> "$ABCDETEMPDIR/cddbchoices"
1773                         for TRACK in $(f_seq_row 1 $TRACKS)
1774                         do
1775                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
1776                         done
1777                         echo >> "$ABCDETEMPDIR/cddbchoices"
1778                         ;;
1779                 202|403|409|503)
1780                         # No match
1781                         case "$RESPONSECODE" in
1782                         202) echo "No CDDB match." >> "$ABCDETEMPDIR/cddbchoices" ;;
1783                         403|409) echo "CDDB entry is corrupt, or the handshake failed." >> "$ABCDETEMPDIR/cddbchoices" ;;
1784                         503) echo "CDDB unavailable." >> "$ABCDETEMPDIR/cddbchoices" ;;
1785                         esac
1786                         $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
1787                         # List out disc title/author and contents of template
1788                         echo ---- Unknown Artist / Unknown Album ---- >> "$ABCDETEMPDIR/cddbchoices"
1789                         UNKNOWNDISK=y
1790                         for TRACK in $(f_seq_row 1 $TRACKS)
1791                         do
1792                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.0" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
1793                         done
1794                         echo >> "$ABCDETEMPDIR/cddbchoices"
1795                         echo cddb-read-0-complete >> "$ABCDETEMPDIR/status"
1796                         echo cddb-choice=0 >> "$ABCDETEMPDIR/status"
1797                         ;;
1798                 210|211)
1799                         # Multiple exact, (possibly multiple) inexact matches
1800                         IN=
1801                         if [ "$RESPONSECODE" = "211" ]; then IN=in; fi
1802                         if [ "$(wc -l < "$ABCDETEMPDIR/cddbquery" | tr -d ' ')" -eq 3 ]; then
1803                                 echo "One ${IN}exact match:" >> "$ABCDETEMPDIR/cddbchoices"
1804                                 tail -n +2 "$ABCDETEMPDIR/cddbquery" | head -n 1 >> "$ABCDETEMPDIR/cddbchoices"
1805                                 echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
1806                         else
1807                                 echo "Multiple ${IN}exact matches:" >> "$ABCDETEMPDIR/cddbchoices"
1808                         fi
1809                         vecho -n "Retrieving multiple matches... "
1810                         grep -v ^[.]$ "$ABCDETEMPDIR/cddbquery" | ( X=0
1811                         read DISCINFO # eat top line
1812                         while read DISCINFO
1813                         do
1814                                 X=$(expr $X + 1)
1815                                 if checkstatus cddb-read-$X-complete; then :; else
1816                                         $CDDBTOOL read $CDDBURL $CDDBPROTO $CDDBUSER $CDDBHOST $(echo $DISCINFO | cut -f1,2 -d' ') > "$ABCDETEMPDIR/cddbread.$X"
1817                                         echo cddb-read-$X-complete >> "$ABCDETEMPDIR/status"
1818                                 fi
1819                                 # List out disc title/author and contents
1820                                 echo \#$X: ---- "$DISCINFO" ---- >> "$ABCDETEMPDIR/cddbchoices"
1821                                 for TRACK in $(f_seq_row 1 $TRACKS)
1822                                 do
1823                                         echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.$X" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
1824                                 done
1825                                 echo >> "$ABCDETEMPDIR/cddbchoices"
1826                         done )
1827                         vecho "done."
1828                         CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
1829                         ;;
1830                 999)
1831                         # Using local copy.
1832                         for TRACK in $(f_seq_row 1 $TRACKS)
1833                         do
1834                                 echo $TRACK: "$(grep ^TTITLE$(expr $TRACK - 1)= "$ABCDETEMPDIR/cddbread.1" | cut -f2- -d= | tr -d \\r\\n)" >> "$ABCDETEMPDIR/cddbchoices"
1835                         done
1836                         echo >> "$ABCDETEMPDIR/cddbchoices"
1837                         echo cddb-read-1-complete >> "$ABCDETEMPDIR/status"
1838                         echo cddb-choice=1 >> "$ABCDETEMPDIR/status"
1839                         ;;
1840                 esac
1841                 echo "cddb-readcomplete" >> "$ABCDETEMPDIR/status"
1842         fi
1843 }
1844
1845 # do_cddbedit
1846 do_cddbedit ()
1847 {
1848         if checkstatus cddb-edit >/dev/null; then
1849                 CDDBDATA="$ABCDETEMPDIR/cddbread.$(checkstatus cddb-choice)"
1850                 VARIOUSARTISTS="$(checkstatus variousartists)"
1851                 VARIOUSARTISTSTYLE="$(checkstatus variousartiststyle)"
1852                 return 0
1853         fi
1854         if [ "$INTERACTIVE" = "y" ]; then
1855                 # We should show the CDDB results both when we are not using the local CDDB repo
1856                 # or when we are using it but we could not find a proper match
1857                 if [ "$CDDBUSELOCAL" = "y" ] && [ ! "$CDDBLOCALSUCCESS" = "y" ] || [ ! "$CDDBUSELOCAL" = "y" ]; then
1858                         # Display the $ABCDETEMPDIR/cddbchoices file created above
1859                         # Pick a pager so that if the tracks overflow the screen the user can still view everything
1860                         if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
1861                                 CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
1862                                 CHOICE=$(checkstatus cddb-choice)
1863                                 if [ -n "$CHOICE" ] ; then
1864                                         case $CDDBCHOICES in
1865                                                 -1) log error "CDDB query failed!"
1866                                                         exit 1
1867                                                         ;;
1868                                                 1) cat "$ABCDETEMPDIR/cddbchoices" ;;
1869                                                 *)
1870                                                 echo "Selected: #$CHOICE"
1871                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$CHOICE"
1872                                                 ;;
1873                                         esac
1874                                 else
1875                                         # The user has a choice to make, display the info in a pager if necessary
1876                                         if [ $(cat "$ABCDETEMPDIR/cddbchoices" | wc -l) -ge 24 ]; then
1877                                                 page "$ABCDETEMPDIR/cddbchoices"
1878                                         else
1879                                                 # It's all going to fit in one page, cat it
1880                                                 cat "$ABCDETEMPDIR/cddbchoices" >&2
1881                                         fi
1882
1883                                         CDDBCHOICENUM=""
1884                                         # Setting the choice to an impossible integer to avoid errors in the numeric comparisons
1885                                         CDCHOICENUM=-1
1886                                         # I'll take CDDB read #3 for $400, Alex
1887                                         while [ $CDCHOICENUM -lt 0 ] || [ $CDCHOICENUM -gt $CDDBCHOICES ]; do
1888                                                 echo -n "Which entry would you like abcde to use (0 for none)? [0-$CDDBCHOICES]: " >&2
1889                                                 read CDDBCHOICE
1890                                                 [ X"$CDDBCHOICE" = "X" ] && CDDBCHOICE=1
1891                                                 if echo $CDDBCHOICE | egrep -q "[[:space:]]*[[:digit:]]+,[[:digit:]]+[[:space:]]*" ; then
1892                                                         if [ ! X"$DIFF" = "X" ]; then
1893                                                                 PARSECHOICE1=$(echo $CDDBCHOICE | cut -d"," -f1 | xargs printf %d 2>/dev/null)
1894                                                                 PARSECHOICE2=$(echo $CDDBCHOICE | cut -d"," -f2 | xargs printf %d 2>/dev/null)
1895                                                                 if [ $PARSECHOICE1 -lt 1 ] || [ $PARSECHOICE1 -gt $CDDBCHOICES ] || \
1896                                                                    [ $PARSECHOICE2 -lt 1 ] || [ $PARSECHOICE2 -gt $CDDBCHOICES ] || \
1897                                                                    [ $PARSECHOICE1 -eq $PARSECHOICE2 ]; then
1898                                                                         echo "Invalid diff range. Please select two coma-separated numbers between 1 and $CDDBCHOICES" >&2
1899                                                                 else
1900                                                                         # We parse the 2 choices to diff, store them in temporary files and diff them.
1901                                                                         for PARSECHOICE in $(echo $CDDBCHOICE | tr , \ ); do
1902                                                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$PARSECHOICE" > "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE"
1903                                                                         done
1904                                                                         echo "Showing diff between choices $PARSECHOICE1 and $PARSECHOICE2..." > "$ABCDETEMPDIR/cddbread.diff"
1905                                                                         $DIFF $DIFFOPTS "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE1" "$ABCDETEMPDIR/cddbread.parsechoice.$PARSECHOICE2" >> "$ABCDETEMPDIR/cddbread.diff"
1906                                                                         if [ $(cat "$ABCDETEMPDIR/cddbread.diff" | wc -l) -ge 24 ]; then
1907                                                                                 page "$ABCDETEMPDIR/cddbread.diff"
1908                                                                         else
1909                                                                                 cat "$ABCDETEMPDIR/cddbread.diff" >&2
1910                                                                         fi
1911                                                                 fi
1912                                                         else
1913                                                                 echo "The diff program was not found in your path. Please choose a number between 0 and $CDDBCHOICES." >&2
1914                                                         fi
1915                                                 elif echo $CDDBCHOICE | egrep -q "[[:space:]]*[[:digit:]]+[[:space:]]*" ; then
1916                                                         # Make sure we get a valid choice
1917                                                         CDCHOICENUM=$(echo $CDDBCHOICE | xargs printf %d 2>/dev/null)
1918                                                         if [ $CDCHOICENUM -lt 0 ] || [ $CDCHOICENUM -gt $CDDBCHOICES ]; then
1919                                                                 echo "Invalid selection. Please choose a number between 0 and $CDDBCHOICES." >&2
1920                                                         fi
1921                                                 fi
1922                                         done
1923                                         if [ "$CDCHOICENUM" = "0" ]; then
1924                                                 vecho "Creating empty CDDB template..."
1925                                                 UNKNOWNDISK=y
1926                                                 $CDDBTOOL template $(cat "$ABCDETEMPDIR/discid") > "$ABCDETEMPDIR/cddbread.0"
1927                                         else
1928                                                 echo "Selected: #$CDCHOICENUM ($(grep ^DTITLE= "$ABCDETEMPDIR/cddbread.$CDCHOICENUM" | cut -f2- -d= | tr -d \\r\\n))" >&2
1929                                                 do_cddbparse "$ABCDETEMPDIR/cddbread.$CDCHOICENUM"
1930                                         fi
1931                                         echo "cddb-choice=$CDCHOICENUM" >> "$ABCDETEMPDIR/status"
1932                                 fi
1933                         fi
1934                 else
1935                         # We need some code to show the selected option when local repository is selected and we have found a match
1936                         vecho "Using cached CDDB match..." >&2
1937                         # Display the $ABCDETEMPDIR/cddbchoices file created above
1938                         # Pick a pager so that if the tracks overflow the screen the user can still view everything
1939                         if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
1940                                 CDDBCHOICES=$(expr $(cat "$ABCDETEMPDIR/cddbquery" | wc -l) - 2)
1941                                 CHOICE=$(checkstatus cddb-choice)
1942                                 if [ "$USELOCALRESP" = "y" ]; then :; else
1943                                         if [ -n "$CHOICE" ] ; then
1944                                                 case $CDDBCHOICES in
1945                                                         0)
1946                                                         UNKNOWNDISK=y
1947                                                         echo "Selected template."
1948                                                         ;;
1949                                                         1) cat "$ABCDETEMPDIR/cddbchoices" ;;
1950                                                         *)
1951                                                         echo "Selected: #$CHOICE"
1952                                                         do_cddbparse "$ABCDETEMPDIR/cddbread.$CHOICE"
1953                                                         ;;
1954                                                 esac
1955                                         fi
1956                                 fi
1957                         fi
1958                 fi
1959         else
1960                 # We're noninteractive - pick the first choice.
1961                 # But in case we run a previous instance and selected a choice, use it.
1962                 if [ -r "$ABCDETEMPDIR/cddbchoices" ]; then
1963                         # Show the choice if we are not using the locally stored one
1964                         # or when the local search failed to find a match.
1965                         PREVIOUSCHOICE=$(checkstatus cddb-choice)
1966                         if [ "$CDDBUSELOCAL" = "y" ] && [ "$CDDBLOCALSUCCESS" = "n" ] || [ ! "$CDDBUSELOCAL" = "y" ]; then
1967                                 #if [ "$PREVIOUSCHOICE" ]; then
1968                                         cat "$ABCDETEMPDIR/cddbchoices"
1969                                 #fi
1970                         fi
1971                         if [ ! -z "$PREVIOUSCHOICE" ] ; then
1972                                 CDCHOICENUM=$PREVIOUSCHOICE
1973                         else
1974                                 CDCHOICENUM=1
1975                                 echo "cddb-choice=$CDCHOICENUM" >> "$ABCDETEMPDIR/status"
1976                         fi
1977                         echo "Selected: #$CDCHOICENUM ($(grep ^DTITLE= "$ABCDETEMPDIR/cddbread.$CDCHOICENUM" | cut -f2- -d= | tr -d \\r\\n))" >&2
1978                 fi
1979         fi
1980
1981         # sanity check
1982         if checkstatus cddb-choice >/dev/null; then :; else
1983                 echo "abcde: internal error: cddb-choice not recorded." >&2
1984                 exit 1
1985         fi
1986         CDDBDATA="$ABCDETEMPDIR/cddbread.$(checkstatus cddb-choice)"
1987         echo -n "Edit selected CDDB data? [y/n] (" >&2
1988         if [ "$INTERACTIVE" = "y" ]; then
1989                 if [ "$UNKNOWNDISK" = "y" ]; then
1990                         echo -n "y): " >&2
1991                         read EDITCDDB
1992                         [ "$EDITCDDB" != "n" ] && EDITCDDB=y
1993                 else
1994                         echo -n "n): " >&2
1995                         read EDITCDDB
1996                 fi
1997         else
1998                 echo "n): n" >&2
1999                 EDITCDDB=n
2000         fi
2001         if [ "$EDITCDDB" = "y" ]; then
2002                 CDDBDATAMD5SUM=$($MD5SUM "$CDDBDATA" | cut -d " " -f 1);
2003
2004                 # Use the debian sensible-editor wrapper to pick the editor that the
2005                 # user has requested via their $EDITOR environment variable
2006                 if [ -x "/usr/bin/sensible-editor" ]; then
2007                         /usr/bin/sensible-editor "$CDDBDATA"
2008                 elif [ -n "$EDITOR" ]; then
2009                         if [ -x $(which "${EDITOR%%\ *}") ]; then
2010                                 # That failed, try to load the preferred editor, starting
2011                                 # with their EDITOR variable
2012                                 eval $(echo "$EDITOR") \"$CDDBDATA\"
2013                         fi
2014                 # If that fails, check for a vi
2015                 elif which vi >/dev/null 2>&1; then
2016                         vi "$CDDBDATA"
2017                 elif [ -x /usr/bin/vim ]; then
2018                         /usr/bin/vim "$CDDBDATA"
2019                 elif [ -x /usr/bin/vi ]; then
2020                         /usr/bin/vi "$CDDBDATA"
2021                 elif [ -x /bin/vi ]; then
2022                         /bin/vi "$CDDBDATA"
2023                 # nano should be on all (modern, i.e., sarge) debian systems
2024                 elif which nano >/dev/null 2>&1 ; then
2025                         nano "$CDDBDATA"
2026                 elif [ -x /usr/bin/nano ]; then
2027                         /usr/bin/nano "$CDDBDATA"
2028                 # mg should be on all OpenBSD systems
2029                 elif which mg >/dev/null 2>&1 ; then
2030                         mg "$CDDBDATA"
2031                 elif [ -x /usr/bin/mg ]; then
2032                         /usr/bin/mg "$CDDBDATA"
2033                 # bomb out
2034                 else
2035                         log warning "no editor available. Check your EDITOR environment variable."
2036                 fi
2037                 # delete editor backup file if it exists
2038                 if [ -w "$CDDBDATA~" ]; then
2039                         rm -f "$CDDBDATA~"
2040                 fi
2041         fi
2042
2043         # Some heuristics first. Look at Disc Title, and if it starts with
2044         # "Various", then we'll assume Various Artists
2045         if [ "$(grep ^DTITLE= "$CDDBDATA" | cut -f2- -d= | egrep -ci '^(various|soundtrack|varios|sonora|ost)')" != "0" ]; then
2046                 echo "Looks like a Multi-Artist CD" >&2
2047                 VARIOUSARTISTS=y
2048         else
2049                 echo -n "Is the CD multi-artist? [y/n] (n): " >&2
2050                 if [ "$INTERACTIVE" = "y" ]; then
2051                         read VARIOUSARTISTS
2052                 else
2053                         echo n >&2
2054                         VARIOUSARTISTS=n
2055                 fi
2056         fi
2057         if [ "$VARIOUSARTISTS" = "y" ] && [ ! "$ONETRACK" = "y" ]; then
2058                 # Set a default
2059                 DEFAULTSTYLE=1
2060                 # Need NUMTRACKS before cddb-tool will return it:
2061                 NUMTRACKS=$(egrep '^TTITLE[0-9]+=' "$CDDBDATA" | wc -l)
2062                 if [ "$(grep -c "^TTITLE.*\/" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2063                         # More than 1/2 tracks contain a "/", so guess forward
2064                         DEFAULTSTYLE=1
2065                 elif [ "$(grep -c "^TTITLE.*\-" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2066                         # More than 1/2 contain a "-", so guess forward-dash
2067                         DEFAULTSTYLE=2
2068                 elif [ "$(grep -c "^TTITLE.*(.*)" "$CDDBDATA")" -gt "$(expr $NUMTRACKS / 2 )" ]; then
2069                         # More than 1/2 contain something in parens, so guess trailing-paren
2070                         DEFAULTSTYLE=6
2071                 fi
2072
2073                 echo "1) Artist / Title" >&2
2074                 echo "2) Artist - Title" >&2
2075                 echo "3) Title / Artist" >&2
2076                 echo "4) Title - Artist" >&2
2077                 echo "5) Artist: Title" >&2
2078                 echo "6) Title (Artist)" >&2
2079                 echo "7) This is a single-artist CD" >&2
2080                 echo -n "Which style of multiple artist entries is it? [1-7] ($DEFAULTSTYLE): " >&2
2081                 if [ "$INTERACTIVE" = "y" ]; then
2082                         read VARIOUSARTISTSTYLE
2083                 else
2084                         echo $DEFAULTSTYLE >&2
2085                         VARIOUSARTISTSTYLE=$DEFAULTSTYLE
2086                 fi
2087                 VARIOUSARTISTSTYLE=$(echo 0$VARIOUSARTISTSTYLE | xargs printf %d)
2088                 # If they press Enter, then the default style (0) was chosen
2089                 while [ $VARIOUSARTISTSTYLE -lt 0 ] || [ $VARIOUSARTISTSTYLE -gt 7 ]; do
2090                         echo "Invalid selection. Please choose a number between 1 and 7."
2091                         echo -n "Selection [1-7]: "
2092                         read VARIOUSARTISTSTYLE
2093                         VARIOUSARTISTSTYLE=$(echo 0$VARIOUSARTISTSTYLE | xargs printf %d)
2094                 done
2095                 if [ "$VARIOUSARTISTSTYLE" = "0" ]; then
2096                         VARIOUSARTISTSTYLE=$DEFAULTSTYLE
2097                 fi
2098                 vecho "Selected: $VARIOUSARTISTSTYLE"
2099                 case "$VARIOUSARTISTSTYLE" in
2100                 1) # Artist / Title
2101                         VARIOUSARTISTSTYLE=forward
2102                         ;;
2103                 2) # Artist - Title
2104                         VARIOUSARTISTSTYLE=forward-dash
2105                         ;;
2106                 3) # Title / Artist
2107                         VARIOUSARTISTSTYLE=reverse
2108                         ;;
2109                 4) # Title - Artist
2110                         VARIOUSARTISTSTYLE=reverse-dash
2111                         ;;
2112                 5) # Artist: Title
2113                         VARIOUSARTISTSTYLE=colon
2114                         ;;
2115                 6) # Title (Artist)
2116                         VARIOUSARTISTSTYLE=trailing-paren
2117                         ;;
2118                 7) # Single Artist
2119                         VARIOUSARTISTS=n
2120                         ;;
2121                 esac
2122         fi
2123
2124         echo "variousartists=$VARIOUSARTISTS" >> "$ABCDETEMPDIR/status"
2125         echo "variousartiststyle=$VARIOUSARTISTSTYLE" >> "$ABCDETEMPDIR/status"
2126
2127         if [ "$EDITCDDB" = "y" ] && [ "$UNINTENTIONALLY_ANGER_THE_FREEDB_PEOPLE" = "y" ]; then
2128                 if [ "$CDDBDATAMD5SUM" != "" ]  && [ "$CDDBDATAMD5SUM" != "$($MD5SUM "$CDDBDATA" | cut -d " " -f 1)" ]; then
2129                         # This works but does not have the necessary error checking
2130                         # yet. If you are familiar with the CDDB spec
2131                         # (see http://www.freedb.org/src/latest/DBFORMAT)
2132                         # and can create an error-free entry on your own, then put
2133                         # UNINTENTIONALLY_ANGER_THE_FREEDB_PEOPLE=y in your
2134                         # abcde.conf to enable it. Put CDDBSUBMIT=email@address in
2135                         # your abcde.conf to change the email address submissions are
2136                         # sent to.
2137
2138                         # submit the modified file, if they want
2139                         if [ "$NOSUBMIT" != "y" ]; then
2140                                 echo -n "Do you want to submit this entry to $CDDBSUBMIT? [y/n] (n): "
2141                                 read YESNO
2142                                 while [ "$YESNO" != "y" ] && [ "$YESNO" != "n" ] && [ "$YESNO" != "Y" ] && \
2143                                         [ "$YESNO" != "N" ] && [ "$YESNO" != "" ]
2144                                 do
2145                                         echo -n 'Invalid selection. Please answer "y" or "n": '
2146                                         read YESNO
2147                                 done
2148                                 if [ "$YESNO" = "y" ] || [ "$YESNO" = "Y" ]; then
2149                                         echo -n "Sending..."
2150                                         $CDDBTOOL send "$CDDBDATA" $CDDBSUBMIT
2151                                         echo "done."
2152                                 fi
2153                         fi
2154                 fi
2155         fi
2156         # Make sure the cache directory exists
2157         mkdir -p $CDDBLOCALDIR
2158         # Cache edited CDDB entry in the user's cddb dir
2159         if [ "$CDDBCOPYLOCAL" = "y" ] || [ "$COPYCDDBLOCAL" = "Y" ]; then
2160                 cat "$CDDBDATA" | tail -n $(expr $(cat "$CDDBDATA" | wc -l ) - 1 ) > ${CDDBLOCALDIR}/$(echo "$TRACKINFO" | cut -d' ' -f1)
2161         fi
2162
2163         echo "cddb-edit" >> "$ABCDETEMPDIR/status"
2164 }
2165
2166 # do_cdread [tracknumber]
2167 # do_cdread onetrack [firsttrack] [lasttrack]
2168 #
2169 do_cdread ()
2170 {
2171         # The commands here don't go through run_command because they're never supposed to be silenced
2172         # return codes need to be doublechecked anyway, however
2173         if [ "$1" = "onetrack" ]; then
2174                 # FIXME # Add the possibility of grabbing ranges of tracks in onetrack
2175                 # FIXME # Until then, we grab the whole CD in one track, no matter what
2176                 # the user said
2177                 # We need the first and last track for cdda2wav
2178                 FIRSTTRACK=$2
2179                 LASTTRACK=$3
2180                 UTRACKNUM=$FIRSTTRACK
2181                 case "$CDROMREADERSYNTAX" in
2182                         flac) READTRACKNUMS="$FIRSTTRACK.1-$(($LASTTRACK + 1)).0" ;;
2183                         cdparanoia) READTRACKNUMS="$FIRSTTRACK-$LASTTRACK" ;;
2184                         cdda2wav) READTRACKNUMS="$FIRSTTRACK+$LASTRACK" ;;
2185                         *) echo "abcde error: $CDROMREADERSYNTAX does not support ONETRACK mode"
2186                                 exit 1 ;;
2187                 esac
2188         else
2189                 UTRACKNUM=$1
2190         fi
2191         CDDBTRACKNUM=$(expr $UTRACKNUM - 1)
2192         if [ "$USEPIPES" = "y" ]; then
2193                 TEMPARG="PIPERIPPER_$CDROMREADERSYNTAX"
2194                 FILEARG="$( eval echo "\$$TEMPARG" )"
2195                 REDIR=""
2196                 PIPE_MESSAGE="and encoding "
2197         else
2198                 WAVDATA="$ABCDETEMPDIR/track$UTRACKNUM.wav"
2199                 case "$CDROMREADERSYNTAX" in
2200                 ## FIXME ## Find the cases for dagrab and flac, to avoid exceptions
2201                         flac)
2202                                 FILEARG="--output-name=$WAVDATA"
2203                                 ;;
2204                         dagrab)
2205                                 FILEARG="-f $WAVDATA"
2206                                 ;;
2207                         *)
2208                                 FILEARG="$WAVDATA"
2209                                 ;;
2210                 esac
2211                 REDIR=">&2"
2212         fi
2213         if [ "$1" = "onetrack" ]; then
2214                 echo "Grabbing ${PIPE_MESSAGE}tracks $UTRACKNUM - $LASTTRACK as one track ..." >&2
2215         else
2216                 if [ -r "$CDDBDATA" ]; then
2217                         do_getcddbinfo TRACKNAME
2218                         echo "Grabbing ${PIPE_MESSAGE}track $UTRACKNUM: $TRACKNAME..." >&2
2219                 else
2220                         echo "Grabbing ${PIPE_MESSAGE}track $UTRACKNUM..." >&2
2221                 fi
2222         fi
2223         case "$CDROMREADERSYNTAX" in
2224                 ### FIXME ### use an exception for flac, since it uses -o
2225                 ### FIXME ### Shall we just use -o $FILEARG ??
2226                 flac)
2227                         nice $READNICE $FLAC -d --cue=${READTRACKNUMS:-$UTRACKNUM.1-$(($UTRACKNUM + 1)).0} "$FILEARG" "$CDROM" ;;
2228                 cdparanoia)
2229                         echo "nice $READNICE $CDROMREADER -$CDPARANOIACDROMBUS $CDROM ${READTRACKNUMS:-$UTRACKNUM} "$FILEARG" $REDIR ;;" > /tmp/log
2230                         nice $READNICE $CDROMREADER -$CDPARANOIACDROMBUS $CDROM ${READTRACKNUMS:-$UTRACKNUM} "$FILEARG" $REDIR ;;
2231                 cdda2wav)
2232                         if [ "$OSFLAVOUR" = "OSX" ] ; then
2233                                 # Hei, we have to unmount the device before running anything like cdda2wav in OSX
2234                                 disktool -u ${CDROM#/dev/} 0
2235                                 # Also, in OSX the cdrom device for cdda2wav changes...
2236                                 CDDA2WAVCDROM="IODVDServices"
2237                         elif [ "$OSFLAVOUR" = "FBSD" ] ; then
2238                                 CDDA2WAVCDROM="$CDROMID"
2239                         else
2240                                 if [ "$CDROMID" = "" ]; then
2241                                         CDDA2WAVCDROM="$CDROM"
2242                                 else
2243                                         CDDA2WAVCDROM="$CDROMID"
2244                                 fi
2245                         fi
2246                         nice $READNICE $CDROMREADER -D $CDDA2WAVCDROM -t ${READTRACKNUMS:-$UTRACKNUM} "$FILEARG" $REDIR
2247                         ;;
2248                 ## FIXME ## We have an exception for dagrab, since it uses -f
2249                 ## FIXME ## Shall we just use -f $FILEARG ??
2250                 dagrab) nice $READNICE $CDROMREADER -d $CDROM -v $UTRACKNUM "$FILEARG" $REDIR
2251                         ;;
2252                 cddafs)
2253                         # Find the track's mounted path
2254                         REALTRACKNUM=$(expr $UTRACKNUM + 0)
2255                         FILEPATH=$(mount | grep "$CDROM on" | sed 's/^[^ ]* on \(.*\) (.*/\1/')
2256                         FILEPATH=$(find "$FILEPATH" | grep "/$REALTRACKNUM ");
2257                         # If the file exists, copy it
2258                         if [ -e "$FILEPATH" ] ; then
2259                                 nice $READNICE $CDROMREADER "$FILEPATH" "$FILEARG" $REDIR
2260                         else
2261                                 false
2262                         fi ;;
2263                 debug) nice $READNICE $CDROMREADER -$CDPARANOIACDROMBUS $CDROM -w $UTRACKNUM-[:1] "$FILEARG" $REDIR
2264                         ;;
2265         esac
2266         RETURN=$?
2267         # If we get some error or we get some missing wav
2268         # (as long as we dont use pipes)
2269         if [ "$RETURN" != "0" -o \( ! -s "$WAVDATA" -a X"$USEPIPES" != "Xy" \) ]; then
2270                 # Thank goodness errors is only machine-parseable up to the
2271                 # first colon, otherwise this woulda sucked
2272                 if [ "$RETURN" = "0" -a ! -s "$WAVDATA" ]; then
2273                         RETURN=73 # fake a return code as cdparanoia return 0 also on aborted reads
2274                 fi
2275                 if [ "$USEPIPES" = "y" ]; then
2276                         echo "readencodetrack-$UTRACKNUM: $CDROMREADER returned code $RETURN" >> "$ABCDETEMPDIR/errors"
2277                 else
2278                         echo "readtrack-$UTRACKNUM: $CDROMREADER returned code $RETURN" >> "$ABCDETEMPDIR/errors"
2279                 fi
2280                 return $RETURN
2281         else
2282                 if [ "$USEPIPES" = "y" ]; then
2283                         echo readencodetrack-$UTRACKNUM >> "$ABCDETEMPDIR/status"
2284                 else
2285                         echo readtrack-$UTRACKNUM >> "$ABCDETEMPDIR/status"
2286                         if [ "$1" = "onetrack" ]; then
2287                                 echo onetrack >> "$ABCDETEMPDIR/status"
2288                         fi
2289                 fi
2290         fi
2291 }
2292
2293 # do_cdspeed
2294 # No values accepted, only uses env variables
2295 do_cdspeed ()
2296 {
2297         if "$CDSPEED" "$CDSPEEDOPTS" "$CDSPEEDVALUE" >/dev/null ; then
2298                 vecho "Setting CD speed to ${CDSPEEDVALUE}x"
2299         else
2300                 echo "abcde: unable to set the device speed" >&2
2301         fi
2302 }
2303
2304 # vecho [message]
2305 #
2306 # vecho outputs a message if EXTRAVERBOSE is selected
2307 vecho ()
2308 {
2309 if [ x"$EXTRAVERBOSE" != "x" ]; then
2310         case $1 in
2311                 warning) log warning "$@" ;;
2312                 *) echo "$@" ;;
2313         esac
2314 fi
2315 }
2316
2317 # decho [message]
2318 #
2319 # decho outputs a debug message if DEBUG is selected
2320 decho ()
2321 {
2322 if [ x"$DEBUG" != "x" ]; then
2323         if echo $1 | grep -q "^\[" ; then
2324                 DEBUGECHO=$(echo "$@" | tr -d '[]')
2325                 echo "[DEBUG] $DEBUGECHO: `eval echo \\$${DEBUGECHO}`"
2326         else
2327                 echo "[DEBUG] $1"
2328         fi
2329 fi
2330 }
2331
2332 # User-redefinable functions
2333 # Custom filename munging:
2334 mungefilename ()
2335 {
2336         #echo "$@" | sed s,:,\ -,g | tr \ /\* __+ | tr -d \'\"\?\[:cntrl:\]
2337         echo "$@" | sed s,:,\ -,g | tr \ / __ | tr -d \'\"\?\[:cntrl:\]
2338 }
2339
2340 # Custom genre munging:
2341 mungegenre ()
2342 {
2343         echo $CDGENRE | tr "[:upper:]" "[:lower:]"
2344 }
2345
2346 # pre_read
2347 # Empty pre_read function, to be defined in the configuration file.
2348 pre_read ()
2349 {
2350 :
2351 }
2352
2353 # post_read
2354 # Empty post_read function, to be defined in the configuration file.
2355 post_read ()
2356 {
2357 :
2358 }
2359
2360 ###############################################################################
2361 # End of functions
2362 #
2363 # Start of execution
2364 ###############################################################################
2365
2366 # Builtin defaults
2367
2368 # CDDB
2369 # Defaults to FreeDB, but a python musicbrainz can be used
2370 CDDBMETHOD=cddb
2371 CDDBURL="http://freedb.freedb.org/~cddb/cddb.cgi"
2372 CDDBSUBMIT=freedb-submit@freedb.org
2373 CDDBPROTO=5
2374 HELLOINFO="$(whoami)@$(hostname)"
2375 CDDBCOPYLOCAL="n"
2376 CDDBLOCALDIR="$HOME/.cddb"
2377 CDDBUSELOCAL="n"
2378
2379 # List of fields we parse and show during the CDDB parsing...
2380 SHOWCDDBFIELDS="year,genre"
2381
2382 INTERACTIVE=y
2383 #CDROMREADERSYNTAX=cdparanoia
2384 ENCODERSYNTAX=default
2385
2386 MP3ENCODERSYNTAX=default
2387 OGGENCODERSYNTAX=default
2388 FLACENCODERSYNTAX=default
2389 SPEEXENCODERSYNTAX=default
2390 MPPENCODERSYNTAX=default
2391 AACENCODERSYNTAX=default
2392 NORMALIZERSYNTAX=default
2393 CUEREADERSYNTAX=default
2394
2395 OUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}.${TRACKFILE}'
2396 # Use the following VAOUTPUTFORMAT to revert to 2.0.x VA format:
2397 #VAOUTPUTFORMAT=${OUTPUTFORMAT}
2398 VAOUTPUTFORMAT='Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
2399 ONETRACKOUTPUTFORMAT='${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
2400 VAONETRACKOUTPUTFORMAT='Various-${ALBUMFILE}/${ALBUMFILE}'
2401 PLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
2402 PLAYLISTDATAPREFIX=''
2403 VAPLAYLISTFORMAT='${ARTISTFILE}-${ALBUMFILE}.${OUTPUT}.m3u'
2404 VAPLAYLISTDATAPREFIX=''
2405 DOSPLAYLIST=n
2406 COMMENT=''
2407 ID3TAGV=2
2408 ENCNICE=10
2409 READNICE=10
2410 DISTMP3NICE=10
2411 VARIOUSARTISTS=n
2412 VARIOUSARTISTSTYLE=forward
2413 KEEPWAVS=n
2414 PADTRACKS=n
2415 NOGAP=n
2416 BATCHNORM=n
2417
2418 # If using scsi devices, cdda2wav needs a CDROMID, instead of a device node
2419 # i.e. CDROMID="1,0,0"
2420 CDROMID=""
2421 # If we are using the IDE bus, we need CDPARANOIACDROMBUS defined as "d"
2422 # If we are using the ide-scsi emulation layer, we need to define a "g"
2423 CDPARANOIACDROMBUS="d"
2424
2425 # program paths - defaults to checking your $PATH
2426 # mp3
2427 LAME=lame
2428 TOOLAME=toolame
2429 GOGO=gogo
2430 BLADEENC=bladeenc
2431 L3ENC=l3enc
2432 XINGMP3ENC=xingmp3enc
2433 MP3ENC=mp3enc
2434 # ogg
2435 VORBIZE=vorbize
2436 OGGENC=oggenc
2437 # flac
2438 FLAC=flac
2439 # speex
2440 SPEEXENC=speexenc
2441 # mpp (Musepack)
2442 MPPENC=mppenc
2443 # m4a
2444 AACENC=faac
2445
2446 ID3=id3
2447 ID3V2=id3v2
2448 EYED3=eyeD3
2449 CDPARANOIA=cdparanoia
2450 CDDA2WAV=cdda2wav
2451 DAGRAB=dagrab
2452 CDDAFS=cp
2453 CDDISCID=cd-discid
2454 CDDBTOOL=cddb-tool
2455 MUSICBRAINZ=musicbrainz-get-tracks
2456 EJECT=eject
2457 MD5SUM=md5sum
2458 DISTMP3=distmp3
2459 VORBISCOMMENT=vorbiscomment
2460 METAFLAC=metaflac
2461 NORMALIZE=normalize-audio
2462 CDSPEED=eject
2463 VORBISGAIN=vorbisgain
2464 MP3GAIN=mp3gain
2465 MPPGAIN=replaygain
2466 MKCUE=mkcue
2467 MKTOC=cdrdao
2468 DIFF=diff
2469 CUE2DISCID=cue2discid
2470
2471 # Options for programs called from abcde
2472 # mp3
2473 LAMEOPTS=
2474 TOOLAMEOPTS=
2475 GOGOOPTS=
2476 BLADEENCOPTS=
2477 L3ENCOPTS=
2478 XINGMP3ENCOPTS=
2479 MP3ENCOPTS=
2480 # ogg
2481 VORBIZEOPTS=
2482 OGGENCOPTS=
2483 # flac
2484 FLACOPTS=
2485 # speex
2486 SPEEXENCOPTS=
2487 # mpc
2488 MPPENCOPTS=
2489 # m4a
2490 AACENCOPTS=
2491
2492 ID3OPTS=
2493 ID3V2OPTS=
2494 CDPARANOIAOPTS=
2495 CDDA2WAVOPTS=
2496 DAGRABOPTS=
2497 CDDAFSOPTS="-f"
2498 CDDBTOOLOPTS=
2499 EJECTOPTS=
2500 DISTMP3OPTS=
2501 NORMALIZEOPTS=
2502 CDSPEEDOPTS="-x"
2503 CDSPEEDVALUE=
2504 MKCUEOPTS=
2505 MKTOCOPTS=""
2506 VORBISCOMMENTOPTS="-R"
2507 METAFLACOPTS="--no-utf8-convert"
2508 DIFFOPTS=
2509
2510 # Default to one process if -j isn't specified
2511 MAXPROCS=1
2512
2513 # List of actions to perform - by default, run to completion
2514 ACTIONS=cddb,read,encode,tag,move,clean
2515
2516 # This option is basicaly for Debian package dependencies:
2517 # List of prefered outputs - by default, run with whatever we have in the path
2518 DEFAULT_OUTPUT_BINARIES=vorbis:oggenc,flac:flac,mp3:lame,mp3:bladeenc,spx:speex
2519
2520 # List of prefered cdromreaders - by default, run whichever we have in the path
2521 DEFAULT_CDROMREADERS="cdparanoia cdda2wav"
2522
2523 # Asume fetch if under FreeBSD. curl is used for Mac OS X. wget is used for Linux/OpenBSD/NetBSD.
2524 # Let's use these checkings to determine the OS flavour, which will be used later
2525 if [ X$(uname) = "XFreeBSD" ] ; then
2526         HTTPGET=fetch
2527         MD5SUM=md5
2528         NEEDCDROMID=y
2529         OSFLAVOUR=FBSD
2530 elif [ X$(uname) = "XDarwin" ] ; then
2531         HTTPGET=curl
2532         OSFLAVOUR=OSX
2533         # We should have disktool in OSX, but let's be sure...
2534         NEEDDISKTOOL=y
2535         CDROMREADERSYNTAX=cddafs
2536 elif [ X$(uname) = "XOpenBSD" ] ; then
2537         HTTPGET=wget
2538         MD5SUM=md5
2539 elif [ X$(uname) = "XNetBSD" ] ; then
2540         HTTPGET=ftp
2541         MD5SUM=md5
2542 else
2543         HTTPGET=wget
2544 fi
2545
2546 # If CDDBAVAIL is set to n, no CDDB read is done
2547 # If USEID3 is set to n, no ID3 tagging is done
2548 CDDBAVAIL=y
2549 USEID3=y
2550 USEID3V2=y
2551
2552 if [ -z "$OUTPUTDIR" ]; then
2553         OUTPUTDIR=$(pwd)
2554 fi
2555
2556 if [ -z "$WAVOUTPUTDIR" ]; then
2557         WAVOUTPUTDIR="$OUTPUTDIR"
2558 fi
2559
2560 # Load system defaults
2561 if [ -r /etc/abcde.conf ]; then
2562         . /etc/abcde.conf
2563 fi
2564 # Load user preference defaults
2565 if [ -r $HOME/.abcde.conf ]; then
2566         . $HOME/.abcde.conf
2567 fi
2568
2569 # By this time, we need some HTTPGETOPTS already defined.
2570 # If the user has defined a non-default HTTPGET method, we should not be empty.
2571
2572 if [ "$HTTPGETOPTS" = "" ] ; then
2573         case $HTTPGET in
2574                 wget) HTTPGETOPTS="-q -O -";;
2575                 curl) HTTPGETOPTS="-f -s";;
2576                 fetch)HTTPGETOPTS="-q -o -";;
2577                 ftp)  HTTPGETOPTS="-q -o -";;
2578                 *) log warning "HTTPGET in non-standard and HTTPGETOPTS are not defined." ;;
2579         esac
2580 fi
2581
2582 # If the CDROM has not been set yet, find a suitable one.
2583 # If this is a devfs system, default to /dev/cdroms/cdrom0
2584 # instead of /dev/cdrom
2585 if [ "$CDROM" = "" ] ; then
2586         if [ -e /dev/cdroms/cdrom0 ]; then
2587                 CDROM=/dev/cdroms/cdrom0
2588         elif [ -e /dev/cdrom ]; then
2589                 CDROM=/dev/cdrom
2590         elif [ -e /dev/cd0c ]; then
2591                 CDROM=/dev/cd0c
2592         elif [ -e /dev/acd0c ]; then
2593                 CDROM=/dev/acd0c
2594         elif [ -e /dev/disk1 ]; then
2595                 CDROM=/dev/disk1
2596         fi
2597 fi
2598
2599 # Parse command line options
2600 #while getopts 1a:bc:C:d:Dehj:klLmMnNo:pPr:Rs:S:t:T:vVxw:W: opt ; do
2601 while getopts 1a:bBc:C:d:Defghj:klLmMnNo:pPr:s:S:t:T:uvVxw:W:z opt ; do
2602         case "$opt" in
2603                 1) ONETRACK=y ;;
2604                 a) ACTIONS="$OPTARG" ;;
2605                 A) EXPACTIONS="$OPTARG" ;;
2606                 b) BATCHNORM=y ;;
2607                 B) NOBATCHREPLAYGAIN=y ;;
2608                 c) if [ -e "$OPTARG" ] ; then . "$OPTARG" ; else log error "config file \"$OPTARG\" cannot be found." ; exit 1 ; fi ;;
2609                 C) DISCID="$( echo ${OPTARG#abcde.} | tr -d /)" ;;
2610                 d) CDROM="$OPTARG" ;;
2611                 D) set -x ;;
2612                 e) ERASEENCODEDSTATUS=y ;;
2613                 h) usage; exit ;;
2614                 e) ERASEENCODEDSTATUS=y ;;
2615                 E) ENCODING="$OPTARG" ;;
2616                 f) FORCE=y ;;
2617                 g) NOGAP=y ;;
2618                 i) INLINETAG=y ;;
2619                 j) MAXPROCS="$OPTARG" ;;
2620                 k) KEEPWAVS=y ;;
2621                 l) LOWDISK=y ;;
2622                 L) CDDBUSELOCAL=y ;;
2623                 n) CDDBAVAIL=n ;;
2624                 N) INTERACTIVE=n ;;
2625                 m) DOSPLAYLIST=y ;;
2626                 M) MAKECUEFILE=y ;;
2627                 o) OUTPUTTYPE="$OPTARG" ;;
2628                 p) PADTRACKS=y ;;
2629                 P) USEPIPES=y ;;
2630                 r) REMOTEHOSTS="$OPTARG" ;;
2631                 R) DOREPLAYGAIN=y ;;
2632                 s) SHOWCDDBFIELDS="$OPTARG" ;;
2633                 S) CDSPEEDVALUE="$OPTARG" ;;
2634                 t) STARTTRACKNUMBER="$OPTARG" ;;
2635                 T) STARTTRACKNUMBER="$OPTARG" ; STARTTRACKNUMBERTAG="y" ;;
2636                 u) CDDBPROTO=6 ;;
2637                 v)
2638                    echo "This is abcde v$VERSION."
2639                    echo "Usage: abcde [options] [tracks]"
2640                    echo "abcde -h for extra help"
2641                    exit
2642                    ;;
2643                 V) EXTRAVERBOSE="y" ;;
2644                 x) EJECTCD="y" ;;
2645                 w) COMMENT="$OPTARG" ;;
2646                 W) if echo $OPTARG | grep -q "[[:digit:]]" ; then
2647                      STARTTRACKNUMBER="${OPTARG}01" ; STARTTRACKNUMBERTAG="y" ; COMMENT="CD${OPTARG}"
2648                    else
2649                      log error "argument of -W must be integer"
2650                          exit 1
2651                    fi
2652                    ;;
2653                 z) DEBUG=y ; CDROMREADERSYNTAX=debug ; EJECTCD="n" ;;
2654                 ?) usage; exit ;;
2655         esac
2656 done
2657
2658 shift $(($OPTIND - 1))
2659
2660 # If the user specified a flac file, then switch to special flac mode
2661 if echo $CDROM | grep -i -q '.flac$'; then
2662         vecho "abcde: switching to flac CDROMREADERSYNTAX..."
2663         CDROMREADERSYNTAX=flac
2664         if [ "$EJECTCD" = "y" ];then
2665                 vecho "abcde: CDROM flac mode, deactivating EJECTCD..."
2666                 EJECTCD=n
2667         fi
2668 fi
2669
2670 # If the user provided a DISCID, disable eject
2671 if [ -n "$DISCID" ]; then EJECTCD=n ; fi
2672
2673 # Check the available cd rippers in the system, from the ones we know.
2674 if [ "$CDROMREADERSYNTAX" = "" ]; then
2675         for DEFAULT_CDROMREADER in $DEFAULT_CDROMREADERS; do
2676                 if [ -x $( which $DEFAULT_CDROMREADER ) ]; then
2677                         CDROMREADERSYNTAX=$DEFAULT_CDROMREADER
2678                         break
2679                 fi
2680         done
2681         if [ "$CDROMREADERSYNTAX" = "" ]; then
2682                 log error "no cdreader found in your PATH"
2683                 log error "hints: are all dependencies installed? has the \$PATH been modified?"
2684                 exit 1
2685         fi
2686 fi
2687
2688 # Decide if we can continue.
2689 if [ "$ONETRACK" = "y" ]; then
2690         # FIXME # remove check as soon as we find out about the other readers
2691         case "$CDROMREADERSYNTAX" in
2692                 flac) ;;
2693                 cdparanoia) ;;
2694                 cdda2wav) ;;
2695                 *) log error "$CDROMREADERSYNTAX does not support ONETRACK mode"
2696                    exit 1 ;;
2697         esac
2698         if [ "$BATCHNORM" = "y" ]; then
2699                 log warning "BATCHNORM mode is not compatible with ONETRACK mode. Disabling..."
2700                 BATCHNORM=n
2701         fi
2702         if [ "$NOGAP" = "y" ]; then
2703                 log warning "NOGAP mode is not compatible with ONETRACK mode. Disabling..."
2704                 NOGAP=n
2705         fi
2706         # It does not matter how many tracks we want. In ONETRACK mode we grab them all
2707         # FIXME # allow ranges of tracks to be selected for onetrack ripping
2708         if [ $# -gt 0 ]; then
2709                 log warning "ONETRACK mode selected, grabbing all tracks..."
2710         fi
2711 else
2712         while [ $# -gt 0 ]; do
2713                 # Range parsing code courtesy of Vincent Ho
2714                 RSTART=$(echo $1 | cut -f1 -d-)
2715                 REND=$(echo $1 | cut -f2 -d-)
2716                 if [ "$RSTART" = "$REND" ]; then
2717                         NEWTRACKS="$RSTART"
2718                 else
2719                         NEWTRACKS=$(f_seq_line $RSTART $REND)
2720                 fi
2721                 TRACKQUEUE=$(echo "$TRACKQUEUE" "$NEWTRACKS")
2722                 shift
2723         done
2724 fi
2725
2726 # List of valid actions: cddb,read,normalize,encode,tag,move,playlist,clean
2727 # List of experimental actions: retag,transcode
2728
2729 # Determine what actions are to be done from $ACTIONS and set the
2730 # following environment variables for them:
2731 DOCDDB=n
2732 DOREAD=n
2733 DONORMALIZE=n
2734 DOPREPROCESS=n
2735 DOENCODE=n
2736 DOPOSTPROCESS=n
2737 DOTAG=n
2738 DOMOVE=n
2739 DOREPLAYGAIN=n
2740 DOPLAYLIST=n
2741 DOCLEAN=n
2742
2743 for ACTION in $(echo $ACTIONS | tr , \ )
2744 do
2745         case $ACTION in
2746                 cddb) DOCDDB=y;;
2747                 read) DOREAD=y;;
2748                 normalize) DONORMALIZE=y; DOREAD=y;;
2749 #               preprocess) DOPREPROCESS=y; DOREAD=y;;
2750                 encode) DOENCODE=y; DOREAD=y;;
2751 #               postprocess) DOPREPROCESS=y; DOENCODE=y; DOREAD=y;;
2752                 tag) DOTAG=y; DOREAD=y; DOENCODE=y; DOCDDB=y;;
2753                 move) DOMOVE=y; DOTAG=y; DOREAD=y; DOENCODE=y; DOCDDB=y;;
2754                 replaygain) DOCDDB=y; DOREAD=y; DOENCODE=y; DOTAG=y; DOMOVE=y; DOREPLAYGAIN=y;;
2755                 playlist) DOCDDB=y; DOPLAYLIST=y;;
2756                 clean) DOCLEAN=y;;
2757         esac
2758 done
2759
2760 if [ "$DONORMALIZE" = "y" ] && [ "$DOREPLAYGAIN" = "y" ]; then
2761         # FIXME # should we abort on error or just inform the user?
2762         log warning "selected both normalize and replaygain actions"
2763 fi
2764
2765 for SHOWCDDBFIELD in $(echo $SHOWCDDBFIELDS | tr , \ ); do
2766         case $SHOWCDDBFIELD in
2767                 y*|Y*) SHOWCDDBYEAR="y";;
2768                 g*|G*) SHOWCDDBGENRE="y";;
2769                 *) ;;
2770         esac
2771 done
2772
2773 # Sanity checks:
2774
2775 # At this point a CDROM has to be defined, so we check it exists.
2776 if [ X"$CDROM" != "X" ] ; then
2777         if [ "$CDROMREADERSYNTAX" = "cdda2wav" ] && [ "$NEEDCDROMID" = "y" ] ; then
2778                 if [ "$OSFLAVOUR" = "FBSD" ]; then
2779                         if ! echo "$CDROMID" | grep "^[0-9],[0-9],[0-9]$" >/dev/null 2>&1 ; then
2780                                 log error "CDROMID not in the right format for $CDROMREADERSYNTAX"
2781                                 log error "Use \"cdrecord -scanbus\" to obtain a adecuate ID an set CDROMID accordingly"
2782                                 exit 1
2783                         fi
2784                 fi
2785         elif [ ! -e "$CDROM" -a X"$DOREAD" = "Xy" ]; then
2786                 log error "CDROM device cannot be found."
2787                 exit 1
2788         fi
2789 # avoid processing if we are not going to hit the CDROM.
2790 elif [ X"$DOREAD" = "Xy" ]; then
2791         log error "CDROM has not been defined or cannot be found"
2792         exit 1
2793 fi
2794
2795 # USEPIPES pre-tests, before we get into more serious stuff
2796 # Not compatible with:
2797 # - multiple outputs
2798 # - normalize
2799 # - lowdisk algorithm
2800 # - anything else?
2801 if [ X"$USEPIPES" = "Xy" ]; then
2802         if [ $(echo "$OUTPUTTYPE" | tr , \  | wc -w ) -gt 1 ]; then
2803                 log error "Unix pipes not compatible with multiple outputs"
2804                 exit 1
2805         fi
2806         if [ X"$DONORMALIZE" = "Xy" ]; then
2807                 log error "Unix pipes not compatible with normalizer"
2808                 # FIXME # Do we need to exit or shall we just disable the mode?
2809                 exit 1
2810         fi
2811         if [ X"$BATCHNORM" = "Xy" ]; then
2812                 log error "Unix pipes not compatible with BATCHNORM encoding"
2813                 exit 1
2814         fi
2815         if [ X"$NOGAP" = "Xy" ]; then
2816                 log error "Unix pipes not compatible with NOGAP encoding"
2817                 exit 1
2818         fi
2819         if [ X"$DOENCODE" = "Xn" ]; then
2820                 vecho warning "Disabling Unix pipes since we are not encoding!"
2821                 USEPIPES=n
2822         fi
2823         if [ X"$LOWDISK" = "Xy" ]; then
2824                 log error "Unix pipes not compatible with lowdisk algorithm"
2825                 exit 1
2826         fi
2827 fi
2828
2829 # LOWDISK pre-tests, before we get into more problematic stuff
2830 # Not compatible with anything that needs all the files in the hard disc:
2831 # - BATCHNORM
2832 # - NOGAP lame mode
2833 if [ X"$LOWDISK" = "Xy" ]; then
2834         if [ X"$BATCHNORM" = "Xy" ]; then
2835                 log error "Unix pipes not compatible with BATCHNORM encoding"
2836                 exit 1
2837         fi
2838         if [ X"$NOGAP" = "Xy" ]; then
2839                 log error "Unix pipes not compatible with NOGAP encoding"
2840                 exit 1
2841         fi
2842 fi
2843
2844 # BATCHNORM pre-tests, before we get into serious problems
2845 # Not compatible with
2846 if [ "$BATCHNORM" = "y" ] && [ "$DONORMALIZE" = "n" ]; then
2847         vecho warning "Disabling BATCHNORM since we are not normalizing!"
2848         BATCHNORM=n
2849 fi
2850
2851 # Check the encoding format from the ones available in the system, if nothing has been configured in the system.
2852 if [ X"$OUTPUTTYPE" = "X" ]; then
2853         for DEFAULT_OUTPUT in $( echo "$DEFAULT_OUTPUT_BINARIES" | tr , \ ); do
2854                 DEFAULT_OUTPUT_FORMAT="$(echo $DEFAULT_OUTPUT | cut -d ":" -f 1)"
2855                 DEFAULT_OUTPUT_BINARY="$(echo $DEFAULT_OUTPUT | cut -d ":" -f 2)"
2856                 if [ -x $(which $DEFAULT_OUTPUT_BINARY) ] ; then
2857                         OUTPUTTYPE=$DEFAULT_OUTPUT_FORMAT
2858                         vecho "No default output type defined. Autoselecting $OUTPUTTYPE..." >&2
2859                         break
2860                 fi
2861         done