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 #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     /* This indicates if this media list is read-only
 119      * from a user point of view */
 120     vlc_bool_t                  b_read_only;
 121 };
 122
 123 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
 124
 125 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
 126         libvlc_exception_t * ) ;
 127
 128 typedef libvlc_media_descriptor_t *
 129         (*libvlc_media_list_view_item_at_index_func_t)(
 130                 libvlc_media_list_view_t * p_mlv,
 131                 int index,
 132                 libvlc_exception_t * ) ;
 133
 134 typedef libvlc_media_list_view_t *
 135         (*libvlc_media_list_view_children_at_index_func_t)(
 136                 libvlc_media_list_view_t * p_mlv,
 137                 int index,
 138                 libvlc_exception_t * ) ;
 139
 140 /* A way to see a media list */
 141 struct libvlc_media_list_view_t
 142 {
 143     libvlc_event_manager_t *    p_event_manager;
 144     libvlc_instance_t *         p_libvlc_instance;
 145     int                         i_refcount;
 146     vlc_mutex_t                 object_lock;
 147
 148     libvlc_media_list_t *       p_mlist;
 149
 150     struct libvlc_media_list_view_private_t * p_this_view_data;
 151
 152     /* Accessors */
 153     libvlc_media_list_view_count_func_t              pf_count;
 154     libvlc_media_list_view_item_at_index_func_t      pf_item_at_index;
 155     libvlc_media_list_view_children_at_index_func_t  pf_children_at_index;
 156
 157     libvlc_media_list_view_release_func_t            pf_release;
 158
 159     /* Notification callback */
 160     void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
 161     void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
 162 };
 163
 164 struct libvlc_dynamic_media_list_t
 165 {
 166     libvlc_instance_t *     p_libvlc_instance;
 167     int                     i_refcount;
 168     libvlc_media_list_t *   p_media_provider;
 169     libvlc_tag_query_t *    p_query;
 170     char *                  psz_tag_key;
 171     libvlc_tag_t            tag;
 172     struct libvlc_media_list_t *  p_mlist;
 173     struct libvlc_media_list_t *  p_provider;
 174 };
 175
 176 struct libvlc_media_instance_t
 177 {
 178     int                i_refcount;
 179     vlc_mutex_t        object_lock;
 180     int i_input_id;  /* Input object id. We don't use a pointer to
 181                         avoid any crash */
 182     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
 183     libvlc_media_descriptor_t * p_md; /* current media descriptor */
 184     libvlc_event_manager_t *    p_event_manager;
 185     libvlc_drawable_t           drawable;
 186
 187     vlc_bool_t        b_own_its_input_thread;
 188 };
 189
 190 struct libvlc_media_list_player_t
 191 {
 192     libvlc_event_manager_t *    p_event_manager;
 193     libvlc_instance_t *         p_libvlc_instance;
 194     int                         i_refcount;
 195     vlc_mutex_t                 object_lock;
 196     libvlc_media_list_path_t    current_playing_item_path;
 197     libvlc_media_descriptor_t * p_current_playing_item;
 198     libvlc_media_list_t *       p_mlist;
 199     libvlc_media_instance_t *   p_mi;
 200 };
 201
 202 struct libvlc_media_library_t
 203 {
 204     libvlc_event_manager_t * p_event_manager;
 205     libvlc_instance_t *      p_libvlc_instance;
 206     int                      i_refcount;
 207     libvlc_media_list_t *    p_mlist;
 208 };
 209
 210 struct libvlc_media_discoverer_t
 211 {
 212     libvlc_event_manager_t * p_event_manager;
 213     libvlc_instance_t *      p_libvlc_instance;
 214     services_discovery_t *   p_sd;
 215     libvlc_media_list_t *    p_mlist;
 216     vlc_bool_t               running;
 217 };
 218
 219 /*
 220  * Event Handling
 221  */
 222 /* Example usage
 223  *
 224  * struct libvlc_cool_object_t
 225  * {
 226  *        ...
 227  *        libvlc_event_manager_t * p_event_manager;
 228  *        ...
 229  * }
 230  *
 231  * libvlc_my_cool_object_new()
 232  * {
 233  *        ...
 234  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
 235  *                                                   p_self->p_libvlc_instance, p_e);
 236  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 237  *                libvlc_MyCoolObjectDidSomething, p_e)
 238  *        ...
 239  * }
 240  *
 241  * libvlc_my_cool_object_release()
 242  * {
 243  *         ...
 244  *         libvlc_event_manager_release( p_self->p_event_manager );
 245  *         ...
 246  * }
 247  *
 248  * libvlc_my_cool_object_do_something()
 249  * {
 250  *        ...
 251  *        libvlc_event_t event;
 252  *        event.type = libvlc_MyCoolObjectDidSomething;
 253  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 254  *        libvlc_event_send( p_self->p_event_manager, &event );
 255  * }
 256  * */
 257
 258 typedef struct libvlc_event_listener_t
 259 {
 260     libvlc_event_type_t event_type;
 261     void *              p_user_data;
 262     libvlc_callback_t   pf_callback;
 263 } libvlc_event_listener_t;
 264
 265 typedef struct libvlc_event_listeners_group_t
 266 {
 267     libvlc_event_type_t event_type;
 268     DECL_ARRAY(libvlc_event_listener_t *) listeners;
 269 } libvlc_event_listeners_group_t;
 270
 271 typedef struct libvlc_event_manager_t
 272 {
 273     void * p_obj;
 274     struct libvlc_instance_t * p_libvlc_instance;
 275     DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
 276     vlc_mutex_t object_lock;
 277     vlc_mutex_t event_sending_lock;
 278 } libvlc_event_sender_t;
 279
 280
 281 /***************************************************************************
 282  * Other internal functions
 283  ***************************************************************************/
 284 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
 285                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
 286
 287 /* Media instance */
 288 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
 289                         ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
 290
 291 VLC_EXPORT (void, libvlc_media_instance_destroy,
 292                         ( libvlc_media_instance_t * ) );
 293
 294 /* Media Descriptor */
 295 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
 296                         ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
 297
 298 VLC_EXPORT (void, libvlc_media_descriptor_set_state,
 299                         ( libvlc_media_descriptor_t *, libvlc_state_t, libvlc_exception_t * ) );
 300
 301 /* Media List */
 302 VLC_EXPORT ( void, _libvlc_media_list_add_media_descriptor,
 303                         ( libvlc_media_list_t * p_mlist,
 304                           libvlc_media_descriptor_t * p_md,
 305                           libvlc_exception_t * p_e ) );
 306
 307 VLC_EXPORT ( void, _libvlc_media_list_insert_media_descriptor,
 308                         ( libvlc_media_list_t * p_mlist,
 309                           libvlc_media_descriptor_t * p_md,
 310                           int index,
 311                           libvlc_exception_t * p_e ) );
 312
 313 VLC_EXPORT ( void, _libvlc_media_list_remove_index,
 314                         ( libvlc_media_list_t * p_mlist,
 315                           int index,
 316                           libvlc_exception_t * p_e ) );
 317
 318 /* Media List View */
 319 VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
 320                           ( libvlc_media_list_t * p_mlist,
 321                             libvlc_media_list_view_count_func_t pf_count,
 322                             libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
 323                             libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
 324                             libvlc_media_list_view_release_func_t pf_release,
 325                             void * this_view_data,
 326                             libvlc_exception_t * p_e ) );
 327
 328 VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
 329                 libvlc_media_list_view_t * p_mlv,
 330                 void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
 331                 void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) ));
 332
 333 VLC_EXPORT ( void, libvlc_media_list_view_will_delete_item, ( libvlc_media_list_view_t * p_mlv,
 334                                                               libvlc_media_descriptor_t * p_item,
 335                                                               int index ));
 336 VLC_EXPORT ( void, libvlc_media_list_view_item_deleted, ( libvlc_media_list_view_t * p_mlv,
 337                                                           libvlc_media_descriptor_t * p_item,
 338                                                           int index ));
 339 VLC_EXPORT ( void, libvlc_media_list_view_will_add_item, ( libvlc_media_list_view_t * p_mlv,
 340                                                            libvlc_media_descriptor_t * p_item,
 341                                                            int index ));
 342 VLC_EXPORT ( void, libvlc_media_list_view_item_added, ( libvlc_media_list_view_t * p_mlv,
 343                                                         libvlc_media_descriptor_t * p_item,
 344                                                         int index ));
 345
 346 /* Events */
 347 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
 348
 349 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
 350
 351 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 ) );
 352 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,
 353                                                     void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
 354
 355 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
 356
 357
 358 /* Exception shorcuts */
 359
 360 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 361                                 return NULL; }
 362 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 363                                 return; }
 364 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 365                                 return 0; }
 366
 367 # ifdef __cplusplus
 368 }
 369 # endif
 370
 371 #endif