vlc_objects.h 6.55 KB
Newer Older
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 8 9 10 11 12
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
13
 *
14 15 16 17 18 19 20
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25 26 27
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

Clément Stenac's avatar
Clément Stenac committed
28 29
/**
 * \file
30
 * This file defines the vlc_object_t structure and object types.
Clément Stenac's avatar
Clément Stenac committed
31 32
 */

33
/**
Clément Stenac's avatar
Clément Stenac committed
34 35 36 37
 * \defgroup vlc_object Objects
 * @{
 */

38
/* Object types */
39
#define VLC_OBJECT_GLOBAL      (-1)
40 41 42 43
#define VLC_OBJECT_LIBVLC      (-2)
#define VLC_OBJECT_MODULE      (-3)
#define VLC_OBJECT_INTF        (-4)
#define VLC_OBJECT_PLAYLIST    (-5)
44

45 46 47 48 49
#define VLC_OBJECT_INPUT       (-7)
#define VLC_OBJECT_DECODER     (-8)
#define VLC_OBJECT_VOUT        (-9)
#define VLC_OBJECT_AOUT        (-10)
#define VLC_OBJECT_SOUT        (-11)
50

51 52 53 54 55 56 57 58 59 60
#define VLC_OBJECT_PACKETIZER  (-13)
#define VLC_OBJECT_ENCODER     (-14)
#define VLC_OBJECT_DIALOGS     (-15)
#define VLC_OBJECT_VLM         (-16)
#define VLC_OBJECT_ANNOUNCE    (-17)
#define VLC_OBJECT_DEMUX       (-18)
#define VLC_OBJECT_ACCESS      (-19)
#define VLC_OBJECT_STREAM      (-20)
#define VLC_OBJECT_OPENGL      (-21)
#define VLC_OBJECT_FILTER      (-22)
61

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
62

63

64

65

66
#define VLC_OBJECT_OSDMENU     (-28)
67

68
#define VLC_OBJECT_HTTPD_HOST  (-30)
69

70
#define VLC_OBJECT_INTERACTION (-32)
71

72
#define VLC_OBJECT_GENERIC     (-666)
73 74 75 76 77 78 79 80

/* Object search mode */
#define FIND_PARENT         0x0001
#define FIND_CHILD          0x0002
#define FIND_ANYWHERE       0x0003

#define FIND_STRICT         0x0010

81 82 83 84 85
/* Object flags */
#define OBJECT_FLAGS_NODBG       0x0001
#define OBJECT_FLAGS_QUIET       0x0002
#define OBJECT_FLAGS_NOINTERACT  0x0004

86 87 88
/* Types */
typedef void (*vlc_destructor_t)(struct vlc_object_t *);

89 90 91
/* Constants */
VLC_PUBLIC_API const vlc_destructor_t kVLCDestructor;

Sam Hocevar's avatar
Sam Hocevar committed
92 93 94
/*****************************************************************************
 * The vlc_object_t type. Yes, it's that simple :-)
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
95
/** The main vlc_object_t structure */
Sam Hocevar's avatar
Sam Hocevar committed
96 97 98 99 100
struct vlc_object_t
{
    VLC_COMMON_MEMBERS
};

101 102 103 104
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
105
VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
106 107
VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
108
VLC_EXPORT( void *, vlc_object_get, ( int ) );
109
VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
110
VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
111 112
VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
113
VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
114
VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
115

116 117 118
/* __vlc_object_dump */
VLC_EXPORT( void, __vlc_object_dump, ( vlc_object_t *p_this ) );

Clément Stenac's avatar
Clément Stenac committed
119 120
/*}@*/

121
#define vlc_object_create(a,b) \
122
    __vlc_object_create( VLC_OBJECT(a), b )
123

124 125 126
#define vlc_object_set_destructor(a,b) \
    __vlc_object_set_destructor( VLC_OBJECT(a), b )

127 128 129 130 131 132
#define vlc_object_detach(a) \
    __vlc_object_detach( VLC_OBJECT(a) )

#define vlc_object_attach(a,b) \
    __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )

133
#define vlc_object_find(a,b,c) \
134
    __vlc_object_find( VLC_OBJECT(a),b,c)
135

136 137 138
#define vlc_object_find_name(a,b,c) \
    __vlc_object_find_name( VLC_OBJECT(a),b,c)

139
#define vlc_object_yield(a) \
140
    __vlc_object_yield( VLC_OBJECT(a) )
141 142

#define vlc_object_release(a) \
143
    __vlc_object_release( VLC_OBJECT(a) )
144

145 146
#define vlc_list_find(a,b,c) \
    __vlc_list_find( VLC_OBJECT(a),b,c)
147

148 149 150
#define vlc_object_dump(a) \
    __vlc_object_dump( VLC_OBJECT(a))

151 152 153 154 155 156 157 158 159 160

/* Objects and threading */
VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
#define vlc_object_lock( obj ) \
    __vlc_object_lock( VLC_OBJECT( obj ) )

VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
#define vlc_object_unlock( obj ) \
    __vlc_object_unlock( VLC_OBJECT( obj ) )

161
VLC_EXPORT( bool, __vlc_object_wait, ( vlc_object_t * ) );
162 163 164 165 166 167 168 169 170 171 172
#define vlc_object_wait( obj ) \
    __vlc_object_wait( VLC_OBJECT( obj ) )

VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
#define vlc_object_timedwait( obj, d ) \
    __vlc_object_timedwait( VLC_OBJECT( obj ), d )

VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
#define vlc_object_signal_unlocked( obj ) \
    __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )

173 174
static inline void __vlc_object_signal( vlc_object_t *obj )
{
Christophe Mutricy's avatar
Christophe Mutricy committed
175
    vlc_object_lock( obj );
176 177 178
    vlc_object_signal_unlocked( obj );
    vlc_object_unlock( obj );
}
179 180 181 182 183 184
#define vlc_object_signal( obj ) \
    __vlc_object_signal( VLC_OBJECT( obj ) )

VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
#define vlc_object_kill(a) \
    __vlc_object_kill( VLC_OBJECT(a) )
185

186
VLC_EXPORT( bool, __vlc_object_alive, ( vlc_object_t * ) );
187 188 189
#define vlc_object_alive(a) \
    __vlc_object_alive( VLC_OBJECT(a) )

190 191 192
VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
#define vlc_object_waitpipe(a) \
    __vlc_object_waitpipe( VLC_OBJECT(a) )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
193 194 195 196 197

/* NOTE: this function is a *temporary* convenience.
 * See the vlc_object_alive() documentation for a better alternative.
 */
static inline
198
bool __vlc_object_lock_and_wait( vlc_object_t *obj )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
199
{
200
    bool b = true;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
201 202 203 204 205 206 207 208 209 210 211

    vlc_object_lock( obj );
    if( vlc_object_alive( obj ) )
        b = vlc_object_wait( obj );
    vlc_object_unlock( obj );
    return b;
}
#define vlc_object_lock_and_wait( obj ) \
    __vlc_object_lock_and_wait( VLC_OBJECT(obj) )