git.sesse.net Git - vlc/blob - modules/control/dbus.h

   1 /*****************************************************************************
   2  * dbus.h : D-Bus control interface
   3  *****************************************************************************
   4  * Copyright (C) 2006 Rafaël Carré
   5  * $Id$
   6  *
   7  * Authors:    Rafaël Carré <funman at videolanorg>
   8  *             Mirsal ENNAIME <mirsal dot ennaime at gmail dot com>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  25 /* DBUS IDENTIFIERS */
  26
  27 /* name registered on the session bus */
  28 #define VLC_MPRIS_DBUS_SERVICE      "org.mpris.vlc"
  29 #define MPRIS_DBUS_INTERFACE        "org.freedesktop.MediaPlayer"
  30 #define MPRIS_DBUS_ROOT_PATH        "/"
  31 #define MPRIS_DBUS_PLAYER_PATH      "/Player"
  32 #define MPRIS_DBUS_TRACKLIST_PATH   "/TrackList"
  33
  34 /* MACROS */
  35
  36 /* DBus related */
  37 #define DBUS_METHOD( method_function ) \
  38     static DBusHandlerResult method_function \
  39             ( DBusConnection *p_conn, DBusMessage *p_from, void *p_this )
  40
  41 #define DBUS_SIGNAL( signal_function ) \
  42     static DBusHandlerResult signal_function \
  43             ( DBusConnection *p_conn, void *p_data )
  44
  45 #define REPLY_INIT \
  46     DBusMessage* p_msg = dbus_message_new_method_return( p_from ); \
  47     if( !p_msg ) return DBUS_HANDLER_RESULT_NEED_MEMORY; \
  48
  49 #define REPLY_SEND \
  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
  55
  56 #define SIGNAL_INIT( signal ) \
  57     DBusMessage *p_msg = dbus_message_new_signal( MPRIS_DBUS_PLAYER_PATH, \
  58         MPRIS_DBUS_INTERFACE, signal ); \
  59     if( !p_msg ) return DBUS_HANDLER_RESULT_NEED_MEMORY; \
  60
  61 #define SIGNAL_SEND \
  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
  67
  68 #define OUT_ARGUMENTS \
  69     DBusMessageIter args; \
  70     dbus_message_iter_init_append( p_msg, &args )
  71
  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
  75
  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 )
  80
  81 /* VLC related */
  82 /* Don't forget to test p_tested_item for NULL on loops */
  83 #define TEST_NEXT_ITEM \
  84     p_tested_item = playlist_GetNextLeaf( p_playlist, \
  85             p_playlist->p_root_onelevel, p_tested_item, VLC_FALSE, VLC_FALSE );
  86
  87 /* XML data to answer org.freedesktop.DBus.Introspectable.Introspect requests */
  88
  89 const char* psz_introspection_xml_data_root =
  90 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
  91 "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
  92 "<node>\n"
  93 "  <node name=\"Player\"/>\n"
  94 "  <node name=\"TrackList\"/>\n"
  95 "  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
  96 "    <method name=\"Introspect\">\n"
  97 "      <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
  98 "    </method>\n"
  99 "  </interface>\n"
 100 "  <interface name=\"org.freedesktop.MediaPlayer\">\n"
 101 "    <method name=\"Identity\">\n"
 102 "      <arg type=\"s\" direction=\"out\" />\n"
 103 "    </method>\n"
 104 "  </interface>\n"
 105 "</node>\n"
 106 ;
 107
 108 const char* psz_introspection_xml_data_player =
 109 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
 110 "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
 111 "<node>"
 112 "  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
 113 "    <method name=\"Introspect\">\n"
 114 "      <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
 115 "    </method>\n"
 116 "  </interface>\n"
 117 "  <interface name=\"org.freedesktop.MediaPlayer\">\n"
 118 "    <method name=\"GetStatus\">\n"
 119 "      <arg type=\"i\" direction=\"out\" />\n"
 120 "    </method>\n"
 121 "    <method name=\"Quit\">\n"
 122 "    </method>\n"
 123 "    <method name=\"Prev\">\n"
 124 "    </method>\n"
 125 "    <method name=\"Next\">\n"
 126 "    </method>\n"
 127 "    <method name=\"Stop\">\n"
 128 "    </method>\n"
 129 "    <method name=\"Play\">\n"
 130 "    </method>\n"
 131 "    <method name=\"Pause\">\n"
 132 "    </method>\n"
 133 "    <method name=\"Repeat\">\n"
 134 "      <arg type=\"b\" direction=\"in\" />\n"
 135 "    </method>\n"
 136 "    <method name=\"VolumeSet\">\n"
 137 "      <arg type=\"i\" direction=\"in\" />\n"
 138 "    </method>\n"
 139 "    <method name=\"VolumeGet\">\n"
 140 "      <arg type=\"i\" direction=\"out\" />\n"
 141 "    </method>\n"
 142 "    <method name=\"PositionSet\">\n"
 143 "      <arg type=\"i\" direction=\"in\" />\n"
 144 "    </method>\n"
 145 "    <method name=\"PositionGet\">\n"
 146 "      <arg type=\"i\" direction=\"out\" />\n"
 147 "    </method>\n"
 148 "    <method name=\"GetMetadata\">\n"
 149 "      <arg type=\"a{sv}\" direction=\"out\" />\n"
 150 "    </method>\n"
 151 "    <signal name=\"TrackChange\">\n"
 152 "      <arg type=\"a{sv}\"/>\n"
 153 "    </signal>\n"
 154 "    <signal name=\"StatusChange\">\n"
 155 "      <arg type=\"i\"/>\n"
 156 "    </signal>\n"
 157 "    <signal name=\"CapsChange\">\n"
 158 "      <arg type=\"i\"/>\n"
 159 "    </signal>\n"
 160 "  </interface>\n"
 161 "</node>\n"
 162 ;
 163
 164 const char* psz_introspection_xml_data_tracklist =
 165 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
 166 "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
 167 "<node>"
 168 "  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
 169 "    <method name=\"Introspect\">\n"
 170 "      <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
 171 "    </method>\n"
 172 "  </interface>\n"
 173 "  <interface name=\"org.freedesktop.MediaPlayer\">\n"
 174 "    <method name=\"AddTrack\">\n"
 175 "      <arg type=\"s\" direction=\"in\" />\n"
 176 "      <arg type=\"b\" direction=\"in\" />\n"
 177 "    </method>\n"
 178 "    <method name=\"DelTrack\">\n"
 179 "      <arg type=\"i\" direction=\"in\" />\n"
 180 "    </method>\n"
 181 "    <method name=\"GetMetadata\">\n"
 182 "      <arg type=\"i\" direction=\"in\" />\n"
 183 "      <arg type=\"a{sv}\" direction=\"out\" />\n"
 184 "    </method>\n"
 185 "    <method name=\"GetCurrentTrack\">\n"
 186 "      <arg type=\"i\" direction=\"out\" />\n"
 187 "    </method>\n"
 188 "    <method name=\"GetLength\">\n"
 189 "      <arg type=\"i\" direction=\"out\" />\n"
 190 "    </method>\n"
 191 "    <method name=\"Loop\">\n"
 192 "      <arg type=\"b\" direction=\"in\" />\n"
 193 "    </method>\n"
 194 "    <method name=\"Random\">\n"
 195 "      <arg type=\"b\" direction=\"in\" />\n"
 196 "    </method>\n"
 197 "  </interface>\n"
 198 "</node>\n"
 199 ;
 200
 201 #define MPRIS_DBUS_ROOT_PATH      "/"
 202 #define MPRIS_DBUS_PLAYER_PATH    "/Player"
 203 #define MPRIS_DBUS_TRACKLIST_PATH "/TrackList"
 204
 205 /* Handle  messages reception */
 206 DBUS_METHOD( handle_root );
 207 DBUS_METHOD( handle_player );
 208 DBUS_METHOD( handle_tracklist );
 209
 210 static DBusObjectPathVTable vlc_dbus_root_vtable = {
 211         NULL, handle_root, /* handler function */
 212         NULL, NULL, NULL, NULL
 213 };
 214
 215 static DBusObjectPathVTable vlc_dbus_player_vtable = {
 216         NULL, handle_player, /* handler function */
 217         NULL, NULL, NULL, NULL
 218 };
 219
 220 static DBusObjectPathVTable vlc_dbus_tracklist_vtable = {
 221         NULL, handle_tracklist, /* handler function */
 222         NULL, NULL, NULL, NULL
 223 };
 224