* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-#include "libvlc_internal.h"
#include <vlc/libvlc.h>
-#include <vlc_playlist.h>
+#include "libvlc_internal.h"
+#include "event_internal.h"
+
+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 bool
+group_contains_listener( libvlc_event_listeners_group_t * group,
+ libvlc_event_listener_t * searched_listener )
+{
+ int i;
+ for( i = 0; i < vlc_array_count(&group->listeners); i++ )
+ {
+ if( listeners_are_equal(searched_listener, vlc_array_item_at_index(&group->listeners, i)) )
+ return true;
+ }
+ return false;
+}
/*
* 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) :
+ * libvlc_event_manager_new (internal) :
*
* Init an object's event manager.
**************************************************************************/
}
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 );
- 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 );
+ 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;
}
**************************************************************************/
void libvlc_event_manager_release( libvlc_event_manager_t * p_em )
{
- libvlc_event_listeners_group_t * listeners_group;
- libvlc_event_listener_t * listener;
+ 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 );
- 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 );
+ 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 ) );
- libvlc_release( p_em->p_libvlc_instance, NULL );
+ 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 );
}
}
listeners_group->event_type = event_type;
- ARRAY_INIT( listeners_group->listeners );
+ vlc_array_init( &listeners_group->listeners );
vlc_mutex_lock( &p_em->object_lock );
- ARRAY_APPEND( p_em->listeners_groups, listeners_group );
+ vlc_array_append( &p_em->listeners_groups, listeners_group );
vlc_mutex_unlock( &p_em->object_lock );
}
void libvlc_event_send( libvlc_event_manager_t * p_em,
libvlc_event_t * p_event )
{
- libvlc_event_listeners_group_t * listeners_group;
+ 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;
/* Here a read/write lock would be nice */
vlc_mutex_lock( &p_em->object_lock );
- FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
+ for( i = 0; i < vlc_array_count(&p_em->listeners_groups); i++)
+ {
+ listeners_group = vlc_array_item_at_index(&p_em->listeners_groups, i);
if( listeners_group->event_type == p_event->type )
{
- if( listeners_group->listeners.i_size <= 0 )
+ if( vlc_array_count( &listeners_group->listeners ) <= 0 )
break;
- /* Cache a copy of the listener to avoid locking issues */
- i_cached_listeners = listeners_group->listeners.i_size;
+ /* 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 )
{
- printf( "Can't alloc memory in libvlc_event_send" );
- break;
+ vlc_mutex_unlock( &p_em->object_lock );
+ fprintf(stderr, "Can't alloc memory in libvlc_event_send" );
+ return;
}
listener_cached = array_listeners_cached;
- FOREACH_ARRAY( listener, listeners_group->listeners )
- memcpy( listener_cached, listener, sizeof(libvlc_event_listener_t));
+ 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++;
- FOREACH_END()
+ }
break;
}
- FOREACH_END()
+ }
+
+ if( !listeners_group )
+ {
+ free( array_listeners_cached );
+ vlc_mutex_unlock( &p_em->object_lock );
+ return;
+ }
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;
+ listeners_group->b_sublistener_removed = false;
for( i = 0; i < i_cached_listeners; i++ )
{
- listener_cached->pf_callback( p_event, listener_cached->p_user_data );
- listener_cached++;
+ 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 );
*/
/**************************************************************************
- * libvlc_event_attach (public) :
+ * libvlc_event_type_name (public) :
+ *
+ * Get the char * name of an event type.
+ **************************************************************************/
+static const char event_type_to_name[][35] =
+{
+#define EVENT(a) [a]=#a
+ EVENT(libvlc_MediaMetaChanged),
+ EVENT(libvlc_MediaSubItemAdded),
+ EVENT(libvlc_MediaDurationChanged),
+ EVENT(libvlc_MediaPreparsedChanged),
+ EVENT(libvlc_MediaFreed),
+ EVENT(libvlc_MediaStateChanged),
+
+ EVENT(libvlc_MediaPlayerNothingSpecial),
+ EVENT(libvlc_MediaPlayerOpening),
+ EVENT(libvlc_MediaPlayerBuffering),
+ EVENT(libvlc_MediaPlayerPlaying),
+ EVENT(libvlc_MediaPlayerPaused),
+ EVENT(libvlc_MediaPlayerStopped),
+ EVENT(libvlc_MediaPlayerForward),
+ EVENT(libvlc_MediaPlayerBackward),
+ EVENT(libvlc_MediaPlayerEndReached),
+ EVENT(libvlc_MediaPlayerTimeChanged),
+ EVENT(libvlc_MediaPlayerTitleChanged),
+ EVENT(libvlc_MediaPlayerPositionChanged),
+ EVENT(libvlc_MediaPlayerSeekableChanged),
+ EVENT(libvlc_MediaPlayerPausableChanged),
+
+ EVENT(libvlc_MediaListItemAdded),
+ EVENT(libvlc_MediaListWillAddItem),
+ EVENT(libvlc_MediaListItemDeleted),
+ EVENT(libvlc_MediaListWillDeleteItem),
+
+ 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),
+
+ EVENT(libvlc_MediaPlayerSnapshotTaken),
+#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];
+}
+
+/**************************************************************************
+ * event_attach (internal) :
*
* 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 )
+static
+void 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_exception_t *p_e )
{
libvlc_event_listeners_group_t * listeners_group;
libvlc_event_listener_t * listener;
+ int i;
+
listener = malloc(sizeof(libvlc_event_listener_t));
if( !listener )
{
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;
-
+ listener->is_asynchronous = is_asynchronous;
+
vlc_mutex_lock( &p_event_manager->object_lock );
- FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
+ 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 == listener->event_type )
{
- ARRAY_APPEND( listeners_group->listeners, listener );
+ vlc_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(a));
+ "This object event manager doesn't know about '%s' events",
+ libvlc_event_type_name(event_type));
}
/**************************************************************************
- * libvlc_event_detach (public) :
+ * libvlc_event_attach (public) :
*
- * Remove a callback for an event.
+ * Add 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 )
+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_detach_lock_state( p_event_manager, event_type, pf_callback,
- p_user_data, libvlc_UnLocked, p_e );
+ event_attach(p_event_manager, event_type, pf_callback, p_user_data, false /* synchronous */, p_e);
}
/**************************************************************************
- * libvlc_event_detach_no_lock (internal) :
+ * 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,
+ libvlc_exception_t *p_e )
+{
+ event_attach(p_event_manager, event_type, pf_callback, p_user_data, true /* asynchronous */, p_e);
+}
+
+/**************************************************************************
+ * libvlc_event_detach (public) :
*
* Remove a callback for an event.
**************************************************************************/
-void libvlc_event_detach_lock_state( libvlc_event_manager_t *p_event_manager,
+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_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 );
+ int i, j;
+ bool found = false;
+
+ 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 )
+ 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 )
{
- FOREACH_ARRAY( listener, listeners_group->listeners )
+ 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 );
- 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;
+ vlc_array_remove( &listeners_group->listeners, j );
+ found = true;
+ break;
}
- FOREACH_END()
+ }
}
- FOREACH_END()
+ }
vlc_mutex_unlock( &p_event_manager->object_lock );
- if( lockstate == libvlc_UnLocked )
- vlc_mutex_unlock( &p_event_manager->event_sending_lock );
+ vlc_mutex_unlock( &p_event_manager->event_sending_lock );
- libvlc_exception_raise( p_e,
- "This object event manager doesn't know about '%i,%p,%p' event observer",
- event_type, pf_callback, p_user_data );
+ /* 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);
+
+ if(!found)
+ {
+ 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 );
+ }
}