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
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 *****************************************************************************/
25 #include "libvlc_internal.h"
26 #include <vlc/libvlc.h>
27 #include <vlc_playlist.h>
35 listeners_are_equal( libvlc_event_listener_t * listener1,
36 libvlc_event_listener_t * listener2 )
38 return listener1->event_type == listener2->event_type &&
39 listener1->pf_callback == listener2->pf_callback &&
40 listener1->p_user_data == listener2->p_user_data;
44 group_contains_listener( libvlc_event_listeners_group_t * group,
45 libvlc_event_listener_t * searched_listener )
48 for( i = 0; i < vlc_array_count(&group->listeners); i++ )
50 if( listeners_are_equal(searched_listener, vlc_array_item_at_index(&group->listeners, i)) )
57 * Internal libvlc functions
60 /**************************************************************************
61 * libvlc_event_init (internal) :
63 * initialization function.
64 **************************************************************************/
65 void libvlc_event_init( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
67 (void)p_instance;(void)p_e;
68 /* Will certainly be used to install libvlc_instance event */
71 /**************************************************************************
72 * libvlc_event_fini (internal) :
74 * finalization function.
75 **************************************************************************/
76 void libvlc_event_fini( libvlc_instance_t *p_instance )
81 /**************************************************************************
82 * libvlc_event_manager_init (internal) :
84 * Init an object's event manager.
85 **************************************************************************/
86 libvlc_event_manager_t *
87 libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst,
88 libvlc_exception_t *p_e )
90 libvlc_event_manager_t * p_em;
92 p_em = malloc(sizeof( libvlc_event_manager_t ));
95 libvlc_exception_raise( p_e, "No Memory left" );
100 p_em->p_libvlc_instance = p_libvlc_inst;
101 libvlc_retain( p_libvlc_inst );
102 vlc_array_init( &p_em->listeners_groups );
103 vlc_mutex_init( p_libvlc_inst->p_libvlc_int, &p_em->object_lock );
104 vlc_mutex_init_recursive( p_libvlc_inst->p_libvlc_int, &p_em->event_sending_lock );
108 /**************************************************************************
109 * libvlc_event_manager_release (internal) :
111 * Init an object's event manager.
112 **************************************************************************/
113 void libvlc_event_manager_release( libvlc_event_manager_t * p_em )
115 libvlc_event_listeners_group_t * p_lg;
118 vlc_mutex_destroy( &p_em->event_sending_lock );
119 vlc_mutex_destroy( &p_em->object_lock );
121 for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++)
123 p_lg = vlc_array_item_at_index( &p_em->listeners_groups, i );
125 for( j = 0; j < vlc_array_count(&p_lg->listeners); j++)
126 free( vlc_array_item_at_index( &p_em->listeners_groups, i ) );
128 vlc_array_clear( &p_lg->listeners );
131 vlc_array_clear( &p_em->listeners_groups );
132 libvlc_release( p_em->p_libvlc_instance );
136 /**************************************************************************
137 * libvlc_event_manager_register_event_type (internal) :
139 * Init an object's event manager.
140 **************************************************************************/
141 void libvlc_event_manager_register_event_type(
142 libvlc_event_manager_t * p_em,
143 libvlc_event_type_t event_type,
144 libvlc_exception_t * p_e )
146 libvlc_event_listeners_group_t * listeners_group;
147 listeners_group = malloc(sizeof(libvlc_event_listeners_group_t));
148 if( !listeners_group )
150 libvlc_exception_raise( p_e, "No Memory left" );
154 listeners_group->event_type = event_type;
155 vlc_array_init( &listeners_group->listeners );
157 vlc_mutex_lock( &p_em->object_lock );
158 vlc_array_append( &p_em->listeners_groups, listeners_group );
159 vlc_mutex_unlock( &p_em->object_lock );
162 /**************************************************************************
163 * libvlc_event_send (internal) :
166 **************************************************************************/
167 void libvlc_event_send( libvlc_event_manager_t * p_em,
168 libvlc_event_t * p_event )
170 libvlc_event_listeners_group_t * listeners_group;
171 libvlc_event_listener_t * listener_cached;
172 libvlc_event_listener_t * listener;
173 libvlc_event_listener_t * array_listeners_cached = NULL;
174 int i, i_cached_listeners = 0;
176 /* Fill event with the sending object now */
177 p_event->p_obj = p_em->p_obj;
179 /* Here a read/write lock would be nice */
181 vlc_mutex_lock( &p_em->object_lock );
182 for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++)
184 listeners_group = vlc_array_item_at_index(&p_em->listeners_groups, i);
185 if( listeners_group->event_type == p_event->type )
187 if( vlc_array_count( &listeners_group->listeners ) <= 0 )
190 /* Cache a copy of the listener to avoid locking issues */
191 i_cached_listeners = vlc_array_count(&listeners_group->listeners);
192 array_listeners_cached = malloc(sizeof(libvlc_event_listener_t)*(i_cached_listeners));
193 if( !array_listeners_cached )
195 printf( "Can't alloc memory in libvlc_event_send" );
199 listener_cached = array_listeners_cached;
200 for( i = 0; i < vlc_array_count(&listeners_group->listeners); i++)
202 listener = vlc_array_item_at_index(&listeners_group->listeners, i);
203 memcpy( listener_cached, listener, sizeof(libvlc_event_listener_t) );
210 if( !listeners_group )
212 free( array_listeners_cached );
216 vlc_mutex_unlock( &p_em->object_lock );
218 vlc_mutex_lock( &p_em->event_sending_lock );
219 listener_cached = array_listeners_cached;
220 listeners_group->b_sublistener_removed = VLC_FALSE;
221 for( i = 0; i < i_cached_listeners; i++ )
223 if( listeners_group->b_sublistener_removed )
225 /* If a callback was removed, this gets called */
226 vlc_bool_t valid_listener;
227 vlc_mutex_lock( &p_em->object_lock );
228 valid_listener = group_contains_listener( listeners_group, listener_cached );
229 vlc_mutex_unlock( &p_em->object_lock );
230 if( !valid_listener )
237 listener_cached->pf_callback( p_event, listener_cached->p_user_data );
240 vlc_mutex_unlock( &p_em->event_sending_lock );
242 free( array_listeners_cached );
246 * Public libvlc functions
249 /**************************************************************************
250 * libvlc_event_type_name (public) :
252 * Get the char * name of an event type.
253 **************************************************************************/
254 static const char * event_type_to_name[] =
256 #define EVENT(a) [a]=#a
257 EVENT(libvlc_MediaDescriptorMetaChanged),
258 EVENT(libvlc_MediaDescriptorSubItemAdded),
259 EVENT(libvlc_MediaDescriptorDurationChanged),
260 EVENT(libvlc_MediaDescriptorPreparsedChanged),
261 EVENT(libvlc_MediaDescriptorFreed),
262 EVENT(libvlc_MediaDescriptorStateChanged),
264 EVENT(libvlc_MediaInstancePlayed),
265 EVENT(libvlc_MediaInstancePaused),
266 EVENT(libvlc_MediaInstanceReachedEnd),
267 EVENT(libvlc_MediaInstanceTimeChanged),
268 EVENT(libvlc_MediaInstancePositionChanged),
270 EVENT(libvlc_MediaListItemAdded),
271 EVENT(libvlc_MediaListWillAddItem),
272 EVENT(libvlc_MediaListItemDeleted),
273 EVENT(libvlc_MediaListWillDeleteItem),
275 EVENT(libvlc_MediaListViewItemAdded),
276 EVENT(libvlc_MediaListViewWillAddItem),
277 EVENT(libvlc_MediaListViewItemDeleted),
278 EVENT(libvlc_MediaListViewWillDeleteItem),
280 EVENT(libvlc_MediaListPlayerPlayed),
281 EVENT(libvlc_MediaListPlayerNextItemSet),
282 EVENT(libvlc_MediaListPlayerStopped),
284 EVENT(libvlc_MediaDiscovererStarted),
285 EVENT(libvlc_MediaDiscovererEnded)
288 static const char * unkwown_event_name = "Unknown Event";
290 const char * libvlc_event_type_name( libvlc_event_type_t event_type )
292 if( event_type >= sizeof(event_type_to_name)/sizeof(event_type_to_name[0]))
293 return unkwown_event_name;
294 return event_type_to_name[event_type];
297 /**************************************************************************
298 * libvlc_event_attach (public) :
300 * Add a callback for an event.
301 **************************************************************************/
302 void libvlc_event_attach( libvlc_event_manager_t * p_event_manager,
303 libvlc_event_type_t event_type,
304 libvlc_callback_t pf_callback,
306 libvlc_exception_t *p_e )
308 libvlc_event_listeners_group_t * listeners_group;
309 libvlc_event_listener_t * listener;
312 listener = malloc(sizeof(libvlc_event_listener_t));
315 libvlc_exception_raise( p_e, "No Memory left" );
319 listener->event_type = event_type;
320 listener->p_user_data = p_user_data;
321 listener->pf_callback = pf_callback;
323 vlc_mutex_lock( &p_event_manager->object_lock );
324 for( i = 0; i < vlc_array_count(&p_event_manager->listeners_groups); i++ )
326 listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i);
327 if( listeners_group->event_type == listener->event_type )
329 vlc_array_append( &listeners_group->listeners, listener );
330 vlc_mutex_unlock( &p_event_manager->object_lock );
334 vlc_mutex_unlock( &p_event_manager->object_lock );
337 libvlc_exception_raise( p_e,
338 "This object event manager doesn't know about '%s' events",
339 libvlc_event_type_name(event_type));
342 /**************************************************************************
343 * libvlc_event_detach (public) :
345 * Remove a callback for an event.
346 **************************************************************************/
347 void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
348 libvlc_event_type_t event_type,
349 libvlc_callback_t pf_callback,
351 libvlc_exception_t *p_e )
353 libvlc_event_detach_lock_state( p_event_manager, event_type, pf_callback,
354 p_user_data, libvlc_UnLocked, p_e );
357 /**************************************************************************
358 * libvlc_event_detach_no_lock (internal) :
360 * Remove a callback for an event.
361 **************************************************************************/
362 void libvlc_event_detach_lock_state( libvlc_event_manager_t *p_event_manager,
363 libvlc_event_type_t event_type,
364 libvlc_callback_t pf_callback,
366 libvlc_lock_state_t lockstate,
367 libvlc_exception_t *p_e )
369 libvlc_event_listeners_group_t * listeners_group;
370 libvlc_event_listener_t * listener;
373 if( lockstate == libvlc_UnLocked )
374 vlc_mutex_lock( &p_event_manager->event_sending_lock );
375 vlc_mutex_lock( &p_event_manager->object_lock );
376 for( i = 0; i < vlc_array_count(&p_event_manager->listeners_groups); i++)
378 listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i);
379 if( listeners_group->event_type == event_type )
381 for( j = 0; j < vlc_array_count(&listeners_group->listeners); j++)
383 listener = vlc_array_item_at_index(&listeners_group->listeners, j);
384 if( listener->event_type == event_type &&
385 listener->pf_callback == pf_callback &&
386 listener->p_user_data == p_user_data )
388 /* that's our listener */
390 vlc_array_remove( &listeners_group->listeners, j );
391 vlc_mutex_unlock( &p_event_manager->object_lock );
392 if( lockstate == libvlc_UnLocked )
393 vlc_mutex_unlock( &p_event_manager->event_sending_lock );
399 vlc_mutex_unlock( &p_event_manager->object_lock );
400 if( lockstate == libvlc_UnLocked )
401 vlc_mutex_unlock( &p_event_manager->event_sending_lock );
403 libvlc_exception_raise( p_e,
404 "This object event manager doesn't know about '%s,%p,%p' event observer",
405 libvlc_event_type_name(event_type), pf_callback, p_user_data );