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_INPUT       (-7)
  36 #define VLC_OBJECT_DECODER     (-8)
  37 #define VLC_OBJECT_VOUT        (-9)
  38 #define VLC_OBJECT_AOUT        (-10)
  39 /* Please add new object types below -34 */
  40 /* Please do not add new object types anyway */
  41 #define VLC_OBJECT_GENERIC     (-666)
  42
  43 /* Object search mode */
  44 #define FIND_PARENT         0x0001
  45 #define FIND_CHILD          0x0002
  46 #define FIND_ANYWHERE       0x0003
  47
  48 /* Object flags */
  49 #define OBJECT_FLAGS_NODBG       0x0001
  50 #define OBJECT_FLAGS_QUIET       0x0002
  51 #define OBJECT_FLAGS_NOINTERACT  0x0004
  52
  53 /* Types */
  54 typedef void (*vlc_destructor_t)(struct vlc_object_t *);
  55
  56 /*****************************************************************************
  57  * The vlc_object_t type. Yes, it's that simple :-)
  58  *****************************************************************************/
  59 /** The main vlc_object_t structure */
  60 struct vlc_object_t
  61 {
  62     VLC_COMMON_MEMBERS
  63 };
  64
  65 /*****************************************************************************
  66  * Prototypes
  67  *****************************************************************************/
  68 VLC_EXPORT( void *, vlc_object_create, ( vlc_object_t *, size_t ) ) LIBVLC_MALLOC LIBVLC_USED;
  69 VLC_EXPORT( void, __vlc_object_set_destructor, ( vlc_object_t *, vlc_destructor_t ) );
  70 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
  71 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
  72 #if defined (__GNUC__) && !defined __cplusplus
  73 __attribute__((deprecated))
  74 #endif
  75 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) ) LIBVLC_USED;
  76 #if defined (__GNUC__) && !defined __cplusplus
  77 __attribute__((deprecated))
  78 #endif
  79 VLC_EXPORT( vlc_object_t *, vlc_object_find_name, ( vlc_object_t *, const char *, int ) ) LIBVLC_USED;
  80 VLC_EXPORT( void *, __vlc_object_hold, ( vlc_object_t * ) );
  81 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
  82 VLC_EXPORT( vlc_list_t *, __vlc_list_children, ( vlc_object_t * ) ) LIBVLC_USED;
  83 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
  84 VLC_EXPORT( char *, vlc_object_get_name, ( const vlc_object_t * ) ) LIBVLC_USED;
  85 #define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
  86
  87 /**}@*/
  88
  89 #define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
  90
  91 #define vlc_object_set_destructor(a,b) \
  92     __vlc_object_set_destructor( VLC_OBJECT(a), b )
  93
  94 #define vlc_object_detach(a) \
  95     __vlc_object_detach( VLC_OBJECT(a) )
  96
  97 #define vlc_object_attach(a,b) \
  98     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
  99
 100 #define vlc_object_find(a,b,c) \
 101     __vlc_object_find( VLC_OBJECT(a),b,c)
 102
 103 #define vlc_object_find_name(a,b,c) \
 104     vlc_object_find_name( VLC_OBJECT(a),b,c)
 105
 106 #define vlc_object_hold(a) \
 107     __vlc_object_hold( VLC_OBJECT(a) )
 108
 109 #define vlc_object_release(a) \
 110     __vlc_object_release( VLC_OBJECT(a) )
 111
 112 #define vlc_list_children(a) \
 113     __vlc_list_children( VLC_OBJECT(a) )
 114
 115 /* Objects and threading */
 116 VLC_EXPORT( void, __vlc_object_kill, ( vlc_object_t * ) );
 117 #define vlc_object_kill(a) \
 118     __vlc_object_kill( VLC_OBJECT(a) )
 119
 120 LIBVLC_USED
 121 static inline bool vlc_object_alive (const vlc_object_t *obj)
 122 {
 123     barrier ();
 124     return !obj->b_die;
 125 }
 126
 127 #define vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) )