X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fcontrol%2Fevent.c;h=2ce0a23970d5bf8eb25fba5993bf02efd13835d3;hb=e2d1b524ca440868f8bf364ef402ff6fd348829e;hp=770348fcac0e064cd7cf09520a949620307fdac6;hpb=33671b8e44c46a06c8d1b8bd23c7fb667b23d63b;p=vlc diff --git a/src/control/event.c b/src/control/event.c index 770348fcac..2ce0a23970 100644 --- a/src/control/event.c +++ b/src/control/event.c @@ -1,10 +1,11 @@ /***************************************************************************** * event.c: New libvlc event control API ***************************************************************************** - * Copyright (C) 2007 the VideoLAN team + * Copyright (C) 2007-2010 the VideoLAN team * $Id $ * * Authors: Filippo Carone + * Pierre d'Herbemont * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -16,191 +17,434 @@ * 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 "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 */ -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 ) { - struct libvlc_callback_entry_t *entry = p_data; /* FIXME: we need some locking here */ - libvlc_event_t event; - event.type = entry->i_event_type; - switch ( event.type ) + int i; + for( i = 0; i < vlc_array_count(&group->listeners); i++ ) { - case VOLUME_CHANGED: - event.value_type = BOOLEAN_EVENT; - break; - case INPUT_POSITION_CHANGED: - break; - default: - break; + if( listeners_are_equal(searched_listener, vlc_array_item_at_index(&group->listeners, i)) ) + return true; } - event.old_value = oldval; - event.new_value = newval; + return false; +} - /* Call the client entry */ - entry->f_callback( entry->p_instance, &event, entry->p_user_data ); +/* + * Internal libvlc functions + */ + +/************************************************************************** + * libvlc_event_manager_new (internal) : + * + * Init an object's event manager. + **************************************************************************/ +libvlc_event_manager_t * +libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst ) +{ + libvlc_event_manager_t * p_em; - return VLC_SUCCESS; + p_em = malloc(sizeof( libvlc_event_manager_t )); + if( !p_em ) + { + libvlc_printerr( "Not enough memory" ); + return NULL; + } + + 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; + + 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; } -static inline void add_callback_entry( struct libvlc_callback_entry_t *entry, - struct libvlc_callback_entry_list_t **list ) +/************************************************************************** + * libvlc_event_manager_release (internal) : + * + * Release an object's event manager. + **************************************************************************/ +void libvlc_event_manager_release( libvlc_event_manager_t * p_em ) { - 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 * p_lg; + int i,j ; + + libvlc_event_async_fini(p_em); + + vlc_mutex_destroy( &p_em->event_sending_lock ); + vlc_mutex_destroy( &p_em->object_lock ); + + for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++) + { + 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_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 ); } -/* - * Public libvlc functions - */ +/************************************************************************** + * libvlc_event_manager_register_event_type (internal) : + * + * Init an object's event manager. + **************************************************************************/ +void libvlc_event_manager_register_event_type( + libvlc_event_manager_t * p_em, + libvlc_event_type_t event_type ) +{ + 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 ); -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 ) + vlc_mutex_lock( &p_em->object_lock ); + vlc_array_append( &p_em->listeners_groups, listeners_group ); + vlc_mutex_unlock( &p_em->object_lock ); +} + +/************************************************************************** + * libvlc_event_send (internal) : + * + * Send a callback. + **************************************************************************/ +void libvlc_event_send( libvlc_event_manager_t * p_em, + libvlc_event_t * p_event ) { - struct libvlc_callback_entry_t *entry; - const char *callback_name = NULL; - int res; - - 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; - - switch ( i_event_type ) + 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; + + /* Here a read/write lock would be nice */ + + vlc_mutex_lock( &p_em->object_lock ); + for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++) { - case VOLUME_CHANGED: - callback_name = "volume-change"; - break; - case INPUT_POSITION_CHANGED: + 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; - default: - free( entry ); - RAISEVOID( "Unsupported event." ); + } } - res = var_AddCallback( p_instance->p_libvlc_int, - callback_name, - handle_event, - entry ); - - if (res != VLC_SUCCESS) + if( !listeners_group ) { - free ( entry ); - RAISEVOID("Internal callback registration was not successful. Callback not registered."); + 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; + } + } + } } - - add_callback_entry( entry, &p_instance->p_callback_list ); + vlc_mutex_unlock( &p_em->event_sending_lock ); - return; + free( array_listeners_cached ); } -void libvlc_event_remove_all_callbacks( libvlc_instance_t *p_instance, - libvlc_exception_t *p_e ) +/* + * Public libvlc functions + */ + +#define DEF( a ) { libvlc_##a, #a, }, + +typedef struct { - struct libvlc_callback_entry_list_t *p_listitem = p_instance->p_callback_list; + int type; + const char name[40]; +} event_name_t; - while( p_listitem ) - { - libvlc_event_remove_callback( p_instance, - p_listitem->elmt->i_event_type, - p_listitem->elmt->f_callback, - p_listitem->elmt->p_user_data, - p_e); - /* libvlc_event_remove_callback will reset the p_callback_list */ - p_listitem = p_instance->p_callback_list; - } +static const event_name_t event_list[] = { + DEF(MediaMetaChanged) + DEF(MediaSubItemAdded) + DEF(MediaDurationChanged) + DEF(MediaParsedChanged) + DEF(MediaFreed) + DEF(MediaStateChanged) + + DEF(MediaPlayerMediaChanged) + DEF(MediaPlayerNothingSpecial) + DEF(MediaPlayerOpening) + DEF(MediaPlayerBuffering) + DEF(MediaPlayerPlaying) + DEF(MediaPlayerPaused) + DEF(MediaPlayerStopped) + DEF(MediaPlayerForward) + DEF(MediaPlayerBackward) + DEF(MediaPlayerEndReached) + DEF(MediaPlayerEncounteredError) + DEF(MediaPlayerTimeChanged) + DEF(MediaPlayerPositionChanged) + DEF(MediaPlayerSeekableChanged) + DEF(MediaPlayerPausableChanged) + DEF(MediaPlayerTitleChanged) + DEF(MediaPlayerSnapshotTaken) + DEF(MediaPlayerLengthChanged) + + DEF(MediaListItemAdded) + DEF(MediaListWillAddItem) + DEF(MediaListItemDeleted) + DEF(MediaListWillDeleteItem) + + DEF(MediaListViewItemAdded) + DEF(MediaListViewWillAddItem) + DEF(MediaListViewItemDeleted) + DEF(MediaListViewWillDeleteItem) + + DEF(MediaListPlayerPlayed) + DEF(MediaListPlayerNextItemSet) + DEF(MediaListPlayerStopped) + + DEF(MediaDiscovererStarted) + DEF(MediaDiscovererEnded) + + DEF(VlmMediaAdded) + DEF(VlmMediaRemoved) + DEF(VlmMediaChanged) + DEF(VlmMediaInstanceStarted) + DEF(VlmMediaInstanceStopped) + DEF(VlmMediaInstanceStatusInit) + DEF(VlmMediaInstanceStatusOpening) +}; +#undef DEF + +static const char unknown_event_name[] = "Unknown Event"; + +static int evcmp( const void *a, const void *b ) +{ + return (*(const int *)a) - ((event_name_t *)b)->type; } -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 ) +const char * libvlc_event_type_name( int event_type ) { - struct libvlc_callback_entry_list_t *p_listitem = p_instance->p_callback_list; + const event_name_t *p; + + p = bsearch( &event_type, event_list, + sizeof(event_list)/sizeof(event_list[0]), sizeof(*p), + evcmp ); + return p ? p->name : unknown_event_name; +} + +/************************************************************************** + * event_attach (internal) : + * + * Add a callback for an event. + **************************************************************************/ +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 ) +{ + libvlc_event_listeners_group_t * listeners_group; + libvlc_event_listener_t * listener; + int i; + + listener = malloc(sizeof(libvlc_event_listener_t)); + if( unlikely(listener == NULL) ) + return ENOMEM; - while( p_listitem ) + 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++ ) { - 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 ) - - ) + listeners_group = vlc_array_item_at_index(&p_event_manager->listeners_groups, i); + if( listeners_group->event_type == listener->event_type ) { - const char * callback_name = NULL; - int res; + 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 ); - if( p_listitem->prev ) - p_listitem->prev->next = p_listitem->next; - else - p_instance->p_callback_list = p_listitem->next; + free(listener); + fprintf( stderr, "This object event manager doesn't know about '%s' events", + libvlc_event_type_name(event_type) ); + assert(0); + return -1; +} - p_listitem->next->prev = p_listitem->prev; +/************************************************************************** + * libvlc_event_attach (public) : + * + * Add a callback for an event. + **************************************************************************/ +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 ) +{ + return event_attach(p_event_manager, event_type, pf_callback, p_user_data, + false /* synchronous */); +} - switch ( i_event_type ) - { - case VOLUME_CHANGED: - callback_name = "volume-change"; - break; - case INPUT_POSITION_CHANGED: - break; - default: - RAISEVOID( "Unsupported event." ); - } +/************************************************************************** + * libvlc_event_attach (public) : + * + * Add a callback for an event. + **************************************************************************/ +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 ) +{ + event_attach(p_event_manager, event_type, pf_callback, p_user_data, + true /* asynchronous */); +} - res = var_DelCallback( p_instance->p_libvlc_int, - callback_name, handle_event, - p_listitem->elmt ); +/************************************************************************** + * 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; - if (res != VLC_SUCCESS) + 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++) + { + 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++) { - RAISEVOID("Internal callback unregistration was not successful. Callback not unregistered."); - } + 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 */ - free( p_listitem->elmt ); /* FIXME: need some locking here */ - free( p_listitem ); - break; + /* 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_listitem = p_listitem->next; } + 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); + + assert(found); }