1 /*****************************************************************************
2 * vlc_objects.h: vlc_object_t definition and manipulation methods
3 *****************************************************************************
4 * Copyright (C) 2002-2006 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #if !defined( __LIBVLC__ )
25 #error You are not libvlc or one of its plugins. You cannot include this file
30 * This file defines the vlc_object_t structure and object types.
34 * \defgroup vlc_object Objects
39 #define VLC_OBJECT_GLOBAL (-1)
40 #define VLC_OBJECT_LIBVLC (-2)
41 #define VLC_OBJECT_MODULE (-3)
42 #define VLC_OBJECT_INTF (-4)
43 #define VLC_OBJECT_PLAYLIST (-5)
44 #define VLC_OBJECT_ITEM (-6)
45 #define VLC_OBJECT_INPUT (-7)
46 #define VLC_OBJECT_DECODER (-8)
47 #define VLC_OBJECT_VOUT (-9)
48 #define VLC_OBJECT_AOUT (-10)
49 #define VLC_OBJECT_SOUT (-11)
50 #define VLC_OBJECT_HTTPD (-12)
51 #define VLC_OBJECT_PACKETIZER (-13)
52 #define VLC_OBJECT_ENCODER (-14)
53 #define VLC_OBJECT_DIALOGS (-15)
54 #define VLC_OBJECT_VLM (-16)
55 #define VLC_OBJECT_ANNOUNCE (-17)
56 #define VLC_OBJECT_DEMUX (-18)
57 #define VLC_OBJECT_ACCESS (-19)
58 #define VLC_OBJECT_STREAM (-20)
59 #define VLC_OBJECT_OPENGL (-21)
60 #define VLC_OBJECT_FILTER (-22)
61 #define VLC_OBJECT_VOD (-23)
62 #define VLC_OBJECT_SPU (-24)
63 /*#define VLC_OBJECT_xxx (-25) - formerly TLS */
64 #define VLC_OBJECT_SD (-26)
65 #define VLC_OBJECT_XML (-27)
66 #define VLC_OBJECT_OSDMENU (-28)
67 #define VLC_OBJECT_STATS (-29)
68 #define VLC_OBJECT_HTTPD_HOST (-30)
69 #define VLC_OBJECT_META_ENGINE (-31)
70 #define VLC_OBJECT_INTERACTION (-32)
72 #define VLC_OBJECT_GENERIC (-666)
74 /* Object search mode */
75 #define FIND_PARENT 0x0001
76 #define FIND_CHILD 0x0002
77 #define FIND_ANYWHERE 0x0003
79 #define FIND_STRICT 0x0010
82 #define OBJECT_FLAGS_NODBG 0x0001
83 #define OBJECT_FLAGS_QUIET 0x0002
84 #define OBJECT_FLAGS_NOINTERACT 0x0004
86 /*****************************************************************************
87 * The vlc_object_t type. Yes, it's that simple :-)
88 *****************************************************************************/
89 /** The main vlc_object_t structure */
95 /*****************************************************************************
97 *****************************************************************************/
98 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
99 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
100 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
101 VLC_EXPORT( void *, vlc_object_get, ( int ) );
102 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
103 VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
104 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
105 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
106 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
107 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
111 #define vlc_object_create(a,b) \
112 __vlc_object_create( VLC_OBJECT(a), b )
114 #define vlc_object_detach(a) \
115 __vlc_object_detach( VLC_OBJECT(a) )
117 #define vlc_object_attach(a,b) \
118 __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
120 #define vlc_object_find(a,b,c) \
121 __vlc_object_find( VLC_OBJECT(a),b,c)
123 #define vlc_object_find_name(a,b,c) \
124 __vlc_object_find_name( VLC_OBJECT(a),b,c)
126 #define vlc_object_yield(a) \
127 __vlc_object_yield( VLC_OBJECT(a) )
129 #define vlc_object_release(a) \
130 __vlc_object_release( VLC_OBJECT(a) )
132 #define vlc_list_find(a,b,c) \
133 __vlc_list_find( VLC_OBJECT(a),b,c)
136 /* Objects and threading */
137 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
138 #define vlc_object_lock( obj ) \
139 __vlc_object_lock( VLC_OBJECT( obj ) )
141 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
142 #define vlc_object_unlock( obj ) \
143 __vlc_object_unlock( VLC_OBJECT( obj ) )
145 VLC_EXPORT( vlc_bool_t, __vlc_object_wait, ( vlc_object_t * ) );
146 #define vlc_object_wait( obj ) \
147 __vlc_object_wait( VLC_OBJECT( obj ) )
149 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
150 #define vlc_object_timedwait( obj, d ) \
151 __vlc_object_timedwait( VLC_OBJECT( obj ), d )
153 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
154 #define vlc_object_signal_unlocked( obj ) \
155 __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
157 static inline void __vlc_object_signal( vlc_object_t *obj )
159 vlc_object_lock( obj );
160 vlc_object_signal_unlocked( obj );
161 vlc_object_unlock( obj );
163 #define vlc_object_signal( obj ) \
164 __vlc_object_signal( VLC_OBJECT( obj ) )
166 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
167 #define vlc_object_kill(a) \
168 __vlc_object_kill( VLC_OBJECT(a) )
170 VLC_EXPORT( vlc_bool_t, __vlc_object_alive, ( vlc_object_t * ) );
171 #define vlc_object_alive(a) \
172 __vlc_object_alive( VLC_OBJECT(a) )
174 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
175 #define vlc_object_waitpipe(a) \
176 __vlc_object_waitpipe( VLC_OBJECT(a) )
178 /* NOTE: this function is a *temporary* convenience.
179 * See the vlc_object_alive() documentation for a better alternative.
182 vlc_bool_t __vlc_object_lock_and_wait( vlc_object_t *obj )
184 vlc_bool_t b = VLC_TRUE;
186 vlc_object_lock( obj );
187 if( vlc_object_alive( obj ) )
188 b = vlc_object_wait( obj );
189 vlc_object_unlock( obj );
192 #define vlc_object_lock_and_wait( obj ) \
193 __vlc_object_lock_and_wait( VLC_OBJECT(obj) )