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 *****************************************************************************/
26 * This file defines the vlc_object_t structure and object types.
30 * \defgroup vlc_object Objects
35 #define VLC_OBJECT_LIBVLC (-2)
36 #define VLC_OBJECT_MODULE (-3)
37 #define VLC_OBJECT_INTF (-4)
38 #define VLC_OBJECT_PLAYLIST (-5)
39 #define VLC_OBJECT_INPUT (-7)
40 #define VLC_OBJECT_DECODER (-8)
41 #define VLC_OBJECT_VOUT (-9)
42 #define VLC_OBJECT_AOUT (-10)
43 #define VLC_OBJECT_PACKETIZER (-13)
44 #define VLC_OBJECT_ENCODER (-14)
45 #define VLC_OBJECT_DIALOGS (-15)
46 #define VLC_OBJECT_ANNOUNCE (-17)
47 #define VLC_OBJECT_OPENGL (-21)
48 #define VLC_OBJECT_FILTER (-22)
49 #define VLC_OBJECT_OSDMENU (-28)
50 /* Please add new object types below -34 */
51 /* Please do not add new object types anyway */
52 #define VLC_OBJECT_GENERIC (-666)
54 /* Object search mode */
55 #define FIND_PARENT 0x0001
56 #define FIND_CHILD 0x0002
57 #define FIND_ANYWHERE 0x0003
59 #define FIND_STRICT 0x0010
62 #define OBJECT_FLAGS_NODBG 0x0001
63 #define OBJECT_FLAGS_QUIET 0x0002
64 #define OBJECT_FLAGS_NOINTERACT 0x0004
67 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
69 /*****************************************************************************
70 * The vlc_object_t type. Yes, it's that simple :-)
71 *****************************************************************************/
72 /** The main vlc_object_t structure */
78 /*****************************************************************************
80 *****************************************************************************/
81 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
82 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
83 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
84 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
85 VLC_EXPORT( void *, vlc_object_get, ( int ) );
86 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
87 VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
88 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
89 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
90 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
91 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) );
92 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
94 /* __vlc_object_dump */
95 VLC_EXPORT( void, __vlc_object_dump, ( vlc_object_t *p_this ) );
99 #define vlc_object_create(a,b) \
100 __vlc_object_create( VLC_OBJECT(a), b )
102 #define vlc_object_set_destructor(a,b) \
103 __vlc_object_set_destructor( VLC_OBJECT(a), b )
105 #define vlc_object_detach(a) \
106 __vlc_object_detach( VLC_OBJECT(a) )
108 #define vlc_object_attach(a,b) \
109 __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
111 #define vlc_object_find(a,b,c) \
112 __vlc_object_find( VLC_OBJECT(a),b,c)
114 #define vlc_object_find_name(a,b,c) \
115 __vlc_object_find_name( VLC_OBJECT(a),b,c)
117 #define vlc_object_yield(a) \
118 __vlc_object_yield( VLC_OBJECT(a) )
120 #define vlc_object_release(a) \
121 __vlc_object_release( VLC_OBJECT(a) )
123 #define vlc_list_find(a,b,c) \
124 __vlc_list_find( VLC_OBJECT(a),b,c)
126 #define vlc_list_children(a) \
127 __vlc_list_children( VLC_OBJECT(a) )
129 #define vlc_object_dump(a) \
130 __vlc_object_dump( VLC_OBJECT(a))
133 /* Objects and threading */
134 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
135 #define vlc_object_lock( obj ) \
136 __vlc_object_lock( VLC_OBJECT( obj ) )
138 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
139 #define vlc_object_unlock( obj ) \
140 __vlc_object_unlock( VLC_OBJECT( obj ) )
142 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
143 #define vlc_object_wait( obj ) \
144 __vlc_object_wait( VLC_OBJECT( obj ) )
146 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
147 #define vlc_object_timedwait( obj, d ) \
148 __vlc_object_timedwait( VLC_OBJECT( obj ), d )
150 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
151 #define vlc_object_signal_unlocked( obj ) \
152 __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
154 static inline void __vlc_object_signal( vlc_object_t *obj )
156 vlc_object_lock( obj );
157 vlc_object_signal_unlocked( obj );
158 vlc_object_unlock( obj );
160 #define vlc_object_signal( obj ) \
161 __vlc_object_signal( VLC_OBJECT( obj ) )
163 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
164 #define vlc_object_kill(a) \
165 __vlc_object_kill( VLC_OBJECT(a) )
167 VLC_EXPORT( bool, __vlc_object_alive, ( vlc_object_t * ) );
168 #define vlc_object_alive(a) \
169 __vlc_object_alive( VLC_OBJECT(a) )
171 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
172 #define vlc_object_waitpipe(a) \
173 __vlc_object_waitpipe( VLC_OBJECT(a) )
175 /* NOTE: this function is a *temporary* convenience.
176 * See the vlc_object_alive() documentation for a better alternative.
179 bool __vlc_object_lock_and_wait( vlc_object_t *obj )
183 vlc_object_lock( obj );
184 b = vlc_object_alive( obj );
187 vlc_object_wait( obj );
188 b = vlc_object_alive( obj );
190 vlc_object_unlock( obj );
193 #define vlc_object_lock_and_wait( obj ) \
194 __vlc_object_lock_and_wait( VLC_OBJECT(obj) )