1 /*****************************************************************************
2 * event.c: New libvlc event control API
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
7 * Authors: Filippo Carone <filippo@carone.org>
8 * Pierre d'Herbemont <pdherbemont # videolan.org>
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.
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.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
29 #define LIBVLC_EVENT_TYPES_KEEP_DEFINE
30 #include <vlc/libvlc.h>
32 #include "libvlc_internal.h"
33 #include "event_internal.h"
36 typedef struct libvlc_event_listeners_group_t
38 libvlc_event_type_t event_type;
39 vlc_array_t listeners;
40 bool b_sublistener_removed;
41 } libvlc_event_listeners_group_t;
48 group_contains_listener( libvlc_event_listeners_group_t * group,
49 libvlc_event_listener_t * searched_listener )
52 for( i = 0; i < vlc_array_count(&group->listeners); i++ )
54 if( listeners_are_equal(searched_listener, vlc_array_item_at_index(&group->listeners, i)) )
61 * Internal libvlc functions
64 /**************************************************************************
65 * libvlc_event_manager_new (internal) :
67 * Init an object's event manager.
68 **************************************************************************/
69 libvlc_event_manager_t *
70 libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst,
71 libvlc_exception_t *p_e )
73 libvlc_event_manager_t * p_em;
75 p_em = malloc(sizeof( libvlc_event_manager_t ));
78 libvlc_exception_raise( p_e );
79 libvlc_printerr( "Not enough memory" );
85 p_em->async_event_queue = NULL;
86 p_em->p_libvlc_instance = p_libvlc_inst;
88 libvlc_retain( p_libvlc_inst );
89 vlc_array_init( &p_em->listeners_groups );
90 vlc_mutex_init( &p_em->object_lock );
91 vlc_mutex_init_recursive( &p_em->event_sending_lock );
95 /**************************************************************************
96 * libvlc_event_manager_release (internal) :
98 * Release an object's event manager.
99 **************************************************************************/
100 void libvlc_event_manager_release( libvlc_event_manager_t * p_em )
102 libvlc_event_listeners_group_t * p_lg;
105 libvlc_event_async_fini(p_em);
107 vlc_mutex_destroy( &p_em->event_sending_lock );
108 vlc_mutex_destroy( &p_em->object_lock );
110 for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++)
112 p_lg = vlc_array_item_at_index( &p_em->listeners_groups, i );
114 for( j = 0; j < vlc_array_count(&p_lg->listeners); j++)
115 free( vlc_array_item_at_index( &p_lg->listeners, j ) );
117 vlc_array_clear( &p_lg->listeners );
120 vlc_array_clear( &p_em->listeners_groups );
121 libvlc_release( p_em->p_libvlc_instance );
125 /**************************************************************************
126 * libvlc_event_manager_register_event_type (internal) :
128 * Init an object's event manager.
129 **************************************************************************/
130 void libvlc_event_manager_register_event_type(
131 libvlc_event_manager_t * p_em,
132 libvlc_event_type_t event_type,
133 libvlc_exception_t * p_e )
135 libvlc_event_listeners_group_t * listeners_group;
136 listeners_group = malloc(sizeof(libvlc_event_listeners_group_t));
137 if( !listeners_group )
139 libvlc_exception_raise( p_e );
140 libvlc_printerr( "Not enough memory" );
144 listeners_group->event_type = event_type;
145 vlc_array_init( &listeners_group->listeners );
147 vlc_mutex_lock( &p_em->object_lock );
148 vlc_array_append( &p_em->listeners_groups, listeners_group );
149 vlc_mutex_unlock( &p_em->object_lock );
152 /**************************************************************************
153 * libvlc_event_send (internal) :
156 **************************************************************************/
157 void libvlc_event_send( libvlc_event_manager_t * p_em,
158 libvlc_event_t * p_event )
160 libvlc_event_listeners_group_t * listeners_group = NULL;
161 libvlc_event_listener_t * listener_cached;
162 libvlc_event_listener_t * listener;
163 libvlc_event_listener_t * array_listeners_cached = NULL;
164 int i, i_cached_listeners = 0;
166 /* Fill event with the sending object now */
167 p_event->p_obj = p_em->p_obj;
169 /* Here a read/write lock would be nice */
171 vlc_mutex_lock( &p_em->object_lock );
172 for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++)
174 listeners_group = vlc_array_item_at_index(&p_em->listeners_groups, i);
175 if( listeners_group->event_type == p_event->type )
177 if( vlc_array_count( &listeners_group->listeners ) <= 0 )
180 /* Cache a copy of the listener to avoid locking issues,
181 * and allow that edition of listeners during callbacks will garantee immediate effect. */
182 i_cached_listeners = vlc_array_count(&listeners_group->listeners);
183 array_listeners_cached = malloc(sizeof(libvlc_event_listener_t)*(i_cached_listeners));
184 if( !array_listeners_cached )
186 vlc_mutex_unlock( &p_em->object_lock );
187 fprintf(stderr, "Can't alloc memory in libvlc_event_send" );
191 listener_cached = array_listeners_cached;
192 for( i = 0; i < vlc_array_count(&listeners_group->listeners); i++)
194 listener = vlc_array_item_at_index(&listeners_group->listeners, i);
195 memcpy( listener_cached, listener, sizeof(libvlc_event_listener_t) );
202 if( !listeners_group )
204 free( array_listeners_cached );
205 vlc_mutex_unlock( &p_em->object_lock );
209 vlc_mutex_unlock( &p_em->object_lock );
211 vlc_mutex_lock( &p_em->event_sending_lock );
212 listener_cached = array_listeners_cached;
213 listeners_group->b_sublistener_removed = false;
214 for( i = 0; i < i_cached_listeners; i++ )
216 if(listener_cached->is_asynchronous)
218 /* The listener wants not to block the emitter during event callback */
219 libvlc_event_async_dispatch(p_em, listener_cached, p_event);
223 /* The listener wants to block the emitter during event callback */
225 listener_cached->pf_callback( p_event, listener_cached->p_user_data );
228 if( listeners_group->b_sublistener_removed )
230 /* If a callback was removed, this gets called */
232 vlc_mutex_lock( &p_em->object_lock );
233 valid_listener = group_contains_listener( listeners_group, listener_cached );
234 vlc_mutex_unlock( &p_em->object_lock );
235 if( !valid_listener )
243 vlc_mutex_unlock( &p_em->event_sending_lock );
245 free( array_listeners_cached );
249 * Public libvlc functions
252 /**************************************************************************
253 * libvlc_event_type_name (public) :
255 * Get the char * name of an event type.
256 **************************************************************************/
257 static const char event_type_to_name[][libvlc_num_event_types] =
259 #define DEF(a) [libvlc_##a]=#a
260 DEFINE_LIBVLC_EVENT_TYPES
264 static const char unknown_event_name[] = "Unknown Event";
266 const char * libvlc_event_type_name( libvlc_event_type_t event_type )
268 if( event_type >= libvlc_num_event_types )
269 return unknown_event_name;
270 return event_type_to_name[event_type];
273 /**************************************************************************
274 * event_attach (internal) :
276 * Add a callback for an event.
277 **************************************************************************/
279 void event_attach( libvlc_event_manager_t * p_event_manager,
280 libvlc_event_type_t event_type,
281 libvlc_callback_t pf_callback,
283 bool is_asynchronous,
284 libvlc_exception_t *p_e )
286 libvlc_event_listeners_group_t * listeners_group;
287 libvlc_event_listener_t * listener;
290 listener = malloc(sizeof(libvlc_event_listener_t));
293 libvlc_exception_raise( p_e );
294 libvlc_printerr( "Not enough memory" );
298 listener->event_type = event_type;
299 listener->p_user_data = p_user_data;
300 listener->pf_callback = pf_callback;
301 listener->is_asynchronous = is_asynchronous;
303 vlc_mutex_lock( &p_event_manager->object_lock );
304 for( i = 0; i < vlc_array_count(&p_event_manager->listeners_groups); i++ )
306 listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i);
307 if( listeners_group->event_type == listener->event_type )
309 vlc_array_append( &listeners_group->listeners, listener );
310 vlc_mutex_unlock( &p_event_manager->object_lock );
314 vlc_mutex_unlock( &p_event_manager->object_lock );
317 fprintf( stderr, "This object event manager doesn't know about '%s' events",
318 libvlc_event_type_name(event_type) );
322 /**************************************************************************
323 * libvlc_event_attach (public) :
325 * Add a callback for an event.
326 **************************************************************************/
327 void libvlc_event_attach( libvlc_event_manager_t * p_event_manager,
328 libvlc_event_type_t event_type,
329 libvlc_callback_t pf_callback,
331 libvlc_exception_t *p_e )
333 event_attach(p_event_manager, event_type, pf_callback, p_user_data, false /* synchronous */, p_e);
336 /**************************************************************************
337 * libvlc_event_attach (public) :
339 * Add a callback for an event.
340 **************************************************************************/
341 void libvlc_event_attach_async( libvlc_event_manager_t * p_event_manager,
342 libvlc_event_type_t event_type,
343 libvlc_callback_t pf_callback,
345 libvlc_exception_t *p_e )
347 event_attach(p_event_manager, event_type, pf_callback, p_user_data, true /* asynchronous */, p_e);
350 /**************************************************************************
351 * libvlc_event_detach (public) :
353 * Remove a callback for an event.
354 **************************************************************************/
355 void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
356 libvlc_event_type_t event_type,
357 libvlc_callback_t pf_callback,
359 libvlc_exception_t *p_e )
362 libvlc_event_listeners_group_t * listeners_group;
363 libvlc_event_listener_t * listener;
367 vlc_mutex_lock( &p_event_manager->event_sending_lock );
368 vlc_mutex_lock( &p_event_manager->object_lock );
369 for( i = 0; i < vlc_array_count(&p_event_manager->listeners_groups); i++)
371 listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i);
372 if( listeners_group->event_type == event_type )
374 for( j = 0; j < vlc_array_count(&listeners_group->listeners); j++)
376 listener = vlc_array_item_at_index(&listeners_group->listeners, j);
377 if( listener->event_type == event_type &&
378 listener->pf_callback == pf_callback &&
379 listener->p_user_data == p_user_data )
381 /* that's our listener */
383 /* Mark this group as edited so that libvlc_event_send
384 * will recheck what listener to call */
385 listeners_group->b_sublistener_removed = false;
388 vlc_array_remove( &listeners_group->listeners, j );
395 vlc_mutex_unlock( &p_event_manager->object_lock );
396 vlc_mutex_unlock( &p_event_manager->event_sending_lock );
398 /* Now make sure any pending async event won't get fired after that point */
399 libvlc_event_listener_t listener_to_remove;
400 listener_to_remove.event_type = event_type;
401 listener_to_remove.pf_callback = pf_callback;
402 listener_to_remove.p_user_data = p_user_data;
403 listener_to_remove.is_asynchronous = true;
405 libvlc_event_async_ensure_listener_removal(p_event_manager, &listener_to_remove);