libvlc_internal.h 11.8 KB
Newer Older
1
/*****************************************************************************
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
6
 * $Id$
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
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24
 *****************************************************************************/

25 26
#ifndef _LIBVLC_INTERNAL_H
#define _LIBVLC_INTERNAL_H 1
27

28 29 30 31
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

32
#include <vlc/vlc.h>
33
#include <vlc/libvlc_structures.h>
34

35
#include <vlc_common.h>
36
#include <vlc_arrays.h>
37
#include <vlc_input.h>
38

Clément Stenac's avatar
Clément Stenac committed
39 40 41
/***************************************************************************
 * Internal creation and destruction functions
 ***************************************************************************/
42
VLC_EXPORT (libvlc_int_t *, libvlc_InternalCreate, ( void ) );
43
VLC_EXPORT (int, libvlc_InternalInit, ( libvlc_int_t *, int, const char *ppsz_argv[] ) );
44 45
VLC_EXPORT (void, libvlc_InternalCleanup, ( libvlc_int_t * ) );
VLC_EXPORT (void, libvlc_InternalDestroy, ( libvlc_int_t * ) );
Clément Stenac's avatar
Clément Stenac committed
46

47
VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char * ) );
48
VLC_EXPORT (void, libvlc_InternalWait, ( libvlc_int_t * ) );
Clément Stenac's avatar
Clément Stenac committed
49 50 51 52 53

/***************************************************************************
 * Opaque structures for libvlc API
 ***************************************************************************/

54 55
typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */

56 57 58 59 60 61
typedef enum libvlc_lock_state_t
{
    libvlc_Locked,
    libvlc_UnLocked
} libvlc_lock_state_t;

62 63
struct libvlc_instance_t
{
64
    libvlc_int_t *p_libvlc_int;
65 66
    vlm_t        *p_vlm;
    int           b_playlist_locked;
67
    unsigned      ref_count;
68
    vlc_mutex_t   instance_lock;
69
    vlc_mutex_t   event_callback_lock;
70
    struct libvlc_callback_entry_list_t *p_callback_list;
71 72
};

73
struct libvlc_media_t
74
{
75
    libvlc_event_manager_t * p_event_manager;
76 77
    int                b_preparsed;
    input_item_t      *p_input_item;
78
    int                i_refcount;
79
    libvlc_instance_t *p_libvlc_instance;
80
    libvlc_state_t     state;
81 82
    struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
                                           * Sub item */
83
    void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
84
};
85

86 87
struct libvlc_media_list_t
{
88 89 90 91
    libvlc_event_manager_t *    p_event_manager;
    libvlc_instance_t *         p_libvlc_instance;
    int                         i_refcount;
    vlc_mutex_t                 object_lock;
92
    libvlc_media_t * p_md; /* The media from which the
93
                                       * mlist comes, if any. */
94
    vlc_array_t                items;
95

96 97
    /* Other way to see that media list */
    /* Used in flat_media_list.c */
98
    libvlc_media_list_t *       p_flat_mlist;
99 100 101

    /* This indicates if this media list is read-only
     * from a user point of view */
102
    bool                  b_read_only;
103 104
};

105
typedef libvlc_media_list_view_t * (*libvlc_media_list_view_constructor_func_t)( libvlc_media_list_t * p_mlist, libvlc_exception_t * p_e ) ;
106
typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
107

108
typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
109 110
        libvlc_exception_t * ) ;

111
typedef libvlc_media_t *
112
        (*libvlc_media_list_view_item_at_index_func_t)(
113 114 115 116 117 118 119
                libvlc_media_list_view_t * p_mlv,
                int index,
                libvlc_exception_t * ) ;

typedef libvlc_media_list_view_t *
        (*libvlc_media_list_view_children_at_index_func_t)(
                libvlc_media_list_view_t * p_mlv,
120 121 122
                int index,
                libvlc_exception_t * ) ;

