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