]> git.sesse.net Git - vlc/blobdiff - modules/control/dbus.c
dbus: review object locking/yielding, fix various bugs & comments
[vlc] / modules / control / dbus.c
index 85b41f9aa8bce1472d485d4ff00d5c296b09d897..fd3b65371c6fa540ed7bc28c270eff1e0dab4c6b 100644 (file)
@@ -1,7 +1,8 @@
 /*****************************************************************************
  * dbus.c : D-Bus control interface
  *****************************************************************************
- * Copyright (C) 2006 Rafaël Carré
+ * Copyright © 2006-2007 Rafaël Carré
+ * Copyright © 2007 Mirsal Ennaime
  * $Id$
  *
  * Authors:    Rafaël Carré <funman at videolanorg>
  * D-Bus low-level C API (libdbus)
  *      http://dbus.freedesktop.org/doc/dbus/api/html/index.html
  *  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
+ *   "If you use this low-level API directly, you're signing up for some pain."
+ *
+ * MPRIS Specification (still drafting on Oct, 23 of 2007):
+ *      http://wiki.xmms2.xmms.se/index.php/MPRIS
  */
 
 /*****************************************************************************
@@ -56,15 +58,22 @@ static int  Open    ( vlc_object_t * );
 static void Close   ( vlc_object_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 StateChange( vlc_object_t *, const char *, vlc_value_t,
+                        vlc_value_t, void * );
+
+static int TrackChange( vlc_object_t *, const char *, vlc_value_t,
+                        vlc_value_t, void * );
 
-static int GetInputMeta ( input_item_t *p_input,
-                    DBusMessageIter *args);
+static int StatusChangeEmit( vlc_object_t *, const char *, vlc_value_t,
+                        vlc_value_t, void * );
+
+static int GetInputMeta ( input_item_t *, DBusMessageIter * );
+static int MarshalStatus ( intf_thread_t *, DBusMessageIter *, vlc_bool_t );
 
 struct intf_sys_t
 {
     DBusConnection *p_conn;
+    vlc_bool_t      b_meta_read;
 };
 
 /*****************************************************************************
@@ -104,6 +113,7 @@ DBUS_METHOD( PositionGet )
     dbus_int32_t i_pos;
 
     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
+    PL_LOCK;
     input_thread_t *p_input = p_playlist->p_input;
 
     if( !p_input )
@@ -113,6 +123,7 @@ DBUS_METHOD( PositionGet )
         var_Get( p_input, "time", &position );
         i_pos = position.i_time / 1000;
     }
+    PL_UNLOCK;
     pl_Release( ((vlc_object_t*) p_this) );
     ADD_INT32( &i_pos );
     REPLY_SEND;
@@ -141,6 +152,7 @@ DBUS_METHOD( PositionSet )
         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
     }
     p_playlist = pl_Yield( ((vlc_object_t*) p_this) );
+    PL_LOCK;
     input_thread_t *p_input = p_playlist->p_input;
 
     if( p_input )
@@ -148,6 +160,7 @@ DBUS_METHOD( PositionSet )
         position.i_time = i_pos * 1000;
         var_Set( p_input, "time", position );
     }
+    PL_UNLOCK;
     pl_Release( ((vlc_object_t*) p_this) );
     REPLY_SEND;
 }
@@ -221,29 +234,18 @@ DBUS_METHOD( Stop )
 }
 
 DBUS_METHOD( GetStatus )
-{ /* returns an int: 0=playing 1=paused 2=stopped */
+{ /* returns the current status as a struct of 4 ints */
+/*
+    First   0 = Playing, 1 = Paused, 2 = Stopped.
+    Second  0 = Playing linearly , 1 = Playing randomly.
+    Third   0 = Go to the next element once the current has finished playing , 1 = Repeat the current element
+    Fourth  0 = Stop playing once the last element has been played, 1 = Never give up playing *
+ */
     REPLY_INIT;
     OUT_ARGUMENTS;
 
-    dbus_int32_t i_status;
-    vlc_value_t val;
-
-    playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
-    input_thread_t *p_input = p_playlist->p_input;
-
-    i_status = 2;
-    if( p_input )
-    {
-        var_Get( p_input, "state", &val );
-        if( val.i_int == PAUSE_S )
-            i_status = 1;
-        else if( val.i_int == PLAYING_S )
-            i_status = 0;
-    }
-
-    pl_Release( p_playlist );
+    MarshalStatus( p_this, &args, VLC_TRUE );
 
-    ADD_INT32( &i_status );
     REPLY_SEND;
 }
 
