[app-musicexpo.git] / lib / App / MusicExpo.pm

package App::MusicExpo;
use v5.14;
use strict;
use warnings;

our $VERSION = '0.005';

use Audio::FLAC::Header qw//;
use HTML::Template::Compiled qw//;
use Memoize qw/memoize/;
use MP3::Tag qw//;
use Ogg::Vorbis::Header::PurePerl;
use MP4::Info qw/get_mp4tag get_mp4info/;

use DB_File qw//;
use File::Basename qw/fileparse/;
use Fcntl qw/O_RDWR O_CREAT/;
use Getopt::Long;
use Storable qw/thaw freeze/;

##################################################

my $default_template;

our $prefix='/music/';
our $cache='';
our $template='';

GetOptions (
	"template:s" => \$template,
	"prefix:s" => \$prefix,
	"cache:s" => \$cache,
);


sub fix{
	my $copy = $_[0];
	utf8::decode($copy);
	$copy
}

sub flacinfo{
	my $file=$_[0];
	my $flac=Audio::FLAC::Header->new($file);
	$file = scalar fileparse $file;

	freeze +{
		format => 'FLAC',
		title => fix ($flac->tags('TITLE') // '?'),
		artist => fix ($flac->tags('ARTIST') // '?'),
		year => fix ($flac->tags('DATE') // '?'),
		album => fix ($flac->tags('ALBUM') // '?'),
		tracknumber => fix ($flac->tags('TRACKNUMBER') // '?'),
		tracktotal => fix ($flac->tags('TRACKTOTAL') // '?'),
		genre => fix ($flac->tags('GENRE') // '?'),
		file => $file,
	}
}

sub mp3info{
	my $file=$_[0];
	my $mp3=MP3::Tag->new($file);
	$file = scalar fileparse $file;

	freeze +{
		format => 'MP3',
		title => fix ($mp3->title || '?'),
		artist => fix ($mp3->artist || '?'),
		year => fix ($mp3->year || '?'),
		album => fix ($mp3->album || '?'),
		tracknumber => fix ($mp3->track1 || '?'),
		tracktotal => fix ($mp3->track2 || '?'),
		genre => fix ($mp3->genre) || '?',
		file => $file,
	}
}

sub vorbisinfo{
	my $file=$_[0];
	my $ogg=Ogg::Vorbis::Header::PurePerl->new($file);
	$file = scalar fileparse $file;

	freeze +{
		format => 'Vorbis',
		title => fix($ogg->comment('TITLE') || '?'),
		artist => fix ($ogg->comment('artist') || '?'),
		year => fix ($ogg->comment('DATE') || '?'),
		album => fix ($ogg->comment('ALBUM') || '?'),
		tracknumber => fix ($ogg->comment('TRACKNUMBER') || '?'),
		tracktotal => fix ($ogg->comment('TRACKTOTAL') || '?'),
		genre => fix ($ogg->comment('GENRE')) || '?',
		file => $file,
	}
}

sub mp4_format ($){
	my $encoding = $_[0];
	return 'AAC' if $encoding eq 'mp4a';
	return 'ALAC' if $encoding eq 'alac';
	"MP4-$encoding"
}

sub mp4info{
	my $file=$_[0];
	my %tag = %{get_mp4tag $file};
	my %info = %{get_mp4info $file};
	$file = scalar fileparse $file;

	freeze +{
		format => mp4_format $info{ENCODING},
		title => $tag{TITLE} || '?',
		artist => $tag{ARTIST} || '?',
		year => $tag{YEAR} || '?',
		album => $tag{ALBUM} || '?',
		tracknumber => $tag{TRACKNUM} || '?',
		tracktotal => ($tag{TRKN} ? $tag{TRKN}->[1] : undef) || '?',
		genre => $tag{GENRE} || '?',
		file => $file,
	};
}

sub normalizer{
	"$_[0]|".(stat $_[0])[9]
}

sub run {
	if ($cache) {
		tie my %cache, 'DB_File', $cache, O_RDWR|O_CREAT, 0644;
		memoize $_, NORMALIZER => \&normalizer, LIST_CACHE => 'MERGE', SCALAR_CACHE => [HASH => \%cache] for qw/flacinfo mp3info vorbisinfo mp4info/;
	}

	my %files;
	for my $file (@ARGV) {
		my $info;
		$info = thaw flacinfo $file if $file =~ /\.flac$/i;
		$info = thaw mp3info $file if $file =~ /\.mp3$/i;
		$info = thaw vorbisinfo $file if $file =~ /\.og(?:g|a)$/i;
		$info = thaw mp4info $file if $file =~ /\.mp4|\.aac|\.m4a$/i;
		next unless defined $info;
		my $basename = fileparse $file, '.flac', '.mp3', '.ogg', '.oga', '.mp4', '.aac', '.m4a';
		$files{$basename} //= [];
		push @{$files{$basename}}, $info;
	}

	my $ht=HTML::Template::Compiled->new(
		default_escape => 'HTML',
		global_vars => 2,
		$template eq '' ? (scalarref => \$default_template) : (filename => $template),
	);

	my @files;
	for (values %files) {
		my @versions = @$_;
		my %entry = (%{$versions[0]}, formats => []);
		for my $ver (@versions) {
			push @{$entry{formats}}, {format => $ver->{format}, file => $ver->{file}};
			for my $key (keys %$ver) {
				$entry{$key} = $ver->{$key} if $ver->{$key} ne '?';
			}
		}
		delete $entry{$_} for qw/format file/;
		push @files, \%entry
	}

	@files = sort { $a->{title} cmp $b->{title} } @files;
	$ht->param(files => \@files, prefix => $prefix);
	print $ht->output;
}

$default_template = <<'HTML';
<!DOCTYPE html>
<title>Music</title>
<meta charset="utf-8">
<link rel="stylesheet" href="musicexpo.css">
<script async defer type="application/javascript" src="player.js"></script>

<div id="player"></div>

<table border>
<thead>
<tr><th>Title<th>Artist<th>Album<th>Genre<th>Track<th>Year<th>Type
<tbody><tmpl_loop files>
<tr><td class="title"><tmpl_var title><td class="artist"><tmpl_var artist><td class="album"><tmpl_var album><td class="genre"><tmpl_var genre><td class="track"><tmpl_var tracknumber>/<tmpl_var tracktotal><td class="year"><tmpl_var year><td class="formats"><tmpl_loop formats><a href="<tmpl_var ...prefix><tmpl_var ESCAPE=URL file>"><tmpl_var format></a> </tmpl_loop></tmpl_loop>
</table>
HTML

1;

__END__

=encoding utf-8

=head1 NAME

App::MusicExpo - script which generates a HTML table of music tags

=head1 SYNOPSIS

  use App::MusicExpo;
  App::MusicExpo->run;

=head1 DESCRIPTION

App::MusicExpo creates a HTML table from a list of songs.

The default template looks like:

    | Title   | Artist  | Album           | Genre   | Track | Year | Type |
    |---------+---------+-----------------+---------+-------+------+------|
    | Cellule | Silence | L'autre endroit | Electro | 01/09 | 2005 | FLAC |

where the type is a download link. If you have multiple files with the same
basename (such as C<cellule.flac> and C<cellule.ogg>), they will be treated
as two versions of the same file, so a row will be created with two download
links, one for each format.

=head1 OPTIONS

=over

=item B<--template> I<template>

Path to the HTML::Template::Compiled template used for generating the music table. If '' (empty), uses the default format. Is empty by default.

=item B<--prefix> I<prefix>

Prefix for download links. Defaults to '/music/'.

=item B<--cache> I<filename>

Path to the cache file. Created if it does not exist. If '' (empty), disables caching. Is empty by default.

=back

=head1 AUTHOR

Marius Gavrilescu, E<lt>marius@ieval.roE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2013-2015 by Marius Gavrilescu

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.2 or,
at your option, any later version of Perl 5 you may have available.
Commit	Line	Data
	1	package App::MusicExpo;
	2	use v5.14;
	3	use strict;
	4	use warnings;
	5
	6	our $VERSION = '0.005';
	7
	8	use Audio::FLAC::Header qw//;
	9	use HTML::Template::Compiled qw//;
	10	use Memoize qw/memoize/;
	11	use MP3::Tag qw//;
	12	use Ogg::Vorbis::Header::PurePerl;
	13	use MP4::Info qw/get_mp4tag get_mp4info/;
	14
	15	use DB_File qw//;
	16	use File::Basename qw/fileparse/;
	17	use Fcntl qw/O_RDWR O_CREAT/;
	18	use Getopt::Long;
	19	use Storable qw/thaw freeze/;
	20
	21	##################################################
	22
	23	my $default_template;
	24
	25	our $prefix='/music/';
	26	our $cache='';
	27	our $template='';
	28
	29	GetOptions (
	30	"template:s" => \$template,
	31	"prefix:s" => \$prefix,
	32	"cache:s" => \$cache,
	33	);
	34
	35
	36	sub fix{
	37	my $copy = $_[0];
	38	utf8::decode($copy);
	39	$copy
	40	}
	41
	42	sub flacinfo{
	43	my $file=$_[0];
	44	my $flac=Audio::FLAC::Header->new($file);
	45	$file = scalar fileparse $file;
	46
	47	freeze +{
	48	format => 'FLAC',
	49	title => fix ($flac->tags('TITLE') // '?'),
	50	artist => fix ($flac->tags('ARTIST') // '?'),
	51	year => fix ($flac->tags('DATE') // '?'),
	52	album => fix ($flac->tags('ALBUM') // '?'),
	53	tracknumber => fix ($flac->tags('TRACKNUMBER') // '?'),
	54	tracktotal => fix ($flac->tags('TRACKTOTAL') // '?'),
	55	genre => fix ($flac->tags('GENRE') // '?'),
	56	file => $file,
	57	}
	58	}
	59
	60	sub mp3info{
	61	my $file=$_[0];
	62	my $mp3=MP3::Tag->new($file);
	63	$file = scalar fileparse $file;
	64
	65	freeze +{
	66	format => 'MP3',
	67	title => fix ($mp3->title \|\| '?'),
	68	artist => fix ($mp3->artist \|\| '?'),
	69	year => fix ($mp3->year \|\| '?'),
	70	album => fix ($mp3->album \|\| '?'),
	71	tracknumber => fix ($mp3->track1 \|\| '?'),
	72	tracktotal => fix ($mp3->track2 \|\| '?'),
	73	genre => fix ($mp3->genre) \|\| '?',
	74	file => $file,
	75	}
	76	}
	77
	78	sub vorbisinfo{
	79	my $file=$_[0];
	80	my $ogg=Ogg::Vorbis::Header::PurePerl->new($file);
	81	$file = scalar fileparse $file;
	82
	83	freeze +{
	84	format => 'Vorbis',
	85	title => fix($ogg->comment('TITLE') \|\| '?'),
	86	artist => fix ($ogg->comment('artist') \|\| '?'),
	87	year => fix ($ogg->comment('DATE') \|\| '?'),
	88	album => fix ($ogg->comment('ALBUM') \|\| '?'),
	89	tracknumber => fix ($ogg->comment('TRACKNUMBER') \|\| '?'),
	90	tracktotal => fix ($ogg->comment('TRACKTOTAL') \|\| '?'),
	91	genre => fix ($ogg->comment('GENRE')) \|\| '?',
	92	file => $file,
	93	}
	94	}
	95
	96	sub mp4_format ($){
	97	my $encoding = $_[0];
	98	return 'AAC' if $encoding eq 'mp4a';
	99	return 'ALAC' if $encoding eq 'alac';
	100	"MP4-$encoding"
	101	}
	102
	103	sub mp4info{
	104	my $file=$_[0];
	105	my %tag = %{get_mp4tag $file};
	106	my %info = %{get_mp4info $file};
	107	$file = scalar fileparse $file;
	108
	109	freeze +{
	110	format => mp4_format $info{ENCODING},
	111	title => $tag{TITLE} \|\| '?',
	112	artist => $tag{ARTIST} \|\| '?',
	113	year => $tag{YEAR} \|\| '?',
	114	album => $tag{ALBUM} \|\| '?',
	115	tracknumber => $tag{TRACKNUM} \|\| '?',
	116	tracktotal => ($tag{TRKN} ? $tag{TRKN}->[1] : undef) \|\| '?',
	117	genre => $tag{GENRE} \|\| '?',
	118	file => $file,
	119	};
	120	}
	121
	122	sub normalizer{
	123	"$_[0]\|".(stat $_[0])[9]
	124	}
	125
	126	sub run {
	127	if ($cache) {
	128	tie my %cache, 'DB_File', $cache, O_RDWR\|O_CREAT, 0644;
	129	memoize $_, NORMALIZER => \&normalizer, LIST_CACHE => 'MERGE', SCALAR_CACHE => [HASH => \%cache] for qw/flacinfo mp3info vorbisinfo mp4info/;
	130	}
	131
	132	my %files;
	133	for my $file (@ARGV) {
	134	my $info;
	135	$info = thaw flacinfo $file if $file =~ /\.flac$/i;
	136	$info = thaw mp3info $file if $file =~ /\.mp3$/i;
	137	$info = thaw vorbisinfo $file if $file =~ /\.og(?:g\|a)$/i;
	138	$info = thaw mp4info $file if $file =~ /\.mp4\|\.aac\|\.m4a$/i;
	139	next unless defined $info;
	140	my $basename = fileparse $file, '.flac', '.mp3', '.ogg', '.oga', '.mp4', '.aac', '.m4a';
	141	$files{$basename} //= [];
	142	push @{$files{$basename}}, $info;
	143	}
	144
	145	my $ht=HTML::Template::Compiled->new(
	146	default_escape => 'HTML',
	147	global_vars => 2,
	148	$template eq '' ? (scalarref => \$default_template) : (filename => $template),
	149	);
	150
	151	my @files;
	152	for (values %files) {
	153	my @versions = @$_;
	154	my %entry = (%{$versions[0]}, formats => []);
	155	for my $ver (@versions) {
	156	push @{$entry{formats}}, {format => $ver->{format}, file => $ver->{file}};
	157	for my $key (keys %$ver) {
	158	$entry{$key} = $ver->{$key} if $ver->{$key} ne '?';
	159	}
	160	}
	161	delete $entry{$_} for qw/format file/;
	162	push @files, \%entry
	163	}
	164
	165	@files = sort { $a->{title} cmp $b->{title} } @files;
	166	$ht->param(files => \@files, prefix => $prefix);
	167	print $ht->output;
	168	}
	169
	170	$default_template = <<'HTML';
	171	<!DOCTYPE html>
	172	<title>Music</title>
	173	<meta charset="utf-8">
	174	<link rel="stylesheet" href="musicexpo.css">
	175	<script async defer type="application/javascript" src="player.js"></script>
	176
	177	<div id="player"></div>
	178
	179	<table border>
	180	<thead>
	181	<tr><th>Title<th>Artist<th>Album<th>Genre<th>Track<th>Year<th>Type
	182	<tbody><tmpl_loop files>
	183	<tr><td class="title"><tmpl_var title><td class="artist"><tmpl_var artist><td class="album"><tmpl_var album><td class="genre"><tmpl_var genre><td class="track"><tmpl_var tracknumber>/<tmpl_var tracktotal><td class="year"><tmpl_var year><td class="formats"><tmpl_loop formats><a href="<tmpl_var ...prefix><tmpl_var ESCAPE=URL file>"><tmpl_var format></a> </tmpl_loop></tmpl_loop>
	184	</table>
	185	HTML
	186
	187	1;
	188
	189	__END__
	190
	191	=encoding utf-8
	192
	193	=head1 NAME
	194
	195	App::MusicExpo - script which generates a HTML table of music tags
	196
	197	=head1 SYNOPSIS
	198
	199	use App::MusicExpo;
	200	App::MusicExpo->run;
	201
	202	=head1 DESCRIPTION
	203
	204	App::MusicExpo creates a HTML table from a list of songs.
	205
	206	The default template looks like:
	207
	208	\| Title \| Artist \| Album \| Genre \| Track \| Year \| Type \|
	209	\|---------+---------+-----------------+---------+-------+------+------\|
	210	\| Cellule \| Silence \| L'autre endroit \| Electro \| 01/09 \| 2005 \| FLAC \|
	211
	212	where the type is a download link. If you have multiple files with the same
	213	basename (such as C<cellule.flac> and C<cellule.ogg>), they will be treated
	214	as two versions of the same file, so a row will be created with two download
	215	links, one for each format.
	216
	217	=head1 OPTIONS
	218
	219	=over
	220
	221	=item B<--template> I<template>
	222
	223	Path to the HTML::Template::Compiled template used for generating the music table. If '' (empty), uses the default format. Is empty by default.
	224
	225	=item B<--prefix> I<prefix>
	226
	227	Prefix for download links. Defaults to '/music/'.
	228
	229	=item B<--cache> I<filename>
	230
	231	Path to the cache file. Created if it does not exist. If '' (empty), disables caching. Is empty by default.
	232
	233	=back
	234
	235	=head1 AUTHOR
	236
	237	Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
	238
	239	=head1 COPYRIGHT AND LICENSE
	240
	241	Copyright (C) 2013-2015 by Marius Gavrilescu
	242
	243	This library is free software; you can redistribute it and/or modify
	244	it under the same terms as Perl itself, either Perl version 5.14.2 or,
	245	at your option, any later version of Perl 5 you may have available.