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-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 #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
  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
  51 #define VLC_OBJECT_PACKETIZER  (-13)
  52 #define VLC_OBJECT_ENCODER     (-14)
  53 #define VLC_OBJECT_DIALOGS     (-15)
  54
  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
  65
  66 #define VLC_OBJECT_OSDMENU     (-28)
  67
  68 #define VLC_OBJECT_HTTPD_HOST  (-30)
  69
  70 #define VLC_OBJECT_INTERACTION (-32)
  71 #define VLC_OBJECT_CHROMA      (-33)
  72
  73 #define VLC_OBJECT_GENERIC     (-666)
  74
  75 /* Object search mode */
  76 #define FIND_PARENT         0x0001
  77 #define FIND_CHILD          0x0002
  78 #define FIND_ANYWHERE       0x0003
  79
  80 #define FIND_STRICT         0x0010
  81
  82 /* Object flags */
  83 #define OBJECT_FLAGS_NODBG       0x0001
  84 #define OBJECT_FLAGS_QUIET       0x0002
  85 #define OBJECT_FLAGS_NOINTERACT  0x0004
  86
  87 /* Types */
  88 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
  89
  90 /*****************************************************************************
  91  * The vlc_object_t type. Yes, it's that simple :-)
  92  *****************************************************************************/
  93 /** The main vlc_object_t structure */
  94 struct vlc_object_t
  95 {
  96     VLC_COMMON_MEMBERS
  97 };
  98
  99 /*****************************************************************************
 100  * Prototypes
 101  *****************************************************************************/
 102 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
 103 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
 104 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
 105 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
 106 VLC_EXPORT( void *, vlc_object_get, ( int ) );
 107 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
 108 VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
 109 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
 110 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
 111 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
 112 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) );
 113 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
 114
 115 /* __vlc_object_dump */
 116 VLC_EXPORT( void, __vlc_object_dump, ( vlc_object_t *p_this ) );
 117
 118 /*}@*/
 119
 120 #define vlc_object_create(a,b) \
 121     __vlc_object_create( VLC_OBJECT(a), b )
 122
 123 #define vlc_object_set_destructor(a,b) \
 124     __vlc_object_set_destructor( VLC_OBJECT(a), b )
 125
 126 #define vlc_object_detach(a) \
 127     __vlc_object_detach( VLC_OBJECT(a) )
 128
 129 #define vlc_object_attach(a,b) \
 130     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
 131
 132 #define vlc_object_find(a,b,c) \
 133     __vlc_object_find( VLC_OBJECT(a),b,c)
 134
 135 #define vlc_object_find_name(a,b,c) \
 136     __vlc_object_find_name( VLC_OBJECT(a),b,c)
 137
 138 #define vlc_object_yield(a) \
 139     __vlc_object_yield( VLC_OBJECT(a) )
 140
 141 #define vlc_object_release(a) \
 142     __vlc_object_release( VLC_OBJECT(a) )
 143
 144 #define vlc_list_find(a,b,c) \
 145     __vlc_list_find( VLC_OBJECT(a),b,c)
 146
 147 #define vlc_list_children(a) \
 148     __vlc_list_children( VLC_OBJECT(a) )
 149
 150 #define vlc_object_dump(a) \
 151     __vlc_object_dump( VLC_OBJECT(a))
 152
 153
 154 /* Objects and threading */
 155 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
 156 #define vlc_object_lock( obj ) \
 157     __vlc_object_lock( VLC_OBJECT( obj ) )
 158
 159 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
 160 #define vlc_object_unlock( obj ) \
 161     __vlc_object_unlock( VLC_OBJECT( obj ) )
 162
 163 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
 164 #define vlc_object_wait( obj ) \
 165     __vlc_object_wait( VLC_OBJECT( obj ) )
 166
 167 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
 168 #define vlc_object_timedwait( obj, d ) \
 169     __vlc_object_timedwait( VLC_OBJECT( obj ), d )
 170
 171 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
 172 #define vlc_object_signal_unlocked( obj ) \
 173     __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
 174
 175 static inline void __vlc_object_signal( vlc_object_t *obj )
 176 {
 177     vlc_object_lock( obj );
 178     vlc_object_signal_unlocked( obj );
 179     vlc_object_unlock( obj );
 180 }
 181 #define vlc_object_signal( obj ) \
 182     __vlc_object_signal( VLC_OBJECT( obj ) )
 183
 184 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
 185 #define vlc_object_kill(a) \
 186     __vlc_object_kill( VLC_OBJECT(a) )
 187
 188 VLC_EXPORT( bool, __vlc_object_alive, ( vlc_object_t * ) );
 189 #define vlc_object_alive(a) \
 190     __vlc_object_alive( VLC_OBJECT(a) )
 191
 192 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
 193 #define vlc_object_waitpipe(a) \
 194     __vlc_object_waitpipe( VLC_OBJECT(a) )
 195
 196 /* NOTE: this function is a *temporary* convenience.
 197  * See the vlc_object_alive() documentation for a better alternative.
 198  */
 199 static inline
 200 bool __vlc_object_lock_and_wait( vlc_object_t *obj )
 201 {
 202     bool b;
 203
 204     vlc_object_lock( obj );
 205     b = vlc_object_alive( obj );
 206     if( b )
 207     {
 208         vlc_object_wait( obj );
 209         b = vlc_object_alive( obj );
 210     }
 211     vlc_object_unlock( obj );
 212     return b;
 213 }
 214 #define vlc_object_lock_and_wait( obj ) \
 215     __vlc_object_lock_and_wait( VLC_OBJECT(obj) )
 216
 217