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