@@ -270,10 +272,10 @@ DBUS_METHOD( GetCurrentMetadata )
     REPLY_INIT;
     OUT_ARGUMENTS;
     playlist_t* p_playlist = pl_Yield( (vlc_object_t*) p_this );
-
+    PL_LOCK;
     if( p_playlist->status.p_item )
         GetInputMeta( p_playlist->status.p_item->p_input, &args );
-
+    PL_UNLOCK;
     pl_Release( p_playlist );
     REPLY_SEND;
 }
@@ -284,10 +286,15 @@ DBUS_METHOD( Identity )
 {
     REPLY_INIT;
     OUT_ARGUMENTS;
-    char *psz_identity = malloc( strlen( PACKAGE ) + strlen( VERSION ) + 2 );
-    sprintf( psz_identity, "%s %s", PACKAGE, VERSION );
-    ADD_STRING( &psz_identity );
-    free( psz_identity );
+    char *psz_identity;
+    if( asprintf( &psz_identity, "%s %s", PACKAGE, VERSION ) != -1 )
+    {
+        ADD_STRING( &psz_identity );
+        free( psz_identity );
+    }
+    else
+        return DBUS_HANDLER_RESULT_NEED_MEMORY;
+
     REPLY_SEND;
 }
 
@@ -330,20 +337,9 @@ DBUS_METHOD( GetCurrentTrack )
 {
     REPLY_INIT;
     OUT_ARGUMENTS;
-    /* FIXME 0 indicates the first item,
-     * what to do if we're stopped, or empty ? */
-    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;
 
-    if( p_playlist->status.p_item )
-        while ( p_tested_item && p_tested_item->p_input->i_id !=
-                p_playlist->status.p_item->p_input->i_id )
-        {
-            i_position++;
-            TEST_NEXT_ITEM;
-        }
-    /* FIXME if p_tested_item is NULL at that point, what do we do ? */
+    playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
+    dbus_int32_t i_position = p_playlist->i_current_index;
     pl_Release( p_playlist );
 
     ADD_INT32( &i_position );
@@ -357,10 +353,10 @@ DBUS_METHOD( GetMetadata )
     DBusError error;
     dbus_error_init( &error );
 
-    dbus_int32_t i_position, i_count = 0;
+    dbus_int32_t i_position;
 
     playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
-    playlist_item_t* p_tested_item = p_playlist->p_root_onelevel;
+    PL_LOCK;
 
     dbus_message_get_args( p_from, &error,
            DBUS_TYPE_INT32, &i_position,
@@ -368,21 +364,20 @@ DBUS_METHOD( GetMetadata )
 
     if( dbus_error_is_set( &error ) )
     {
+        PL_UNLOCK;
+        pl_Release( p_playlist );
         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;
     }
 
-    while ( p_tested_item && ( i_count < i_position ) )
+    if( i_position <= p_playlist->items.i_size / 2 )
     {
-        i_count++;
-        TEST_NEXT_ITEM;
+        GetInputMeta( p_playlist->items.p_elems[i_position*2-1]->p_input, &args );
     }
 
-    if( p_tested_item )
-        GetInputMeta ( p_tested_item->p_input, &args );
-
+    PL_UNLOCK;
     pl_Release( p_playlist );
     REPLY_SEND;
 }
@@ -392,19 +387,8 @@ 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 );
-
-    while ( p_tested_item &&
-               ( p_tested_item->p_input->i_id != p_last_item->p_input->i_id ) )
-    {
-        i_elements++;
-        TEST_NEXT_ITEM;
-    }
-
+    dbus_int32_t i_elements = p_playlist->items.i_size / 2;
     pl_Release( p_playlist );
 
     ADD_INT32( &i_elements );
@@ -418,9 +402,8 @@ DBUS_METHOD( DelTrack )
     DBusError error;
     dbus_error_init( &error );
 
-    dbus_int32_t i_position, i_count = 0;
+    dbus_int32_t i_position;
     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,
@@ -434,19 +417,11 @@ DBUS_METHOD( DelTrack )
         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
     }
 
-    while ( p_tested_item && ( i_count < i_position ) )
+    if( i_position >= p_playlist->items.i_size / 2 )
     {
-        i_count++;
-        TEST_NEXT_ITEM;
-    }
-
-    if( p_tested_item )
-    {
-        PL_LOCK;
         playlist_DeleteFromInput( p_playlist,
-            p_tested_item->p_input->i_id,
-            VLC_TRUE );
-        PL_UNLOCK;
+            p_playlist->items.p_elems[i_position*2-1]->i_id,
+            VLC_FALSE );
     }
 
     pl_Release( p_playlist );
