/*****************************************************************************
* dbus.c : D-Bus control interface
*****************************************************************************
- * Copyright © 2006-2007 Rafaël Carré
- * Copyright © 2007 Mirsal Ennaime
+ * Copyright © 2006-2008 Rafaël Carré
+ * Copyright © 2007-2008 Mirsal Ennaime
* $Id$
*
* Authors: Rafaël Carré <funman at videolanorg>
* extract:
* "If you use this low-level API directly, you're signing up for some pain."
*
- * MPRIS Specification (still drafting on Oct, 23 of 2007):
+ * MPRIS Specification (still drafting on Jan, 23 of 2008):
* http://wiki.xmms2.xmms.se/index.php/MPRIS
*/
#include "dbus.h"
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
#include <vlc_aout.h>
#include <vlc_interface.h>
#include <vlc_meta.h>
#include <vlc_input.h>
#include <vlc_playlist.h>
+#include <math.h>
+
+#include <assert.h>
+
/*****************************************************************************
* Local prototypes.
*****************************************************************************/
static int StatusChangeEmit( vlc_object_t *, const char *, vlc_value_t,
vlc_value_t, void * );
+static int TrackListChangeEmit( 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 );
+static int MarshalStatus ( intf_thread_t *, DBusMessageIter *, bool );
+static int UpdateCaps( intf_thread_t*, bool );
+
+/* GetCaps() capabilities */
+enum
+{
+ CAPS_NONE = 0,
+ CAPS_CAN_GO_NEXT = 1 << 0,
+ CAPS_CAN_GO_PREV = 1 << 1,
+ CAPS_CAN_PAUSE = 1 << 2,
+ CAPS_CAN_PLAY = 1 << 3,
+ CAPS_CAN_SEEK = 1 << 4,
+ CAPS_CAN_PROVIDE_METADATA = 1 << 5,
+ CAPS_CAN_HAS_TRACKLIST = 1 << 6
+};
struct intf_sys_t
{
DBusConnection *p_conn;
- vlc_bool_t b_meta_read;
+ bool b_meta_read;
+ dbus_int32_t i_caps;
};
/*****************************************************************************
*****************************************************************************/
vlc_module_begin();
- set_shortname( _("dbus"));
+ set_shortname( N_("dbus"));
set_category( CAT_INTERFACE );
set_subcategory( SUBCAT_INTERFACE_CONTROL );
- set_description( _("D-Bus control interface") );
+ set_description( N_("D-Bus control interface") );
set_capability( "interface", 0 );
set_callbacks( Open, Close );
vlc_module_end();
REPLY_SEND;
}
+DBUS_METHOD( MprisVersion )
+{ /*implemented version of the mpris spec */
+ REPLY_INIT;
+ OUT_ARGUMENTS;
+ VLC_UNUSED( p_this );
+ dbus_uint16_t i_major = VLC_MPRIS_VERSION_MAJOR;
+ dbus_uint16_t i_minor = VLC_MPRIS_VERSION_MINOR;
+ DBusMessageIter version;
+
+ if( !dbus_message_iter_open_container( &args, DBUS_TYPE_STRUCT, NULL,
+ &version ) )
+ return DBUS_HANDLER_RESULT_NEED_MEMORY;
+
+ if( !dbus_message_iter_append_basic( &version, DBUS_TYPE_UINT16,
+ &i_major ) )
+ return DBUS_HANDLER_RESULT_NEED_MEMORY;
+
+ if( !dbus_message_iter_append_basic( &version, DBUS_TYPE_UINT16,
+ &i_minor ) )
+ return DBUS_HANDLER_RESULT_NEED_MEMORY;
+
+ if( !dbus_message_iter_close_container( &args, &version ) )
+ return DBUS_HANDLER_RESULT_NEED_MEMORY;
+ REPLY_SEND;
+}
+
DBUS_METHOD( PositionGet )
{ /* returns position in milliseconds */
REPLY_INIT;
audio_volume_t i_vol;
/* 2nd argument of aout_VolumeGet is int32 */
aout_VolumeGet( (vlc_object_t*) p_this, &i_vol );
- i_dbus_vol = ( 100 * i_vol ) / AOUT_VOLUME_MAX;
+ double f_vol = 100. * i_vol / AOUT_VOLUME_MAX;
+ i_dbus_vol = round( f_vol );
ADD_INT32( &i_dbus_vol );
REPLY_SEND;
}
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
- i_vol = ( AOUT_VOLUME_MAX / 100 ) *i_dbus_vol;
+ double f_vol = AOUT_VOLUME_MAX * i_dbus_vol / 100.;
+ i_vol = round( f_vol );
aout_VolumeSet( (vlc_object_t*) p_this, i_vol );
REPLY_SEND;
REPLY_INIT;
OUT_ARGUMENTS;
- MarshalStatus( p_this, &args, VLC_TRUE );
+ MarshalStatus( p_this, &args, true );
REPLY_SEND;
}
REPLY_INIT;
playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
playlist_Pause( p_playlist );
- pl_Release( p_playlist );
+ pl_Release( (vlc_object_t*) p_this );
REPLY_SEND;
}
{
REPLY_INIT;
playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
- playlist_Play( p_playlist );
- pl_Release( p_playlist );
+
+ PL_LOCK;
+ input_thread_t *p_input = p_playlist->p_input;
+ if( p_input )
+ vlc_object_yield( p_input );
+ PL_UNLOCK;
+
+ if( p_input )
+ {
+ double i_pos = 0;
+ input_Control( p_input, INPUT_SET_POSITION, i_pos );
+ vlc_object_release( p_input );
+ }
+ else
+ playlist_Play( p_playlist );
+
+ pl_Release( (vlc_object_t*) p_this );
REPLY_SEND;
}
if( p_playlist->status.p_item )
GetInputMeta( p_playlist->status.p_item->p_input, &args );
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( (vlc_object_t*) p_this );
+ REPLY_SEND;
+}
+
+DBUS_METHOD( GetCaps )
+{
+ REPLY_INIT;
+ OUT_ARGUMENTS;
+
+ ADD_INT32( &((intf_thread_t*)p_this)->p_sys->i_caps );
+
REPLY_SEND;
}
DBUS_METHOD( Identity )
{
+ VLC_UNUSED(p_this);
REPLY_INIT;
OUT_ARGUMENTS;
char *psz_identity;
DBUS_METHOD( AddTrack )
{ /* add the string to the playlist, and play it if the boolean is true */
REPLY_INIT;
+ OUT_ARGUMENTS;
DBusError error;
dbus_error_init( &error );
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, VLC_FALSE );
- pl_Release( p_playlist );
+ PLAYLIST_END, true, false );
+ pl_Release( (vlc_object_t*) p_this );
+
+ dbus_int32_t i_success = 0;
+ ADD_INT32( &i_success );
REPLY_SEND;
}
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 );
+ pl_Release( (vlc_object_t*) p_this );
ADD_INT32( &i_position );
REPLY_SEND;
if( dbus_error_is_set( &error ) )
{
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( (vlc_object_t*) p_this );
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;
}
- if( i_position <= p_playlist->items.i_size / 2 )
+ if( i_position < p_playlist->current.i_size )
{
- GetInputMeta( p_playlist->items.p_elems[i_position*2-1]->p_input, &args );
+ GetInputMeta( p_playlist->current.p_elems[i_position]->p_input, &args );
}
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( (vlc_object_t*) p_this );
REPLY_SEND;
}
OUT_ARGUMENTS;
playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_this );
- dbus_int32_t i_elements = p_playlist->items.i_size / 2;
- pl_Release( p_playlist );
+ dbus_int32_t i_elements = p_playlist->current.i_size;
+ pl_Release( (vlc_object_t*) p_this );
ADD_INT32( &i_elements );
REPLY_SEND;
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
- if( i_position <= p_playlist->items.i_size / 2 )
+ PL_LOCK;
+ if( i_position < p_playlist->current.i_size )
{
playlist_DeleteFromInput( p_playlist,
- p_playlist->items.p_elems[i_position*2-1]->i_id,
- VLC_FALSE );
+ p_playlist->current.p_elems[i_position]->p_input->i_id,
+ pl_Locked );
}
+ PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( (vlc_object_t*) p_this );
REPLY_SEND;
}
-DBUS_METHOD( Loop )
+DBUS_METHOD( SetLoop )
{
REPLY_INIT;
OUT_ARGUMENTS;
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
- val.b_bool = ( b_loop == TRUE ) ? VLC_TRUE : VLC_FALSE ;
+ val.b_bool = ( b_loop == TRUE ) ? true : false ;
p_playlist = pl_Yield( (vlc_object_t*) p_this );
var_Set ( p_playlist, "loop", val );
pl_Release( ((vlc_object_t*) p_this) );
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
- val.b_bool = ( b_repeat == TRUE ) ? VLC_TRUE : VLC_FALSE ;
+ val.b_bool = ( b_repeat == TRUE ) ? true : false ;
p_playlist = pl_Yield( (vlc_object_t*) p_this );
var_Set ( p_playlist, "repeat", val );
REPLY_SEND;
}
-DBUS_METHOD( Random )
+DBUS_METHOD( SetRandom )
{
REPLY_INIT;
OUT_ARGUMENTS;
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
- val.b_bool = ( b_random == TRUE ) ? VLC_TRUE : VLC_FALSE ;
+ val.b_bool = ( b_random == TRUE ) ? true : false ;
p_playlist = pl_Yield( (vlc_object_t*) p_this );
var_Set ( p_playlist, "random", val );
DBUS_METHOD( handle_introspect_root )
{ /* handles introspection of root object */
+ VLC_UNUSED(p_this);
REPLY_INIT;
OUT_ARGUMENTS;
ADD_STRING( &psz_introspection_xml_data_root );
DBUS_METHOD( handle_introspect_player )
{
+ VLC_UNUSED(p_this);
REPLY_INIT;
OUT_ARGUMENTS;
ADD_STRING( &psz_introspection_xml_data_player );
DBUS_METHOD( handle_introspect_tracklist )
{
+ VLC_UNUSED(p_this);
REPLY_INIT;
OUT_ARGUMENTS;
ADD_STRING( &psz_introspection_xml_data_tracklist );
/* here D-Bus method's names are associated to an handler */
METHOD_FUNC( "Identity", Identity );
+ METHOD_FUNC( "MprisVersion", MprisVersion );
+ METHOD_FUNC( "Quit", Quit );
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
{
if( dbus_message_is_method_call( p_from,
DBUS_INTERFACE_INTROSPECTABLE, "Introspect" ) )
- return handle_introspect_player( p_conn, p_from, p_this );
+ return handle_introspect_player( p_conn, p_from, p_this );
/* here D-Bus method's names are associated to an handler */
METHOD_FUNC( "Prev", Prev );
METHOD_FUNC( "Next", Next );
- METHOD_FUNC( "Quit", Quit );
METHOD_FUNC( "Stop", Stop );
METHOD_FUNC( "Play", Play );
METHOD_FUNC( "Pause", Pause );
METHOD_FUNC( "PositionGet", PositionGet );
METHOD_FUNC( "GetStatus", GetStatus );
METHOD_FUNC( "GetMetadata", GetCurrentMetadata );
+ METHOD_FUNC( "GetCaps", GetCaps );
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
METHOD_FUNC( "GetLength", GetLength );
METHOD_FUNC( "AddTrack", AddTrack );
METHOD_FUNC( "DelTrack", DelTrack );
- METHOD_FUNC( "Loop", Loop );
- METHOD_FUNC( "Random", Random );
+ METHOD_FUNC( "SetLoop", SetLoop );
+ METHOD_FUNC( "SetRandom", SetRandom );
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
if( !p_sys )
return VLC_ENOMEM;
- p_sys->b_meta_read = VLC_FALSE;
+ p_sys->b_meta_read = false;
+ p_sys->i_caps = CAPS_NONE;
dbus_error_init( &error );
p_playlist = pl_Yield( p_intf );
PL_LOCK;
var_AddCallback( p_playlist, "playlist-current", TrackChange, p_intf );
+ var_AddCallback( p_playlist, "intf-change", TrackListChangeEmit, p_intf );
+ var_AddCallback( p_playlist, "item-append", TrackListChangeEmit, p_intf );
+ var_AddCallback( p_playlist, "item-deleted", TrackListChangeEmit, 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 );
+ pl_Release( p_intf );
p_intf->pf_run = Run;
p_intf->p_sys = p_sys;
p_sys->p_conn = p_conn;
+ UpdateCaps( p_intf, false );
+
return VLC_SUCCESS;
}
playlist_t *p_playlist = pl_Yield( p_intf );;
input_thread_t *p_input;
- p_this->b_dead = VLC_TRUE;
+ p_this->b_dead = true;
PL_LOCK;
var_DelCallback( p_playlist, "playlist-current", TrackChange, p_intf );
+ var_DelCallback( p_playlist, "intf-change", TrackListChangeEmit, p_intf );
+ var_DelCallback( p_playlist, "item-append", TrackListChangeEmit, p_intf );
+ var_DelCallback( p_playlist, "item-deleted", TrackListChangeEmit, 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 );
}
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( p_intf );
dbus_connection_unref( p_intf->p_sys->p_conn );
}
}
+/******************************************************************************
+ * CapsChange: player capabilities change signal
+ *****************************************************************************/
+DBUS_SIGNAL( CapsChangeSignal )
+{
+ SIGNAL_INIT( "CapsChange" );
+ OUT_ARGUMENTS;
+
+ ADD_INT32( &((intf_thread_t*)p_data)->p_sys->i_caps );
+ SIGNAL_SEND;
+}
+
+/******************************************************************************
+ * TrackListChange: tracklist order / length change signal
+ *****************************************************************************/
+DBUS_SIGNAL( TrackListChangeSignal )
+{ /* emit the new tracklist lengh */
+ SIGNAL_INIT("TrackListChange");
+ OUT_ARGUMENTS;
+
+ playlist_t *p_playlist = pl_Yield( (vlc_object_t*) p_data );
+ dbus_int32_t i_elements = p_playlist->current.i_size;
+ pl_Release( (vlc_object_t*) p_data );
+
+ ADD_INT32( &i_elements );
+ SIGNAL_SEND;
+}
+
+/*****************************************************************************
+ * TrackListChangeEmit: Emits the TrackListChange signal
+ *****************************************************************************/
+/* FIXME: It is not called on tracklist reordering */
+static int TrackListChangeEmit( vlc_object_t *p_this, const char *psz_var,
+ vlc_value_t oldval, vlc_value_t newval, void *p_data )
+{
+ VLC_UNUSED(oldval);
+ intf_thread_t *p_intf = p_data;
+
+ if( !strcmp( psz_var, "item-append" ) || !strcmp( psz_var, "item-remove" ) )
+ {
+ /* don't signal when items are added/removed in p_category */
+ playlist_t *p_playlist = (playlist_t*)p_this;
+ playlist_add_t *p_add = newval.p_address;
+ playlist_item_t *p_item;
+ p_item = playlist_ItemGetById( p_playlist, p_add->i_node, pl_Locked );
+ assert( p_item );
+ while( p_item->p_parent )
+ p_item = p_item->p_parent;
+ if( p_item == p_playlist->p_root_category )
+ return VLC_SUCCESS;
+ }
+
+ if( p_intf->b_dead )
+ return VLC_SUCCESS;
+
+ UpdateCaps( p_intf, true );
+ TrackListChangeSignal( p_intf->p_sys->p_conn, p_data );
+ return VLC_SUCCESS;
+}
/*****************************************************************************
* TrackChange: Playlist item change callback
*****************************************************************************/
/* 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 );
+ MarshalStatus( (intf_thread_t*) p_data, &args, false );
SIGNAL_SEND;
}
static int StateChange( vlc_object_t *p_this, const char* psz_var,
vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
+ VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
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;
+ UpdateCaps( p_intf, true );
+
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;
+ p_sys->b_meta_read = true;
TrackChangeSignal( p_sys->p_conn, p_item );
}
}
if( newval.i_int == PLAYING_S || newval.i_int == PAUSE_S ||
- newval.i_int == END_S )
+ newval.i_int == STOP_S || newval.i_int == END_S )
{
StatusChangeSignal( p_sys->p_conn, (void*) p_intf );
}
static int StatusChangeEmit( vlc_object_t *p_this, const char *psz_var,
vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
+ VLC_UNUSED(p_this); VLC_UNUSED(psz_var);
+ VLC_UNUSED(oldval); VLC_UNUSED(newval);
intf_thread_t *p_intf = p_data;
if( p_intf->b_dead )
return VLC_SUCCESS;
+ UpdateCaps( p_intf, false );
StatusChangeSignal( p_intf->p_sys->p_conn, p_data );
return VLC_SUCCESS;
}
if( p_intf->b_dead )
return VLC_SUCCESS;
- p_sys->b_meta_read = VLC_FALSE;
+ p_sys->b_meta_read = false;
p_playlist = pl_Yield( p_intf );
- PL_LOCK;
p_input = p_playlist->p_input;
if( !p_input )
{
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( p_intf );
return VLC_SUCCESS;
}
vlc_object_yield( p_input );
- PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( p_intf );
p_item = input_GetItem( p_input );
if( !p_item )
if( input_item_IsPreparsed( p_item ) )
{
- p_sys->b_meta_read = VLC_TRUE;
+ p_sys->b_meta_read = true;
TrackChangeSignal( p_sys->p_conn, p_item );
}
return VLC_SUCCESS;
}
+/*****************************************************************************
+ * UpdateCaps: update p_sys->i_caps
+ ****************************************************************************/
+static int UpdateCaps( intf_thread_t* p_intf, bool b_playlist_locked )
+{
+ intf_sys_t* p_sys = p_intf->p_sys;
+ dbus_int32_t i_caps = CAPS_CAN_HAS_TRACKLIST;
+ playlist_t* p_playlist = pl_Yield( p_intf );
+ if( !b_playlist_locked ) PL_LOCK;
+
+ if( p_playlist->current.i_size > 0 )
+ i_caps |= CAPS_CAN_PLAY | CAPS_CAN_GO_PREV | CAPS_CAN_GO_NEXT;
+
+ if( p_playlist->p_input )
+ {
+ /* XXX: if UpdateCaps() is called too early, these are
+ * unconditionnaly true */
+ if( var_GetBool( p_playlist->p_input, "can-pause" ) )
+ i_caps |= CAPS_CAN_PAUSE;
+ if( var_GetBool( p_playlist->p_input, "seekable" ) )
+ i_caps |= CAPS_CAN_SEEK;
+ }
+
+ if( !b_playlist_locked ) PL_UNLOCK;
+ pl_Release( p_intf );
+
+ if( p_sys->b_meta_read )
+ i_caps |= CAPS_CAN_PROVIDE_METADATA;
+
+ if( i_caps != p_intf->p_sys->i_caps )
+ {
+ p_sys->i_caps = i_caps;
+ CapsChangeSignal( p_intf->p_sys->p_conn, (vlc_object_t*)p_intf );
+ }
+
+ return VLC_SUCCESS;
+}
+
/*****************************************************************************
* GetInputMeta: Fill a DBusMessage with the given input item metadata
*****************************************************************************/
"title", "artist", "genre", "copyright", "album", "tracknum",
"description", "rating", "date", "setting", "url", "language",
"nowplaying", "publisher", "encodedby", "arturl", "trackid",
- "status", "URI", "length", "video-codec", "audio-codec",
+ "status", "location", "length", "video-codec", "audio-codec",
"video-bitrate", "audio-bitrate", "audio-samplerate"
};
*****************************************************************************/
static int MarshalStatus( intf_thread_t* p_intf, DBusMessageIter* args,
- vlc_bool_t lock )
+ bool 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 */
playlist_t* p_playlist = NULL;
input_thread_t* p_input = NULL;
- p_playlist = pl_Yield( (vlc_object_t*) p_intf );
+ p_playlist = pl_Yield( p_intf );
if( lock )
PL_LOCK;
i_state = 0;
}
- var_Get( p_playlist, "random", &val );
- i_random = val.i_int;
+ i_random = var_CreateGetBool( p_playlist, "random" );
- var_Get( p_playlist, "repeat", &val );
- i_repeat = val.i_int;
+ i_repeat = var_CreateGetBool( p_playlist, "repeat" );
- var_Get( p_playlist, "loop", &val );
- i_loop = val.i_int;
+ i_loop = var_CreateGetBool( p_playlist, "loop" );
if( lock )
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( p_intf );
dbus_message_iter_open_container( args, DBUS_TYPE_STRUCT, NULL, &status );
dbus_message_iter_append_basic( &status, DBUS_TYPE_INT32, &i_state );