X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fcontrol%2Fevent.c;h=af3f043c9af2a3222734360daa49d4685494d88d;hb=4d76e25678ef48a4cc4bfb191df2a8d326edfe4d;hp=a44b247383b67fb65414a8f3377cc2f35d2bddaa;hpb=23942f1f36db6ab5ed4272da903c054336bed5ee;p=vlc diff --git a/src/control/event.c b/src/control/event.c index a44b247383..af3f043c9a 100644 --- a/src/control/event.c +++ b/src/control/event.c @@ -17,359 +17,376 @@ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#include "libvlc_internal.h" +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#define LIBVLC_EVENT_TYPES_KEEP_DEFINE #include -#include +#include "libvlc_internal.h" +#include "event_internal.h" +#include +#include + +typedef struct libvlc_event_listeners_group_t +{ + libvlc_event_type_t event_type; + vlc_array_t listeners; + bool b_sublistener_removed; +} libvlc_event_listeners_group_t; /* * Private functions */ -/************************************************************************** - * handle_event (private) - * - * Callback from the vlc variables - **************************************************************************/ -static int handle_event( vlc_object_t *p_this, char const *psz_cmd, - vlc_value_t oldval, vlc_value_t newval, - void *p_data ) +static bool +group_contains_listener( libvlc_event_listeners_group_t * group, + libvlc_event_listener_t * searched_listener ) { - /* This is thread safe, as the var_*Callback already provide the locking - * facility for p_data */ - struct libvlc_callback_entry_t *entry = p_data; - libvlc_event_t event; - - event.type = entry->i_event_type; - - if (event.type == libvlc_VolumeChanged) - { - if(!strcmp(psz_cmd, "intf-change")) - { - input_thread_t * p_input = (input_thread_t *)p_this; - vlc_value_t val; - var_Get( p_input, "time", &val ); - - /* Only send event at a reasonable time precision (500ms) */ - /* (FIXME: this should be configurable) */ - if ((val.i_time % I64C(500000)) != 0) - { - /* Don't send this event */ - return VLC_SUCCESS; - } - - event.u.input_position_changed.new_position = val.i_time; - } - else - event.u.input_position_changed.new_position = newval.i_time; - - event.u.input_position_changed.new_position *= 1000LL; - } - else if (event.type == libvlc_InputPositionChanged) + int i; + for( i = 0; i < vlc_array_count(&group->listeners); i++ ) { - event.u.volume_changed.new_volume = newval.i_int; + if( listeners_are_equal(searched_listener, vlc_array_item_at_index(&group->listeners, i)) ) + return true; } - - /* Call the client entry */ - entry->f_callback( entry->p_instance, &event, entry->p_user_data ); - - return VLC_SUCCESS; + return false; } +/* + * Internal libvlc functions + */ + /************************************************************************** - * get_input (private) : + * libvlc_event_manager_new (internal) : * - * Utility function, Object should be released by vlc_object_release - * afterwards + * Init an object's event manager. **************************************************************************/ -static input_thread_t * get_input(libvlc_instance_t * p_instance) +libvlc_event_manager_t * +libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst ) { - libvlc_media_instance_t * p_mi; - input_thread_t * p_input; - - p_mi = libvlc_playlist_get_media_instance( p_instance, NULL ); + libvlc_event_manager_t * p_em; - if( !p_mi ) + p_em = malloc(sizeof( libvlc_event_manager_t )); + if( !p_em ) + { + libvlc_printerr( "Not enough memory" ); return NULL; + } - p_input = libvlc_get_input_thread( p_mi, NULL ); - - libvlc_media_instance_release( p_mi ); + p_em->p_obj = p_obj; + p_em->p_obj = p_obj; + p_em->async_event_queue = NULL; + p_em->p_libvlc_instance = p_libvlc_inst; - return p_input; + libvlc_retain( p_libvlc_inst ); + vlc_array_init( &p_em->listeners_groups ); + vlc_mutex_init( &p_em->object_lock ); + vlc_mutex_init_recursive( &p_em->event_sending_lock ); + return p_em; } /************************************************************************** - * install_input_event (private) : + * libvlc_event_manager_release (internal) : * - * vlc variables callback, used to install input event. - * Can be called manually though. + * Release an object's event manager. **************************************************************************/ -static int install_input_event( vlc_object_t *p_this, char const *psz_cmd, - vlc_value_t oldval, vlc_value_t newval, - void *p_data ) +void libvlc_event_manager_release( libvlc_event_manager_t * p_em ) { - libvlc_instance_t * p_instance = p_data; - struct libvlc_callback_entry_list_t *p_listitem; - input_thread_t * p_input = get_input( p_instance ); + libvlc_event_listeners_group_t * p_lg; + int i,j ; - if( !p_input ) - return; - - vlc_mutex_lock( &p_instance->instance_lock ); + libvlc_event_async_fini(p_em); - p_listitem = p_instance->p_callback_list; + vlc_mutex_destroy( &p_em->event_sending_lock ); + vlc_mutex_destroy( &p_em->object_lock ); - for( ; p_listitem ; p_listitem = p_listitem->next ) + for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++) { - if (p_listitem->elmt->i_event_type == libvlc_InputPositionChanged) - { - /* FIXME: here we shouldn't listen on intf-change, we have to provide - * in vlc core a more accurate callback */ - var_AddCallback( p_input, "intf-change", handle_event, p_listitem->elmt ); - var_AddCallback( p_input, "time", handle_event, p_listitem->elmt ); - } - } + p_lg = vlc_array_item_at_index( &p_em->listeners_groups, i ); + + for( j = 0; j < vlc_array_count(&p_lg->listeners); j++) + free( vlc_array_item_at_index( &p_lg->listeners, j ) ); - vlc_mutex_unlock( &p_instance->instance_lock ); - vlc_object_release( p_input ); - return VLC_SUCCESS; + vlc_array_clear( &p_lg->listeners ); + free( p_lg ); + } + vlc_array_clear( &p_em->listeners_groups ); + libvlc_release( p_em->p_libvlc_instance ); + free( p_em ); } /************************************************************************** - * add_callback_to_list (private) : + * libvlc_event_manager_register_event_type (internal) : * - * callback list utility function. + * Init an object's event manager. **************************************************************************/ -static inline void add_callback_to_list( struct libvlc_callback_entry_t *entry, - struct libvlc_callback_entry_list_t **list ) +void libvlc_event_manager_register_event_type( + libvlc_event_manager_t * p_em, + libvlc_event_type_t event_type ) { - struct libvlc_callback_entry_list_t *new_listitem; - - /* malloc/free strategy: - * - alloc-ded in add_callback_entry - * - free-ed by libvlc_event_remove_callback - * - free-ed in libvlc_destroy threw libvlc_event_remove_callback - * when entry is destroyed - */ - new_listitem = malloc( sizeof( struct libvlc_callback_entry_list_t ) ); - new_listitem->elmt = entry; - new_listitem->next = *list; - new_listitem->prev = NULL; - - if(*list) - (*list)->prev = new_listitem; - - *list = new_listitem; + libvlc_event_listeners_group_t * listeners_group; + listeners_group = xmalloc(sizeof(libvlc_event_listeners_group_t)); + listeners_group->event_type = event_type; + vlc_array_init( &listeners_group->listeners ); + + vlc_mutex_lock( &p_em->object_lock ); + vlc_array_append( &p_em->listeners_groups, listeners_group ); + vlc_mutex_unlock( &p_em->object_lock ); } /************************************************************************** - * remove_variable_callback (private) : + * libvlc_event_send (internal) : * - * Delete the appropriate vlc variables callback for an event. + * Send a callback. **************************************************************************/ -static int remove_variable_callback( libvlc_instance_t *p_instance, - struct libvlc_callback_entry_t * p_entry ) +void libvlc_event_send( libvlc_event_manager_t * p_em, + libvlc_event_t * p_event ) { - input_thread_t * p_input = get_input( p_instance ); - int res = VLC_SUCCESS; + libvlc_event_listeners_group_t * listeners_group = NULL; + libvlc_event_listener_t * listener_cached; + libvlc_event_listener_t * listener; + libvlc_event_listener_t * array_listeners_cached = NULL; + int i, i_cached_listeners = 0; + + /* Fill event with the sending object now */ + p_event->p_obj = p_em->p_obj; - /* Note: Appropriate lock should be held by the caller */ + /* Here a read/write lock would be nice */ - switch ( p_entry->i_event_type ) + vlc_mutex_lock( &p_em->object_lock ); + for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++) { - case libvlc_VolumeChanged: - res = var_DelCallback( p_instance->p_libvlc_int, "volume-change", - handle_event, p_entry ); - break; - case libvlc_InputPositionChanged: - /* We may not be deleting the right p_input callback, in this case this - * will be a no-op */ - var_DelCallback( p_input, "intf-change", handle_event, p_entry ); - var_DelCallback( p_input, "position", handle_event, p_entry ); + listeners_group = vlc_array_item_at_index(&p_em->listeners_groups, i); + if( listeners_group->event_type == p_event->type ) + { + if( vlc_array_count( &listeners_group->listeners ) <= 0 ) + break; + + /* Cache a copy of the listener to avoid locking issues, + * and allow that edition of listeners during callbacks will garantee immediate effect. */ + i_cached_listeners = vlc_array_count(&listeners_group->listeners); + array_listeners_cached = malloc(sizeof(libvlc_event_listener_t)*(i_cached_listeners)); + if( !array_listeners_cached ) + { + vlc_mutex_unlock( &p_em->object_lock ); + fprintf(stderr, "Can't alloc memory in libvlc_event_send" ); + return; + } + + listener_cached = array_listeners_cached; + for( i = 0; i < vlc_array_count(&listeners_group->listeners); i++) + { + listener = vlc_array_item_at_index(&listeners_group->listeners, i); + memcpy( listener_cached, listener, sizeof(libvlc_event_listener_t) ); + listener_cached++; + } break; + } } - - if (p_input) - vlc_object_release( p_input ); - return res; + if( !listeners_group ) + { + free( array_listeners_cached ); + vlc_mutex_unlock( &p_em->object_lock ); + return; + } + + vlc_mutex_unlock( &p_em->object_lock ); + + vlc_mutex_lock( &p_em->event_sending_lock ); + listener_cached = array_listeners_cached; + listeners_group->b_sublistener_removed = false; + for( i = 0; i < i_cached_listeners; i++ ) + { + if(listener_cached->is_asynchronous) + { + /* The listener wants not to block the emitter during event callback */ + libvlc_event_async_dispatch(p_em, listener_cached, p_event); + } + else + { + /* The listener wants to block the emitter during event callback */ + + listener_cached->pf_callback( p_event, listener_cached->p_user_data ); + listener_cached++; + + if( listeners_group->b_sublistener_removed ) + { + /* If a callback was removed, this gets called */ + bool valid_listener; + vlc_mutex_lock( &p_em->object_lock ); + valid_listener = group_contains_listener( listeners_group, listener_cached ); + vlc_mutex_unlock( &p_em->object_lock ); + if( !valid_listener ) + { + listener_cached++; + continue; + } + } + } + } + vlc_mutex_unlock( &p_em->event_sending_lock ); + + free( array_listeners_cached ); } /* - * Internal libvlc functions + * Public libvlc functions */ /************************************************************************** - * libvlc_event_init (internal) : + * libvlc_event_type_name (public) : * - * initialization function. + * Get the char * name of an event type. **************************************************************************/ -void libvlc_event_init( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) +static const char event_type_to_name[][libvlc_num_event_types] = { - playlist_t *p_playlist = p_instance->p_libvlc_int->p_playlist; +#define DEF(a) [libvlc_##a]=#a + DEFINE_LIBVLC_EVENT_TYPES +#undef DEF +}; - if( !p_playlist ) - RAISEVOID ("Can't listen to input event"); +static const char unknown_event_name[] = "Unknown Event"; - /* Install a Callback for input changes, so - * so we can track input event */ - var_AddCallback( p_playlist, "playlist-current", - install_input_event, p_instance ); -} - -/************************************************************************** - * libvlc_event_fini (internal) : - * - * finalization function. - **************************************************************************/ -void libvlc_event_fini( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) +const char * libvlc_event_type_name( libvlc_event_type_t event_type ) { - playlist_t *p_playlist = p_instance->p_libvlc_int->p_playlist; - libvlc_exception_t p_e_unused; - - libvlc_event_remove_all_callbacks( p_instance, &p_e_unused ); - - if( !p_playlist ) - RAISEVOID ("Can't unregister input events"); - - var_DelCallback( p_playlist, "playlist-current", - install_input_event, p_instance ); + if( event_type >= libvlc_num_event_types ) + return unknown_event_name; + return event_type_to_name[event_type]; } -/* - * Public libvlc functions - */ - /************************************************************************** - * libvlc_event_add_callback (public) : + * event_attach (internal) : * * Add a callback for an event. **************************************************************************/ -void libvlc_event_add_callback( libvlc_instance_t *p_instance, - libvlc_event_type_t i_event_type, - libvlc_callback_t f_callback, - void *user_data, - libvlc_exception_t *p_e ) +static +int event_attach( libvlc_event_manager_t * p_event_manager, + libvlc_event_type_t event_type, + libvlc_callback_t pf_callback, void *p_user_data, + bool is_asynchronous ) { - struct libvlc_callback_entry_t *entry; - vlc_value_t unused1, unused2; - int res = VLC_SUCCESS; - - if ( !f_callback ) - RAISEVOID (" Callback function is null "); - - /* malloc/free strategy: - * - alloc-ded in libvlc_event_add_callback - * - free-ed by libvlc_event_add_callback on error - * - free-ed by libvlc_event_remove_callback - * - free-ed in libvlc_destroy threw libvlc_event_remove_callback - * when entry is destroyed - */ - entry = malloc( sizeof( struct libvlc_callback_entry_t ) ); - entry->f_callback = f_callback; - entry->i_event_type = i_event_type; - entry->p_user_data = user_data; + libvlc_event_listeners_group_t * listeners_group; + libvlc_event_listener_t * listener; + int i; - switch ( i_event_type ) - { - case libvlc_VolumeChanged: - res = var_AddCallback( p_instance->p_libvlc_int, "volume-change", - handle_event, entry ); - break; - case libvlc_InputPositionChanged: - install_input_event( NULL, NULL, unused1, unused2, p_instance); - break; - default: - free( entry ); - RAISEVOID( "Unsupported event." ); - } - - if (res != VLC_SUCCESS) + listener = malloc(sizeof(libvlc_event_listener_t)); + if( unlikely(listener == NULL) ) + return ENOMEM; + + listener->event_type = event_type; + listener->p_user_data = p_user_data; + listener->pf_callback = pf_callback; + listener->is_asynchronous = is_asynchronous; + + vlc_mutex_lock( &p_event_manager->object_lock ); + for( i = 0; i < vlc_array_count(&p_event_manager->listeners_groups); i++ ) { - free ( entry ); - RAISEVOID("Internal callback registration was not successful. Callback not registered."); + listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i); + if( listeners_group->event_type == listener->event_type ) + { + vlc_array_append( &listeners_group->listeners, listener ); + vlc_mutex_unlock( &p_event_manager->object_lock ); + return 0; + } } + vlc_mutex_unlock( &p_event_manager->object_lock ); - vlc_mutex_lock( &p_instance->instance_lock ); - add_callback_to_list( entry, &p_instance->p_callback_list ); - vlc_mutex_unlock( &p_instance->instance_lock ); - - return; + free(listener); + fprintf( stderr, "This object event manager doesn't know about '%s' events", + libvlc_event_type_name(event_type) ); + assert(0); + return -1; } /************************************************************************** - * libvlc_event_remove_callback (public) : + * libvlc_event_attach (public) : * - * Remove a callback for an event. + * Add a callback for an event. **************************************************************************/ -void libvlc_event_remove_callback( libvlc_instance_t *p_instance, - libvlc_event_type_t i_event_type, - libvlc_callback_t f_callback, - void *p_user_data, - libvlc_exception_t *p_e ) +int libvlc_event_attach( libvlc_event_manager_t * p_event_manager, + libvlc_event_type_t event_type, + libvlc_callback_t pf_callback, + void *p_user_data ) { - struct libvlc_callback_entry_list_t *p_listitem; - - vlc_mutex_lock( &p_instance->instance_lock ); - - p_listitem = p_instance->p_callback_list; - - while( p_listitem ) - { - if( p_listitem->elmt->f_callback == f_callback - && ( p_listitem->elmt->i_event_type == i_event_type ) - && ( p_listitem->elmt->p_user_data == p_user_data ) - - ) - { - remove_variable_callback( p_instance, p_listitem->elmt ); /* FIXME: We should warn on error */ - - if( p_listitem->prev ) - p_listitem->prev->next = p_listitem->next; - else - p_instance->p_callback_list = p_listitem->next; - - - p_listitem->next->prev = p_listitem->prev; - - free( p_listitem->elmt ); - - free( p_listitem ); - break; - } - - p_listitem = p_listitem->next; - } - vlc_mutex_unlock( &p_instance->instance_lock ); + return event_attach(p_event_manager, event_type, pf_callback, p_user_data, + false /* synchronous */); } /************************************************************************** - * libvlc_event_remove_all_callbacks (public) : + * libvlc_event_attach (public) : * - * Remove all callbacks for all events. + * Add a callback for an event. **************************************************************************/ -void libvlc_event_remove_all_callbacks( libvlc_instance_t *p_instance, - libvlc_exception_t *p_e ) +void libvlc_event_attach_async( libvlc_event_manager_t * p_event_manager, + libvlc_event_type_t event_type, + libvlc_callback_t pf_callback, + void *p_user_data ) { - struct libvlc_callback_entry_list_t *p_listitem; - - vlc_mutex_lock( &p_instance->instance_lock ); - - p_listitem = p_instance->p_callback_list; + event_attach(p_event_manager, event_type, pf_callback, p_user_data, + true /* asynchronous */); +} - while( p_listitem ) +/************************************************************************** + * libvlc_event_detach (public) : + * + * Remove a callback for an event. + **************************************************************************/ +void libvlc_event_detach( libvlc_event_manager_t *p_event_manager, + libvlc_event_type_t event_type, + libvlc_callback_t pf_callback, + void *p_user_data ) +{ + libvlc_event_listeners_group_t * listeners_group; + libvlc_event_listener_t * listener; + int i, j; + bool found = false; + + vlc_mutex_lock( &p_event_manager->event_sending_lock ); + vlc_mutex_lock( &p_event_manager->object_lock ); + for( i = 0; i < vlc_array_count(&p_event_manager->listeners_groups); i++) { - remove_variable_callback( p_instance, p_listitem->elmt ); /* FIXME: We could warn on error */ - p_listitem = p_listitem->next; - + listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i); + if( listeners_group->event_type == event_type ) + { + for( j = 0; j < vlc_array_count(&listeners_group->listeners); j++) + { + listener = vlc_array_item_at_index(&listeners_group->listeners, j); + if( listener->event_type == event_type && + listener->pf_callback == pf_callback && + listener->p_user_data == p_user_data ) + { + /* that's our listener */ + + /* Mark this group as edited so that libvlc_event_send + * will recheck what listener to call */ + listeners_group->b_sublistener_removed = false; + + free( listener ); + vlc_array_remove( &listeners_group->listeners, j ); + found = true; + break; + } + } + } } - p_instance->p_callback_list = NULL; + vlc_mutex_unlock( &p_event_manager->object_lock ); + vlc_mutex_unlock( &p_event_manager->event_sending_lock ); + + /* Now make sure any pending async event won't get fired after that point */ + libvlc_event_listener_t listener_to_remove; + listener_to_remove.event_type = event_type; + listener_to_remove.pf_callback = pf_callback; + listener_to_remove.p_user_data = p_user_data; + listener_to_remove.is_asynchronous = true; + + libvlc_event_async_ensure_listener_removal(p_event_manager, &listener_to_remove); - vlc_mutex_unlock( &p_instance->instance_lock ); + assert(found); }