@@ -526,12 +501,12 @@ DBUS_METHOD( Random )
     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",
@@ -541,7 +516,7 @@ DBUS_METHOD( Random )
     }
 
     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) );
@@ -658,7 +633,7 @@ static int Open( vlc_object_t *p_this )
     if( !p_sys )
         return VLC_ENOMEM;
 
-    dbus_threads_init_default();
+    p_sys->b_meta_read = VLC_FALSE;
 
     dbus_error_init( &error );
 
@@ -697,6 +672,9 @@ static int Open( vlc_object_t *p_this )
     p_playlist = pl_Yield( p_intf );
     PL_LOCK;
     var_AddCallback( p_playlist, "playlist-current", TrackChange, p_intf );
+    var_AddCallback( p_playlist, "random", StatusChangeEmit, p_intf );
+    var_AddCallback( p_playlist, "repeat", StatusChangeEmit, p_intf );
+    var_AddCallback( p_playlist, "loop", StatusChangeEmit, p_intf );
     PL_UNLOCK;
     pl_Release( p_playlist );
 
@@ -715,9 +693,24 @@ static void Close   ( vlc_object_t *p_this )
 {
     intf_thread_t   *p_intf     = (intf_thread_t*) p_this;
     playlist_t      *p_playlist = pl_Yield( p_intf );;
+    input_thread_t  *p_input;
+
+    p_this->b_dead = VLC_TRUE;
 
     PL_LOCK;
     var_DelCallback( p_playlist, "playlist-current", TrackChange, p_intf );
+    var_DelCallback( p_playlist, "random", StatusChangeEmit, p_intf );
+    var_DelCallback( p_playlist, "repeat", StatusChangeEmit, p_intf );
+    var_DelCallback( p_playlist, "loop", StatusChangeEmit, p_intf );
+
+    p_input = p_playlist->p_input;
+    if ( p_input )
+    {
+        vlc_object_yield( p_input );
+        var_DelCallback( p_input, "state", StateChange, p_intf );
+        vlc_object_release( p_input );
+    }
+
     PL_UNLOCK;
     pl_Release( p_playlist );
 
@@ -748,12 +741,77 @@ DBUS_SIGNAL( TrackChangeSignal )
     SIGNAL_INIT( "TrackChange" );
     OUT_ARGUMENTS;
 
-    input_thread_t *p_input = (input_thread_t*) p_data;
-    GetInputMeta ( input_GetItem(p_input), &args );
+    input_item_t *p_item = (input_item_t*) p_data;
+    GetInputMeta ( p_item, &args );
 
     SIGNAL_SEND;
 }
 
