]> git.sesse.net Git - vlc/blobdiff - modules/control/dbus.c
Removes trailing spaces. Removes tabs.
[vlc] / modules / control / dbus.c
index ab3bdbd3f5292c05917e9d992945955f8bf12676..5f15b4dfcd096779fc087f4bab7449d06c114316 100644 (file)
@@ -4,7 +4,8 @@
  * Copyright (C) 2006 Rafaël Carré
  * $Id$
  *
- * Author:    Rafaël Carré <funman at videolanorg>
+ * Authors:    Rafaël Carré <funman at videolanorg>
+ *             Mirsal Ennaime <mirsal dot ennaime at gmail dot com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *      http://dbus.freedesktop.org/doc/dbus-specification.html
  * D-Bus low-level C API (libdbus)
  *      http://dbus.freedesktop.org/doc/dbus/api/html/index.html
- */
-
-/*
- * TODO:
- *  properties ?
- *
- *  macros to read incoming arguments
- *
- *  explore different possible types (arrays..)
- *
- *  what must we do if org.videolan.vlc already exist on the bus ?
- *  ( there is more than one vlc instance )
+ *  extract:
+    "If you use this low-level API directly, you're signing up for some pain."
+ * MPRIS Specification (still drafting on June, 25 of 2007):
+ *      http://wiki.xmms2.xmms.se/index.php/Media_Player_Interfaces
  */
 
 /*****************************************************************************
@@ -45,9 +38,6 @@
  *****************************************************************************/
 
 #include <dbus/dbus.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
 
 #include "dbus.h"
 
 #include <vlc_input.h>
 #include <vlc_playlist.h>
 
-
 /*****************************************************************************
  * Local prototypes.
  *****************************************************************************/
 
 static int  Open    ( vlc_object_t * );
 static void Close   ( vlc_object_t * );
-static void Run        ( intf_thread_t * );
-
+static void Run     ( intf_thread_t * );
 
 static int TrackChange( vlc_object_t *p_this, const char *psz_var,
                     vlc_value_t oldval, vlc_value_t newval, void *p_data );
 
+static int GetInputMeta ( input_item_t *p_input,
+                    DBusMessageIter *args);
+
 struct intf_sys_t
 {
     DBusConnection *p_conn;
@@ -105,7 +96,7 @@ DBUS_METHOD( PlaylistExport_XSPF )
     REPLY_INIT;
     OUT_ARGUMENTS;
 
-    DBusError error; 
+    DBusError error;
     dbus_error_init( &error );
 
     char *psz_file;
@@ -153,7 +144,7 @@ DBUS_METHOD( Quit )
     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
     playlist_Stop( p_playlist );
     pl_Release( ((vlc_object_t*) p_this) );
-    ((vlc_object_t*)p_this)->p_libvlc->b_die = VLC_TRUE;
+    vlc_object_kill(((vlc_object_t*)p_this)->p_libvlc);
     REPLY_SEND;
 }
 
@@ -174,8 +165,8 @@ DBUS_METHOD( PositionGet )
         var_Get( p_input, "position", &position );
         i_pos = position.f_float * 1000 ;
     }
-    ADD_INT32( &i_pos );
     pl_Release( ((vlc_object_t*) p_this) );
+    ADD_INT32( &i_pos );
     REPLY_SEND;
 }
 
@@ -184,6 +175,7 @@ DBUS_METHOD( PositionSet )
 
     REPLY_INIT;
     vlc_value_t position;
+    playlist_t* p_playlist = NULL;
     dbus_int32_t i_pos;
 
     DBusError error;
@@ -200,7 +192,7 @@ DBUS_METHOD( PositionSet )
         dbus_error_free( &error );
         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
     }
-    playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
+    p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
     input_thread_t *p_input = p_playlist->p_input;
 
     if( p_input )
@@ -325,13 +317,41 @@ DBUS_METHOD( Play )
     REPLY_SEND;
 }
 
