libvlc_internal.h 11.6 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-2009 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
    int           verbosity;
69
    vlc_mutex_t   instance_lock;
70
    vlc_mutex_t   event_callback_lock;
71
    struct libvlc_callback_entry_list_t *p_callback_list;
72 73
};

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

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

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

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

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

110
typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
111 112
        libvlc_exception_t * ) ;

113
typedef libvlc_media_t *
114
        (*libvlc_media_list_view_item_at_index_func_t)(
115 116 117 118 119 120 121
                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,
122 123 124
                int index,
                libvlc_exception_t * ) ;

125 126 127 128 129 130 131
/* 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;
132

133 134
    libvlc_media_list_t *       p_mlist;

135
    struct libvlc_media_list_view_private_t * p_this_view_data;
136 137

    /* Accessors */
138 139 140
    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;
141

Jean-Paul Saman's avatar
Jean-Paul Saman committed
142
    libvlc_media_list_view_constructor_func_t        pf_constructor;
143
    libvlc_media_list_view_release_func_t            pf_release;
144 145

    /* Notification callback */
146 147
    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 *);
148 149
};

150
struct libvlc_media_player_t
151
{
152 153
    int                i_refcount;
    vlc_mutex_t        object_lock;
154
    input_thread_t *   p_input_thread;
Jean-Paul Saman's avatar
Jean-Paul Saman committed
155
    struct libvlc_instance_t * p_libvlc_instance; /* Parent instance */
156
    libvlc_media_t * p_md; /* current media descriptor */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
157
    libvlc_event_manager_t * p_event_manager;
158
    struct
159 160
    {
        void *hwnd;
161
        void *nsobject;
162
        uint32_t xid;
163
        uint32_t agl;
164
    } drawable;
165 166
};

167 168
struct libvlc_media_list_player_t
{
169 170
    libvlc_event_manager_t *    p_event_manager;
    libvlc_instance_t *         p_libvlc_instance;
171
    unsigned                    i_refcount;
172 173
    vlc_mutex_t                 object_lock;
    libvlc_media_list_path_t    current_playing_item_path;
Jean-Paul Saman's avatar
Jean-Paul Saman committed
174
    libvlc_media_t *            p_current_playing_item;
175
    libvlc_media_list_t *       p_mlist;
Jean-Paul Saman's avatar
Jean-Paul Saman committed
176
    libvlc_media_player_t *     p_mi;
177 178
};

179 180 181 182 183 184 185 186
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;
};

187 188 189 190 191 192
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;
Jean-Paul Saman's avatar
Jean-Paul Saman committed
193
    bool                     running;
194
    vlc_dictionary_t         catname_to_submedialist;
195
};
196

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

typedef struct libvlc_event_listener_t
{
238 239 240
    libvlc_event_type_t event_type;
    void *              p_user_data;
    libvlc_callback_t   pf_callback;
241 242 243 244
} libvlc_event_listener_t;

typedef struct libvlc_event_listeners_group_t
{
245
    libvlc_event_type_t event_type;
246
    vlc_array_t listeners;
247
    bool b_sublistener_removed;
248 249 250 251
} libvlc_event_listeners_group_t;

typedef struct libvlc_event_manager_t
{
252 253
    void * p_obj;
    struct libvlc_instance_t * p_libvlc_instance;
254
    vlc_array_t listeners_groups;
255
    vlc_mutex_t object_lock;
256
    vlc_mutex_t event_sending_lock;
257 258 259
} libvlc_event_sender_t;


260 261 262
/***************************************************************************
 * Other internal functions
 ***************************************************************************/
263
input_thread_t *libvlc_get_input_thread(
264 265
     libvlc_media_player_t *,
    libvlc_exception_t * );
266

267
/* Media Descriptor */
268
libvlc_media_t * libvlc_media_new_from_input_item(
269 270
        libvlc_instance_t *, input_item_t *,
        libvlc_exception_t * );
271

272
void libvlc_media_set_state(
273 274
        libvlc_media_t *, libvlc_state_t,
        libvlc_exception_t * );
275

276
/* Media List */
277
void _libvlc_media_list_add_media(
278 279 280
        libvlc_media_list_t * p_mlist,
        libvlc_media_t * p_md,
        libvlc_exception_t * p_e );
281

282
void _libvlc_media_list_insert_media(
283 284 285
        libvlc_media_list_t * p_mlist,
        libvlc_media_t * p_md, int index,
        libvlc_exception_t * p_e );
286

287
void _libvlc_media_list_remove_index(
288 289
        libvlc_media_list_t * p_mlist, int index,
        libvlc_exception_t * p_e );
290

291
/* Media List View */
292
libvlc_media_list_view_t * libvlc_media_list_view_new(
293 294 295 296 297 298 299 300 301
        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 );

302
void libvlc_media_list_view_set_ml_notification_callback(
303 304 305 306
        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 *) );

307
void libvlc_media_list_view_will_delete_item(
308 309 310
        libvlc_media_list_view_t * p_mlv,
        libvlc_media_t * p_item, int index );

311
void libvlc_media_list_view_item_deleted(
312 313 314
        libvlc_media_list_view_t * p_mlv,
        libvlc_media_t * p_item, int index );

315
void libvlc_media_list_view_will_add_item (
316 317 318
        libvlc_media_list_view_t * p_mlv,
        libvlc_media_t * p_item, int index );

319
void libvlc_media_list_view_item_added(
320 321
        libvlc_media_list_view_t * p_mlv,
        libvlc_media_t * p_item, int index );
322

323
/* Events */
324
libvlc_event_manager_t * libvlc_event_manager_new(
325 326
        void * p_obj, libvlc_instance_t * p_libvlc_inst,
        libvlc_exception_t *p_e );
327

328
void libvlc_event_manager_release(
329
        libvlc_event_manager_t * p_em );
330

331
void libvlc_event_manager_register_event_type(
332 333 334
        libvlc_event_manager_t * p_em,
        libvlc_event_type_t event_type,
        libvlc_exception_t * p_e );
335

336
void libvlc_event_send(
337 338
        libvlc_event_manager_t * p_em,
        libvlc_event_t * p_event );
339

340 341 342 343 344 345
/* 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 );

346 347 348

/* Exception shorcuts */

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
349 350 351 352 353 354
#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; }
355 356

#endif