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