+DBUS_METHOD( Disconnect )
+{
+    REPLY_INIT;
+    DBusError error;
+    int i;
+    dbus_error_init( &error );
+    i = dbus_bus_release_name( p_conn, VLC_MPRIS_DBUS_SERVICE, &error );
+    if( ( i == -1 ) && ( dbus_error_is_set( &error ) ) )
+    {
+        msg_Err( (vlc_object_t*) p_this, "D-Bus disconnection failed : %s\n",
+            error.message );
+        dbus_error_free( &error );
+    }
+    REPLY_SEND;
+}
+
+DBUS_METHOD( GetCurrentMetadata )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+    playlist_t* p_playlist = pl_Yield( (vlc_object_t*) p_this );
+
+    GetInputMeta( p_playlist->status.p_item->p_input, &args );
+
+    pl_Release( p_playlist );
+    REPLY_SEND;
+}
+
 /* Media Player information */
 
 DBUS_METHOD( Identity )
 {
     REPLY_INIT;
     OUT_ARGUMENTS;
-    char *psz_identity = malloc( strlen( PACKAGE ) + strlen( VERSION ) + 1 );
+    char *psz_identity = malloc( strlen( PACKAGE ) + strlen( VERSION ) + 2 );
     sprintf( psz_identity, "%s %s", PACKAGE, VERSION );
     ADD_STRING( &psz_identity );
     free( psz_identity );
@@ -346,6 +366,7 @@ DBUS_METHOD( AddTrack )
 
     DBusError error;
     dbus_error_init( &error );
+    playlist_t* p_playlist = NULL;
 
     char *psz_mrl;
     dbus_bool_t b_play;
@@ -363,9 +384,10 @@ DBUS_METHOD( AddTrack )
         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
     }
 
-    playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
+    p_playlist = pl_Yield( (vlc_object_t*) p_this );
     playlist_Add( p_playlist, psz_mrl, NULL, PLAYLIST_APPEND |
-            ( ( b_play == TRUE ) ? PLAYLIST_GO : 0 ) , PLAYLIST_END, VLC_TRUE );
+            ( ( b_play == TRUE ) ? PLAYLIST_GO : 0 ) ,
+            PLAYLIST_END, VLC_TRUE, VLC_FALSE );
     pl_Release( p_playlist );
 
     REPLY_SEND;
@@ -378,15 +400,12 @@ DBUS_METHOD( GetCurrentTrack )
     dbus_int32_t i_position = 0;
     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
     playlist_item_t* p_tested_item = p_playlist->p_root_onelevel;
-    
-    while ( p_tested_item->i_id != p_playlist->status.p_item->i_id )
+
+    while ( p_tested_item->p_input->i_id !=
+                    p_playlist->status.p_item->p_input->i_id )
     {
         i_position++;
-        p_tested_item = playlist_GetNextLeaf( p_playlist, 
-                        p_playlist->p_root_onelevel, 
-                        p_tested_item,
-                        VLC_FALSE,
-                        VLC_FALSE );
+        TEST_NEXT;
     }
 
     pl_Release( p_playlist );
@@ -396,13 +415,16 @@ DBUS_METHOD( GetCurrentTrack )
 }
 
 DBUS_METHOD( GetMetadata )
