libvlc_internal.h 14.2 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
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
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 HAVE_CONFIG_H
# include "config.h"
#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 38 39 40 41

# ifdef __cplusplus
extern "C" {
# endif

zorglub's avatar
zorglub committed
42 43 44
/***************************************************************************
 * Internal creation and destruction functions
 ***************************************************************************/
45
VLC_EXPORT (libvlc_int_t *, libvlc_InternalCreate, ( void ) );
46
VLC_EXPORT (int, libvlc_InternalInit, ( libvlc_int_t *, int, const char *ppsz_argv[] ) );
47 48
VLC_EXPORT (int, libvlc_InternalCleanup, ( libvlc_int_t * ) );
VLC_EXPORT (int, libvlc_InternalDestroy, ( libvlc_int_t *, vlc_bool_t ) );
zorglub's avatar
zorglub committed
49

50 51
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
52

53
VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *, libvlc_exception_t * ) );
54
VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t * ) );
55

56

zorglub's avatar
zorglub committed
57 58 59 60
/***************************************************************************
 * Opaque structures for libvlc API
 ***************************************************************************/

61 62
typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */

63 64 65 66 67 68
typedef enum libvlc_lock_state_t
{
    libvlc_Locked,
    libvlc_UnLocked
} libvlc_lock_state_t;

zorglub's avatar
zorglub committed
69 70
struct libvlc_instance_t
{
71
    libvlc_int_t *p_libvlc_int;
72 73
    vlm_t        *p_vlm;
    int           b_playlist_locked;
74
    unsigned      ref_count;
75
    vlc_mutex_t   instance_lock;
76
    vlc_mutex_t   event_callback_lock;
77
    struct libvlc_callback_entry_list_t *p_callback_list;
zorglub's avatar
zorglub committed
78 79
};

80 81 82 83 84 85
struct libvlc_tags_storage_t
{
    char ** ppsz_tags;
    int i_count;
};

86 87
struct libvlc_media_descriptor_t
{
88
    libvlc_event_manager_t * p_event_manager;
89 90
    int                b_preparsed;
    input_item_t      *p_input_item;
91
    int                i_refcount;
92
    libvlc_instance_t *p_libvlc_instance;
93
    vlc_dictionary_t   tags; /* To be merged with core's meta soon */
94
    libvlc_state_t     state;
95 96
    struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
                                           * Sub item */
97
    void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
98
};
99

100 101 102 103
struct libvlc_tag_query_t
{
    struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
    int                i_refcount;
104 105
    libvlc_tag_t       tag;
    char *             psz_tag_key;
106 107 108 109
};

struct libvlc_media_list_t
{
110 111 112 113 114 115
    libvlc_event_manager_t *    p_event_manager;
    libvlc_instance_t *         p_libvlc_instance;
    int                         i_refcount;
    vlc_mutex_t                 object_lock;
    libvlc_media_descriptor_t * p_md; /* The media_descriptor from which the
                                       * mlist comes, if any. */
116
    vlc_array_t                items;
117
 
118 119
    /* Other way to see that media list */
    /* Used in flat_media_list.c */
120
    libvlc_media_list_t *       p_flat_mlist;
121 122 123 124

    /* This indicates if this media list is read-only
     * from a user point of view */
    vlc_bool_t                  b_read_only;
125 126
};

127
typedef libvlc_media_list_view_t * (*libvlc_media_list_view_constructor_func_t)( libvlc_media_list_t * p_mlist, libvlc_exception_t * p_e ) ;
128
typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
129

130
typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
131 132 133 134
        libvlc_exception_t * ) ;

typedef libvlc_media_descriptor_t *
        (*libvlc_media_list_view_item_at_index_func_t)(
135 136 137 138 139 140 141
                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,
142 143 144
                int index,
                libvlc_exception_t * ) ;

145 146 147 148 149 150 151 152 153 154
/* 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;
    
    libvlc_media_list_t *       p_mlist;

155
    struct libvlc_media_list_view_private_t * p_this_view_data;
156 157

    /* Accessors */
158 159 160
    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;
161

162
    libvlc_media_list_view_constructor_func_t         pf_constructor;
163
    libvlc_media_list_view_release_func_t            pf_release;
164 165

    /* Notification callback */
166 167
    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 *);
168 169
};

170 171 172 173 174 175 176 177 178 179 180 181
struct libvlc_dynamic_media_list_t
{
    libvlc_instance_t *     p_libvlc_instance;
    int                     i_refcount;
    libvlc_media_list_t *   p_media_provider;
    libvlc_tag_query_t *    p_query;
    char *                  psz_tag_key;
    libvlc_tag_t            tag;
    struct libvlc_media_list_t *  p_mlist;
    struct libvlc_media_list_t *  p_provider;
};

182
struct libvlc_media_instance_t
zorglub's avatar
zorglub committed
183
{
184 185
    int                i_refcount;
    vlc_mutex_t        object_lock;
186 187
    int i_input_id;  /* Input object id. We don't use a pointer to
                        avoid any crash */
188 189 190 191
    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;
192 193
    
    vlc_bool_t        b_own_its_input_thread;
zorglub's avatar
zorglub committed
194 195
};

