Add support for reading release dates from MusicBrainz.

[flac-archive] / fa-flacd

diff --git a/fa-flacd b/fa-flacd
index 37e79a0a49a5ea3b01abad9c5931862786e97902..3c3637241b12b2ea8cac3b8227cf8572a4e18ead 100755 (executable)
--- a/fa-flacd
+++ b/fa-flacd
@@ -1,18 +1,15 @@
 #! /usr/bin/env perl
 
 # $Id$
 #! /usr/bin/env perl
 
 # $Id$

+# $URL$

 
 =head1 NAME
 
 
 =head1 NAME
 

-B<fa-flacd>, B<fa-rip>, B<fa-tags> - archive CDs to single FLAC files
+B<fa-flacd> - archive CDs to single FLAC files

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-B<fa-flacd> [B<-jv>]
-
-B<fa-rip>
-
-B<fa-tags> I<track-count>
+B<fa-flacd> [B<-j> I<jobs>] [B<-v>]

 
 =cut
 
 
 =cut
 


@@ -20,11 +17,11 @@ use strict;
 use warnings;
 
 use File::Basename;
 use warnings;
 
 use File::Basename;

-use Getopt::Std; $Getopt::Std::STANDARD_HELP_VERSION = 1;
+use Getopt::Long qw(:config gnu_getopt no_ignore_case);

 use POSIX ':sys_wait_h';
 use POSIX ':sys_wait_h';

+use Pod::Usage;

 
 

-our $VERSION = 1;
-
+my $debug;

 my $verbose;
 my @jobs;
 my @finished;
 my $verbose;
 my @jobs;
 my @finished;


@@ -41,6 +38,7 @@ sub get_tags {
     my $value;
     my $artist;
     my $album;
     my $value;
     my $artist;
     my $album;

+    my $discnum;

     my @tags;
 
     verbose("Opening tags file $fn\n");
     my @tags;
 
     verbose("Opening tags file $fn\n");


@@ -51,17 +49,20 @@ sub get_tags {
 
         ($tag, $value) = split(/=/, $_, 2);
 
 
         ($tag, $value) = split(/=/, $_, 2);
 

-        if (/^ARTIST=/) {
+        if (/^ARTIST=/i) {

             $artist = $value;
             verbose("ARTIST $artist from $fn\n");
             $artist = $value;
             verbose("ARTIST $artist from $fn\n");

-        } elsif (/^ALBUM=/) {
+        } elsif (/^ALBUM=/i) {

             $album = $value;
             $album = $value;

-            verbose("ALBUM $album from $fn\n");
+            verbose("ALBUM $album from $fn\n"); # cperl-mode sucks "
+        } elsif (/^DISCNUMBER=/i) {
+            $discnum = int($value);
+            verbose("DISCNUMBER $discnum from $fn\n");

         }
     }
     close(TAGS) or die("close($fn): $!");
 
         }
     }
     close(TAGS) or die("close($fn): $!");
 

-    return ($artist, $album, @tags);
+    return ($artist, $album, $discnum, @tags);

 }
 
 # Process the fa-rip output in the directory DIR.
 }
 
 # Process the fa-rip output in the directory DIR.