-{ //TODO reads int, returns a{sv}
+{
     REPLY_INIT;
     OUT_ARGUMENTS;
     DBusError error;
     dbus_error_init( &error );
 
-    dbus_int32_t i_position;
+    dbus_int32_t i_position, i_count = 0;
+
+    playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
+    playlist_item_t* p_tested_item = p_playlist->p_root_onelevel;
 
     dbus_message_get_args( p_from, &error,
             DBUS_TYPE_INT32, &i_position,
@@ -416,40 +438,43 @@ DBUS_METHOD( GetMetadata )
         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
     }
 
-    //TODO return a{sv}
+    while ( i_count < i_position )
+    {
+        i_count++;
+        TEST_NEXT;
+    }
 
+    GetInputMeta ( p_tested_item->p_input, &args );
+
+    pl_Release( p_playlist );
     REPLY_SEND;
 }
 
 DBUS_METHOD( GetLength )
-{ 
+{
     REPLY_INIT;
     OUT_ARGUMENTS;
 
     dbus_int32_t i_elements = 0;
     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
     playlist_item_t* p_tested_item = p_playlist->p_root_onelevel;
-    playlist_item_t* p_last_item = playlist_GetLastLeaf( p_playlist, p_playlist->p_root_onelevel ); 
+    playlist_item_t* p_last_item = playlist_GetLastLeaf( p_playlist,
+                    p_playlist->p_root_onelevel );
 
-    while ( p_tested_item->i_id != p_last_item->i_id )
+    while ( p_tested_item->p_input->i_id != p_last_item->p_input->i_id )
     {
         i_elements++;
-        p_tested_item = playlist_GetNextLeaf( p_playlist, 
-                        p_playlist->p_root_onelevel, 
-                        p_tested_item,
-                        VLC_FALSE,
-                        VLC_FALSE );
+        TEST_NEXT;
     }
 
     pl_Release( p_playlist );
-    
+
     ADD_INT32( &i_elements );
     REPLY_SEND;
 }
 
 DBUS_METHOD( DelTrack )
 {
-  /*FIXME: Doesn't work.*/
     REPLY_INIT;
 
     DBusError error;
@@ -470,31 +495,124 @@ DBUS_METHOD( DelTrack )
         dbus_error_free( &error );
         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
     }
-    
-    while ( i_count < i_position ) 
+
+    while ( i_count < i_position )
     {
         i_count++;
-        p_tested_item = playlist_GetNextLeaf( p_playlist, 
-                        p_playlist->p_root_onelevel, 
-                        p_tested_item,
-                        VLC_FALSE,
-                        VLC_FALSE );
+        TEST_NEXT;
     }
 
-    playlist_NodeRemoveItem( p_playlist, 
-                   p_tested_item, 
-                   p_playlist->p_root_onelevel );
+    PL_LOCK;
+    playlist_DeleteFromInput( p_playlist,
+        p_tested_item->p_input->i_id,
+        VLC_TRUE );
+    PL_UNLOCK;
+
     pl_Release( p_playlist );
 
     REPLY_SEND;
 }
 
+DBUS_METHOD( Loop )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+
+    DBusError error;
+    dbus_bool_t b_loop;
+    vlc_value_t val;
+    playlist_t* p_playlist = NULL;
+
+    dbus_error_init( &error );
+    dbus_message_get_args( p_from, &error,
+            DBUS_TYPE_BOOLEAN, &b_loop,
+            DBUS_TYPE_INVALID );
+
+    if( dbus_error_is_set( &error ) )
+    {
+        msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
+                error.message );
+        dbus_error_free( &error );
+        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+    }
+
+    val.b_bool = ( b_loop == TRUE ) ? VLC_TRUE : VLC_FALSE ;
+    p_playlist = pl_Yield( (vlc_object_t*) p_this );
+    var_Set ( p_playlist, "loop", val );
+    pl_Release( ((vlc_object_t*) p_this) );
+
+    REPLY_SEND;
+}
+
+DBUS_METHOD( Repeat )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+
+    DBusError error;
+    dbus_bool_t b_repeat;
+    vlc_value_t val;
+    playlist_t* p_playlist = NULL;
+
+    dbus_error_init( &error );
+    dbus_message_get_args( p_from, &error,
+            DBUS_TYPE_BOOLEAN, &b_repeat,
+            DBUS_TYPE_INVALID );
+
+    if( dbus_error_is_set( &error ) )
+    {
+        msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
+                error.message );
+        dbus_error_free( &error );
+        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+    }
+
+    val.b_bool = ( b_repeat == TRUE ) ? VLC_TRUE : VLC_FALSE ;
+
+    p_playlist = pl_Yield( (vlc_object_t*) p_this );
+    var_Set ( p_playlist, "repeat", val );
+    pl_Release( ((vlc_object_t*) p_this) );
+
+    REPLY_SEND;
+}
+
+DBUS_METHOD( Random )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+
+    DBusError error;
+    dbus_bool_t b_random;
+    vlc_value_t val;
+    playlist_t* p_playlist = NULL;
+    dbus_error_init( &error );
+    dbus_message_get_args( p_from, &error,
+            DBUS_TYPE_BOOLEAN, &b_random,
+            DBUS_TYPE_INVALID );
+    if( dbus_error_is_set( &error ) )
+    {
+        msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s\n",
+                error.message );
+        dbus_error_free( &error );
+        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+    }
+
+    val.b_bool = ( b_random == TRUE ) ? VLC_TRUE : VLC_FALSE ;
+    p_playlist = pl_Yield( (vlc_object_t*) p_this );
+    var_Set ( p_playlist, "random", val );
+    pl_Release( ((vlc_object_t*) p_this) );
+
+    REPLY_SEND;
+}
 /*****************************************************************************
  * Introspection method
  *****************************************************************************/
 
 DBUS_METHOD( handle_introspect_root )
