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