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$
   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_arrays.h>
  36 #include <vlc_input.h>
  37
  38 # ifdef __cplusplus
  39 extern "C" {
  40 # endif
  41
  42 /***************************************************************************
  43  * Internal creation and destruction functions
  44  ***************************************************************************/
  45 VLC_EXPORT (libvlc_int_t *, libvlc_InternalCreate, ( void ) );
  46 VLC_EXPORT (int, libvlc_InternalInit, ( libvlc_int_t *, int, const char *ppsz_argv[] ) );
  47 VLC_EXPORT (int, libvlc_InternalCleanup, ( libvlc_int_t * ) );
  48 VLC_EXPORT (int, libvlc_InternalDestroy, ( libvlc_int_t *, bool ) );
  49
  50 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, bool ) );
  51
  52 /***************************************************************************
  53  * Opaque structures for libvlc API
  54  ***************************************************************************/
  55
  56 typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */
  57
  58 typedef enum libvlc_lock_state_t
  59 {
  60     libvlc_Locked,
  61     libvlc_UnLocked
  62 } libvlc_lock_state_t;
  63
  64 struct libvlc_instance_t
  65 {
  66     libvlc_int_t *p_libvlc_int;
  67     vlm_t        *p_vlm;
  68     int           b_playlist_locked;
  69     unsigned      ref_count;
  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_media_t
  76 {
  77     libvlc_event_manager_t * p_event_manager;
  78     int                b_preparsed;
  79     input_item_t      *p_input_item;
  80     int                i_refcount;
  81     libvlc_instance_t *p_libvlc_instance;
  82     libvlc_state_t     state;
  83     struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
  84                                            * Sub item */
  85     void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
  86 };
  87
  88 struct libvlc_media_list_t
  89 {
  90     libvlc_event_manager_t *    p_event_manager;
  91     libvlc_instance_t *         p_libvlc_instance;
  92     int                         i_refcount;
  93     vlc_mutex_t                 object_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     libvlc_drawable_t           drawable;
 159
 160     bool        b_own_its_input_thread;
 161 };
 162
 163 struct libvlc_media_list_player_t
 164 {
 165     libvlc_event_manager_t *    p_event_manager;
 166     libvlc_instance_t *         p_libvlc_instance;
 167     int                         i_refcount;
 168     vlc_mutex_t                 object_lock;
 169     libvlc_media_list_path_t    current_playing_item_path;
 170     libvlc_media_t * p_current_playing_item;
 171     libvlc_media_list_t *       p_mlist;
 172     libvlc_media_player_t *   p_mi;
 173 };
 174
 175 struct libvlc_media_library_t
 176 {
 177     libvlc_event_manager_t * p_event_manager;
 178     libvlc_instance_t *      p_libvlc_instance;
 179     int                      i_refcount;
 180     libvlc_media_list_t *    p_mlist;
 181 };
 182
 183 struct libvlc_media_discoverer_t
 184 {
 185     libvlc_event_manager_t * p_event_manager;
 186     libvlc_instance_t *      p_libvlc_instance;
 187     services_discovery_t *   p_sd;
 188     libvlc_media_list_t *    p_mlist;
 189     bool               running;
 190     vlc_dictionary_t         catname_to_submedialist;
 191 };
 192
 193 /*
 194  * Event Handling
 195  */
 196 /* Example usage
 197  *
 198  * struct libvlc_cool_object_t
 199  * {
 200  *        ...
 201  *        libvlc_event_manager_t * p_event_manager;
 202  *        ...
 203  * }
 204  *
 205  * libvlc_my_cool_object_new()
 206  * {
 207  *        ...
 208  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
 209  *                                                   p_self->p_libvlc_instance, p_e);
 210  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 211  *                libvlc_MyCoolObjectDidSomething, p_e)
 212  *        ...
 213  * }
 214  *
 215  * libvlc_my_cool_object_release()
 216  * {
 217  *         ...
 218  *         libvlc_event_manager_release( p_self->p_event_manager );
 219  *         ...
 220  * }
 221  *
 222  * libvlc_my_cool_object_do_something()
 223  * {
 224  *        ...
 225  *        libvlc_event_t event;
 226  *        event.type = libvlc_MyCoolObjectDidSomething;
 227  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 228  *        libvlc_event_send( p_self->p_event_manager, &event );
 229  * }
 230  * */
 231
 232 typedef struct libvlc_event_listener_t
 233 {
 234     libvlc_event_type_t event_type;
 235     void *              p_user_data;
 236     libvlc_callback_t   pf_callback;
 237 } libvlc_event_listener_t;
 238
 239 typedef struct libvlc_event_listeners_group_t
 240 {
 241     libvlc_event_type_t event_type;
 242     vlc_array_t listeners;
 243     bool b_sublistener_removed;
 244 } libvlc_event_listeners_group_t;
 245
 246 typedef struct libvlc_event_manager_t
 247 {
 248     void * p_obj;
 249     struct libvlc_instance_t * p_libvlc_instance;
 250     vlc_array_t listeners_groups;
 251     vlc_mutex_t object_lock;
 252     vlc_mutex_t event_sending_lock;
 253 } libvlc_event_sender_t;
 254
 255
 256 /***************************************************************************
 257  * Other internal functions
 258  ***************************************************************************/
 259 input_thread_t *libvlc_get_input_thread(
 260      libvlc_media_player_t *,
 261     libvlc_exception_t * );
 262
 263 /* Media instance */
 264 libvlc_media_player_t *
 265 libvlc_media_player_new_from_input_thread( libvlc_instance_t *,
 266                                            input_thread_t *,
 267                                            libvlc_exception_t * );
 268
 269 void libvlc_media_player_destroy(
 270         libvlc_media_player_t * );
 271
 272 /* Media Descriptor */
 273 libvlc_media_t * libvlc_media_new_from_input_item(
 274         libvlc_instance_t *, input_item_t *,
 275         libvlc_exception_t * );
 276
 277 void libvlc_media_set_state(
 278         libvlc_media_t *, libvlc_state_t,
 279         libvlc_exception_t * );
 280
 281 /* Media List */
 282 void _libvlc_media_list_add_media(
 283         libvlc_media_list_t * p_mlist,
 284         libvlc_media_t * p_md,
 285         libvlc_exception_t * p_e );
 286
 287 void _libvlc_media_list_insert_media(
 288         libvlc_media_list_t * p_mlist,
 289         libvlc_media_t * p_md, int index,
 290         libvlc_exception_t * p_e );
 291
 292 void _libvlc_media_list_remove_index(
 293         libvlc_media_list_t * p_mlist, int index,
 294         libvlc_exception_t * p_e );
 295
 296 /* Media List View */
 297 libvlc_media_list_view_t * libvlc_media_list_view_new(
 298         libvlc_media_list_t * p_mlist,
 299         libvlc_media_list_view_count_func_t pf_count,
 300         libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
 301         libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
 302         libvlc_media_list_view_constructor_func_t pf_constructor,
 303         libvlc_media_list_view_release_func_t pf_release,
 304         void * this_view_data,
 305         libvlc_exception_t * p_e );
 306
 307 void libvlc_media_list_view_set_ml_notification_callback(
 308         libvlc_media_list_view_t * p_mlv,
 309         void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
 310         void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) );
 311
 312 void libvlc_media_list_view_will_delete_item(
 313         libvlc_media_list_view_t * p_mlv,
 314         libvlc_media_t * p_item, int index );
 315
 316 void libvlc_media_list_view_item_deleted(
 317         libvlc_media_list_view_t * p_mlv,
 318         libvlc_media_t * p_item, int index );
 319
 320 void libvlc_media_list_view_will_add_item (
 321         libvlc_media_list_view_t * p_mlv,
 322         libvlc_media_t * p_item, int index );
 323
 324 void libvlc_media_list_view_item_added(
 325         libvlc_media_list_view_t * p_mlv,
 326         libvlc_media_t * p_item, int index );
 327
 328 /* Events */
 329 libvlc_event_manager_t * libvlc_event_manager_new(
 330         void * p_obj, libvlc_instance_t * p_libvlc_inst,
 331         libvlc_exception_t *p_e );
 332
 333 void libvlc_event_manager_release(
 334         libvlc_event_manager_t * p_em );
 335
 336 void libvlc_event_manager_register_event_type(
 337         libvlc_event_manager_t * p_em,
 338         libvlc_event_type_t event_type,
 339         libvlc_exception_t * p_e );
 340
 341 void libvlc_event_send(
 342         libvlc_event_manager_t * p_em,
 343         libvlc_event_t * p_event );
 344
 345
 346 /* Exception shorcuts */
 347
 348 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 349                                 return NULL; }
 350 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 351                                 return; }
 352 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 353                                 return 0; }
 354
 355 # ifdef __cplusplus
 356 }
 357 # endif
 358
 359 #endif