123 124 125 126 127 128 129
/* A way to see a media list */
struct libvlc_media_list_view_t
{
    libvlc_event_manager_t *    p_event_manager;
    libvlc_instance_t *         p_libvlc_instance;
    int                         i_refcount;
    vlc_mutex_t                 object_lock;
130

131 132
    libvlc_media_list_t *       p_mlist;

133
    struct libvlc_media_list_view_private_t * p_this_view_data;
134 135

    /* Accessors */
136 137 138
    libvlc_media_list_view_count_func_t              pf_count;
    libvlc_media_list_view_item_at_index_func_t      pf_item_at_index;
    libvlc_media_list_view_children_at_index_func_t  pf_children_at_index;
139

140
    libvlc_media_list_view_constructor_func_t         pf_constructor;
141
    libvlc_media_list_view_release_func_t            pf_release;
142 143

    /* Notification callback */
144 145
    void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
    void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
146 147
};

148
struct libvlc_media_player_t
149
{
150 151
    int                i_refcount;
    vlc_mutex_t        object_lock;
152
    input_thread_t *   p_input_thread;
153
    struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
154
    libvlc_media_t * p_md; /* current media descriptor */
155 156
    libvlc_event_manager_t *    p_event_manager;
    libvlc_drawable_t           drawable;
157

158
    bool        b_own_its_input_thread;
159 160
};

161 162
struct libvlc_media_list_player_t
{
163 164 165 166 167
    libvlc_event_manager_t *    p_event_manager;
    libvlc_instance_t *         p_libvlc_instance;
    int                         i_refcount;
    vlc_mutex_t                 object_lock;
    libvlc_media_list_path_t    current_playing_item_path;
168
    libvlc_media_t * p_current_playing_item;
169
    libvlc_media_list_t *       p_mlist;
170
    libvlc_media_player_t *   p_mi;
171 172
};

173 174 175 176 177 178 179 180
struct libvlc_media_library_t
{
    libvlc_event_manager_t * p_event_manager;
    libvlc_instance_t *      p_libvlc_instance;
    int                      i_refcount;
    libvlc_media_list_t *    p_mlist;
};

181 182 183 184 185 186
struct libvlc_media_discoverer_t
{
    libvlc_event_manager_t * p_event_manager;
    libvlc_instance_t *      p_libvlc_instance;
    services_discovery_t *   p_sd;
    libvlc_media_list_t *    p_mlist;
187
    bool               running;
188
    vlc_dictionary_t         catname_to_submedialist;
189
};
190

191
/*
192 193 194 195 196 197
 * Event Handling
 */
/* Example usage
 *
 * struct libvlc_cool_object_t
 * {
198 199 200
 *        ...
 *        libvlc_event_manager_t * p_event_manager;
 *        ...
201 202 203 204
 * }
 *
 * libvlc_my_cool_object_new()
 * {
205
 *        ...
206
 *        p_self->p_event_manager = libvlc_event_manager_new( p_self,
207 208 209 210
 *                                                   p_self->p_libvlc_instance, p_e);
 *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 *                libvlc_MyCoolObjectDidSomething, p_e)
 *        ...
211 212 213 214
 * }
 *
 * libvlc_my_cool_object_release()
 * {
215 216 217
 *         ...
 *         libvlc_event_manager_release( p_self->p_event_manager );
 *         ...
218 219 220 221
 * }
 *
 * libvlc_my_cool_object_do_something()
 * {
222 223 224 225 226
 *        ...
 *        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 );
227 228 229 230 231
 * }
 * */

typedef struct libvlc_event_listener_t
{
232 233 234
    libvlc_event_type_t event_type;
    void *              p_user_data;
    libvlc_callback_t   pf_callback;
235 236 237 238
} libvlc_event_listener_t;

typedef struct libvlc_event_listeners_group_t
{
239
    libvlc_event_type_t event_type;
240
    vlc_array_t listeners;
241
    bool b_sublistener_removed;
242 243 244 245
} libvlc_event_listeners_group_t;

