#!/usr/bin/perl
#
-# Copyright © 2008,2010,2012,2020 Nick Bowler
+# Copyright © 2008,2010,2012,2020-2021 Nick Bowler
#
# Silly little script to generate an FVWM menu with various bits of MPD
# status information and controls.
my $SELF = "$FindBin::Bin/$FindBin::Script";
my $MUSIC = $ENV{MUSIC} // "/srv/music";
-my $sock;
+my ($sock, $mpd_have_binarylimit);
-my ($albumid, $trackid);
+my ($albumid, $albumname, $trackid, $recordingid);
my ($topmenu, $menu);
my $mode = "top";
my %artistids;
$c = "%";
}
+ if ($mpd_have_binarylimit) {
+ # --embedded implies and requires binarylimit support
+ push @opts, "--embedded";
+ } else {
+ push @opts, "--no-binarylimit";
+ }
+
open THUMB, "-|", "$FindBin::Bin/mpdthumb.sh", @opts, "--", @_;
foreach (@_) {
my $thumb = <THUMB>;
my @submenu;
my ($mbid) = get_track_metadata($entry, "MUSICBRAINZ_RELEASETRACKID");
- @submenu = make_submenu("$menu-$mbid", "--track-id=$mbid") if $mbid;
+ if ($mbid) {
+ @submenu = make_submenu("$menu-$mbid", "--track-id=$mbid")
+ } else {
+ ($mbid) = get_track_metadata($entry, "MUSICBRAINZ_TRACKID");
+ @submenu = make_submenu("$menu-track-$mbid", "--recording-id=$mbid")
+ if ($mbid);
+ }
fvwm_cmd("AddToMenu", $menu,
fvwm_label_escape("Title:\t$entry->{Title}"),
sub top_track_album {
my ($entry) = @_;
my @submenu;
+ my $mbid;
+
+ if (($mbid) = get_track_metadata($entry, "MUSICBRAINZ_ALBUMID")) {
+ @submenu = make_submenu("$menu-$mbid", "--album-id=$mbid");
+ } elsif (($mbid) = get_track_metadata($entry, "MUSICBRAINZ_TRACKID")) {
+ # Standalone recording
+ my @a = get_track_metadata($entry, "MUSICBRAINZ_ARTISTID");
+ my ($album) = get_track_metadata($entry, "Album");
- my ($mbid) = get_track_metadata($entry, "MUSICBRAINZ_ALBUMID");
- @submenu = make_submenu("$menu-$mbid", "--album-id=$mbid") if $mbid;
+ @submenu = make_submenu("$menu-$mbid", "--album-name=$album",
+ map { "--artist-id=$_" } @a);
+
+ }
fvwm_cmd("AddToMenu", $menu,
fvwm_label_escape("Album:\t$entry->{Album}"),
@submenu);
}
+# Generate the "MusicBrainz:" entry in the top menu.
+sub top_track_musicbrainz {
+ my ($entry) = @_;
+ my ($track_mbid, $recording_mbid, $release_mbid);
+ my @artist_mbids;
+ my $label = "MB:";
+ my %idmap;
+
+ ($track_mbid) = get_track_metadata($entry, "MUSICBRAINZ_RELEASETRACKID");
+ ($recording_mbid) = get_track_metadata($entry, "MUSICBRAINZ_TRACKID");
+ ($release_mbid) = get_track_metadata($entry, "MUSICBRAINZ_ALBUMID");
+ @artist_mbids = get_track_metadata($entry, "MUSICBRAINZ_ARTISTID");
+ return unless $track_mbid // $recording_mbid
+ // $release_mbid // @artist_mbids;
+
+ foreach (get_track_metadata($entry, "Comment")) {
+ $idmap{$1} = $2 if /^([^=]*)=(.*) \(idmap\)$/;
+ }
+
+ fvwm_cmd("AddToMenu", $menu, "", "Nop");
+ if ($track_mbid) {
+ fvwm_cmd("AddToMenu", $menu, "$label\tShow track",
+ "Exec", "exec", "xdg-open",
+ "https://musicbrainz.org/track/$track_mbid");
+ $label = "";
+ } elsif ($recording_mbid) {
+ fvwm_cmd("AddToMenu", $menu, "$label\tShow recording",
+ "Exec", "exec", "xdg-open",
+ "https://musicbrainz.org/recording/$recording_mbid");
+ $label = "";
+ } elsif ($release_mbid) {
+ fvwm_cmd("AddToMenu", $menu, "$label\tShow",
+ "Exec", "exec", "xdg-open",
+ "https://musicbrainz.org/release/$release_mbid");
+ $label = "";
+ }
+
+ foreach my $mbid (@artist_mbids) {
+ my $name = " $idmap{$mbid}" if $idmap{$mbid};
+
+ fvwm_cmd("AddToMenu", $menu, "$label\tShow artist$name",
+ "Exec", "exec", "xdg-open",
+ "https://musicbrainz.org/artist/$mbid");
+ $label = "";
+ }
+}
+
# Given a work MBID, return a hash reference containing all tracks
# linked to that work. The hash keys are filenames.
sub get_tracks_by_work_mbid {
my $entry;
return \%matches unless ($mbid);
- MPD::exec("search", "(MUSICBRAINZ_RELEASETRACKID == \"$mbid\")");
+ MPD::exec("search", "($tagname == \"$mbid\")");
while (<$sock>) {
last if (/^OK/);
die($_) if (/^ACK/);
return \%matches;
}
+sub get_tracks_by_recording_mbid {
+ return get_tracks_by_track_mbid($_[0], "MUSICBRAINZ_TRACKID");
+}
+
# Given a release MBID, return a hash reference containing all its
# associated tracks in the MPD database. The hash keys are filenames.
sub get_tracks_by_release_mbid {
return \%matches;
}
-# Given an artist MBID, return a hash reference containing associated
-# releases in the MPD database. The hash keys are release MBIDs.
+# Insert the given entry into the referenced hash if it represents a
+# standalone recording (not associated with a release). The recording
+# MBID is used as the hash key.
+sub check_standalone {
+ my ($outhash, $entry) = @_;
+ my ($mbid) = get_track_metadata($entry, "MUSICBRAINZ_TRACKID");
+
+ return if exists $entry->{MUSICBRAINZ_ALBUMID};
+ $outhash->{$mbid} = $entry if ($mbid);
+}
+
+# Given an artist MBID, return a list of two hash refererences. The
+# first contains the associated releases in the MPD database and the
+# hash keys are release MBIDs. The second contains the artist's
+# standalone recordings and the hash keys are recording MBIDs.
+#
+# In scalar context only the release hash is returned.
#
# Since MPD returns results on a per-track basis, each entry in the
# hash has the metadata for one unspecified track from that release.
sub get_releases_by_artist_mbid {
- my %releases;
+ my (%releases, %standalones);
my $entry;
foreach my $mbid (@_) {
if (/^(\w+): (.*)$/) {
if ($1 eq "file") {
+ check_standalone(\%standalones, $entry);
$entry = {};
} elsif ($1 eq "MUSICBRAINZ_ALBUMID") {
$releases{$2} //= $entry;
add_track_metadata($entry, $1, $2);
}
}
+ check_standalone(\%standalones, $entry);
}
- return \%releases;
+ return wantarray ? (\%releases, values %standalones) : \%releases;
}
# Given a filename, return the IDs (if any) for that file in the
return @results;
}
+sub update_entry_ids {
+ my @notqueued = ();
+
+ foreach my $entry (@_) {
+ unless (exists $entry->{Id}) {
+ my ($id) = get_ids_by_filename($entry->{file});
+ if (defined $id) {
+ $entry->{Id} = $id;
+ } else {
+ push @notqueued, $entry;
+ next;
+ }
+ }
+ }
+
+ return @notqueued;
+}
+
# albumsort(matches, a, b)
#
# Sort hash keys (a, b) by disc/track number for album menus.
sub print_version {
print <<EOF
-mpdmenu.pl 0.8
-Copyright © 2019 Nick Bowler
+mpdmenu.pl 0.9
+Copyright © 2021 Nick Bowler
License GPLv3+: GNU General Public License version 3 or any later version.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
-p, --port=PORT Connect to the MPD server on PORT, overriding defaults.
-m, --menu=NAME Set the name of the generated menu.
--album-id=MBID Generate a menu for the given release MBID.
+ --album-name=NAME
+ Generate a menu for standalone tracks with the given
+ "album" NAME. An artist MBID must be supplied.
--artist-id=MBID Generate a menu for the given artist MBID.
--track-id=MBID Generate a menu for the given track MBID.
+ --recording-id=MBID
+ Generate a menu for the given recording MBID.
-V, --version Print a version message and then exit.
-H, --help Print this message and then exit.
EOF
}
GetOptions(
- 'host|h=s' => \$MPD::host,
- 'port|p=s' => \$MPD::port,
- 'menu|m=s' => \$menu,
+ 'host|h=s' => \$MPD::host,
+ 'port|p=s' => \$MPD::port,
+ 'menu|m=s' => \$menu,
- 'artist-id=s' => sub { $artistids{$_[1]} = 1; $mode = "artist"; },
- 'album-id=s' => sub { $albumid = $_[1]; $mode = "album"; },
- 'track-id=s' => sub { $trackid = $_[1]; $mode = "track"; },
+ 'artist-id=s' => sub { $artistids{$_[1]} = 1; $mode = "artist"; },
+ 'album-id=s' => sub { $albumid = $_[1]; $mode = "album"; },
+ 'album-name=s' => sub { $albumname = $_[1]; $mode = "albumname"; },
+ 'track-id=s' => sub { $trackid = $_[1]; $mode = "track"; },
+ 'recording-id=s' => sub { $recordingid = $_[1]; $mode = "recording"; },
- 'V|version' => sub { print_version(); exit },
- 'H|help' => sub { print_help(); exit },
+ 'V|version' => sub { print_version(); exit },
+ 'H|help' => sub { print_help(); exit },
- 'topmenu=s' => \$topmenu, # top menu name (for submenu generation)
+ 'topmenu=s' => \$topmenu, # top menu name (for submenu generation)
) or do { print_usage; exit 1 };
+$mode = "albumname" if ($albumname && $mode eq "artist");
+
unless (defined $menu) {
$topmenu //= "MenuMPD";
$menu = $topmenu . ($mode ne "top" ? $mode : "");
die("MPD version $MPD::major.$MPD::minor.$MPD::revision insufficient.")
unless MPD::min_version(MPD_MJR_MIN, MPD_MNR_MIN, MPD_REV_MIN);
+MPD::exec("binarylimit", 64);
+while (<$sock>) {
+ $mpd_have_binarylimit = 1 if /^OK/;
+ last if /^OK/ or /^ACK/;
+}
+
if ($mode eq "top") {
my %current;
my %state;
top_track_title(\%current);
top_track_artist(\%current);
top_track_album(\%current);
+ top_track_musicbrainz(\%current);
} else {
fvwm_cmd("AddToMenu", $menu, "[current track unavailable]");
}
}
} elsif ($mode eq "artist") {
# Create an artist menu.
- my $matches = get_releases_by_artist_mbid(keys %artistids);
- my $entry;
+ my ($matches, @recs) = get_releases_by_artist_mbid(keys %artistids);
$menu //= "MenuMPDArtist";
my @mbids = sort { datesort($matches, $a, $b) } keys %$matches;
my @files = map { $matches->{$_}->{file} } @mbids;
my @thumbs = get_item_thumbnails({ small => 1 }, @files);
- fvwm_cmd("AddToMenu", $menu, "No releases found", "Title") unless @mbids;
+
+ unless (@mbids) {
+ fvwm_cmd("AddToMenu", $menu, "No releases found", "Title")
+ }
foreach my $mbid (@mbids) {
my $entry = $matches->{$mbid};
"--album-id=$mbid");
fvwm_cmd("AddToMenu", $menu,
$thumb . fvwm_label_escape($entry->{Album}),
- @submenu);
+ @submenu);
+ }
+
+ my @artists = map { "--artist-id=$_" } keys %artistids;
+ my %nonalbums = map { $_->{Album} => $_ } @recs;
+ foreach my $name (sort keys %nonalbums) {
+ my $mbid = $nonalbums{$name}->{MUSICBRAINZ_TRACKID};
+ my @submenu = make_submenu("$topmenu-$mbid", @artists,
+ "--album-name=$name");
+ fvwm_cmd("AddToMenu", $menu, fvwm_label_escape($name), @submenu);
+ }
+} elsif ($mode eq "albumname") {
+ # Create a standalone recordings menu
+ my ($releases, @recs) = get_releases_by_artist_mbid(keys %artistids);
+
+ $menu //= "MenuMPDRecordings";
+ my @tracks = sort { $a->{Title} cmp $b->{Title} }
+ grep { $_->{Album} eq $albumname } @recs;
+
+ # Show thumbnails for standalone recordings
+ my @thumbs = get_item_thumbnails({ small => 1 },
+ map { $_->{file} } @tracks);
+ foreach my $entry (@tracks) {
+ $entry->{thumb} = shift @thumbs;
+ }
+
+ my @notqueued = update_entry_ids(@tracks);
+
+ fvwm_cmd("AddToMenu", $menu);
+ fvwm_cmd("+", "No tracks found", "Title") unless @tracks;
+
+ foreach my $entry (@tracks) {
+ next unless exists $entry->{Id};
+
+ fvwm_cmd("+", menu_trackname($entry), "Exec",
+ "exec", "$FindBin::Bin/mpdexec.pl",
+ "playid", $entry->{Id});
}
-} elsif ($mode eq "track") {
- my $matches = get_tracks_by_track_mbid($trackid);
+
+ fvwm_cmd("+", "Not in play queue", "Title") if @notqueued;
+ foreach my $entry (@notqueued) {
+ fvwm_cmd("+", menu_trackname($entry));
+ }
+} elsif ($mode eq "track" || $mode eq "recording") {
+ my ($matches, $mbid);
my @notqueued;
+ if ($mode eq "track") {
+ $matches = get_tracks_by_track_mbid($trackid)
+ } else {
+ $matches = get_tracks_by_recording_mbid($recordingid)
+ }
+
$menu //= "MenuMPDTrack";
+ fvwm_cmd("DestroyMenu", $menu);
my @files = sort { datesort($matches, $a, $b) } keys %$matches;
my @thumbs = get_item_thumbnails({ small => 1 }, @files);