1 /*****************************************************************************
2 * vlc_objects.h: vlc_object_t definition and manipulation methods
3 *****************************************************************************
4 * Copyright (C) 2002-2008 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
40 #define VLC_OBJECT_LIBVLC (-2)
41 #define VLC_OBJECT_MODULE (-3)
42 #define VLC_OBJECT_INTF (-4)
43 #define VLC_OBJECT_PLAYLIST (-5)
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)
51 #define VLC_OBJECT_PACKETIZER (-13)
52 #define VLC_OBJECT_ENCODER (-14)
53 #define VLC_OBJECT_DIALOGS (-15)
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)
66 #define VLC_OBJECT_OSDMENU (-28)
68 #define VLC_OBJECT_HTTPD_HOST (-30)
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
87 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
90 VLC_PUBLIC_API const vlc_destructor_t kVLCDestructor;
92 /*****************************************************************************
93 * The vlc_object_t type. Yes, it's that simple :-)
94 *****************************************************************************/
95 /** The main vlc_object_t structure */
101 /*****************************************************************************
103 *****************************************************************************/
104 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
105 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
106 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
107 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
108 VLC_EXPORT( void *, vlc_object_get, ( int ) );
109 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
110 VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
111 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
112 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
113 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
114 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) );
115 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
117 /* __vlc_object_dump */
118 VLC_EXPORT( void, __vlc_object_dump, ( vlc_object_t *p_this ) );
122 #define vlc_object_create(a,b) \
123 __vlc_object_create( VLC_OBJECT(a), b )
125 #define vlc_object_set_destructor(a,b) \
126 __vlc_object_set_destructor( VLC_OBJECT(a), b )
128 #define vlc_object_detach(a) \
129 __vlc_object_detach( VLC_OBJECT(a) )
131 #define vlc_object_attach(a,b) \
132 __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
134 #define vlc_object_find(a,b,c) \
135 __vlc_object_find( VLC_OBJECT(a),b,c)
137 #define vlc_object_find_name(a,b,c) \
138 __vlc_object_find_name( VLC_OBJECT(a),b,c)
140 #define vlc_object_yield(a) \
141 __vlc_object_yield( VLC_OBJECT(a) )
143 #define vlc_object_release(a) \
144 __vlc_object_release( VLC_OBJECT(a) )
146 #define vlc_list_find(a,b,c) \
147 __vlc_list_find( VLC_OBJECT(a),b,c)
149 #define vlc_list_children(a) \
150 __vlc_list_children( VLC_OBJECT(a) )
152 #define vlc_object_dump(a) \
153 __vlc_object_dump( VLC_OBJECT(a))
156 /* Objects and threading */
157 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
158 #define vlc_object_lock( obj ) \
159 __vlc_object_lock( VLC_OBJECT( obj ) )
161 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
162 #define vlc_object_unlock( obj ) \
163 __vlc_object_unlock( VLC_OBJECT( obj ) )
165 VLC_EXPORT( bool, __vlc_object_wait, ( vlc_object_t * ) );
166 #define vlc_object_wait( obj ) \
167 __vlc_object_wait( VLC_OBJECT( obj ) )
169 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
170 #define vlc_object_timedwait( obj, d ) \
171 __vlc_object_timedwait( VLC_OBJECT( obj ), d )
173 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
174 #define vlc_object_signal_unlocked( obj ) \
175 __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
177 static inline void __vlc_object_signal( vlc_object_t *obj )
179 vlc_object_lock( obj );
180 vlc_object_signal_unlocked( obj );
181 vlc_object_unlock( obj );
183 #define vlc_object_signal( obj ) \
184 __vlc_object_signal( VLC_OBJECT( obj ) )
186 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
187 #define vlc_object_kill(a) \
188 __vlc_object_kill( VLC_OBJECT(a) )
190 VLC_EXPORT( bool, __vlc_object_alive, ( vlc_object_t * ) );
191 #define vlc_object_alive(a) \
192 __vlc_object_alive( VLC_OBJECT(a) )
194 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
195 #define vlc_object_waitpipe(a) \
196 __vlc_object_waitpipe( VLC_OBJECT(a) )
198 /* NOTE: this function is a *temporary* convenience.
199 * See the vlc_object_alive() documentation for a better alternative.
202 bool __vlc_object_lock_and_wait( vlc_object_t *obj )
206 vlc_object_lock( obj );
207 if( vlc_object_alive( obj ) )
208 b = vlc_object_wait( obj );
209 vlc_object_unlock( obj );
212 #define vlc_object_lock_and_wait( obj ) \
213 __vlc_object_lock_and_wait( VLC_OBJECT(obj) )