telepathy: shows an empty status when VLC has been stopped
[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 StateChange( vlc_object_t *, const char *,
55                         vlc_value_t, vlc_value_t, void * );
56 static int SendToTelepathy( intf_thread_t *, const char * );
57
58 /*****************************************************************************
59  * Module descriptor
60  *****************************************************************************/
61 #define FORMAT_DEFAULT "$a - $t"
62 #define FORMAT_TEXT N_("Title format string")
63 #define FORMAT_LONGTEXT N_("Format of the string to send to Telepathy." \
64 "Defaults to \"Artist - Title\" ($a - $t). " \
65 "You can use the following substitutions: " \
66 "$a Artist, $b Album, $c Copyright, $d Description, $e Encoder, $g Genre, " \
67 "$l Language, $n number, $p Now Playing, $r Rating, $s Subtitles language, " \
68 "$t Title, $u URL, $A Date, $B Bitrate, $C Chapter, $D Duration, $F URI, " \
69 "$I Video Title, $L Time Remaining, $N Name, $O Audio language, $P Position, " \
70 "$R Rate, $S Sample rate, $T Time elapsed, $U Publisher, $V Volume")
71
72 vlc_module_begin();
73     set_category( CAT_INTERFACE );
74     set_subcategory( SUBCAT_INTERFACE_CONTROL );
75     set_shortname( "Telepathy" );
76     set_description( _("Telepathy \"Now Playing\" using MissionControl") );
77
78     add_string( "telepathy-format", FORMAT_DEFAULT, NULL,
79                 FORMAT_TEXT, FORMAT_LONGTEXT, VLC_FALSE );
80
81     set_capability( "interface", 0 );
82     set_callbacks( Open, Close );
83 vlc_module_end();
84
85 /*****************************************************************************
86  * Open: initialize and create stuff
87  *****************************************************************************/
88 static int Open( vlc_object_t *p_this )
89 {
90     intf_thread_t *p_intf = (intf_thread_t *)p_this;
91     playlist_t *p_playlist;
92     DBusConnection  *p_conn;
93     DBusError       error;
94
95     MALLOC_ERR( p_intf->p_sys, intf_sys_t );
96
97     /* connect to the session bus */
98     dbus_error_init( &error );
99     p_conn = dbus_bus_get( DBUS_BUS_SESSION, &error );
100     if( !p_conn )
101     {
102         msg_Err( p_this, "Failed to connect to the DBus session daemon: %s",
103                 error.message );
104         dbus_error_free( &error );
105         free( p_intf->p_sys );
106         return VLC_EGENERIC;
107     }
108     p_intf->p_sys->p_conn = p_conn;
109
110     p_intf->p_sys->psz_format = config_GetPsz( p_intf, "telepathy-format" );
111     if( !p_intf->p_sys->psz_format )
112     {
113         msg_Dbg( p_intf, "no format provided" );
114         p_intf->p_sys->psz_format = strdup( FORMAT_DEFAULT );
115     }
116     msg_Dbg( p_intf, "using format: %s", p_intf->p_sys->psz_format );
117
118     p_intf->p_sys->i_id = -1;
119
120     p_playlist = pl_Yield( p_intf );
121     var_AddCallback( p_playlist, "item-change", ItemChange, p_intf );
122     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
123     pl_Release( p_intf );
124
125     return VLC_SUCCESS;
126 }
127
128 /*****************************************************************************
129  * Close: destroy interface stuff
130  *****************************************************************************/
131 static void Close( vlc_object_t *p_this )
132 {
133     p_this->b_dead = VLC_TRUE;
134     intf_thread_t *p_intf = (intf_thread_t *)p_this;
135     playlist_t *p_playlist = pl_Yield( p_this );
136
137     /* Clears the Presence message ... else it looks like we're still playing
138      * something although VLC (or the Telepathy plugin) is closed */
139
140     /* Do not check for VLC_ENOMEM as we're closing */
141     SendToTelepathy( p_intf, "" );
142
143     PL_LOCK;
144     var_DelCallback( p_playlist, "item-change", ItemChange, p_intf );
145     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
146     if( p_playlist->p_input )
147         var_DelCallback( p_playlist->p_input, "state", StateChange, p_intf );
148     PL_UNLOCK;
149     pl_Release( p_this );
150
151     /* we won't use the DBus connection anymore */
152     dbus_connection_unref( p_intf->p_sys->p_conn );
153
154     /* Destroy structure */
155     free( p_intf->p_sys->psz_format );
156     free( p_intf->p_sys );
157 }
158
159 /*****************************************************************************
160  * ItemChange: Playlist item change callback
161  *****************************************************************************/
162 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
163                        vlc_value_t oldval, vlc_value_t newval, void *param )
164 {
165     intf_thread_t *p_intf = (intf_thread_t *)param;
166     char *psz_buf = NULL;
167     input_thread_t *p_input;
168
169     if( p_intf->b_dead )
170         return VLC_EGENERIC;
171
172     /* Don't update Telepathy presence each time an item has been preparsed */
173     if( !strncmp( "playlist-current", psz_var, 16 ) )
174     { /* stores the current input item id */
175         p_intf->p_sys->i_id = newval.i_int;
176         p_intf->p_sys->i_item_changes = 0;
177     }
178     else
179     {
180         if( newval.i_int != p_intf->p_sys->i_id ) /* "item-change" */
181             return VLC_SUCCESS;
182         /* Some variable bitrate inputs call "item-change callbacks each time
183          * their length is updated, that is several times per second.
184          * We'll limit the number of changes to 10 per input. */
185         if( p_intf->p_sys->i_item_changes > 10 )
186             return VLC_SUCCESS;
187         p_intf->p_sys->i_item_changes++;
188     }
189
190
191     playlist_t *p_playlist = pl_Yield( p_this );
192
193     p_input = p_playlist->p_input;
194     pl_Release( p_this );
195
196     if( !p_input ) return VLC_SUCCESS;
197     vlc_object_yield( p_input );
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( p_this, 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     intf_thread_t *p_intf = (intf_thread_t *)param;
237     if( p_intf->b_dead )
238         return VLC_EGENERIC;
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 }