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