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_INTF (-4)
36 #define VLC_OBJECT_INPUT (-7)
37 #define VLC_OBJECT_DECODER (-8)
38 #define VLC_OBJECT_VOUT (-9)
39 #define VLC_OBJECT_AOUT (-10)
40 #define VLC_OBJECT_PACKETIZER (-13)
41 #define VLC_OBJECT_ENCODER (-14)
42 #define VLC_OBJECT_OSDMENU (-28)
43 /* Please add new object types below -34 */
44 /* Please do not add new object types anyway */
45 #define VLC_OBJECT_GENERIC (-666)
47 /* Object search mode */
48 #define FIND_PARENT 0x0001
49 #define FIND_CHILD 0x0002
50 #define FIND_ANYWHERE 0x0003
52 #define FIND_STRICT 0x0010
55 #define OBJECT_FLAGS_NODBG 0x0001
56 #define OBJECT_FLAGS_QUIET 0x0002
57 #define OBJECT_FLAGS_NOINTERACT 0x0004
60 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
62 /*****************************************************************************
63 * The vlc_object_t type. Yes, it's that simple :-)
64 *****************************************************************************/
65 /** The main vlc_object_t structure */
71 /*****************************************************************************
73 *****************************************************************************/
74 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
75 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
76 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
77 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
78 #if defined (__GNUC__) && !defined __cplusplus
79 __attribute__((deprecated))
81 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
82 VLC_EXPORT( vlc_object_t *, vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
83 VLC_EXPORT( void *, __vlc_object_hold, ( vlc_object_t * ) );
84 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
85 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
86 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) );
87 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
91 #define vlc_object_create(a,b) \
92 __vlc_object_create( VLC_OBJECT(a), b )
94 #define vlc_object_set_destructor(a,b) \
95 __vlc_object_set_destructor( VLC_OBJECT(a), b )
97 #define vlc_object_detach(a) \
98 __vlc_object_detach( VLC_OBJECT(a) )
100 #define vlc_object_attach(a,b) \
101 __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
103 #define vlc_object_find(a,b,c) \
104 __vlc_object_find( VLC_OBJECT(a),b,c)
106 #define vlc_object_find_name(a,b,c) \
107 vlc_object_find_name( VLC_OBJECT(a),b,c)
109 #define vlc_object_hold(a) \
110 __vlc_object_hold( VLC_OBJECT(a) )
112 #define vlc_object_release(a) \
113 __vlc_object_release( VLC_OBJECT(a) )
115 #define vlc_list_find(a,b,c) \
116 __vlc_list_find( VLC_OBJECT(a),b,c)
118 #define vlc_list_children(a) \
119 __vlc_list_children( VLC_OBJECT(a) )
121 /* Objects and threading */
122 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
123 #define vlc_object_lock( obj ) \
124 __vlc_object_lock( VLC_OBJECT( obj ) )
126 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
127 #define vlc_object_unlock( obj ) \
128 __vlc_object_unlock( VLC_OBJECT( obj ) )
130 VLC_EXPORT( void, __vlc_object_assert_locked, ( vlc_object_t * ) );
131 #define vlc_object_assert_locked( obj ) \
132 __vlc_object_assert_locked( VLC_OBJECT( obj ) )
134 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
135 #define vlc_object_wait( obj ) \
136 __vlc_object_wait( VLC_OBJECT( obj ) )
138 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
139 #define vlc_object_signal_unlocked( obj ) \
140 __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
142 static inline void __vlc_object_signal( vlc_object_t *obj )
144 vlc_object_lock( obj );
145 vlc_object_signal_unlocked( obj );
146 vlc_object_unlock( obj );
148 #define vlc_object_signal( obj ) \
149 __vlc_object_signal( VLC_OBJECT( obj ) )
151 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
152 #define vlc_object_kill(a) \
153 __vlc_object_kill( VLC_OBJECT(a) )
155 static inline bool __vlc_object_alive (const vlc_object_t *obj)
161 #define vlc_object_alive(a) \
162 __vlc_object_alive( VLC_OBJECT(a) )