75e62058e6ca2efc03a6cb7c4705136e27374c3c
[vlc.git] / extras / mpris.py
1 #!/usr/bin/python
2 # -*- coding: utf8 -*-
3 #
4 # Copyright © 2006-2007 Rafaël Carré <funman at videolanorg>
5 #
6 # $Id$
7
8 #  This program is free software; you can redistribute it and/or modify
9 #  it under the terms of the GNU General Public License as published by
10 #  the Free Software Foundation; either version 2 of the License, or
11 #  (at your option) any later version.
12
13 #  This program is distributed in the hope that it will be useful,
14 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
15 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 #  GNU General Public License for more details.
17
18 #  You should have received a copy of the GNU General Public License
19 #  along with this program; if not, write to the Free Software
20 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 #
22
23 #
24 # NOTE: This controller is a SAMPLE, and thus doesn't use all the
25 # Media Player Remote Interface Specification (MPRIS for short) capabilities
26 #
27 # MPRIS:  http://wiki.xmms2.xmms.se/index.php/Media_Player_Interfaces
28 #
29 # You'll need pygtk >= 2.10 to use gtk.StatusIcon
30 #
31 # TODO
32 #   Ability to choose the Media Player if several are connected to the bus
33
34 # core dbus stuff
35 import dbus
36 import dbus.glib
37
38 # core interface stuff
39 import gtk
40 import gtk.glade
41
42 # timer
43 import gobject
44
45 # file loading
46 import os
47
48 global win_position # store the window position on the screen
49
50 global playing
51 playing = False
52
53 global shuffle      # playlist will play randomly
54 global repeat       # repeat the playlist
55 global loop         # loop the current element
56
57 # mpris doesn't support getting the status of these (at the moment)
58 shuffle = False
59 repeat = False
60 loop = False
61
62 # these are defined on the mpris detected unique name
63 global root         # / org.freedesktop.MediaPlayer
64 global player       # /Player org.freedesktop.MediaPlayer
65 global tracklist    # /Tracklist org.freedesktop.MediaPlayer
66
67 global bus          # Connection to the session bus
68 global identity     # MediaPlayer Identity
69
70
71 # If a Media Player connects to the bus, we'll use it
72 # Note that we forget the previous Media Player we were connected to
73 def NameOwnerChanged(name, new, old):
74     if old != "" and "org.mpris." in name:
75         Connect(name)
76
77 # Callback for when "TrackChange" signal is emitted
78 def TrackChange(Track):
79     # the only mandatory metadata is "URI"
80     try:
81         a = Track["artist"]
82     except:
83         a = ""
84     try:
85         t = Track["title"]
86     except:
87         t = Track["URI"]
88     # update the labels
89     l_artist.set_text(a)
90     l_title.set_text(t)
91
92 # Connects to the Media Player we detected
93 def Connect(name):
94     global root, player, tracklist
95     global playing, identity
96
97     # first we connect to the objects
98     root_o = bus.get_object(name, "/")
99     player_o = bus.get_object(name, "/Player")
100     tracklist_o = bus.get_object(name, "/TrackList")
101
102     # there is only 1 interface per object
103     root = dbus.Interface(root_o, "org.freedesktop.MediaPlayer")
104     tracklist  = dbus.Interface(tracklist_o, "org.freedesktop.MediaPlayer")
105     player = dbus.Interface(player_o, "org.freedesktop.MediaPlayer")
106
107     # connect to the TrackChange signal
108     player_o.connect_to_signal("TrackChange", TrackChange, dbus_interface="org.freedesktop.MediaPlayer")
109
110     # determine if the Media Player is playing something
111     if player.GetStatus() == 0:
112         playing = True
113
114     # gets its identity (name and version)
115     identity = root.Identity()
116     window.set_title(identity)
117
118 #plays an element
119 def AddTrack(widget):
120     mrl = e_mrl.get_text()
121     if mrl != None and mrl != "":
122         tracklist.AddTrack(mrl, True)
123         e_mrl.set_text('')
124     else:
125         mrl = bt_file.get_filename()
126         if mrl != None and mrl != "":
127             tracklist.AddTrack("directory://" + mrl, True)
128     update(0)
129
130 # basic control
131
132 def Next(widget):
133     player.Next(reply_handler=(lambda *args: None), error_handler=(lambda *args: None))
134     update(0)
135
136 def Prev(widget):
137     player.Prev(reply_handler=(lambda *args: None), error_handler=(lambda *args: None))
138     update(0)
139
140 def Stop(widget):
141     player.Stop(reply_handler=(lambda *args: None), error_handler=(lambda *args: None))
142     update(0)
143
144 def Quit(widget):
145     player.Quit(reply_handler=(lambda *args: None), error_handler=(lambda *args: None))
146     l_title.set_text("")
147
148 def Pause(widget):
149     player.Pause()
150     status = player.GetStatus()
151     if status == 0:
152         img_bt_toggle.set_from_stock(gtk.STOCK_MEDIA_PAUSE, gtk.ICON_SIZE_SMALL_TOOLBAR)
153     else:
154         img_bt_toggle.set_from_stock(gtk.STOCK_MEDIA_PLAY, gtk.ICON_SIZE_SMALL_TOOLBAR)
155     update(0)
156
157 def Repeat(widget):
158     global repeat
159     repeat = not repeat
160     player.Repeat(repeat)
161
162 def Shuffle(widget):
163     global shuffle
164     shuffle = not shuffle
165     tracklist.Random(shuffle)
166
167 def Loop(widget):
168     global loop
169     loop = not loop
170     tracklist.Loop(loop)
171
172 # update status display
173 def update(widget):
174     item = tracklist.GetMetadata(tracklist.GetCurrentTrack())
175     vol.set_value(player.VolumeGet())
176     try: 
177         a = item["artist"]
178     except:        a = ""
179     try:
180         t = item["title"]
181     except:        t = ""
182     if t == "":
183         try:
184             t = item["URI"]
185         except:
186             t = ""
187     l_artist.set_text(a)
188     l_title.set_text(t)
189     GetPlayStatus(0)
190
191 # callback for volume change
192 def volchange(widget, data):
193     player.VolumeSet(vol.get_value_as_int(), reply_handler=(lambda *args: None), error_handler=(lambda *args: None))
194
195 # callback for position change
196 def timechange(widget, x=None, y=None):
197     player.PositionSet(int(time_s.get_value()), reply_handler=(lambda *args: None), error_handler=(lambda *args: None))
198
199 # refresh position change
200 def timeset():
201     global playing
202     if playing == True:
203         time_s.set_value(player.PositionGet())
204     return True
205
206 # toggle simple/full display
207 def expander(widget):
208     if exp.get_expanded() == False:
209         exp.set_label("Less")
210     else:
211         exp.set_label("More")
212
213 # close event : hide in the systray
214 def delete_event(self, widget):
215     self.hide()
216     return True
217
218 # shouldn't happen
219 def destroy(widget):
220     gtk.main_quit()
221
222 # hide the controller when 'Esc' is pressed
223 def key_release(widget, event):
224     if event.keyval == gtk.keysyms.Escape:
225         global win_position
226         win_position = window.get_position()
227         widget.hide()
228
229 # callback for click on the tray icon
230 def tray_button(widget):
231     global win_position
232     if window.get_property('visible'):
233         # store position
234         win_position = window.get_position()
235         window.hide()
236     else:
237         # restore position
238         window.move(win_position[0], win_position[1])
239         window.show()
240
241 # hack: update position, volume, and metadata
242 def icon_clicked(widget, event):
243     update(0)
244
245 # get playing status, modify the Play/Pause button accordingly
246 def GetPlayStatus(widget):
247     global playing
248     status = player.GetStatus()
249     if status == 0:
250         img_bt_toggle.set_from_stock("gtk-media-pause", gtk.ICON_SIZE_SMALL_TOOLBAR)
251         playing = True
252     else:
253         img_bt_toggle.set_from_stock("gtk-media-play", gtk.ICON_SIZE_SMALL_TOOLBAR)
254         playing = False
255
256 # loads glade file from the directory where the script is,
257 # so we can use /path/to/mpris.py to execute it.
258 import sys
259 xml = gtk.glade.XML(os.path.dirname(sys.argv[0]) + '/mpris.glade')
260
261 # ui setup
262 bt_close    = xml.get_widget('close')
263 bt_quit     = xml.get_widget('quit')
264 bt_file     = xml.get_widget('ChooseFile')
265 bt_next     = xml.get_widget('next')
266 bt_prev     = xml.get_widget('prev')
267 bt_stop     = xml.get_widget('stop')
268 bt_toggle   = xml.get_widget('toggle')
269 bt_mrl      = xml.get_widget('AddMRL')
270 bt_shuffle  = xml.get_widget('shuffle')
271 bt_repeat   = xml.get_widget('repeat')
272 bt_loop     = xml.get_widget('loop')
273 l_artist    = xml.get_widget('l_artist')
274 l_title     = xml.get_widget('l_title')
275 e_mrl       = xml.get_widget('mrl')
276 window      = xml.get_widget('window1')
277 img_bt_toggle=xml.get_widget('image6')
278 exp         = xml.get_widget('expander2')
279 expvbox     = xml.get_widget('expandvbox')
280 audioicon   = xml.get_widget('eventicon')
281 vol         = xml.get_widget('vol')
282 time_s      = xml.get_widget('time_s')
283 time_l      = xml.get_widget('time_l')
284
285 # connect to the different callbacks
286
287 window.connect('delete_event',  delete_event)
288 window.connect('destroy',       destroy)
289 window.connect('key_release_event', key_release)
290
291 tray = gtk.status_icon_new_from_icon_name("audio-x-generic")
292 tray.connect('activate', tray_button)
293
294 bt_close.connect('clicked',     destroy)
295 bt_quit.connect('clicked',      Quit)
296 bt_mrl.connect('clicked',       AddTrack)
297 bt_toggle.connect('clicked',    Pause)
298 bt_next.connect('clicked',      Next)
299 bt_prev.connect('clicked',      Prev)
300 bt_stop.connect('clicked',      Stop)
301 bt_loop.connect('clicked',      Loop)
302 bt_repeat.connect('clicked',    Repeat)
303 bt_shuffle.connect('clicked',   Shuffle)
304 exp.connect('activate',         expander)
305 vol.connect('change-value',     volchange)
306 vol.connect('scroll-event',     volchange)
307 time_s.connect('adjust-bounds', timechange)
308 audioicon.set_events(gtk.gdk.BUTTON_PRESS_MASK) # hack for the bottom right icon
309 audioicon.connect('button_press_event', icon_clicked) 
310 time_s.set_update_policy(gtk.UPDATE_DISCONTINUOUS)
311
312 library = "/media/mp3" # editme
313
314 # set the Directory chooser to a default location
315 try:
316     os.chdir(library)
317     bt_file.set_current_folder(library)
318 except:
319     bt_file.set_current_folder(os.path.expanduser("~"))
320
321 # connect to the bus
322 bus = dbus.SessionBus()
323 dbus_names = bus.get_object( "org.freedesktop.DBus", "/org/freedesktop/DBus" )
324 dbus_names.connect_to_signal("NameOwnerChanged", NameOwnerChanged, dbus_interface="org.freedesktop.DBus") # to detect new Media Players
325
326 dbus_o = bus.get_object("org.freedesktop.DBus", "/")
327 dbus_intf = dbus.Interface(dbus_o, "org.freedesktop.DBus")
328 name_list = dbus_intf.ListNames()
329
330 # connect to the first Media Player found
331 for n in name_list:
332     if "org.mpris." in n:
333         Connect(n)
334         window.set_title(identity)
335         vol.set_value(player.VolumeGet())
336         update(0)
337         break
338
339 # run a timer to update position
340 gobject.timeout_add( 1000, timeset)
341
342 window.set_icon_name('audio-x-generic')
343 window.show()
344
345 icon_theme = gtk.icon_theme_get_default()
346 try:
347     pix = icon_theme.load_icon("audio-x-generic",24,0)
348     window.set_icon(pix)
349 except:
350     True
351
352 win_position = window.get_position()
353
354 gtk.main() # execute the main loop