X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_objects.h;h=ba8b7295cbefc6dd570e28233ab0d4076d6f2bba;hb=6d1bdaf0c6161fabf99a00f76e8404823312cf74;hp=c83c1a2b26d9bc80cc114e2ce9dbd1cd1bb915e8;hpb=fab59c05a4dacdcc0e6dd2e29236010661c5b618;p=vlc diff --git a/include/vlc_objects.h b/include/vlc_objects.h index c83c1a2b26..ba8b7295cb 100644 --- a/include/vlc_objects.h +++ b/include/vlc_objects.h @@ -1,7 +1,7 @@ /***************************************************************************** - * vlc_objects.h: vlc_object_t definition. + * vlc_objects.h: vlc_object_t definition and manipulation methods ***************************************************************************** - * Copyright (C) 2002 VideoLAN + * Copyright (C) 2002-2008 the VideoLAN team * $Id$ * * Authors: Samuel Hocevar @@ -18,12 +18,16 @@ * * 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., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * 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 + * This file defines the vlc_object_t structure and object types. */ /** @@ -32,25 +36,40 @@ */ /* Object types */ -#define VLC_OBJECT_ROOT (-1) -#define VLC_OBJECT_VLC (-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_GENERIC (-666) +#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_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_OSDMENU (-28) + +#define VLC_OBJECT_HTTPD_HOST (-30) +#define VLC_OBJECT_META_ENGINE (-31) +#define VLC_OBJECT_INTERACTION (-32) + +#define VLC_OBJECT_GENERIC (-666) /* Object search mode */ #define FIND_PARENT 0x0001 @@ -59,6 +78,17 @@ #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 *); + +/* Constants */ +VLC_PUBLIC_API const vlc_destructor_t kVLCDestructor; + /***************************************************************************** * The vlc_object_t type. Yes, it's that simple :-) *****************************************************************************/ @@ -72,11 +102,12 @@ 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_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 ) ); @@ -87,9 +118,8 @@ VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) ); #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_set_destructor(a,b) \ + __vlc_object_set_destructor( VLC_OBJECT(a), b ) #define vlc_object_detach(a) \ __vlc_object_detach( VLC_OBJECT(a) ) @@ -97,12 +127,12 @@ VLC_EXPORT( void, vlc_list_release, ( vlc_list_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) +#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) ) @@ -112,3 +142,64 @@ VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) ); #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) ) + +