typedef struct libvlc_event_manager_t
{
246 247
    void * p_obj;
    struct libvlc_instance_t * p_libvlc_instance;
248
    vlc_array_t listeners_groups;
249
    vlc_mutex_t object_lock;
250
    vlc_mutex_t event_sending_lock;
251 252 253
} libvlc_event_sender_t;


254 255 256
/***************************************************************************
 * Other internal functions
 ***************************************************************************/
257
input_thread_t *libvlc_get_input_thread(
258 259
     libvlc_media_player_t *,
    libvlc_exception_t * );
260

261
/* Media instance */
262
libvlc_media_player_t *
263
libvlc_media_player_new_from_input_thread( libvlc_instance_t *,
264 265
                                           input_thread_t *,
                                           libvlc_exception_t * );
266

267
void libvlc_media_player_destroy(
268
        libvlc_media_player_t * );
269

270
/* Media Descriptor */
271
libvlc_media_t * libvlc_media_new_from_input_item(
272 273
        libvlc_instance_t *, input_item_t *,
        libvlc_exception_t * );
274

275
void libvlc_media_set_state(
276 277
        libvlc_media_t *, libvlc_state_t,
        libvlc_exception_t * );
278

279
/* Media List */
280
void _libvlc_media_list_add_media(
281 282 283
        libvlc_media_list_t * p_mlist,
        libvlc_media_t * p_md,
        libvlc_exception_t * p_e );
284

285
void _libvlc_media_list_insert_media(
286 287 288
        libvlc_media_list_t * p_mlist,
        libvlc_media_t * p_md, int index,
        libvlc_exception_t * p_e );
289

290
void _libvlc_media_list_remove_index(
291 292
        libvlc_media_list_t * p_mlist, int index,
        libvlc_exception_t * p_e );
293

294
/* Media List View */
295
libvlc_media_list_view_t * libvlc_media_list_view_new(
296 297 298 299 300 301 302 303 304
        libvlc_media_list_t * p_mlist,
        libvlc_media_list_view_count_func_t pf_count,
        libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
        libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
        libvlc_media_list_view_constructor_func_t pf_constructor,
        libvlc_media_list_view_release_func_t pf_release,
        void * this_view_data,
        libvlc_exception_t * p_e );

305
void libvlc_media_list_view_set_ml_notification_callback(
306 307 308 309
        libvlc_media_list_view_t * p_mlv,
        void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
        void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) );

310
void libvlc_media_list_view_will_delete_item(
311 312 313
        libvlc_media_list_view_t * p_mlv,
        libvlc_media_t * p_item, int index );

314
void libvlc_media_list_view_item_deleted(
315 316 317
        libvlc_media_list_view_t * p_mlv,
        libvlc_media_t * p_item, int index );

318
void libvlc_media_list_view_will_add_item (
319 320 321
        libvlc_media_list_view_t * p_mlv,
        libvlc_media_t * p_item, int index );

322
void libvlc_media_list_view_item_added(
323 324
        libvlc_media_list_view_t * p_mlv,
        libvlc_media_t * p_item, int index );
325

326
/* Events */
327
libvlc_event_manager_t * libvlc_event_manager_new(
328 329
        void * p_obj, libvlc_instance_t * p_libvlc_inst,
        libvlc_exception_t *p_e );
330

331
void libvlc_event_manager_release(
332
        libvlc_event_manager_t * p_em );
333

334
void libvlc_event_manager_register_event_type(
335 336 337
        libvlc_event_manager_t * p_em,
        libvlc_event_type_t event_type,
        libvlc_exception_t * p_e );
338

339
void libvlc_event_send(
340 341
        libvlc_event_manager_t * p_em,
        libvlc_event_t * p_event );
342

343 344 345 346 347 348
/* Media player - audio, video */
libvlc_track_description_t * libvlc_get_track_description(
        libvlc_media_player_t *p_mi,
        const char *psz_variable,
        libvlc_exception_t *p_e );

349 350 351

/* Exception shorcuts */

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
352 353 354 355 356 357
#define RAISENULL( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
                           return NULL; }
#define RAISEVOID( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
                           return; }
#define RAISEZERO( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
                           return 0; }
358 359

#endif