1 /*****************************************************************************
2 * vlc_objects.h: vlc_object_t definition.
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: vlc_objects.h,v 1.19 2003/10/08 21:01:07 gbazin Exp $
7 * Authors: Samuel Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
26 * This file defines the vlc_object_t structure and object types
30 * \defgroup vlc_object Objects
35 #define VLC_OBJECT_ROOT (-1)
36 #define VLC_OBJECT_VLC (-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 /* tmp for backward compat */
44 #define VLC_OBJECT_DECODER_FIFO (-999)
45 #define VLC_OBJECT_VOUT (-9)
46 #define VLC_OBJECT_AOUT (-10)
47 #define VLC_OBJECT_SOUT (-11)
48 #define VLC_OBJECT_HTTPD (-12)
49 #define VLC_OBJECT_PACKETIZER (-13)
50 #define VLC_OBJECT_ENCODER (-14)
52 #define VLC_OBJECT_GENERIC (-666)
54 /* Object search mode */
55 #define FIND_PARENT 0x0001
56 #define FIND_CHILD 0x0002
57 #define FIND_ANYWHERE 0x0003
59 #define FIND_STRICT 0x0010
61 /*****************************************************************************
62 * The vlc_object_t type. Yes, it's that simple :-)
63 *****************************************************************************/
64 /** The main vlc_object_t structure */
70 /*****************************************************************************
72 *****************************************************************************/
73 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
74 VLC_EXPORT( void, __vlc_object_destroy, ( vlc_object_t * ) );
75 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
76 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
77 VLC_EXPORT( void *, __vlc_object_get, ( vlc_object_t *, int ) );
78 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
79 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
80 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
81 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
82 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
86 #define vlc_object_create(a,b) \
87 __vlc_object_create( VLC_OBJECT(a), b )
89 #define vlc_object_destroy(a) do { \
90 __vlc_object_destroy( VLC_OBJECT(a) ); \
91 (a) = NULL; } while(0)
93 #define vlc_object_detach(a) \
94 __vlc_object_detach( VLC_OBJECT(a) )
96 #define vlc_object_attach(a,b) \
97 __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
99 #define vlc_object_get(a,b) \
100 __vlc_object_get( VLC_OBJECT(a),b)
102 #define vlc_object_find(a,b,c) \
103 __vlc_object_find( VLC_OBJECT(a),b,c)
105 #define vlc_object_yield(a) \
106 __vlc_object_yield( VLC_OBJECT(a) )
108 #define vlc_object_release(a) \
109 __vlc_object_release( VLC_OBJECT(a) )
111 #define vlc_list_find(a,b,c) \
112 __vlc_list_find( VLC_OBJECT(a),b,c)