libvlc_internal.h 7.73 KB
Newer Older
1
/*****************************************************************************
zorglub's avatar
zorglub committed
2
3
 * libvlc_internal.h : Definition of opaque structures for libvlc exported API
 * Also contains some internal utility functions
4
5
 *****************************************************************************
 * Copyright (C) 2005 the VideoLAN team
zorglub's avatar
zorglub committed
6
 * $Id: control_structures.h 13752 2005-12-15 10:14:42Z oaubert $
7
 *
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
8
 * Authors: Clément Stenac <zorglub@videolan.org>
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23
24
 *****************************************************************************/

zorglub's avatar
zorglub committed
25
26
#ifndef _LIBVLC_INTERNAL_H
#define _LIBVLC_INTERNAL_H 1
27
28
29
30
31

# ifdef __cplusplus
extern "C" {
# endif

zorglub's avatar
zorglub committed
32
#include <vlc/vlc.h>
33
#include <vlc/libvlc_structures.h>
34

35
#include <vlc_arrays.h>
36
#include <vlc_input.h>
37
    
zorglub's avatar
zorglub committed
38
39
40
/***************************************************************************
 * Internal creation and destruction functions
 ***************************************************************************/
41
42
43
44
VLC_EXPORT (libvlc_int_t *, libvlc_InternalCreate, ( void ) );
VLC_EXPORT (int, libvlc_InternalInit, ( libvlc_int_t *, int, char *ppsz_argv[] ) );
VLC_EXPORT (int, libvlc_InternalCleanup, ( libvlc_int_t * ) );
VLC_EXPORT (int, libvlc_InternalDestroy, ( libvlc_int_t *, vlc_bool_t ) );
zorglub's avatar
zorglub committed
45

46
47
VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, vlc_bool_t,
                            vlc_bool_t, int, const char *const * ) );
zorglub's avatar
zorglub committed
48

49
50
51
VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *, libvlc_exception_t * ) );
VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *, libvlc_exception_t * ) );

zorglub's avatar
zorglub committed
52
53
54
55
/***************************************************************************
 * Opaque structures for libvlc API
 ***************************************************************************/

zorglub's avatar
zorglub committed
56
57
struct libvlc_instance_t
{
58
    libvlc_int_t *p_libvlc_int;
59
60
61
    vlm_t        *p_vlm;
    int           b_playlist_locked;
    vlc_mutex_t   instance_lock;
62
    vlc_mutex_t   event_callback_lock;
63
    struct libvlc_callback_entry_list_t *p_callback_list;
zorglub's avatar
zorglub committed
64
65
};

66
67
68
69
struct libvlc_media_descriptor_t
{
    int                b_preparsed;
    input_item_t      *p_input_item;
70
    int                i_refcount;
71
    libvlc_instance_t *p_libvlc_instance;
72
};
73

74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
struct libvlc_tag_query_t
{
    struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
    int                i_refcount;
};


struct libvlc_media_list_t
{
    libvlc_event_manager_t * p_event_manager;
    libvlc_instance_t *      p_libvlc_instance;
    int                      i_refcount;
    vlc_mutex_t              object_lock;
    libvlc_media_list_t *    p_media_provider; /* For dynamic sublist */
    libvlc_tag_query_t *     p_query;              /* For dynamic sublist */
    DECL_ARRAY(void *) items;
};

92
struct libvlc_media_instance_t
zorglub's avatar
zorglub committed
93
{
94
95
    int                i_refcount;
    vlc_mutex_t        object_lock;
96
97
    int i_input_id;  /* Input object id. We don't use a pointer to
                        avoid any crash */
98
99
100
101
    struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
    libvlc_media_descriptor_t * p_md; /* current media descriptor */
    libvlc_event_manager_t *    p_event_manager;
    libvlc_drawable_t           drawable;
zorglub's avatar
zorglub committed
102
103
};

104
105
106
107
108
109
110
111
112
113
114
115
116
struct libvlc_media_list_player_t
{
    libvlc_event_manager_t * p_event_manager;
    libvlc_instance_t *      p_libvlc_instance;
    int                      i_refcount;
    vlc_mutex_t              object_lock;
    int                      i_current_playing_index;
    libvlc_media_descriptor_t * p_current_playing_item;
    libvlc_media_list_t *    p_mlist;
    libvlc_media_instance_t *  p_mi;
};


117
118
119
120
121
122
123
124

/* 
 * Event Handling
 */
/* Example usage
 *
 * struct libvlc_cool_object_t
 * {
125
126
127
 *        ...
 *        libvlc_event_manager_t * p_event_manager;
 *        ...
128
129
130
131
 * }
 *
 * libvlc_my_cool_object_new()
 * {
132
133
134
135
136
137
 *        ...
 *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
 *                                                   p_self->p_libvlc_instance, p_e);
 *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 *                libvlc_MyCoolObjectDidSomething, p_e)
 *        ...
138
139
140
141
 * }
 *
 * libvlc_my_cool_object_release()
 * {
142
143
144
 *         ...
 *         libvlc_event_manager_release( p_self->p_event_manager );
 *         ...
145
146
147
148
 * }
 *
 * libvlc_my_cool_object_do_something()
 * {
149
150
151
152
153
 *        ...
 *        libvlc_event_t event;
 *        event.type = libvlc_MyCoolObjectDidSomething;
 *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 *        libvlc_event_send( p_self->p_event_manager, &event );
154
155
156
157
158
 * }
 * */

typedef struct libvlc_event_listener_t
{
159
160
161
    libvlc_event_type_t event_type;
    void *              p_user_data;
    libvlc_callback_t   pf_callback;
162
163
164
165
} libvlc_event_listener_t;

typedef struct libvlc_event_listeners_group_t
{
166
167
    libvlc_event_type_t event_type;
    DECL_ARRAY(libvlc_event_listener_t *) listeners;
168
169
170
171
} libvlc_event_listeners_group_t;

typedef struct libvlc_event_manager_t
{
172
173
174
    void * p_obj;
    struct libvlc_instance_t * p_libvlc_instance;
    DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
175
176
177
} libvlc_event_sender_t;


178
179
180
181
/***************************************************************************
 * Other internal functions
 ***************************************************************************/
VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
182
183
                        ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );

184
/* Media instance */
185
VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
186
                        ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
187

188
189
190
VLC_EXPORT (void, libvlc_media_instance_destroy,
                        ( libvlc_media_instance_t * ) );

191
/* Media Descriptor */
192
VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
193
                        ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
194
195
196

VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
                        ( libvlc_media_descriptor_t * ) );
197

198
199
200
201
202
/* Events */
VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );

VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );

203
VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
204
205
206
207
208
209
210
211
212
213

VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );

VLC_EXPORT (void, libvlc_event_manager_register_event_type, ( libvlc_event_manager_t * p_em, libvlc_event_type_t event_type, libvlc_exception_t * p_e ) );

VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );


/* Exception shorcuts */

zorglub's avatar
zorglub committed
214
215
216
217
218
219
#define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
                                return NULL; }
#define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
                                return; }
#define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
                                return 0; }
220
221
222
223
224
225

# ifdef __cplusplus
}
# endif

#endif