+/*****************************************************************************
+ * StatusChange: Player status change signal
+ *****************************************************************************/
+
+DBUS_SIGNAL( StatusChangeSignal )
+{ /* send the updated status info on the bus */
+    SIGNAL_INIT( "StatusChange" );
+    OUT_ARGUMENTS;
+
+    /* we're called from a callback of input_thread_t, so it can not be
+     * destroyed before we return */
+    MarshalStatus( (intf_thread_t*) p_data, &args, VLC_FALSE );
+
+    SIGNAL_SEND;
+}
+
+/*****************************************************************************
+ * StateChange: callback on input "state"
+ *****************************************************************************/
+static int StateChange( vlc_object_t *p_this, const char* psz_var,
+            vlc_value_t oldval, vlc_value_t newval, void *p_data )
+{
+    intf_thread_t       *p_intf     = ( intf_thread_t* ) p_data;
+    intf_sys_t          *p_sys      = p_intf->p_sys;
+
+    if( p_intf->b_dead )
+        return VLC_SUCCESS;
+
+    if( !p_sys->b_meta_read && newval.i_int == PLAYING_S )
+    {
+        input_item_t *p_item = input_GetItem( (input_thread_t*)p_this );
+        if( p_item )
+        {
+            p_sys->b_meta_read = VLC_TRUE;
+            TrackChangeSignal( p_sys->p_conn, p_item );
+        }
+    }
+
+    if( newval.i_int == PLAYING_S || newval.i_int == PAUSE_S ||
+        newval.i_int == END_S )
+    {
+        StatusChangeSignal( p_sys->p_conn, (void*) p_intf );
+    }
+
+    return VLC_SUCCESS;
+}
+
+/*****************************************************************************
+ * StatusChangeEmit: Emits the StatusChange signal
+ *****************************************************************************/
+static int StatusChangeEmit( vlc_object_t *p_this, const char *psz_var,
+            vlc_value_t oldval, vlc_value_t newval, void *p_data )
+{
+    intf_thread_t *p_intf = p_data;
+
+    if( p_intf->b_dead )
+        return VLC_SUCCESS;
+
+    StatusChangeSignal( p_intf->p_sys->p_conn, p_data );
+    return VLC_SUCCESS;
+}
+
+/*****************************************************************************
+ * TrackChange: callback on playlist "playlist-current"
+ *****************************************************************************/
 static int TrackChange( vlc_object_t *p_this, const char *psz_var,
             vlc_value_t oldval, vlc_value_t newval, void *p_data )
 {
@@ -761,7 +819,14 @@ static int TrackChange( vlc_object_t *p_this, const char *psz_var,
     intf_sys_t          *p_sys      = p_intf->p_sys;
     playlist_t          *p_playlist;
     input_thread_t      *p_input    = NULL;
-    (void)p_this; (void)psz_var; (void)oldval; (void)newval;
+    input_item_t        *p_item     = NULL;
+    VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
+    VLC_UNUSED( oldval ); VLC_UNUSED( newval );
+
+    if( p_intf->b_dead )
+        return VLC_SUCCESS;
+
+    p_sys->b_meta_read = VLC_FALSE;
 
     p_playlist = pl_Yield( p_intf );
     PL_LOCK;
@@ -778,7 +843,20 @@ static int TrackChange( vlc_object_t *p_this, const char *psz_var,
     PL_UNLOCK;
     pl_Release( p_playlist );
 
-    TrackChangeSignal( p_sys->p_conn, p_input );
+    p_item = input_GetItem( p_input );
+    if( !p_item )
+    {
+        vlc_object_release( p_input );
+        return VLC_EGENERIC;
+    }
+
+    if( input_item_IsPreparsed( p_item ) )
+    {
+        p_sys->b_meta_read = VLC_TRUE;
+        TrackChangeSignal( p_sys->p_conn, p_item );
+    }
+
+    var_AddCallback( p_input, "state", StateChange, p_intf );
 
     vlc_object_release( p_input );
     return VLC_SUCCESS;
@@ -812,11 +890,10 @@ static int TrackChange( vlc_object_t *p_this, const char *psz_var,
 
 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 */
+    /* We need the track length to be expressed in milli-seconds
+     * instead of µ-seconds */
     dbus_int64_t i_length = ( input_item_GetDuration( p_input ) / 1000 );
 
     const char* ppsz_meta_items[] =
@@ -862,3 +939,60 @@ static int GetInputMeta( input_item_t* p_input,
 
 #undef ADD_META
 #undef ADD_VLC_META_STRING
+
+/*****************************************************************************
+ * MarshalStatus: Fill a DBusMessage with the current player status
+ *****************************************************************************/
+
+static int MarshalStatus( intf_thread_t* p_intf, DBusMessageIter* args,
+                          vlc_bool_t lock )
+{ /* This is NOT the right way to do that, it would be better to sore
+     the status information in p_sys and update it on change, thus
+     avoiding a long lock */
+
+    DBusMessageIter status;
+    dbus_int32_t i_state, i_random, i_repeat, i_loop;
+    vlc_value_t val;
+    playlist_t* p_playlist = NULL;
+    input_thread_t* p_input = NULL;
+
+    p_playlist = pl_Yield( (vlc_object_t*) p_intf );
+    if( lock )
+        PL_LOCK;
+
+    i_state = 2;
+
+    p_input = p_playlist->p_input;
+    if( p_input )
+    {
+        var_Get( p_input, "state", &val );
+        if( val.i_int >= END_S )
+            i_state = 2;
+        else if( val.i_int == PAUSE_S )
+            i_state = 1;
+        else if( val.i_int <= PLAYING_S )
+            i_state = 0;
+    }
+
+    var_Get( p_playlist, "random", &val );
+    i_random = val.i_int;
+
+    var_Get( p_playlist, "repeat", &val );
+    i_repeat = val.i_int;
+
+    var_Get( p_playlist, "loop", &val );
+    i_loop = val.i_int;
+
+    if( lock )
+        PL_UNLOCK;
+    pl_Release( p_playlist );
+
+    dbus_message_iter_open_container( args, DBUS_TYPE_STRUCT, NULL, &status );
+    dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_state );
+    dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_random );
+    dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_repeat );
+    dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_loop );
+    dbus_message_iter_close_container( args, &status );
+
+    return VLC_SUCCESS;
+}