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: control_structures.h 13752 2005-12-15 10:14:42Z oaubert $
   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 #include <vlc/vlc.h>
  29 #include <vlc/libvlc_structures.h>
  30
  31 #include <vlc_arrays.h>
  32 #include <vlc_input.h>
  33
  34 # ifdef __cplusplus
  35 extern "C" {
  36 # endif
  37
  38 /***************************************************************************
  39  * Internal creation and destruction functions
  40  ***************************************************************************/
  41 VLC_EXPORT (libvlc_int_t *, libvlc_InternalCreate, ( void ) );
  42 VLC_EXPORT (int, libvlc_InternalInit, ( libvlc_int_t *, int, const char *ppsz_argv[] ) );
  43 VLC_EXPORT (int, libvlc_InternalCleanup, ( libvlc_int_t * ) );
  44 VLC_EXPORT (int, libvlc_InternalDestroy, ( libvlc_int_t *, vlc_bool_t ) );
  45
  46 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, vlc_bool_t,
  47                             vlc_bool_t, int, const char *const * ) );
  48
  49 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *, libvlc_exception_t * ) );
  50 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t * ) );
  51
  52
  53 /***************************************************************************
  54  * Opaque structures for libvlc API
  55  ***************************************************************************/
  56
  57 typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */
  58
  59 typedef enum libvlc_lock_state_t
  60 {
  61     libvlc_Locked,
  62     libvlc_UnLocked
  63 } libvlc_lock_state_t;
  64
  65 struct libvlc_instance_t
  66 {
  67     libvlc_int_t *p_libvlc_int;
  68     vlm_t        *p_vlm;
  69     int           b_playlist_locked;
  70     unsigned      ref_count;
  71     vlc_mutex_t   instance_lock;
  72     vlc_mutex_t   event_callback_lock;
  73     struct libvlc_callback_entry_list_t *p_callback_list;
  74 };
  75
  76 struct libvlc_tags_storage_t
  77 {
  78     char ** ppsz_tags;
  79     int i_count;
  80 };
  81
  82 struct libvlc_media_descriptor_t
  83 {
  84     libvlc_event_manager_t * p_event_manager;
  85     int                b_preparsed;
  86     input_item_t      *p_input_item;
  87     int                i_refcount;
  88     libvlc_instance_t *p_libvlc_instance;
  89     vlc_dictionary_t   tags; /* To be merged with core's meta soon */
  90     libvlc_state_t     state;
  91     struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
  92                                            * Sub item */
  93     void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
  94 };
  95
  96 struct libvlc_tag_query_t
  97 {
  98     struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
  99     int                i_refcount;
 100     libvlc_tag_t       tag;
 101     char *             psz_tag_key;
 102 };
 103
 104 struct libvlc_media_list_t
 105 {
 106     libvlc_event_manager_t *    p_event_manager;
 107     libvlc_instance_t *         p_libvlc_instance;
 108     int                         i_refcount;
 109     vlc_mutex_t                 object_lock;
 110     libvlc_media_descriptor_t * p_md; /* The media_descriptor from which the
 111                                        * mlist comes, if any. */
 112     vlc_array_t                items;
 113
 114     /* Other way to see that media list */
 115     /* Used in flat_media_list.c */
 116     libvlc_media_list_t *       p_flat_mlist;
 117 };
 118
 119 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
 120
 121 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
 122         libvlc_exception_t * ) ;
 123
 124 typedef libvlc_media_descriptor_t *
 125         (*libvlc_media_list_view_item_at_index_func_t)(
 126                 libvlc_media_list_view_t * p_mlv,
 127                 int index,
 128                 libvlc_exception_t * ) ;
 129
 130 typedef libvlc_media_list_view_t *
 131         (*libvlc_media_list_view_children_at_index_func_t)(
 132                 libvlc_media_list_view_t * p_mlv,
 133                 int index,
 134                 libvlc_exception_t * ) ;
 135
 136 /* A way to see a media list */
 137 struct libvlc_media_list_view_t
 138 {
 139     libvlc_event_manager_t *    p_event_manager;
 140     libvlc_instance_t *         p_libvlc_instance;
 141     int                         i_refcount;
 142     vlc_mutex_t                 object_lock;
 143
 144     libvlc_media_list_t *       p_mlist;
 145
 146     struct libvlc_media_list_view_private_t * p_this_view_data;
 147
 148     /* Accessors */
 149     libvlc_media_list_view_count_func_t              pf_count;
 150     libvlc_media_list_view_item_at_index_func_t      pf_item_at_index;
 151     libvlc_media_list_view_children_at_index_func_t  pf_children_at_index;
 152
 153     libvlc_media_list_view_release_func_t            pf_release;
 154
 155     /* Notification callback */
 156     void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
 157     void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
 158 };
 159
 160 struct libvlc_dynamic_media_list_t
 161 {
 162     libvlc_instance_t *     p_libvlc_instance;
 163     int                     i_refcount;
 164     libvlc_media_list_t *   p_media_provider;
 165     libvlc_tag_query_t *    p_query;
 166     char *                  psz_tag_key;
 167     libvlc_tag_t            tag;
 168     struct libvlc_media_list_t *  p_mlist;
 169     struct libvlc_media_list_t *  p_provider;
 170 };
 171
 172 struct libvlc_media_instance_t
 173 {
 174     int                i_refcount;
 175     vlc_mutex_t        object_lock;
 176     int i_input_id;  /* Input object id. We don't use a pointer to
 177                         avoid any crash */
 178     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
 179     libvlc_media_descriptor_t * p_md; /* current media descriptor */
 180     libvlc_event_manager_t *    p_event_manager;
 181     libvlc_drawable_t           drawable;
 182
 183     vlc_bool_t        b_own_its_input_thread;
 184 };
 185
 186 struct libvlc_media_list_player_t
 187 {
 188     libvlc_event_manager_t *    p_event_manager;
 189     libvlc_instance_t *         p_libvlc_instance;
 190     int                         i_refcount;
 191     vlc_mutex_t                 object_lock;
 192     libvlc_media_list_path_t    current_playing_item_path;
 193     libvlc_media_descriptor_t * p_current_playing_item;
 194     libvlc_media_list_t *       p_mlist;
 195     libvlc_media_instance_t *   p_mi;
 196 };
 197
 198 struct libvlc_media_library_t
 199 {
 200     libvlc_event_manager_t * p_event_manager;
 201     libvlc_instance_t *      p_libvlc_instance;
 202     int                      i_refcount;
 203     libvlc_media_list_t *    p_mlist;
 204 };
 205
 206 struct libvlc_media_discoverer_t
 207 {
 208     libvlc_event_manager_t * p_event_manager;
 209     libvlc_instance_t *      p_libvlc_instance;
 210     services_discovery_t *   p_sd;
 211     libvlc_media_list_t *    p_mlist;
 212 };
 213
 214 /*
 215  * Event Handling
 216  */
 217 /* Example usage
 218  *
 219  * struct libvlc_cool_object_t
 220  * {
 221  *        ...
 222  *        libvlc_event_manager_t * p_event_manager;
 223  *        ...
 224  * }
 225  *
 226  * libvlc_my_cool_object_new()
 227  * {
 228  *        ...
 229  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
 230  *                                                   p_self->p_libvlc_instance, p_e);
 231  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 232  *                libvlc_MyCoolObjectDidSomething, p_e)
 233  *        ...
 234  * }
 235  *
 236  * libvlc_my_cool_object_release()
 237  * {
 238  *         ...
 239  *         libvlc_event_manager_release( p_self->p_event_manager );
 240  *         ...
 241  * }
 242  *
 243  * libvlc_my_cool_object_do_something()
 244  * {
 245  *        ...
 246  *        libvlc_event_t event;
 247  *        event.type = libvlc_MyCoolObjectDidSomething;
 248  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 249  *        libvlc_event_send( p_self->p_event_manager, &event );
 250  * }
 251  * */
 252
 253 typedef struct libvlc_event_listener_t
 254 {
 255     libvlc_event_type_t event_type;
 256     void *              p_user_data;
 257     libvlc_callback_t   pf_callback;
 258 } libvlc_event_listener_t;
 259
 260 typedef struct libvlc_event_listeners_group_t
 261 {
 262     libvlc_event_type_t event_type;
 263     DECL_ARRAY(libvlc_event_listener_t *) listeners;
 264 } libvlc_event_listeners_group_t;
 265
 266 typedef struct libvlc_event_manager_t
 267 {
 268     void * p_obj;
 269     struct libvlc_instance_t * p_libvlc_instance;
 270     DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
 271     vlc_mutex_t object_lock;
 272     vlc_mutex_t event_sending_lock;
 273 } libvlc_event_sender_t;
 274
 275
 276 /***************************************************************************
 277  * Other internal functions
 278  ***************************************************************************/
 279 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
 280                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
 281
 282 /* Media instance */
 283 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
 284                         ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
 285
 286 VLC_EXPORT (void, libvlc_media_instance_destroy,
 287                         ( libvlc_media_instance_t * ) );
 288
 289 /* Media Descriptor */
 290 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
 291                         ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
 292
 293 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
 294                         ( libvlc_media_descriptor_t * ) );
 295
 296 VLC_EXPORT (void, libvlc_media_descriptor_set_state,
 297                         ( libvlc_media_descriptor_t *, libvlc_state_t, libvlc_exception_t * ) );
 298
 299 /* Media List View */
 300 VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
 301                           ( libvlc_media_list_t * p_mlist,
 302                             libvlc_media_list_view_count_func_t pf_count,
 303                             libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
 304                             libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
 305                             libvlc_media_list_view_release_func_t pf_release,
 306                             void * this_view_data,
 307                             libvlc_exception_t * p_e ) );
 308
 309 VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
 310                 libvlc_media_list_view_t * p_mlv,
 311                 void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
 312                 void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) ));
 313
 314 VLC_EXPORT ( void, libvlc_media_list_view_will_delete_item, ( libvlc_media_list_view_t * p_mlv,
 315                                                               libvlc_media_descriptor_t * p_item,
 316                                                               int index ));
 317 VLC_EXPORT ( void, libvlc_media_list_view_item_deleted, ( libvlc_media_list_view_t * p_mlv,
 318                                                           libvlc_media_descriptor_t * p_item,
 319                                                           int index ));
 320 VLC_EXPORT ( void, libvlc_media_list_view_will_add_item, ( libvlc_media_list_view_t * p_mlv,
 321                                                            libvlc_media_descriptor_t * p_item,
 322                                                            int index ));
 323 VLC_EXPORT ( void, libvlc_media_list_view_item_added, ( libvlc_media_list_view_t * p_mlv,
 324                                                         libvlc_media_descriptor_t * p_item,
 325                                                         int index ));
 326
 327 /* Events */
 328 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
 329
 330 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
 331
 332 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 ) );
 333 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,
 334                                                     void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
 335
 336 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
 337
 338
 339 /* Exception shorcuts */
 340
 341 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 342                                 return NULL; }
 343 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 344                                 return; }
 345 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 346                                 return 0; }
 347
 348 # ifdef __cplusplus
 349 }
 350 # endif
 351
 352 #endif