196 197
struct libvlc_media_list_player_t
{
198 199 200 201 202
    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;
203
    libvlc_media_descriptor_t * p_current_playing_item;
204 205
    libvlc_media_list_t *       p_mlist;
    libvlc_media_instance_t *   p_mi;
206 207
};

208 209 210 211 212 213 214 215
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;
};

216 217 218 219 220 221
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;
222
    vlc_bool_t               running;
223
    vlc_dictionary_t         catname_to_submedialist;
224
};
225

226
/*
227 228 229 230 231 232
 * Event Handling
 */
/* Example usage
 *
 * struct libvlc_cool_object_t
 * {
233 234 235
 *        ...
 *        libvlc_event_manager_t * p_event_manager;
 *        ...
236 237 238 239
 * }
 *
 * libvlc_my_cool_object_new()
 * {
240 241 242 243 244 245
 *        ...
 *        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)
 *        ...
246 247 248 249
 * }
 *
 * libvlc_my_cool_object_release()
 * {
250 251 252
 *         ...
 *         libvlc_event_manager_release( p_self->p_event_manager );
 *         ...
253 254 255 256
 * }
 *
 * libvlc_my_cool_object_do_something()
 * {
257 258 259 260 261
 *        ...
 *        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 );
262 263 264 265 266
 * }
 * */

typedef struct libvlc_event_listener_t
{
267 268 269
    libvlc_event_type_t event_type;
    void *              p_user_data;
    libvlc_callback_t   pf_callback;
270 271 272 273
} libvlc_event_listener_t;

typedef struct libvlc_event_listeners_group_t
{
274 275
    libvlc_event_type_t event_type;
    DECL_ARRAY(libvlc_event_listener_t *) listeners;
276 277 278 279
} libvlc_event_listeners_group_t;

typedef struct libvlc_event_manager_t
{
280 281 282
    void * p_obj;
    struct libvlc_instance_t * p_libvlc_instance;
    DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
283
    vlc_mutex_t object_lock;
284
    vlc_mutex_t event_sending_lock;
285 286 287
} libvlc_event_sender_t;


288 289 290 291
/***************************************************************************
 * Other internal functions
 ***************************************************************************/
VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
292 293
                        ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );

294
/* Media instance */
295
VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
296
                        ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
297

298 299 300
VLC_EXPORT (void, libvlc_media_instance_destroy,
                        ( libvlc_media_instance_t * ) );

301
/* Media Descriptor */
302
VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
303
                        ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
304

305 306 307
VLC_EXPORT (void, libvlc_media_descriptor_set_state,
                        ( libvlc_media_descriptor_t *, libvlc_state_t, libvlc_exception_t * ) );

308
/* Media List */
309 310 311 312 313
VLC_EXPORT ( void, _libvlc_media_list_add_media_descriptor,
                        ( libvlc_media_list_t * p_mlist,
                          libvlc_media_descriptor_t * p_md,
                          libvlc_exception_t * p_e ) );

314 315 316 317 318 319 320 321 322 323 324
VLC_EXPORT ( void, _libvlc_media_list_insert_media_descriptor,
                        ( libvlc_media_list_t * p_mlist,
                          libvlc_media_descriptor_t * p_md,
                          int index,
                          libvlc_exception_t * p_e ) );

VLC_EXPORT ( void, _libvlc_media_list_remove_index,
                        ( libvlc_media_list_t * p_mlist,
                          int index,
                          libvlc_exception_t * p_e ) );

325 326 327 328 329
/* Media List View */
VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
                          ( 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,
330
                            libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
331
                            libvlc_media_list_view_constructor_func_t pf_constructor,
332 333 334 335 336 337
                            libvlc_media_list_view_release_func_t pf_release,
                            void * this_view_data,
                            libvlc_exception_t * p_e ) );

VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
                libvlc_media_list_view_t * p_mlv,
338 339
                void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
                void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) ));
340

341 342 343 344 345 346 347 348 349 350 351 352 353
VLC_EXPORT ( void, libvlc_media_list_view_will_delete_item, ( libvlc_media_list_view_t * p_mlv,
                                                              libvlc_media_descriptor_t * p_item,
                                                              int index ));
VLC_EXPORT ( void, libvlc_media_list_view_item_deleted, ( libvlc_media_list_view_t * p_mlv,
                                                          libvlc_media_descriptor_t * p_item,
                                                          int index ));
VLC_EXPORT ( void, libvlc_media_list_view_will_add_item, ( libvlc_media_list_view_t * p_mlv,
                                                           libvlc_media_descriptor_t * p_item,
                                                           int index ));
VLC_EXPORT ( void, libvlc_media_list_view_item_added, ( libvlc_media_list_view_t * p_mlv,
                                                        libvlc_media_descriptor_t * p_item,
                                                        int index ));

354
/* Events */
355
VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
356 357 358 359

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 ) );
360 361
VLC_EXPORT (void, libvlc_event_detach_lock_state, ( libvlc_event_manager_t *p_event_manager, libvlc_event_type_t event_type, libvlc_callback_t pf_callback,
                                                    void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
362 363 364 365 366 367

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


/* Exception shorcuts */

zorglub's avatar
zorglub committed
368 369 370 371 372 373
#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; }
374 375 376 377 378 379

# ifdef __cplusplus
}
# endif

#endif