git.sesse.net Git - vlc/blob - src/control/libvlc_internal.h

   1 /*****************************************************************************
   2  * libvlc_internal.h : Definition of opaque structures for libvlc exported API
   3  * Also contains some internal utility functions
   4  *****************************************************************************
   5  * Copyright (C) 2005 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Clément Stenac <zorglub@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef _LIBVLC_INTERNAL_H
  26 #define _LIBVLC_INTERNAL_H 1
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc/libvlc_structures.h>
  34
  35 #include <vlc_arrays.h>
  36 #include <vlc_input.h>
  37
  38 # ifdef __cplusplus
  39 extern "C" {
  40 # endif
  41
  42 /***************************************************************************
  43  * Internal creation and destruction functions
  44  ***************************************************************************/
  45 VLC_EXPORT (libvlc_int_t *, libvlc_InternalCreate, ( void ) );
  46 VLC_EXPORT (int, libvlc_InternalInit, ( libvlc_int_t *, int, const char *ppsz_argv[] ) );
  47 VLC_EXPORT (int, libvlc_InternalCleanup, ( libvlc_int_t * ) );
  48 VLC_EXPORT (int, libvlc_InternalDestroy, ( libvlc_int_t *, vlc_bool_t ) );
  49
  50 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, vlc_bool_t,
  51                             vlc_bool_t, int, const char *const * ) );
  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
  57 /***************************************************************************
  58  * Opaque structures for libvlc API
  59  ***************************************************************************/
  60
  61 typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */
  62
  63 typedef enum libvlc_lock_state_t
  64 {
  65     libvlc_Locked,
  66     libvlc_UnLocked
  67 } libvlc_lock_state_t;
  68
  69 struct libvlc_instance_t
  70 {
  71     libvlc_int_t *p_libvlc_int;
  72     vlm_t        *p_vlm;
  73     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;
  78 };
  79
  80 struct libvlc_tags_storage_t
  81 {
  82     char ** ppsz_tags;
  83     int i_count;
  84 };
  85
  86 struct libvlc_media_descriptor_t
  87 {
  88     libvlc_event_manager_t * p_event_manager;
  89     int                b_preparsed;
  90     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     struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
  96                                            * 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 struct libvlc_tag_query_t
 101 {
 102     struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
 103     int                i_refcount;
 104     libvlc_tag_t       tag;
 105     char *             psz_tag_key;
 106 };
 107
 108 struct libvlc_media_list_t
 109 {
 110     libvlc_event_manager_t *    p_event_manager;
 111     libvlc_instance_t *         p_libvlc_instance;
 112     int                         i_refcount;
 113     vlc_mutex_t                 object_lock;
 114     libvlc_media_descriptor_t * p_md; /* The media_descriptor from which the
 115                                        * mlist comes, if any. */
 116     vlc_array_t                items;
 117
 118     /* Other way to see that media list */
 119     /* Used in flat_media_list.c */
 120     libvlc_media_list_t *       p_flat_mlist;
 121
 122     /* This indicates if this media list is read-only
 123      * from a user point of view */
 124     vlc_bool_t                  b_read_only;
 125 };
 126
 127 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
 128
 129 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
 130         libvlc_exception_t * ) ;
 131
 132 typedef libvlc_media_descriptor_t *
 133         (*libvlc_media_list_view_item_at_index_func_t)(
 134                 libvlc_media_list_view_t * p_mlv,
 135                 int index,
 136                 libvlc_exception_t * ) ;
 137
 138 typedef libvlc_media_list_view_t *
 139         (*libvlc_media_list_view_children_at_index_func_t)(
 140                 libvlc_media_list_view_t * p_mlv,
 141                 int index,
 142                 libvlc_exception_t * ) ;
 143
 144 /* A way to see a media list */
 145 struct libvlc_media_list_view_t
 146 {
 147     libvlc_event_manager_t *    p_event_manager;
 148     libvlc_instance_t *         p_libvlc_instance;
 149     int                         i_refcount;
 150     vlc_mutex_t                 object_lock;
 151
 152     libvlc_media_list_t *       p_mlist;
 153
 154     struct libvlc_media_list_view_private_t * p_this_view_data;
 155
 156     /* Accessors */
 157     libvlc_media_list_view_count_func_t              pf_count;
 158     libvlc_media_list_view_item_at_index_func_t      pf_item_at_index;
 159     libvlc_media_list_view_children_at_index_func_t  pf_children_at_index;
 160
 161     libvlc_media_list_view_release_func_t            pf_release;
 162
 163     /* Notification callback */
 164     void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
 165     void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
 166 };
 167
 168 struct libvlc_dynamic_media_list_t
 169 {
 170     libvlc_instance_t *     p_libvlc_instance;
 171     int                     i_refcount;
 172     libvlc_media_list_t *   p_media_provider;
 173     libvlc_tag_query_t *    p_query;
 174     char *                  psz_tag_key;
 175     libvlc_tag_t            tag;
 176     struct libvlc_media_list_t *  p_mlist;
 177     struct libvlc_media_list_t *  p_provider;
 178 };
 179
 180 struct libvlc_media_instance_t
 181 {
 182     int                i_refcount;
 183     vlc_mutex_t        object_lock;
 184     int i_input_id;  /* Input object id. We don't use a pointer to
 185                         avoid any crash */
 186     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
 187     libvlc_media_descriptor_t * p_md; /* current media descriptor */
 188     libvlc_event_manager_t *    p_event_manager;
 189     libvlc_drawable_t           drawable;
 190
 191     vlc_bool_t        b_own_its_input_thread;
 192 };
 193
 194 struct libvlc_media_list_player_t
 195 {
 196     libvlc_event_manager_t *    p_event_manager;
 197     libvlc_instance_t *         p_libvlc_instance;
 198     int                         i_refcount;
 199     vlc_mutex_t                 object_lock;
 200     libvlc_media_list_path_t    current_playing_item_path;
 201     libvlc_media_descriptor_t * p_current_playing_item;
 202     libvlc_media_list_t *       p_mlist;
 203     libvlc_media_instance_t *   p_mi;
 204 };
 205
 206 struct libvlc_media_library_t
 207 {
 208     libvlc_event_manager_t * p_event_manager;
 209     libvlc_instance_t *      p_libvlc_instance;
 210     int                      i_refcount;
 211     libvlc_media_list_t *    p_mlist;
 212 };
 213
 214 struct libvlc_media_discoverer_t
 215 {
 216     libvlc_event_manager_t * p_event_manager;
 217     libvlc_instance_t *      p_libvlc_instance;
 218     services_discovery_t *   p_sd;
 219     libvlc_media_list_t *    p_mlist;
 220     vlc_bool_t               running;
 221     vlc_dictionary_t         catname_to_submedialist;
 222 };
 223
 224 /*
 225  * Event Handling
 226  */
 227 /* Example usage
 228  *
 229  * struct libvlc_cool_object_t
 230  * {
 231  *        ...
 232  *        libvlc_event_manager_t * p_event_manager;
 233  *        ...
 234  * }
 235  *
 236  * libvlc_my_cool_object_new()
 237  * {
 238  *        ...
 239  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
 240  *                                                   p_self->p_libvlc_instance, p_e);
 241  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 242  *                libvlc_MyCoolObjectDidSomething, p_e)
 243  *        ...
 244  * }
 245  *
 246  * libvlc_my_cool_object_release()
 247  * {
 248  *         ...
 249  *         libvlc_event_manager_release( p_self->p_event_manager );
 250  *         ...
 251  * }
 252  *
 253  * libvlc_my_cool_object_do_something()
 254  * {
 255  *        ...
 256  *        libvlc_event_t event;
 257  *        event.type = libvlc_MyCoolObjectDidSomething;
 258  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 259  *        libvlc_event_send( p_self->p_event_manager, &event );
 260  * }
 261  * */
 262
 263 typedef struct libvlc_event_listener_t
 264 {
 265     libvlc_event_type_t event_type;
 266     void *              p_user_data;
 267     libvlc_callback_t   pf_callback;
 268 } libvlc_event_listener_t;
 269
 270 typedef struct libvlc_event_listeners_group_t
 271 {
 272     libvlc_event_type_t event_type;
 273     DECL_ARRAY(libvlc_event_listener_t *) listeners;
 274 } libvlc_event_listeners_group_t;
 275
 276 typedef struct libvlc_event_manager_t
 277 {
 278     void * p_obj;
 279     struct libvlc_instance_t * p_libvlc_instance;
 280     DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
 281     vlc_mutex_t object_lock;
 282     vlc_mutex_t event_sending_lock;
 283 } libvlc_event_sender_t;
 284
 285
 286 /***************************************************************************
 287  * Other internal functions
 288  ***************************************************************************/
 289 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
 290                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
 291
 292 /* Media instance */
 293 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
 294                         ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
 295
 296 VLC_EXPORT (void, libvlc_media_instance_destroy,
 297                         ( libvlc_media_instance_t * ) );
 298
 299 /* Media Descriptor */
 300 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
 301                         ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
 302
 303 VLC_EXPORT (void, libvlc_media_descriptor_set_state,
 304                         ( libvlc_media_descriptor_t *, libvlc_state_t, libvlc_exception_t * ) );
 305
 306 /* Media List */
 307 VLC_EXPORT ( void, _libvlc_media_list_add_media_descriptor,
 308                         ( libvlc_media_list_t * p_mlist,
 309                           libvlc_media_descriptor_t * p_md,
 310                           libvlc_exception_t * p_e ) );
 311
 312 VLC_EXPORT ( void, _libvlc_media_list_insert_media_descriptor,
 313                         ( libvlc_media_list_t * p_mlist,
 314                           libvlc_media_descriptor_t * p_md,
 315                           int index,
 316                           libvlc_exception_t * p_e ) );
 317
 318 VLC_EXPORT ( void, _libvlc_media_list_remove_index,
 319                         ( libvlc_media_list_t * p_mlist,
 320                           int index,
 321                           libvlc_exception_t * p_e ) );
 322
 323 /* Media List View */
 324 VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
 325                           ( libvlc_media_list_t * p_mlist,
 326                             libvlc_media_list_view_count_func_t pf_count,
 327                             libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
 328                             libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
 329                             libvlc_media_list_view_release_func_t pf_release,
 330                             void * this_view_data,
 331                             libvlc_exception_t * p_e ) );
 332
 333 VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
 334                 libvlc_media_list_view_t * p_mlv,
 335                 void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
 336                 void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) ));
 337
 338 VLC_EXPORT ( void, libvlc_media_list_view_will_delete_item, ( libvlc_media_list_view_t * p_mlv,
 339                                                               libvlc_media_descriptor_t * p_item,
 340                                                               int index ));
 341 VLC_EXPORT ( void, libvlc_media_list_view_item_deleted, ( libvlc_media_list_view_t * p_mlv,
 342                                                           libvlc_media_descriptor_t * p_item,
 343                                                           int index ));
 344 VLC_EXPORT ( void, libvlc_media_list_view_will_add_item, ( libvlc_media_list_view_t * p_mlv,
 345                                                            libvlc_media_descriptor_t * p_item,
 346                                                            int index ));
 347 VLC_EXPORT ( void, libvlc_media_list_view_item_added, ( libvlc_media_list_view_t * p_mlv,
 348                                                         libvlc_media_descriptor_t * p_item,
 349                                                         int index ));
 350
 351 /* Events */
 352 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
 353
 354 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
 355
 356 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 ) );
 357 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,
 358                                                     void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
 359
 360 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
 361
 362
 363 /* Exception shorcuts */
 364
 365 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 366                                 return NULL; }
 367 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 368                                 return; }
 369 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 370                                 return 0; }
 371
 372 # ifdef __cplusplus
 373 }
 374 # endif
 375
 376 #endif