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