1 /*****************************************************************************
2 * vlc_objects.h: vlc_object_t definition and manipulation methods
3 *****************************************************************************
4 * Copyright (C) 2002-2008 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
26 * This file defines the vlc_object_t structure and object types.
30 * \defgroup vlc_object Objects
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)
43 /* Object search mode */
44 #define FIND_PARENT 0x0001
45 #define FIND_CHILD 0x0002
46 #define FIND_ANYWHERE 0x0003
49 #define OBJECT_FLAGS_NODBG 0x0001
50 #define OBJECT_FLAGS_QUIET 0x0002
51 #define OBJECT_FLAGS_NOINTERACT 0x0004
53 /*****************************************************************************
54 * The vlc_object_t type. Yes, it's that simple :-)
55 *****************************************************************************/
56 /** The main vlc_object_t structure */
62 /*****************************************************************************
64 *****************************************************************************/
65 VLC_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED;
66 VLC_API void vlc_object_attach( vlc_object_t *, vlc_object_t * );
67 VLC_API vlc_object_t *vlc_object_find_name( vlc_object_t *, const char *, int ) VLC_USED VLC_DEPRECATED;
68 VLC_API void * vlc_object_hold( vlc_object_t * );
69 VLC_API void vlc_object_release( vlc_object_t * );
70 VLC_API vlc_list_t *vlc_list_children( vlc_object_t * ) VLC_USED;
71 VLC_API void vlc_list_release( vlc_list_t * );
72 VLC_API char *vlc_object_get_name( const vlc_object_t * ) VLC_USED;
73 #define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
77 #define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
79 #define vlc_object_attach(a,b) \
80 vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
82 #define vlc_object_find_name(a,b,c) \
83 vlc_object_find_name( VLC_OBJECT(a),b,c)
85 #define vlc_object_hold(a) \
86 vlc_object_hold( VLC_OBJECT(a) )
88 #define vlc_object_release(a) \
89 vlc_object_release( VLC_OBJECT(a) )
91 #define vlc_list_children(a) \
92 vlc_list_children( VLC_OBJECT(a) )
94 /* Objects and threading */
95 VLC_API void vlc_object_kill( vlc_object_t * ) VLC_DEPRECATED;
96 #define vlc_object_kill(a) \
97 vlc_object_kill( VLC_OBJECT(a) )
100 static inline bool vlc_object_alive (const vlc_object_t *obj)
106 #define vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) )