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 # ifdef __cplusplus
  29 extern "C" {
  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 /***************************************************************************
  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  * Opaque structures for libvlc API
  54  ***************************************************************************/
  55
  56 struct libvlc_instance_t
  57 {
  58     libvlc_int_t *p_libvlc_int;
  59     vlm_t        *p_vlm;
  60     int           b_playlist_locked;
  61     vlc_mutex_t   instance_lock;
  62     vlc_mutex_t   event_callback_lock;
  63     struct libvlc_callback_entry_list_t *p_callback_list;
  64 };
  65
  66 struct libvlc_tags_storage_t
  67 {
  68     char ** ppsz_tags;
  69     int i_count;
  70 };
  71
  72 struct libvlc_media_descriptor_t
  73 {
  74     libvlc_event_manager_t * p_event_manager;
  75     int                b_preparsed;
  76     input_item_t      *p_input_item;
  77     int                i_refcount;
  78     libvlc_instance_t *p_libvlc_instance;
  79     vlc_dictionary_t   tags; /* To be merged with core's meta soon */
  80 };
  81
  82 struct libvlc_tag_query_t
  83 {
  84     struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
  85     int                i_refcount;
  86     libvlc_tag_t       tag;
  87     char *             psz_tag_key;
  88 };
  89
  90 struct libvlc_tree_t
  91 {
  92     libvlc_event_manager_t * p_event_manager;
  93     int     i_refcount;
  94     void *  p_item; /* For dynamic sublist */
  95     libvlc_retain_function  pf_item_retain;
  96     libvlc_release_function pf_item_release;
  97     DECL_ARRAY(struct libvlc_tree_t *)  subtrees; /* For dynamic sublist */
  98 };
  99
 100 struct libvlc_media_list_t
 101 {
 102     libvlc_event_manager_t * p_event_manager;
 103     libvlc_instance_t *      p_libvlc_instance;
 104     int                      i_refcount;
 105     vlc_mutex_t              object_lock;
 106     char *                   psz_name; /* Usually NULL */
 107     DECL_ARRAY(void *) items;
 108 };
 109
 110 struct libvlc_dynamic_media_list_t
 111 {
 112     libvlc_instance_t *     p_libvlc_instance;
 113     int                     i_refcount;
 114     libvlc_media_list_t *   p_media_provider;
 115     libvlc_tag_query_t *    p_query;
 116     char *                  psz_tag_key;
 117     libvlc_tag_t            tag;
 118     struct libvlc_media_list_t *  p_mlist;
 119     struct libvlc_media_list_t *  p_provider;
 120 };
 121
 122 struct libvlc_media_instance_t
 123 {
 124     int                i_refcount;
 125     vlc_mutex_t        object_lock;
 126     int i_input_id;  /* Input object id. We don't use a pointer to
 127                         avoid any crash */
 128     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
 129     libvlc_media_descriptor_t * p_md; /* current media descriptor */
 130     libvlc_event_manager_t *    p_event_manager;
 131     libvlc_drawable_t           drawable;
 132 };
 133
 134 struct libvlc_media_list_player_t
 135 {
 136     libvlc_event_manager_t * p_event_manager;
 137     libvlc_instance_t *      p_libvlc_instance;
 138     int                      i_refcount;
 139     vlc_mutex_t              object_lock;
 140     int                      i_current_playing_index;
 141     libvlc_media_descriptor_t * p_current_playing_item;
 142     libvlc_media_list_t *    p_mlist;
 143     libvlc_media_instance_t *  p_mi;
 144 };
 145
 146 struct libvlc_media_library_t
 147 {
 148     libvlc_event_manager_t * p_event_manager;
 149     libvlc_instance_t *      p_libvlc_instance;
 150     int                      i_refcount;
 151     libvlc_media_list_t *    p_mlist;
 152     libvlc_tree_t *          p_playlists_tree;
 153 };
 154
 155 struct libvlc_media_discoverer_t
 156 {
 157     libvlc_event_manager_t * p_event_manager;
 158     libvlc_instance_t *      p_libvlc_instance;
 159     services_discovery_t *   p_sd;
 160     libvlc_media_list_t *    p_mlist;
 161 };
 162
 163 /*
 164  * Event Handling
 165  */
 166 /* Example usage
 167  *
 168  * struct libvlc_cool_object_t
 169  * {
 170  *        ...
 171  *        libvlc_event_manager_t * p_event_manager;
 172  *        ...
 173  * }
 174  *
 175  * libvlc_my_cool_object_new()
 176  * {
 177  *        ...
 178  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
 179  *                                                   p_self->p_libvlc_instance, p_e);
 180  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
 181  *                libvlc_MyCoolObjectDidSomething, p_e)
 182  *        ...
 183  * }
 184  *
 185  * libvlc_my_cool_object_release()
 186  * {
 187  *         ...
 188  *         libvlc_event_manager_release( p_self->p_event_manager );
 189  *         ...
 190  * }
 191  *
 192  * libvlc_my_cool_object_do_something()
 193  * {
 194  *        ...
 195  *        libvlc_event_t event;
 196  *        event.type = libvlc_MyCoolObjectDidSomething;
 197  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
 198  *        libvlc_event_send( p_self->p_event_manager, &event );
 199  * }
 200  * */
 201
 202 typedef struct libvlc_event_listener_t
 203 {
 204     libvlc_event_type_t event_type;
 205     void *              p_user_data;
 206     libvlc_callback_t   pf_callback;
 207 } libvlc_event_listener_t;
 208
 209 typedef struct libvlc_event_listeners_group_t
 210 {
 211     libvlc_event_type_t event_type;
 212     DECL_ARRAY(libvlc_event_listener_t *) listeners;
 213 } libvlc_event_listeners_group_t;
 214
 215 typedef struct libvlc_event_manager_t
 216 {
 217     void * p_obj;
 218     struct libvlc_instance_t * p_libvlc_instance;
 219     DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
 220 } libvlc_event_sender_t;
 221
 222
 223 /***************************************************************************
 224  * Other internal functions
 225  ***************************************************************************/
 226 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
 227                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
 228
 229 /* Media instance */
 230 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
 231                         ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
 232
 233 VLC_EXPORT (void, libvlc_media_instance_destroy,
 234                         ( libvlc_media_instance_t * ) );
 235
 236 /* Media Descriptor */
 237 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
 238                         ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
 239
 240 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
 241                         ( libvlc_media_descriptor_t * ) );
 242
 243 /* Events */
 244 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
 245
 246 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
 247
 248 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
 249
 250 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
 251
 252 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 ) );
 253
 254 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
 255
 256
 257 /* Exception shorcuts */
 258
 259 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 260                                 return NULL; }
 261 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 262                                 return; }
 263 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
 264                                 return 0; }
 265
 266 # ifdef __cplusplus
 267 }
 268 # endif
 269
 270 #endif