-
Notifications
You must be signed in to change notification settings - Fork 42
/
mpris2.pm
404 lines (349 loc) · 13.9 KB
/
mpris2.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# Copyright (C) 2011 Quentin Sculo <squentin@free.fr>
#
# This file is part of Gmusicbrowser.
# Gmusicbrowser is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3, as
# published by the Free Software Foundation
=for gmbplugin MPRIS2
name MPRIS v2
title MPRIS v2 support
desc Allows controlling gmusicbrowser via DBus using the MPRIS v2.0 standard
req perl(Net::DBus, libnet-dbus-perl perl-Net-DBus)
=cut
package GMB::Plugin::MPRIS2;
use strict;
use warnings;
use constant
{ OPT => 'PLUGIN_MPRIS2_',
};
use Net::DBus::Annotation 'dbus_call_async';
my $bus=$GMB::DBus::bus;
die "Requires DBus support to be active\n" unless $bus; #only requires this to use the hack in gmusicbrowser_dbus.pm so that Net::DBus::GLib is not required, else could do just : use Net::DBus::GLib; $bus=Net::DBus::GLib->session;
my @Objects;
sub Start
{ my $service= $bus->export_service('org.mpris.MediaPlayer2.gmusicbrowser');
push @Objects, GMB::DBus::MPRIS2->new($service);
}
sub Stop
{ ::UnWatch_all($_) for @Objects;
$_->disconnect for @Objects;
@Objects=();
}
sub prefbox
{ my $vbox=Gtk2::VBox->new(0,2);
my $blacklist= Gtk2::CheckButton->new(_"Show in sound menu");
soundmenu_button_update($blacklist);
$blacklist->signal_connect(toggled => \&soundmenu_toggle_cb);
$vbox->pack_start($blacklist,0,0,0);
return $vbox;
}
sub soundmenu_button_update
{ my $check=shift;
eval
{ my $service = $bus->get_service('com.canonical.indicators.sound');
my $object = $service->get_object('/com/canonical/indicators/sound/service');
my $asyncreply=$object->IsBlacklisted(dbus_call_async,'gmusicbrowser'); #called async, because it seems to trigger the calling of gmb DBus methods before replying
$check->{busy}=1;
$asyncreply->set_notify(sub { soundmenu_button_set($check, eval {$_[0]->get_result;}) });
};
soundmenu_button_set($check,undef) unless $check->{busy};
}
sub soundmenu_button_set
{ my ($check,$on)=@_;
$check->set_active(1) if !$on;
if (!defined $on)
{ $check->set_sensitive(0);
$check->set_tooltip_text(_"No sound menu found");
}
delete $check->{busy};
}
sub soundmenu_toggle_cb
{ my $check=shift;
return if $check->{busy};
my $on=$check->get_active;
eval
{ my $service = $bus->get_service('com.canonical.indicators.sound');
my $object = $service->get_object('/com/canonical/indicators/sound/service');
$object->BlacklistMediaPlayer('gmusicbrowser',!$on);
};
soundmenu_button_update($check);
}
package GMB::DBus::MPRIS2;
use base 'Net::DBus::Object';
use Net::DBus::Exporter 'org.mpris.MediaPlayer2';
use Net::DBus ':typing';
our %PropChanged;
# events watched by properties of org.mpris.MediaPlayer2.Player that send PropertiesChanged signal
# the functions associated with these properties must bless the return value with dbus_string() and friends
my %PropertiesWatch=
( PlaybackStatus => 'Playing',
LoopStatus => 'Lock Repeat',
Shuffle => 'Sort',
Metadata => 'CurSong',
Volume => 'Vol',
CanGoNext => 'Playlist Sort Queue Repeat',
CanGoPrevious => 'CurSongID',
CanPlay => 'CurSongID',
#CanSeek => 'CurSongID', # always true currently => no need to watch event
);
sub new
{ my ($class,$service) = @_;
my $self = $class->SUPER::new($service, '/org/mpris/MediaPlayer2');
bless $self, $class;
::Watch($self, Seek => \&Seeked);
::Watch($self, FullScreen=> sub { $self->emit_signal( PropertiesChanged => 'org.mpris.MediaPlayer2', {Fullscreen=> Fullscreen()} ,[] ); });
#watchers for properties of org.mpris.MediaPlayer2.Player that send PropertiesChanged signal
my %events;
for my $prop (sort keys %PropertiesWatch)
{ push @{ $events{$_} }, $prop for split / /, $PropertiesWatch{$prop};
}
for my $event (keys %events)
{ my $props= $events{$event};
::Watch($self, $event =>
sub { my $self=shift;
$PropChanged{$_}=1 for @$props;
::IdleDo('2_MPRIS2_propchanged', 500, \&PropertiesChanged, $self);
});
}
return $self;
}
dbus_signal(PropertiesChanged => ['string',['dict','string',['variant']],['array','string']], 'org.freedesktop.DBus.Properties');
sub PropertiesChanged
{ my $self=shift;
my %changed;
for my $name (keys %PropChanged)
{ no strict "refs";
$changed{$name}= $name->();
}
%PropChanged=();
$self->emit_signal( PropertiesChanged => 'org.mpris.MediaPlayer2.Player', \%changed,[] );
}
dbus_method('Raise', [], [],{no_return=>1});
sub Raise
{ ::ShowHide(1);
}
dbus_method('Quit', [], [],{no_return=>1});
sub Quit
{ ::Quit();
}
dbus_property('Fullscreen', 'bool', 'readwrite');
sub Fullscreen
{ if (defined $_[1]) { ::SetFullScreenMode($_[1]); }
else { return dbus_boolean(!!$::FullscreenWindow) }
}
dbus_property('CanSetFullscreen', 'bool', 'read');
sub CanSetFullscreen {dbus_boolean(1)}
dbus_property('CanQuit', 'bool', 'read');
sub CanQuit {dbus_boolean(1)}
dbus_property('CanRaise', 'bool', 'read');
sub CanRaise {dbus_boolean(1)}
dbus_property('HasTrackList', 'bool', 'read');
sub HasTrackList {dbus_boolean(0)}
dbus_property('Identity', 'string', 'read');
sub Identity { 'gmusicbrowser' }
dbus_property('DesktopEntry', 'string', 'read');
sub DesktopEntry { 'gmusicbrowser' }
dbus_property('SupportedUriSchemes', ['array','string'], 'read');
sub SupportedUriSchemes { return ['file']; }
dbus_property('SupportedMimeTypes', ['array','string'], 'read');
sub SupportedMimeTypes { return [qw(application/ogg audio/flac audio/mpeg audio/ogg audio/x-flac audio/x-m4a audio/x-musepack)]; } #FIXME
dbus_method('Next', [], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub Next { ::NextSong(); }
dbus_method('Previous', [], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub Previous { ::PrevSong(); }
dbus_method('Pause', [], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub Pause { ::Pause(); }
dbus_method('PlayPause',[], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub PlayPause { ::PlayPause(); }
dbus_method('Stop', [], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub Stop { ::Stop(); }
dbus_method('Play', [], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub Play { ::Play(); }
dbus_method('Seek', ['int64'], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub Seek
{ my $offset= $_[1]/1_000_000; #convert from microseconds
my $sec= $::PlayTime || 0;
return unless defined $::SongID;
if ($offset>0)
{ $sec+=$offset;
my $length= Songs::Get($::SongID,'length');
if ($sec>$length) { ::NextSong(); }
else { ::SkipTo($sec) }
}
elsif ($offset<0)
{ $sec+=$offset;
if ($sec<0) { ::PrevSong(); }
else { ::SkipTo($sec) }
}
}
dbus_method('SetPosition', ['objectpath','int64'], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub SetPosition
{ my (undef,$ID,$position)= (@_);
return unless $ID=~m#^/Song/(\d+)$#;
$ID=$1;
return unless defined $::SongID && $ID==$::SongID;
$position/=1_000_000;
my $length= Songs::Get($::SongID,'length');
return if $length<0 || $position>$length;
::SkipTo($position);
}
dbus_method('OpenUri', ['string'], [], 'org.mpris.MediaPlayer2.Player', {no_return=>1});
sub OpenUri
{ my $uri=$_[1];
my $IDs= ::Uris_to_IDs($uri);
my $ID= $IDs->[0];
::Select(song => $ID, play=>1) if defined $ID;
}
dbus_signal(Seeked => ['int64'], 'org.mpris.MediaPlayer2.Player');
sub Seeked
{ $_[0]->emit_signal( Seeked => $_[1]*1_000_000 );
}
dbus_property('PlaybackStatus', 'string', 'read', 'org.mpris.MediaPlayer2.Player');
sub PlaybackStatus
{ my $status= $::TogPlay ? 'Playing' : defined $::TogPlay ? 'Paused' : 'Stopped';
return dbus_string($status);
}
dbus_property('LoopStatus', 'string', 'readwrite', 'org.mpris.MediaPlayer2.Player');
sub LoopStatus
{ if (defined $_[1])
{ my $m=$_[1];
my $notrack;
if ($m eq 'None') { ::SetRepeat(0); $notrack=1; }
elsif ($m eq 'Track') { ::SetRepeat(1); ::ToggleLock('fullfilename',1); }
elsif ($m eq 'Playlist'){ ::SetRepeat(1); $notrack=1; }
if ($notrack && $::TogLock && $::TogLock eq 'fullfilename') { ::ToggleLock('fullfilename') }
}
else
{ my $r= !$::Options{Repeat} ? 'None' :
($::TogLock && $::TogLock eq 'fullfilename') ? 'Track' : 'Playlist';
return dbus_string($r);
}
}
dbus_property('Rate', 'double', 'readwrite', 'org.mpris.MediaPlayer2.Player');
sub Rate {dbus_double(1)}
dbus_property('MinimumRate', 'double', 'read', 'org.mpris.MediaPlayer2.Player');
sub MinimumRate {dbus_double(1)}
dbus_property('MaximumRate', 'double', 'read', 'org.mpris.MediaPlayer2.Player');
sub MaximumRate {dbus_double(1)}
dbus_property('Shuffle', 'bool', 'readwrite', 'org.mpris.MediaPlayer2.Player');
sub Shuffle
{ my $on= ($::RandomMode || $::Options{Sort}=~m/shuffle/) ? 1 : 0;
return dbus_boolean($on) if !defined $_[1];
::ToggleSort() if $_[1] xor $on;
}
dbus_property('Metadata', ['dict','string',['variant']], 'read', 'org.mpris.MediaPlayer2.Player');
sub Metadata
{ GetMetadata_from($::SongID);
}
dbus_property('Volume', 'double', 'readwrite', 'org.mpris.MediaPlayer2.Player');
sub Volume
{ if (defined $_[1]) { my $v=$_[1]; $v=0 if $v<0; ::ChangeVol(100*$v); }
else { return dbus_double($::Volume/100); }
}
dbus_property('Position', 'int64', 'read', 'org.mpris.MediaPlayer2.Player');
sub Position
{ return dbus_int64( ($::PlayTime||0) *1_000_000 );
}
dbus_property('CanGoNext', 'bool', 'read', 'org.mpris.MediaPlayer2.Player');
sub CanGoNext
{ return dbus_boolean(1) if !defined $::Position && @$::ListPlay;
return dbus_boolean(1) if @$::Queue;
return dbus_boolean(0) unless @$::ListPlay>1;
return dbus_boolean(0) if !$::Options{Repeat} && $::Position==$#$::ListPlay;
return dbus_boolean(1);
}
dbus_property('CanGoPrevious', 'bool', 'read', 'org.mpris.MediaPlayer2.Player');
sub CanGoPrevious
{ return dbus_boolean( @$::Recent > ($::RecentPos||0) );
}
dbus_property('CanPlay', 'bool', 'read', 'org.mpris.MediaPlayer2.Player');
sub CanPlay
{ return dbus_boolean( defined $::SongID );
}
dbus_property('CanPause', 'bool', 'read', 'org.mpris.MediaPlayer2.Player');
sub CanPause
{ return dbus_boolean( defined $::SongID );
}
dbus_property('CanSeek', 'bool', 'read', 'org.mpris.MediaPlayer2.Player');
sub CanSeek
{ return dbus_boolean( defined $::SongID ); #will need to check if stream when supported
}
dbus_property('CanControl', 'bool', 'read', 'org.mpris.MediaPlayer2.Player');
sub CanControl {dbus_boolean(1)}
# 'org.mpris.MediaPlayer2.Player','Metadata'
sub GetMetadata_from
{ my $ID=shift;
# Net::DBus support for properties is incomplete, the following use undocumented functions to force it to use the correct data types for the returned values
my $type=
[ &Net::DBus::Binding::Message::TYPE_DICT_ENTRY,
[ &Net::DBus::Binding::Message::TYPE_STRING,
[ &Net::DBus::Binding::Message::TYPE_VARIANT,
[],
]]];
#my ($type)= Net::DBus::Binding::Introspector->_convert(['dict','string',['variant']]); #works too, not sure which one is best
return Net::DBus::Binding::Value->new($type,{}) unless defined $ID;
my %h;
$h{$_}=Songs::Get($ID,$_) for qw/title album artist comment length track disc year album_artist uri album_picture rating bitrate samprate genre playcount/, grep Songs::FieldEnabled($_), qw/composer lyricist bpm/;
my %r= #return values
( 'mpris:length' => dbus_int64($h{'length'}*1_000_000),
'mpris:trackid' => dbus_object_path("/Song/$ID"), #FIXME should contain a string that uniquely identifies the track within the scope of the playlist
'xesam:album' => dbus_string($h{album}),
'xesam:albumArtist' => dbus_array([ $h{album_artist} ]),
'xesam:artist' => dbus_array([ $h{artist} ]),
'xesam:comment' => ( $h{comment} ne '' ? dbus_array([$h{comment}]) : undef ),
'xesam:contentCreated' => ($h{year} ? dbus_string($h{year}) : undef), # ."-01-01T00:00Z" ?
'xesam:discNumber' => ($h{disc} ? dbus_int32($h{disc}) : undef),
'xesam:genre', => dbus_array([split /\x00/, $h{genre}]),
'xesam:lastUsed', => ($h{lastplay} ? dbus_string( ::strftime("%FT%RZ",gmtime($h{lastplay})) ) : undef),
'xesam:title', => dbus_string( $h{title} ),
'xesam:trackNumber' => ( $h{track} ? dbus_int32($h{track}) : undef),
'xesam:url' => dbus_string( $h{uri} ),
'xesam:useCount' => dbus_int32($h{playcount}),
'xesam:audioBPM' => ($h{bpm} ? dbus_int32($h{bpm}) : undef),
'xesam:composer' => ($h{composer}||'' ne '' ? dbus_array([ $h{composer} ]) : undef),
'xesam:lyricist', => ($h{lyricist}||'' ne '' ? dbus_array([ $h{lyricist} ]) : undef),
);
my $rating=$h{rating};
if (defined $rating && length $rating) { $r{'xesam:userRating'}=dbus_double($rating/100); }
if (my $pic= $h{album_picture}) #FIXME use ~album.picture.uri when available
{ $r{'mpris:artUrl'}= dbus_string( 'file://'.::url_escape($pic) ) if $pic=~m/\.(?:jpe?g|png|gif)$/i; # ignore embedded pictures
}
delete $r{$_} for grep !defined $r{$_}, keys %r;
return Net::DBus::Binding::Value->new($type,\%r);
}
### patched version of Net::DBus::Object::_dispatch_all_prop_read v1.0.0 to support properties of different types
### Net::DBus::Object::_dispatch_all_prop_read was added in Net::DBus v1.0.0 to support the org.freedesktop.DBus.Properties.GetAll method
no warnings 'redefine';
sub Net::DBus::Object::_dispatch_all_prop_read {
my $self = shift;
my $connection = shift;
my $message = shift;
my $ins = $self->_introspector;
if (!$ins) {
return $connection->make_error_message($message,
"org.freedesktop.DBus.Error.Failed",
"no introspection data exported for properties");
}
my ($pinterface) = $ins->decode($message, "methods", "Get", "params");
my %values = ();
foreach my $pname ($ins->list_properties($pinterface)) {
unless ($ins->is_property_readable($pinterface, $pname)) {
next; # skip write-only properties
}
$values{$pname} = eval {
$self->$pname;
};
if ($@) {
return $connection->make_error_message($message,
"org.freedesktop.DBus.Error.Failed",
"error reading '$pname' in interface '$pinterface': $@");
}
}
my $reply = $connection->make_method_return_message($message);
### patch : fix method name, which fix return type
$self->_introspector->encode($reply, "methods", "GetAll", "returns", \%values);
### $self->_introspector->encode($reply, "methods", "Get", "returns", \%values);
### end of patch
return $reply;
}
1;