X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fcontrol%2Fevent.c;h=016e3a0f7dfd66b3ac9155e55ee8a9818eea6c7f;hb=7b1fa618ce2e67689a1e1bd5f84f88cf21fc3aee;hp=3b5775a079e2f572a180cbe73659065fb7811595;hpb=60bd120e06d3399c15f1367bdd02285c1b429d7b;p=vlc diff --git a/src/control/event.c b/src/control/event.c index 3b5775a079..016e3a0f7d 100644 --- a/src/control/event.c +++ b/src/control/event.c @@ -5,6 +5,7 @@ * $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 @@ -23,159 +24,330 @@ #include "libvlc_internal.h" #include +#include /* * 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 ) +/* + * Internal libvlc functions + */ + +/************************************************************************** + * libvlc_event_init (internal) : + * + * initialization function. + **************************************************************************/ +void libvlc_event_init( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) +{ + /* Will certainly be used to install libvlc_instance event */ +} + +/************************************************************************** + * libvlc_event_fini (internal) : + * + * finalization function. + **************************************************************************/ +void libvlc_event_fini( libvlc_instance_t *p_instance ) +{ +} + +/************************************************************************** + * libvlc_event_manager_init (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_exception_t *p_e ) { - 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 ) + libvlc_event_manager_t * p_em; + + p_em = malloc(sizeof( libvlc_event_manager_t )); + if( !p_em ) { - case VOLUME_CHANGED: - event.value_type = BOOLEAN_EVENT; - break; - case INPUT_POSITION_CHANGED: - break; - default: - break; + libvlc_exception_raise( p_e, "No Memory left" ); + return NULL; } - event.old_value = oldval; - event.new_value = newval; - /* Call the client entry */ - entry->f_callback( entry->p_instance, &event, entry->p_user_data ); - - return VLC_SUCCESS; + p_em->p_obj = p_obj; + p_em->p_libvlc_instance = p_libvlc_inst; + libvlc_retain( p_libvlc_inst ); + ARRAY_INIT( p_em->listeners_groups ); + vlc_mutex_init( p_libvlc_inst->p_libvlc_int, &p_em->object_lock ); + vlc_mutex_init( p_libvlc_inst->p_libvlc_int, &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) : + * + * Init 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 * listeners_group; + libvlc_event_listener_t * listener; -/* - * Public libvlc functions - */ + vlc_mutex_destroy( &p_em->event_sending_lock ); + vlc_mutex_destroy( &p_em->object_lock ); + + FOREACH_ARRAY( listeners_group, p_em->listeners_groups ) + FOREACH_ARRAY( listener, listeners_group->listeners ) + free( listener ); + FOREACH_END() + ARRAY_RESET( listeners_group->listeners ); + free( listeners_group ); + FOREACH_END() + ARRAY_RESET( p_em->listeners_groups ); -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 ) + libvlc_release( p_em->p_libvlc_instance, NULL ); + free( p_em ); +} + +/************************************************************************** + * 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_exception_t * p_e ) { - struct libvlc_callback_entry_t *entry; - const char *callback_name = NULL; - - 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; + listeners_group = malloc(sizeof(libvlc_event_listeners_group_t)); + if( !listeners_group ) { - case VOLUME_CHANGED: - callback_name = "volume-change"; - break; - case INPUT_POSITION_CHANGED: - break; - default: - free( entry ); - RAISEVOID( "Unsupported event." ); + libvlc_exception_raise( p_e, "No Memory left" ); + return; } - int res = var_AddCallback( p_instance->p_libvlc_int, - callback_name, - handle_event, - entry ); - - if (res != VLC_SUCCESS) + listeners_group->event_type = event_type; + ARRAY_INIT( listeners_group->listeners ); + + vlc_mutex_lock( &p_em->object_lock ); + 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 ) +{ + libvlc_event_listeners_group_t * listeners_group; + 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 ); + FOREACH_ARRAY( listeners_group, p_em->listeners_groups ) + if( listeners_group->event_type == p_event->type ) + { + if( listeners_group->listeners.i_size <= 0 ) + break; + + /* Cache a copy of the listener to avoid locking issues */ + i_cached_listeners = listeners_group->listeners.i_size; + array_listeners_cached = malloc(sizeof(libvlc_event_listener_t)*(i_cached_listeners)); + if( !array_listeners_cached ) + { + printf( "Can't alloc memory in libvlc_event_send" ); + break; + } + + listener_cached = array_listeners_cached; + FOREACH_ARRAY( listener, listeners_group->listeners ) + memcpy( listener_cached, listener, sizeof(libvlc_event_listener_t)); + listener_cached++; + FOREACH_END() + break; + } + FOREACH_END() + + vlc_mutex_unlock( &p_em->object_lock ); + + /* Here a read/write lock would be *especially* nice, + * We would be able to send event without blocking */ + /* The only reason for this lock is to be able to wait the + * End of events sending with libvlc_event_manager_lock_event_sending. + * This can be useful to make sure a callback is completely detached. */ + vlc_mutex_lock( &p_em->event_sending_lock ); + listener_cached = array_listeners_cached; + for( i = 0; i < i_cached_listeners; i++ ) { - free ( entry ); - RAISEVOID("Internal callback registration was not successful. Callback not registered."); + listener_cached->pf_callback( p_event, listener_cached->p_user_data ); + listener_cached++; } - - 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 + */ + +/************************************************************************** + * libvlc_event_type_name (public) : + * + * Get the char * name of an event type. + **************************************************************************/ +static const char * event_type_to_name[] = { - struct libvlc_callback_entry_list_t *p_listitem = p_instance->p_callback_list; +#define EVENT(a) [a]=#a + EVENT(libvlc_MediaDescriptorMetaChanged), + EVENT(libvlc_MediaDescriptorSubItemAdded), + EVENT(libvlc_MediaDescriptorDurationChanged), + EVENT(libvlc_MediaDescriptorPreparsedChanged), + EVENT(libvlc_MediaDescriptorFreed), + EVENT(libvlc_MediaDescriptorStateChanged), + + EVENT(libvlc_MediaInstancePlayed), + EVENT(libvlc_MediaInstancePaused), + EVENT(libvlc_MediaInstanceReachedEnd), + EVENT(libvlc_MediaInstanceTimeChanged), + EVENT(libvlc_MediaInstancePositionChanged), + + EVENT(libvlc_MediaListItemAdded), + EVENT(libvlc_MediaListWillAddItem), + EVENT(libvlc_MediaListItemDeleted), + EVENT(libvlc_MediaListWillDeleteItem), - while( p_listitem ) + EVENT(libvlc_MediaListViewItemAdded), + EVENT(libvlc_MediaListViewWillAddItem), + EVENT(libvlc_MediaListViewItemDeleted), + EVENT(libvlc_MediaListViewWillDeleteItem), + + EVENT(libvlc_MediaListPlayerPlayed), + EVENT(libvlc_MediaListPlayerNextItemSet), + EVENT(libvlc_MediaListPlayerStopped), + + EVENT(libvlc_MediaDiscovererStarted), + EVENT(libvlc_MediaDiscovererEnded) +#undef EVENT +}; +static const char * unkwown_event_name = "Unknown Event"; + +const char * libvlc_event_type_name( libvlc_event_type_t event_type ) +{ + if( event_type >= sizeof(event_type_to_name)/sizeof(event_type_to_name[0])) + return unkwown_event_name; + return event_type_to_name[event_type]; +} + +/************************************************************************** + * libvlc_event_attach (public) : + * + * Add a callback for an event. + **************************************************************************/ +void 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, + libvlc_exception_t *p_e ) +{ + libvlc_event_listeners_group_t * listeners_group; + libvlc_event_listener_t * listener; + listener = malloc(sizeof(libvlc_event_listener_t)); + if( !listener ) { - 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; + libvlc_exception_raise( p_e, "No Memory left" ); + return; } + + listener->event_type = event_type; + listener->p_user_data = p_user_data; + listener->pf_callback = pf_callback; + + vlc_mutex_lock( &p_event_manager->object_lock ); + FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups ) + if( listeners_group->event_type == listener->event_type ) + { + ARRAY_APPEND( listeners_group->listeners, listener ); + vlc_mutex_unlock( &p_event_manager->object_lock ); + return; + } + FOREACH_END() + vlc_mutex_unlock( &p_event_manager->object_lock ); + + free(listener); + libvlc_exception_raise( p_e, + "This object event manager doesn't know about '%s' events", + libvlc_event_type_name(event_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 ) +/************************************************************************** + * 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_exception_t *p_e ) { - struct libvlc_callback_entry_list_t *p_listitem = p_instance->p_callback_list; + libvlc_event_detach_lock_state( p_event_manager, event_type, pf_callback, + p_user_data, libvlc_UnLocked, p_e ); +} - 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 ) - - ) +/************************************************************************** + * libvlc_event_detach_no_lock (internal) : + * + * Remove a callback for an event. + **************************************************************************/ +void libvlc_event_detach_lock_state( libvlc_event_manager_t *p_event_manager, + libvlc_event_type_t event_type, + libvlc_callback_t pf_callback, + void *p_user_data, + libvlc_lock_state_t lockstate, + libvlc_exception_t *p_e ) +{ + libvlc_event_listeners_group_t * listeners_group; + libvlc_event_listener_t * listener; + + if( lockstate == libvlc_UnLocked ) + vlc_mutex_lock( &p_event_manager->event_sending_lock ); + vlc_mutex_lock( &p_event_manager->object_lock ); + FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups ) + if( listeners_group->event_type == event_type ) { - 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 ); /* FIXME: need some locking here */ - free( p_listitem ); - break; + FOREACH_ARRAY( listener, listeners_group->listeners ) + if( listener->event_type == event_type && + listener->pf_callback == pf_callback && + listener->p_user_data == p_user_data ) + { + /* that's our listener */ + free( listener ); + ARRAY_REMOVE( listeners_group->listeners, + fe_idx /* This comes from the macro (and that's why + I hate macro) */ ); + vlc_mutex_unlock( &p_event_manager->object_lock ); + if( lockstate == libvlc_UnLocked ) + vlc_mutex_unlock( &p_event_manager->event_sending_lock ); + return; + } + FOREACH_END() } - p_listitem = p_listitem->next; - } + FOREACH_END() + vlc_mutex_unlock( &p_event_manager->object_lock ); + if( lockstate == libvlc_UnLocked ) + vlc_mutex_unlock( &p_event_manager->event_sending_lock ); + + libvlc_exception_raise( p_e, + "This object event manager doesn't know about '%s,%p,%p' event observer", + libvlc_event_type_name(event_type), pf_callback, p_user_data ); }