X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_objects.h;h=34149d027aa6f87ed6699e0e5c7e16eb7f4728f2;hb=07be8bb586c268720eb4deec0509f473a4d64b51;hp=6058b0b2eb2521cfe3b9f048f59d28f35b172666;hpb=278b0b2aa118af8b6fcc3919764b6fab2eb5eb21;p=vlc diff --git a/include/vlc_objects.h b/include/vlc_objects.h index 6058b0b2eb..34149d027a 100644 --- a/include/vlc_objects.h +++ b/include/vlc_objects.h @@ -1,7 +1,7 @@ /***************************************************************************** * 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 @@ -21,10 +21,6 @@ * 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. @@ -36,38 +32,21 @@ */ /* 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 */ @@ -82,6 +61,9 @@ #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 :-) *****************************************************************************/ @@ -95,36 +77,28 @@ 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_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_set_destructor, ( vlc_object_t *, vlc_destructor_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( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) ); 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 * ) ); -#endif +/* __vlc_object_dump */ +VLC_EXPORT( void, __vlc_object_dump, ( vlc_object_t *p_this ) ); /*}@*/ #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_set_destructor(a,b) \ + __vlc_object_set_destructor( VLC_OBJECT(a), b ) #define vlc_object_detach(a) \ __vlc_object_detach( VLC_OBJECT(a) ) @@ -132,9 +106,6 @@ VLC_EXPORT( const char *, vlc_path, ( vlc_object_t * ) ); #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) @@ -149,3 +120,80 @@ VLC_EXPORT( const char *, vlc_path, ( vlc_object_t * ) ); #define vlc_list_find(a,b,c) \ __vlc_list_find( VLC_OBJECT(a),b,c) + +#define vlc_list_children(a) \ + __vlc_list_children( VLC_OBJECT(a) ) + +#define vlc_object_dump(a) \ + __vlc_object_dump( VLC_OBJECT(a)) + + +/* 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( void, __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) ) + +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) ) + +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 +bool __vlc_object_lock_and_wait( vlc_object_t *obj ) +{ + bool b; + + vlc_object_lock( obj ); + b = vlc_object_alive( obj ); + if( b ) + { + vlc_object_wait( obj ); + b = vlc_object_alive( obj ); + } + vlc_object_unlock( obj ); + return b; +} +#define vlc_object_lock_and_wait( obj ) \ + __vlc_object_lock_and_wait( VLC_OBJECT(obj) ) + +