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