git.sesse.net Git - vlc/blob - src/control/event.c

   1 /*****************************************************************************
   2  * event.c: New libvlc event control API
   3  *****************************************************************************
   4  * Copyright (C) 2007 the VideoLAN team
   5  * $Id $
   6  *
   7  * Authors: Filippo Carone <filippo@carone.org>
   8  *          Pierre d'Herbemont <pdherbemont # videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #include "libvlc_internal.h"
  26 #include <vlc/libvlc.h>
  27 #include <vlc_playlist.h>
  28
  29
  30 /*
  31  * Private functions
  32  */
  33
  34 /**************************************************************************
  35  *       handle_event (private)
  36  *
  37  * Callback from the vlc variables
  38  **************************************************************************/
  39 static int handle_event( vlc_object_t *p_this, char const *psz_cmd,
  40                          vlc_value_t oldval, vlc_value_t newval,
  41                          void *p_data )
  42 {
  43     /* This is thread safe, as the var_*Callback already provide the locking
  44      * facility for p_data */
  45     struct libvlc_callback_entry_t *entry = p_data;
  46     libvlc_event_t event;
  47
  48     event.type = entry->i_event_type;
  49
  50     if (event.type == libvlc_VolumeChanged)
  51     {
  52         if(!strcmp(psz_cmd, "intf-change"))
  53         {
  54             input_thread_t * p_input = (input_thread_t *)p_this;
  55             vlc_value_t val;
  56             var_Get( p_input, "time", &val );
  57
  58             /* Only send event at a reasonable time precision (500ms) */
  59             /* (FIXME: this should be configurable) */
  60             if ((val.i_time % I64C(500000)) != 0)
  61             {
  62                 /* Don't send this event */
  63                 return VLC_SUCCESS;
  64             }
  65
  66             event.u.input_position_changed.new_position = val.i_time;
  67         }
  68         else
  69             event.u.input_position_changed.new_position = newval.i_time;
  70
  71         event.u.input_position_changed.new_position *= 1000LL;
  72     }
  73     else if (event.type == libvlc_InputPositionChanged)
  74     {
  75         event.u.volume_changed.new_volume = newval.i_int;
  76     }
  77
  78     /* Call the client entry */
  79     entry->f_callback( entry->p_instance, &event, entry->p_user_data );
  80
  81     return VLC_SUCCESS;
  82 }
  83
  84 /**************************************************************************
  85  *       get_input (private) :
  86  *
  87  * Utility function, Object should be released by vlc_object_release
  88  * afterwards
  89  **************************************************************************/
  90 static input_thread_t * get_input(libvlc_instance_t * p_instance)
  91 {
  92     libvlc_exception_t p_e_unused; /* FIXME: error checking here */
  93     libvlc_media_instance_t * p_mi;
  94     input_thread_t * p_input;
  95
  96     p_mi = libvlc_playlist_get_media_instance( p_instance, &p_e_unused );
  97
  98     if( !p_mi )
  99         return NULL;
 100
 101     p_input = libvlc_get_input_thread( p_mi, &p_e_unused );
 102
 103     libvlc_media_instance_destroy( p_mi );
 104
 105     return p_input;
 106 }
 107
 108 /**************************************************************************
 109  *       install_input_event (private) :
 110  *
 111  * vlc variables callback, used to install input event.
 112  * Can be called manually though.
 113  **************************************************************************/
 114 static int install_input_event( vlc_object_t *p_this, char const *psz_cmd,
 115                                 vlc_value_t oldval, vlc_value_t newval,
 116                                 void *p_data )
 117 {
 118     libvlc_instance_t * p_instance = p_data;
 119     struct libvlc_callback_entry_list_t *p_listitem;
 120     input_thread_t * p_input = get_input( p_instance );
 121
 122     vlc_mutex_lock( &p_instance->instance_lock );
 123
 124     p_listitem = p_instance->p_callback_list;
 125
 126     for( ; p_listitem ; p_listitem = p_listitem->next )
 127     {
 128         if (p_listitem->elmt->i_event_type == libvlc_InputPositionChanged)
 129         {
 130             /* FIXME: here we shouldn't listen on intf-change, we have to provide
 131              * in vlc core a more accurate callback */
 132             var_AddCallback( p_input, "intf-change", handle_event, p_listitem->elmt );
 133             var_AddCallback( p_input, "time", handle_event, p_listitem->elmt );
 134         }
 135     }
 136
 137     vlc_mutex_unlock( &p_instance->instance_lock );
 138     vlc_object_release( p_input );
 139     return VLC_SUCCESS;
 140 }
 141
 142 /**************************************************************************
 143  *       add_callback_to_list (private) :
 144  *
 145  * callback list utility function.
 146  **************************************************************************/
 147 static inline void add_callback_to_list( struct libvlc_callback_entry_t *entry,
 148                                          struct libvlc_callback_entry_list_t **list )
 149 {
 150     struct libvlc_callback_entry_list_t *new_listitem;
 151
 152     /* malloc/free strategy:
 153      *  - alloc-ded in add_callback_entry
 154      *  - free-ed by libvlc_event_remove_callback
 155      *  - free-ed in libvlc_destroy threw libvlc_event_remove_callback
 156      *    when entry is destroyed
 157      */
 158     new_listitem = malloc( sizeof( struct libvlc_callback_entry_list_t ) );
 159     new_listitem->elmt = entry;
 160     new_listitem->next = *list;
 161     new_listitem->prev = NULL;
 162
 163     if(*list)
 164         (*list)->prev = new_listitem;
 165
 166     *list = new_listitem;
 167 }
 168
 169 /**************************************************************************
 170  *       remove_variable_callback (private) :
 171  *
 172  * Delete the appropriate vlc variables callback for an event.
 173  **************************************************************************/
 174 static int remove_variable_callback( libvlc_instance_t *p_instance,
 175                                      struct libvlc_callback_entry_t * p_entry )
 176 {
 177     input_thread_t * p_input = get_input( p_instance );
 178     int res = VLC_SUCCESS;
 179
 180     /* Note: Appropriate lock should be held by the caller */
 181
 182     switch ( p_entry->i_event_type )
 183     {
 184         case libvlc_VolumeChanged:
 185             res = var_DelCallback( p_instance->p_libvlc_int, "volume-change",
 186                              handle_event, p_entry );
 187             break;
 188         case libvlc_InputPositionChanged:
 189             /* We may not be deleting the right p_input callback, in this case this
 190              * will be a no-op */
 191             var_DelCallback( p_input, "intf-change", handle_event, p_entry );
 192             var_DelCallback( p_input, "position", handle_event, p_entry );
 193             break;
 194     }
 195
 196     if (p_input)
 197         vlc_object_release( p_input );
 198
 199     return res;
 200 }
 201
 202 /*
 203  * Internal libvlc functions
 204  */
 205
 206 /**************************************************************************
 207  *       libvlc_event_init (internal) :
 208  *
 209  * initialization function.
 210  **************************************************************************/
 211 void libvlc_event_init( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
 212 {
 213     playlist_t *p_playlist = p_instance->p_libvlc_int->p_playlist;
 214
 215     if( !p_playlist )
 216         RAISEVOID ("Can't listen to input event");
 217
 218     /* Install a Callback for input changes, so
 219      * so we can track input event */
 220      var_AddCallback( p_playlist, "playlist-current",
 221                       install_input_event, p_instance );
 222 }
 223
 224 /**************************************************************************
 225  *       libvlc_event_fini (internal) :
 226  *
 227  * finalization function.
 228  **************************************************************************/
 229 void libvlc_event_fini( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
 230 {
 231     playlist_t *p_playlist = p_instance->p_libvlc_int->p_playlist;
 232     libvlc_exception_t p_e_unused;
 233
 234     libvlc_event_remove_all_callbacks( p_instance, &p_e_unused );
 235
 236     if( !p_playlist )
 237         RAISEVOID ("Can't unregister input events");
 238
 239     var_DelCallback( p_playlist, "playlist-current",
 240                      install_input_event, p_instance );
 241 }
 242
 243 /*
 244  * Public libvlc functions
 245  */
 246
 247 /**************************************************************************
 248  *       libvlc_event_add_callback (public) :
 249  *
 250  * Add a callback for an event.
 251  **************************************************************************/
 252 void libvlc_event_add_callback( libvlc_instance_t *p_instance,
 253                                 libvlc_event_type_t i_event_type,
 254                                 libvlc_callback_t f_callback,
 255                                 void *user_data,
 256                                 libvlc_exception_t *p_e )
 257 {
 258     struct libvlc_callback_entry_t *entry;
 259     vlc_value_t unused1, unused2;
 260     int res = VLC_SUCCESS;
 261
 262     if ( !f_callback )
 263         RAISEVOID (" Callback function is null ");
 264
 265     /* malloc/free strategy:
 266      *  - alloc-ded in libvlc_event_add_callback
 267      *  - free-ed by libvlc_event_add_callback on error
 268      *  - free-ed by libvlc_event_remove_callback
 269      *  - free-ed in libvlc_destroy threw libvlc_event_remove_callback
 270      *    when entry is destroyed
 271      */
 272     entry = malloc( sizeof( struct libvlc_callback_entry_t ) );
 273     entry->f_callback = f_callback;
 274     entry->i_event_type = i_event_type;
 275     entry->p_user_data = user_data;
 276
 277     switch ( i_event_type )
 278     {
 279         case libvlc_VolumeChanged:
 280             res = var_AddCallback( p_instance->p_libvlc_int, "volume-change",
 281                            handle_event, entry );
 282             break;
 283         case libvlc_InputPositionChanged:
 284             install_input_event( NULL, NULL, unused1, unused2, p_instance);
 285             break;
 286         default:
 287             free( entry );
 288             RAISEVOID( "Unsupported event." );
 289     }
 290
 291     if (res != VLC_SUCCESS)
 292     {
 293         free ( entry );
 294         RAISEVOID("Internal callback registration was not successful. Callback not registered.");
 295     }
 296
 297     vlc_mutex_lock( &p_instance->instance_lock );
 298     add_callback_to_list( entry, &p_instance->p_callback_list );
 299     vlc_mutex_unlock( &p_instance->instance_lock );
 300
 301     return;
 302 }
 303
 304 /**************************************************************************
 305  *       libvlc_event_remove_callback (public) :
 306  *
 307  * Remove a callback for an event.
 308  **************************************************************************/
 309 void libvlc_event_remove_callback( libvlc_instance_t *p_instance,
 310                                    libvlc_event_type_t i_event_type,
 311                                    libvlc_callback_t f_callback,
 312                                    void *p_user_data,
 313                                    libvlc_exception_t *p_e )
 314 {
 315     struct libvlc_callback_entry_list_t *p_listitem;
 316
 317     vlc_mutex_lock( &p_instance->instance_lock );
 318
 319     p_listitem = p_instance->p_callback_list;
 320
 321     while( p_listitem )
 322     {
 323         if( p_listitem->elmt->f_callback == f_callback
 324             && ( p_listitem->elmt->i_event_type == i_event_type )
 325             && ( p_listitem->elmt->p_user_data == p_user_data )
 326
 327         )
 328         {
 329             remove_variable_callback( p_instance, p_listitem->elmt ); /* FIXME: We should warn on error */
 330
 331             if( p_listitem->prev )
 332                 p_listitem->prev->next = p_listitem->next;
 333             else
 334                 p_instance->p_callback_list = p_listitem->next;
 335
 336
 337             p_listitem->next->prev = p_listitem->prev;
 338
 339             free( p_listitem->elmt );
 340
 341             free( p_listitem );
 342             break;
 343         }
 344
 345         p_listitem = p_listitem->next;
 346     }
 347     vlc_mutex_unlock( &p_instance->instance_lock );
 348 }
 349
 350 /**************************************************************************
 351  *       libvlc_event_remove_all_callbacks (public) :
 352  *
 353  * Remove all callbacks for all events.
 354  **************************************************************************/
 355 void libvlc_event_remove_all_callbacks( libvlc_instance_t *p_instance,
 356                                        libvlc_exception_t *p_e )
 357 {
 358     struct libvlc_callback_entry_list_t *p_listitem;
 359
 360     vlc_mutex_lock( &p_instance->instance_lock );
 361
 362     p_listitem = p_instance->p_callback_list;
 363
 364     while( p_listitem )
 365     {
 366         remove_variable_callback( p_instance, p_listitem->elmt ); /* FIXME: We could warn on error */
 367         p_listitem = p_listitem->next;
 368
 369     }
 370     p_instance->p_callback_list = NULL;
 371
 372     vlc_mutex_unlock( &p_instance->instance_lock );
 373 }