1 /*****************************************************************************
2 * events.c: events interface
3 * This library provides an interface to the send and receive events.
4 * It is more lightweight than variable based callback.
6 *****************************************************************************
7 * Copyright (C) 1998-2005 the VideoLAN team
10 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org >
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
35 #include <vlc_events.h>
36 #include <vlc_arrays.h>
38 /*****************************************************************************
39 * Documentation : Read vlc_events.h
40 *****************************************************************************/
44 /*****************************************************************************
46 *****************************************************************************/
48 typedef struct vlc_event_listener_t
51 vlc_event_callback_t pf_callback;
53 char * psz_debug_name;
55 } vlc_event_listener_t;
57 typedef struct vlc_event_listeners_group_t
59 vlc_event_type_t event_type;
60 DECL_ARRAY(struct vlc_event_listener_t *) listeners;
61 } vlc_event_listeners_group_t;
64 static const char * ppsz_event_type_to_name[] =
66 [vlc_InputItemMetaChanged] = "vlc_InputItemMetaChanged",
67 [vlc_InputItemSubItemAdded] = "vlc_InputItemSubItemAdded",
68 [vlc_ServicesDiscoveryItemAdded] = "vlc_ServicesDiscoveryItemAdded",
69 [vlc_ServicesDiscoveryItemRemoved] = "vlc_ServicesDiscoveryItemRemoved"
73 /*****************************************************************************
75 *****************************************************************************/
78 * Initialize event manager object
79 * p_obj is the object that contains the event manager. But not
80 * necessarily a vlc_object_t (an input_item_t is not a vlc_object_t
82 * p_parent_obj gives a libvlc instance
84 int vlc_event_manager_init( vlc_event_manager_t * p_em, void * p_obj,
85 vlc_object_t * p_parent_obj )
88 p_em->p_parent_object = p_parent_obj;
89 vlc_mutex_init( p_parent_obj, &p_em->object_lock );
90 ARRAY_INIT( p_em->listeners_groups );
95 * Destroy the event manager
97 void vlc_event_manager_fini( vlc_event_manager_t * p_em )
99 struct vlc_event_listeners_group_t * listeners_group;
100 struct vlc_event_listener_t * listener;
102 vlc_mutex_destroy( &p_em->object_lock );
104 FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
105 FOREACH_ARRAY( listener, listeners_group->listeners )
108 free( listeners_group );
113 * Destroy the event manager
115 int vlc_event_manager_register_event_type(
116 vlc_event_manager_t * p_em,
117 vlc_event_type_t event_type )
119 vlc_event_listeners_group_t * listeners_group;
120 listeners_group = malloc(sizeof(vlc_event_listeners_group_t));
122 if( !listeners_group )
125 listeners_group->event_type = event_type;
126 ARRAY_INIT( listeners_group->listeners );
128 vlc_mutex_lock( &p_em->object_lock );
129 ARRAY_APPEND( p_em->listeners_groups, listeners_group );
130 vlc_mutex_unlock( &p_em->object_lock );
136 * Send an event to the listener attached to this p_em.
138 void vlc_event_send( vlc_event_manager_t * p_em,
139 vlc_event_t * p_event )
141 vlc_event_listeners_group_t * listeners_group;
142 vlc_event_listener_t * listener;
143 vlc_event_listener_t * array_of_cached_listeners = NULL;
144 vlc_event_listener_t * cached_listener;
145 int i, i_cached_listeners = 0;
147 /* Fill event with the sending object now */
148 p_event->p_obj = p_em->p_obj;
150 vlc_mutex_lock( &p_em->object_lock );
151 FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
152 if( listeners_group->event_type == p_event->type )
154 if( listeners_group->listeners.i_size <= 0 )
157 /* Save the function to call */
158 i_cached_listeners = listeners_group->listeners.i_size;
159 array_of_cached_listeners = malloc(
160 sizeof(vlc_event_listener_t)*i_cached_listeners );
161 if( !array_of_cached_listeners )
163 msg_Err( p_em->p_parent_object, "Not enough memory in vlc_event_send" );
167 cached_listener = array_of_cached_listeners;
168 FOREACH_ARRAY( listener, listeners_group->listeners )
169 memcpy( cached_listener, listener, sizeof(vlc_event_listener_t));
171 cached_listener->psz_debug_name = strdup(cached_listener->psz_debug_name);
173 cached_listener += sizeof(vlc_event_listener_t);
179 vlc_mutex_unlock( &p_em->object_lock );
181 /* Call the function attached */
182 cached_listener = array_of_cached_listeners;
183 for( i = 0; i < i_cached_listeners; i++ )
186 msg_Dbg( p_em->p_parent_object,
187 "Calling '%s' with a '%s' event (data %p)",
188 cached_listener->psz_debug_name,
189 ppsz_event_type_to_name[p_event->type],
190 cached_listener->p_user_data );
191 free(psz_debug_name);
194 cached_listener->pf_callback( p_event, cached_listener->p_user_data );
195 cached_listener += sizeof(vlc_event_listener_t) ;
197 free( array_of_cached_listeners );
202 * Add a callback for an event.
204 int __vlc_event_attach( vlc_event_manager_t * p_em,
205 vlc_event_type_t event_type,
206 vlc_event_callback_t pf_callback,
208 const char * psz_debug_name )
210 vlc_event_listeners_group_t * listeners_group;
211 vlc_event_listener_t * listener;
212 listener = malloc(sizeof(vlc_event_listener_t));
216 listener->p_user_data = p_user_data;
217 listener->pf_callback = pf_callback;
219 listener->psz_debug_name = strdup( psz_debug_name );
221 (void)psz_debug_name;
224 vlc_mutex_lock( &p_em->object_lock );
225 FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
226 if( listeners_group->event_type == event_type )
228 ARRAY_APPEND( listeners_group->listeners, listener );
230 msg_Dbg( p_em->p_parent_object,
231 "Listening to '%s' event with '%s' (data %p)",
232 ppsz_event_type_to_name[event_type],
233 listener->psz_debug_name,
234 listener->p_user_data );
236 vlc_mutex_unlock( &p_em->object_lock );
240 vlc_mutex_unlock( &p_em->object_lock );
242 msg_Err( p_em->p_parent_object, "Can't attach to an object event manager event" );
248 * Remove a callback for an event.
250 int vlc_event_detach( vlc_event_manager_t *p_em,
251 vlc_event_type_t event_type,
252 vlc_event_callback_t pf_callback,
255 vlc_event_listeners_group_t * listeners_group;
256 struct vlc_event_listener_t * listener;
258 vlc_mutex_lock( &p_em->object_lock );
259 FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
260 if( listeners_group->event_type == event_type )
262 FOREACH_ARRAY( listener, listeners_group->listeners )
263 if( listener->pf_callback == pf_callback &&
264 listener->p_user_data == p_user_data )
266 /* that's our listener */
267 ARRAY_REMOVE( listeners_group->listeners,
268 fe_idx /* This comes from the macro (and that's why
271 msg_Dbg( p_em->p_parent_object,
272 "Detaching '%s' from '%s' event (data %p)",
273 listener->psz_debug_name,
274 ppsz_event_type_to_name[event_type],
275 listener->p_user_data );
277 free( listener->psz_debug_name );
280 vlc_mutex_unlock( &p_em->object_lock );
286 vlc_mutex_unlock( &p_em->object_lock );
288 msg_Warn( p_em->p_parent_object, "Can't detach to an object event manager event" );