use vlc-control to be more multiplatform friendly

[vlc] / include / vlc_objects.h

diff --git a/include/vlc_objects.h b/include/vlc_objects.h
index 71565ab947f5b729d144337d2bcc3a75f4761f82..9f9244acf855349668ff4700e5cb21ff502edfbb 100644 (file)
--- a/include/vlc_objects.h
+++ b/include/vlc_objects.h
@@ -21,6 +21,10 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+#if !defined( __LIBVLC__ )
+  #error You are not libvlc or one of its plugins. You cannot include this file
+#endif
+
 /**
  * \file
  * This file defines the vlc_object_t structure and object types.
@@ -32,7 +36,7 @@
  */
 
 /* Object types */
-#define VLC_OBJECT_ROOT        (-1)
+#define VLC_OBJECT_GLOBAL      (-1)
 #define VLC_OBJECT_LIBVLC      (-2)
 #define VLC_OBJECT_MODULE      (-3)
 #define VLC_OBJECT_INTF        (-4)
@@ -56,7 +60,7 @@
 #define VLC_OBJECT_FILTER      (-22)
 #define VLC_OBJECT_VOD         (-23)
 #define VLC_OBJECT_SPU         (-24)
-#define VLC_OBJECT_TLS         (-25)
+/*#define VLC_OBJECT_xxx         (-25) - formerly TLS */
 #define VLC_OBJECT_SD          (-26)
 #define VLC_OBJECT_XML         (-27)
 #define VLC_OBJECT_OSDMENU     (-28)
@@ -91,38 +95,33 @@ struct vlc_object_t
  * Prototypes
  *****************************************************************************/
 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
-VLC_EXPORT( void, __vlc_object_destroy, ( vlc_object_t * ) );
 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
-VLC_EXPORT( void *, __vlc_object_get, ( vlc_object_t *, int ) );
+VLC_EXPORT( void *, vlc_object_get, ( int ) );
 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
+VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
-VLC_EXPORT( libvlc_int_t *, vlc_current_object, ( int ) );
 
 /*}@*/
 
 #define vlc_object_create(a,b) \
     __vlc_object_create( VLC_OBJECT(a), b )
 
-#define vlc_object_destroy(a) do { \
-    __vlc_object_destroy( VLC_OBJECT(a) ); \
-    (a) = NULL; } while(0)
-
 #define vlc_object_detach(a) \
     __vlc_object_detach( VLC_OBJECT(a) )
 
 #define vlc_object_attach(a,b) \
     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
 
-#define vlc_object_get(a,b) \
-    __vlc_object_get( VLC_OBJECT(a),b)
-
 #define vlc_object_find(a,b,c) \
     __vlc_object_find( VLC_OBJECT(a),b,c)
 
+#define vlc_object_find_name(a,b,c) \
+    __vlc_object_find_name( VLC_OBJECT(a),b,c)
+
 #define vlc_object_yield(a) \
     __vlc_object_yield( VLC_OBJECT(a) )
 
@@ -131,3 +130,65 @@ VLC_EXPORT( libvlc_int_t *, vlc_current_object, ( int ) );
 
 #define vlc_list_find(a,b,c) \
     __vlc_list_find( VLC_OBJECT(a),b,c)
+
+
+/* Objects and threading */
+VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
+#define vlc_object_lock( obj ) \
+    __vlc_object_lock( VLC_OBJECT( obj ) )
+
+VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
+#define vlc_object_unlock( obj ) \
+    __vlc_object_unlock( VLC_OBJECT( obj ) )
+
+VLC_EXPORT( vlc_bool_t, __vlc_object_wait, ( vlc_object_t * ) );
+#define vlc_object_wait( obj ) \
+    __vlc_object_wait( VLC_OBJECT( obj ) )
+
+VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
+#define vlc_object_timedwait( obj, d ) \
+    __vlc_object_timedwait( VLC_OBJECT( obj ), d )
+
+VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
+#define vlc_object_signal_unlocked( obj ) \
+    __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
+
+static inline void __vlc_object_signal( vlc_object_t *obj )
+{
+    vlc_object_lock( obj );
+    vlc_object_signal_unlocked( obj );
+    vlc_object_unlock( obj );
+}
+#define vlc_object_signal( obj ) \
+    __vlc_object_signal( VLC_OBJECT( obj ) )
+
+VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
+#define vlc_object_kill(a) \
+    __vlc_object_kill( VLC_OBJECT(a) )
+
+VLC_EXPORT( vlc_bool_t, __vlc_object_alive, ( vlc_object_t * ) );
+#define vlc_object_alive(a) \
+    __vlc_object_alive( VLC_OBJECT(a) )
+
+VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
+#define vlc_object_waitpipe(a) \
+    __vlc_object_waitpipe( VLC_OBJECT(a) )
+
+/* NOTE: this function is a *temporary* convenience.
+ * See the vlc_object_alive() documentation for a better alternative.
+ */
+static inline
+vlc_bool_t __vlc_object_lock_and_wait( vlc_object_t *obj )
+{
+    vlc_bool_t b = VLC_TRUE;
+
+    vlc_object_lock( obj );
+    if( vlc_object_alive( obj ) )
+        b = vlc_object_wait( obj );
+    vlc_object_unlock( obj );
+    return b;
+}
+#define vlc_object_lock_and_wait( obj ) \
+    __vlc_object_lock_and_wait( VLC_OBJECT(obj) )
+
+