lib/App/XMMS2/Notifier.pm

   1 package App::XMMS2::Notifier;
   2 use 5.014000;
   3 use strict;
   4 use warnings;
   5 our $VERSION = 0.001002;
   6
   7 use Audio::XMMSClient 0.03;
   8 use Gtk2::Notify 0.05 -init,'xmms2-notifyd';
   9
  10 use constant CONVERSION_SPECIFIERS => qw/bitrate date sample_format url id channels samplerate tracknr genre artist album title/;
  11
  12 ##################################################
  13
  14 my $format;
  15 my $xmms = Audio::XMMSClient->new('xmms2-notifyd');
  16 my $notify = Gtk2::Notify->new('');
  17
  18 $notify->set_timeout(3000);
  19
  20 ##################################################
  21
  22 sub notify_libnotify{
  23         $notify->update($_[0]);
  24         $notify->show;
  25 }
  26
  27 sub notify{
  28         my ($id, $minfo);
  29         eval {
  30                 $id=$xmms->playback_current_id->wait->value or return;
  31                 $minfo=$xmms->medialib_get_info($id)->wait->value;
  32         } or return;
  33
  34         my %metadata = map { $_ => exists $minfo->{$_} ? (values %{$minfo->{$_}})[0] : undef } CONVERSION_SPECIFIERS;
  35         my $str=$format;
  36         $str =~ s/\$$_/$metadata{$_}/gs for keys %metadata;
  37
  38         notify_libnotify $str
  39 }
  40
  41 sub on_playback_current_id {
  42         notify;
  43         $xmms->broadcast_playback_current_id->notifier_set(\&on_playback_current_id);
  44 }
  45
  46 sub on_playback_status {
  47         notify if $xmms->playback_status->wait->value == 1; # 1 means playing, 2 means paused
  48         $xmms->broadcast_playback_status->notifier_set(\&on_playback_status);
  49 }
  50
  51 sub run {
  52         $format = $_[0];
  53         while (1) {
  54                 last if ($xmms->connect);
  55                 sleep 1
  56         }
  57
  58         $xmms->broadcast_playback_current_id->notifier_set(\&on_playback_current_id);
  59         $xmms->broadcast_playback_status->notifier_set(\&on_playback_status);
  60         $xmms->loop
  61 }
  62
  63 1;
  64 __END__
  65
  66 =head1 NAME
  67
  68 App::XMMS2::Notifier - script which notifies you what xmms2 is playing
  69
  70 =head1 SYNOPSIS
  71
  72   # Shows libnotify notifications e.g. "Silence - Cellule"
  73   xmms2-notifier
  74
  75   # Shows libnotify notifications e.g. "Cellule by Silence (L'autre endroit), year 2005, genre Electro"
  76   xmms2-notifier --format="$title by $artist ($album), year $date, genre $genre"
  77
  78 =head1 DESCRIPTION
  79
  80 xmms2-notifier is a script which shows libnotify notifications when
  81 the song is changed and when the playback is started/resumed.
  82
  83 You can control the notification format with the B<--format> argument.
  84 The following strings are replaced:
  85
  86 =over
  87
  88 =item $bitrate
  89
  90 The song bitrate, in bits/s. Example: 785104
  91
  92 =item $date
  93
  94 Usually the year the song was published. Example: 2005
  95
  96 =item $sample_format
  97
  98 The format of each sample. Example: S16
  99
 100 =item $url
 101
 102 An URL that points to the song. Example: file:///ext/Music/Silence+-+Cellule.flac
 103
 104 =item $id
 105
 106 The XMMS2 id of the song. Example: 498
 107
 108 =item $channels
 109
 110 The number of channels the song has. Example: 2
 111
 112 =item $samplerate
 113
 114 The sample rate of the song, in Hz. Example: 44100
 115
 116 =item $tracknr
 117
 118 The track number in the album. Example: 1
 119
 120 =item $genre
 121
 122 The genre of the song. Example: Electro
 123
 124 =item $artist
 125
 126 The artist/band. Example: Silence
 127
 128 =item $album
 129
 130 The album the song is from. Example: L'autre endroit
 131
 132 =item $title
 133
 134 The song title. Example: Cellule
 135
 136 =back
 137
 138 =head1 SEE ALSO
 139
 140 L<xmms2(1)>
 141
 142 =head1 AUTHOR
 143
 144 Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
 145
 146 =head1 COPYRIGHT AND LICENSE
 147
 148 Copyright (C) 2013-2016 by Marius Gavrilescu
 149
 150 This library is free software; you can redistribute it and/or modify
 151 it under the same terms as Perl itself, either Perl version 5.14.2 or,
 152 at your option, any later version of Perl 5 you may have available.
 153
 154
 155 =cut