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 /*
  36  * Internal libvlc functions
  37  */
  38
  39 /**************************************************************************
  40  *       libvlc_event_init (internal) :
  41  *
  42  * initialization function.
  43  **************************************************************************/
  44 void libvlc_event_init( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
  45 {
  46     /* Will certainly be used to install libvlc_instance event */
  47 }
  48
  49 /**************************************************************************
  50  *       libvlc_event_fini (internal) :
  51  *
  52  * finalization function.
  53  **************************************************************************/
  54 void libvlc_event_fini( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
  55 {
  56 }
  57
  58 /**************************************************************************
  59  *       libvlc_event_manager_init (internal) :
  60  *
  61  * Init an object's event manager.
  62  **************************************************************************/
  63 libvlc_event_manager_t *
  64 libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst,
  65                            libvlc_exception_t *p_e )
  66 {
  67     libvlc_event_manager_t * p_em;
  68
  69     p_em = malloc(sizeof( libvlc_event_manager_t ));
  70     if( !p_em )
  71     {
  72         libvlc_exception_raise( p_e, "No Memory left" );
  73         return NULL;
  74     }
  75
  76     p_em->p_obj = p_obj;
  77     p_em->p_libvlc_instance = p_libvlc_inst;
  78     ARRAY_INIT( p_em->listeners_groups );
  79     vlc_mutex_init( p_libvlc_inst->p_libvlc_int, &p_em->object_lock );
  80
  81     return p_em;
  82 }
  83
  84 /**************************************************************************
  85  *       libvlc_event_manager_release (internal) :
  86  *
  87  * Init an object's event manager.
  88  **************************************************************************/
  89 void libvlc_event_manager_release( libvlc_event_manager_t * p_em )
  90 {
  91     libvlc_event_listeners_group_t * listeners_group;
  92     libvlc_event_listener_t * listener;
  93
  94     vlc_mutex_destroy( &p_em->object_lock );
  95
  96     FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
  97         FOREACH_ARRAY( listener, listeners_group->listeners )
  98             free( listener );
  99         FOREACH_END()
 100         free( listeners_group );
 101     FOREACH_END()
 102     free( p_em );
 103 }
 104
 105 /**************************************************************************
 106  *       libvlc_event_manager_register_event_type (internal) :
 107  *
 108  * Init an object's event manager.
 109  **************************************************************************/
 110 void libvlc_event_manager_register_event_type(
 111         libvlc_event_manager_t * p_em,
 112         libvlc_event_type_t event_type,
 113         libvlc_exception_t * p_e )
 114 {
 115     libvlc_event_listeners_group_t * listeners_group;
 116     listeners_group = malloc(sizeof(libvlc_event_listeners_group_t));
 117     if( !listeners_group )
 118     {
 119         libvlc_exception_raise( p_e, "No Memory left" );
 120         return;
 121     }
 122
 123     listeners_group->event_type = event_type;
 124     ARRAY_INIT( listeners_group->listeners );
 125
 126     vlc_mutex_lock( &p_em->object_lock );
 127     ARRAY_APPEND( p_em->listeners_groups, listeners_group );
 128     vlc_mutex_unlock( &p_em->object_lock );
 129 }
 130
 131 /**************************************************************************
 132  *       libvlc_event_send (internal) :
 133  *
 134  * Send a callback.
 135  **************************************************************************/
 136 void libvlc_event_send( libvlc_event_manager_t * p_em,
 137                         libvlc_event_t * p_event )
 138 {
 139     libvlc_event_listeners_group_t * listeners_group;
 140     libvlc_event_listener_t * listener_cached;
 141     libvlc_event_listener_t * listener;
 142     libvlc_event_listener_t * array_listeners_cached = NULL;
 143     int i, i_cached_listeners = 0;
 144
 145     /* Fill event with the sending object now */
 146     p_event->p_obj = p_em->p_obj;
 147
 148     vlc_mutex_lock( &p_em->object_lock );
 149     FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
 150         if( listeners_group->event_type == p_event->type )
 151         {
 152             if( listeners_group->listeners.i_size <= 0 )
 153                 break;
 154
 155             /* Cache a copy of the listener to avoid locking issues */
 156             i_cached_listeners = listeners_group->listeners.i_size;
 157             array_listeners_cached = malloc(sizeof(libvlc_event_listener_t)*(i_cached_listeners));
 158             if( !array_listeners_cached )
 159             {
 160                 printf( "Can't alloc memory in libvlc_event_send" );
 161                 break;
 162             }
 163
 164             listener_cached = array_listeners_cached;
 165             FOREACH_ARRAY( listener, listeners_group->listeners )
 166                 memcpy( listener_cached, listener, sizeof(libvlc_event_listener_t));
 167                 listener_cached++;
 168             FOREACH_END()
 169             break;
 170         }
 171     FOREACH_END()
 172     vlc_mutex_unlock( &p_em->object_lock );
 173
 174     listener_cached = array_listeners_cached;
 175     for( i = 0; i < i_cached_listeners; i++ )
 176     {
 177         listener_cached->pf_callback( p_event, listener_cached->p_user_data );
 178         listener_cached++;
 179     }
 180     free( array_listeners_cached );
 181 }
 182
 183 /*
 184  * Public libvlc functions
 185  */
 186
 187 /**************************************************************************
 188  *       libvlc_event_attach (public) :
 189  *
 190  * Add a callback for an event.
 191  **************************************************************************/
 192 void libvlc_event_attach( libvlc_event_manager_t * p_event_manager,
 193                           libvlc_event_type_t event_type,
 194                           libvlc_callback_t pf_callback,
 195                           void *p_user_data,
 196                           libvlc_exception_t *p_e )
 197 {
 198     libvlc_event_listeners_group_t * listeners_group;
 199     libvlc_event_listener_t * listener;
 200     listener = malloc(sizeof(libvlc_event_listener_t));
 201     if( !listener )
 202     {
 203         libvlc_exception_raise( p_e, "No Memory left" );
 204         return;
 205     }
 206
 207     listener->event_type = event_type;
 208     listener->p_user_data = p_user_data;
 209     listener->pf_callback = pf_callback;
 210
 211     vlc_mutex_lock( &p_event_manager->object_lock );
 212     FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
 213         if( listeners_group->event_type == listener->event_type )
 214         {
 215             ARRAY_APPEND( listeners_group->listeners, listener );
 216             vlc_mutex_unlock( &p_event_manager->object_lock );
 217             return;
 218         }
 219     FOREACH_END()
 220     vlc_mutex_unlock( &p_event_manager->object_lock );
 221
 222     free(listener);
 223     libvlc_exception_raise( p_e,
 224             "This object event manager doesn't know about '%s' events",
 225             libvlc_event_type_name(a));
 226 }
 227
 228 /**************************************************************************
 229  *       libvlc_event_detach (public) :
 230  *
 231  * Remove a callback for an event.
 232  **************************************************************************/
 233 void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
 234                           libvlc_event_type_t event_type,
 235                           libvlc_callback_t pf_callback,
 236                           void *p_user_data,
 237                           libvlc_exception_t *p_e )
 238 {
 239     libvlc_event_listeners_group_t * listeners_group;
 240     libvlc_event_listener_t * listener;
 241
 242     vlc_mutex_lock( &p_event_manager->object_lock );
 243     FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
 244         if( listeners_group->event_type == event_type )
 245         {
 246             FOREACH_ARRAY( listener, listeners_group->listeners )
 247                 if( listener->event_type == event_type &&
 248                     listener->pf_callback == pf_callback &&
 249                     listener->p_user_data == p_user_data )
 250                 {
 251                     /* that's our listener */
 252                     free( listener );
 253                     ARRAY_REMOVE( listeners_group->listeners,
 254                         fe_idx /* This comes from the macro (and that's why
 255                                   I hate macro) */ );
 256                     vlc_mutex_unlock( &p_event_manager->object_lock );
 257                     return;
 258                 }
 259             FOREACH_END()
 260         }
 261     FOREACH_END()
 262     vlc_mutex_unlock( &p_event_manager->object_lock );
 263
 264     libvlc_exception_raise( p_e,
 265             "This object event manager doesn't know about '%i,%p,%p' event observer",
 266             event_type, pf_callback, p_user_data );
 267 }