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