/*****************************************************************************
* vlc_objects.h: vlc_object_t definition and manipulation methods
*****************************************************************************
- * Copyright (C) 2002-2006 the VideoLAN team
+ * Copyright (C) 2002-2008 the VideoLAN team
* $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
* 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.
*/
/* Object types */
-#define VLC_OBJECT_GLOBAL (-1)
-#define VLC_OBJECT_LIBVLC (-2)
-#define VLC_OBJECT_MODULE (-3)
-#define VLC_OBJECT_INTF (-4)
-#define VLC_OBJECT_PLAYLIST (-5)
-#define VLC_OBJECT_ITEM (-6)
#define VLC_OBJECT_INPUT (-7)
#define VLC_OBJECT_DECODER (-8)
#define VLC_OBJECT_VOUT (-9)
#define VLC_OBJECT_AOUT (-10)
-#define VLC_OBJECT_SOUT (-11)
-#define VLC_OBJECT_HTTPD (-12)
-#define VLC_OBJECT_PACKETIZER (-13)
-#define VLC_OBJECT_ENCODER (-14)
-#define VLC_OBJECT_DIALOGS (-15)
-#define VLC_OBJECT_VLM (-16)
-#define VLC_OBJECT_ANNOUNCE (-17)
-#define VLC_OBJECT_DEMUX (-18)
-#define VLC_OBJECT_ACCESS (-19)
-#define VLC_OBJECT_STREAM (-20)
-#define VLC_OBJECT_OPENGL (-21)
-#define VLC_OBJECT_FILTER (-22)
-#define VLC_OBJECT_VOD (-23)
-#define VLC_OBJECT_SPU (-24)
-#define VLC_OBJECT_TLS (-25)
-#define VLC_OBJECT_SD (-26)
-#define VLC_OBJECT_XML (-27)
-#define VLC_OBJECT_OSDMENU (-28)
-#define VLC_OBJECT_STATS (-29)
-#define VLC_OBJECT_HTTPD_HOST (-30)
-#define VLC_OBJECT_META_ENGINE (-31)
-
+/* Please add new object types below -34 */
+/* Please do not add new object types anyway */
#define VLC_OBJECT_GENERIC (-666)
/* Object search mode */
#define FIND_CHILD 0x0002
#define FIND_ANYWHERE 0x0003
-#define FIND_STRICT 0x0010
-
/* Object flags */
#define OBJECT_FLAGS_NODBG 0x0001
#define OBJECT_FLAGS_QUIET 0x0002
#define OBJECT_FLAGS_NOINTERACT 0x0004
+/* Types */
+typedef void (*vlc_destructor_t)(struct vlc_object_t *);
+
/*****************************************************************************
* The vlc_object_t type. Yes, it's that simple :-)
*****************************************************************************/
/*****************************************************************************
* 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_kill, ( vlc_object_t * ) );
-VLC_EXPORT( vlc_bool_t, __vlc_object_dying_unlocked, ( vlc_object_t * ) );
-VLC_EXPORT( vlc_bool_t, __vlc_object_dying, ( 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_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 ) );
-
-#if defined( WIN32 ) || defined( SYS_BEOS ) || defined( __APPLE__ )
-VLC_EXPORT( const char *, vlc_path, ( vlc_object_t * ) );
+VLC_EXPORT( void *, vlc_object_create, ( vlc_object_t *, size_t ) ) LIBVLC_MALLOC LIBVLC_USED;
+VLC_EXPORT( void, vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
+VLC_EXPORT( void, vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
+#if defined (__GNUC__) && !defined __cplusplus
+__attribute__((deprecated))
#endif
+VLC_EXPORT( void *, vlc_object_find, ( vlc_object_t *, int, int ) ) LIBVLC_USED;
+#if defined (__GNUC__) && !defined __cplusplus
+__attribute__((deprecated))
+#endif
+VLC_EXPORT( vlc_object_t *, vlc_object_find_name, ( vlc_object_t *, const char *, int ) ) LIBVLC_USED;
+VLC_EXPORT( void *, vlc_object_hold, ( vlc_object_t * ) );
+VLC_EXPORT( void, vlc_object_release, ( vlc_object_t * ) );
+VLC_EXPORT( vlc_list_t *, vlc_list_children, ( vlc_object_t * ) ) LIBVLC_USED;
+VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
+VLC_EXPORT( char *, vlc_object_get_name, ( const vlc_object_t * ) ) LIBVLC_USED;
+#define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
-/*}@*/
-
-#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_kill(a) \
- __vlc_object_kill( VLC_OBJECT(a) )
+#define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
-#define vlc_object_detach(a) \
- __vlc_object_detach( VLC_OBJECT(a) )
+#define vlc_object_set_destructor(a,b) \
+ vlc_object_set_destructor( VLC_OBJECT(a), b )
#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)
+ vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
#define vlc_object_find(a,b,c) \
- __vlc_object_find( VLC_OBJECT(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)
+ vlc_object_find_name( VLC_OBJECT(a),b,c)
-#define vlc_object_yield(a) \
- __vlc_object_yield( VLC_OBJECT(a) )
+#define vlc_object_hold(a) \
+ vlc_object_hold( VLC_OBJECT(a) )
#define vlc_object_release(a) \
- __vlc_object_release( VLC_OBJECT(a) )
+ vlc_object_release( VLC_OBJECT(a) )
+
+#define vlc_list_children(a) \
+ vlc_list_children( VLC_OBJECT(a) )
+
+/* Objects and threading */
+VLC_EXPORT( void, vlc_object_kill, ( vlc_object_t * ) );
+#define vlc_object_kill(a) \
+ vlc_object_kill( VLC_OBJECT(a) )
+
+LIBVLC_USED
+static inline bool vlc_object_alive (const vlc_object_t *obj)
+{
+ barrier ();
+ return !obj->b_die;
+}
+
+#define vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) )
-#define vlc_list_find(a,b,c) \
- __vlc_list_find( VLC_OBJECT(a),b,c)
+/** @} */
projects / vlc / blobdiff