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

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