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