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