]> git.sesse.net Git - vlc/blobdiff - src/control/event.c
src/control/event.c: Add missing return for NDEBUG builds. Fix return
[vlc] / src / control / event.c
index d7f0b41facbe27bba69cf38d89846a2d5844f216..af3f043c9af2a3222734360daa49d4685494d88d 100644 (file)
  * 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 <vlc/libvlc.h>
-#include <vlc_playlist.h>
+
+#include "libvlc_internal.h"
+#include "event_internal.h"
+#include <assert.h>
+#include <errno.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
-listeners_are_equal( libvlc_event_listener_t * listener1,
-                     libvlc_event_listener_t * listener2 )
-{
-    return listener1->event_type  == listener2->event_type &&
-           listener1->pf_callback == listener2->pf_callback &&
-           listener1->p_user_data == listener2->p_user_data;
-}
-
 static bool
 group_contains_listener( libvlc_event_listeners_group_t * group,
                          libvlc_event_listener_t * searched_listener )
@@ -62,20 +68,22 @@ group_contains_listener( libvlc_event_listeners_group_t * group,
  * 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 )
+libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst )
 {
     libvlc_event_manager_t * p_em;
 
     p_em = malloc(sizeof( libvlc_event_manager_t ));
     if( !p_em )
     {
-        libvlc_exception_raise( p_e, "No Memory left" );
+        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 );
@@ -86,13 +94,15 @@ libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst,
 /**************************************************************************
  *       libvlc_event_manager_release (internal) :
  *
- * Init an object's event manager.
+ * Release an object's event manager.
  **************************************************************************/
 void libvlc_event_manager_release( libvlc_event_manager_t * p_em )
 {
     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 );
 
@@ -118,17 +128,10 @@ void libvlc_event_manager_release( libvlc_event_manager_t * p_em )
  **************************************************************************/
 void libvlc_event_manager_register_event_type(
         libvlc_event_manager_t * p_em,
-        libvlc_event_type_t event_type,
-        libvlc_exception_t * p_e )
+        libvlc_event_type_t event_type )
 {
     libvlc_event_listeners_group_t * listeners_group;
-    listeners_group = malloc(sizeof(libvlc_event_listeners_group_t));
-    if( !listeners_group )
-    {
-        libvlc_exception_raise( p_e, "No Memory left" );
-        return;
-    }
-
+    listeners_group = xmalloc(sizeof(libvlc_event_listeners_group_t));
     listeners_group->event_type = event_type;
     vlc_array_init( &listeners_group->listeners );
 
@@ -165,11 +168,13 @@ void libvlc_event_send( libvlc_event_manager_t * p_em,
             if( vlc_array_count( &listeners_group->listeners ) <= 0 )
                 break;
 
-            /* Cache a copy of the listener to avoid locking issues */
+            /* 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;
             }
@@ -188,6 +193,7 @@ void libvlc_event_send( libvlc_event_manager_t * p_em,
     if( !listeners_group )
     {
         free( array_listeners_cached );
+        vlc_mutex_unlock( &p_em->object_lock );
         return;
     }
 
@@ -198,22 +204,32 @@ void libvlc_event_send( libvlc_event_manager_t * p_em,
     listeners_group->b_sublistener_removed = false;
     for( i = 0; i < i_cached_listeners; i++ )
     {
-        if( listeners_group->b_sublistener_removed )
+        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
         {
-            /* 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 )
+            /* 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 )
             {
-                listener_cached++;
-                continue;
-            }
+                /* 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;
+                }
+            }            
         }
-
-        listener_cached->pf_callback( p_event, listener_cached->p_user_data );
-        listener_cached++;
     }
     vlc_mutex_unlock( &p_em->event_sending_lock );
 
@@ -229,87 +245,46 @@ void libvlc_event_send( libvlc_event_manager_t * p_em,
  *
  * Get the char * name of an event type.
  **************************************************************************/
-static const char event_type_to_name[][35] =
+static const char event_type_to_name[][libvlc_num_event_types] =
 {
-#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
+#define DEF(a) [libvlc_##a]=#a
+    DEFINE_LIBVLC_EVENT_TYPES
+#undef  DEF
 };
 
-static const char unkwown_event_name[] = "Unknown Event";
+static const char unknown_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;
+    if( event_type >= libvlc_num_event_types )
+        return unknown_event_name;
     return event_type_to_name[event_type];
 }
 
 /**************************************************************************
- *       libvlc_event_attach (public) :
+ *       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
+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( !listener )
-    {
-        libvlc_exception_raise( p_e, "No Memory left" );
-        return;
-    }
-
+    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++ )
     {
@@ -318,15 +293,44 @@ void libvlc_event_attach( libvlc_event_manager_t * p_event_manager,
         {
             vlc_array_append( &listeners_group->listeners, listener );
             vlc_mutex_unlock( &p_event_manager->object_lock );
-            return;
+            return 0;
         }
     }
     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));
+    fprintf( stderr, "This object event manager doesn't know about '%s' events",
+             libvlc_event_type_name(event_type) );
+    assert(0);
+    return -1;
+}
+
+/**************************************************************************
+ *       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 */);
+}
+
+/**************************************************************************
+ *       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 */);
 }
 
 /**************************************************************************
@@ -337,13 +341,13 @@ void libvlc_event_attach( 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_exception_t *p_e )
+                                     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++)
@@ -366,9 +370,8 @@ void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
 
                     free( listener );
                     vlc_array_remove( &listeners_group->listeners, j );
-                    vlc_mutex_unlock( &p_event_manager->object_lock );
-                    vlc_mutex_unlock( &p_event_manager->event_sending_lock );
-                    return;
+                    found = true;
+                    break;
                 }
             }
         }
@@ -376,7 +379,14 @@ void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
     vlc_mutex_unlock( &p_event_manager->object_lock );
     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 );
+    /* 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);
 }