Initial support of one instance mode on systems running D-Bus
[vlc.git] / modules / control / dbus.c
1 /*****************************************************************************
2  * dbus.c : D-Bus control interface
3  *****************************************************************************
4  * Copyright (C) 2006 Rafaël Carré
5  * $Id$
6  *
7  * Author:    Rafaël Carré <funman at videolanorg>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*
25  * D-Bus Specification: 
26  *      http://dbus.freedesktop.org/doc/dbus-specification.html
27  * D-Bus low-level C API (libdbus)
28  *      http://dbus.freedesktop.org/doc/dbus/api/html/index.html
29  */
30
31 /*
32  * TODO:
33  *  properties ?
34  *
35  *  macros to read incoming arguments
36  *
37  *  explore different possible types (arrays..)
38  *
39  *  what must we do if org.videolan.vlc already exist on the bus ?
40  *  ( there is more than one vlc instance )
41  */
42
43 /*****************************************************************************
44  * Preamble
45  *****************************************************************************/
46
47 #include <dbus/dbus.h>
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <string.h>
51
52 #include <sys/types.h> /* getpid() */
53 #include <unistd.h> /* getpid() */
54
55 #include "dbus.h"
56
57 #include <vlc/vlc.h>
58 #include <vlc/intf.h>
59 #include <vlc_meta.h>
60 #include <vlc_input.h>
61
62 /*****************************************************************************
63  * Local prototypes.
64  *****************************************************************************/
65
66 static int  Open    ( vlc_object_t * );
67 static void Close   ( vlc_object_t * );
68 static void Run        ( intf_thread_t * );
69
70
71 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
72                     vlc_value_t oldval, vlc_value_t newval, void *p_data );
73
74 struct intf_sys_t
75 {
76     DBusConnection *p_conn;
77 };
78
79 /*****************************************************************************
80  * Module descriptor
81  *****************************************************************************/
82
83 vlc_module_begin();
84     set_shortname( _("dbus"));
85     set_category( CAT_INTERFACE );
86     set_subcategory( SUBCAT_INTERFACE_CONTROL );
87     set_description( _("D-Bus control interface") );
88     set_capability( "interface", 0 );
89     set_callbacks( Open, Close );
90 vlc_module_end();
91
92 /*****************************************************************************
93  * Methods
94  *****************************************************************************/
95
96 DBUS_METHOD( Nothing )
97 { /* do nothing */
98     REPLY_INIT;
99     REPLY_SEND;
100 }
101
102 DBUS_METHOD( Quit )
103 { /* exits vlc */
104     REPLY_INIT;
105     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
106     playlist_Stop( p_playlist );
107     pl_Release( ((vlc_object_t*) p_this) );
108     ((vlc_object_t*)p_this)->p_libvlc->b_die = VLC_TRUE;
109     REPLY_SEND;
110 }
111
112 DBUS_METHOD( Next )
113 { /* next playlist item */
114     REPLY_INIT;
115     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
116     playlist_Next( p_playlist );
117     pl_Release( ((vlc_object_t*) p_this) );
118     REPLY_SEND;
119 }
120
121 DBUS_METHOD( Prev )
122 { /* previous playlist item */
123     REPLY_INIT;
124     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
125     playlist_Prev( p_playlist );
126     pl_Release( ((vlc_object_t*) p_this) );
127     REPLY_SEND;
128 }
129
130 DBUS_METHOD( Stop )
131 { /* stop playing */
132     REPLY_INIT;
133     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
134     playlist_Stop( p_playlist );
135     pl_Release( ((vlc_object_t*) p_this) );
136     REPLY_SEND;
137 }
138
139 DBUS_METHOD( GetPlayingItem )
140 { /* return the current item */
141     REPLY_INIT;
142     OUT_ARGUMENTS;
143     char psz_no_input = '\0';
144     char *p_psz_no_input = &psz_no_input;
145     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
146     input_thread_t *p_input = p_playlist->p_input;
147     ADD_STRING( ( p_input ) ? &p_input->input.p_item->psz_name : &p_psz_no_input );
148     pl_Release( ((vlc_object_t*) p_this) );
149     REPLY_SEND;
150 }
151
152 DBUS_METHOD( GetPlayStatus )
153 { /* return a string */
154     REPLY_INIT;
155     OUT_ARGUMENTS;
156
157     char *psz_play;
158     vlc_value_t val;
159     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
160     PL_LOCK;
161     input_thread_t *p_input = p_playlist->p_input;
162
163     if( !p_input )
164         psz_play = strdup( "stopped" );
165     else
166     {
167         var_Get( p_input, "state", &val );
168         if( val.i_int == PAUSE_S )
169             psz_play = strdup( "pause" );
170         else if( val.i_int == PLAYING_S )
171             psz_play = strdup( "playing" );
172         else psz_play = strdup( "unknown" );
173     }
174     
175     PL_UNLOCK;
176     pl_Release( p_playlist );
177
178     ADD_STRING( &psz_play );
179     free( psz_play );
180     REPLY_SEND;
181 }
182
183 DBUS_METHOD( TogglePause )
184 { /* return a bool: true if playing */
185     REPLY_INIT;
186     OUT_ARGUMENTS;
187
188     vlc_value_t val;
189     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
190     input_thread_t *p_input = p_playlist->p_input;
191     if( p_input != NULL )
192     {
193         var_Get( p_input, "state", &val );
194         if( val.i_int != PAUSE_S )
195         {
196             val.i_int = PAUSE_S;
197             playlist_Pause( p_playlist );
198         }
199         else
200         {
201             val.i_int = PLAYING_S;
202             playlist_Play( p_playlist );
203         }
204     }
205     else
206     {
207         val.i_int = PLAYING_S;
208         playlist_Play( p_playlist );
209     }
210     pl_Release( p_playlist );
211
212     dbus_bool_t pause = ( val.i_int == PLAYING_S ) ? TRUE : FALSE;
213     ADD_BOOL( &pause );
214     REPLY_SEND;
215 }
216
217 DBUS_SIGNAL( NewInstance )
218 { /* emits a signal with vlc pid */
219     SIGNAL_INIT( "NewInstance" );
220     OUT_ARGUMENTS;
221     dbus_uint32_t i_pid = (dbus_uint32_t) getpid();
222     ADD_UINT32( &i_pid );
223     SIGNAL_SEND;
224 }
225
226 DBUS_METHOD( AddMRL )
227 { /* add the string to the playlist, and play it if the boolean is true */
228     REPLY_INIT;
229
230     DBusError error;
231     dbus_error_init( &error );
232
233     intf_thread_t *p_intf = (intf_thread_t*) p_this;
234     char *psz_mrl;
235     dbus_bool_t b_play;
236
237     dbus_message_get_args( p_from, &error,
238             DBUS_TYPE_STRING, &psz_mrl,
239             DBUS_TYPE_BOOLEAN, &b_play,
240             DBUS_TYPE_INVALID );
241
242     if( dbus_error_is_set( &error ) )
243     {
244         printf("error: %s\n", error.message );
245         dbus_error_free( &error );
246         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
247     }
248
249     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
250     input_item_t *p_item = input_ItemNew( p_intf, psz_mrl, NULL );
251     if( p_item )
252     {
253         playlist_AddInput( p_playlist, p_item,
254             PLAYLIST_APPEND | ( ( b_play == TRUE ) ? PLAYLIST_GO : 0 ) ,
255             PLAYLIST_END, VLC_TRUE );
256     }
257     pl_Release( p_playlist );
258
259     REPLY_SEND;
260 }
261
262 /*****************************************************************************
263  * Introspection method
264  *****************************************************************************/
265
266 DBUS_METHOD( handle_introspect )
267 { /* handles introspection of /org/videolan/vlc */
268     REPLY_INIT;
269     OUT_ARGUMENTS;
270     ADD_STRING( &psz_introspection_xml_data );
271     REPLY_SEND;
272 }
273
274 /*****************************************************************************
275  * handle_messages: answer to incoming messages
276  *****************************************************************************/
277
278 #define METHOD_FUNC( method, function ) \
279     else if( dbus_message_is_method_call( p_from, VLC_DBUS_INTERFACE, method ) )\
280         return function( p_conn, p_from, p_this )
281
282 DBUS_METHOD( handle_messages )
283 { /* the main handler, that call methods */
284
285     if( dbus_message_is_method_call( p_from,
286                 DBUS_INTERFACE_INTROSPECTABLE, "Introspect" ) )
287         return handle_introspect( p_conn, p_from, p_this );
288
289     /* here D-Bus method's names are associated to an handler */
290
291     METHOD_FUNC( "GetPlayStatus",   GetPlayStatus );
292     METHOD_FUNC( "GetPlayingItem",  GetPlayingItem );
293     METHOD_FUNC( "AddMRL",          AddMRL );
294     METHOD_FUNC( "TogglePause",     TogglePause );
295     METHOD_FUNC( "Nothing",         Nothing );
296     METHOD_FUNC( "Prev",            Prev );
297     METHOD_FUNC( "Next",            Next );
298     METHOD_FUNC( "Quit",            Quit );
299     METHOD_FUNC( "Stop",            Stop );
300
301     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
302 }
303
304 /*****************************************************************************
305  * Open: initialize interface
306  *****************************************************************************/
307
308 static int Open( vlc_object_t *p_this )
309 { /* initialisation of the connection */
310     intf_thread_t   *p_intf = (intf_thread_t*)p_this;
311     intf_sys_t      *p_sys  = malloc( sizeof( intf_sys_t ) );
312     playlist_t      *p_playlist;
313     DBusConnection  *p_conn;
314     DBusError       error;
315
316     if( !p_sys )
317         return VLC_ENOMEM;
318
319     dbus_threads_init_default();
320     
321     dbus_error_init( &error );
322     
323     /* connect to the session bus */
324     p_conn = dbus_bus_get( DBUS_BUS_SESSION, &error );
325     if( !p_conn )
326     {
327         msg_Err( p_this, "Failed to connect to the D-Bus session daemon: %s",
328                 error.message );
329         dbus_error_free( &error );
330         free( p_sys );
331         return VLC_EGENERIC;
332     }
333
334     /* we unregister the object /, registered by libvlc */
335     dbus_connection_unregister_object_path( p_conn, "/" );
336
337     /* we register the object /org/videolan/vlc */
338     dbus_connection_register_object_path( p_conn, VLC_DBUS_OBJECT_PATH,
339             &vlc_dbus_vtable, p_this );
340
341     dbus_connection_flush( p_conn );
342
343     p_playlist = pl_Yield( p_intf );
344     PL_LOCK;
345     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
346     PL_UNLOCK;
347     pl_Release( p_playlist );
348
349     p_intf->pf_run = Run;
350     p_intf->p_sys = p_sys;
351     p_sys->p_conn = p_conn;
352
353     return VLC_SUCCESS;
354 }
355
356 /*****************************************************************************
357  * Close: destroy interface
358  *****************************************************************************/
359
360 static void Close   ( vlc_object_t *p_this )
361 {
362     intf_thread_t   *p_intf     = (intf_thread_t*) p_this;
363     playlist_t      *p_playlist = pl_Yield( p_intf );;
364
365     PL_LOCK;
366     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
367     PL_UNLOCK;
368     pl_Release( p_playlist );
369
370     free( p_intf->p_sys );
371 }
372
373 /*****************************************************************************
374  * Run: main loop    
375  *****************************************************************************/
376
377 static void Run          ( intf_thread_t *p_intf )
378 {
379     NewInstance( p_intf->p_sys->p_conn, NULL );
380
381     while( !p_intf->b_die )
382     {
383         msleep( INTF_IDLE_SLEEP );
384         dbus_connection_read_write_dispatch( p_intf->p_sys->p_conn, 0 );
385     }
386 }
387
388 /*****************************************************************************
389  * ItemChange: Playlist item change callback
390  *****************************************************************************/
391
392 DBUS_SIGNAL( ItemChangeSignal )
393 { /* emit the name of the new item */
394     SIGNAL_INIT( "ItemChange" );
395     OUT_ARGUMENTS;
396
397     input_thread_t *p_input = (input_thread_t*) p_data;
398     ADD_STRING( &p_input->input.p_item->psz_name );
399
400     SIGNAL_SEND;
401 }
402
403 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
404             vlc_value_t oldval, vlc_value_t newval, void *p_data )
405 {
406     intf_thread_t       *p_intf     = ( intf_thread_t* ) p_data;
407     intf_sys_t          *p_sys      = p_intf->p_sys;
408     playlist_t          *p_playlist;
409     input_thread_t      *p_input    = NULL;
410     (void)p_this; (void)psz_var; (void)oldval; (void)newval;
411
412     p_playlist = pl_Yield( p_intf );
413     PL_LOCK;
414     p_input = p_playlist->p_input;
415
416     if( !p_input )
417     {
418         PL_UNLOCK;
419         pl_Release( p_playlist );
420         return VLC_SUCCESS;
421     }
422
423     vlc_object_yield( p_input );
424     PL_UNLOCK;
425     pl_Release( p_playlist );
426
427     ItemChangeSignal( p_sys->p_conn, p_input );
428
429     vlc_object_release( p_input );
430     return VLC_SUCCESS;
431 }
432