]> git.sesse.net Git - vlc/blobdiff - src/control/event.c
- libvlc APIs: bug fixing, and please note that exception argument is OPTIONAL (can...
[vlc] / src / control / event.c
index 338f6b37b606a2e7f09baca3ea476673f39143ff..a44b247383b67fb65414a8f3377cc2f35d2bddaa 100644 (file)
@@ -1,10 +1,11 @@
 /*****************************************************************************
- * libvlc_callback.c: New libvlc callback control API
+ * event.c: New libvlc event control API
  *****************************************************************************
  * Copyright (C) 2007 the VideoLAN team
  * $Id $
  *
  * Authors: Filippo Carone <filippo@carone.org>
+ *          Pierre d'Herbemont <pdherbemont # videolan.org>
  *
  * 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
 
 #include "libvlc_internal.h"
 #include <vlc/libvlc.h>
+#include <vlc_playlist.h>
 
-static int handle_callback( vlc_object_t *p_this, char const *psz_cmd,
-                            vlc_value_t oldval, vlc_value_t newval,
-                            void *p_data )
+
+/*
+ * 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 )
 {
+    /* 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;
-    switch ( event.type )
+
+    event.type = entry->i_event_type;    
+
+    if (event.type == libvlc_VolumeChanged)
     {
-        case VOLUME_CHANGED:
-            event.value_type = BOOLEAN_EVENT;
-            break;
-        case INPUT_POSITION_CHANGED:
-            break;
-        default:
-            break;
+        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)
+    {
+        event.u.volume_changed.new_volume = newval.i_int;
     }
-    event.old_value = oldval;
-    event.new_value = newval;
 
     /* Call the client entry */
     entry->f_callback( entry->p_instance, &event, entry->p_user_data );
@@ -50,58 +81,244 @@ static int handle_callback( vlc_object_t *p_this, char const *psz_cmd,
     return VLC_SUCCESS;
 }
 
-void libvlc_callback_register_for_event( 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 )
+/**************************************************************************
+ *       get_input (private) :
+ *
+ * Utility function, Object should be released by vlc_object_release
+ * afterwards
+ **************************************************************************/
+static input_thread_t * get_input(libvlc_instance_t * p_instance)
 {
+    libvlc_media_instance_t * p_mi;
+    input_thread_t * p_input;
 
-    if ( ! &f_callback )
-        RAISEVOID (" Callback function is null ");
+    p_mi = libvlc_playlist_get_media_instance( p_instance, NULL );
+
+    if( !p_mi )
+        return NULL;
+
+    p_input = libvlc_get_input_thread( p_mi, NULL );
+
+    libvlc_media_instance_release( p_mi );
+
+    return p_input;
+}
+
+/**************************************************************************
+ *       install_input_event (private) :
+ *
+ * vlc variables callback, used to install input event.
+ * Can be called manually though.
+ **************************************************************************/
+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 )
+{
+    libvlc_instance_t * p_instance = p_data;
+    struct libvlc_callback_entry_list_t *p_listitem;
+    input_thread_t * p_input = get_input( p_instance );
+
+    if( !p_input )
+        return;
+
+    vlc_mutex_lock( &p_instance->instance_lock );
+
+    p_listitem = p_instance->p_callback_list;
+
+    for( ; p_listitem ; p_listitem = p_listitem->next )
+    {
+        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 );
+        }
+    }
+
+    vlc_mutex_unlock( &p_instance->instance_lock );
+    vlc_object_release( p_input );
+    return VLC_SUCCESS;
+}
+
+/**************************************************************************
+ *       add_callback_to_list (private) :
+ *
+ * callback list utility function.
+ **************************************************************************/
+static inline void add_callback_to_list( struct libvlc_callback_entry_t *entry,
+                                         struct libvlc_callback_entry_list_t **list )
+{
+    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;
+}
+
+/**************************************************************************
+ *       remove_variable_callback (private) :
+ *
+ * Delete the appropriate vlc variables callback for an event.
+ **************************************************************************/
+static int remove_variable_callback( libvlc_instance_t *p_instance, 
+                                     struct libvlc_callback_entry_t * p_entry )
+{
+    input_thread_t * p_input = get_input( p_instance );
+    int res = VLC_SUCCESS;
+
+    /* Note: Appropriate lock should be held by the caller */
+
+    switch ( p_entry->i_event_type )
+    {
+        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 );
+            break;
+    }
     
-    struct libvlc_callback_entry_t *entry = malloc( sizeof( struct libvlc_callback_entry_t ) );
+    if (p_input)
+        vlc_object_release( p_input );
+
+    return res;
+}
+
+/*
+ * Internal libvlc functions
+ */
+
+/**************************************************************************
+ *       libvlc_event_init (internal) :
+ *
+ * initialization function.
+ **************************************************************************/
+void libvlc_event_init( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
+{
+    playlist_t *p_playlist = p_instance->p_libvlc_int->p_playlist;
+
+    if( !p_playlist )
+        RAISEVOID ("Can't listen to input 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 )
+{
+    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 );
+}
+
+/*
+ * Public libvlc functions
+ */
+
+/**************************************************************************
+ *       libvlc_event_add_callback (public) :
+ *
+ * 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 )
+{
+    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;
-
-    const char *callback_name;
     
     switch ( i_event_type )
     {
-        case VOLUME_CHANGED:
-            callback_name = "volume-change";
+        case libvlc_VolumeChanged:
+            res = var_AddCallback( p_instance->p_libvlc_int, "volume-change",
+                           handle_event, entry );
             break;
-        case INPUT_POSITION_CHANGED:
+        case libvlc_InputPositionChanged:
+            install_input_event( NULL, NULL, unused1, unused2, p_instance);
             break;
         default:
             free( entry );
             RAISEVOID( "Unsupported event." );
     }
 
-    int res = var_AddCallback( p_instance->p_libvlc_int,
-                               callback_name,
-                               handle_callback,
-                               entry );
-    
     if (res != VLC_SUCCESS)
     {
         free ( entry );
         RAISEVOID("Internal callback registration was not successful. Callback not registered.");
     }
     
-    add_callback_entry( entry, &p_instance->p_callback_list );
+    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;
 }
 
-void libvlc_callback_unregister_for_event( 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_remove_callback (public) :
+ *
+ * Remove 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 )
 {
-    struct libvlc_callback_entry_list_t *p_listitem = p_instance->p_callback_list;
+    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 )
     {
@@ -111,15 +328,48 @@ void libvlc_callback_unregister_for_event( libvlc_instance_t *p_instance,
         
         )
         {
+            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 );
+}
+
+/**************************************************************************
+ *       libvlc_event_remove_all_callbacks (public) :
+ *
+ * Remove all callbacks for all events.
+ **************************************************************************/
+void libvlc_event_remove_all_callbacks( libvlc_instance_t *p_instance,
+                                       libvlc_exception_t *p_e )
+{
+    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 )
+    {
+        remove_variable_callback( p_instance, p_listitem->elmt ); /* FIXME: We could warn on error */
+        p_listitem = p_listitem->next;
+
+    }
+    p_instance->p_callback_list = NULL;
+
+    vlc_mutex_unlock( &p_instance->instance_lock );
 }