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 /**
  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_LIBVLC      (-2)
  36 #define VLC_OBJECT_MODULE      (-3)
  37 #define VLC_OBJECT_INTF        (-4)
  38 #define VLC_OBJECT_PLAYLIST    (-5)
  39 #define VLC_OBJECT_INPUT       (-7)
  40 #define VLC_OBJECT_DECODER     (-8)
  41 #define VLC_OBJECT_VOUT        (-9)
  42 #define VLC_OBJECT_AOUT        (-10)
  43 #define VLC_OBJECT_PACKETIZER  (-13)
  44 #define VLC_OBJECT_ENCODER     (-14)
  45 #define VLC_OBJECT_ANNOUNCE    (-17)
  46 #define VLC_OBJECT_OPENGL      (-21)
  47 #define VLC_OBJECT_FILTER      (-22)
  48 #define VLC_OBJECT_OSDMENU     (-28)
  49 /* Please add new object types below -34 */
  50 /* Please do not add new object types anyway */
  51 #define VLC_OBJECT_GENERIC     (-666)
  52
  53 /* Object search mode */
  54 #define FIND_PARENT         0x0001
  55 #define FIND_CHILD          0x0002
  56 #define FIND_ANYWHERE       0x0003
  57
  58 #define FIND_STRICT         0x0010
  59
  60 /* Object flags */
  61 #define OBJECT_FLAGS_NODBG       0x0001
  62 #define OBJECT_FLAGS_QUIET       0x0002
  63 #define OBJECT_FLAGS_NOINTERACT  0x0004
  64
  65 /* Types */
  66 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
  67
  68 /*****************************************************************************
  69  * The vlc_object_t type. Yes, it's that simple :-)
  70  *****************************************************************************/
  71 /** The main vlc_object_t structure */
  72 struct vlc_object_t
  73 {
  74     VLC_COMMON_MEMBERS
  75 };
  76
  77 /*****************************************************************************
  78  * Prototypes
  79  *****************************************************************************/
  80 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
  81 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
  82 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
  83 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
  84 VLC_EXPORT( void *, vlc_object_get, ( int ) );
  85 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
  86 VLC_EXPORT( void *, __vlc_object_find_name, ( vlc_object_t *, const char *, int ) );
  87 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
  88 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
  89 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
  90 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) );
  91 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
  92
  93 /* __vlc_object_dump */
  94 VLC_EXPORT( void, __vlc_object_dump, ( vlc_object_t *p_this ) );
  95
  96 /*}@*/
  97
  98 #define vlc_object_create(a,b) \
  99     __vlc_object_create( VLC_OBJECT(a), b )
 100
 101 #define vlc_object_set_destructor(a,b) \
 102     __vlc_object_set_destructor( VLC_OBJECT(a), b )
 103
 104 #define vlc_object_detach(a) \
 105     __vlc_object_detach( VLC_OBJECT(a) )
 106
 107 #define vlc_object_attach(a,b) \
 108     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
 109
 110 #define vlc_object_find(a,b,c) \
 111     __vlc_object_find( VLC_OBJECT(a),b,c)
 112
 113 #define vlc_object_find_name(a,b,c) \
 114     __vlc_object_find_name( VLC_OBJECT(a),b,c)
 115
 116 #define vlc_object_yield(a) \
 117     __vlc_object_yield( VLC_OBJECT(a) )
 118
 119 #define vlc_object_release(a) \
 120     __vlc_object_release( VLC_OBJECT(a) )
 121
 122 #define vlc_list_find(a,b,c) \
 123     __vlc_list_find( VLC_OBJECT(a),b,c)
 124
 125 #define vlc_list_children(a) \
 126     __vlc_list_children( VLC_OBJECT(a) )
 127
 128 #define vlc_object_dump(a) \
 129     __vlc_object_dump( VLC_OBJECT(a))
 130
 131
 132 /* Objects and threading */
 133 VLC_EXPORT( void, __vlc_object_lock, ( vlc_object_t * ) );
 134 #define vlc_object_lock( obj ) \
 135     __vlc_object_lock( VLC_OBJECT( obj ) )
 136
 137 VLC_EXPORT( void, __vlc_object_unlock, ( vlc_object_t * ) );
 138 #define vlc_object_unlock( obj ) \
 139     __vlc_object_unlock( VLC_OBJECT( obj ) )
 140
 141 VLC_EXPORT( void, __vlc_object_wait, ( vlc_object_t * ) );
 142 #define vlc_object_wait( obj ) \
 143     __vlc_object_wait( VLC_OBJECT( obj ) )
 144
 145 VLC_EXPORT( int, __vlc_object_timedwait, ( vlc_object_t *, mtime_t ) );
 146 #define vlc_object_timedwait( obj, d ) \
 147     __vlc_object_timedwait( VLC_OBJECT( obj ), d )
 148
 149 VLC_EXPORT( void, __vlc_object_signal_unlocked, ( vlc_object_t * ) );
 150 #define vlc_object_signal_unlocked( obj ) \
 151     __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
 152
 153 static inline void __vlc_object_signal( vlc_object_t *obj )
 154 {
 155     vlc_object_lock( obj );
 156     vlc_object_signal_unlocked( obj );
 157     vlc_object_unlock( obj );
 158 }
 159 #define vlc_object_signal( obj ) \
 160     __vlc_object_signal( VLC_OBJECT( obj ) )
 161
 162 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
 163 #define vlc_object_kill(a) \
 164     __vlc_object_kill( VLC_OBJECT(a) )
 165
 166 VLC_EXPORT( bool, __vlc_object_alive, ( vlc_object_t * ) );
 167 #define vlc_object_alive(a) \
 168     __vlc_object_alive( VLC_OBJECT(a) )
 169
 170 VLC_EXPORT( int, __vlc_object_waitpipe, ( vlc_object_t *obj ));
 171 #define vlc_object_waitpipe(a) \
 172     __vlc_object_waitpipe( VLC_OBJECT(a) )
 173
 174 /* NOTE: this function is a *temporary* convenience.
 175  * See the vlc_object_alive() documentation for a better alternative.
 176  */
 177 static inline
 178 bool __vlc_object_lock_and_wait( vlc_object_t *obj )
 179 {
 180     bool b;
 181
 182     vlc_object_lock( obj );
 183     b = vlc_object_alive( obj );
 184     if( b )
 185     {
 186         vlc_object_wait( obj );
 187         b = vlc_object_alive( obj );
 188     }
 189     vlc_object_unlock( obj );
 190     return b;
 191 }
 192 #define vlc_object_lock_and_wait( obj ) \
 193     __vlc_object_lock_and_wait( VLC_OBJECT(obj) )
 194
 195