1 /*****************************************************************************
2 * notify.c : libnotify notification plugin
3 *****************************************************************************
4 * Copyright (C) 2006-2009 the VideoLAN team
7 * Authors: Christophe Mutricy <xtophe -at- videolan -dot- org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_interface.h>
34 #include <vlc_playlist.h>
36 #include <gdk-pixbuf/gdk-pixbuf.h>
37 #include <libnotify/notify.h>
39 /*****************************************************************************
41 ****************************************************************************/
42 static int Open ( vlc_object_t * );
43 static void Close ( vlc_object_t * );
45 #define APPLICATION_NAME "VLC media player"
47 #define TIMEOUT_TEXT N_("Timeout (ms)")
48 #define TIMEOUT_LONGTEXT N_("How long the notification will be displayed ")
51 set_category( CAT_INTERFACE )
52 set_subcategory( SUBCAT_INTERFACE_CONTROL )
53 set_shortname( N_( "Notify" ) )
54 set_description( N_("LibNotify Notification Plugin") )
56 add_integer( "notify-timeout", 4000, NULL,
57 TIMEOUT_TEXT, TIMEOUT_LONGTEXT, true )
59 set_capability( "interface", 0 )
60 set_callbacks( Open, Close )
64 /*****************************************************************************
66 *****************************************************************************/
67 static int ItemChange( vlc_object_t *, const char *,
68 vlc_value_t, vlc_value_t, void * );
69 static int Notify( vlc_object_t *, const char *, GdkPixbuf *, intf_thread_t * );
70 #define MAX_LENGTH 256
74 NotifyNotification *notification;
79 /*****************************************************************************
80 * Open: initialize and create stuff
81 *****************************************************************************/
82 static int Open( vlc_object_t *p_this )
84 intf_thread_t *p_intf = (intf_thread_t *)p_this;
85 intf_sys_t *p_sys = malloc( sizeof( *p_sys ) );
90 if( !notify_init( APPLICATION_NAME ) )
93 msg_Err( p_intf, "can't find notification daemon" );
96 p_intf->p_sys = p_sys;
98 vlc_mutex_init( &p_sys->lock );
99 p_sys->notification = NULL;
100 p_sys->b_has_actions = false;
102 GList *p_caps = notify_get_server_caps ();
105 for( GList *c = p_caps; c != NULL; c = c->next )
107 if( !strcmp( (char*)c->data, "actions" ) )
109 p_sys->b_has_actions = true;
113 g_list_foreach( p_caps, (GFunc)g_free, NULL );
114 g_list_free( p_caps );
118 playlist_t *p_playlist = pl_Hold( p_intf );
119 var_AddCallback( p_playlist, "item-current", ItemChange, p_intf );
120 pl_Release( p_intf );
125 /*****************************************************************************
126 * Close: destroy interface stuff
127 *****************************************************************************/
128 static void Close( vlc_object_t *p_this )
130 intf_thread_t *p_intf = ( intf_thread_t* ) p_this;
131 intf_sys_t *p_sys = p_intf->p_sys;
133 playlist_t *p_playlist = pl_Hold( p_this );
134 var_DelCallback( p_playlist, "item-current", ItemChange, p_this );
135 pl_Release( p_this );
137 if( p_sys->notification )
139 GError *p_error = NULL;
140 notify_notification_close( p_sys->notification, &p_error );
141 g_object_unref( p_sys->notification );
144 vlc_mutex_destroy( &p_sys->lock );
149 /*****************************************************************************
150 * ItemChange: Playlist item change callback
151 *****************************************************************************/
152 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
153 vlc_value_t oldval, vlc_value_t newval, void *param )
155 VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
156 char psz_tmp[MAX_LENGTH];
157 char psz_notify[MAX_LENGTH];
158 char *psz_title = NULL;
159 char *psz_artist = NULL;
160 char *psz_album = NULL;
161 char *psz_arturl = NULL;
162 input_thread_t *p_input = playlist_CurrentInput(
163 (playlist_t*) p_this );
164 intf_thread_t *p_intf = param;
165 intf_sys_t *p_sys = p_intf->p_sys;
170 if( p_input->b_dead )
172 /* Not playing anything ... */
173 vlc_object_release( p_input );
177 /* Wait a tad so the meta has been fetched
178 * FIXME that's awfully wrong */
181 /* Playing something ... */
182 input_item_t *p_input_item = input_GetItem( p_input );
183 psz_artist = input_item_GetArtist( p_input_item );
184 psz_album = input_item_GetAlbum( p_input_item );
185 psz_title = input_item_GetTitle( p_input_item );
186 if( EMPTY_STR( psz_title ) )
189 psz_title = input_item_GetName( p_input_item );
191 if( EMPTY_STR( psz_title ) )
192 { /* Not enough metadata ... */
196 vlc_object_release( p_input );
199 if( EMPTY_STR( psz_artist ) )
204 if( EMPTY_STR( psz_album ) )
210 if( psz_artist && psz_album )
211 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s\n[%s]",
212 psz_title, psz_artist, psz_album );
213 else if( psz_artist )
214 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s",
215 psz_title, psz_artist );
217 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>", psz_title );
223 GdkPixbuf *pix = NULL;
224 psz_arturl = input_item_GetArtURL( p_input_item );
225 vlc_object_release( p_input );
227 if( psz_arturl && !strncmp( psz_arturl, "file://", 7 ) &&
228 strlen( psz_arturl ) > 7 )
229 { /* scale the art to show it in notify popup */
230 GError *p_error = NULL;
231 pix = gdk_pixbuf_new_from_file_at_scale( &psz_arturl[7],
232 72, 72, TRUE, &p_error );
235 else /* else we show state-of-the art logo */
237 GError *p_error = NULL;
239 if( asprintf( &psz_pixbuf, "%s/vlc48x48.png", config_GetDataDir() ) >= 0 )
241 pix = gdk_pixbuf_new_from_file( psz_pixbuf, &p_error );
246 /* we need to replace '&' with '&' because '&' is a keyword of
247 * notification-daemon parser */
248 const int i_len = strlen( psz_tmp );
250 for( int i = 0; i < i_len && i_notify < ( MAX_LENGTH - 5 ); i++ )
251 { /* we use MAX_LENGTH - 5 because if the last char of psz_tmp is '&'
252 * we will need 5 more characters: 'amp;\0' .
253 * however that's unlikely to happen because the last char is '\0' */
254 if( psz_tmp[i] != '&' )
256 psz_notify[i_notify] = psz_tmp[i];
260 snprintf( &psz_notify[i_notify], 6, "&" );
265 psz_notify[i_notify] = '\0';
267 vlc_mutex_lock( &p_sys->lock );
269 Notify( p_this, psz_notify, pix, p_intf );
271 vlc_mutex_unlock( &p_sys->lock );
276 static void Next( NotifyNotification *notification, gchar *psz, gpointer p )
277 { /* libnotify callback, called when the "Next" button is pressed */
278 vlc_object_t *p_object = (vlc_object_t*)p;
281 notify_notification_close( notification, NULL );
282 playlist_t *p_playlist = pl_Hold( p_object );
283 playlist_Next( p_playlist );
284 pl_Release( p_object );
287 static void Prev( NotifyNotification *notification, gchar *psz, gpointer p )
288 { /* libnotify callback, called when the "Previous" button is pressed */
289 vlc_object_t *p_object = (vlc_object_t*)p;
292 notify_notification_close( notification, NULL );
293 playlist_t *p_playlist = pl_Hold( p_object );
294 playlist_Prev( p_playlist );
295 pl_Release( p_object );
298 static int Notify( vlc_object_t *p_this, const char *psz_temp, GdkPixbuf *pix,
299 intf_thread_t *p_intf )
301 intf_sys_t *p_sys = p_intf->p_sys;
303 NotifyNotification * notification;
305 /* Close previous notification if still active */
306 if( p_sys->notification )
308 GError *p_error = NULL;
309 notify_notification_close( p_sys->notification, &p_error );
310 g_object_unref( p_sys->notification );
313 notification = notify_notification_new( _("Now Playing"),
314 psz_temp, NULL, NULL );
315 notify_notification_set_timeout( notification,
316 config_GetInt(p_this, "notify-timeout") );
317 notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
320 notify_notification_set_icon_from_pixbuf( notification, pix );
321 gdk_pixbuf_unref( pix );
324 /* Adds previous and next buttons in the notification if actions are supported. */
325 if( p_sys->b_has_actions )
327 notify_notification_add_action( notification, "previous", _("Previous"), Prev,
328 (gpointer*)p_intf, NULL );
329 notify_notification_add_action( notification, "next", _("Next"), Next,
330 (gpointer*)p_intf, NULL );
333 notify_notification_show( notification, NULL);
335 /* Stores the notification to be able to close it */
336 p_sys->notification = notification;