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