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