vlc_object_find_name: return vlc_object_t *
[vlc.git] / include / vlc_objects.h
1 /*****************************************************************************
2  * vlc_objects.h: vlc_object_t definition and manipulation methods
3  *****************************************************************************
4  * Copyright (C) 2002-2008 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /**
25  * \file
26  * This file defines the vlc_object_t structure and object types.
27  */
28
29 /**
30  * \defgroup vlc_object Objects
31  * @{
32  */
33
34 /* Object types */
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)
51
52 /* Object search mode */
53 #define FIND_PARENT         0x0001
54 #define FIND_CHILD          0x0002
55 #define FIND_ANYWHERE       0x0003
56
57 #define FIND_STRICT         0x0010
58
59 /* Object flags */
60 #define OBJECT_FLAGS_NODBG       0x0001
61 #define OBJECT_FLAGS_QUIET       0x0002
62 #define OBJECT_FLAGS_NOINTERACT  0x0004
63
64 /* Types */
65 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
66
67 /*****************************************************************************
68  * The vlc_object_t type. Yes, it's that simple :-)
69  *****************************************************************************/
70 /** The main vlc_object_t structure */
71 struct vlc_object_t
72 {
73     VLC_COMMON_MEMBERS
74 };
75
76 /*****************************************************************************
77  * Prototypes
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))
85 #endif
86 VLC_EXPORT( void *, vlc_object_get, ( libvlc_int_t *, int ) );
87 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
88 VLC_EXPORT( vlc_object_t *, 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 * ) );
94
95 /*}@*/
96
97 #define vlc_object_create(a,b) \
98     __vlc_object_create( VLC_OBJECT(a), b )
99
100 #define vlc_object_set_destructor(a,b) \
101     __vlc_object_set_destructor( VLC_OBJECT(a), b )
102
103 #define vlc_object_detach(a) \
104     __vlc_object_detach( VLC_OBJECT(a) )
105
106 #define vlc_object_attach(a,b) \
107     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
108
109 #define vlc_object_find(a,b,c) \
110     __vlc_object_find( VLC_OBJECT(a),b,c)
111
112 #define vlc_object_find_name(a,b,c) \
113     vlc_object_find_name( VLC_OBJECT(a),b,c)
114
115 #define vlc_object_yield(a) \
116     __vlc_object_yield( VLC_OBJECT(a) )
117
118 #define vlc_object_release(a) \
119     __vlc_object_release( VLC_OBJECT(a) )
120
121 #define vlc_list_find(a,b,c) \
122     __vlc_list_find( VLC_OBJECT(a),b,c)
123
124 #define vlc_list_children(a) \
125     __vlc_list_children( VLC_OBJECT(a) )
126
127 /* Objects and threading */
128 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
129 #define vlc_object_lock( obj ) \
130     __vlc_object_lock( VLC_OBJECT( obj ) )
131
132 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
133 #define vlc_object_unlock( obj ) \
134     __vlc_object_unlock( VLC_OBJECT( obj ) )
135
136 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
137 #define vlc_object_wait( obj ) \
138     __vlc_object_wait( VLC_OBJECT( obj ) )
139
140 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
141 #define vlc_object_timedwait( obj, d ) \
142     __vlc_object_timedwait( VLC_OBJECT( obj ), d )
143
144 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
145 #define vlc_object_signal_unlocked( obj ) \
146     __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
147
148 static inline void __vlc_object_signal( vlc_object_t *obj )
149 {
150     vlc_object_lock( obj );
151     vlc_object_signal_unlocked( obj );
152     vlc_object_unlock( obj );
153 }
154 #define vlc_object_signal( obj ) \
155     __vlc_object_signal( VLC_OBJECT( obj ) )
156
157 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
158 #define vlc_object_kill(a) \
159     __vlc_object_kill( VLC_OBJECT(a) )
160
161 static inline bool __vlc_object_alive (const vlc_object_t *obj)
162 {
163     barrier ();
164     return !obj->b_die;
165 }
166
167 #define vlc_object_alive(a) \
168     __vlc_object_alive( VLC_OBJECT(a) )
169
170 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
171 #define vlc_object_waitpipe(a) \
172     __vlc_object_waitpipe( VLC_OBJECT(a) )