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_list_player_t
 168 {
 169     libvlc_event_manager_t *    p_event_manager;
 170     libvlc_instance_t *         p_libvlc_instance;
 171     unsigned                    i_refcount;
 172     vlc_mutex_t                 object_lock;
 173     libvlc_media_list_path_t    current_playing_item_path;
 174     libvlc_media_t *            p_current_playing_item;
 175     libvlc_media_list_t *       p_mlist;
 176     libvlc_media_player_t *     p_mi;
 177 };
 178
 179 struct libvlc_media_library_t
 180 {
 181     libvlc_event_manager_t * p_event_manager;
 182     libvlc_instance_t *      p_libvlc_instance;
 183     int                      i_refcount;
 184     libvlc_media_list_t *    p_mlist;
 185 };
 186
 187 struct libvlc_media_discoverer_t
 188 {
 189     libvlc_event_manager_t * p_event_manager;
 190     libvlc_instance_t *      p_libvlc_instance;
 191     services_discovery_t *   p_sd;
 192     libvlc_media_list_t *    p_mlist;
 193     bool                     running;
 194     vlc_dictionary_t         catname_to_submedialist;
 195 };
 196
 197 /*
 198  * Event Handling
 199  */
 200 /* Example usage
 201  *
 202  * struct libvlc_cool_object_t
 203  * {
 204  *        ...
 205  *        libvlc_event_manager_t * p_event_manager;
 206  *        ...
 207  * }
 208  *
 209  * libvlc_my_cool_object_new()
 210  * {
 211  *        ...
 212  *        p_self->p_event_manager = libvlc_event_manager_new( p_self,
 213  *                                                   p_self->p_libvlc_instance, p_e);
 214  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 215  *                libvlc_MyCoolObjectDidSomething, p_e)
 216  *        ...
 217  * }
 218  *
 219  * libvlc_my_cool_object_release()
 220  * {
 221  *         ...
 222  *         libvlc_event_manager_release( p_self->p_event_manager );
 223  *         ...
 224  * }
 225  *
 226  * libvlc_my_cool_object_do_something()
 227  * {
 228  *        ...
 229  *        libvlc_event_t event;
 230  *        event.type = libvlc_MyCoolObjectDidSomething;
 231  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 232  *        libvlc_event_send( p_self->p_event_manager, &event );
 233  * }
 234  * */
 235
 236 typedef struct libvlc_event_listener_t
 237 {
 238     libvlc_event_type_t event_type;
 239     void *              p_user_data;
 240     libvlc_callback_t   pf_callback;
 241 } libvlc_event_listener_t;
 242
 243 typedef struct libvlc_event_listeners_group_t
 244 {
 245     libvlc_event_type_t event_type;
 246     vlc_array_t listeners;
 247     bool b_sublistener_removed;
 248 } libvlc_event_listeners_group_t;
 249
 250 typedef struct libvlc_event_manager_t
 251 {
 252     void * p_obj;
 253     struct libvlc_instance_t * p_libvlc_instance;
 254     vlc_array_t listeners_groups;
 255     vlc_mutex_t object_lock;
 256     vlc_mutex_t event_sending_lock;
 257 } libvlc_event_sender_t;
 258
 259
 260 /***************************************************************************
 261  * Other internal functions
 262  ***************************************************************************/
 263 input_thread_t *libvlc_get_input_thread(
 264      libvlc_media_player_t *,
 265     libvlc_exception_t * );
 266
 267 /* Media Descriptor */
 268 libvlc_media_t * libvlc_media_new_from_input_item(
 269         libvlc_instance_t *, input_item_t *,
 270         libvlc_exception_t * );
 271
 272 void libvlc_media_set_state(
 273         libvlc_media_t *, libvlc_state_t,
 274         libvlc_exception_t * );
 275
 276 /* Media List */
 277 void _libvlc_media_list_add_media(
 278         libvlc_media_list_t * p_mlist,
 279         libvlc_media_t * p_md,
 280         libvlc_exception_t * p_e );
 281
 282 void _libvlc_media_list_insert_media(
 283         libvlc_media_list_t * p_mlist,
 284         libvlc_media_t * p_md, int index,
 285         libvlc_exception_t * p_e );
 286
 287 void _libvlc_media_list_remove_index(
 288         libvlc_media_list_t * p_mlist, int index,
 289         libvlc_exception_t * p_e );
 290
 291 /* Media List View */
 292 libvlc_media_list_view_t * libvlc_media_list_view_new(
 293         libvlc_media_list_t * p_mlist,
 294         libvlc_media_list_view_count_func_t pf_count,
 295         libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
 296         libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
 297         libvlc_media_list_view_constructor_func_t pf_constructor,
 298         libvlc_media_list_view_release_func_t pf_release,
 299         void * this_view_data,
 300         libvlc_exception_t * p_e );
 301
 302 void libvlc_media_list_view_set_ml_notification_callback(
 303         libvlc_media_list_view_t * p_mlv,
 304         void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
 305         void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) );
 306
 307 void libvlc_media_list_view_will_delete_item(
 308         libvlc_media_list_view_t * p_mlv,
 309         libvlc_media_t * p_item, int index );
 310
 311 void libvlc_media_list_view_item_deleted(
 312         libvlc_media_list_view_t * p_mlv,
 313         libvlc_media_t * p_item, int index );
 314
 315 void libvlc_media_list_view_will_add_item (
 316         libvlc_media_list_view_t * p_mlv,
 317         libvlc_media_t * p_item, int index );
 318
 319 void libvlc_media_list_view_item_added(
 320         libvlc_media_list_view_t * p_mlv,
 321         libvlc_media_t * p_item, int index );
 322
 323 /* Events */
 324 libvlc_event_manager_t * libvlc_event_manager_new(
 325         void * p_obj, libvlc_instance_t * p_libvlc_inst,
 326         libvlc_exception_t *p_e );
 327
 328 void libvlc_event_manager_release(
 329         libvlc_event_manager_t * p_em );
 330
 331 void libvlc_event_manager_register_event_type(
 332         libvlc_event_manager_t * p_em,
 333         libvlc_event_type_t event_type,
 334         libvlc_exception_t * p_e );
 335
 336 void libvlc_event_send(
 337         libvlc_event_manager_t * p_em,
 338         libvlc_event_t * p_event );
 339
 340 /* Media player - audio, video */
 341 libvlc_track_description_t * libvlc_get_track_description(
 342         libvlc_media_player_t *p_mi,
 343         const char *psz_variable,
 344         libvlc_exception_t *p_e );
 345
 346
 347 /* Exception shorcuts */
 348
 349 #define RAISENULL( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
 350                            return NULL; }
 351 #define RAISEVOID( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
 352                            return; }
 353 #define RAISEZERO( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
 354                            return 0; }
 355
 356 #endif