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