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     libvlc_media_t * p_md; /* The media from which the
  94                                        * mlist comes, if any. */
  95     vlc_array_t                items;
  96
  97     /* Other way to see that media list */
  98     /* Used in flat_media_list.c */
  99     libvlc_media_list_t *       p_flat_mlist;
 100
 101     /* This indicates if this media list is read-only
 102      * from a user point of view */
 103     bool                  b_read_only;
 104 };
 105
 106 typedef libvlc_media_list_view_t * (*libvlc_media_list_view_constructor_func_t)( libvlc_media_list_t * p_mlist, libvlc_exception_t * p_e ) ;
 107 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
 108
 109 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
 110         libvlc_exception_t * ) ;
 111
 112 typedef libvlc_media_t *
 113         (*libvlc_media_list_view_item_at_index_func_t)(
 114                 libvlc_media_list_view_t * p_mlv,
 115                 int index,
 116                 libvlc_exception_t * ) ;
 117
 118 typedef libvlc_media_list_view_t *
 119         (*libvlc_media_list_view_children_at_index_func_t)(
 120                 libvlc_media_list_view_t * p_mlv,
 121                 int index,
 122                 libvlc_exception_t * ) ;
 123
 124 /* A way to see a media list */
 125 struct libvlc_media_list_view_t
 126 {
 127     libvlc_event_manager_t *    p_event_manager;
 128     libvlc_instance_t *         p_libvlc_instance;
 129     int                         i_refcount;
 130     vlc_mutex_t                 object_lock;
 131
 132     libvlc_media_list_t *       p_mlist;
 133
 134     struct libvlc_media_list_view_private_t * p_this_view_data;
 135
 136     /* Accessors */
 137     libvlc_media_list_view_count_func_t              pf_count;
 138     libvlc_media_list_view_item_at_index_func_t      pf_item_at_index;
 139     libvlc_media_list_view_children_at_index_func_t  pf_children_at_index;
 140
 141     libvlc_media_list_view_constructor_func_t        pf_constructor;
 142     libvlc_media_list_view_release_func_t            pf_release;
 143
 144     /* Notification callback */
 145     void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
 146     void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
 147 };
 148
 149 struct libvlc_media_player_t
 150 {
 151     int                i_refcount;
 152     vlc_mutex_t        object_lock;
 153     input_thread_t *   p_input_thread;
 154     struct libvlc_instance_t * p_libvlc_instance; /* Parent instance */
 155     libvlc_media_t * p_md; /* current media descriptor */
 156     libvlc_event_manager_t * p_event_manager;
 157     struct
 158     {
 159         void *hwnd;
 160         void *nsobject;
 161         uint32_t xid;
 162         uint32_t agl;
 163     } drawable;
 164 };
 165
 166 struct libvlc_media_list_player_t
 167 {
 168     libvlc_event_manager_t *    p_event_manager;
 169     libvlc_instance_t *         p_libvlc_instance;
 170     int                         i_refcount;
 171     vlc_mutex_t                 object_lock;
 172     libvlc_media_list_path_t    current_playing_item_path;
 173     libvlc_media_t *            p_current_playing_item;
 174     libvlc_media_list_t *       p_mlist;
 175     libvlc_media_player_t *     p_mi;
 176 };
 177
 178 struct libvlc_media_library_t
 179 {
 180     libvlc_event_manager_t * p_event_manager;
 181     libvlc_instance_t *      p_libvlc_instance;
 182     int                      i_refcount;
 183     libvlc_media_list_t *    p_mlist;
 184 };
 185
 186 struct libvlc_media_discoverer_t
 187 {
 188     libvlc_event_manager_t * p_event_manager;
 189     libvlc_instance_t *      p_libvlc_instance;
 190     services_discovery_t *   p_sd;
 191     libvlc_media_list_t *    p_mlist;
 192     bool                     running;
 193     vlc_dictionary_t         catname_to_submedialist;
 194 };
 195
 196 /*
 197  * Event Handling
 198  */
 199 /* Example usage
 200  *
 201  * struct libvlc_cool_object_t
 202  * {
 203  *        ...
 204  *        libvlc_event_manager_t * p_event_manager;
 205  *        ...
 206  * }
 207  *
 208  * libvlc_my_cool_object_new()
 209  * {
 210  *        ...
 211  *        p_self->p_event_manager = libvlc_event_manager_new( p_self,
 212  *                                                   p_self->p_libvlc_instance, p_e);
 213  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 214  *                libvlc_MyCoolObjectDidSomething, p_e)
 215  *        ...
 216  * }
 217  *
 218  * libvlc_my_cool_object_release()
 219  * {
 220  *         ...
 221  *         libvlc_event_manager_release( p_self->p_event_manager );
 222  *         ...
 223  * }
 224  *
 225  * libvlc_my_cool_object_do_something()
 226  * {
 227  *        ...
 228  *        libvlc_event_t event;
 229  *        event.type = libvlc_MyCoolObjectDidSomething;
 230  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 231  *        libvlc_event_send( p_self->p_event_manager, &event );
 232  * }
 233  * */
 234
 235 typedef struct libvlc_event_listener_t
 236 {
 237     libvlc_event_type_t event_type;
 238     void *              p_user_data;
 239     libvlc_callback_t   pf_callback;
 240 } libvlc_event_listener_t;
 241
 242 typedef struct libvlc_event_listeners_group_t
 243 {
 244     libvlc_event_type_t event_type;
 245     vlc_array_t listeners;
 246     bool b_sublistener_removed;
 247 } libvlc_event_listeners_group_t;
 248
 249 typedef struct libvlc_event_manager_t
 250 {
 251     void * p_obj;
 252     struct libvlc_instance_t * p_libvlc_instance;
 253     vlc_array_t listeners_groups;
 254     vlc_mutex_t object_lock;
 255     vlc_mutex_t event_sending_lock;
 256 } libvlc_event_sender_t;
 257
 258
 259 /***************************************************************************
 260  * Other internal functions
 261  ***************************************************************************/
 262 input_thread_t *libvlc_get_input_thread(
 263      libvlc_media_player_t *,
 264     libvlc_exception_t * );
 265
 266 /* Media Descriptor */
 267 libvlc_media_t * libvlc_media_new_from_input_item(
 268         libvlc_instance_t *, input_item_t *,
 269         libvlc_exception_t * );
 270
 271 void libvlc_media_set_state(
 272         libvlc_media_t *, libvlc_state_t,
 273         libvlc_exception_t * );
 274
 275 /* Media List */
 276 void _libvlc_media_list_add_media(
 277         libvlc_media_list_t * p_mlist,
 278         libvlc_media_t * p_md,
 279         libvlc_exception_t * p_e );
 280
 281 void _libvlc_media_list_insert_media(
 282         libvlc_media_list_t * p_mlist,
 283         libvlc_media_t * p_md, int index,
 284         libvlc_exception_t * p_e );
 285
 286 void _libvlc_media_list_remove_index(
 287         libvlc_media_list_t * p_mlist, int index,
 288         libvlc_exception_t * p_e );
 289
 290 /* Media List View */
 291 libvlc_media_list_view_t * libvlc_media_list_view_new(
 292         libvlc_media_list_t * p_mlist,
 293         libvlc_media_list_view_count_func_t pf_count,
 294         libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
 295         libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
 296         libvlc_media_list_view_constructor_func_t pf_constructor,
 297         libvlc_media_list_view_release_func_t pf_release,
 298         void * this_view_data,
 299         libvlc_exception_t * p_e );
 300
 301 void libvlc_media_list_view_set_ml_notification_callback(
 302         libvlc_media_list_view_t * p_mlv,
 303         void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
 304         void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) );
 305
 306 void libvlc_media_list_view_will_delete_item(
 307         libvlc_media_list_view_t * p_mlv,
 308         libvlc_media_t * p_item, int index );
 309
 310 void libvlc_media_list_view_item_deleted(
 311         libvlc_media_list_view_t * p_mlv,
 312         libvlc_media_t * p_item, int index );
 313
 314 void libvlc_media_list_view_will_add_item (
 315         libvlc_media_list_view_t * p_mlv,
 316         libvlc_media_t * p_item, int index );
 317
 318 void libvlc_media_list_view_item_added(
 319         libvlc_media_list_view_t * p_mlv,
 320         libvlc_media_t * p_item, int index );
 321
 322 /* Events */
 323 libvlc_event_manager_t * libvlc_event_manager_new(
 324         void * p_obj, libvlc_instance_t * p_libvlc_inst,
 325         libvlc_exception_t *p_e );
 326
 327 void libvlc_event_manager_release(
 328         libvlc_event_manager_t * p_em );
 329
 330 void libvlc_event_manager_register_event_type(
 331         libvlc_event_manager_t * p_em,
 332         libvlc_event_type_t event_type,
 333         libvlc_exception_t * p_e );
 334
 335 void libvlc_event_send(
 336         libvlc_event_manager_t * p_em,
 337         libvlc_event_t * p_event );
 338
 339 /* Media player - audio, video */
 340 libvlc_track_description_t * libvlc_get_track_description(
 341         libvlc_media_player_t *p_mi,
 342         const char *psz_variable,
 343         libvlc_exception_t *p_e );
 344
 345
 346 /* Exception shorcuts */
 347
 348 #define RAISENULL( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
 349                            return NULL; }
 350 #define RAISEVOID( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
 351                            return; }
 352 #define RAISEZERO( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
 353                            return 0; }
 354
 355 #endif