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 /* MPRIS VERSION */
  26 #define VLC_MPRIS_VERSION_MAJOR     1
  27 #define VLC_MPRIS_VERSION_MINOR     0
  28
  29 /* DBUS IDENTIFIERS */
  30
  31 /* name registered on the session bus */
  32 #define VLC_MPRIS_DBUS_SERVICE      "org.mpris.vlc"
  33 #define MPRIS_DBUS_INTERFACE        "org.freedesktop.MediaPlayer"
  34 #define MPRIS_DBUS_ROOT_PATH        "/"
  35 #define MPRIS_DBUS_PLAYER_PATH      "/Player"
  36 #define MPRIS_DBUS_TRACKLIST_PATH   "/TrackList"
  37
  38 /* MACROS */
  39
  40 #define DBUS_METHOD( method_function ) \
  41     static DBusHandlerResult method_function \
  42             ( DBusConnection *p_conn, DBusMessage *p_from, void *p_this )
  43
  44 #define DBUS_SIGNAL( signal_function ) \
  45     static DBusHandlerResult signal_function \
  46             ( DBusConnection *p_conn, void *p_data )
  47
  48 #define REPLY_INIT \
  49     DBusMessage* p_msg = dbus_message_new_method_return( p_from ); \
  50     if( !p_msg ) return DBUS_HANDLER_RESULT_NEED_MEMORY; \
  51
  52 #define REPLY_SEND \
  53     if( !dbus_connection_send( p_conn, p_msg, NULL ) ) \
  54         return DBUS_HANDLER_RESULT_NEED_MEMORY; \
  55     dbus_connection_flush( p_conn ); \
  56     dbus_message_unref( p_msg ); \
  57     return DBUS_HANDLER_RESULT_HANDLED
  58
  59 #define SIGNAL_INIT( signal ) \
  60     DBusMessage *p_msg = dbus_message_new_signal( MPRIS_DBUS_PLAYER_PATH, \
  61         MPRIS_DBUS_INTERFACE, signal ); \
  62     if( !p_msg ) return DBUS_HANDLER_RESULT_NEED_MEMORY; \
  63
  64 #define SIGNAL_SEND \
  65     if( !dbus_connection_send( p_conn, p_msg, NULL ) ) \
  66         return DBUS_HANDLER_RESULT_NEED_MEMORY; \
  67     dbus_message_unref( p_msg ); \
  68     dbus_connection_flush( p_conn ); \
  69     return DBUS_HANDLER_RESULT_HANDLED
  70
  71 #define OUT_ARGUMENTS \
  72     DBusMessageIter args; \
  73     dbus_message_iter_init_append( p_msg, &args )
  74
  75 #define DBUS_ADD( dbus_type, value ) \
  76     if( !dbus_message_iter_append_basic( &args, dbus_type, value ) ) \
  77         return DBUS_HANDLER_RESULT_NEED_MEMORY
  78
  79 #define ADD_STRING( s ) DBUS_ADD( DBUS_TYPE_STRING, s )
  80 #define ADD_BOOL( b ) DBUS_ADD( DBUS_TYPE_BOOLEAN, b )
  81 #define ADD_INT32( i ) DBUS_ADD( DBUS_TYPE_INT32, i )
  82 #define ADD_BYTE( b ) DBUS_ADD( DBUS_TYPE_BYTE, b )
  83
  84 /* XML data to answer org.freedesktop.DBus.Introspectable.Introspect requests */
  85
  86 const char* psz_introspection_xml_data_root =
  87 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
  88 "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
  89 "<node>\n"
  90 "  <node name=\"Player\"/>\n"
  91 "  <node name=\"TrackList\"/>\n"
  92 "  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
  93 "    <method name=\"Introspect\">\n"
  94 "      <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
  95 "    </method>\n"
  96 "  </interface>\n"
  97 "  <interface name=\"org.freedesktop.MediaPlayer\">\n"
  98 "    <method name=\"Identity\">\n"
  99 "      <arg type=\"s\" direction=\"out\" />\n"
 100 "    </method>\n"
 101 "    <method name=\"MprisVersion\">\n"
 102 "      <arg type=\"(qq)\" 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=\"(iiii)\" 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 "    <method name=\"GetCaps\">\n"
 152 "      <arg type=\"i\" direction=\"out\" />\n"
 153 "    </method>\n"
 154 "    <signal name=\"TrackChange\">\n"
 155 "      <arg type=\"a{sv}\"/>\n"
 156 "    </signal>\n"
 157 "    <signal name=\"StatusChange\">\n"
 158 "      <arg type=\"(iiii)\"/>\n"
 159 "    </signal>\n"
 160 "    <signal name=\"CapsChange\">\n"
 161 "      <arg type=\"i\"/>\n"
 162 "    </signal>\n"
 163 "  </interface>\n"
 164 "</node>\n"
 165 ;
 166
 167 const char* psz_introspection_xml_data_tracklist =
 168 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
 169 "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
 170 "<node>"
 171 "  <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
 172 "    <method name=\"Introspect\">\n"
 173 "      <arg name=\"data\" direction=\"out\" type=\"s\"/>\n"
 174 "    </method>\n"
 175 "  </interface>\n"
 176 "  <interface name=\"org.freedesktop.MediaPlayer\">\n"
 177 "    <method name=\"AddTrack\">\n"
 178 "      <arg type=\"s\" direction=\"in\" />\n"
 179 "      <arg type=\"b\" direction=\"in\" />\n"
 180 "    </method>\n"
 181 "    <method name=\"DelTrack\">\n"
 182 "      <arg type=\"i\" direction=\"in\" />\n"
 183 "    </method>\n"
 184 "    <method name=\"GetMetadata\">\n"
 185 "      <arg type=\"i\" direction=\"in\" />\n"
 186 "      <arg type=\"a{sv}\" direction=\"out\" />\n"
 187 "    </method>\n"
 188 "    <method name=\"GetCurrentTrack\">\n"
 189 "      <arg type=\"i\" direction=\"out\" />\n"
 190 "    </method>\n"
 191 "    <method name=\"GetLength\">\n"
 192 "      <arg type=\"i\" direction=\"out\" />\n"
 193 "    </method>\n"
 194 "    <method name=\"SetLoop\">\n"
 195 "      <arg type=\"b\" direction=\"in\" />\n"
 196 "    </method>\n"
 197 "    <method name=\"SetRandom\">\n"
 198 "      <arg type=\"b\" direction=\"in\" />\n"
 199 "    </method>\n"
 200 "    <signal name=\"TrackListChange\">\n"
 201 "      <arg type=\"i\" />\n"
 202 "    </signal>\n"
 203 "  </interface>\n"
 204 "</node>\n"
 205 ;
 206
 207 #define MPRIS_DBUS_ROOT_PATH      "/"
 208 #define MPRIS_DBUS_PLAYER_PATH    "/Player"
 209 #define MPRIS_DBUS_TRACKLIST_PATH "/TrackList"
 210
 211 /* Handle  messages reception */
 212 DBUS_METHOD( handle_root );
 213 DBUS_METHOD( handle_player );
 214 DBUS_METHOD( handle_tracklist );
 215
 216 static DBusObjectPathVTable vlc_dbus_root_vtable = {
 217         NULL, handle_root, /* handler function */
 218         NULL, NULL, NULL, NULL
 219 };
 220
 221 static DBusObjectPathVTable vlc_dbus_player_vtable = {
 222         NULL, handle_player, /* handler function */
 223         NULL, NULL, NULL, NULL
 224 };
 225
 226 static DBusObjectPathVTable vlc_dbus_tracklist_vtable = {
 227         NULL, handle_tracklist, /* handler function */
 228         NULL, NULL, NULL, NULL
 229 };
 230