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