git.sesse.net Git - vlc/blob - modules/misc/notify/telepathy.c

   1 /*****************************************************************************
   2  * telepathy.c : changes Telepathy Presence information using MissionControl
   3  *****************************************************************************
   4  * Copyright © 2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Author: Rafaël Carré <funman@videoanorg>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_interface.h>
  35 #include <vlc_meta.h>
  36 #include <vlc_playlist.h>
  37 #include <vlc_strings.h>
  38 #include <dbus/dbus.h>
  39
  40 /*****************************************************************************
  41  * intf_sys_t: description and status of log interface
  42  *****************************************************************************/
  43 struct intf_sys_t
  44 {
  45     char            *psz_format;
  46     DBusConnection  *p_conn;
  47     int             i_id;
  48     int             i_item_changes;
  49 };
  50
  51 /*****************************************************************************
  52  * Local prototypes
  53  *****************************************************************************/
  54 static int  Open    ( vlc_object_t * );
  55 static void Close   ( vlc_object_t * );
  56
  57 static int ItemChange( vlc_object_t *, const char *,
  58                        vlc_value_t, vlc_value_t, void * );
  59 static int StateChange( vlc_object_t *, const char *,
  60                         vlc_value_t, vlc_value_t, void * );
  61 static int SendToTelepathy( intf_thread_t *, const char * );
  62
  63 /*****************************************************************************
  64  * Module descriptor
  65  *****************************************************************************/
  66 #define FORMAT_DEFAULT "$a - $t"
  67 #define FORMAT_TEXT N_("Title format string")
  68 #define FORMAT_LONGTEXT N_("Format of the string to send to Telepathy." \
  69 "Defaults to \"Artist - Title\" ($a - $t). " \
  70 "You can use the following substitutions: " \
  71 "$a Artist, $b Album, $c Copyright, $d Description, $e Encoder, $g Genre, " \
  72 "$l Language, $n number, $p Now Playing, $r Rating, $s Subtitles language, " \
  73 "$t Title, $u URL, $A Date, $B Bitrate, $C Chapter, $D Duration, $F URI, " \
  74 "$I Video Title, $L Time Remaining, $N Name, $O Audio language, $P Position, " \
  75 "$R Rate, $S Sample rate, $T Time elapsed, $U Publisher, $V Volume")
  76
  77 vlc_module_begin ()
  78     set_category( CAT_INTERFACE )
  79     set_subcategory( SUBCAT_INTERFACE_CONTROL )
  80     set_shortname( "Telepathy" )
  81     set_description( N_("Telepathy \"Now Playing\" using MissionControl") )
  82
  83     add_string( "telepathy-format", FORMAT_DEFAULT, NULL,
  84                 FORMAT_TEXT, FORMAT_LONGTEXT, false );
  85
  86     set_capability( "interface", 0 )
  87     set_callbacks( Open, Close )
  88 vlc_module_end ()
  89
  90 /*****************************************************************************
  91  * Open: initialize and create stuff
  92  *****************************************************************************/
  93 static int Open( vlc_object_t *p_this )
  94 {
  95     intf_thread_t *p_intf = (intf_thread_t *)p_this;
  96     playlist_t *p_playlist;
  97     DBusConnection  *p_conn;
  98     DBusError       error;
  99
 100     MALLOC_ERR( p_intf->p_sys, intf_sys_t );
 101
 102     /* connect to the session bus */
 103     dbus_error_init( &error );
 104     p_conn = dbus_bus_get( DBUS_BUS_SESSION, &error );
 105     if( !p_conn )
 106     {
 107         msg_Err( p_this, "Failed to connect to the DBus session daemon: %s",
 108                 error.message );
 109         dbus_error_free( &error );
 110         free( p_intf->p_sys );
 111         return VLC_EGENERIC;
 112     }
 113     p_intf->p_sys->p_conn = p_conn;
 114
 115     p_intf->p_sys->psz_format = config_GetPsz( p_intf, "telepathy-format" );
 116     if( !p_intf->p_sys->psz_format )
 117     {
 118         msg_Dbg( p_intf, "no format provided" );
 119         p_intf->p_sys->psz_format = strdup( FORMAT_DEFAULT );
 120     }
 121     msg_Dbg( p_intf, "using format: %s", p_intf->p_sys->psz_format );
 122
 123     p_intf->p_sys->i_id = -1;
 124
 125     p_playlist = pl_Hold( p_intf );
 126     var_AddCallback( p_playlist, "item-change", ItemChange, p_intf );
 127     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 128     pl_Release( p_intf );
 129
 130     return VLC_SUCCESS;
 131 }
 132
 133 /*****************************************************************************
 134  * Close: destroy interface stuff
 135  *****************************************************************************/
 136 static void Close( vlc_object_t *p_this )
 137 {
 138     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 139     playlist_t *p_playlist = pl_Hold( p_this );
 140     input_thread_t *p_input = NULL;
 141
 142     var_DelCallback( p_playlist, "item-change", ItemChange, p_intf );
 143     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 144     if( (p_input = playlist_CurrentInput( p_playlist )) )
 145     {
 146         var_DelCallback( p_input, "state", StateChange, p_intf );
 147         vlc_object_release( p_input );
 148     }
 149     pl_Release( p_this );
 150
 151     /* Clears the Presence message ... else it looks like we're still playing
 152      * something although VLC (or the Telepathy plugin) is closed */
 153
 154     /* Do not check for VLC_ENOMEM as we're closing */
 155     SendToTelepathy( p_intf, "" );
 156
 157     /* we won't use the DBus connection anymore */
 158     dbus_connection_unref( p_intf->p_sys->p_conn );
 159
 160     /* Destroy structure */
 161     free( p_intf->p_sys->psz_format );
 162     free( p_intf->p_sys );
 163 }
 164
 165 /*****************************************************************************
 166  * ItemChange: Playlist item change callback
 167  *****************************************************************************/
 168 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 169                        vlc_value_t oldval, vlc_value_t newval, void *param )
 170 {
 171     VLC_UNUSED(oldval);
 172     intf_thread_t *p_intf = (intf_thread_t *)param;
 173     playlist_t* p_playlist = (playlist_t*) p_this;
 174     char *psz_buf = NULL;
 175     input_thread_t *p_input;
 176
 177     /* Don't update Telepathy presence each time an item has been preparsed */
 178     if( !strncmp( "playlist-current", psz_var, 16 ) )
 179     { /* stores the current input item id */
 180         p_intf->p_sys->i_id = newval.i_int;
 181         p_intf->p_sys->i_item_changes = 0;
 182     }
 183     else
 184     {
 185         if( newval.i_int != p_intf->p_sys->i_id ) /* "item-change" */
 186             return VLC_SUCCESS;
 187         /* Some variable bitrate inputs call "item-change callbacks each time
 188          * their length is updated, that is several times per second.
 189          * We'll limit the number of changes to 10 per input. */
 190         if( p_intf->p_sys->i_item_changes > 10 )
 191             return VLC_SUCCESS;
 192         p_intf->p_sys->i_item_changes++;
 193     }
 194
 195     p_input = playlist_CurrentInput( p_playlist );
 196
 197     if( !p_input ) return VLC_SUCCESS;
 198
 199     if( p_input->b_dead || !input_GetItem(p_input)->psz_name )
 200     {
 201         vlc_object_release( p_input );
 202         /* Not playing anything ... */
 203         switch( SendToTelepathy( p_intf, "" ) )
 204         {
 205             case VLC_ENOMEM:
 206                 return VLC_ENOMEM;
 207             default:
 208                 return VLC_SUCCESS;
 209         }
 210     }
 211
 212     if( !strncmp( "playlist-current", psz_var, 16 ) )
 213         var_AddCallback( p_input, "state", StateChange, p_intf );
 214
 215     /* We format the string to be displayed */
 216     psz_buf = str_format_meta( (vlc_object_t*) p_intf,
 217             p_intf->p_sys->psz_format );
 218
 219     /* We don't need the input anymore */
 220     vlc_object_release( p_input );
 221
 222     if( SendToTelepathy( p_intf, psz_buf ) == VLC_ENOMEM )
 223     {
 224         free( psz_buf );
 225         return VLC_ENOMEM;
 226     }
 227     free( psz_buf );
 228     return VLC_SUCCESS;
 229 }
 230
 231 /*****************************************************************************
 232  * StateChange: State change callback
 233  *****************************************************************************/
 234 static int StateChange( vlc_object_t *p_this, const char *psz_var,
 235                        vlc_value_t oldval, vlc_value_t newval, void *param )
 236 {
 237     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 238     intf_thread_t *p_intf = (intf_thread_t *)param;
 239     if( newval.i_int >= END_S )
 240         return SendToTelepathy( p_intf, "" );
 241     return VLC_SUCCESS;
 242 }
 243
 244 /*****************************************************************************
 245  * SendToTelepathy
 246  *****************************************************************************/
 247 static int SendToTelepathy( intf_thread_t *p_intf, const char *psz_msg )
 248 {
 249     DBusConnection *p_conn;
 250     DBusMessage *p_msg;
 251     DBusMessage *p_reply;
 252     DBusMessageIter args;
 253     DBusError error;
 254     dbus_error_init( &error );
 255     dbus_uint32_t i_status;
 256
 257     p_conn = p_intf->p_sys->p_conn;
 258
 259     /* first we need to get the actual status */
 260     p_msg = dbus_message_new_method_call(
 261             "org.freedesktop.Telepathy.MissionControl",
 262            "/org/freedesktop/Telepathy/MissionControl",
 263             "org.freedesktop.Telepathy.MissionControl",
 264             "GetPresence" );
 265     if( !p_msg )
 266         return VLC_ENOMEM;
 267
 268     p_reply = dbus_connection_send_with_reply_and_block( p_conn, p_msg,
 269         50, &error ); /* blocks 50ms maximum */
 270
 271     dbus_message_unref( p_msg );
 272     if( p_reply == NULL )
 273     {   /* MC is not active, or too slow. Better luck next time? */
 274         return VLC_SUCCESS;
 275     }
 276
 277     /* extract the status from the reply */
 278     if( dbus_message_get_args( p_reply, &error,
 279             DBUS_TYPE_UINT32, &i_status,
 280             DBUS_TYPE_INVALID ) == FALSE )
 281     {
 282         return VLC_ENOMEM;
 283     }
 284
 285     p_msg = dbus_message_new_method_call(
 286             "org.freedesktop.Telepathy.MissionControl",
 287            "/org/freedesktop/Telepathy/MissionControl",
 288             "org.freedesktop.Telepathy.MissionControl",
 289             "SetPresence" );
 290     if( !p_msg )
 291         return VLC_ENOMEM;
 292
 293     dbus_message_iter_init_append( p_msg, &args );
 294
 295     /* first argument is the status */
 296     if( !dbus_message_iter_append_basic( &args, DBUS_TYPE_UINT32, &i_status ) )
 297     {
 298         dbus_message_unref( p_msg );
 299         return VLC_ENOMEM;
 300     }
 301     /* second argument is the message */
 302     if( !dbus_message_iter_append_basic( &args, DBUS_TYPE_STRING, &psz_msg ) )
 303     {
 304         dbus_message_unref( p_msg );
 305         return VLC_ENOMEM;
 306     }
 307
 308
 309     if( !dbus_connection_send( p_conn, p_msg, NULL ) )
 310         return VLC_ENOMEM;
 311
 312     dbus_connection_flush( p_conn );
 313     dbus_message_unref( p_msg );
 314
 315     return VLC_SUCCESS;
 316 }