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

   1 /*****************************************************************************
   2  * notify.c : libnotify notification plugin
   3  *****************************************************************************
   4  * Copyright (C) 2006 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 #include <errno.h>
  28
  29 #include <gdk-pixbuf/gdk-pixbuf.h>
  30 #include <libnotify/notify.h>
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc_interface.h>
  34 #include <vlc_playlist.h>
  35 #include <vlc_meta.h>
  36
  37 /*****************************************************************************
  38  * Local prototypes
  39  *****************************************************************************/
  40 static int  Open    ( vlc_object_t * );
  41 static void Close   ( vlc_object_t * );
  42
  43 static int ItemChange( vlc_object_t *, const char *,
  44                        vlc_value_t, vlc_value_t, void * );
  45 static int Notify( vlc_object_t *, const char *, GdkPixbuf *, intf_thread_t * );
  46 #define MAX_LENGTH 256
  47
  48 struct intf_sys_t
  49 {
  50     NotifyNotification *notification;
  51     vlc_mutex_t     lock;
  52 };
  53
  54 /*****************************************************************************
  55  * Module descriptor
  56  ****************************************************************************/
  57
  58 #define APPLICATION_NAME "VLC media player"
  59
  60 #define TIMEOUT_TEXT N_("Timeout (ms)")
  61 #define TIMEOUT_LONGTEXT N_("How long the notification will be displayed ")
  62
  63 vlc_module_begin();
  64     set_category( CAT_INTERFACE );
  65     set_subcategory( SUBCAT_INTERFACE_CONTROL );
  66     set_shortname( _( "Notify" ) );
  67     set_description( _("LibNotify Notification Plugin") );
  68
  69     add_integer( "notify-timeout", 4000,NULL,
  70                 TIMEOUT_TEXT, TIMEOUT_LONGTEXT, VLC_TRUE );
  71
  72     set_capability( "interface", 0 );
  73     set_callbacks( Open, Close );
  74 vlc_module_end();
  75
  76 /*****************************************************************************
  77  * Open: initialize and create stuff
  78  *****************************************************************************/
  79 static int Open( vlc_object_t *p_this )
  80 {
  81     intf_thread_t   *p_intf = (intf_thread_t *)p_this;
  82     playlist_t      *p_playlist;
  83     intf_sys_t      *p_sys  = malloc( sizeof( intf_sys_t ) );
  84
  85     if( !p_sys )
  86     {
  87         msg_Err( p_intf, "Out of memory" );
  88         return VLC_ENOMEM;
  89     }
  90
  91     if( !notify_init( APPLICATION_NAME ) )
  92     {
  93         msg_Err( p_intf, "can't find notification daemon" );
  94         return VLC_EGENERIC;
  95     }
  96
  97     vlc_mutex_init( p_this, &p_sys->lock );
  98
  99     p_intf->p_sys = p_sys;
 100
 101     p_intf->p_sys->notification = NULL;
 102
 103     p_playlist = pl_Yield( p_intf );
 104     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 105     pl_Release( p_intf );
 106
 107     return VLC_SUCCESS;
 108 }
 109
 110 /*****************************************************************************
 111  * Close: destroy interface stuff
 112  *****************************************************************************/
 113 static void Close( vlc_object_t *p_this )
 114 {
 115     intf_thread_t   *p_intf = ( intf_thread_t* ) p_this;
 116     intf_sys_t      *p_sys  = p_intf->p_sys;
 117
 118     playlist_t *p_playlist = pl_Yield( p_this );
 119     var_DelCallback( p_playlist, "playlist-current", ItemChange, p_this );
 120     pl_Release( p_this );
 121
 122     vlc_mutex_destroy( &p_sys->lock );
 123     free( p_sys );
 124     notify_uninit();
 125 }
 126
 127 /*****************************************************************************
 128  * ItemChange: Playlist item change callback
 129  *****************************************************************************/
 130 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
 131                        vlc_value_t oldval, vlc_value_t newval, void *param )
 132 {
 133     char                psz_tmp[MAX_LENGTH];
 134     char                psz_notify[MAX_LENGTH];
 135     char                *psz_title      = NULL;
 136     char                *psz_artist     = NULL;
 137     char                *psz_album      = NULL;
 138     char                *psz_arturl     = NULL;
 139     input_thread_t      *p_input        = NULL;
 140     playlist_t          * p_playlist    = pl_Yield( p_this );
 141     intf_thread_t       *p_intf         = ( intf_thread_t* ) param;
 142     intf_sys_t          *p_sys          = p_intf->p_sys;
 143
 144     p_input = p_playlist->p_input;
 145     pl_Release( p_playlist );
 146
 147     if( !p_input ) return VLC_SUCCESS;
 148     vlc_object_yield( p_input );
 149
 150     if( p_input->b_dead )
 151     {
 152         /* Not playing anything ... */
 153         vlc_object_release( p_input );
 154         return VLC_SUCCESS;
 155     }
 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         pix = gdk_pixbuf_new_from_file( DATA_PATH "/vlc48x48.png", &p_error );
 214
 215     /* we need to replace '&' with '&amp;' because '&' is a keyword of
 216      * notification-daemon parser */
 217     int i_notify, i_len, i;
 218     i_len = strlen( psz_tmp );
 219     i_notify = 0;
 220     for( i = 0; ( ( i < i_len ) && ( i_notify < ( MAX_LENGTH - 5 ) ) ); i++ )
 221     { /* we use MAX_LENGTH - 5 because if the last char of psz_tmp is '&'
 222        * we will need 5 more characters: 'amp;\0' .
 223        * however that's unlikely to happen because the last char is '\0' */
 224         if( psz_tmp[i] != '&' )
 225             psz_notify[i_notify] = psz_tmp[i];
 226         else
 227         {
 228             snprintf( psz_notify + i_notify, 6, "&amp;" );
 229             i_notify += 4;
 230         }
 231         i_notify++;
 232     }
 233     psz_notify[i_notify] = '\0';
 234
 235     vlc_mutex_lock( &p_sys->lock );
 236
 237     Notify( p_this, psz_notify, pix, p_intf );
 238
 239     vlc_mutex_unlock( &p_sys->lock );
 240
 241     return VLC_SUCCESS;
 242 }
 243
 244 static void Next( NotifyNotification *notification, gchar *psz, gpointer p )
 245 { /* libnotify callback, called when the "Next" button is pressed */
 246     notify_notification_close (notification, NULL);
 247     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p) );
 248     playlist_Next( p_playlist );
 249     pl_Release( ((vlc_object_t*) p) );
 250 }
 251
 252 static void Prev( NotifyNotification *notification, gchar *psz, gpointer p )
 253 { /* libnotify callback, called when the "Previous" button is pressed */
 254     notify_notification_close (notification, NULL);
 255     playlist_t *p_playlist = pl_Yield( ((vlc_object_t*) p) );
 256     playlist_Prev( p_playlist );
 257     pl_Release( ((vlc_object_t*) p) );
 258 }
 259
 260 static int Notify( vlc_object_t *p_this, const char *psz_temp, GdkPixbuf *pix,
 261                    intf_thread_t *p_intf )
 262 {
 263     NotifyNotification * notification;
 264     GError *p_error = NULL;
 265
 266     /* Close previous notification if still active */
 267     if( p_intf->p_sys->notification )
 268         notify_notification_close( p_intf->p_sys->notification, &p_error );
 269
 270     notification = notify_notification_new( _("Now Playing"),
 271             psz_temp, NULL, NULL);
 272     notify_notification_set_timeout( notification,
 273                                      config_GetInt(p_this, "notify-timeout") );
 274     notify_notification_set_urgency( notification, NOTIFY_URGENCY_LOW );
 275     if( pix )
 276     {
 277         notify_notification_set_icon_from_pixbuf( notification, pix );
 278         gdk_pixbuf_unref( pix );
 279     }
 280
 281     /* Adds previous and next buttons in the notification */
 282     notify_notification_add_action( notification, "prev", _("Previous"), Prev,
 283                                     (gpointer*) p_intf, NULL );
 284     notify_notification_add_action( notification, "next", _("Next"), Next,
 285                                     (gpointer*) p_intf, NULL );
 286
 287     notify_notification_show( notification, NULL);
 288
 289     /* Stores the notification to be able to close it */
 290     p_intf->p_sys->notification = notification;
 291     return VLC_SUCCESS;
 292 }
 293