include/vlc_objects.h

   1 /*****************************************************************************
   2  * vlc_objects.h: vlc_object_t definition.
   3  *****************************************************************************
   4  * Copyright (C) 2002 VideoLAN
   5  * $Id: vlc_objects.h,v 1.14 2002/12/13 01:56:29 gbazin Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /* Object types */
  25 #define VLC_OBJECT_ROOT       (-1)
  26 #define VLC_OBJECT_VLC        (-2)
  27 #define VLC_OBJECT_MODULE     (-3)
  28 #define VLC_OBJECT_INTF       (-4)
  29 #define VLC_OBJECT_PLAYLIST   (-5)
  30 #define VLC_OBJECT_ITEM       (-6)
  31 #define VLC_OBJECT_INPUT      (-7)
  32 #define VLC_OBJECT_DECODER    (-8)
  33 #define VLC_OBJECT_VOUT       (-9)
  34 #define VLC_OBJECT_AOUT      (-10)
  35 #define VLC_OBJECT_SOUT      (-11)
  36 #define VLC_OBJECT_GENERIC  (-666)
  37
  38 /* Object search mode */
  39 #define FIND_PARENT         0x0001
  40 #define FIND_CHILD          0x0002
  41 #define FIND_ANYWHERE       0x0003
  42
  43 #define FIND_STRICT         0x0010
  44
  45 /*****************************************************************************
  46  * The vlc_object_t type. Yes, it's that simple :-)
  47  *****************************************************************************/
  48 struct vlc_object_t
  49 {
  50     VLC_COMMON_MEMBERS
  51 };
  52
  53 /*****************************************************************************
  54  * Prototypes
  55  *****************************************************************************/
  56 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
  57 VLC_EXPORT( void, __vlc_object_destroy, ( vlc_object_t * ) );
  58 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
  59 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
  60 VLC_EXPORT( void *, __vlc_object_get, ( vlc_object_t *, int ) );
  61 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
  62 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
  63 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
  64 VLC_EXPORT( vlc_list_t, __vlc_list_find, ( vlc_object_t *, int, int ) );
  65 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
  66
  67 #define vlc_object_create(a,b) \
  68     __vlc_object_create( VLC_OBJECT(a), b )
  69
  70 #define vlc_object_destroy(a) do { \
  71     __vlc_object_destroy( VLC_OBJECT(a) ); \
  72     (a) = NULL; } while(0)
  73
  74 #define vlc_object_detach(a) \
  75     __vlc_object_detach( VLC_OBJECT(a) )
  76
  77 #define vlc_object_attach(a,b) \
  78     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
  79
  80 #define vlc_object_get(a,b) \
  81     __vlc_object_get( VLC_OBJECT(a),b)
  82
  83 #define vlc_object_find(a,b,c) \
  84     __vlc_object_find( VLC_OBJECT(a),b,c)
  85
  86 #define vlc_object_yield(a) \
  87     __vlc_object_yield( VLC_OBJECT(a) )
  88
  89 #define vlc_object_release(a) \
  90     __vlc_object_release( VLC_OBJECT(a) )
  91
  92 #define vlc_list_find(a,b,c) \
  93     __vlc_list_find( VLC_OBJECT(a),b,c)
  94