X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_objects.h;h=c6708750ee9cd68a9fce0246f019ad8aec80432b;hb=1c757f0a4ffcc4d87f950441bcdc2ef6f1240c20;hp=9f9244acf855349668ff4700e5cb21ff502edfbb;hpb=a78e273ec53ff8a6c3993f3deda0b893f8dd709a;p=vlc diff --git a/include/vlc_objects.h b/include/vlc_objects.h index 9f9244acf8..c6708750ee 100644 --- a/include/vlc_objects.h +++ b/include/vlc_objects.h @@ -1,30 +1,26 @@ /***************************************************************************** * vlc_objects.h: vlc_object_t definition and manipulation methods ***************************************************************************** - * Copyright (C) 2002-2006 the VideoLAN team + * Copyright (C) 2002-2008 VLC authors and VideoLAN * $Id$ * * Authors: Samuel Hocevar * - * 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 - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software 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. @@ -35,50 +31,7 @@ * @{ */ -/* 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_xxx (-25) - formerly TLS */ -#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) - -#define VLC_OBJECT_GENERIC (-666) - -/* Object search mode */ -#define FIND_PARENT 0x0001 -#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 @@ -94,101 +47,33 @@ struct vlc_object_t /***************************************************************************** * Prototypes *****************************************************************************/ -VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) ); -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, ( 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_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED; +VLC_API vlc_object_t *vlc_object_find_name( vlc_object_t *, const char * ) VLC_USED VLC_DEPRECATED; +VLC_API void * vlc_object_hold( vlc_object_t * ); +VLC_API void vlc_object_release( vlc_object_t * ); +VLC_API vlc_list_t *vlc_list_children( vlc_object_t * ) VLC_USED; +VLC_API void vlc_list_release( vlc_list_t * ); +VLC_API char *vlc_object_get_name( const vlc_object_t * ) VLC_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_detach(a) \ - __vlc_object_detach( VLC_OBJECT(a) ) +#define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b ) -#define vlc_object_attach(a,b) \ - __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) ) +#define vlc_object_find_name(a,b) \ + vlc_object_find_name( 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) ) +#define vlc_object_hold(a) \ + vlc_object_hold( VLC_OBJECT(a) ) #define vlc_object_release(a) \ - __vlc_object_release( VLC_OBJECT(a) ) - -#define vlc_list_find(a,b,c) \ - __vlc_list_find( VLC_OBJECT(a),b,c) + 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_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) ) - +VLC_API VLC_USED VLC_DEPRECATED bool vlc_object_alive (vlc_object_t *); +#define vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) ) +/** @} */