mpdmenu.pl

   1 #!/usr/bin/perl
   2 #
   3 # Copyright © 2008,2010,2012,2019 Nick Bowler
   4 #
   5 # Silly little script to generate an FVWM menu with various bits of MPD
   6 # status information and controls.
   7 #
   8 # License GPLv3+: GNU General Public License version 3 or any later version.
   9 # This is free software: you are free to change and redistribute it.
  10 # There is NO WARRANTY, to the extent permitted by law.
  11
  12 use strict;
  13
  14 use Getopt::Long;
  15 use IO::Socket::INET6;
  16 use Scalar::Util qw(reftype);
  17 use FindBin;
  18
  19 use constant {
  20         MPD_MJR_MIN => 0,
  21         MPD_MNR_MIN => 21,
  22         MPD_REV_MIN => 0,
  23 };
  24
  25 use utf8;
  26 use open qw(:std :utf8);
  27 binmode(STDOUT, ":utf8");
  28 use Encode;
  29
  30 my $SELF = "$FindBin::Bin/$FindBin::Script";
  31 my $MUSIC = $ENV{MUSIC} // "/srv/music";
  32
  33 # get_item_thumbnails({ options }, file, ...)
  34 # get_item_thumbnails(file, ...)
  35 #
  36 # For each music file listed, obtain a thumbnail (if any) for the cover art.
  37 #
  38 # The first argument is a hash reference to control the mode of operation;
  39 # it may be omitted for default options.
  40 #
  41 #   get_item_thumbnails({ small => 1 }, ...) - smaller thumbnails
  42 #
  43 # The returned list consists of strings (in the same order as the filename
  44 # arguments) suitable for use directly in FVWM menus; by default the filename
  45 # is bracketed by asterisks (e.g., "*thumbnail.png*"); in small mode it is
  46 # surrounded by % (e.g., "%thumbnail.png%").  If no cover art was found, the
  47 # empty string is returned for that file.
  48 sub get_item_thumbnails {
  49         my @results = ();
  50         my $flags = {};
  51         my @opts = ();
  52
  53         $flags = shift if (reftype($_[0]) eq "HASH");
  54         return @results unless @_;
  55
  56         my $c = "*";
  57         if ($flags->{small}) {
  58                 push @opts, "--small";
  59                 $c = "%";
  60         }
  61
  62         open THUMB, "-|", "$FindBin::Bin/mpdthumb.sh", @opts, "--", @_;
  63         foreach (@_) {
  64                 my $thumb = <THUMB>;
  65                 chomp $thumb;
  66
  67                 $thumb = "$c$thumb$c" if (-f $thumb);
  68                 push @results, $thumb;
  69         }
  70         close THUMB;
  71         die("mpdthumb failed") if ($?);
  72
  73         return @results;
  74 }
  75
  76 # Given a music filename, search for the cover art in the same directory.
  77 sub mpd_cover_filename {
  78         my ($dir) = @_;
  79         my $file;
  80
  81         $dir =~ s/\/[^\/]*$//;
  82         foreach ("cover.png", "cover.jpg", "cover.tiff", "cover.bmp") {
  83                 if (-f "$dir/$_") {
  84                         $file = "$dir/$_";
  85                         last;
  86                 }
  87         }
  88         return unless defined $file;
  89
  90         # Follow one level of symbolic link to get to the scans directory.
  91         $file = readlink($file) // $file;
  92         $file = "$dir/$file" unless ($file =~ /^\//);
  93         return $file;
  94 }
  95
  96 sub cmd
  97 {
  98         print "$_[0]\n";
  99 }
 100
 101 # Global hash for tracking what is to be "accepted".
 102 my %accept = ();
 103
 104 my $FVWM = (defined $ENV{FVWM_USERDIR}) ? $ENV{FVWM_USERDIR}
 105                                         : $ENV{HOME}."/.fvwm";
 106 my $icons = "$FVWM/icons";
 107
 108 # Default values for stuff.
 109 my ($album, $artist, $title, $menu) = (undef, undef, undef, undef);
 110 my $host = (defined $ENV{MPD_HOST}) ? $ENV{MPD_HOST} : "localhost";
 111 my $port = (defined $ENV{MPD_PORT}) ? $ENV{MPD_PORT} : "6600";
 112
 113 GetOptions(
 114         'host|h=s'   => \&host,   # Host that MPD is running on.
 115         'port|p=s'   => \&port,   # Port that MPD is listening on.
 116         'menu|m=s'   => \$menu,   # Name of the menu to create.
 117         'album=s'    => \$album,  # Album to get tracks from
 118         'artist=s'   => \$artist, # Artist to limit results to
 119         'title=s'    => \$title,  # Title to create menu for
 120 );
 121
 122 $album  = decode_utf8($album)  if defined($album);
 123 $artist = decode_utf8($artist) if defined($artist);
 124 $title  = decode_utf8($title)  if defined($title);;
 125
 126 # Connect to MPD.
 127 my $sock = new IO::Socket::INET6(
 128         PeerAddr => $host,
 129         PeerPort => $port,
 130         Proto => 'tcp',
 131         Timeout => 2
 132 ) or die("could not open socket: $!.\n");
 133 binmode($sock, ":utf8");
 134
 135 die("could not connect to MPD: $!.\n")
 136         if (!(<$sock> =~ /^OK MPD ([0-9]+)\.([0-9]+)\.([0-9]+)$/));
 137
 138 die("MPD version $1.$2.$3 insufficient.\n")
 139         if (  ($1 <  MPD_MJR_MIN)
 140            || ($1 == MPD_MJR_MIN && $2 <  MPD_MNR_MIN)
 141            || ($1 == MPD_MJR_MIN && $2 == MPD_MNR_MIN && $3 < MPD_REV_MIN));
 142
 143 if (defined $album) {
 144         # Create an album menu.
 145         my @playlist = ();
 146         my $entry;
 147
 148         $menu = "MenuMPDAlbum" unless defined $menu;
 149
 150         $album =~ s/"/\\"/g;
 151         print $sock "playlistfind album \"$album\"\n";
 152         while (<$sock>) {
 153                 last if (/^OK/);
 154                 die($_) if (/^ACK/);
 155
 156                 if (/^(\w+): (.*)$/) {
 157                         if ($1 eq "file") {
 158                                 if (keys(%$entry) > 0) {
 159                                         addalbumentry(\@playlist, $entry)
 160                                 }
 161
 162                                 $entry = {};
 163                         }
 164
 165                         $entry->{$1} = $2;
 166                 }
 167         }
 168         addalbumentry(\@playlist, $entry) if (keys(%$entry) > 0);
 169
 170         die("No tracks found.\n") if (!@playlist);
 171         foreach (sort albumsort @playlist) {
 172                 my ($t_file, $t_trackno, $t_artist, $t_title, $t_id) = (
 173                         $_->{file},
 174                         $_->{Track},
 175                         $_->{Artist},
 176                         $_->{Title},
 177                         $_->{Id},
 178                 );
 179
 180                 next if (defined $artist && !$accept{albumdir($t_file)});
 181
 182                 $t_artist = sanitise($t_artist, 0);
 183                 $t_title  = sanitise($t_title, 0);
 184
 185                 my $cmd = sprintf "AddToMenu $menu \"%d\t%s - %s\""
 186                                   ." Exec exec $FindBin::Bin/mpdexec.pl"
 187                                   ." playid %d",
 188                                   $t_trackno, $t_artist, $t_title, $t_id;
 189
 190                 cmd($cmd);
 191         }
 192 } elsif (defined $artist) {
 193         # Create an artist menu.
 194         my %albums = ();
 195         my $file;
 196         my $quoteartist = $artist;
 197
 198         $menu = "MenuMPDArtist" unless defined $menu;
 199
 200         $quoteartist =~ s/"/\\"/g;
 201         print $sock "playlistfind artist \"$quoteartist\"\n";
 202         while (<$sock>) {
 203                 last if (/^OK/);
 204                 die($_) if (/^ACK/);
 205
 206                 if (/^(\w+): (.*)$/) {
 207                         $file       = $2    if ($1 eq "file");
 208                         $albums{$2} = $file if ($1 eq "Album");
 209                 }
 210         }
 211
 212         die("No albums found.\n") if (!keys(%albums));
 213
 214 { # work around 'use locale' breaking s///i
 215         my $i = 0;
 216         use locale;
 217
 218         my @keys = sort keys %albums;
 219         my @thumbs = get_item_thumbnails({ small => 1 },
 220                                           map { $albums{$_} } @keys);
 221
 222         foreach my $key (@keys) {
 223                 my $a_album  = sanitise($key, 1);
 224                 my $thumb = shift @thumbs;
 225
 226                 cmd("AddToMenu $menu \"$thumb$a_album\" Popup MenuMPDArt_$i");
 227
 228                 cmd("AddToMenu MenuMPDArt_$i DynamicPopUpAction MakeMenuMPDArt_$i");
 229
 230                 cmd("DestroyFunc MakeMenuMPDArt_$i");
 231                 cmd("AddToFunc   MakeMenuMPDArt_$i
 232                      + I DestroyMenu MenuMPDArt_$i
 233                      + I -PipeRead \"exec $SELF "
 234                            ."--menu MenuMPDArt_$i "
 235                            ."--album  ".shellify($key, 1)." "
 236                            ."--artist ".shellify($artist, 1)."\"");
 237
 238                 cmd("AddToFunc KillMenuMPD I DestroyMenu MenuMPDArt_$i");
 239                 cmd("AddToFunc KillMenuMPD I DestroyFunc MakeMenuMPDArt_$i");
 240
 241                 $i++;
 242         }
 243 } # end use locale workaround
 244 } elsif (defined $title) {
 245         # Create a title menu.
 246         my @titles;
 247         my $entry;
 248
 249         $menu = "MenuMPDTitle" unless defined $menu;
 250
 251         # Open and close brackets.
 252         my ($ob, $cb) = ("[\[~〜<〈(ー−-]", "[\]~〜>〉)ー−-]");
 253
 254         $_ = $title;
 255
 256         # Deal with specific cases.
 257         s/ちいさな(?=ヘミソフィア)//;                 # ヘミソフィア
 258         s/ "mix on air flavor" dear EIKO SHIMAMIYA//; # Spiral wind
 259         s/ "So,you need me" Style//;                  # I need you
 260         s/ ::Symphony Second movement:://;            # Disintegration
 261         s/-\[instrumental\]//;                        # 青い果実
 262         s/ -Practice Track-//;                        # Fair Heaven
 263         s/〜世界で一番アナタが好き〜//;               # Pure Heart
 264         s/〜彼方への哀歌//;                           # 十二幻夢
 265         s/　sora no uta ver.//;                       # 美しい星
 266
 267         s/\s*-remix-$//; # Otherwise "D-THREAD -remix-" doesn't work right.
 268
 269         # Deal with titles like "blah (ABC version)".
 270         s/\s*$ob.*(style|mix|edit|edition|ver\.?|version|melody|カラオケ)$cb?$//i;
 271
 272         # Deal with titles like "blah (without XYZ)".
 273         s/\s*$ob\s*((e\.)?piano|english|japanese|inst|tv|without|w\/o|off|back|short|karaoke|game).*//i;
 274
 275         # Deal with titles like "blah instrumental".
 276         s/\s+(instrumental|off vocal|short|tv)([\s-]+(mix|size|version))?$//i;
 277         s/\s+without\s+\w+$//i;
 278
 279         # Deal with separate movements in classical pieces.
 280         s/: [IVX]+\..*//;
 281
 282         my $basetitle  = $_;
 283         my $_basetitle = $basetitle;
 284
 285         $_basetitle =~ s/"/\\"/g;
 286         print $sock "playlistsearch title \"$_basetitle\"\n";
 287         while (<$sock>) {
 288                 last if (/^OK/);
 289                 die($_) if (/^ACK/);
 290
 291                 if (/^(\w+): (.*)$/) {
 292                         if ($1 eq "file") {
 293                                 push @titles, $entry if (keys(%$entry) > 0);
 294                                 $entry = {};
 295                         }
 296
 297                         $entry->{$1} = $2;
 298                 }
 299         }
 300         push @titles, $entry if (keys(%$entry) > 0);
 301
 302 { # work around 'use locale' breaking s///i
 303         use locale;
 304
 305         my @thumbs = get_item_thumbnails({ small => 1 },
 306                                           map { $_->{file} } @titles);
 307         for (my $i = 0; $i < @titles; $i++) {
 308                 $titles[$i]->{thumb} = $thumbs[$i];
 309         }
 310
 311         foreach (sort titlesort @titles) {
 312                 my ($t_file, $t_artist, $t_title, $t_id, $thumb) = (
 313                         $_->{file},
 314                         $_->{Artist},
 315                         $_->{Title},
 316                         $_->{Id},
 317                         $_->{thumb}
 318                 );
 319
 320                 # MPD searches are case-insensitive.
 321                 next if (!($t_title =~ m/(\P{Latin}|^)\Q$basetitle\E(\P{Latin}|$)/ || $t_title =~ m/\Q$basetitle\E/i));
 322
 323                 $t_artist = sanitise($t_artist, 1);
 324                 $t_title  = sanitise($t_title, 1);
 325
 326                 cmd("AddToMenu $menu \"$thumb$t_artist - $t_title\""
 327                     ." Exec exec $FindBin::Bin/mpdexec.pl"
 328                     ." playid $t_id");
 329         }
 330 } # end use locale workaround
 331 } else {
 332         # Make MPD base menu
 333         my ($state, $songid) = (undef, undef);
 334         my %entry = ();
 335
 336         $menu = "MenuMPD" unless defined $menu;
 337
 338         print $sock "status\n";
 339         while (<$sock>) {
 340                 last if (/^OK/);
 341                 die($_) if (/^ACK/);
 342
 343                 if (/^(\w+): (.*)$/) {
 344                         $state  = $2 if ($1 eq "state");
 345                         $songid = $2 if ($1 eq "songid");
 346                 }
 347         }
 348         die("Failed status query\n") unless (defined $state);
 349
 350         cmd("AddToMenu $menu Playing Title") if ($state eq "play");
 351         cmd("AddToMenu $menu Paused Title")  if ($state eq "pause");
 352         cmd("AddToMenu $menu Stopped Title") if ($state eq "stop");
 353
 354         if (defined $songid) {
 355                 print $sock "playlistid $songid\n";
 356                 while (<$sock>) {
 357                         last if (/^OK/);
 358                         die($_) if (/^ACK/);
 359
 360                         if (/^(\w+): (.*)$/) {
 361                                 $entry{$1} = $2;
 362                         }
 363                 }
 364                 die("Failed data query\n") unless (keys(%entry) > 0);
 365
 366                 my ($thumb) = get_item_thumbnails($entry{file});
 367                 if ($thumb) {
 368                         my $cover = mpd_cover_filename("$MUSIC/$entry{file}");
 369
 370                         cmd("AddToMenu $menu \"$thumb\" "
 371                                 ."Exec exec geeqie ".shellify($cover, 0));
 372                 }
 373
 374                 cmd("AddToMenu $menu \"Title:   ".sanitise($entry{Title}, 0)
 375                         ."\" Popup MenuMPDTitle");
 376                 cmd("AddToMenu $menu \"Artist:  ".sanitise($entry{Artist}, 0)
 377                         ."\" Popup MenuMPDArtist");
 378                 cmd("AddToMenu $menu \"Album:   ".sanitise($entry{Album}, 0)
 379                         ."\" Popup MenuMPDAlbum");
 380                 cmd("AddToMenu $menu \"\" Nop");
 381         } else {
 382                 cmd("AddToMenu $menu \"<Song info unavailable>\"");
 383                 cmd("AddToMenu $menu \"\" Nop");
 384         }
 385
 386         if ($state eq "play" || $state eq "pause") {
 387                 cmd("AddToMenu $menu \"\t\tNext%$icons/next.svg:16x16%\" "
 388                         ."Exec exec $FindBin::Bin/mpdexec.pl next");
 389                 cmd("AddToMenu $menu \"\t\tPause%$icons/pause.svg:16x16%\" "
 390                         ."Exec exec $FindBin::Bin/mpdexec.pl pause");
 391                 cmd("AddToMenu $menu \"\t\tPlay%$icons/play.svg:16x16%\" "
 392                         ."Exec exec $FindBin::Bin/mpdexec.pl play");
 393                 cmd("AddToMenu $menu \"\t\tStop%$icons/stop.svg:16x16%\" "
 394                         ."Exec exec $FindBin::Bin/mpdexec.pl stop");
 395                 cmd("AddToMenu $menu \"\t\tPrev%$icons/prev.svg:16x16%\" "
 396                         ."Exec exec $FindBin::Bin/mpdexec.pl previous");
 397         } elsif ($state eq "stop") {
 398                 cmd("AddToMenu $menu \"\t\tPlay%$icons/play.svg:16x16%\" "
 399                         ."Exec exec $FindBin::Bin/mpdexec.pl play");
 400         } else {
 401                 die("Unknown MPD state!\n");
 402         }
 403
 404         cmd("AddToMenu $menu \"\" Nop");
 405         cmd("AddToMenu $menu \"\t\tShuffle%$icons/shuffle.svg:16x16%\" "
 406                 ."Exec exec $FindBin::Bin/mpdexec.pl shuffle");
 407
 408         cmd("DestroyMenu MenuMPDTitle");
 409         cmd("AddToMenu   MenuMPDTitle  DynamicPopUpAction MakeMenuMPDTitle");
 410         cmd("DestroyMenu MenuMPDArtist");
 411         cmd("AddToMenu   MenuMPDArtist DynamicPopUpAction MakeMenuMPDArtist");
 412         cmd("DestroyMenu MenuMPDAlbum");
 413         cmd("AddToMenu   MenuMPDAlbum  DynamicPopUpAction MakeMenuMPDAlbum");
 414
 415         cmd("DestroyFunc MakeMenuMPDTitle");
 416         cmd("AddToFunc   MakeMenuMPDTitle
 417              + I DestroyMenu MenuMPDTitle
 418              + I -PipeRead \"exec $SELF "
 419                            ."--menu MenuMPDTitle "
 420                            ."--title ".shellify($entry{Title}, 1)."\"");
 421
 422         cmd("DestroyFunc MakeMenuMPDAlbum");
 423         cmd("AddToFunc   MakeMenuMPDAlbum
 424              + I DestroyMenu MenuMPDAlbum
 425              + I -PipeRead \"exec $SELF "
 426                            ."--menu MenuMPDAlbum "
 427                            ."--album  ".shellify($entry{Album}, 1)." "
 428                            ."--artist ".shellify($entry{Artist}, 1)."\"");
 429
 430         cmd("DestroyFunc MakeMenuMPDArtist");
 431         cmd("AddToFunc   MakeMenuMPDArtist
 432              + I DestroyMenu MenuMPDArtist
 433              + I -PipeRead \"exec $SELF "
 434                            ."--menu MenuMPDArtist "
 435                            ."--artist ".shellify($entry{Artist}, 1)."\"");
 436
 437         cmd("DestroyFunc KillMenuMPD");
 438         cmd("AddToFunc   KillMenuMPD I Nop");
 439 }
 440
 441 # Finished.
 442 print $sock "close\n";
 443
 444 sub sanitise
 445 {
 446         $_ = $_[0];
 447         s/&/&&/g if ($_[1]);
 448         s/([\$@%^*])/\1\1/g;
 449         s/"/\\"/g;
 450         return $_;
 451 }
 452
 453 sub addalbumentry
 454 {
 455         my ($playlist, $entry) = @_;
 456
 457         push(@$playlist, $entry);
 458
 459         if (defined $artist && $artist eq $entry->{Artist}) {
 460                 my $albumdir = albumdir($entry->{file});
 461                 $accept{$albumdir} = 1;
 462         }
 463 }
 464
 465 sub albumdir
 466 {
 467         my $file = $_[0];
 468
 469         $file =~ s:(/Disk [0-9]+[^/]*)?/[^/]*$::;
 470         return $file
 471 }
 472
 473 sub albumsort
 474 {
 475         return ($a->{Disc} <=> $b->{Disc}) if ($a->{Disc} != $b->{Disc});
 476         return ($a->{Track} <=> $b->{Track});
 477 }
 478
 479 sub titlesort
 480 {
 481         return ($a->{Album}  cmp $b->{Album})  if($a->{Album}  ne $b->{Album});
 482         return ($a->{Artist} cmp $b->{Artist}) if($a->{Artist} ne $b->{Artist});
 483         return ($a->{Title}  cmp $b->{Title});
 484 }
 485
 486 sub shellify
 487 {
 488         my ($str, $quoted) = @_;
 489         $str =~ s/'/'\\''/g;
 490         if ($quoted) {
 491                 $str =~ s/\\/\\\\/g;
 492                 $str =~ s/"/\\"/g;
 493         }
 494         return "'$str'";
 495 }