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