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 )
138 g_object_unref( p_sys->notification );
140 vlc_mutex_destroy( &p_sys->lock );
145 /*****************************************************************************
146 * ItemChange: Playlist item change callback
147 *****************************************************************************/
148 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
149 vlc_value_t oldval, vlc_value_t newval, void *param )
151 VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
152 char psz_tmp[MAX_LENGTH];
153 char psz_notify[MAX_LENGTH];
154 char *psz_title = NULL;
155 char *psz_artist = NULL;
156 char *psz_album = NULL;
157 char *psz_arturl = NULL;
158 input_thread_t *p_input = playlist_CurrentInput(
159 (playlist_t*) p_this );
160 intf_thread_t *p_intf = param;
161 intf_sys_t *p_sys = p_intf->p_sys;
163 if( !p_input ) return VLC_SUCCESS;
165 if( p_input->b_dead )
167 /* Not playing anything ... */
168 vlc_object_release( p_input );
171 /*Wait a tad so the meta has been fetched*/
174 /* Playing something ... */
175 psz_artist = input_item_GetArtist( input_GetItem( p_input ) );
176 psz_album = input_item_GetAlbum( input_GetItem( p_input ) ) ;
177 psz_title = input_item_GetTitle( input_GetItem( p_input ) );
178 if( ( psz_title == NULL ) || EMPTY_STR( psz_title ) )
181 psz_title = input_item_GetName( input_GetItem( p_input ) );
183 if( ( psz_title == NULL ) || EMPTY_STR( psz_title ) )
184 { /* Not enough metadata ... */
188 vlc_object_release( p_input );
191 if( EMPTY_STR( psz_artist ) )
196 if( EMPTY_STR( psz_album ) )
202 vlc_object_release( p_input );
204 if( psz_artist && psz_album )
205 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s\n[%s]",
206 psz_title, psz_artist, psz_album );
207 else if( psz_artist )
208 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s",
209 psz_title, psz_artist );
211 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>", psz_title );
217 GdkPixbuf *pix = NULL;
218 GError *p_error = NULL;
220 psz_arturl = input_item_GetArtURL( input_GetItem( p_input ) );
221 if( psz_arturl && !strncmp( psz_arturl, "file://", 7 ) &&
222 strlen( psz_arturl ) > 7 )
223 { /* scale the art to show it in notify popup */
225 pix = gdk_pixbuf_new_from_file_at_scale(
226 (psz_arturl + 7), 72, 72, b, &p_error );
229 else /* else we show state-of-the art logo */
232 if( asprintf( &psz_pixbuf, "%s/vlc48x48.png", config_GetDataDir() ) >= 0 )
234 pix = gdk_pixbuf_new_from_file( psz_pixbuf, &p_error );
239 /* we need to replace '&' with '&' because '&' is a keyword of
240 * notification-daemon parser */
241 int i_notify, i_len, i;
242 i_len = strlen( psz_tmp );
244 for( i = 0; ( ( i < i_len ) && ( i_notify < ( MAX_LENGTH - 5 ) ) ); i++ )
245 { /* we use MAX_LENGTH - 5 because if the last char of psz_tmp is '&'
246 * we will need 5 more characters: 'amp;\0' .
247 * however that's unlikely to happen because the last char is '\0' */
248 if( psz_tmp[i] != '&' )
249 psz_notify[i_notify] = psz_tmp[i];
252 snprintf( psz_notify + i_notify, 6, "&" );
257 psz_notify[i_notify] = '\0';
259 vlc_mutex_lock( &p_sys->lock );
261 Notify( p_this, psz_notify, pix, p_intf );
263 vlc_mutex_unlock( &p_sys->lock );
268 static void Next( NotifyNotification *notification, gchar *psz, gpointer p )
269 { /* libnotify callback, called when the "Next" button is pressed */
271 notify_notification_close (notification, NULL);
272 playlist_t *p_playlist = pl_Hold( ((vlc_object_t*) p) );
273 playlist_Next( p_playlist );
274 pl_Release( ((vlc_object_t*) p) );
277 static void Prev( NotifyNotification *notification, gchar *psz, gpointer p )
278 { /* libnotify callback, called when the "Previous" button is pressed */
280 notify_notification_close (notification, NULL);
281 playlist_t *p_playlist = pl_Hold( ((vlc_object_t*) p) );
282 playlist_Prev( p_playlist );
283 pl_Release( ((vlc_object_t*) p) );
286 static int Notify( vlc_object_t *p_this, const char *psz_temp, GdkPixbuf *pix,
287 intf_thread_t *p_intf )
289 intf_sys_t *p_sys = p_intf->p_sys;
291 NotifyNotification * notification;
293 /* Close previous notification if still active */
294 if( p_sys->notification )
296 GError *p_error = NULL;
297 notify_notification_close( p_sys->notification, &p_error );
298 g_object_unref( p_sys->notification );
301 notification = notify_notification_new( _("Now Playing"),
302 psz_temp, NULL, NULL);
303 notify_notification_set_timeout( notification,
304 config_GetInt(p_this, "notify-timeout") );
305 notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
308 notify_notification_set_icon_from_pixbuf( notification, pix );
309 gdk_pixbuf_unref( pix );
312 /* Adds previous and next buttons in the notification if actions are supported. */
313 if( p_sys->b_has_actions )
315 notify_notification_add_action( notification, "previous", _("Previous"), Prev,
316 (gpointer*)p_intf, NULL );
317 notify_notification_add_action( notification, "next", _("Next"), Next,
318 (gpointer*)p_intf, NULL );
321 notify_notification_show( notification, NULL);
323 /* Stores the notification to be able to close it */
324 p_sys->notification = notification;