Remove VLC_OBJECT_ANNOUNCE
[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_OPENGL      (-21)
46 #define VLC_OBJECT_OSDMENU     (-28)
47 /* Please add new object types below -34 */
48 /* Please do not add new object types anyway */
49 #define VLC_OBJECT_GENERIC     (-666)
50
51 /* Object search mode */
52 #define FIND_PARENT         0x0001
53 #define FIND_CHILD          0x0002
54 #define FIND_ANYWHERE       0x0003
55
56 #define FIND_STRICT         0x0010
57
58 /* Object flags */
59 #define OBJECT_FLAGS_NODBG       0x0001
60 #define OBJECT_FLAGS_QUIET       0x0002
61 #define OBJECT_FLAGS_NOINTERACT  0x0004
62
63 /* Types */
64 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
65
66 /*****************************************************************************
67  * The vlc_object_t type. Yes, it's that simple :-)
68  *****************************************************************************/
69 /** The main vlc_object_t structure */
70 struct vlc_object_t
71 {
72     VLC_COMMON_MEMBERS
73 };
74
75 /*****************************************************************************
76  * Prototypes
77  *****************************************************************************/
78 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
79 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
80 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
81 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
82 #if defined (__GNUC__) && !defined __cplusplus
83 __attribute__((deprecated))
84 #endif
85 VLC_EXPORT( void *, vlc_object_get, ( libvlc_int_t *, int ) );
86 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
87 VLC_EXPORT( vlc_object_t *, 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 * ) );
93
94 /*}@*/
95
96 #define vlc_object_create(a,b) \
97     __vlc_object_create( VLC_OBJECT(a), b )
98
99 #define vlc_object_set_destructor(a,b) \
100     __vlc_object_set_destructor( VLC_OBJECT(a), b )
101
102 #define vlc_object_detach(a) \
103     __vlc_object_detach( VLC_OBJECT(a) )
104
105 #define vlc_object_attach(a,b) \
106     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
107
108 #define vlc_object_find(a,b,c) \
109     __vlc_object_find( VLC_OBJECT(a),b,c)
110
111 #define vlc_object_find_name(a,b,c) \
112     vlc_object_find_name( VLC_OBJECT(a),b,c)
113
114 #define vlc_object_yield(a) \
115     __vlc_object_yield( VLC_OBJECT(a) )
116
117 #define vlc_object_release(a) \
118     __vlc_object_release( VLC_OBJECT(a) )
119
120 #define vlc_list_find(a,b,c) \
121     __vlc_list_find( VLC_OBJECT(a),b,c)
122
123 #define vlc_list_children(a) \
124     __vlc_list_children( VLC_OBJECT(a) )
125
126 /* Objects and threading */
127 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
128 #define vlc_object_lock( obj ) \
129     __vlc_object_lock( VLC_OBJECT( obj ) )
130
131 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
132 #define vlc_object_unlock( obj ) \
133     __vlc_object_unlock( VLC_OBJECT( obj ) )
134
135 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
136 #define vlc_object_wait( obj ) \
137     __vlc_object_wait( VLC_OBJECT( obj ) )
138
139 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
140 #define vlc_object_signal_unlocked( obj ) \
141     __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
142
143 static inline void __vlc_object_signal( vlc_object_t *obj )
144 {
145     vlc_object_lock( obj );
146     vlc_object_signal_unlocked( obj );
147     vlc_object_unlock( obj );
148 }
149 #define vlc_object_signal( obj ) \
150     __vlc_object_signal( VLC_OBJECT( obj ) )
151
152 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
153 #define vlc_object_kill(a) \
154     __vlc_object_kill( VLC_OBJECT(a) )
155
156 static inline bool __vlc_object_alive (const vlc_object_t *obj)
157 {
158     barrier ();
159     return !obj->b_die;
160 }
161
162 #define vlc_object_alive(a) \
163     __vlc_object_alive( VLC_OBJECT(a) )
164
165 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
166 #define vlc_object_waitpipe(a) \
167     __vlc_object_waitpipe( VLC_OBJECT(a) )