vlc_objects.h 4.47 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_objects.h: vlc_object_t definition and manipulation methods
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2002-2008 VLC authors and VideoLAN
5
 * $Id$
6 7 8
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12
 * (at your option) any later version.
13
 *
14 15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
24
/**
25
 * \defgroup vlc_object VLC objects
Clément Stenac's avatar
Clément Stenac committed
26
 * @{
27 28
 * \file
 * Common VLC object defintions
Clément Stenac's avatar
Clément Stenac committed
29 30
 */

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
/**
 * VLC object common members
 *
 * Common public properties for all VLC objects.
 * Object also have private properties maintained by the core, see
 * \ref vlc_object_internals_t
 */
struct vlc_common_members
{
    /** Object type name
     *
     * A constant string identifying the type of the object (for logging)
     */
    const char *object_type;

    /** Log messages header
     *
     * Human-readable header for log messages. This is not thread-safe and
     * only used by VLM and Lua interfaces.
     */
    char *header;

    int  flags;

    /** Module probe flag
     *
     * A boolean during module probing when the probe is "forced".
     * See \ref module_need().
     */
    bool force;

    /** LibVLC instance
     *
     * Root VLC object of the objects tree that this object belongs in.
     */
    libvlc_int_t *libvlc;

    /** Parent object
     *
     * The parent VLC object in the objects tree. For the root (the LibVLC
     * instance) object, this is NULL.
     */
    vlc_object_t *parent;
};

/**
 * Type-safe vlc_object_t cast
 *
 * This macro attempts to cast a pointer to a compound type to a
 * \ref vlc_object_t pointer in a type-safe manner.
 * It checks if the compound type actually starts with an embedded
 * \ref vlc_object_t structure.
 */
#if !defined(__cplusplus)
# define VLC_OBJECT(x) \
    _Generic((x)->obj, \
        struct vlc_common_members: (vlc_object_t *)(&(x)->obj), \
        const struct vlc_common_members: (const vlc_object_t *)(&(x)->obj) \
    )
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)&(x)->obj)
#endif

94 95 96 97
/* Object flags */
#define OBJECT_FLAGS_QUIET       0x0002
#define OBJECT_FLAGS_NOINTERACT  0x0004

Sam Hocevar's avatar
Sam Hocevar committed
98 99 100
/*****************************************************************************
 * The vlc_object_t type. Yes, it's that simple :-)
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
101
/** The main vlc_object_t structure */
Sam Hocevar's avatar
Sam Hocevar committed
102 103
struct vlc_object_t
{
104
    struct vlc_common_members obj;
Sam Hocevar's avatar
Sam Hocevar committed
105 106
};

107 108 109
/* The root object */
struct libvlc_int_t
{
110
    struct vlc_common_members obj;
111 112
};

113 114 115
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
116
VLC_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED;
117
VLC_API vlc_object_t *vlc_object_find_name( vlc_object_t *, const char * ) VLC_USED VLC_DEPRECATED;
118 119
VLC_API void * vlc_object_hold( vlc_object_t * );
VLC_API void vlc_object_release( vlc_object_t * );
120
VLC_API vlc_list_t *vlc_list_children( vlc_object_t * ) VLC_USED;
121
VLC_API void vlc_list_release( vlc_list_t * );
122
VLC_API char *vlc_object_get_name( const vlc_object_t * ) VLC_USED;
123
#define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
124

125
#define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
126

127 128
#define vlc_object_find_name(a,b) \
    vlc_object_find_name( VLC_OBJECT(a),b)
129

130
#define vlc_object_hold(a) \
131
    vlc_object_hold( VLC_OBJECT(a) )
132 133

#define vlc_object_release(a) \
134
    vlc_object_release( VLC_OBJECT(a) )
135

136
#define vlc_list_children(a) \
137
    vlc_list_children( VLC_OBJECT(a) )
138

139
VLC_API VLC_MALLOC void *vlc_obj_malloc(vlc_object_t *, size_t);
140 141
VLC_API VLC_MALLOC void *vlc_obj_calloc(vlc_object_t *, size_t, size_t);
VLC_API void vlc_obj_free(vlc_object_t *, void *);
142

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
143
/** @} */