misc: fix warnings
[vlc.git] / modules / misc / notify / notify.c
1 /*****************************************************************************
2  * notify.c : libnotify notification plugin
3  *****************************************************************************
4  * Copyright (C) 2006-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Christophe Mutricy <xtophe -at- videolan -dot- org>
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 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc/vlc.h>
32 #include <vlc_interface.h>
33 #include <vlc_playlist.h>
34 #include <vlc_meta.h>
35
36 #include <errno.h>
37 #include <gdk-pixbuf/gdk-pixbuf.h>
38 #include <libnotify/notify.h>
39
40 /*****************************************************************************
41  * Local prototypes
42  *****************************************************************************/
43 static int  Open    ( vlc_object_t * );
44 static void Close   ( vlc_object_t * );
45
46 static int ItemChange( vlc_object_t *, const char *,
47                        vlc_value_t, vlc_value_t, void * );
48 static int Notify( vlc_object_t *, const char *, GdkPixbuf *, intf_thread_t * );
49 #define MAX_LENGTH 256
50
51 struct intf_sys_t
52 {
53     NotifyNotification *notification;
54     vlc_mutex_t     lock;
55 };
56
57 /*****************************************************************************
58  * Module descriptor
59  ****************************************************************************/
60
61 #define APPLICATION_NAME "VLC media player"
62
63 #define TIMEOUT_TEXT N_("Timeout (ms)")
64 #define TIMEOUT_LONGTEXT N_("How long the notification will be displayed ")
65
66 vlc_module_begin();
67     set_category( CAT_INTERFACE );
68     set_subcategory( SUBCAT_INTERFACE_CONTROL );
69     set_shortname( _( "Notify" ) );
70     set_description( _("LibNotify Notification Plugin") );
71
72     add_integer( "notify-timeout", 4000,NULL,
73                 TIMEOUT_TEXT, TIMEOUT_LONGTEXT, VLC_TRUE );
74
75     set_capability( "interface", 0 );
76     set_callbacks( Open, Close );
77 vlc_module_end();
78
79 /*****************************************************************************
80  * Open: initialize and create stuff
81  *****************************************************************************/
82 static int Open( vlc_object_t *p_this )
83 {
84     intf_thread_t   *p_intf = (intf_thread_t *)p_this;
85     playlist_t      *p_playlist;
86     intf_sys_t      *p_sys  = malloc( sizeof( intf_sys_t ) );
87
88     if( !p_sys )
89     {
90         msg_Err( p_intf, "Out of memory" );
91         return VLC_ENOMEM;
92     }
93
94     if( !notify_init( APPLICATION_NAME ) )
95     {
96         msg_Err( p_intf, "can't find notification daemon" );
97         return VLC_EGENERIC;
98     }
99
100     vlc_mutex_init( p_this, &p_sys->lock );
101
102     p_intf->p_sys = p_sys;
103
104     p_intf->p_sys->notification = NULL;
105
106     p_playlist = pl_Yield( p_intf );
107     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
108     pl_Release( p_intf );
109
110     return VLC_SUCCESS;
111 }
112
113 /*****************************************************************************
114  * Close: destroy interface stuff
115  *****************************************************************************/
116 static void Close( vlc_object_t *p_this )
117 {
118     intf_thread_t   *p_intf = ( intf_thread_t* ) p_this;
119     intf_sys_t      *p_sys  = p_intf->p_sys;
120
121     playlist_t *p_playlist = pl_Yield( p_this );
122     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_this );
123     pl_Release( p_this );
124
125     if( p_intf->p_sys->notification )
126         g_object_unref( p_intf->p_sys->notification );
127
128     vlc_mutex_destroy( &p_sys->lock );
129     free( p_sys );
130     notify_uninit();
131 }
132
133 /*****************************************************************************
134  * ItemChange: Playlist item change callback
135  *****************************************************************************/
136 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
137                        vlc_value_t oldval, vlc_value_t newval, void *param )
138 {
139     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
140     char                psz_tmp[MAX_LENGTH];
141     char                psz_notify[MAX_LENGTH];
142     char                *psz_title      = NULL;
143     char                *psz_artist     = NULL;
144     char                *psz_album      = NULL;
145     char                *psz_arturl     = NULL;
146     input_thread_t      *p_input        = NULL;
147     playlist_t          * p_playlist    = pl_Yield( p_this );
148     intf_thread_t       *p_intf         = ( intf_thread_t* ) param;
149     intf_sys_t          *p_sys          = p_intf->p_sys;
150
151     p_input = p_playlist->p_input;
152     pl_Release( p_playlist );
153
154     if( !p_input ) return VLC_SUCCESS;
155     vlc_object_yield( p_input );
156
157     if( p_input->b_dead )
158     {
159         /* Not playing anything ... */
160         vlc_object_release( p_input );
161         return VLC_SUCCESS;
162     }
163     /*Wait a tad so the meta has been fetched*/
164     msleep( 1000*4 );
165
166     /* Playing something ... */
167     psz_artist = input_item_GetArtist( input_GetItem( p_input ) );
168     psz_album = input_item_GetAlbum( input_GetItem( p_input ) ) ;
169     psz_title = input_item_GetTitle( input_GetItem( p_input ) );
170     if( ( psz_title == NULL ) || EMPTY_STR( psz_title ) )
171     {
172         free( psz_title );
173         psz_title = input_item_GetName( input_GetItem( p_input ) );
174     }
175     if( ( psz_title == NULL ) || EMPTY_STR( psz_title ) )
176     {  /* Not enough metadata ... */
177         free( psz_title );
178         free( psz_artist );
179         free( psz_album );
180         vlc_object_release( p_input );
181         return VLC_SUCCESS;
182     }
183     if( EMPTY_STR( psz_artist ) )
184     {
185         free( psz_artist );
186         psz_artist = NULL;
187     }
188     if( EMPTY_STR( psz_album ) )
189     {
190         free( psz_album );
191         psz_album = NULL;
192     }
193
194     vlc_object_release( p_input );
195
196     if( psz_artist && psz_album )
197         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s\n[%s]",
198                   psz_title, psz_artist, psz_album );
199     else if( psz_artist )
200         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s",
201                   psz_title, psz_artist );
202     else
203         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>", psz_title );
204
205     free( psz_title );
206     free( psz_artist );
207     free( psz_album );
208
209     GdkPixbuf *pix = NULL;
210     GError *p_error = NULL;
211
212     psz_arturl = input_item_GetArtURL( input_GetItem( p_input ) );
213     if( psz_arturl && !strncmp( psz_arturl, "file://", 7 ) &&
214                 strlen( psz_arturl ) > 7 )
215     { /* scale the art to show it in notify popup */
216         gboolean b = TRUE;
217         pix = gdk_pixbuf_new_from_file_at_scale(
218                 (psz_arturl + 7), 72, 72, b, &p_error );
219         free( psz_arturl );
220     }
221     else /* else we show state-of-the art logo */
222         pix = gdk_pixbuf_new_from_file( DATA_PATH "/vlc48x48.png", &p_error );
223
224     /* we need to replace '&' with '&amp;' because '&' is a keyword of
225      * notification-daemon parser */
226     int i_notify, i_len, i;
227     i_len = strlen( psz_tmp );
228     i_notify = 0;
229     for( i = 0; ( ( i < i_len ) && ( i_notify < ( MAX_LENGTH - 5 ) ) ); i++ )
230     { /* we use MAX_LENGTH - 5 because if the last char of psz_tmp is '&'
231        * we will need 5 more characters: 'amp;\0' .
232        * however that's unlikely to happen because the last char is '\0' */
233         if( psz_tmp[i] != '&' )
234             psz_notify[i_notify] = psz_tmp[i];
235         else
236         {
237             snprintf( psz_notify + i_notify, 6, "&amp;" );
238             i_notify += 4;
239         }
240         i_notify++;
241     }
242     psz_notify[i_notify] = '\0';
243
244     vlc_mutex_lock( &p_sys->lock );
245
246     Notify( p_this, psz_notify, pix, p_intf );
247
248     vlc_mutex_unlock( &p_sys->lock );
249
250     return VLC_SUCCESS;
251 }
252
253 static void Next( NotifyNotification *notification, gchar *psz, gpointer p )
254 { /* libnotify callback, called when the "Next" button is pressed */
255     VLC_UNUSED(psz);
256     notify_notification_close (notification, NULL);
257     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p) );
258     playlist_Next( p_playlist );
259     pl_Release( ((vlc_object_t*) p) );
260 }
261
262 static void Prev( NotifyNotification *notification, gchar *psz, gpointer p )
263 { /* libnotify callback, called when the "Previous" button is pressed */
264     VLC_UNUSED(psz);
265     notify_notification_close (notification, NULL);
266     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p) );
267     playlist_Prev( p_playlist );
268     pl_Release( ((vlc_object_t*) p) );
269 }
270
271 static int Notify( vlc_object_t *p_this, const char *psz_temp, GdkPixbuf *pix,
272                    intf_thread_t *p_intf )
273 {
274     NotifyNotification * notification;
275     GError *p_error = NULL;
276
277     /* Close previous notification if still active */
278     if( p_intf->p_sys->notification )
279     {
280         notify_notification_close( p_intf->p_sys->notification, &p_error );
281         g_object_unref( p_intf->p_sys->notification );
282     }
283
284     notification = notify_notification_new( _("Now Playing"),
285             psz_temp, NULL, NULL);
286     notify_notification_set_timeout( notification,
287                                      config_GetInt(p_this, "notify-timeout") );
288     notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
289     if( pix )
290     {
291         notify_notification_set_icon_from_pixbuf( notification, pix );
292         gdk_pixbuf_unref( pix );
293     }
294
295     /* Adds previous and next buttons in the notification */
296     notify_notification_add_action( notification, "previous", _("Previous"), Prev,
297                                     (gpointer*) p_intf, NULL );
298     notify_notification_add_action( notification, "next", _("Next"), Next,
299                                     (gpointer*) p_intf, NULL );
300
301     notify_notification_show( notification, NULL);
302
303     /* Stores the notification to be able to close it */
304     p_intf->p_sys->notification = notification;
305     return VLC_SUCCESS;
306 }
307