git.sesse.net Git - vlc/blob - modules/notify/notify.c

   1 /*****************************************************************************
   2  * notify.c : libnotify notification plugin
   3  *****************************************************************************
   4  * Copyright (C) 2006-2009 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_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_interface.h>
  34 #include <vlc_playlist.h>
  35 #include <vlc_url.h>
  36
  37 #include <gtk/gtk.h>
  38 #include <gdk-pixbuf/gdk-pixbuf.h>
  39 #include <libnotify/notify.h>
  40
  41 #ifndef NOTIFY_CHECK_VERSION
  42 # define NOTIFY_CHECK_VERSION(x,y,z) 0
  43 #endif
  44
  45 /*****************************************************************************
  46  * Module descriptor
  47  ****************************************************************************/
  48 static int  Open    ( vlc_object_t * );
  49 static void Close   ( vlc_object_t * );
  50
  51 #define APPLICATION_NAME "VLC media player"
  52
  53 #define TIMEOUT_TEXT N_("Timeout (ms)")
  54 #define TIMEOUT_LONGTEXT N_("How long the notification will be displayed ")
  55
  56 vlc_module_begin ()
  57     set_category( CAT_INTERFACE )
  58     set_subcategory( SUBCAT_INTERFACE_CONTROL )
  59     set_shortname( N_( "Notify" ) )
  60     set_description( N_("LibNotify Notification Plugin") )
  61
  62     add_integer( "notify-timeout", 4000,
  63                  TIMEOUT_TEXT, TIMEOUT_LONGTEXT, true )
  64
  65     set_capability( "interface", 0 )
  66     set_callbacks( Open, Close )
  67 vlc_module_end ()
  68
  69
  70 /*****************************************************************************
  71  * Local prototypes
  72  *****************************************************************************/
  73 static int ItemChange( vlc_object_t *, const char *,
  74                        vlc_value_t, vlc_value_t, void * );
  75 static int Notify( vlc_object_t *, const char *, GdkPixbuf *, intf_thread_t * );
  76 #define MAX_LENGTH 256
  77
  78 struct intf_sys_t
  79 {
  80     NotifyNotification *notification;
  81     vlc_mutex_t     lock;
  82     bool            b_has_actions;
  83 };
  84
  85 /*****************************************************************************
  86  * Open: initialize and create stuff
  87  *****************************************************************************/
  88 static int Open( vlc_object_t *p_this )
  89 {
  90     intf_thread_t   *p_intf = (intf_thread_t *)p_this;
  91     intf_sys_t      *p_sys  = malloc( sizeof( *p_sys ) );
  92
  93     if( !p_sys )
  94         return VLC_ENOMEM;
  95
  96     if( !notify_init( APPLICATION_NAME ) )
  97     {
  98         free( p_sys );
  99         msg_Err( p_intf, "can't find notification daemon" );
 100         return VLC_EGENERIC;
 101     }
 102     p_intf->p_sys = p_sys;
 103
 104     vlc_mutex_init( &p_sys->lock );
 105     p_sys->notification = NULL;
 106     p_sys->b_has_actions = false;
 107
 108     GList *p_caps = notify_get_server_caps ();
 109     if( p_caps )
 110     {
 111         for( GList *c = p_caps; c != NULL; c = c->next )
 112         {
 113             if( !strcmp( (char*)c->data, "actions" ) )
 114             {
 115                 p_sys->b_has_actions = true;
 116                 break;
 117             }
 118         }
 119         g_list_foreach( p_caps, (GFunc)g_free, NULL );
 120         g_list_free( p_caps );
 121     }
 122
 123     /* */
 124     var_AddCallback( pl_Get( p_intf ), "item-current", ItemChange, p_intf );
 125     var_AddCallback( pl_Get( p_intf ), "item-change", ItemChange, p_intf );
 126
 127     return VLC_SUCCESS;
 128 }
 129
 130 /*****************************************************************************
 131  * Close: destroy interface stuff
 132  *****************************************************************************/
 133 static void Close( vlc_object_t *p_this )
 134 {
 135     intf_thread_t   *p_intf = ( intf_thread_t* ) p_this;
 136     intf_sys_t      *p_sys  = p_intf->p_sys;
 137
 138     var_DelCallback( pl_Get( p_this ), "item-current", ItemChange, p_this );
 139     var_DelCallback( pl_Get( p_this ), "item-change", ItemChange, p_this );
 140
 141     if( p_sys->notification )
 142     {
 143         GError *p_error = NULL;
 144         notify_notification_close( p_sys->notification, &p_error );
 145         g_object_unref( p_sys->notification );
 146     }
 147
 148     vlc_mutex_destroy( &p_sys->lock );
 149     free( p_sys );
 150     notify_uninit();
 151 }
 152
 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 )
 158 {
 159     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
 160     char           psz_tmp[MAX_LENGTH];
 161     char           psz_notify[MAX_LENGTH];
 162     char           *psz_title;
 163     char           *psz_artist;
 164     char           *psz_album;
 165     char           *psz_arturl;
 166     input_thread_t *p_input = playlist_CurrentInput( (playlist_t*)p_this );
 167     intf_thread_t  *p_intf  = param;
 168     intf_sys_t     *p_sys   = p_intf->p_sys;
 169
 170     if( !p_input )
 171         return VLC_SUCCESS;
 172
 173     if( p_input->b_dead )
 174     {
 175         /* Not playing anything ... */
 176         vlc_object_release( p_input );
 177         return VLC_SUCCESS;
 178     }
 179
 180     /* Wait a tad so the meta has been fetched
 181      * FIXME that's awfully wrong */
 182     msleep( 10000 );
 183
 184     /* Playing something ... */
 185     input_item_t *p_input_item = input_GetItem( p_input );
 186     psz_title = input_item_GetTitleFbName( p_input_item );
 187
 188     /* We need at least a title */
 189     if( EMPTY_STR( psz_title ) )
 190     {
 191         free( psz_title );
 192         vlc_object_release( p_input );
 193         return VLC_SUCCESS;
 194     }
 195
 196     psz_artist = input_item_GetArtist( p_input_item );
 197     psz_album = input_item_GetAlbum( p_input_item );
 198
 199     if( !EMPTY_STR( psz_artist ) )
 200     {
 201         if( !EMPTY_STR( psz_album ) )
 202             snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s\n[%s]",
 203                       psz_title, psz_artist, psz_album );
 204         else
 205             snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s",
 206                       psz_title, psz_artist );
 207     }
 208     else
 209         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>", psz_title );
 210
 211     free( psz_title );
 212     free( psz_artist );
 213     free( psz_album );
 214
 215     GdkPixbuf *pix = NULL;
 216     psz_arturl = input_item_GetArtURL( p_input_item );
 217     vlc_object_release( p_input );
 218
 219     if( psz_arturl )
 220     {
 221         char *psz = make_path( psz_arturl );
 222         free( psz_arturl );
 223         psz_arturl = psz;
 224     }
 225
 226     if( psz_arturl )
 227     { /* scale the art to show it in notify popup */
 228         GError *p_error = NULL;
 229         pix = gdk_pixbuf_new_from_file_at_scale( psz_arturl,
 230                                                  72, 72, TRUE, &p_error );
 231     }
 232     else /* else we show state-of-the art logo */
 233     {
 234         /* First try to get an icon from the current theme. */
 235         GtkIconTheme* p_theme = gtk_icon_theme_get_default();
 236         pix = gtk_icon_theme_load_icon( p_theme, "vlc", 72, 0, NULL);
 237
 238         if( !pix )
 239         {
 240         /* Load icon from share/ */
 241             GError *p_error = NULL;
 242             char *psz_pixbuf;
 243             char *psz_data = config_GetDataDir( p_this );
 244             if( asprintf( &psz_pixbuf, "%s/icons/48x48/vlc.png", psz_data ) >= 0 )
 245             {
 246                 pix = gdk_pixbuf_new_from_file( psz_pixbuf, &p_error );
 247                 free( psz_pixbuf );
 248             }
 249             free( psz_data );
 250         }
 251     }
 252
 253     free( psz_arturl );
 254
 255     /* we need to replace '&' with '&amp;' because '&' is a keyword of
 256      * notification-daemon parser */
 257     const int i_len = strlen( psz_tmp );
 258     int i_notify = 0;
 259     for( int i = 0; i < i_len && i_notify < ( MAX_LENGTH - 5 ); i++ )
 260     { /* we use MAX_LENGTH - 5 because if the last char of psz_tmp is '&'
 261        * we will need 5 more characters: 'amp;\0' .
 262        * however that's unlikely to happen because the last char is '\0' */
 263         if( psz_tmp[i] != '&' )
 264         {
 265             psz_notify[i_notify] = psz_tmp[i];
 266         }
 267         else
 268         {
 269             strcpy( &psz_notify[i_notify], "&amp;" );
 270             i_notify += 4;
 271         }
 272         i_notify++;
 273     }
 274     psz_notify[i_notify] = '\0';
 275
 276     vlc_mutex_lock( &p_sys->lock );
 277
 278     Notify( p_this, psz_notify, pix, p_intf );
 279
 280     vlc_mutex_unlock( &p_sys->lock );
 281
 282     return VLC_SUCCESS;
 283 }
 284
 285 /* libnotify callback, called when the "Next" button is pressed */
 286 static void Next( NotifyNotification *notification, gchar *psz, gpointer p )
 287 {
 288     vlc_object_t *p_object = (vlc_object_t*)p;
 289
 290     VLC_UNUSED(psz);
 291     notify_notification_close( notification, NULL );
 292     playlist_Next( pl_Get( p_object ) );
 293 }
 294
 295 /* libnotify callback, called when the "Previous" button is pressed */
 296 static void Prev( NotifyNotification *notification, gchar *psz, gpointer p )
 297 {
 298     vlc_object_t *p_object = (vlc_object_t*)p;
 299
 300     VLC_UNUSED(psz);
 301     notify_notification_close( notification, NULL );
 302     playlist_Prev( pl_Get( p_object ) );
 303 }
 304
 305 static int Notify( vlc_object_t *p_this, const char *psz_temp, GdkPixbuf *pix,
 306                    intf_thread_t *p_intf )
 307 {
 308     intf_sys_t *p_sys = p_intf->p_sys;
 309
 310     NotifyNotification * notification;
 311
 312     /* Close previous notification if still active */
 313     if( p_sys->notification )
 314     {
 315         GError *p_error = NULL;
 316         notify_notification_close( p_sys->notification, &p_error );
 317         g_object_unref( p_sys->notification );
 318     }
 319
 320     notification = notify_notification_new( _("Now Playing"),
 321                                             psz_temp, NULL
 322 #if NOTIFY_CHECK_VERSION (0, 7, 0)
 323                                           );
 324 #else
 325                                           , NULL );
 326 #endif
 327     notify_notification_set_timeout( notification,
 328                                 var_InheritInteger(p_this, "notify-timeout") );
 329     notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
 330     if( pix )
 331     {
 332         notify_notification_set_icon_from_pixbuf( notification, pix );
 333         gdk_pixbuf_unref( pix );
 334     }
 335
 336     /* Adds previous and next buttons in the notification if actions are supported. */
 337     if( p_sys->b_has_actions )
 338     {
 339       notify_notification_add_action( notification, "previous", _("Previous"), Prev,
 340                                       (gpointer*)p_intf, NULL );
 341       notify_notification_add_action( notification, "next", _("Next"), Next,
 342                                       (gpointer*)p_intf, NULL );
 343     }
 344
 345     notify_notification_show( notification, NULL);
 346
 347     /* Stores the notification to be able to close it */
 348     p_sys->notification = notification;
 349     return VLC_SUCCESS;
 350 }
 351