cb435161dc0082b8d9874a5172f691bb7e13c66c
[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_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 /* Please add new object types below -34 */
43 /* Please do not add new object types anyway */
44 #define VLC_OBJECT_GENERIC     (-666)
45
46 /* Object search mode */
47 #define FIND_PARENT         0x0001
48 #define FIND_CHILD          0x0002
49 #define FIND_ANYWHERE       0x0003
50
51 #define FIND_STRICT         0x0010
52
53 /* Object flags */
54 #define OBJECT_FLAGS_NODBG       0x0001
55 #define OBJECT_FLAGS_QUIET       0x0002
56 #define OBJECT_FLAGS_NOINTERACT  0x0004
57
58 /* Types */
59 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
60
61 /*****************************************************************************
62  * The vlc_object_t type. Yes, it's that simple :-)
63  *****************************************************************************/
64 /** The main vlc_object_t structure */
65 struct vlc_object_t
66 {
67     VLC_COMMON_MEMBERS
68 };
69
70 /*****************************************************************************
71  * Prototypes
72  *****************************************************************************/
73 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
74 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
75 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
76 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
77 #if defined (__GNUC__) && !defined __cplusplus
78 __attribute__((deprecated))
79 #endif
80 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
81 VLC_EXPORT( vlc_object_t *, vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
82 VLC_EXPORT( void *, __vlc_object_hold, ( vlc_object_t * ) );
83 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
84 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) );
85 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
86
87 /*}@*/
88
89 #define vlc_object_create(a,b) \
90     __vlc_object_create( VLC_OBJECT(a), b )
91
92 #define vlc_object_set_destructor(a,b) \
93     __vlc_object_set_destructor( VLC_OBJECT(a), b )
94
95 #define vlc_object_detach(a) \
96     __vlc_object_detach( VLC_OBJECT(a) )
97
98 #define vlc_object_attach(a,b) \
99     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
100
101 #define vlc_object_find(a,b,c) \
102     __vlc_object_find( VLC_OBJECT(a),b,c)
103
104 #define vlc_object_find_name(a,b,c) \
105     vlc_object_find_name( VLC_OBJECT(a),b,c)
106
107 #define vlc_object_hold(a) \
108     __vlc_object_hold( VLC_OBJECT(a) )
109
110 #define vlc_object_release(a) \
111     __vlc_object_release( VLC_OBJECT(a) )
112
113 #define vlc_list_children(a) \
114     __vlc_list_children( VLC_OBJECT(a) )
115
116 /* Objects and threading */
117 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
118 #define vlc_object_lock( obj ) \
119     __vlc_object_lock( VLC_OBJECT( obj ) )
120
121 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
122 #define vlc_object_unlock( obj ) \
123     __vlc_object_unlock( VLC_OBJECT( obj ) )
124
125 VLC_EXPORT( void, __vlc_object_assert_locked, ( vlc_object_t * ) );
126 #define vlc_object_assert_locked( obj ) \
127     __vlc_object_assert_locked( VLC_OBJECT( obj ) )
128
129 #if defined (__GNUC__) && !defined __cplusplus
130 __attribute__((deprecated))
131 #endif
132 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
133 #define vlc_object_wait( obj ) \
134     __vlc_object_wait( VLC_OBJECT( obj ) )
135
136 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
137 #define vlc_object_kill(a) \
138     __vlc_object_kill( VLC_OBJECT(a) )
139
140 static inline bool vlc_object_alive (const vlc_object_t *obj)
141 {
142     barrier ();
143     return !obj->b_die;
144 }
145
146 #define vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) )