git.sesse.net Git - vlc/blob - include/vlc_objects.h

   1 /*****************************************************************************
   2  * vlc_objects.h: vlc_object_t definition and manipulation methods
   3  *****************************************************************************
   4  * Copyright (C) 2002-2006 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 #if !defined( __LIBVLC__ )
  25   #error You are not libvlc or one of its plugins. You cannot include this file
  26 #endif
  27
  28 /**
  29  * \file
  30  * This file defines the vlc_object_t structure and object types.
  31  */
  32
  33 /**
  34  * \defgroup vlc_object Objects
  35  * @{
  36  */
  37
  38 /* Object types */
  39 #define VLC_OBJECT_GLOBAL      (-1)
  40 #define VLC_OBJECT_LIBVLC      (-2)
  41 #define VLC_OBJECT_MODULE      (-3)
  42 #define VLC_OBJECT_INTF        (-4)
  43 #define VLC_OBJECT_PLAYLIST    (-5)
  44
  45 #define VLC_OBJECT_INPUT       (-7)
  46 #define VLC_OBJECT_DECODER     (-8)
  47 #define VLC_OBJECT_VOUT        (-9)
  48 #define VLC_OBJECT_AOUT        (-10)
  49 #define VLC_OBJECT_SOUT        (-11)
  50 #define VLC_OBJECT_HTTPD       (-12)
  51 #define VLC_OBJECT_PACKETIZER  (-13)
  52 #define VLC_OBJECT_ENCODER     (-14)
  53 #define VLC_OBJECT_DIALOGS     (-15)
  54 #define VLC_OBJECT_VLM         (-16)
  55 #define VLC_OBJECT_ANNOUNCE    (-17)
  56 #define VLC_OBJECT_DEMUX       (-18)
  57 #define VLC_OBJECT_ACCESS      (-19)
  58 #define VLC_OBJECT_STREAM      (-20)
  59 #define VLC_OBJECT_OPENGL      (-21)
  60 #define VLC_OBJECT_FILTER      (-22)
  61
  62
  63
  64 #define VLC_OBJECT_SD          (-26)
  65 #define VLC_OBJECT_XML         (-27)
  66 #define VLC_OBJECT_OSDMENU     (-28)
  67 #define VLC_OBJECT_STATS       (-29)
  68 #define VLC_OBJECT_HTTPD_HOST  (-30)
  69 #define VLC_OBJECT_META_ENGINE (-31)
  70 #define VLC_OBJECT_INTERACTION (-32)
  71
  72 #define VLC_OBJECT_GENERIC     (-666)
  73
  74 /* Object search mode */
  75 #define FIND_PARENT         0x0001
  76 #define FIND_CHILD          0x0002
  77 #define FIND_ANYWHERE       0x0003
  78
  79 #define FIND_STRICT         0x0010
  80
  81 /* Object flags */
  82 #define OBJECT_FLAGS_NODBG       0x0001
  83 #define OBJECT_FLAGS_QUIET       0x0002
  84 #define OBJECT_FLAGS_NOINTERACT  0x0004
  85
  86 /* Types */
  87 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
  88
  89 /* Constants */
  90 VLC_PUBLIC_API const vlc_destructor_t kVLCDestructor;
  91
  92 /*****************************************************************************
  93  * The vlc_object_t type. Yes, it's that simple :-)
  94  *****************************************************************************/
  95 /** The main vlc_object_t structure */
  96 struct vlc_object_t
  97 {
  98     VLC_COMMON_MEMBERS
  99 };
 100
 101 /*****************************************************************************
 102  * Prototypes
 103  *****************************************************************************/
 104 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 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
 107 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 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
 112 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 #define vlc_object_create(a,b) \
 119     __vlc_object_create( VLC_OBJECT(a), b )
 120
 121 #define vlc_object_set_destructor(a,b) \
 122     __vlc_object_set_destructor( VLC_OBJECT(a), b )
 123
 124 #define vlc_object_detach(a) \
 125     __vlc_object_detach( VLC_OBJECT(a) )
 126
 127 #define vlc_object_attach(a,b) \
 128     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
 129
 130 #define vlc_object_find(a,b,c) \
 131     __vlc_object_find( VLC_OBJECT(a),b,c)
 132
 133 #define vlc_object_find_name(a,b,c) \
 134     __vlc_object_find_name( VLC_OBJECT(a),b,c)
 135
 136 #define vlc_object_yield(a) \
 137     __vlc_object_yield( VLC_OBJECT(a) )
 138
 139 #define vlc_object_release(a) \
 140     __vlc_object_release( VLC_OBJECT(a) )
 141
 142 #define vlc_list_find(a,b,c) \
 143     __vlc_list_find( VLC_OBJECT(a),b,c)
 144
 145
 146 /* Objects and threading */
 147 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
 148 #define vlc_object_lock( obj ) \
 149     __vlc_object_lock( VLC_OBJECT( obj ) )
 150
 151 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
 152 #define vlc_object_unlock( obj ) \
 153     __vlc_object_unlock( VLC_OBJECT( obj ) )
 154
 155 VLC_EXPORT( vlc_bool_t, __vlc_object_wait, ( vlc_object_t * ) );
 156 #define vlc_object_wait( obj ) \
 157     __vlc_object_wait( VLC_OBJECT( obj ) )
 158
 159 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
 160 #define vlc_object_timedwait( obj, d ) \
 161     __vlc_object_timedwait( VLC_OBJECT( obj ), d )
 162
 163 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
 164 #define vlc_object_signal_unlocked( obj ) \
 165     __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
 166
 167 static inline void __vlc_object_signal( vlc_object_t *obj )
 168 {
 169     vlc_object_lock( obj );
 170     vlc_object_signal_unlocked( obj );
 171     vlc_object_unlock( obj );
 172 }
 173 #define vlc_object_signal( obj ) \
 174     __vlc_object_signal( VLC_OBJECT( obj ) )
 175
 176 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
 177 #define vlc_object_kill(a) \
 178     __vlc_object_kill( VLC_OBJECT(a) )
 179
 180 VLC_EXPORT( vlc_bool_t, __vlc_object_alive, ( vlc_object_t * ) );
 181 #define vlc_object_alive(a) \
 182     __vlc_object_alive( VLC_OBJECT(a) )
 183
 184 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
 185 #define vlc_object_waitpipe(a) \
 186     __vlc_object_waitpipe( VLC_OBJECT(a) )
 187
 188 /* NOTE: this function is a *temporary* convenience.
 189  * See the vlc_object_alive() documentation for a better alternative.
 190  */
 191 static inline
 192 vlc_bool_t __vlc_object_lock_and_wait( vlc_object_t *obj )
 193 {
 194     vlc_bool_t b = VLC_TRUE;
 195
 196     vlc_object_lock( obj );
 197     if( vlc_object_alive( obj ) )
 198         b = vlc_object_wait( obj );
 199     vlc_object_unlock( obj );
 200     return b;
 201 }
 202 #define vlc_object_lock_and_wait( obj ) \
 203     __vlc_object_lock_and_wait( VLC_OBJECT(obj) )
 204
 205