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     struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
  91                                            * Sub item */
  92     void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
  93 };
  94
  95 struct libvlc_tag_query_t
  96 {
  97     struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
  98     int                i_refcount;
  99     libvlc_tag_t       tag;
 100     char *             psz_tag_key;
 101 };
 102
 103 struct libvlc_media_list_t
 104 {
 105     libvlc_event_manager_t *    p_event_manager;
 106     libvlc_instance_t *         p_libvlc_instance;
 107     int                         i_refcount;
 108     vlc_mutex_t                 object_lock;
 109     libvlc_media_descriptor_t * p_md; /* The media_descriptor from which the
 110                                        * mlist comes, if any. */
 111     vlc_array_t                items;
 112
 113     /* Other way to see that media list */
 114     /* Used in flat_media_list.c */
 115     libvlc_media_list_t *       p_flat_mlist;
 116 };
 117
 118 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
 119
 120 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
 121         libvlc_exception_t * ) ;
 122
 123 typedef libvlc_media_descriptor_t *
 124         (*libvlc_media_list_view_item_at_index_func_t)(
 125                 libvlc_media_list_view_t * p_mlv,
 126                 int index,
 127                 libvlc_exception_t * ) ;
 128
 129 typedef libvlc_media_list_view_t *
 130         (*libvlc_media_list_view_children_at_index_func_t)(
 131                 libvlc_media_list_view_t * p_mlv,
 132                 int index,
 133                 libvlc_exception_t * ) ;
 134
 135 /* A way to see a media list */
 136 struct libvlc_media_list_view_t
 137 {
 138     libvlc_event_manager_t *    p_event_manager;
 139     libvlc_instance_t *         p_libvlc_instance;
 140     int                         i_refcount;
 141     vlc_mutex_t                 object_lock;
 142
 143     libvlc_media_list_t *       p_mlist;
 144
 145     struct libvlc_media_list_view_private_t * p_this_view_data;
 146
 147     /* Accessors */
 148     libvlc_media_list_view_count_func_t              pf_count;
 149     libvlc_media_list_view_item_at_index_func_t      pf_item_at_index;
 150     libvlc_media_list_view_children_at_index_func_t  pf_children_at_index;
 151
 152     libvlc_media_list_view_release_func_t            pf_release;
 153
 154     /* Notification callback */
 155     void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
 156     void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
 157 };
 158
 159 struct libvlc_dynamic_media_list_t
 160 {
 161     libvlc_instance_t *     p_libvlc_instance;
 162     int                     i_refcount;
 163     libvlc_media_list_t *   p_media_provider;
 164     libvlc_tag_query_t *    p_query;
 165     char *                  psz_tag_key;
 166     libvlc_tag_t            tag;
 167     struct libvlc_media_list_t *  p_mlist;
 168     struct libvlc_media_list_t *  p_provider;
 169 };
 170
 171 struct libvlc_media_instance_t
 172 {
 173     int                i_refcount;
 174     vlc_mutex_t        object_lock;
 175     int i_input_id;  /* Input object id. We don't use a pointer to
 176                         avoid any crash */
 177     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
 178     libvlc_media_descriptor_t * p_md; /* current media descriptor */
 179     libvlc_event_manager_t *    p_event_manager;
 180     libvlc_drawable_t           drawable;
 181
 182     vlc_bool_t        b_own_its_input_thread;
 183 };
 184
 185 struct libvlc_media_list_player_t
 186 {
 187     libvlc_event_manager_t *    p_event_manager;
 188     libvlc_instance_t *         p_libvlc_instance;
 189     int                         i_refcount;
 190     vlc_mutex_t                 object_lock;
 191     libvlc_media_list_path_t    current_playing_item_path;
 192     libvlc_media_descriptor_t * p_current_playing_item;
 193     libvlc_media_list_t *       p_mlist;
 194     libvlc_media_instance_t *   p_mi;
 195 };
 196
 197 struct libvlc_media_library_t
 198 {
 199     libvlc_event_manager_t * p_event_manager;
 200     libvlc_instance_t *      p_libvlc_instance;
 201     int                      i_refcount;
 202     libvlc_media_list_t *    p_mlist;
 203 };
 204
 205 struct libvlc_media_discoverer_t
 206 {
 207     libvlc_event_manager_t * p_event_manager;
 208     libvlc_instance_t *      p_libvlc_instance;
 209     services_discovery_t *   p_sd;
 210     libvlc_media_list_t *    p_mlist;
 211 };
 212
 213 /*
 214  * Event Handling
 215  */
 216 /* Example usage
 217  *
 218  * struct libvlc_cool_object_t
 219  * {
 220  *        ...
 221  *        libvlc_event_manager_t * p_event_manager;
 222  *        ...
 223  * }
 224  *
 225  * libvlc_my_cool_object_new()
 226  * {
 227  *        ...
 228  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
 229  *                                                   p_self->p_libvlc_instance, p_e);
 230  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 231  *                libvlc_MyCoolObjectDidSomething, p_e)
 232  *        ...
 233  * }
 234  *
 235  * libvlc_my_cool_object_release()
 236  * {
 237  *         ...
 238  *         libvlc_event_manager_release( p_self->p_event_manager );
 239  *         ...
 240  * }
 241  *
 242  * libvlc_my_cool_object_do_something()
 243  * {
 244  *        ...
 245  *        libvlc_event_t event;
 246  *        event.type = libvlc_MyCoolObjectDidSomething;
 247  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 248  *        libvlc_event_send( p_self->p_event_manager, &event );
 249  * }
 250  * */
 251
 252 typedef struct libvlc_event_listener_t
 253 {
 254     libvlc_event_type_t event_type;
 255     void *              p_user_data;
 256     libvlc_callback_t   pf_callback;
 257 } libvlc_event_listener_t;
 258
 259 typedef struct libvlc_event_listeners_group_t
 260 {
 261     libvlc_event_type_t event_type;
 262     DECL_ARRAY(libvlc_event_listener_t *) listeners;
 263 } libvlc_event_listeners_group_t;
 264
 265 typedef struct libvlc_event_manager_t
 266 {
 267     void * p_obj;
 268     struct libvlc_instance_t * p_libvlc_instance;
 269     DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
 270     vlc_mutex_t object_lock;
 271     vlc_mutex_t event_sending_lock;
 272 } libvlc_event_sender_t;
 273
 274
 275 /***************************************************************************
 276  * Other internal functions
 277  ***************************************************************************/
 278 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
 279                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
 280
 281 /* Media instance */
 282 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
 283                         ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
 284
 285 VLC_EXPORT (void, libvlc_media_instance_destroy,
 286                         ( libvlc_media_instance_t * ) );
 287
 288 /* Media Descriptor */
 289 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
 290                         ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
 291
 292 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
 293                         ( libvlc_media_descriptor_t * ) );
 294
 295 /* Media List View */
 296 VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
 297                           ( libvlc_media_list_t * p_mlist,
 298                             libvlc_media_list_view_count_func_t pf_count,
 299                             libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
 300                             libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
 301                             libvlc_media_list_view_release_func_t pf_release,
 302                             void * this_view_data,
 303                             libvlc_exception_t * p_e ) );
 304
 305 VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
 306                 libvlc_media_list_view_t * p_mlv,
 307                 void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
 308                 void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) ));
 309
 310 /* Events */
 311 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
 312
 313 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
 314
 315 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 ) );
 316 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,
 317                                                     void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
 318
 319 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
 320
 321
 322 /* Exception shorcuts */
 323
 324 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 325                                 return NULL; }
 326 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 327                                 return; }
 328 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 329                                 return 0; }
 330
 331 # ifdef __cplusplus
 332 }
 333 # endif
 334
 335 #endif