-{ /* handles introspection of /org/videolan/vlc */
+{ /* handles introspection of root object */
     REPLY_INIT;
     OUT_ARGUMENTS;
     ADD_STRING( &psz_introspection_xml_data_root );
@@ -522,7 +640,7 @@ DBUS_METHOD( handle_introspect_tracklist )
  *****************************************************************************/
 
 #define METHOD_FUNC( method, function ) \
-    else if( dbus_message_is_method_call( p_from, VLC_DBUS_INTERFACE, method ) )\
+    else if( dbus_message_is_method_call( p_from, MPRIS_DBUS_INTERFACE, method ) )\
         return function( p_conn, p_from, p_this )
 
 DBUS_METHOD( handle_root )
@@ -554,11 +672,14 @@ DBUS_METHOD( handle_player )
     METHOD_FUNC( "Stop",                    Stop );
     METHOD_FUNC( "Play",                    Play );
     METHOD_FUNC( "Pause",                   Pause );
+    METHOD_FUNC( "Repeat",                  Repeat );
+    METHOD_FUNC( "Disconnect",              Disconnect );
     METHOD_FUNC( "VolumeSet",               VolumeSet );
     METHOD_FUNC( "VolumeGet",               VolumeGet );
     METHOD_FUNC( "PositionSet",             PositionSet );
     METHOD_FUNC( "PositionGet",             PositionGet );
     METHOD_FUNC( "GetStatus",               GetStatus );
+    METHOD_FUNC( "GetMetadata",             GetCurrentMetadata );
 
     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 }
@@ -576,6 +697,8 @@ DBUS_METHOD( handle_tracklist )
     METHOD_FUNC( "GetLength",               GetLength );
     METHOD_FUNC( "AddTrack",                AddTrack );
     METHOD_FUNC( "DelTrack",                DelTrack );
+    METHOD_FUNC( "Loop",                    Loop );
+    METHOD_FUNC( "Random",                  Random );
 
     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 }
@@ -611,21 +734,22 @@ static int Open( vlc_object_t *p_this )
     }
 
     /* register a well-known name on the bus */
-    dbus_bus_request_name( p_conn, "org.freedesktop.MediaPlayer", 0, &error );
+    dbus_bus_request_name( p_conn, VLC_MPRIS_DBUS_SERVICE, 0, &error );
     if( dbus_error_is_set( &error ) )
     {
-        msg_Err( p_this, "Error requesting org.freedesktop.MediaPlayer service:"                " %s\n", error.message );
+        msg_Err( p_this, "Error requesting % service: %s\n"
+        VLC_MPRIS_DBUS_SERVICE, error.message );
         dbus_error_free( &error );
         free( p_sys );
         return VLC_EGENERIC;
     }
 
     /* we register the objects */
