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