X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_objects.h;h=46103b16e257611c79ac5f0a5e20ffd1cc8e5911;hb=8fec091327c0a2bf0927981bca52fe2f6fabcc72;hp=23b4bbb09001432c52e7972cff59c0eae5952030;hpb=bf7985b74afcef9103b35a3c47eeae5845ae681b;p=vlc diff --git a/include/vlc_objects.h b/include/vlc_objects.h index 23b4bbb090..46103b16e2 100644 --- a/include/vlc_objects.h +++ b/include/vlc_objects.h @@ -1,8 +1,8 @@ /***************************************************************************** - * vlc_objects.h: vlc_object_t definition. + * vlc_objects.h: vlc_object_t definition and manipulation methods ***************************************************************************** - * Copyright (C) 2002 VideoLAN - * $Id: vlc_objects.h,v 1.13 2002/10/14 16:46:55 sam Exp $ + * Copyright (C) 2002-2006 the VideoLAN team + * $Id$ * * Authors: Samuel Hocevar * @@ -10,7 +10,7 @@ * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 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 @@ -18,22 +18,57 @@ * * 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. + */ + +/** + * \defgroup vlc_object Objects + * @{ + */ + /* 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_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_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) + +#define VLC_OBJECT_GENERIC (-666) /* Object search mode */ #define FIND_PARENT 0x0001 @@ -42,27 +77,20 @@ #define FIND_STRICT 0x0010 +/* Object flags */ +#define OBJECT_FLAGS_NODBG 0x0001 +#define OBJECT_FLAGS_QUIET 0x0002 +#define OBJECT_FLAGS_NOINTERACT 0x0004 + /***************************************************************************** * The vlc_object_t type. Yes, it's that simple :-) *****************************************************************************/ +/** The main vlc_object_t structure */ struct vlc_object_t { VLC_COMMON_MEMBERS }; -/***************************************************************************** - * The vlc_list_t object list type - *****************************************************************************/ -struct vlc_list_t -{ - int i_count; - vlc_object_t ** pp_objects; - - /* Private */ - int _i_extra; - vlc_object_t * _p_first; -}; - /***************************************************************************** * Prototypes *****************************************************************************/ @@ -72,11 +100,14 @@ 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 * ) ); +/*}@*/ + #define vlc_object_create(a,b) \ __vlc_object_create( VLC_OBJECT(a), b ) @@ -96,6 +127,9 @@ VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) ); #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) ) @@ -105,3 +139,45 @@ 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 ) ) + +static inline +vlc_bool_t __vlc_object_lock_and_wait( vlc_object_t *obj ) +{ + vlc_bool_t b; + + vlc_object_lock( 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_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 ) ) + +VLC_EXPORT( void, __vlc_object_signal, ( vlc_object_t * ) ); +#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) )