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