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 /**
  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_ROOT        (-1)
  36 #define VLC_OBJECT_LIBVLC      (-2)
  37 #define VLC_OBJECT_MODULE      (-3)
  38 #define VLC_OBJECT_INTF        (-4)
  39 #define VLC_OBJECT_PLAYLIST    (-5)
  40 #define VLC_OBJECT_ITEM        (-6)
  41 #define VLC_OBJECT_INPUT       (-7)
  42 #define VLC_OBJECT_DECODER     (-8)
  43 #define VLC_OBJECT_VOUT        (-9)
  44 #define VLC_OBJECT_AOUT        (-10)
  45 #define VLC_OBJECT_SOUT        (-11)
  46 #define VLC_OBJECT_HTTPD       (-12)
  47 #define VLC_OBJECT_PACKETIZER  (-13)
  48 #define VLC_OBJECT_ENCODER     (-14)
  49 #define VLC_OBJECT_DIALOGS     (-15)
  50 #define VLC_OBJECT_VLM         (-16)
  51 #define VLC_OBJECT_ANNOUNCE    (-17)
  52 #define VLC_OBJECT_DEMUX       (-18)
  53 #define VLC_OBJECT_ACCESS      (-19)
  54 #define VLC_OBJECT_STREAM      (-20)
  55 #define VLC_OBJECT_OPENGL      (-21)
  56 #define VLC_OBJECT_FILTER      (-22)
  57 #define VLC_OBJECT_VOD         (-23)
  58 #define VLC_OBJECT_SPU         (-24)
  59 #define VLC_OBJECT_TLS         (-25)
  60 #define VLC_OBJECT_SD          (-26)
  61 #define VLC_OBJECT_XML         (-27)
  62 #define VLC_OBJECT_OSDMENU     (-28)
  63 #define VLC_OBJECT_STATS       (-29)
  64 #define VLC_OBJECT_HTTPD_HOST  (-30)
  65 #define VLC_OBJECT_META_ENGINE (-31)
  66
  67 #define VLC_OBJECT_GENERIC     (-666)
  68
  69 /* Object search mode */
  70 #define FIND_PARENT         0x0001
  71 #define FIND_CHILD          0x0002
  72 #define FIND_ANYWHERE       0x0003
  73
  74 #define FIND_STRICT         0x0010
  75
  76 /* Object flags */
  77 #define OBJECT_FLAGS_NODBG       0x0001
  78 #define OBJECT_FLAGS_QUIET       0x0002
  79 #define OBJECT_FLAGS_NOINTERACT  0x0004
  80
  81 /*****************************************************************************
  82  * The vlc_object_t type. Yes, it's that simple :-)
  83  *****************************************************************************/
  84 /** The main vlc_object_t structure */
  85 struct vlc_object_t
  86 {
  87     VLC_COMMON_MEMBERS
  88 };
  89
  90 /*****************************************************************************
  91  * Prototypes
  92  *****************************************************************************/
  93 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
  94 VLC_EXPORT( void, __vlc_object_destroy, ( vlc_object_t * ) );
  95 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
  96 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
  97 VLC_EXPORT( void *, __vlc_object_get, ( vlc_object_t *, int ) );
  98 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
  99 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
 100 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
 101 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
 102 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
 103 VLC_EXPORT( libvlc_int_t *, vlc_current_object, ( int ) );
 104
 105 /*}@*/
 106
 107 #define vlc_object_create(a,b) \
 108     __vlc_object_create( VLC_OBJECT(a), b )
 109
 110 #define vlc_object_destroy(a) do { \
 111     __vlc_object_destroy( VLC_OBJECT(a) ); \
 112     (a) = NULL; } while(0)
 113
 114 #define vlc_object_detach(a) \
 115     __vlc_object_detach( VLC_OBJECT(a) )
 116
 117 #define vlc_object_attach(a,b) \
 118     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
 119
 120 #define vlc_object_get(a,b) \
 121     __vlc_object_get( VLC_OBJECT(a),b)
 122
 123 #define vlc_object_find(a,b,c) \
 124     __vlc_object_find( VLC_OBJECT(a),b,c)
 125
 126 #define vlc_object_yield(a) \
 127     __vlc_object_yield( VLC_OBJECT(a) )
 128
 129 #define vlc_object_release(a) \
 130     __vlc_object_release( VLC_OBJECT(a) )
 131
 132 #define vlc_list_find(a,b,c) \
 133     __vlc_list_find( VLC_OBJECT(a),b,c)