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 #define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_interface.h>
35 #include <vlc_input.h>
36 #include <vlc_playlist.h>
40 #include <gdk-pixbuf/gdk-pixbuf.h>
41 #include <libnotify/notify.h>
43 #ifndef NOTIFY_CHECK_VERSION
44 # define NOTIFY_CHECK_VERSION(x,y,z) 0
47 /*****************************************************************************
49 ****************************************************************************/
50 static int Open ( vlc_object_t * );
51 static void Close ( vlc_object_t * );
53 #define APPLICATION_NAME "VLC media player"
55 #define TIMEOUT_TEXT N_("Timeout (ms)")
56 #define TIMEOUT_LONGTEXT N_("How long the notification will be displayed ")
59 set_category( CAT_INTERFACE )
60 set_subcategory( SUBCAT_INTERFACE_CONTROL )
61 set_shortname( N_( "Notify" ) )
62 set_description( N_("LibNotify Notification Plugin") )
64 add_integer( "notify-timeout", 4000,
65 TIMEOUT_TEXT, TIMEOUT_LONGTEXT, true )
67 set_capability( "interface", 0 )
68 set_callbacks( Open, Close )
72 /*****************************************************************************
74 *****************************************************************************/
75 static int ItemChange( vlc_object_t *, const char *,
76 vlc_value_t, vlc_value_t, void * );
77 static int Notify( vlc_object_t *, const char *, GdkPixbuf *, intf_thread_t * );
78 #define MAX_LENGTH 256
82 NotifyNotification *notification;
87 /*****************************************************************************
88 * Open: initialize and create stuff
89 *****************************************************************************/
90 static int Open( vlc_object_t *p_this )
92 intf_thread_t *p_intf = (intf_thread_t *)p_this;
93 intf_sys_t *p_sys = malloc( sizeof( *p_sys ) );
98 if( !notify_init( APPLICATION_NAME ) )
101 msg_Err( p_intf, "can't find notification daemon" );
104 p_intf->p_sys = p_sys;
106 vlc_mutex_init( &p_sys->lock );
107 p_sys->notification = NULL;
108 p_sys->b_has_actions = false;
110 GList *p_caps = notify_get_server_caps ();
113 for( GList *c = p_caps; c != NULL; c = c->next )
115 if( !strcmp( (char*)c->data, "actions" ) )
117 p_sys->b_has_actions = true;
121 g_list_foreach( p_caps, (GFunc)g_free, NULL );
122 g_list_free( p_caps );
126 var_AddCallback( pl_Get( p_intf ), "input-current", ItemChange, p_intf );
131 /*****************************************************************************
132 * Close: destroy interface stuff
133 *****************************************************************************/
134 static void Close( vlc_object_t *p_this )
136 intf_thread_t *p_intf = ( intf_thread_t* ) p_this;
137 intf_sys_t *p_sys = p_intf->p_sys;
139 var_DelCallback( pl_Get( p_intf ), "input-current", ItemChange, p_this );
141 if( p_sys->notification )
143 GError *p_error = NULL;
144 notify_notification_close( p_sys->notification, &p_error );
145 g_object_unref( p_sys->notification );
148 vlc_mutex_destroy( &p_sys->lock );
153 /*****************************************************************************
154 * ItemChange: Playlist item change callback
155 *****************************************************************************/
156 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
157 vlc_value_t oldval, vlc_value_t newval, void *param )
159 VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
160 char psz_tmp[MAX_LENGTH];
161 char psz_notify[MAX_LENGTH];
166 input_thread_t *p_input = newval.p_address;
167 intf_thread_t *p_intf = param;
168 intf_sys_t *p_sys = p_intf->p_sys;
173 if( p_input->b_dead )
174 /* Not playing anything ... */
177 /* Playing something ... */
178 input_item_t *p_input_item = input_GetItem( p_input );
179 psz_title = input_item_GetTitleFbName( p_input_item );
181 /* We need at least a title */
182 if( EMPTY_STR( psz_title ) )
188 psz_artist = input_item_GetArtist( p_input_item );
189 psz_album = input_item_GetAlbum( p_input_item );
191 if( !EMPTY_STR( psz_artist ) )
193 if( !EMPTY_STR( psz_album ) )
194 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s\n[%s]",
195 psz_title, psz_artist, psz_album );
197 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s",
198 psz_title, psz_artist );
201 snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>", psz_title );
207 GdkPixbuf *pix = NULL;
208 psz_arturl = input_item_GetArtURL( p_input_item );
212 char *psz = make_path( psz_arturl );
218 { /* scale the art to show it in notify popup */
219 GError *p_error = NULL;
220 pix = gdk_pixbuf_new_from_file_at_scale( psz_arturl,
221 72, 72, TRUE, &p_error );
223 else /* else we show state-of-the art logo */
225 /* First try to get an icon from the current theme. */
226 GtkIconTheme* p_theme = gtk_icon_theme_get_default();
227 pix = gtk_icon_theme_load_icon( p_theme, "vlc", 72, 0, NULL);
231 /* Load icon from share/ */
232 GError *p_error = NULL;
234 char *psz_data = config_GetDataDir();
235 if( asprintf( &psz_pixbuf, "%s/icons/48x48/vlc.png", psz_data ) >= 0 )
237 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 strcpy( &psz_notify[i_notify], "&" );
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 /* libnotify callback, called when the "Next" button is pressed */
277 static void Next( NotifyNotification *notification, gchar *psz, gpointer p )
279 intf_thread_t *p_object = (intf_thread_t *)p;
282 notify_notification_close( notification, NULL );
283 playlist_Next( pl_Get( p_object ) );
286 /* libnotify callback, called when the "Previous" button is pressed */
287 static void Prev( NotifyNotification *notification, gchar *psz, gpointer p )
289 intf_thread_t *p_object = (intf_thread_t *)p;
292 notify_notification_close( notification, NULL );
293 playlist_Prev( pl_Get( p_object ) );
296 static int Notify( vlc_object_t *p_this, const char *psz_temp, GdkPixbuf *pix,
297 intf_thread_t *p_intf )
299 intf_sys_t *p_sys = p_intf->p_sys;
301 NotifyNotification * notification;
303 /* Close previous notification if still active */
304 if( p_sys->notification )
306 GError *p_error = NULL;
307 notify_notification_close( p_sys->notification, &p_error );
308 g_object_unref( p_sys->notification );
311 notification = notify_notification_new( _("Now Playing"),
313 #if NOTIFY_CHECK_VERSION (0, 7, 0)
318 notify_notification_set_timeout( notification,
319 var_InheritInteger(p_this, "notify-timeout") );
320 notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
323 notify_notification_set_icon_from_pixbuf( notification, pix );
324 gdk_pixbuf_unref( pix );
327 /* Adds previous and next buttons in the notification if actions are supported. */
328 if( p_sys->b_has_actions )
330 notify_notification_add_action( notification, "previous", _("Previous"), Prev,
331 (gpointer*)p_intf, NULL );
332 notify_notification_add_action( notification, "next", _("Next"), Next,
333 (gpointer*)p_intf, NULL );
336 notify_notification_show( notification, NULL);
338 /* Stores the notification to be able to close it */
339 p_sys->notification = notification;