Dbus control module: * Implement (partially) the CapsChange signal * Refactor capabil...
[vlc.git] / modules / control / dbus.c
1 /*****************************************************************************
2  * dbus.c : D-Bus control interface
3  *****************************************************************************
4  * Copyright © 2006-2008 Rafaël Carré
5  * Copyright © 2007-2008 Mirsal Ennaime
6  * $Id$
7  *
8  * Authors:    Rafaël Carré <funman at videolanorg>
9  *             Mirsal Ennaime <mirsal dot ennaime at gmail dot com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /*
27  * D-Bus Specification:
28  *      http://dbus.freedesktop.org/doc/dbus-specification.html
29  * D-Bus low-level C API (libdbus)
30  *      http://dbus.freedesktop.org/doc/dbus/api/html/index.html
31  *  extract:
32  *   "If you use this low-level API directly, you're signing up for some pain."
33  *
34  * MPRIS Specification (still drafting on Jan, 23 of 2008):
35  *      http://wiki.xmms2.xmms.se/index.php/MPRIS
36  */
37
38 /*****************************************************************************
39  * Preamble
40  *****************************************************************************/
41
42 #include <dbus/dbus.h>
43
44 #include "dbus.h"
45
46 #ifdef HAVE_CONFIG_H
47 # include "config.h"
48 #endif
49
50 #include <vlc/vlc.h>
51 #include <vlc_aout.h>
52 #include <vlc_interface.h>
53 #include <vlc_meta.h>
54 #include <vlc_input.h>
55 #include <vlc_playlist.h>
56 #include <vlc_demux.h>
57 #include <vlc_access.h>
58
59 /*****************************************************************************
60  * Local prototypes.
61  *****************************************************************************/
62
63 static int  Open    ( vlc_object_t * );
64 static void Close   ( vlc_object_t * );
65 static void Run     ( intf_thread_t * );
66
67 static int StateChange( vlc_object_t *, const char *, vlc_value_t,
68                         vlc_value_t, void * );
69
70 static int TrackChange( vlc_object_t *, const char *, vlc_value_t,
71                         vlc_value_t, void * );
72
73 static int StatusChangeEmit( vlc_object_t *, const char *, vlc_value_t,
74                         vlc_value_t, void * );
75
76 static int TrackListChangeEmit( vlc_object_t *, const char *, vlc_value_t,
77                         vlc_value_t, void * );
78
79 static int GetInputMeta ( input_item_t *, DBusMessageIter * );
80 static int MarshalStatus ( intf_thread_t *, DBusMessageIter *, vlc_bool_t );
81 static int UpdateCaps( intf_thread_t* );
82
83 /* GetCaps() capabilities */
84 enum
85 {
86      CAPS_NONE                  = 0,
87      CAPS_CAN_GO_NEXT           = 1 << 0,
88      CAPS_CAN_GO_PREV           = 1 << 1,
89      CAPS_CAN_PAUSE             = 1 << 2,
90      CAPS_CAN_PLAY              = 1 << 3,
91      CAPS_CAN_SEEK              = 1 << 4,
92      CAPS_CAN_PROVIDE_METADATA  = 1 << 5
93 };
94
95 struct intf_sys_t
96 {
97     DBusConnection *p_conn;
98     vlc_bool_t      b_meta_read;
99     dbus_int32_t    i_caps;
100 };
101
102 /*****************************************************************************
103  * Module descriptor
104  *****************************************************************************/
105
106 vlc_module_begin();
107     set_shortname( _("dbus"));
108     set_category( CAT_INTERFACE );
109     set_subcategory( SUBCAT_INTERFACE_CONTROL );
110     set_description( _("D-Bus control interface") );
111     set_capability( "interface", 0 );
112     set_callbacks( Open, Close );
113 vlc_module_end();
114
115 /*****************************************************************************
116  * Methods
117  *****************************************************************************/
118
119 /* Player */
120
121 DBUS_METHOD( Quit )
122 { /* exits vlc */
123     REPLY_INIT;
124     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
125     playlist_Stop( p_playlist );
126     pl_Release( ((vlc_object_t*) p_this) );
127     vlc_object_kill(((vlc_object_t*)p_this)->p_libvlc);
128     REPLY_SEND;
129 }
130
131 DBUS_METHOD( PositionGet )
132 { /* returns position in milliseconds */
133     REPLY_INIT;
134     OUT_ARGUMENTS;
135     vlc_value_t position;
136     dbus_int32_t i_pos;
137
138     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
139     PL_LOCK;
140     input_thread_t *p_input = p_playlist->p_input;
141
142     if( !p_input )
143         i_pos = 0;
144     else
145     {
146         var_Get( p_input, "time", &position );
147         i_pos = position.i_time / 1000;
148     }
149     PL_UNLOCK;
150     pl_Release( ((vlc_object_t*) p_this) );
151     ADD_INT32( &i_pos );
152     REPLY_SEND;
153 }
154
155 DBUS_METHOD( PositionSet )
156 { /* set position in milliseconds */
157
158     REPLY_INIT;
159     vlc_value_t position;
160     playlist_t* p_playlist = NULL;
161     dbus_int32_t i_pos;
162
163     DBusError error;
164     dbus_error_init( &error );
165
166     dbus_message_get_args( p_from, &error,
167             DBUS_TYPE_INT32, &i_pos,
168             DBUS_TYPE_INVALID );
169
170     if( dbus_error_is_set( &error ) )
171     {
172         msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
173                 error.message );
174         dbus_error_free( &error );
175         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
176     }
177     p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
178     PL_LOCK;
179     input_thread_t *p_input = p_playlist->p_input;
180
181     if( p_input )
182     {
183         position.i_time = i_pos * 1000;
184         var_Set( p_input, "time", position );
185     }
186     PL_UNLOCK;
187     pl_Release( ((vlc_object_t*) p_this) );
188     REPLY_SEND;
189 }
190
191 DBUS_METHOD( VolumeGet )
192 { /* returns volume in percentage */
193     REPLY_INIT;
194     OUT_ARGUMENTS;
195     dbus_int32_t i_dbus_vol;
196     audio_volume_t i_vol;
197     /* 2nd argument of aout_VolumeGet is int32 */
198     aout_VolumeGet( (vlc_object_t*) p_this, &i_vol );
199     i_dbus_vol = ( 100 * i_vol ) / AOUT_VOLUME_MAX;
200     ADD_INT32( &i_dbus_vol );
201     REPLY_SEND;
202 }
203
204 DBUS_METHOD( VolumeSet )
205 { /* set volume in percentage */
206     REPLY_INIT;
207
208     DBusError error;
209     dbus_error_init( &error );
210
211     dbus_int32_t i_dbus_vol;
212     audio_volume_t i_vol;
213
214     dbus_message_get_args( p_from, &error,
215             DBUS_TYPE_INT32, &i_dbus_vol,
216             DBUS_TYPE_INVALID );
217
218     if( dbus_error_is_set( &error ) )
219     {
220         msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
221                 error.message );
222         dbus_error_free( &error );
223         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
224     }
225
226     i_vol = ( AOUT_VOLUME_MAX / 100 ) *i_dbus_vol;
227     aout_VolumeSet( (vlc_object_t*) p_this, i_vol );
228
229     REPLY_SEND;
230 }
231
232 DBUS_METHOD( Next )
233 { /* next playlist item */
234     REPLY_INIT;
235     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
236     playlist_Next( p_playlist );
237     pl_Release( ((vlc_object_t*) p_this) );
238     REPLY_SEND;
239 }
240
241 DBUS_METHOD( Prev )
242 { /* previous playlist item */
243     REPLY_INIT;
244     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
245     playlist_Prev( p_playlist );
246     pl_Release( ((vlc_object_t*) p_this) );
247     REPLY_SEND;
248 }
249
250 DBUS_METHOD( Stop )
251 { /* stop playing */
252     REPLY_INIT;
253     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
254     playlist_Stop( p_playlist );
255     pl_Release( ((vlc_object_t*) p_this) );
256     REPLY_SEND;
257 }
258
259 DBUS_METHOD( GetStatus )
260 { /* returns the current status as a struct of 4 ints */
261 /*
262     First   0 = Playing, 1 = Paused, 2 = Stopped.
263     Second  0 = Playing linearly , 1 = Playing randomly.
264     Third   0 = Go to the next element once the current has finished playing , 1 = Repeat the current element
265     Fourth  0 = Stop playing once the last element has been played, 1 = Never give up playing *
266  */
267     REPLY_INIT;
268     OUT_ARGUMENTS;
269
270     MarshalStatus( p_this, &args, VLC_TRUE );
271
272     REPLY_SEND;
273 }
274
275 DBUS_METHOD( Pause )
276 {
277     REPLY_INIT;
278     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
279     playlist_Pause( p_playlist );
280     pl_Release( p_playlist );
281     REPLY_SEND;
282 }
283
284 DBUS_METHOD( Play )
285 {
286     REPLY_INIT;
287     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
288     playlist_Play( p_playlist );
289     pl_Release( p_playlist );
290     REPLY_SEND;
291 }
292
293 DBUS_METHOD( GetCurrentMetadata )
294 {
295     REPLY_INIT;
296     OUT_ARGUMENTS;
297     playlist_t* p_playlist = pl_Yield( (vlc_object_t*) p_this );
298     PL_LOCK;
299     if( p_playlist->status.p_item )
300         GetInputMeta( p_playlist->status.p_item->p_input, &args );
301     PL_UNLOCK;
302     pl_Release( p_playlist );
303     REPLY_SEND;
304 }
305
306 DBUS_METHOD( GetCaps )
307 {
308     REPLY_INIT;
309     OUT_ARGUMENTS;
310
311     UpdateCaps( (intf_thread_t*)p_this );
312     ADD_INT32( &((intf_thread_t*)p_this)->p_sys->i_caps );
313
314     REPLY_SEND;
315 }
316
317 /* Media Player information */
318
319 DBUS_METHOD( Identity )
320 {
321     VLC_UNUSED(p_this);
322     REPLY_INIT;
323     OUT_ARGUMENTS;
324     char *psz_identity;
325     if( asprintf( &psz_identity, "%s %s", PACKAGE, VERSION ) != -1 )
326     {
327         ADD_STRING( &psz_identity );
328         free( psz_identity );
329     }
330     else
331         return DBUS_HANDLER_RESULT_NEED_MEMORY;
332
333     REPLY_SEND;
334 }
335
336 /* TrackList */
337
338 DBUS_METHOD( AddTrack )
339 { /* add the string to the playlist, and play it if the boolean is true */
340     REPLY_INIT;
341
342     DBusError error;
343     dbus_error_init( &error );
344     playlist_t* p_playlist = NULL;
345
346     char *psz_mrl;
347     dbus_bool_t b_play;
348
349     dbus_message_get_args( p_from, &error,
350             DBUS_TYPE_STRING, &psz_mrl,
351             DBUS_TYPE_BOOLEAN, &b_play,
352             DBUS_TYPE_INVALID );
353
354     if( dbus_error_is_set( &error ) )
355     {
356         msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
357                 error.message );
358         dbus_error_free( &error );
359         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
360     }
361
362     p_playlist = pl_Yield( (vlc_object_t*) p_this );
363     playlist_Add( p_playlist, psz_mrl, NULL, PLAYLIST_APPEND |
364             ( ( b_play == TRUE ) ? PLAYLIST_GO : 0 ) ,
365             PLAYLIST_END, VLC_TRUE, VLC_FALSE );
366     pl_Release( p_playlist );
367
368     REPLY_SEND;
369 }
370
371 DBUS_METHOD( GetCurrentTrack )
372 {
373     REPLY_INIT;
374     OUT_ARGUMENTS;
375
376     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
377     dbus_int32_t i_position = p_playlist->i_current_index;
378     pl_Release( p_playlist );
379
380     ADD_INT32( &i_position );
381     REPLY_SEND;
382 }
383
384 DBUS_METHOD( GetMetadata )
385 {
386     REPLY_INIT;
387     OUT_ARGUMENTS;
388     DBusError error;
389     dbus_error_init( &error );
390
391     dbus_int32_t i_position;
392
393     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
394     PL_LOCK;
395
396     dbus_message_get_args( p_from, &error,
397            DBUS_TYPE_INT32, &i_position,
398            DBUS_TYPE_INVALID );
399
400     if( dbus_error_is_set( &error ) )
401     {
402         PL_UNLOCK;
403         pl_Release( p_playlist );
404         msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
405                 error.message );
406         dbus_error_free( &error );
407         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
408     }
409
410     if( i_position <= p_playlist->items.i_size / 2 )
411     {
412         GetInputMeta( p_playlist->items.p_elems[i_position*2-1]->p_input, &args );
413     }
414
415     PL_UNLOCK;
416     pl_Release( p_playlist );
417     REPLY_SEND;
418 }
419
420 DBUS_METHOD( GetLength )
421 {
422     REPLY_INIT;
423     OUT_ARGUMENTS;
424
425     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
426     dbus_int32_t i_elements = p_playlist->items.i_size / 2;
427     pl_Release( p_playlist );
428
429     ADD_INT32( &i_elements );
430     REPLY_SEND;
431 }
432
433 DBUS_METHOD( DelTrack )
434 {
435     REPLY_INIT;
436
437     DBusError error;
438     dbus_error_init( &error );
439
440     dbus_int32_t i_position;
441     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
442
443     dbus_message_get_args( p_from, &error,
444             DBUS_TYPE_INT32, &i_position,
445             DBUS_TYPE_INVALID );
446
447     if( dbus_error_is_set( &error ) )
448     {
449         msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
450                 error.message );
451         dbus_error_free( &error );
452         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
453     }
454
455     if( i_position <= p_playlist->items.i_size / 2 )
456     {
457         playlist_DeleteFromInput( p_playlist,
458             p_playlist->items.p_elems[i_position*2-1]->i_id,
459             VLC_FALSE );
460     }
461
462     pl_Release( p_playlist );
463
464     REPLY_SEND;
465 }
466
467 DBUS_METHOD( Loop )
468 {
469     REPLY_INIT;
470     OUT_ARGUMENTS;
471
472     DBusError error;
473     dbus_bool_t b_loop;
474     vlc_value_t val;
475     playlist_t* p_playlist = NULL;
476
477     dbus_error_init( &error );
478     dbus_message_get_args( p_from, &error,
479             DBUS_TYPE_BOOLEAN, &b_loop,
480             DBUS_TYPE_INVALID );
481
482     if( dbus_error_is_set( &error ) )
483     {
484         msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
485                 error.message );
486         dbus_error_free( &error );
487         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
488     }
489
490     val.b_bool = ( b_loop == TRUE ) ? VLC_TRUE : VLC_FALSE ;
491     p_playlist = pl_Yield( (vlc_object_t*) p_this );
492     var_Set ( p_playlist, "loop", val );
493     pl_Release( ((vlc_object_t*) p_this) );
494
495     REPLY_SEND;
496 }
497
498 DBUS_METHOD( Repeat )
499 {
500     REPLY_INIT;
501     OUT_ARGUMENTS;
502
503     DBusError error;
504     dbus_bool_t b_repeat;
505     vlc_value_t val;
506     playlist_t* p_playlist = NULL;
507
508     dbus_error_init( &error );
509     dbus_message_get_args( p_from, &error,
510             DBUS_TYPE_BOOLEAN, &b_repeat,
511             DBUS_TYPE_INVALID );
512
513     if( dbus_error_is_set( &error ) )
514     {
515         msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
516                 error.message );
517         dbus_error_free( &error );
518         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
519     }
520
521     val.b_bool = ( b_repeat == TRUE ) ? VLC_TRUE : VLC_FALSE ;
522
523     p_playlist = pl_Yield( (vlc_object_t*) p_this );
524     var_Set ( p_playlist, "repeat", val );
525     pl_Release( ((vlc_object_t*) p_this) );
526
527     REPLY_SEND;
528 }
529
530 DBUS_METHOD( Random )
531 {
532     REPLY_INIT;
533     OUT_ARGUMENTS;
534
535     DBusError error;
536     dbus_bool_t b_random;
537     vlc_value_t val;
538     playlist_t* p_playlist = NULL;
539
540     dbus_error_init( &error );
541     dbus_message_get_args( p_from, &error,
542             DBUS_TYPE_BOOLEAN, &b_random,
543             DBUS_TYPE_INVALID );
544
545     if( dbus_error_is_set( &error ) )
546     {
547         msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
548                 error.message );
549         dbus_error_free( &error );
550         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
551     }
552
553     val.b_bool = ( b_random == TRUE ) ? VLC_TRUE : VLC_FALSE ;
554
555     p_playlist = pl_Yield( (vlc_object_t*) p_this );
556     var_Set ( p_playlist, "random", val );
557     pl_Release( ((vlc_object_t*) p_this) );
558
559     REPLY_SEND;
560 }
561 /*****************************************************************************
562  * Introspection method
563  *****************************************************************************/
564
565 DBUS_METHOD( handle_introspect_root )
566 { /* handles introspection of root object */
567     VLC_UNUSED(p_this);
568     REPLY_INIT;
569     OUT_ARGUMENTS;
570     ADD_STRING( &psz_introspection_xml_data_root );
571     REPLY_SEND;
572 }
573
574 DBUS_METHOD( handle_introspect_player )
575 {
576     VLC_UNUSED(p_this);
577     REPLY_INIT;
578     OUT_ARGUMENTS;
579     ADD_STRING( &psz_introspection_xml_data_player );
580     REPLY_SEND;
581 }
582
583 DBUS_METHOD( handle_introspect_tracklist )
584 {
585     VLC_UNUSED(p_this);
586     REPLY_INIT;
587     OUT_ARGUMENTS;
588     ADD_STRING( &psz_introspection_xml_data_tracklist );
589     REPLY_SEND;
590 }
591
592 /*****************************************************************************
593  * handle_*: answer to incoming messages
594  *****************************************************************************/
595
596 #define METHOD_FUNC( method, function ) \
597     else if( dbus_message_is_method_call( p_from, MPRIS_DBUS_INTERFACE, method ) )\
598         return function( p_conn, p_from, p_this )
599
600 DBUS_METHOD( handle_root )
601 {
602
603     if( dbus_message_is_method_call( p_from,
604                 DBUS_INTERFACE_INTROSPECTABLE, "Introspect" ) )
605         return handle_introspect_root( p_conn, p_from, p_this );
606
607     /* here D-Bus method's names are associated to an handler */
608
609     METHOD_FUNC( "Identity",                Identity );
610
611     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
612 }
613
614
615 DBUS_METHOD( handle_player )
616 {
617     if( dbus_message_is_method_call( p_from,
618                 DBUS_INTERFACE_INTROSPECTABLE, "Introspect" ) )
619         return handle_introspect_player( p_conn, p_from, p_this );
620
621     /* here D-Bus method's names are associated to an handler */
622
623     METHOD_FUNC( "Prev",                    Prev );
624     METHOD_FUNC( "Next",                    Next );
625     METHOD_FUNC( "Quit",                    Quit );
626     METHOD_FUNC( "Stop",                    Stop );
627     METHOD_FUNC( "Play",                    Play );
628     METHOD_FUNC( "Pause",                   Pause );
629     METHOD_FUNC( "Repeat",                  Repeat );
630     METHOD_FUNC( "VolumeSet",               VolumeSet );
631     METHOD_FUNC( "VolumeGet",               VolumeGet );
632     METHOD_FUNC( "PositionSet",             PositionSet );
633     METHOD_FUNC( "PositionGet",             PositionGet );
634     METHOD_FUNC( "GetStatus",               GetStatus );
635     METHOD_FUNC( "GetMetadata",             GetCurrentMetadata );
636     METHOD_FUNC( "GetCaps",                 GetCaps );
637
638     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
639 }
640
641 DBUS_METHOD( handle_tracklist )
642 {
643     if( dbus_message_is_method_call( p_from,
644                 DBUS_INTERFACE_INTROSPECTABLE, "Introspect" ) )
645     return handle_introspect_tracklist( p_conn, p_from, p_this );
646
647     /* here D-Bus method's names are associated to an handler */
648
649     METHOD_FUNC( "GetMetadata",             GetMetadata );
650     METHOD_FUNC( "GetCurrentTrack",         GetCurrentTrack );
651     METHOD_FUNC( "GetLength",               GetLength );
652     METHOD_FUNC( "AddTrack",                AddTrack );
653     METHOD_FUNC( "DelTrack",                DelTrack );
654     METHOD_FUNC( "Loop",                    Loop );
655     METHOD_FUNC( "Random",                  Random );
656
657     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
658 }
659
660 /*****************************************************************************
661  * Open: initialize interface
662  *****************************************************************************/
663
664 static int Open( vlc_object_t *p_this )
665 { /* initialisation of the connection */
666     intf_thread_t   *p_intf = (intf_thread_t*)p_this;
667     intf_sys_t      *p_sys  = malloc( sizeof( intf_sys_t ) );
668     playlist_t      *p_playlist;
669     DBusConnection  *p_conn;
670     DBusError       error;
671
672     if( !p_sys )
673         return VLC_ENOMEM;
674
675     p_sys->b_meta_read = VLC_FALSE;
676     p_sys->i_caps = CAPS_NONE;
677
678     dbus_error_init( &error );
679
680     /* connect to the session bus */
681     p_conn = dbus_bus_get( DBUS_BUS_SESSION, &error );
682     if( !p_conn )
683     {
684         msg_Err( p_this, "Failed to connect to the D-Bus session daemon: %s",
685                 error.message );
686         dbus_error_free( &error );
687         free( p_sys );
688         return VLC_EGENERIC;
689     }
690
691     /* register a well-known name on the bus */
692     dbus_bus_request_name( p_conn, VLC_MPRIS_DBUS_SERVICE, 0, &error );
693     if( dbus_error_is_set( &error ) )
694     {
695         msg_Err( p_this, "Error requesting service " VLC_MPRIS_DBUS_SERVICE
696                  ": %s", error.message );
697         dbus_error_free( &error );
698         free( p_sys );
699         return VLC_EGENERIC;
700     }
701
702     /* we register the objects */
703     dbus_connection_register_object_path( p_conn, MPRIS_DBUS_ROOT_PATH,
704             &vlc_dbus_root_vtable, p_this );
705     dbus_connection_register_object_path( p_conn, MPRIS_DBUS_PLAYER_PATH,
706             &vlc_dbus_player_vtable, p_this );
707     dbus_connection_register_object_path( p_conn, MPRIS_DBUS_TRACKLIST_PATH,
708             &vlc_dbus_tracklist_vtable, p_this );
709
710     dbus_connection_flush( p_conn );
711
712     p_playlist = pl_Yield( p_intf );
713     PL_LOCK;
714     var_AddCallback( p_playlist, "playlist-current", TrackChange, p_intf );
715     var_AddCallback( p_playlist, "intf-change", TrackListChangeEmit, p_intf );
716     var_AddCallback( p_playlist, "item-append", TrackListChangeEmit, p_intf );
717     var_AddCallback( p_playlist, "item-deleted", TrackListChangeEmit, p_intf );
718     var_AddCallback( p_playlist, "random", StatusChangeEmit, p_intf );
719     var_AddCallback( p_playlist, "repeat", StatusChangeEmit, p_intf );
720     var_AddCallback( p_playlist, "loop", StatusChangeEmit, p_intf );
721     PL_UNLOCK;
722     pl_Release( p_playlist );
723
724     p_intf->pf_run = Run;
725     p_intf->p_sys = p_sys;
726     p_sys->p_conn = p_conn;
727
728     UpdateCaps( p_intf );
729
730     return VLC_SUCCESS;
731 }
732
733 /*****************************************************************************
734  * Close: destroy interface
735  *****************************************************************************/
736
737 static void Close   ( vlc_object_t *p_this )
738 {
739     intf_thread_t   *p_intf     = (intf_thread_t*) p_this;
740     playlist_t      *p_playlist = pl_Yield( p_intf );;
741     input_thread_t  *p_input;
742
743     p_this->b_dead = VLC_TRUE;
744
745     PL_LOCK;
746     var_DelCallback( p_playlist, "playlist-current", TrackChange, p_intf );
747     var_DelCallback( p_playlist, "intf-change", TrackListChangeEmit, p_intf );
748     var_DelCallback( p_playlist, "item-append", TrackListChangeEmit, p_intf );
749     var_DelCallback( p_playlist, "item-deleted", TrackListChangeEmit, p_intf );
750     var_DelCallback( p_playlist, "random", StatusChangeEmit, p_intf );
751     var_DelCallback( p_playlist, "repeat", StatusChangeEmit, p_intf );
752     var_DelCallback( p_playlist, "loop", StatusChangeEmit, p_intf );
753
754     p_input = p_playlist->p_input;
755     if ( p_input )
756     {
757         vlc_object_yield( p_input );
758         var_DelCallback( p_input, "state", StateChange, p_intf );
759         vlc_object_release( p_input );
760     }
761
762     PL_UNLOCK;
763     pl_Release( p_playlist );
764
765     dbus_connection_unref( p_intf->p_sys->p_conn );
766
767     free( p_intf->p_sys );
768 }
769
770 /*****************************************************************************
771  * Run: main loop
772  *****************************************************************************/
773
774 static void Run          ( intf_thread_t *p_intf )
775 {
776     while( !intf_ShouldDie( p_intf ) )
777     {
778         msleep( INTF_IDLE_SLEEP );
779         dbus_connection_read_write_dispatch( p_intf->p_sys->p_conn, 0 );
780     }
781 }
782
783 /******************************************************************************
784  * CapsChange: player capabilities change signal
785  *****************************************************************************/
786 DBUS_SIGNAL( CapsChangeSignal )
787 {
788     SIGNAL_INIT( "CapsChange" );
789     OUT_ARGUMENTS;
790
791     ADD_INT32( &((intf_thread_t*)p_data)->p_sys->i_caps );
792     SIGNAL_SEND;
793 }
794
795 /******************************************************************************
796  * TrackListChange: tracklist order / length change signal 
797  *****************************************************************************/
798 DBUS_SIGNAL( TrackListChangeSignal )
799 { /* emit the new tracklist lengh */
800     SIGNAL_INIT("TrackListChange");
801     OUT_ARGUMENTS;
802
803     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_data );
804     dbus_int32_t i_elements = p_playlist->items.i_size / 2;
805     pl_Release( p_playlist );
806
807     ADD_INT32( &i_elements );
808     SIGNAL_SEND;
809 }
810
811 /*****************************************************************************
812  * TrackListChangeEmit: Emits the TrackListChange signal
813  *****************************************************************************/
814 /* FIXME: It is not called on tracklist reordering */
815 static int TrackListChangeEmit( vlc_object_t *p_this, const char *psz_var,
816             vlc_value_t oldval, vlc_value_t newval, void *p_data )
817 {
818     VLC_UNUSED(oldval);
819     intf_thread_t *p_intf = p_data;
820
821     if( !strcmp( psz_var, "item-append" ) || !strcmp( psz_var, "item-remove" ) )
822     {
823         /* don't signal when items are added/removed in p_category */
824         playlist_t *p_playlist = (playlist_t*)p_this;
825         playlist_add_t *p_add = newval.p_address;
826         playlist_item_t *p_item;
827         p_item = playlist_ItemGetById( p_playlist, p_add->i_node, VLC_TRUE );
828         assert( p_item );
829         while( p_item->p_parent )
830             p_item = p_item->p_parent;
831         if( p_item == p_playlist->p_root_category )
832             return VLC_SUCCESS;
833     }
834
835     if( p_intf->b_dead )
836         return VLC_SUCCESS;
837
838     /* We're called from the playlist, so that would cause locking issues */
839     /* UpdateCaps( p_intf ); */
840     TrackListChangeSignal( p_intf->p_sys->p_conn, p_data );
841     return VLC_SUCCESS;
842 }
843 /*****************************************************************************
844  * TrackChange: Playlist item change callback
845  *****************************************************************************/
846
847 DBUS_SIGNAL( TrackChangeSignal )
848 { /* emit the metadata of the new item */
849     SIGNAL_INIT( "TrackChange" );
850     OUT_ARGUMENTS;
851
852     input_item_t *p_item = (input_item_t*) p_data;
853     GetInputMeta ( p_item, &args );
854
855     SIGNAL_SEND;
856 }
857
858 /*****************************************************************************
859  * StatusChange: Player status change signal
860  *****************************************************************************/
861
862 DBUS_SIGNAL( StatusChangeSignal )
863 { /* send the updated status info on the bus */
864     SIGNAL_INIT( "StatusChange" );
865     OUT_ARGUMENTS;
866
867     /* we're called from a callback of input_thread_t, so it can not be
868      * destroyed before we return */
869     MarshalStatus( (intf_thread_t*) p_data, &args, VLC_FALSE );
870
871     SIGNAL_SEND;
872 }
873
874 /*****************************************************************************
875  * StateChange: callback on input "state"
876  *****************************************************************************/
877 static int StateChange( vlc_object_t *p_this, const char* psz_var,
878             vlc_value_t oldval, vlc_value_t newval, void *p_data )
879 {
880     VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
881     intf_thread_t       *p_intf     = ( intf_thread_t* ) p_data;
882     intf_sys_t          *p_sys      = p_intf->p_sys;
883
884     if( p_intf->b_dead )
885         return VLC_SUCCESS;
886
887     if( !p_sys->b_meta_read && newval.i_int == PLAYING_S )
888     {
889         input_item_t *p_item = input_GetItem( (input_thread_t*)p_this );
890         if( p_item )
891         {
892             p_sys->b_meta_read = VLC_TRUE;
893             TrackChangeSignal( p_sys->p_conn, p_item );
894         }
895     }
896
897     if( newval.i_int == PLAYING_S || newval.i_int == PAUSE_S ||
898         newval.i_int == END_S )
899     {
900         StatusChangeSignal( p_sys->p_conn, (void*) p_intf );
901     }
902
903
904     return VLC_SUCCESS;
905 }
906
907 /*****************************************************************************
908  * StatusChangeEmit: Emits the StatusChange signal
909  *****************************************************************************/
910 static int StatusChangeEmit( vlc_object_t *p_this, const char *psz_var,
911             vlc_value_t oldval, vlc_value_t newval, void *p_data )
912 {
913     VLC_UNUSED(p_this); VLC_UNUSED(psz_var);
914     VLC_UNUSED(oldval); VLC_UNUSED(newval);
915     intf_thread_t *p_intf = p_data;
916
917     if( p_intf->b_dead )
918         return VLC_SUCCESS;
919
920     UpdateCaps( p_intf );
921     StatusChangeSignal( p_intf->p_sys->p_conn, p_data );
922     return VLC_SUCCESS;
923 }
924
925 /*****************************************************************************
926  * TrackChange: callback on playlist "playlist-current"
927  *****************************************************************************/
928 static int TrackChange( vlc_object_t *p_this, const char *psz_var,
929             vlc_value_t oldval, vlc_value_t newval, void *p_data )
930 {
931     intf_thread_t       *p_intf     = ( intf_thread_t* ) p_data;
932     intf_sys_t          *p_sys      = p_intf->p_sys;
933     playlist_t          *p_playlist;
934     input_thread_t      *p_input    = NULL;
935     input_item_t        *p_item     = NULL;
936     VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
937     VLC_UNUSED( oldval ); VLC_UNUSED( newval );
938
939     if( p_intf->b_dead )
940         return VLC_SUCCESS;
941
942     p_sys->b_meta_read = VLC_FALSE;
943
944     p_playlist = pl_Yield( p_intf );
945     PL_LOCK;
946     p_input = p_playlist->p_input;
947
948     if( !p_input )
949     {
950         PL_UNLOCK;
951         pl_Release( p_playlist );
952         return VLC_SUCCESS;
953     }
954
955     vlc_object_yield( p_input );
956     PL_UNLOCK;
957     pl_Release( p_playlist );
958
959     p_item = input_GetItem( p_input );
960     if( !p_item )
961     {
962         vlc_object_release( p_input );
963         return VLC_EGENERIC;
964     }
965
966     if( input_item_IsPreparsed( p_item ) )
967     {
968         p_sys->b_meta_read = VLC_TRUE;
969         TrackChangeSignal( p_sys->p_conn, p_item );
970     }
971
972     UpdateCaps( p_intf );
973
974     var_AddCallback( p_input, "state", StateChange, p_intf );
975
976     vlc_object_release( p_input );
977     return VLC_SUCCESS;
978 }
979
980 /*****************************************************************************
981  * UpdateCaps: update p_sys->i_caps
982  ****************************************************************************/
983 static int UpdateCaps( intf_thread_t* p_intf )
984 {
985     dbus_int32_t i_caps = CAPS_NONE;
986     playlist_t* p_playlist = pl_Yield( (vlc_object_t*)p_intf );
987     PL_LOCK;
988     
989     if( p_playlist->items.i_size > 0 )
990         i_caps |= CAPS_CAN_PLAY | CAPS_CAN_GO_PREV | CAPS_CAN_GO_NEXT;
991
992     if( p_playlist->p_input )
993     {
994         access_t *p_access = (access_t*)vlc_object_find( p_playlist->p_input,
995             VLC_OBJECT_ACCESS, FIND_CHILD );
996         if( p_access )
997         {
998             vlc_bool_t b_can_pause;
999             if( !access2_Control( p_access, ACCESS_CAN_PAUSE, &b_can_pause ) &&
1000                     b_can_pause )
1001                 i_caps |= CAPS_CAN_PAUSE;
1002             vlc_object_release( p_access );
1003         }
1004         demux_t *p_demux = (demux_t*)vlc_object_find( p_playlist->p_input,
1005             VLC_OBJECT_DEMUX, FIND_CHILD );
1006         if( p_demux )
1007         {   /* XXX: is: demux can seek and access can not a possibility ? */
1008             vlc_bool_t b_can_seek;
1009             if( !stream_Control( p_demux->s, STREAM_CAN_SEEK, &b_can_seek ) &&
1010                     b_can_seek )
1011                 i_caps |= CAPS_CAN_SEEK;
1012             vlc_object_release( p_demux );
1013         }
1014     }
1015
1016     PL_UNLOCK;
1017     pl_Release( p_playlist );
1018
1019     if( p_intf->p_sys->b_meta_read )
1020         i_caps |= CAPS_CAN_PROVIDE_METADATA;
1021
1022     if( i_caps != p_intf->p_sys->i_caps )
1023     {
1024         p_intf->p_sys->i_caps = i_caps;
1025         CapsChangeSignal( p_intf->p_sys->p_conn, (vlc_object_t*)p_intf );
1026     }
1027
1028     return VLC_SUCCESS;
1029 }
1030
1031 /*****************************************************************************
1032  * GetInputMeta: Fill a DBusMessage with the given input item metadata
1033  *****************************************************************************/
1034
1035 #define ADD_META( entry, type, data ) \
1036     if( data ) { \
1037         dbus_message_iter_open_container( &dict, DBUS_TYPE_DICT_ENTRY, \
1038                 NULL, &dict_entry ); \
1039         dbus_message_iter_append_basic( &dict_entry, DBUS_TYPE_STRING, \
1040                 &ppsz_meta_items[entry] ); \
1041         dbus_message_iter_open_container( &dict_entry, DBUS_TYPE_VARIANT, \
1042                 type##_AS_STRING, &variant ); \
1043         dbus_message_iter_append_basic( &variant, \
1044                 type, \
1045                 & data ); \
1046         dbus_message_iter_close_container( &dict_entry, &variant ); \
1047         dbus_message_iter_close_container( &dict, &dict_entry ); }
1048
1049 #define ADD_VLC_META_STRING( entry, item ) \
1050     { \
1051         char * psz = input_item_Get##item( p_input );\
1052         ADD_META( entry, DBUS_TYPE_STRING, \
1053                   psz ); \
1054         free( psz ); \
1055     }
1056
1057 static int GetInputMeta( input_item_t* p_input,
1058                         DBusMessageIter *args )
1059 {
1060     DBusMessageIter dict, dict_entry, variant;
1061     /* We need the track length to be expressed in milli-seconds
1062      * instead of µ-seconds */
1063     dbus_int64_t i_length = ( input_item_GetDuration( p_input ) / 1000 );
1064
1065     const char* ppsz_meta_items[] =
1066     {
1067     "title", "artist", "genre", "copyright", "album", "tracknum",
1068     "description", "rating", "date", "setting", "url", "language",
1069     "nowplaying", "publisher", "encodedby", "arturl", "trackid",
1070     "status", "URI", "length", "video-codec", "audio-codec",
1071     "video-bitrate", "audio-bitrate", "audio-samplerate"
1072     };
1073
1074     dbus_message_iter_open_container( args, DBUS_TYPE_ARRAY, "{sv}", &dict );
1075
1076     ADD_VLC_META_STRING( 0,  Title );
1077     ADD_VLC_META_STRING( 1,  Artist );
1078     ADD_VLC_META_STRING( 2,  Genre );
1079     ADD_VLC_META_STRING( 3,  Copyright );
1080     ADD_VLC_META_STRING( 4,  Album );
1081     ADD_VLC_META_STRING( 5,  TrackNum );
1082     ADD_VLC_META_STRING( 6,  Description );
1083     ADD_VLC_META_STRING( 7,  Rating );
1084     ADD_VLC_META_STRING( 8,  Date );
1085     ADD_VLC_META_STRING( 9,  Setting );
1086     ADD_VLC_META_STRING( 10, URL );
1087     ADD_VLC_META_STRING( 11, Language );
1088     ADD_VLC_META_STRING( 12, NowPlaying );
1089     ADD_VLC_META_STRING( 13, Publisher );
1090     ADD_VLC_META_STRING( 14, EncodedBy );
1091     ADD_VLC_META_STRING( 15, ArtURL );
1092     ADD_VLC_META_STRING( 16, TrackID );
1093
1094     vlc_mutex_lock( &p_input->lock );
1095     if( p_input->p_meta )
1096         ADD_META( 17, DBUS_TYPE_INT32, p_input->p_meta->i_status );
1097     vlc_mutex_unlock( &p_input->lock );
1098
1099     ADD_VLC_META_STRING( 18, URI );
1100     ADD_META( 19, DBUS_TYPE_INT64, i_length );
1101
1102     dbus_message_iter_close_container( args, &dict );
1103     return VLC_SUCCESS;
1104 }
1105
1106 #undef ADD_META
1107 #undef ADD_VLC_META_STRING
1108
1109 /*****************************************************************************
1110  * MarshalStatus: Fill a DBusMessage with the current player status
1111  *****************************************************************************/
1112
1113 static int MarshalStatus( intf_thread_t* p_intf, DBusMessageIter* args,
1114                           vlc_bool_t lock )
1115 { /* This is NOT the right way to do that, it would be better to sore
1116      the status information in p_sys and update it on change, thus
1117      avoiding a long lock */
1118
1119     DBusMessageIter status;
1120     dbus_int32_t i_state, i_random, i_repeat, i_loop;
1121     vlc_value_t val;
1122     playlist_t* p_playlist = NULL;
1123     input_thread_t* p_input = NULL;
1124
1125     p_playlist = pl_Yield( (vlc_object_t*) p_intf );
1126     if( lock )
1127         PL_LOCK;
1128
1129     i_state = 2;
1130
1131     p_input = p_playlist->p_input;
1132     if( p_input )
1133     {
1134         var_Get( p_input, "state", &val );
1135         if( val.i_int >= END_S )
1136             i_state = 2;
1137         else if( val.i_int == PAUSE_S )
1138             i_state = 1;
1139         else if( val.i_int <= PLAYING_S )
1140             i_state = 0;
1141     }
1142
1143     var_Get( p_playlist, "random", &val );
1144     i_random = val.i_int;
1145
1146     var_Get( p_playlist, "repeat", &val );
1147     i_repeat = val.i_int;
1148
1149     var_Get( p_playlist, "loop", &val );
1150     i_loop = val.i_int;
1151
1152     if( lock )
1153         PL_UNLOCK;
1154     pl_Release( p_playlist );
1155
1156     dbus_message_iter_open_container( args, DBUS_TYPE_STRUCT, NULL, &status );
1157     dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_state );
1158     dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_random );
1159     dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_repeat );
1160     dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_loop );
1161     dbus_message_iter_close_container( args, &status );
1162
1163     return VLC_SUCCESS;
1164 }