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_Yield( 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_Yield( p_this );
 140
 141     PL_LOCK;
 142     var_DelCallback( p_playlist, "item-change", ItemChange, p_intf );
 143     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 144     if( p_playlist->p_input )
 145         var_DelCallback( p_playlist->p_input, "state", StateChange, p_intf );
 146     PL_UNLOCK;
 147     pl_Release( p_this );
 148
 149     /* Clears the Presence message ... else it looks like we're still playing
 150      * something although VLC (or the Telepathy plugin) is closed */
 151
 152     /* Do not check for VLC_ENOMEM as we're closing */
 153     SendToTelepathy( p_intf, "" );
 154
 155     /* we won't use the DBus connection anymore */
 156     dbus_connection_unref( p_intf->p_sys->p_conn );
 157
 158     /* Destroy structure */
 159     free( p_intf->p_sys->psz_format );
 160     free( p_intf->p_sys );
 161 }
 162
 163 /*****************************************************************************
 164  * ItemChange: Playlist item change callback
 165  *****************************************************************************/
 166 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 167                        vlc_value_t oldval, vlc_value_t newval, void *param )
 168 {
 169     VLC_UNUSED(oldval);
 170     intf_thread_t *p_intf = (intf_thread_t *)param;
 171     playlist_t* p_playlist = (playlist_t*) p_this;
 172     char *psz_buf = NULL;
 173     input_thread_t *p_input;
 174
 175     /* Don't update Telepathy presence each time an item has been preparsed */
 176     if( !strncmp( "playlist-current", psz_var, 16 ) )
 177     { /* stores the current input item id */
 178         p_intf->p_sys->i_id = newval.i_int;
 179         p_intf->p_sys->i_item_changes = 0;
 180     }
 181     else
 182     {
 183         if( newval.i_int != p_intf->p_sys->i_id ) /* "item-change" */
 184             return VLC_SUCCESS;
 185         /* Some variable bitrate inputs call "item-change callbacks each time
 186          * their length is updated, that is several times per second.
 187          * We'll limit the number of changes to 10 per input. */
 188         if( p_intf->p_sys->i_item_changes > 10 )
 189             return VLC_SUCCESS;
 190         p_intf->p_sys->i_item_changes++;
 191     }
 192
 193     p_input = p_playlist->p_input;
 194
 195     if( !p_input ) return VLC_SUCCESS;
 196     vlc_object_hold( p_input );
 197
 198     if( p_input->b_dead || !input_GetItem(p_input)->psz_name )
 199     {
 200         vlc_object_release( p_input );
 201         /* Not playing anything ... */
 202         switch( SendToTelepathy( p_intf, "" ) )
 203         {
 204             case VLC_ENOMEM:
 205                 return VLC_ENOMEM;
 206             default:
 207                 return VLC_SUCCESS;
 208         }
 209     }
 210
 211     if( !strncmp( "playlist-current", psz_var, 16 ) )
 212         var_AddCallback( p_input, "state", StateChange, p_intf );
 213
 214     /* We format the string to be displayed */
 215     psz_buf = str_format_meta( (vlc_object_t*) p_intf,
 216             p_intf->p_sys->psz_format );
 217
 218     /* We don't need the input anymore */
 219     vlc_object_release( p_input );
 220
 221     if( SendToTelepathy( p_intf, psz_buf ) == VLC_ENOMEM )
 222     {
 223         free( psz_buf );
 224         return VLC_ENOMEM;
 225     }
 226     free( psz_buf );
 227     return VLC_SUCCESS;
 228 }
 229
 230 /*****************************************************************************
 231  * StateChange: State change callback
 232  *****************************************************************************/
 233 static int StateChange( vlc_object_t *p_this, const char *psz_var,
 234                        vlc_value_t oldval, vlc_value_t newval, void *param )
 235 {
 236     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 237     intf_thread_t *p_intf = (intf_thread_t *)param;
 238     if( newval.i_int >= END_S )
 239         return SendToTelepathy( p_intf, "" );
 240     return VLC_SUCCESS;
 241 }
 242
 243 /*****************************************************************************
 244  * SendToTelepathy
 245  *****************************************************************************/
 246 static int SendToTelepathy( intf_thread_t *p_intf, const char *psz_msg )
 247 {
 248     DBusConnection *p_conn;
 249     DBusMessage *p_msg;
 250     DBusMessage *p_reply;
 251     DBusMessageIter args;
 252     DBusError error;
 253     dbus_error_init( &error );
 254     dbus_uint32_t i_status;
 255
 256     p_conn = p_intf->p_sys->p_conn;
 257
 258     /* first we need to get the actual status */
 259     p_msg = dbus_message_new_method_call(
 260             "org.freedesktop.Telepathy.MissionControl",
 261            "/org/freedesktop/Telepathy/MissionControl",
 262             "org.freedesktop.Telepathy.MissionControl",
 263             "GetPresence" );
 264     if( !p_msg )
 265         return VLC_ENOMEM;
 266
 267     p_reply = dbus_connection_send_with_reply_and_block( p_conn, p_msg,
 268         50, &error ); /* blocks 50ms maximum */
 269
 270     dbus_message_unref( p_msg );
 271     if( p_reply == NULL )
 272     {   /* MC is not active, or too slow. Better luck next time? */
 273         return VLC_SUCCESS;
 274     }
 275
 276     /* extract the status from the reply */
 277     if( dbus_message_get_args( p_reply, &error,
 278             DBUS_TYPE_UINT32, &i_status,
 279             DBUS_TYPE_INVALID ) == FALSE )
 280     {
 281         return VLC_ENOMEM;
 282     }
 283
 284     p_msg = dbus_message_new_method_call(
 285             "org.freedesktop.Telepathy.MissionControl",
 286            "/org/freedesktop/Telepathy/MissionControl",
 287             "org.freedesktop.Telepathy.MissionControl",
 288             "SetPresence" );
 289     if( !p_msg )
 290         return VLC_ENOMEM;
 291
 292     dbus_message_iter_init_append( p_msg, &args );
 293
 294     /* first argument is the status */
 295     if( !dbus_message_iter_append_basic( &args, DBUS_TYPE_UINT32, &i_status ) )
 296     {
 297         dbus_message_unref( p_msg );
 298         return VLC_ENOMEM;
 299     }
 300     /* second argument is the message */
 301     if( !dbus_message_iter_append_basic( &args, DBUS_TYPE_STRING, &psz_msg ) )
 302     {
 303         dbus_message_unref( p_msg );
 304         return VLC_ENOMEM;
 305     }
 306
 307
 308     if( !dbus_connection_send( p_conn, p_msg, NULL ) )
 309         return VLC_ENOMEM;
 310
 311     dbus_connection_flush( p_conn );
 312     dbus_message_unref( p_msg );
 313
 314     return VLC_SUCCESS;
 315 }