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     playlist_t *p_playlist = pl_Hold( p_intf );
 120     var_AddCallback( p_playlist, "item-current", ItemChange, p_intf );
 121     pl_Release( p_intf );
 122
 123     return VLC_SUCCESS;
 124 }
 125
 126 /*****************************************************************************
 127  * Close: destroy interface stuff
 128  *****************************************************************************/
 129 static void Close( vlc_object_t *p_this )
 130 {
 131     intf_thread_t   *p_intf = ( intf_thread_t* ) p_this;
 132     intf_sys_t      *p_sys  = p_intf->p_sys;
 133
 134     playlist_t *p_playlist = pl_Hold( p_this );
 135     var_DelCallback( p_playlist, "item-current", ItemChange, p_this );
 136     pl_Release( p_this );
 137
 138     if( p_sys->notification )
 139     {
 140         GError *p_error = NULL;
 141         notify_notification_close( p_sys->notification, &p_error );
 142         g_object_unref( p_sys->notification );
 143     }
 144
 145     vlc_mutex_destroy( &p_sys->lock );
 146     free( p_sys );
 147     notify_uninit();
 148 }
 149
 150 /*****************************************************************************
 151  * ItemChange: Playlist item change callback
 152  *****************************************************************************/
 153 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 154                        vlc_value_t oldval, vlc_value_t newval, void *param )
 155 {
 156     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(newval);
 157     char                psz_tmp[MAX_LENGTH];
 158     char                psz_notify[MAX_LENGTH];
 159     char                *psz_title      = NULL;
 160     char                *psz_artist     = NULL;
 161     char                *psz_album      = NULL;
 162     char                *psz_arturl     = NULL;
 163     input_thread_t      *p_input        =  playlist_CurrentInput(
 164                                                     (playlist_t*) p_this );
 165     intf_thread_t       *p_intf         = param;
 166     intf_sys_t          *p_sys          = p_intf->p_sys;
 167
 168     if( !p_input )
 169         return VLC_SUCCESS;
 170
 171     if( p_input->b_dead )
 172     {
 173         /* Not playing anything ... */
 174         vlc_object_release( p_input );
 175         return VLC_SUCCESS;
 176     }
 177
 178     /* Wait a tad so the meta has been fetched
 179      * FIXME that's awfully wrong */
 180     msleep( 1000*4 );
 181
 182     /* Playing something ... */
 183     input_item_t *p_input_item = input_GetItem( p_input );
 184     psz_artist = input_item_GetArtist( p_input_item );
 185     psz_album = input_item_GetAlbum( p_input_item );
 186     psz_title = input_item_GetTitleFbName( p_input_item );
 187
 188     if( EMPTY_STR( psz_title ) )
 189     {  /* Not enough metadata ... */
 190         free( psz_title );
 191         free( psz_artist );
 192         free( psz_album );
 193         vlc_object_release( p_input );
 194         return VLC_SUCCESS;
 195     }
 196     if( EMPTY_STR( psz_artist ) )
 197     {
 198         free( psz_artist );
 199         psz_artist = NULL;
 200     }
 201     if( EMPTY_STR( psz_album ) )
 202     {
 203         free( psz_album );
 204         psz_album = NULL;
 205     }
 206
 207     if( psz_artist && psz_album )
 208         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s\n[%s]",
 209                   psz_title, psz_artist, psz_album );
 210     else if( psz_artist )
 211         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>\n%s",
 212                   psz_title, psz_artist );
 213     else
 214         snprintf( psz_tmp, MAX_LENGTH, "<b>%s</b>", psz_title );
 215
 216     free( psz_title );
 217     free( psz_artist );
 218     free( psz_album );
 219
 220     GdkPixbuf *pix = NULL;
 221     psz_arturl = input_item_GetArtURL( p_input_item );
 222     vlc_object_release( p_input );
 223
 224     if( psz_arturl && !strncmp( psz_arturl, "file://", 7 ) &&
 225                 decode_URI( psz_arturl + 7 ) )
 226     { /* scale the art to show it in notify popup */
 227         GError *p_error = NULL;
 228         pix = gdk_pixbuf_new_from_file_at_scale( &psz_arturl[7],
 229                                                  72, 72, TRUE, &p_error );
 230     }
 231     else /* else we show state-of-the art logo */
 232     {
 233         GError *p_error = NULL;
 234         char *psz_pixbuf;
 235         if( asprintf( &psz_pixbuf, "%s/vlc48x48.png", config_GetDataDir() ) >= 0 )
 236         {
 237             pix = gdk_pixbuf_new_from_file( psz_pixbuf, &p_error );
 238             free( psz_pixbuf );
 239         }
 240     }
 241
 242     free( psz_arturl );
 243
 244     /* we need to replace '&' with '&amp;' because '&' is a keyword of
 245      * notification-daemon parser */
 246     const int i_len = strlen( psz_tmp );
 247     int i_notify = 0;
 248     for( int i = 0; i < i_len && i_notify < ( MAX_LENGTH - 5 ); i++ )
 249     { /* we use MAX_LENGTH - 5 because if the last char of psz_tmp is '&'
 250        * we will need 5 more characters: 'amp;\0' .
 251        * however that's unlikely to happen because the last char is '\0' */
 252         if( psz_tmp[i] != '&' )
 253         {
 254             psz_notify[i_notify] = psz_tmp[i];
 255         }
 256         else
 257         {
 258             snprintf( &psz_notify[i_notify], 6, "&amp;" );
 259             i_notify += 4;
 260         }
 261         i_notify++;
 262     }
 263     psz_notify[i_notify] = '\0';
 264
 265     vlc_mutex_lock( &p_sys->lock );
 266
 267     Notify( p_this, psz_notify, pix, p_intf );
 268
 269     vlc_mutex_unlock( &p_sys->lock );
 270
 271     return VLC_SUCCESS;
 272 }
 273
 274 static void Next( NotifyNotification *notification, gchar *psz, gpointer p )
 275 { /* libnotify callback, called when the "Next" button is pressed */
 276     vlc_object_t *p_object = (vlc_object_t*)p;
 277
 278     VLC_UNUSED(psz);
 279     notify_notification_close( notification, NULL );
 280     playlist_t *p_playlist = pl_Hold( p_object );
 281     playlist_Next( p_playlist );
 282     pl_Release( p_object );
 283 }
 284
 285 static void Prev( NotifyNotification *notification, gchar *psz, gpointer p )
 286 { /* libnotify callback, called when the "Previous" button is pressed */
 287     vlc_object_t *p_object = (vlc_object_t*)p;
 288
 289     VLC_UNUSED(psz);
 290     notify_notification_close( notification, NULL );
 291     playlist_t *p_playlist = pl_Hold( p_object );
 292     playlist_Prev( p_playlist );
 293     pl_Release( p_object );
 294 }
 295
 296 static int Notify( vlc_object_t *p_this, const char *psz_temp, GdkPixbuf *pix,
 297                    intf_thread_t *p_intf )
 298 {
 299     intf_sys_t *p_sys = p_intf->p_sys;
 300
 301     NotifyNotification * notification;
 302
 303     /* Close previous notification if still active */
 304     if( p_sys->notification )
 305     {
 306         GError *p_error = NULL;
 307         notify_notification_close( p_sys->notification, &p_error );
 308         g_object_unref( p_sys->notification );
 309     }
 310
 311     notification = notify_notification_new( _("Now Playing"),
 312                                             psz_temp, NULL, NULL );
 313     notify_notification_set_timeout( notification,
 314                                      config_GetInt(p_this, "notify-timeout") );
 315     notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
 316     if( pix )
 317     {
 318         notify_notification_set_icon_from_pixbuf( notification, pix );
 319         gdk_pixbuf_unref( pix );
 320     }
 321
 322     /* Adds previous and next buttons in the notification if actions are supported. */
 323     if( p_sys->b_has_actions )
 324     {
 325       notify_notification_add_action( notification, "previous", _("Previous"), Prev,
 326                                                       (gpointer*)p_intf, NULL );
 327       notify_notification_add_action( notification, "next", _("Next"), Next,
 328                                                       (gpointer*)p_intf, NULL );
 329     }
 330
 331     notify_notification_show( notification, NULL);
 332
 333     /* Stores the notification to be able to close it */
 334     p_sys->notification = notification;
 335     return VLC_SUCCESS;
 336 }
 337