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
39 #define VLC_OBJECT_LIBVLC (-2)
40 #define VLC_OBJECT_MODULE (-3)
41 #define VLC_OBJECT_INTF (-4)
42 #define VLC_OBJECT_PLAYLIST (-5)
43 #define VLC_OBJECT_INPUT (-7)
44 #define VLC_OBJECT_DECODER (-8)
45 #define VLC_OBJECT_VOUT (-9)
46 #define VLC_OBJECT_AOUT (-10)
47 #define VLC_OBJECT_PACKETIZER (-13)
48 #define VLC_OBJECT_ENCODER (-14)
49 #define VLC_OBJECT_DIALOGS (-15)
50 #define VLC_OBJECT_ANNOUNCE (-17)
51 #define VLC_OBJECT_DEMUX (-18)
52 #define VLC_OBJECT_ACCESS (-19)
53 #define VLC_OBJECT_STREAM (-20)
54 #define VLC_OBJECT_OPENGL (-21)
55 #define VLC_OBJECT_FILTER (-22)
56 #define VLC_OBJECT_OSDMENU (-28)
57 #define VLC_OBJECT_HTTPD_HOST (-30)
58 #define VLC_OBJECT_INTERACTION (-32)
59 /* Please add new object types below -34 */
60 /* Please do not add new object types anyway */
61 #define VLC_OBJECT_GENERIC (-666)
63 /* Object search mode */
64 #define FIND_PARENT 0x0001
65 #define FIND_CHILD 0x0002
66 #define FIND_ANYWHERE 0x0003
68 #define FIND_STRICT 0x0010
71 #define OBJECT_FLAGS_NODBG 0x0001
72 #define OBJECT_FLAGS_QUIET 0x0002
73 #define OBJECT_FLAGS_NOINTERACT 0x0004
76 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
78 /*****************************************************************************
79 * The vlc_object_t type. Yes, it's that simple :-)
80 *****************************************************************************/
81 /** The main vlc_object_t structure */
87 /*****************************************************************************
89 *****************************************************************************/
90 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
91 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
92 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
93 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
94 VLC_EXPORT( void *, vlc_object_get, ( int ) );
95 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
96 VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
97 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
98 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
99 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
100 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) );
101 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
103 /* __vlc_object_dump */
104 VLC_EXPORT( void, __vlc_object_dump, ( vlc_object_t *p_this ) );
108 #define vlc_object_create(a,b) \
109 __vlc_object_create( VLC_OBJECT(a), b )
111 #define vlc_object_set_destructor(a,b) \
112 __vlc_object_set_destructor( 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)
135 #define vlc_list_children(a) \
136 __vlc_list_children( VLC_OBJECT(a) )
138 #define vlc_object_dump(a) \
139 __vlc_object_dump( VLC_OBJECT(a))
142 /* Objects and threading */
143 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
144 #define vlc_object_lock( obj ) \
145 __vlc_object_lock( VLC_OBJECT( obj ) )
147 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
148 #define vlc_object_unlock( obj ) \
149 __vlc_object_unlock( VLC_OBJECT( obj ) )
151 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
152 #define vlc_object_wait( obj ) \
153 __vlc_object_wait( VLC_OBJECT( obj ) )
155 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
156 #define vlc_object_timedwait( obj, d ) \
157 __vlc_object_timedwait( VLC_OBJECT( obj ), d )
159 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
160 #define vlc_object_signal_unlocked( obj ) \
161 __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
163 static inline void __vlc_object_signal( vlc_object_t *obj )
165 vlc_object_lock( obj );
166 vlc_object_signal_unlocked( obj );
167 vlc_object_unlock( obj );
169 #define vlc_object_signal( obj ) \
170 __vlc_object_signal( VLC_OBJECT( obj ) )
172 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
173 #define vlc_object_kill(a) \
174 __vlc_object_kill( VLC_OBJECT(a) )
176 VLC_EXPORT( bool, __vlc_object_alive, ( vlc_object_t * ) );
177 #define vlc_object_alive(a) \
178 __vlc_object_alive( VLC_OBJECT(a) )
180 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
181 #define vlc_object_waitpipe(a) \
182 __vlc_object_waitpipe( VLC_OBJECT(a) )
184 /* NOTE: this function is a *temporary* convenience.
185 * See the vlc_object_alive() documentation for a better alternative.
188 bool __vlc_object_lock_and_wait( vlc_object_t *obj )
192 vlc_object_lock( obj );
193 b = vlc_object_alive( obj );
196 vlc_object_wait( obj );
197 b = vlc_object_alive( obj );
199 vlc_object_unlock( obj );
202 #define vlc_object_lock_and_wait( obj ) \
203 __vlc_object_lock_and_wait( VLC_OBJECT(obj) )