Warn in abcde.conf about use of recode
[abcde.git] / abcde-musicbrainz-tool
1 #!/usr/bin/perl
2 # Copyright (c) 2012-2018 Steve McIntyre <93sam@debian.org>
3 # This code is hereby licensed for public consumption under either the
4 # GNU GPL v2 or greater, or Larry Wall's Artistic license - your choice.
5 #
6 # You should have received a copy of the GNU General Public License along
7 # with this program; if not, write to the Free Software Foundation, Inc.,
8 # 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
9 #
10 # abcde-musicbrainz-tool
11 #
12 # Helper script for abcde to work with the MusicBrainz WS API (v2)
13
14 use strict;
15 use utf8;
16 use POSIX qw(ceil);
17 use Digest::SHA;
18 use MusicBrainz::DiscID;
19 use WebService::MusicBrainz 1.0.4;
20 use Getopt::Long;
21 use Pod::Usage;
22
23 my $FRAMES_PER_S = 75;
24
25 my ($device, $command, $discid, @discinfo, $workdir, $help, $man, $start);
26 Getopt::Long::Configure ('no_ignore_case');
27 Getopt::Long::Configure ('no_auto_abbrev');
28 GetOptions ("device=s"       => \$device,
29             "command=s"      => \$command,
30             "discid=s"       => \$discid,
31             "discinfo=i{5,}" => \@discinfo,
32             "workdir=s"      => \$workdir,
33             "start=s"        => \$start,
34             "help|h"         => \$help,
35             "man"            => \$man) or pod2usage(-verbose => 0, -exitcode => 2);
36 if (@ARGV) {
37     print STDERR "Extraneous arguments given.\n";
38     pod2usage(-verbose => 0, -exitcode => 2);
39 }
40 pod2usage(-verbose => 1, -exitcode => 0) if $help;
41 pod2usage(-verbose => 2, -exitcode => 0) if $man;
42
43 # defaults
44 if (!defined($device)) {
45     $device = "/dev/cdrom";
46 }
47 if (!defined($command)) {
48     $command = "id";
49 }
50 if (!defined($workdir)) {
51     $workdir = "/tmp";
52 }
53 if (!defined($start)) {
54     $start = "0";
55 }
56
57 sub calc_sha1($) {
58     my $filename = shift;
59     my $s = Digest::SHA->new(1);
60     $s->addfile($filename);
61     return $s->hexdigest;
62 }
63
64 if ($command =~ m/^id/) {
65     my $disc = new MusicBrainz::DiscID($device);
66
67     # read the disc in the default disc drive */
68     if ( $disc->read() == 0 ) {
69         printf STDERR "Error: %s\n", $disc->error_msg();
70         exit(1);
71     }
72
73     printf("%s ", $disc->id());
74     printf("%d ", $disc->last_track_num() + 1 - $disc->first_track_num());
75
76     for ( my $i = $disc->first_track_num;
77           $i <= $disc->last_track_num; $i++ ) {
78         printf("%d ", $disc->track_offset($i));
79     }
80     printf("%d\n", $disc->sectors() / $FRAMES_PER_S);
81     undef $disc;
82 } elsif ($command =~ m/data/) {
83     if (!defined $discid or !$discid) {
84         print STDERR "Discid undefined.\n";
85         exit(1);
86     }
87     my $ws = WebService::MusicBrainz->new();
88     my $response = $ws->search(discid => {
89         discid => $discid,
90         inc => ['artists', 'artist-credits', 'recordings']
91         });
92
93     if ($response->{'error'}) {
94         print STDERR "MusicBrainz lookup returned an error \"$response->{'error'}\"\n";
95         exit(0);
96     }
97
98     my $releasenum = $start;
99     my @sums;
100
101     if ($response->{'releases'}) {
102         my @releases = @{ $response->{'releases'} };
103         foreach my $release (@releases) {
104             my $a_artist = "";
105             my $number_artists = @{ $release->{'artist-credit'}};
106             if ($number_artists > 0) {
107                 for (my $i = 0; $i < $number_artists; $i++) {
108                     if ($i > 0) {
109                         $a_artist = $a_artist . @{ $release->{'artist-credit'} }[$i-1]->{'joinphrase'};
110                     }
111                     $a_artist = $a_artist . @{ $release->{'artist-credit'} }[$i]->{'name'};
112                 }
113             }
114             my $va = 0;
115             my $rel_year = "";
116             if ($a_artist =~ /Various Artists/) {
117                 $va = 1;
118             }
119
120             if ($release->{'release-events'}) {
121                 my @release_events = @{ $release->{'release-events'} };
122                 if (@release_events > 0) {
123                     $rel_year =  substr(@release_events[0]->{'date'},0,4);
124                 }
125             }
126             $releasenum++;
127             open (OUT, "> $workdir/cddbread.$releasenum");
128             binmode OUT, ":utf8";
129             print OUT "# xmcd style database file\n";
130             print OUT "#\n";
131             print OUT "# Track frame offsets:\n";
132
133             my @offsets = @{ $response->{'offsets'}};
134             foreach my $offset (@offsets) {
135                 printf OUT "#       %d\n", $offset;
136             }
137
138             # Locate the media that contains a disc with the discid we requested
139             # initially. The API may return multiple media associated with the
140             # release, including media with different discids
141             my @mediums = grep {
142                 my @disks = @{ $_->{'discs'} };
143                 grep { $_->{'id'} eq $discid } @disks;
144             } @{ $release->{'media'} };
145
146             if (not @mediums) {
147                 # This release doesn't have a media with our requested dicsid
148                 # Shouldn't happen (?), skip it
149                 next;
150             }
151
152             # Only consider the first medium
153             my $medium = @mediums[0];
154             my @tracks = @{ $medium->{'tracks'} };
155
156             my $total_len = 0;
157             for (my $i = 0; $i < scalar(@tracks); $i++) {
158                 my $track = $tracks[$i];
159                 $total_len += $track->{'length'};
160             }
161
162             print OUT "#\n";
163             printf OUT "# Disc length: %d seconds\n", $total_len / 1000.0;
164             print OUT "#\n";
165             print OUT "# Submitted via: XXXXXX\n";
166             print OUT "#\n";
167             print OUT "#blues,classical,country,data,folk,jazz,newage,reggae,rock,soundtrack,misc\n";
168             print OUT "#CATEGORY=none\n";
169             print OUT "DISCID=" . $discid . "\n";
170             print OUT "DTITLE=" . $a_artist. " / " . $release->{'title'} . "\n";
171             print OUT "DYEAR=" . $rel_year . "\n";
172             print OUT "DGENRE=\n";        
173
174             for (my $i = 0; $i < scalar(@tracks); $i++) {
175                 my $track = $tracks[$i];
176                 my $t_name = $track->{'title'};
177                 my $number_artists = @{$track->{'recording'}->{'artist-credit'}};
178                 if ($va and $number_artists > 0) {
179                     my $t_artist = "";
180                     for (my $j = 0; $j < $number_artists; $j++) {
181                         if ($j > 0) {
182                             $t_artist = $t_artist . @{$track->{'recording'}->{'artist-credit'}}[$j-1]->{'joinphrase'};
183                         }
184                         $t_artist = $t_artist . @{$track->{'recording'}->{'artist-credit'}}[$j]->{'name'};
185                     }
186                     printf OUT "TTITLE%d=%s / %s\n", $i, $t_artist, $t_name;
187                 } else {
188                     printf OUT "TTITLE%d=%s\n", $i, $t_name;
189                 }
190             }
191
192             print OUT "EXTD=\n";
193             for (my $i = 0; $i < scalar(@tracks); $i++) {
194                 printf OUT "EXTT%d=\n", $i;
195             }
196             print OUT "PLAYORDER=\n";
197             print OUT ".\n";
198             close OUT;
199
200             # save release mbid
201             open (OUT, "> $workdir/mbid.$releasenum");
202             print OUT $release->{'id'};
203             close OUT;
204
205             # save release asin
206             open (OUT, "> $workdir/asin.$releasenum");
207             print OUT $release->{'asin'};
208             close OUT;
209
210             # Check to see that this entry is unique; generate a checksum
211             # and compare to any previous checksums
212             my $checksum = calc_sha1("$workdir/cddbread.$releasenum");
213             foreach my $sum (@sums) {
214                 if ($checksum eq $sum) {
215                     unlink("$workdir/cddbread.$releasenum");
216                     $releasenum--;
217                     last;
218                 }
219             }
220             push (@sums, $checksum);
221         }
222     } else {
223         # No release events found - looks like we have a stub
224         # entry. We can parse it, but it's going to be very
225         # different.
226         print STDERR "MusicBrainz lookup only returned a stub, trying to cope\n";
227         
228         my $va = 0;
229         my $a_artist = "";
230         my $a_title = "";
231         my $rel_year = "";
232
233         if ($response->{'artist'}) {
234             $a_artist = $response->{'artist'};
235         }
236         if ($response->{'title'}) {
237             $a_title = $response->{'title'};
238         }
239         if ($a_artist =~ /Various Artists/) {
240             $va = 1;
241         }
242
243         $releasenum++;
244         open (OUT, "> $workdir/cddbread.$releasenum");
245         binmode OUT, ":utf8";
246         print OUT "# xmcd style database file\n";
247         print OUT "#\n";
248         print OUT "# Musicbrainz stub entry - check carefully!\n";
249         print OUT "#\n";
250
251         my @tracks = @{ $response->{'tracks'} };
252
253         my $total_len = 0;
254         for (my $i = 0; $i < scalar(@tracks); $i++) {
255             my $track = $tracks[$i];
256             $total_len += $track->{'length'};
257         }
258
259         printf OUT "# Disc length: %d seconds\n", $total_len / 1000.0;
260         print OUT "#\n";
261         print OUT "# Submitted via: XXXXXX\n";
262         print OUT "#\n";
263         print OUT "#blues,classical,country,data,folk,jazz,newage,reggae,rock,soundtrack,misc\n";
264         print OUT "#CATEGORY=none\n";
265         print OUT "DISCID=" . $discid . "\n";
266         print OUT "DTITLE=" . $a_artist. " / " . $a_title . "\n";
267         print OUT "DYEAR=" . $rel_year . "\n";
268         print OUT "DGENRE=\n";        
269
270         for (my $i = 0; $i < scalar(@tracks); $i++) {
271             my $track = $tracks[$i];
272             my $t_name = $track->{'title'};
273             if ($va) {
274                 my $t_artist = $track->{'artist'};
275                 printf OUT "TTITLE%d=%s / %s\n", $i, $t_artist, $t_name;
276             } else {
277                 printf OUT "TTITLE%d=%s\n", $i, $t_name;
278             }
279         }
280
281         print OUT "EXTD=\n";
282         for (my $i = 0; $i < scalar(@tracks); $i++) {
283             printf OUT "EXTT%d=\n", $i;
284         }
285         print OUT "PLAYORDER=\n";
286         print OUT ".\n";
287         close OUT;
288
289         # Check to see that this entry is unique; generate a checksum
290         # and compare to any previous checksums
291         my $checksum = calc_sha1("$workdir/cddbread.$releasenum");
292         foreach my $sum (@sums) {
293             if ($checksum eq $sum) {
294                 unlink("$workdir/cddbread.$releasenum");
295                 $releasenum--;
296                 last;
297             }
298         }
299         push (@sums, $checksum);
300     }
301 } elsif ($command =~ m/calcid/) {
302     # Calculate MusicBrainz ID from disc offsets; see
303     # https://musicbrainz.org/doc/DiscIDCalculation
304
305     if ($#discinfo < 5) {
306         print STDERR "Insufficient or missing discinfo data.\n";
307         exit(1);
308     }
309     my ($first, $last, $leadin, $leadout, @offsets) = @discinfo;
310
311     my $s = Digest::SHA->new(1);
312     $s->add(sprintf "%02X", int($first));
313     $s->add(sprintf "%02X", int($last));
314
315     my @a;
316     for (my $i = 0; $i < 100; $i++) {
317         $a[$i] = 0;
318     }
319     my $i = 0;
320     foreach my $o ($leadout, @offsets) {
321        $a[$i++] = int($o) + int($leadin);
322     }
323     for (my $i = 0; $i < 100; $i++) {
324        $s->add(sprintf "%08X", $a[$i]);
325     }
326
327     my $id = $s->b64digest;
328     # CPAN Digest modules do not pad their Base64 output, so we have to do it.
329     while (length($id) % 4) {
330         $id .= '=';
331     }
332
333     $id =~ tr#+#.#;
334     $id =~ tr#/#_#;
335     $id =~ tr#=#-#;
336
337     print $id;
338     if (-t STDOUT) { print "\n"; }
339 } else {
340     print STDERR "Unknown command given.\n";
341     pod2usage(1);
342     exit(1);
343 }
344 __END__
345
346 =head1 NAME
347
348 abcde-musicbrainz-tool - Musicbrainz query tool
349
350 =head1 SYNOPSIS
351
352  abcde-musicbrainz-tool [options]
353
354  Options:
355    --command {id|data|calcid} mode of operation (default: id)
356    --device <DEV>             read from CD-ROM device DEV (default: /dev/cdrom)
357    --discid <ID>              Disc ID to query with --command data.
358    --discinfo <F> <L> <LI> <LO> <TRK1OFF> [<TRK2OFF> [...]]
359                               Disc information for --command calcid.
360    --workdir <DIR>            working directory (default: /tmp)
361    --help                     print option summary
362    --man                      full documentation
363
364 =head1 OPTIONS
365
366 =over 8
367
368 =item B<--command> I<{id|data|calcid}>
369
370 Select mode of operation:
371
372 =over 8
373
374 =item B<id>
375
376 Read the disc-ID from the disc in the given device, and print it, the number of tracks, their start sectors, and the duration of the disc in seconds, to stdout. Format:
377
378  ID TRACKCOUNT OFFSET1 [OFFSET2 [...]] LENGTH_S
379
380 =item B<data>
381
382 Query MusicBrainz web service and store data into the workdir into cddbread.1, cddbread.2, ... files in the workdir.
383
384 =item B<calcid>
385
386 Calculate MusicBrainz ID from given B<--discinfo> data.
387
388 =back
389
390 =item B<--device>
391
392 Specify CD-ROM drive's device name, to read ID from with B<--command id>.
393
394 =item B<--discid>
395
396 Supply disc ID for B<--command data>.
397
398 =item B<--discinfo> I<<first track> <last track> <lead-in sector> <lead-out sector> <track1 offset> [<track2 offset> [...]]>
399
400 Supply disc information for B<--command calcid>.
401
402 =item B<--workdir> I<directory>
403
404 The cddbread.* output files from B<--command data> go into this directory.
405
406 =item B<--help>
407
408 Print a brief help message and exit.
409
410 =item B<--man>
411
412 Display full manual and exit.
413
414 =back