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_ANNOUNCE (-17)
46 #define VLC_OBJECT_OPENGL (-21)
47 #define VLC_OBJECT_OSDMENU (-28)
48 /* Please add new object types below -34 */
49 /* Please do not add new object types anyway */
50 #define VLC_OBJECT_GENERIC (-666)
52 /* Object search mode */
53 #define FIND_PARENT 0x0001
54 #define FIND_CHILD 0x0002
55 #define FIND_ANYWHERE 0x0003
57 #define FIND_STRICT 0x0010
60 #define OBJECT_FLAGS_NODBG 0x0001
61 #define OBJECT_FLAGS_QUIET 0x0002
62 #define OBJECT_FLAGS_NOINTERACT 0x0004
65 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
67 /*****************************************************************************
68 * The vlc_object_t type. Yes, it's that simple :-)
69 *****************************************************************************/
70 /** The main vlc_object_t structure */
76 /*****************************************************************************
78 *****************************************************************************/
79 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
80 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
81 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
82 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
83 #if defined (__GNUC__) && !defined __cplusplus
84 __attribute__((deprecated))
86 VLC_EXPORT( void *, vlc_object_get, ( int ) );
87 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
88 VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
89 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
90 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
91 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
92 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) );
93 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
95 /* __vlc_object_dump */
96 VLC_EXPORT( void, __vlc_object_dump, ( vlc_object_t *p_this ) );
100 #define vlc_object_create(a,b) \
101 __vlc_object_create( VLC_OBJECT(a), b )
103 #define vlc_object_set_destructor(a,b) \
104 __vlc_object_set_destructor( VLC_OBJECT(a), b )
106 #define vlc_object_detach(a) \
107 __vlc_object_detach( VLC_OBJECT(a) )
109 #define vlc_object_attach(a,b) \
110 __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
112 #define vlc_object_find(a,b,c) \
113 __vlc_object_find( VLC_OBJECT(a),b,c)
115 #define vlc_object_find_name(a,b,c) \
116 __vlc_object_find_name( VLC_OBJECT(a),b,c)
118 #define vlc_object_yield(a) \
119 __vlc_object_yield( VLC_OBJECT(a) )
121 #define vlc_object_release(a) \
122 __vlc_object_release( VLC_OBJECT(a) )
124 #define vlc_list_find(a,b,c) \
125 __vlc_list_find( VLC_OBJECT(a),b,c)
127 #define vlc_list_children(a) \
128 __vlc_list_children( VLC_OBJECT(a) )
130 #define vlc_object_dump(a) \
131 __vlc_object_dump( VLC_OBJECT(a))
134 /* Objects and threading */
135 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
136 #define vlc_object_lock( obj ) \
137 __vlc_object_lock( VLC_OBJECT( obj ) )
139 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
140 #define vlc_object_unlock( obj ) \
141 __vlc_object_unlock( VLC_OBJECT( obj ) )
143 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
144 #define vlc_object_wait( obj ) \
145 __vlc_object_wait( VLC_OBJECT( obj ) )
147 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
148 #define vlc_object_timedwait( obj, d ) \
149 __vlc_object_timedwait( VLC_OBJECT( obj ), d )
151 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
152 #define vlc_object_signal_unlocked( obj ) \
153 __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
155 static inline void __vlc_object_signal( vlc_object_t *obj )
157 vlc_object_lock( obj );
158 vlc_object_signal_unlocked( obj );
159 vlc_object_unlock( obj );
161 #define vlc_object_signal( obj ) \
162 __vlc_object_signal( VLC_OBJECT( obj ) )
164 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
165 #define vlc_object_kill(a) \
166 __vlc_object_kill( VLC_OBJECT(a) )
168 static inline bool __vlc_object_alive (const vlc_object_t *obj)
174 #define vlc_object_alive(a) \
175 __vlc_object_alive( VLC_OBJECT(a) )
177 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
178 #define vlc_object_waitpipe(a) \
179 __vlc_object_waitpipe( VLC_OBJECT(a) )
181 /* NOTE: this function is a *temporary* convenience.
182 * See the vlc_object_alive() documentation for a better alternative.
185 bool __vlc_object_lock_and_wait( vlc_object_t *obj )
189 vlc_object_lock( obj );
190 b = vlc_object_alive( obj );
193 vlc_object_wait( obj );
194 b = vlc_object_alive( obj );
196 vlc_object_unlock( obj );
199 #define vlc_object_lock_and_wait( obj ) \
200 __vlc_object_lock_and_wait( VLC_OBJECT(obj) )