-    dbus_connection_register_object_path( p_conn, VLC_DBUS_ROOT_PATH,
+    dbus_connection_register_object_path( p_conn, MPRIS_DBUS_ROOT_PATH,
             &vlc_dbus_root_vtable, p_this );
-    dbus_connection_register_object_path( p_conn, VLC_DBUS_PLAYER_PATH,
+    dbus_connection_register_object_path( p_conn, MPRIS_DBUS_PLAYER_PATH,
             &vlc_dbus_player_vtable, p_this );
-    dbus_connection_register_object_path( p_conn, VLC_DBUS_TRACKLIST_PATH,
+    dbus_connection_register_object_path( p_conn, MPRIS_DBUS_TRACKLIST_PATH,
             &vlc_dbus_tracklist_vtable, p_this );
 
     dbus_connection_flush( p_conn );
@@ -680,12 +804,12 @@ static void Run          ( intf_thread_t *p_intf )
  *****************************************************************************/
 
 DBUS_SIGNAL( TrackChangeSignal )
-{ /* emit the name of the new item */
+{ /* emit the metadata of the new item */
     SIGNAL_INIT( "TrackChange" );
     OUT_ARGUMENTS;
 
     input_thread_t *p_input = (input_thread_t*) p_data;
-    ADD_STRING( &input_GetItem(p_input)->psz_name );
+    GetInputMeta ( input_GetItem(p_input), &args );
 
     SIGNAL_SEND;
 }
@@ -720,3 +844,80 @@ static int TrackChange( vlc_object_t *p_this, const char *psz_var,
     return VLC_SUCCESS;
 }
 
+/*****************************************************************************
+ * GetInputMeta: Fill a DBusMessage with the given input item metadata
+ *****************************************************************************/
+
+#define ADD_META( entry, type, data ) \
+    if( data ) { \
+        dbus_message_iter_open_container( &dict, DBUS_TYPE_DICT_ENTRY, \
+                NULL, &dict_entry ); \
+        dbus_message_iter_append_basic( &dict_entry, DBUS_TYPE_STRING, \
+                &ppsz_meta_items[entry] ); \
+        dbus_message_iter_open_container( &dict_entry, DBUS_TYPE_VARIANT, \
+                type##_AS_STRING, &variant ); \
+        dbus_message_iter_append_basic( &variant, \
+                type, \
+                & data ); \
+        dbus_message_iter_close_container( &dict_entry, &variant ); \
+        dbus_message_iter_close_container( &dict, &dict_entry ); }
+
+#define ADD_VLC_META_STRING( entry, item ) \
+    { \
+        char * psz = input_item_Get##item( p_input );\
+        ADD_META( entry, DBUS_TYPE_STRING, \
+                  psz ); \
+        free( psz ); \
+    }
+
+static int GetInputMeta( input_item_t* p_input,
+                        DBusMessageIter *args )
+{ /*FIXME: Works only for already read metadata. */
+
+    DBusMessageIter dict, dict_entry, variant;
+    /* We need the track length to be expressed in seconds
+     * instead of milliseconds */
+    dbus_int64_t i_length = ( input_item_GetDuration( p_input ) / 1000 );
+
+    const char* ppsz_meta_items[] =
+    {
+    "title", "artist", "genre", "copyright", "album", "tracknum",
+    "description", "rating", "date", "setting", "url", "language",
+    "nowplaying", "publisher", "encodedby", "arturl", "trackid",
+    "status", "URI", "length", "video-codec", "audio-codec",
+    "video-bitrate", "audio-bitrate", "audio-samplerate"
+    };
+
+    dbus_message_iter_open_container( args, DBUS_TYPE_ARRAY, "{sv}", &dict );
+
+    ADD_VLC_META_STRING( 0,  Title );
+    ADD_VLC_META_STRING( 1,  Artist );
+    ADD_VLC_META_STRING( 2,  Genre );
+    ADD_VLC_META_STRING( 3,  Copyright );
+    ADD_VLC_META_STRING( 4,  Album );
+    ADD_VLC_META_STRING( 5,  TrackNum );
+    ADD_VLC_META_STRING( 6,  Description );
+    ADD_VLC_META_STRING( 7,  Rating );
+    ADD_VLC_META_STRING( 8,  Date );
+    ADD_VLC_META_STRING( 9,  Setting );
+    ADD_VLC_META_STRING( 10, URL );
+    ADD_VLC_META_STRING( 11, Language );
+    ADD_VLC_META_STRING( 12, NowPlaying );
+    ADD_VLC_META_STRING( 13, Publisher );
+    ADD_VLC_META_STRING( 14, EncodedBy );
+    ADD_VLC_META_STRING( 15, ArtURL );
+    ADD_VLC_META_STRING( 16, TrackID );
+
+    vlc_mutex_lock( &p_input->lock );
+    ADD_META( 17, DBUS_TYPE_INT32, p_input->p_meta->i_status );
+    vlc_mutex_unlock( &p_input->lock );
+
+    ADD_VLC_META_STRING( 18, URI );
+    ADD_META( 19, DBUS_TYPE_INT64, i_length );
+
+    dbus_message_iter_close_container( args, &dict );
+    return VLC_SUCCESS;
+}
+
+#undef ADD_META
+#undef ADD_VLC_META_STRING