a8e5886dfbb7b593284b7011823ed07fc829649e
[vlc.git] / 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 #include <vlc/vlc.h>
29 #include <vlc_interface.h>
30 #include <vlc_meta.h>
31 #include <vlc_playlist.h>
32 #include <vlc_strings.h>
33 #include <dbus/dbus.h>
34
35 /*****************************************************************************
36  * intf_sys_t: description and status of log interface
37  *****************************************************************************/
38 struct intf_sys_t
39 {
40     char            *psz_format;
41     DBusConnection  *p_conn;
42     int             i_id;
43     int             i_item_changes;
44 };
45
46 /*****************************************************************************
47  * Local prototypes
48  *****************************************************************************/
49 static int  Open    ( vlc_object_t * );
50 static void Close   ( vlc_object_t * );
51
52 static int ItemChange( vlc_object_t *, const char *,
53                        vlc_value_t, vlc_value_t, void * );
54 static int SendToTelepathy( intf_thread_t *, const char * );
55
56 /*****************************************************************************
57  * Module descriptor
58  *****************************************************************************/
59 #define FORMAT_DEFAULT "$a - $t"
60 #define FORMAT_TEXT N_("Title format string")
61 #define FORMAT_LONGTEXT N_("Format of the string to send to Telepathy." \
62 "Defaults to \"Artist - Title\" ($a - $t). " \
63 "You can use the following substitutions: " \
64 "$a Artist, $b Album, $c Copyright, $d Description, $e Encoder, $g Genre, " \
65 "$l Language, $n number, $p Now Playing, $r Rating, $s Subtitles language, " \
66 "$t Title, $u URL, $A Date, $B Bitrate, $C Chapter, $D Duration, $F URI, " \
67 "$I Video Title, $L Time Remaining, $N Name, $O Audio language, $P Position, " \
68 "$R Rate, $S Sample rate, $T Time elapsed, $U Publisher, $V Volume")
69
70 vlc_module_begin();
71     set_category( CAT_INTERFACE );
72     set_subcategory( SUBCAT_INTERFACE_CONTROL );
73     set_shortname( "Telepathy" );
74     set_description( _("Telepathy \"Now Playing\" using MissionControl") );
75
76     add_string( "telepathy-format", FORMAT_DEFAULT, NULL,
77                 FORMAT_TEXT, FORMAT_LONGTEXT, VLC_FALSE );
78
79     set_capability( "interface", 0 );
80     set_callbacks( Open, Close );
81 vlc_module_end();
82
83 /*****************************************************************************
84  * Open: initialize and create stuff
85  *****************************************************************************/
86 static int Open( vlc_object_t *p_this )
87 {
88     intf_thread_t *p_intf = (intf_thread_t *)p_this;
89     playlist_t *p_playlist;
90     DBusConnection  *p_conn;
91     DBusError       error;
92
93     MALLOC_ERR( p_intf->p_sys, intf_sys_t );
94
95     /* connect to the session bus */
96     dbus_error_init( &error );
97     p_conn = dbus_bus_get( DBUS_BUS_SESSION, &error );
98     if( !p_conn )
99     {
100         msg_Err( p_this, "Failed to connect to the DBus session daemon: %s",
101                 error.message );
102         dbus_error_free( &error );
103         free( p_intf->p_sys );
104         return VLC_EGENERIC;
105     }
106     p_intf->p_sys->p_conn = p_conn;
107
108     p_intf->p_sys->psz_format = config_GetPsz( p_intf, "telepathy-format" );
109     if( !p_intf->p_sys->psz_format )
110     {
111         msg_Dbg( p_intf, "no format provided" );
112         p_intf->p_sys->psz_format = strdup( FORMAT_DEFAULT );
113     }
114     msg_Dbg( p_intf, "using format: %s", p_intf->p_sys->psz_format );
115
116     p_intf->p_sys->i_id = -1;
117
118     p_playlist = pl_Yield( p_intf );
119     var_AddCallback( p_playlist, "item-change", ItemChange, p_intf );
120     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
121     pl_Release( p_intf );
122
123     return VLC_SUCCESS;
124 }
125
126 /*****************************************************************************
127  * Close: destroy interface stuff
128  *****************************************************************************/
129 static void Close( vlc_object_t *p_this )
130 {
131     intf_thread_t *p_intf = (intf_thread_t *)p_this;
132     playlist_t *p_playlist = pl_Yield( p_this );
133
134     /* Clears the Presence message ... else it looks like we're still playing
135      * something although VLC (or the Telepathy plugin) is closed */
136
137     /* Do not check for VLC_ENOMEM as we're closing */
138     SendToTelepathy( p_intf, "" );
139
140     var_DelCallback( p_playlist, "item-change", ItemChange, p_intf );
141     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
142     pl_Release( p_this );
143
144     /* we won't use the DBus connection anymore */
145     dbus_connection_unref( p_intf->p_sys->p_conn );
146
147     /* Destroy structure */
148     free( p_intf->p_sys->psz_format );
149     free( p_intf->p_sys );
150 }
151
152 /*****************************************************************************
153  * ItemChange: Playlist item change callback
154  *****************************************************************************/
155 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
156                        vlc_value_t oldval, vlc_value_t newval, void *param )
157 {
158     intf_thread_t *p_intf = (intf_thread_t *)param;
159     char *psz_buf = NULL;
160     input_thread_t *p_input;
161
162     /* Don't update Telepathy presence each time an item has been preparsed */
163     if( !strncmp( "playlist-current", psz_var, 16 ) )
164     { /* stores the current input item id */
165         p_intf->p_sys->i_id = newval.i_int;
166         p_intf->p_sys->i_item_changes = 0;
167     }
168     else
169     {
170         if( newval.i_int != p_intf->p_sys->i_id ) /* "item-change" */
171             return VLC_SUCCESS;
172         /* Some variable bitrate inputs call "item-change callbacks each time
173          * their length is updated, that is several times per second.
174          * We'll limit the number of changes to 10 per input. */
175         if( p_intf->p_sys->i_item_changes > 10 )
176             return VLC_SUCCESS;
177         p_intf->p_sys->i_item_changes++;
178     }
179
180
181     playlist_t *p_playlist = pl_Yield( p_this );
182
183     p_input = p_playlist->p_input;
184     pl_Release( p_this );
185
186     if( !p_input ) return VLC_SUCCESS;
187     vlc_object_yield( p_input );
188
189     if( p_input->b_dead || !input_GetItem(p_input)->psz_name )
190     {
191         vlc_object_release( p_input );
192         /* Not playing anything ... */
193         switch( SendToTelepathy( p_intf, "" ) )
194         {
195             case VLC_ENOMEM:
196                 return VLC_ENOMEM;
197             default:
198                 return VLC_SUCCESS;
199         }
200     }
201
202     /* We format the string to be displayed */
203     psz_buf = str_format_meta( p_this, p_intf->p_sys->psz_format );
204     /* We don't need the input anymore */
205     vlc_object_release( p_input );
206
207     if( SendToTelepathy( p_intf, psz_buf ) == VLC_ENOMEM )
208     {
209         free( psz_buf );
210         return VLC_ENOMEM;
211     }
212     free( psz_buf );
213     return VLC_SUCCESS;
214 }
215
216 /*****************************************************************************
217  * SendToTelepathy
218  *****************************************************************************/
219 static int SendToTelepathy( intf_thread_t *p_intf, const char *psz_msg )
220 {
221     DBusConnection *p_conn;
222     DBusMessage *p_msg;
223     DBusMessage *p_reply;
224     DBusMessageIter args;
225     DBusError error;
226     dbus_error_init( &error );
227     dbus_uint32_t i_status;
228
229     p_conn = p_intf->p_sys->p_conn;
230
231     /* first we need to get the actual status */
232     p_msg = dbus_message_new_method_call(
233             "org.freedesktop.Telepathy.MissionControl",
234            "/org/freedesktop/Telepathy/MissionControl",
235             "org.freedesktop.Telepathy.MissionControl",
236             "GetPresence" );
237     if( !p_msg )
238         return VLC_ENOMEM;
239
240     p_reply = dbus_connection_send_with_reply_and_block( p_conn, p_msg,
241         50, &error ); /* blocks 50ms maximum */
242
243     dbus_message_unref( p_msg );
244     if( p_reply == NULL )
245     {   /* MC is not active, or too slow. Better luck next time? */
246         return VLC_SUCCESS;
247     }
248
249     /* extract the status from the reply */
250     if( dbus_message_get_args( p_reply, &error,
251             DBUS_TYPE_UINT32, &i_status,
252             DBUS_TYPE_INVALID ) == FALSE )
253     {
254         return VLC_ENOMEM;
255     }
256
257     p_msg = dbus_message_new_method_call(
258             "org.freedesktop.Telepathy.MissionControl",
259            "/org/freedesktop/Telepathy/MissionControl",
260             "org.freedesktop.Telepathy.MissionControl",
261             "SetPresence" );
262     if( !p_msg )
263         return VLC_ENOMEM;
264
265     dbus_message_iter_init_append( p_msg, &args );
266
267     /* first argument is the status */
268     if( !dbus_message_iter_append_basic( &args, DBUS_TYPE_UINT32, &i_status ) )
269     {
270         dbus_message_unref( p_msg );
271         return VLC_ENOMEM;
272     }
273     /* second argument is the message */
274     if( !dbus_message_iter_append_basic( &args, DBUS_TYPE_STRING, &psz_msg ) )
275     {
276         dbus_message_unref( p_msg );
277         return VLC_ENOMEM;
278     }
279
280
281     if( !dbus_connection_send( p_conn, p_msg, NULL ) )
282         return VLC_ENOMEM;
283
284     dbus_connection_flush( p_conn );
285     dbus_message_unref( p_msg );
286
287     return VLC_SUCCESS;
288 }