@@ -69,6 +70,7 @@ sub flac {
     my $dir = shift;
     my $artist;
     my $album;
     my $dir = shift;
     my $artist;
     my $album;

+    my $discnum;

     my @tags;
     my $outfile;
     my $status;
     my @tags;
     my $outfile;
     my $status;


@@ -77,7 +79,7 @@ sub flac {
     rename("$dir/tags", "$dir/using-tags")
       or die("rename($dir/tags, $dir/using-tags): $!");
 
     rename("$dir/tags", "$dir/using-tags")
       or die("rename($dir/tags, $dir/using-tags): $!");
 

-    ($artist, $album, @tags) = get_tags("$dir/using-tags");
+    ($artist, $album, $discnum, @tags) = get_tags("$dir/using-tags");

 
     verbose("mkdir($artist)\n");
     -d $artist or mkdir($artist) or die("mkdir($artist): $!");
 
     verbose("mkdir($artist)\n");
     -d $artist or mkdir($artist) or die("mkdir($artist): $!");


@@ -86,12 +88,8 @@ sub flac {
     chdir($dir) or die("chdir($dir): $!");
 
     $outfile = "$album";
     chdir($dir) or die("chdir($dir): $!");
 
     $outfile = "$album";

-    for ($outfile) {
-        s/\//_/g;
-        s/:/_/g;
-        s/'/_/g;
-        s/"/_/g;
-    }
+    defined($discnum) and $outfile .= " (disc $discnum)";
+    $outfile =~ s/\//_/g;

 
     verbose("Running flac\n");
     $status = system('flac', '-o', "../$artist/$outfile.flac-tmp",
 
     verbose("Running flac\n");
     $status = system('flac', '-o', "../$artist/$outfile.flac-tmp",


@@ -99,27 +97,36 @@ sub flac {
                      'cue', '--no-padding', '--best',
                      map({ ('-T', $_) } @tags),
                      'wav');
                      'cue', '--no-padding', '--best',
                      map({ ('-T', $_) } @tags),
                      'wav');

-    if (WIFEXITED($status) and ($status = WEXITSTATUS($status)) != 0) {
-        die("flac: $status");
+    if (WIFEXITED($status)) {
+        if (($status = WEXITSTATUS($status)) != 0) {
+            die("flac exited with status $status");
+        }

     } elsif (WIFSIGNALED($status)) {
         die("flac killed with signal ", WTERMSIG($status));
     } elsif (WIFSTOPPED($status)) {
         die("flac stopped with signal ", WSTOPSIG($status));
     } elsif (WIFSIGNALED($status)) {
         die("flac killed with signal ", WTERMSIG($status));
     } elsif (WIFSTOPPED($status)) {
         die("flac stopped with signal ", WSTOPSIG($status));

+    } else {
+        die("Major horkage on system(flac): \$? = $? \$! = $!");

     }
 
     verbose("Cleaning up $dir\n");
     unlink('using-tags') or die("unlink(using-tags): $!");
     unlink('cue') or die("unlink(cue): $!");
     }
 
     verbose("Cleaning up $dir\n");
     unlink('using-tags') or die("unlink(using-tags): $!");
     unlink('cue') or die("unlink(cue): $!");

-    rename('toc', "../$artist/$outfile.toc")
-      or die("rename(toc, ../$artist/$outfile.toc): $!");

     rename('log', "../$artist/$outfile.log")
       or die("rename(log, ../$artist/$outfile.log): $!");
     chdir('..') or die("chdir(..): $!");
     rename('log', "../$artist/$outfile.log")
       or die("rename(log, ../$artist/$outfile.log): $!");
     chdir('..') or die("chdir(..): $!");

-    rmdir($dir) or die("rmdir($dir): $!");

 
     rename("$artist/$outfile.flac-tmp", "$artist/$outfile.flac")
       or die("rename($artist/$outfile.flac-tmp, $artist/$outfile.flac): $!");
 
 
     rename("$artist/$outfile.flac-tmp", "$artist/$outfile.flac")
       or die("rename($artist/$outfile.flac-tmp, $artist/$outfile.flac): $!");
 

+    if (-x "$dir/post-processor") {
+        verbose("Running './$dir/post-processor $artist/$outfile.flac'\n");
+        system("./$dir/post-processor", "$artist/$outfile.flac");
+        unlink("$dir/post-processor") or die("unlink($dir/post-processor): $!");
+    }
+
+    rmdir($dir) or die("rmdir($dir): $!");
+

     return 0;
 }
 
     return 0;
 }
 


@@ -137,10 +144,14 @@ sub newjob {
     my $dir = shift;
     my $pid;
 
     my $dir = shift;
     my $pid;
 

-    $pid = fork();
-    if (not defined($pid)) {
-        die("fork: $!");
-    } elsif ($pid == 0) {
+    if (not $debug) {
+        $pid = fork();
+        if (not defined($pid)) {
+            die("fork: $!");
+        }
+    }
+
+    if ($debug or $pid == 0) {

         $SIG{CHLD} = 'IGNORE';
         open(STDERR, ">$dir/log") or die("open(STDERR, >$dir/log): $!");
         exit(flac($dir));
         $SIG{CHLD} = 'IGNORE';
         open(STDERR, ">$dir/log") or die("open(STDERR, >$dir/log): $!");
         exit(flac($dir));


@@ -161,11 +172,11 @@ sub deljob {
 
     verbose("$pid finished (");
     if (WIFEXITED($status)) {
 
     verbose("$pid finished (");
     if (WIFEXITED($status)) {

-        verbose('exited ', WEXITSTATUS($status));
+        verbose('exited with status ', WEXITSTATUS($status));

     } elsif (WIFSIGNALED($status)) {
     } elsif (WIFSIGNALED($status)) {

-        verbose('signalled ', WTERMSIG($status));
+        verbose('killed with signal ', WTERMSIG($status));

     } elsif (WIFSTOPPED($status)) {
     } elsif (WIFSTOPPED($status)) {

-        verbose('stopped ', WSTOPSIG($status));
+        verbose('stopped with signal ', WSTOPSIG($status));

     }
     verbose(")\n");
 
     }
     verbose(")\n");
 


@@ -200,18 +211,19 @@ sub flacloop {
 }
 
 MAIN: {
 }
 
 MAIN: {

-    my %opts;
-
-    $opts{'j'} = 4;
-    $opts{'v'} = 0;
-    if (not getopts('j:v', \%opts)) {
-        print(STDERR "usage: flacd [-jN -v]\n");
-        exit(2);
-    }
-
-    $verbose = $opts{'v'};
-
-    flacloop($opts{'j'});
+    my $jobs;
+    my $help;
+
+    $jobs = 4;
+    GetOptions(
+               'debug|X' => \$debug,
+               'jobs|j=i' => \$jobs,
+               'verbose|v' => \$verbose,
+               'help|h|?' => \$help,
+              ) or pod2usage();
+    $help and pod2usage(-exitstatus=>0, -verbose=>1);
+
+    flacloop($jobs);

 }
 
 \f
 }
 
 \f


@@ -219,29 +231,23 @@ __END__
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-B<fa-flacd>, B<fa-rip>, and B<fa-tags> together comprise
-B<flac-archive>, a system for archiving audio CDs to single FLAC
-files.  B<fa-flacd> is the guts of the system.  It runs in the
-directory where the audio archives are stored, scanning for new CDs to
-encode and rename; it never exits.  B<fa-rip> generates the inputs for
-B<fa-flacd>: the ripped WAV file, Vorbis tags, and a cuesheet.
-B<fa-tags> is not meant to be run directly; B<fa-rip> uses it to
-generate the candidate Vorbis tags.
-
-All three programs expect to be run from the same directory.  They use
-that directory to manage directories named by artist and by disc ID.
-Intermediate files are written to the disc ID directory.  B<fa-flacd>
-processes the disc ID directories into per-album files in the artist
-directories.
-
-=head2 FA-FLACD
-
-B<fa-flacd> does not exit; it runs until the user kills it.  Every 5
-seconds it scans its current directory for directories with a file
-called "tags" and creates a processing job for each one.  The number
-of jobs B<fa-flacd> attempts to run is controlled by the B<-j> option
-and defaults to 4.  B<fa-flacd> will print diagnostic output when the
-B<-v> option is given.
+B<fa-flacd> and B<fa-rip> together comprise B<flac-archive>, a system
+for archiving audio CDs to single FLAC files.  B<fa-flacd> is the guts
+of the system.  It runs in the directory where the audio archives are
+stored, scanning for new ripped CDs to encode and rename; it never
+exits.  B<fa-rip> generates the inputs for B<fa-flacd>: the ripped WAV
+file, Vorbis tags, and a cuesheet.
+
+Both programs expect to be run from the same directory.  They use that
+directory to manage directories named by artist.  Intermediate files
+are written to temporary directories here.  B<fa-flacd> processes the
+temporary directories into per-album files in the artist directories.
+
+Every 5 seconds, B<fa-flacd> scans its current directory for
+directories with a file called "tags" and creates a processing job for
+each one.  The number of jobs B<fa-flacd> attempts to run is
+controlled by the B<-j> option and defaults to 4.  B<fa-flacd> will
+print diagnostic output when the B<-v> option is given.

 
 A processing job first renames the directory's "tags" file to
 "using-tags" so that B<ra-flacd> will not try to start another job for
 
 A processing job first renames the directory's "tags" file to
 "using-tags" so that B<ra-flacd> will not try to start another job for


@@ -250,41 +256,32 @@ so a new job will not be started until the user corrects the error
 condition and renames "using-tags" back to "tags".  Next, it encodes
 the "wav" file to a FLAC file, using the "cue" file for the cuesheet
 and "using-tags" for Vorbis tags.  Any diagnostic output is saved in
 condition and renames "using-tags" back to "tags".  Next, it encodes
 the "wav" file to a FLAC file, using the "cue" file for the cuesheet
 and "using-tags" for Vorbis tags.  Any diagnostic output is saved in

-the "log" file.  Finally, the "cue" and "log" files are moved to the
-artist directory (and named by album) and the ID directory is removed.
-
-=head2 FA-RIP
+the "log" file.  Finally, B<fa-flacd> moves the "cue" and "log" files
+to the artist directory (named by album) and removes the temporary
+directory.
+
+If the temporary directory contains an executable file named
+"post-processor", B<fa-flacd> executes that file with the relative
+path to the output FLAC file as an argument.  The output files are in
+their final location when "post-processor" starts.  Possible uses are
+running B<flac2mp3>, moving the output files to a different location,
+removing the lock file, or adding to a database.  The standard input,
+output, and error streams are inherited from B<fa-flacd>, so they may
+be connected to anything from a tty to /dev/null.  This means that you
+may want to redirect these streams, if you want to save them or do any
+logging.
+
+=head1 OPTIONS

 
 

-B<fa-rip> uses C<mktemp(1)> to create a directory for storage of its
-intermediate files.  It uses C<cdrdao(1)> to create the "cue" file and
-then passes the number of tracks (from the "cue" file) as command-line
-arguments to B<fa-tags>.  Finally, it execs C<cdparanoia(1)> to rip
-the CD to the "wav" file.
-
-In order for this CD to be processed by B<fa-flacd>, the user must
-create a "tags" file.  This is usually done by renaming one of the
-candidate-tags files and deleting the others.
-
-=head2 FA-TAGS
-
-B<fa-tags> uses C<MusicBrainz::Client> to populate candidate-tags
-files.  These are numbered in the order of entries read from
-MusicBrainz, e.g. candidate-tags-1, candidate-tags-2, etc.  B<fa-tags>
-also creates candidate-tags-0, which has the correct fields for this
-CD (including correct number of TITLE= lines), but with all fields
-blank.
-
-B<fa-tags> requires the number of tracks as its sole argument.
+=over 4

 
 

-=head1 ENVIRONMENT
+=item B<-j> [B<--jobs>] I<jobs>

 
 

-=over 4
+Run up to I<jobs> jobs instead of the default 4.

 
 

-=item CDDEV
+=item B<-v> [B<--verbose>]

 
 

-B<fa-rip> uses this to rip audio and save the cuesheet for a CD.  It
-makes some effort to check some common device names for FreeBSD,
-Linux, and NetBSD by default.
+Print diagnostic information.

 
 =back
 
 
 =back