1 /*****************************************************************************
2 * dbus.h : D-Bus control interface
3 *****************************************************************************
4 * Copyright (C) 2006 Rafaël Carré
7 * Authors: Rafaël Carré <funman at videolanorg>
8 * Mirsal ENNAIME <mirsal dot ennaime at gmail dot com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /* DBUS IDENTIFIERS */
27 /* name registered on the session bus */
28 #define VLC_DBUS_SERVICE "org.freedesktop.MediaPlayer"
29 #define VLC_DBUS_INTERFACE "org.freedesktop.MediaPlayer"
30 #define VLC_DBUS_ROOT_PATH "/"
31 #define VLC_DBUS_PLAYER_PATH "/Player"
32 #define VLC_DBUS_TRACKLIST_PATH "/TrackList"
37 #define DBUS_METHOD( method_function ) \
38 static DBusHandlerResult method_function \
39 ( DBusConnection *p_conn, DBusMessage *p_from, void *p_this )
41 #define DBUS_SIGNAL( signal_function ) \
42 static DBusHandlerResult signal_function \
43 ( DBusConnection *p_conn, void *p_data )
46 DBusMessage* p_msg = dbus_message_new_method_return( p_from ); \
47 if( !p_msg ) return DBUS_HANDLER_RESULT_NEED_MEMORY; \
50 if( !dbus_connection_send( p_conn, p_msg, NULL ) ) \
51 return DBUS_HANDLER_RESULT_NEED_MEMORY; \
52 dbus_connection_flush( p_conn ); \
53 dbus_message_unref( p_msg ); \
54 return DBUS_HANDLER_RESULT_HANDLED
56 #define SIGNAL_INIT( signal ) \
57 DBusMessage *p_msg = dbus_message_new_signal( VLC_DBUS_PLAYER_PATH, \
58 VLC_DBUS_INTERFACE, signal ); \
59 if( !p_msg ) return DBUS_HANDLER_RESULT_NEED_MEMORY; \
62 if( !dbus_connection_send( p_conn, p_msg, NULL ) ) \
63 return DBUS_HANDLER_RESULT_NEED_MEMORY; \
64 dbus_message_unref( p_msg ); \
65 dbus_connection_flush( p_conn ); \
66 return DBUS_HANDLER_RESULT_HANDLED
68 #define OUT_ARGUMENTS \
69 DBusMessageIter args; \
70 dbus_message_iter_init_append( p_msg, &args )
72 #define DBUS_ADD( dbus_type, value ) \
73 if( !dbus_message_iter_append_basic( &args, dbus_type, value ) ) \
74 return DBUS_HANDLER_RESULT_NEED_MEMORY
76 #define ADD_STRING( s ) DBUS_ADD( DBUS_TYPE_STRING, s )
77 #define ADD_BOOL( b ) DBUS_ADD( DBUS_TYPE_BOOLEAN, b )
78 #define ADD_INT32( i ) DBUS_ADD( DBUS_TYPE_INT32, i )
79 #define ADD_BYTE( b ) DBUS_ADD( DBUS_TYPE_BYTE, b )
83 p_tested_item = playlist_GetNextLeaf( p_playlist, \
84 p_playlist->p_root_onelevel, p_tested_item, VLC_FALSE, VLC_FALSE );
86 /* XML data to answer org.freedesktop.DBus.Introspectable.Introspect requests */
88 const char* psz_introspection_xml_data_root =
89 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
90 "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
92 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
93 " <method name=\"Introspect\">\n"
94 " <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
97 " <interface name=\"org.freedesktop.MediaPlayer\">\n"
98 " <method name=\"Identity\">\n"
99 " <arg type=\"s\" direction=\"out\" />\n"
105 const char* psz_introspection_xml_data_player =
106 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
107 "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
109 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
110 " <method name=\"Introspect\">\n"
111 " <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
114 " <interface name=\"org.videolan.vlc\">\n"
115 " <method name=\"GetStatus\">\n"
116 " <arg type=\"i\" direction=\"out\" />\n"
118 " <method name=\"Quit\">\n"
120 " <method name=\"Prev\">\n"
122 " <method name=\"Next\">\n"
124 " <method name=\"Stop\">\n"
126 " <method name=\"Play\">\n"
128 " <method name=\"Pause\">\n"
130 " <method name=\"Repeat\">\n"
131 " <arg type=\"b\" direction=\"in\" />\n"
133 " <method name=\"VolumeSet\">\n"
134 " <arg type=\"i\" direction=\"in\" />\n"
136 " <method name=\"VolumeGet\">\n"
137 " <arg type=\"i\" direction=\"out\" />\n"
139 " <method name=\"PositionSet\">\n"
140 " <arg type=\"i\" direction=\"in\" />\n"
142 " <method name=\"PositionGet\">\n"
143 " <arg type=\"i\" direction=\"out\" />\n"
145 " <method name=\"GetMetadata\">\n"
146 " <arg type=\"a{sv}\" direction=\"out\" />\n"
148 " <method name=\"Disconnect\">\n"
154 const char* psz_introspection_xml_data_tracklist =
155 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
156 "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
158 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
159 " <method name=\"Introspect\">\n"
160 " <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
163 " <interface name=\"org.videolan.vlc\">\n"
164 " <method name=\"AddTrack\">\n"
165 " <arg type=\"s\" direction=\"in\" />\n"
166 " <arg type=\"b\" direction=\"in\" />\n"
168 " <method name=\"DelTrack\">\n"
169 " <arg type=\"i\" direction=\"in\" />\n"
171 " <method name=\"GetMetadata\">\n"
172 " <arg type=\"i\" direction=\"in\" />\n"
173 " <arg type=\"a{sv}\" direction=\"out\" />\n"
175 " <method name=\"GetCurrentTrack\">\n"
176 " <arg type=\"i\" direction=\"out\" />\n"
178 " <method name=\"GetLength\">\n"
179 " <arg type=\"i\" direction=\"out\" />\n"
181 " <method name=\"Loop\">\n"
182 " <arg type=\"b\" direction=\"in\" />\n"
184 " <method name=\"Random\">\n"
185 " <arg type=\"b\" direction=\"in\" />\n"
191 #define VLC_DBUS_ROOT_PATH "/"
192 #define VLC_DBUS_PLAYER_PATH "/Player"
193 #define VLC_DBUS_TRACKLIST_PATH "/TrackList"
195 /* Handle messages reception */
196 DBUS_METHOD( handle_root );
197 DBUS_METHOD( handle_player );
198 DBUS_METHOD( handle_tracklist );
200 static DBusObjectPathVTable vlc_dbus_root_vtable = {
201 NULL, handle_root, /* handler function */
202 NULL, NULL, NULL, NULL
205 static DBusObjectPathVTable vlc_dbus_player_vtable = {
206 NULL, handle_player, /* handler function */
207 NULL, NULL, NULL, NULL
210 static DBusObjectPathVTable vlc_dbus_tracklist_vtable = {
211 NULL, handle_tracklist, /* handler function */
212 NULL, NULL, NULL, NULL