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  * Private functions
  31  */
  32
  33 static bool
  34 listeners_are_equal( libvlc_event_listener_t * listener1,
  35                      libvlc_event_listener_t * listener2 )
  36 {
  37     return listener1->event_type  == listener2->event_type &&
  38            listener1->pf_callback == listener2->pf_callback &&
  39            listener1->p_user_data == listener2->p_user_data;
  40 }
  41
  42 static bool
  43 group_contains_listener( libvlc_event_listeners_group_t * group,
  44                          libvlc_event_listener_t * searched_listener )
  45 {
  46     int i;
  47     for( i = 0; i < vlc_array_count(&group->listeners); i++ )
  48     {
  49         if( listeners_are_equal(searched_listener, vlc_array_item_at_index(&group->listeners, i)) )
  50             return true;
  51     }
  52     return false;
  53 }
  54
  55 /*
  56  * Internal libvlc functions
  57  */
  58
  59 /**************************************************************************
  60  *       libvlc_event_manager_init (internal) :
  61  *
  62  * Init an object's event manager.
  63  **************************************************************************/
  64 libvlc_event_manager_t *
  65 libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst,
  66                            libvlc_exception_t *p_e )
  67 {
  68     libvlc_event_manager_t * p_em;
  69
  70     p_em = malloc(sizeof( libvlc_event_manager_t ));
  71     if( !p_em )
  72     {
  73         libvlc_exception_raise( p_e, "No Memory left" );
  74         return NULL;
  75     }
  76
  77     p_em->p_obj = p_obj;
  78     p_em->p_libvlc_instance = p_libvlc_inst;
  79     libvlc_retain( p_libvlc_inst );
  80     vlc_array_init( &p_em->listeners_groups );
  81     vlc_mutex_init( &p_em->object_lock );
  82     vlc_mutex_init_recursive( &p_em->event_sending_lock );
  83     return p_em;
  84 }
  85
  86 /**************************************************************************
  87  *       libvlc_event_manager_release (internal) :
  88  *
  89  * Init an object's event manager.
  90  **************************************************************************/
  91 void libvlc_event_manager_release( libvlc_event_manager_t * p_em )
  92 {
  93     libvlc_event_listeners_group_t * p_lg;
  94     int i,j ;
  95
  96     vlc_mutex_destroy( &p_em->event_sending_lock );
  97     vlc_mutex_destroy( &p_em->object_lock );
  98
  99     for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++)
 100     {
 101         p_lg = vlc_array_item_at_index( &p_em->listeners_groups, i );
 102
 103         for( j = 0; j < vlc_array_count(&p_lg->listeners); j++)
 104             free( vlc_array_item_at_index( &p_em->listeners_groups, i ) );
 105
 106         vlc_array_clear( &p_lg->listeners );
 107         free( p_lg );
 108     }
 109     vlc_array_clear( &p_em->listeners_groups );
 110     libvlc_release( p_em->p_libvlc_instance );
 111     free( p_em );
 112 }
 113
 114 /**************************************************************************
 115  *       libvlc_event_manager_register_event_type (internal) :
 116  *
 117  * Init an object's event manager.
 118  **************************************************************************/
 119 void libvlc_event_manager_register_event_type(
 120         libvlc_event_manager_t * p_em,
 121         libvlc_event_type_t event_type,
 122         libvlc_exception_t * p_e )
 123 {
 124     libvlc_event_listeners_group_t * listeners_group;
 125     listeners_group = malloc(sizeof(libvlc_event_listeners_group_t));
 126     if( !listeners_group )
 127     {
 128         libvlc_exception_raise( p_e, "No Memory left" );
 129         return;
 130     }
 131
 132     listeners_group->event_type = event_type;
 133     vlc_array_init( &listeners_group->listeners );
 134
 135     vlc_mutex_lock( &p_em->object_lock );
 136     vlc_array_append( &p_em->listeners_groups, listeners_group );
 137     vlc_mutex_unlock( &p_em->object_lock );
 138 }
 139
 140 /**************************************************************************
 141  *       libvlc_event_send (internal) :
 142  *
 143  * Send a callback.
 144  **************************************************************************/
 145 void libvlc_event_send( libvlc_event_manager_t * p_em,
 146                         libvlc_event_t * p_event )
 147 {
 148     libvlc_event_listeners_group_t * listeners_group = NULL;
 149     libvlc_event_listener_t * listener_cached;
 150     libvlc_event_listener_t * listener;
 151     libvlc_event_listener_t * array_listeners_cached = NULL;
 152     int i, i_cached_listeners = 0;
 153
 154     /* Fill event with the sending object now */
 155     p_event->p_obj = p_em->p_obj;
 156
 157     /* Here a read/write lock would be nice */
 158
 159     vlc_mutex_lock( &p_em->object_lock );
 160     for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++)
 161     {
 162         listeners_group = vlc_array_item_at_index(&p_em->listeners_groups, i);
 163         if( listeners_group->event_type == p_event->type )
 164         {
 165             if( vlc_array_count( &listeners_group->listeners ) <= 0 )
 166                 break;
 167
 168             /* Cache a copy of the listener to avoid locking issues */
 169             i_cached_listeners = vlc_array_count(&listeners_group->listeners);
 170             array_listeners_cached = malloc(sizeof(libvlc_event_listener_t)*(i_cached_listeners));
 171             if( !array_listeners_cached )
 172             {
 173                 printf( "Can't alloc memory in libvlc_event_send" );
 174                 break;
 175             }
 176
 177             listener_cached = array_listeners_cached;
 178             for( i = 0; i < vlc_array_count(&listeners_group->listeners); i++)
 179             {
 180                 listener = vlc_array_item_at_index(&listeners_group->listeners, i);
 181                 memcpy( listener_cached, listener, sizeof(libvlc_event_listener_t) );
 182                 listener_cached++;
 183             }
 184             break;
 185         }
 186     }
 187
 188     if( !listeners_group )
 189     {
 190         free( array_listeners_cached );
 191         return;
 192     }
 193
 194     vlc_mutex_unlock( &p_em->object_lock );
 195
 196     vlc_mutex_lock( &p_em->event_sending_lock );
 197     listener_cached = array_listeners_cached;
 198     listeners_group->b_sublistener_removed = false;
 199     for( i = 0; i < i_cached_listeners; i++ )
 200     {
 201         if( listeners_group->b_sublistener_removed )
 202         {
 203             /* If a callback was removed, this gets called */
 204             bool valid_listener;
 205             vlc_mutex_lock( &p_em->object_lock );
 206             valid_listener = group_contains_listener( listeners_group, listener_cached );
 207             vlc_mutex_unlock( &p_em->object_lock );
 208             if( !valid_listener )
 209             {
 210                 listener_cached++;
 211                 continue;
 212             }
 213         }
 214
 215         listener_cached->pf_callback( p_event, listener_cached->p_user_data );
 216         listener_cached++;
 217     }
 218     vlc_mutex_unlock( &p_em->event_sending_lock );
 219
 220     free( array_listeners_cached );
 221 }
 222
 223 /*
 224  * Public libvlc functions
 225  */
 226
 227 /**************************************************************************
 228  *       libvlc_event_type_name (public) :
 229  *
 230  * Get the char * name of an event type.
 231  **************************************************************************/
 232 static const char event_type_to_name[][35] =
 233 {
 234 #define EVENT(a) [a]=#a
 235     EVENT(libvlc_MediaMetaChanged),
 236     EVENT(libvlc_MediaSubItemAdded),
 237     EVENT(libvlc_MediaDurationChanged),
 238     EVENT(libvlc_MediaPreparsedChanged),
 239     EVENT(libvlc_MediaFreed),
 240     EVENT(libvlc_MediaStateChanged),
 241
 242     EVENT(libvlc_MediaPlayerNothingSpecial),
 243     EVENT(libvlc_MediaPlayerOpening),
 244     EVENT(libvlc_MediaPlayerBuffering),
 245     EVENT(libvlc_MediaPlayerPlaying),
 246     EVENT(libvlc_MediaPlayerPaused),
 247     EVENT(libvlc_MediaPlayerStopped),
 248     EVENT(libvlc_MediaPlayerForward),
 249     EVENT(libvlc_MediaPlayerBackward),
 250     EVENT(libvlc_MediaPlayerEndReached),
 251     EVENT(libvlc_MediaPlayerTimeChanged),
 252     EVENT(libvlc_MediaPlayerPositionChanged),
 253     EVENT(libvlc_MediaPlayerSeekableChanged),
 254     EVENT(libvlc_MediaPlayerPausableChanged),
 255
 256     EVENT(libvlc_MediaListItemAdded),
 257     EVENT(libvlc_MediaListWillAddItem),
 258     EVENT(libvlc_MediaListItemDeleted),
 259     EVENT(libvlc_MediaListWillDeleteItem),
 260
 261     EVENT(libvlc_MediaListViewItemAdded),
 262     EVENT(libvlc_MediaListViewWillAddItem),
 263     EVENT(libvlc_MediaListViewItemDeleted),
 264     EVENT(libvlc_MediaListViewWillDeleteItem),
 265
 266     EVENT(libvlc_MediaListPlayerPlayed),
 267     EVENT(libvlc_MediaListPlayerNextItemSet),
 268     EVENT(libvlc_MediaListPlayerStopped),
 269
 270     EVENT(libvlc_MediaDiscovererStarted),
 271     EVENT(libvlc_MediaDiscovererEnded)
 272 #undef EVENT
 273 };
 274
 275 static const char unkwown_event_name[] = "Unknown Event";
 276
 277 const char * libvlc_event_type_name( libvlc_event_type_t event_type )
 278 {
 279     if( event_type >= sizeof(event_type_to_name)/sizeof(event_type_to_name[0]))
 280         return unkwown_event_name;
 281     return event_type_to_name[event_type];
 282 }
 283
 284 /**************************************************************************
 285  *       libvlc_event_attach (public) :
 286  *
 287  * Add a callback for an event.
 288  **************************************************************************/
 289 void libvlc_event_attach( libvlc_event_manager_t * p_event_manager,
 290                           libvlc_event_type_t event_type,
 291                           libvlc_callback_t pf_callback,
 292                           void *p_user_data,
 293                           libvlc_exception_t *p_e )
 294 {
 295     libvlc_event_listeners_group_t * listeners_group;
 296     libvlc_event_listener_t * listener;
 297     int i;
 298
 299     listener = malloc(sizeof(libvlc_event_listener_t));
 300     if( !listener )
 301     {
 302         libvlc_exception_raise( p_e, "No Memory left" );
 303         return;
 304     }
 305
 306     listener->event_type = event_type;
 307     listener->p_user_data = p_user_data;
 308     listener->pf_callback = pf_callback;
 309
 310     vlc_mutex_lock( &p_event_manager->object_lock );
 311     for( i = 0; i < vlc_array_count(&p_event_manager->listeners_groups); i++ )
 312     {
 313         listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i);
 314         if( listeners_group->event_type == listener->event_type )
 315         {
 316             vlc_array_append( &listeners_group->listeners, listener );
 317             vlc_mutex_unlock( &p_event_manager->object_lock );
 318             return;
 319         }
 320     }
 321     vlc_mutex_unlock( &p_event_manager->object_lock );
 322
 323     free(listener);
 324     libvlc_exception_raise( p_e,
 325             "This object event manager doesn't know about '%s' events",
 326             libvlc_event_type_name(event_type));
 327 }
 328
 329 /**************************************************************************
 330  *       libvlc_event_detach (public) :
 331  *
 332  * Remove a callback for an event.
 333  **************************************************************************/
 334 void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
 335                                      libvlc_event_type_t event_type,
 336                                      libvlc_callback_t pf_callback,
 337                                      void *p_user_data,
 338                                      libvlc_exception_t *p_e )
 339 {
 340     libvlc_event_listeners_group_t * listeners_group;
 341     libvlc_event_listener_t * listener;
 342     int i, j;
 343
 344     vlc_mutex_lock( &p_event_manager->event_sending_lock );
 345     vlc_mutex_lock( &p_event_manager->object_lock );
 346     for( i = 0; i < vlc_array_count(&p_event_manager->listeners_groups); i++)
 347     {
 348         listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i);
 349         if( listeners_group->event_type == event_type )
 350         {
 351             for( j = 0; j < vlc_array_count(&listeners_group->listeners); j++)
 352             {
 353                 listener = vlc_array_item_at_index(&listeners_group->listeners, j);
 354                 if( listener->event_type == event_type &&
 355                     listener->pf_callback == pf_callback &&
 356                     listener->p_user_data == p_user_data )
 357                 {
 358                     /* that's our listener */
 359
 360                     /* Mark this group as edited so that libvlc_event_send
 361                      * will recheck what listener to call */
 362                     listeners_group->b_sublistener_removed = false;
 363
 364                     free( listener );
 365                     vlc_array_remove( &listeners_group->listeners, j );
 366                     vlc_mutex_unlock( &p_event_manager->object_lock );
 367                     vlc_mutex_unlock( &p_event_manager->event_sending_lock );
 368                     return;
 369                 }
 370             }
 371         }
 372     }
 373     vlc_mutex_unlock( &p_event_manager->object_lock );
 374     vlc_mutex_unlock( &p_event_manager->event_sending_lock );
 375
 376     libvlc_exception_raise( p_e,
 377             "This object event manager doesn't know about '%s,%p,%p' event observer",
 378             libvlc_event_type_name(event_type), pf_callback, p_user_data );
 379 }