]> git.sesse.net Git - vlc/blobdiff - modules/control/dbus/dbus_tracklist.c
Reorganize the dbus control module code
[vlc] / modules / control / dbus / dbus_tracklist.c
diff --git a/modules/control/dbus/dbus_tracklist.c b/modules/control/dbus/dbus_tracklist.c
new file mode 100644 (file)
index 0000000..a4e6a62
--- /dev/null
@@ -0,0 +1,346 @@
+/*****************************************************************************
+ * dbus-tracklist.c : dbus control module (mpris v1.0) - /TrackList object
+ *****************************************************************************
+ * Copyright © 2006-2008 Rafaël Carré
+ * Copyright © 2007-2010 Mirsal Ennaime
+ * Copyright © 2009-2010 The VideoLAN team
+ * $Id$
+ *
+ * Authors:    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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_playlist.h>
+
+#include <assert.h>
+
+#include "dbus_tracklist.h"
+#include "dbus_common.h"
+
+
+const char* psz_tracklist_introspection_xml =
+"<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
+"\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
+"<node>"
+"  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
+"    <method name=\"Introspect\">\n"
+"      <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
+"    </method>\n"
+"  </interface>\n"
+"  <interface name=\"org.freedesktop.MediaPlayer\">\n"
+"    <method name=\"AddTrack\">\n"
+"      <arg type=\"s\" direction=\"in\" />\n"
+"      <arg type=\"b\" direction=\"in\" />\n"
+"      <arg type=\"i\" direction=\"out\" />\n"
+"    </method>\n"
+"    <method name=\"DelTrack\">\n"
+"      <arg type=\"i\" direction=\"in\" />\n"
+"    </method>\n"
+"    <method name=\"GetMetadata\">\n"
+"      <arg type=\"i\" direction=\"in\" />\n"
+"      <arg type=\"a{sv}\" direction=\"out\" />\n"
+"    </method>\n"
+"    <method name=\"GetCurrentTrack\">\n"
+"      <arg type=\"i\" direction=\"out\" />\n"
+"    </method>\n"
+"    <method name=\"GetLength\">\n"
+"      <arg type=#include <vlc_common.h>\"i\" direction=\"out\" />\n"
+"    </method>\n"
+"    <method name=\"SetLoop\">\n"
+"      <arg type=\"b\" direction=\"in\" />\n"
+"    </method>\n"
+"    <method name=\"SetRandom\">\n"
+"      <arg type=\"b\" direction=\"in\" />\n"
+"    </method>\n"
+"    <signal name=\"TrackListChange\">\n"
+"      <arg type=\"i\" />\n"
+"    </signal>\n"
+"  </interface>\n"
+"</node>\n"
+;
+
+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 );
+
+    char *psz_mrl;
+    dbus_bool_t b_play;
+
+    dbus_message_get_args( p_from, &error,
+            DBUS_TYPE_STRING, &psz_mrl,
+            DBUS_TYPE_BOOLEAN, &b_play,
+            DBUS_TYPE_INVALID );
+
+    if( dbus_error_is_set( &error ) )
+    {
+        msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s",
+                error.message );
+        dbus_error_free( &error );
+        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+    }
+
+    playlist_Add( PL, psz_mrl, NULL, PLAYLIST_APPEND |
+            ( ( b_play == TRUE ) ? PLAYLIST_GO : 0 ) ,
+            PLAYLIST_END, true, false );
+
+    dbus_int32_t i_success = 0;
+    ADD_INT32( &i_success );
+
+    REPLY_SEND;
+}
+
+DBUS_METHOD( GetCurrentTrack )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+
+    playlist_t *p_playlist = PL;
+
+    PL_LOCK;
+    dbus_int32_t i_position = PL->i_current_index;
+    PL_UNLOCK;
+
+    ADD_INT32( &i_position );
+    REPLY_SEND;
+}
+
+DBUS_METHOD( GetMetadata )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+    DBusError error;
+    dbus_error_init( &error );
+
+    dbus_int32_t i_position;
+    playlist_t *p_playlist = PL;
+
+    dbus_message_get_args( p_from, &error,
+           DBUS_TYPE_INT32, &i_position,
+           DBUS_TYPE_INVALID );
+
+    if( dbus_error_is_set( &error ) )
+    {
+        msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s",
+                error.message );
+        dbus_error_free( &error );
+        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+    }
+
+    PL_LOCK;
+    if( i_position < p_playlist->current.i_size )
+    {
+        GetInputMeta( p_playlist->current.p_elems[i_position]->p_input, &args );
+    }
+
+    PL_UNLOCK;
+    REPLY_SEND;
+}
+
+DBUS_METHOD( GetLength )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+    playlist_t *p_playlist = PL;
+
+    PL_LOCK;
+    dbus_int32_t i_elements = PL->current.i_size;
+    PL_UNLOCK;
+
+    ADD_INT32( &i_elements );
+    REPLY_SEND;
+}
+
+DBUS_METHOD( DelTrack )
+{
+    REPLY_INIT;
+
+    DBusError error;
+    dbus_error_init( &error );
+
+    dbus_int32_t i_position;
+    playlist_t *p_playlist = PL;
+
+    dbus_message_get_args( p_from, &error,
+            DBUS_TYPE_INT32, &i_position,
+            DBUS_TYPE_INVALID );
+
+    if( dbus_error_is_set( &error ) )
+    {
+        msg_Err( (vlc_object_t*) p_this, "D-Bus message reading : %s",
+                error.message );
+        dbus_error_free( &error );
+        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+    }
+
+    PL_LOCK;
+    if( i_position < p_playlist->current.i_size )
+    {
+        playlist_DeleteFromInput( p_playlist,
+            p_playlist->current.p_elems[i_position]->p_input,
+            pl_Locked );
+    }
+    PL_UNLOCK;
+
+    REPLY_SEND;
+}
+
+DBUS_METHOD( SetLoop )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+
+    DBusError error;
+    dbus_bool_t b_loop;
+
+    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",
+                error.message );
+        dbus_error_free( &error );
+        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+    }
+
+    var_SetBool( PL, "loop", ( b_loop == TRUE ) );
+
+    REPLY_SEND;
+}
+
+DBUS_METHOD( SetRandom )
+{
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+
+    DBusError error;
+    dbus_bool_t b_random;
+
+    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",
+                error.message );
+        dbus_error_free( &error );
+        return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+    }
+
+    var_SetBool( PL, "random", ( b_random == TRUE ) );
+
+    REPLY_SEND;
+}
+
+/******************************************************************************
+ * TrackListChange: tracklist order / length change signal
+ *****************************************************************************/
+DBUS_SIGNAL( TrackListChangeSignal )
+{ /* emit the new tracklist lengh */
+    SIGNAL_INIT( DBUS_MPRIS_TRACKLIST_INTERFACE,
+                 DBUS_MPRIS_TRACKLIST_PATH,
+                 "TrackListChange");
+
+    OUT_ARGUMENTS;
+
+    playlist_t *p_playlist = ((intf_thread_t*)p_data)->p_sys->p_playlist;
+    PL_LOCK;
+    dbus_int32_t i_elements = p_playlist->current.i_size;
+    PL_UNLOCK;
+
+    ADD_INT32( &i_elements );
+    SIGNAL_SEND;
+}
+
+DBUS_METHOD( handle_introspect_tracklist )
+{
+    VLC_UNUSED(p_this);
+    REPLY_INIT;
+    OUT_ARGUMENTS;
+    ADD_STRING( &psz_tracklist_introspection_xml );
+    REPLY_SEND;
+}
+
+#define METHOD_FUNC( interface, method, function ) \
+    else if( dbus_message_is_method_call( p_from, interface, method ) )\
+        return function( p_conn, p_from, p_this )
+
+DBusHandlerResult
+handle_tracklist ( DBusConnection *p_conn, DBusMessage *p_from, void *p_this )
+{
+    if( dbus_message_is_method_call( p_from,
+                DBUS_INTERFACE_INTROSPECTABLE, "Introspect" ) )
+    return handle_introspect_tracklist( p_conn, p_from, p_this );
+
+    /* here D-Bus method names are associated to an handler */
+
+    METHOD_FUNC( DBUS_MPRIS_TRACKLIST_INTERFACE, "GetMetadata",     GetMetadata );
+    METHOD_FUNC( DBUS_MPRIS_TRACKLIST_INTERFACE, "GetCurrentTrack", GetCurrentTrack );
+    METHOD_FUNC( DBUS_MPRIS_TRACKLIST_INTERFACE, "GetLength",       GetLength );
+    METHOD_FUNC( DBUS_MPRIS_TRACKLIST_INTERFACE, "AddTrack",        AddTrack );
+    METHOD_FUNC( DBUS_MPRIS_TRACKLIST_INTERFACE, "DelTrack",        DelTrack );
+    METHOD_FUNC( DBUS_MPRIS_TRACKLIST_INTERFACE, "SetLoop",         SetLoop );
+    METHOD_FUNC( DBUS_MPRIS_TRACKLIST_INTERFACE, "SetRandom",       SetRandom );
+
+    return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+}
+
+/*****************************************************************************
+ * TrackListChangeEmit: Emits the TrackListChange signal
+ *****************************************************************************/
+/* FIXME: It is not called on tracklist reordering */
+int TrackListChangeEmit( intf_thread_t *p_intf, int signal, int i_node )
+{
+    // "playlist-item-append"
+    if( signal == SIGNAL_PLAYLIST_ITEM_APPEND )
+    {
+        /* don't signal when items are added/removed in p_category */
+        playlist_t *p_playlist = p_intf->p_sys->p_playlist;
+        PL_LOCK;
+        playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_node );
+        assert( p_item );
+        while( p_item->p_parent )
+            p_item = p_item->p_parent;
+        if( p_item == p_playlist->p_root_category )
+        {
+            PL_UNLOCK;
+            return VLC_SUCCESS;
+        }
+        PL_UNLOCK;
+    }
+
+    if( p_intf->p_sys->b_dead )
+        return VLC_SUCCESS;
+
+    UpdateCaps( p_intf );
+    TrackListChangeSignal( p_intf->p_sys->p_conn, p_intf );
+    return VLC_SUCCESS;
+}
+
+#undef METHOD_FUNC