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 $
8 * Authors: Clément Stenac <zorglub@videolan.org>
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.
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.
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 *****************************************************************************/
25 #ifndef _LIBVLC_INTERNAL_H
26 #define _LIBVLC_INTERNAL_H 1
29 #include <vlc/libvlc_structures.h>
31 #include <vlc_arrays.h>
32 #include <vlc_input.h>
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, const char *ppsz_argv[] ) );
43 VLC_EXPORT (int, libvlc_InternalCleanup, ( libvlc_int_t * ) );
44 VLC_EXPORT (int, libvlc_InternalDestroy, ( libvlc_int_t *, vlc_bool_t ) );
46 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, vlc_bool_t,
47 vlc_bool_t, int, const char *const * ) );
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 * ) );
53 /***************************************************************************
54 * Opaque structures for libvlc API
55 ***************************************************************************/
57 typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */
59 typedef enum libvlc_lock_state_t
63 } libvlc_lock_state_t;
65 struct libvlc_instance_t
67 libvlc_int_t *p_libvlc_int;
69 int b_playlist_locked;
71 vlc_mutex_t instance_lock;
72 vlc_mutex_t event_callback_lock;
73 struct libvlc_callback_entry_list_t *p_callback_list;
76 struct libvlc_tags_storage_t
82 struct libvlc_media_descriptor_t
84 libvlc_event_manager_t * p_event_manager;
86 input_item_t *p_input_item;
88 libvlc_instance_t *p_libvlc_instance;
89 vlc_dictionary_t tags; /* To be merged with core's meta soon */
90 struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
92 void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
95 struct libvlc_tag_query_t
97 struct libvlc_instance_t *p_libvlc_instance; /* Parent instance */
103 struct libvlc_media_list_t
105 libvlc_event_manager_t * p_event_manager;
106 libvlc_instance_t * p_libvlc_instance;
108 vlc_mutex_t object_lock;
109 libvlc_media_descriptor_t * p_md; /* The media_descriptor from which the
110 * mlist comes, if any. */
113 /* Other way to see that media list */
114 /* Used in flat_media_list.c */
115 libvlc_media_list_t * p_flat_mlist;
118 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
120 typedef int (*libvlc_media_list_view_count_func_t)( struct libvlc_media_list_view_t * p_mlv,
121 libvlc_exception_t * ) ;
123 typedef libvlc_media_descriptor_t *
124 (*libvlc_media_list_view_item_at_index_func_t)(
125 struct libvlc_media_list_view_t * p_mlv,
127 libvlc_exception_t * ) ;
129 /* A way to see a media list */
130 struct libvlc_media_list_view_t
132 libvlc_event_manager_t * p_event_manager;
133 libvlc_instance_t * p_libvlc_instance;
135 vlc_mutex_t object_lock;
137 libvlc_media_list_t * p_mlist;
139 struct libvlc_media_list_view_private_t * p_this_view_data;
142 libvlc_media_list_view_count_func_t pf_count;
143 libvlc_media_list_view_item_at_index_func_t pf_item_at_index;
145 libvlc_media_list_view_release_func_t pf_release;
147 /* Notification callback */
148 void (*pf_ml_item_added)(const libvlc_event_t *, void *);
149 void (*pf_ml_item_removed)(const libvlc_event_t *, void *);
152 struct libvlc_dynamic_media_list_t
154 libvlc_instance_t * p_libvlc_instance;
156 libvlc_media_list_t * p_media_provider;
157 libvlc_tag_query_t * p_query;
160 struct libvlc_media_list_t * p_mlist;
161 struct libvlc_media_list_t * p_provider;
164 struct libvlc_media_instance_t
167 vlc_mutex_t object_lock;
168 int i_input_id; /* Input object id. We don't use a pointer to
170 struct libvlc_instance_t * p_libvlc_instance; /* Parent instance */
171 libvlc_media_descriptor_t * p_md; /* current media descriptor */
172 libvlc_event_manager_t * p_event_manager;
173 libvlc_drawable_t drawable;
175 vlc_bool_t b_own_its_input_thread;
178 struct libvlc_media_list_player_t
180 libvlc_event_manager_t * p_event_manager;
181 libvlc_instance_t * p_libvlc_instance;
183 vlc_mutex_t object_lock;
184 libvlc_media_list_path_t current_playing_item_path;
185 libvlc_media_descriptor_t * p_current_playing_item;
186 libvlc_media_list_t * p_mlist;
187 libvlc_media_instance_t * p_mi;
190 struct libvlc_media_library_t
192 libvlc_event_manager_t * p_event_manager;
193 libvlc_instance_t * p_libvlc_instance;
195 libvlc_media_list_t * p_mlist;
198 struct libvlc_media_discoverer_t
200 libvlc_event_manager_t * p_event_manager;
201 libvlc_instance_t * p_libvlc_instance;
202 services_discovery_t * p_sd;
203 libvlc_media_list_t * p_mlist;
211 * struct libvlc_cool_object_t
214 * libvlc_event_manager_t * p_event_manager;
218 * libvlc_my_cool_object_new()
221 * p_self->p_event_manager = libvlc_event_manager_init( p_self,
222 * p_self->p_libvlc_instance, p_e);
223 * libvlc_event_manager_register_event_type(p_self->p_event_manager,
224 * libvlc_MyCoolObjectDidSomething, p_e)
228 * libvlc_my_cool_object_release()
231 * libvlc_event_manager_release( p_self->p_event_manager );
235 * libvlc_my_cool_object_do_something()
238 * libvlc_event_t event;
239 * event.type = libvlc_MyCoolObjectDidSomething;
240 * event.u.my_cool_object_did_something.what_it_did = kSomething;
241 * libvlc_event_send( p_self->p_event_manager, &event );
245 typedef struct libvlc_event_listener_t
247 libvlc_event_type_t event_type;
249 libvlc_callback_t pf_callback;
250 } libvlc_event_listener_t;
252 typedef struct libvlc_event_listeners_group_t
254 libvlc_event_type_t event_type;
255 DECL_ARRAY(libvlc_event_listener_t *) listeners;
256 } libvlc_event_listeners_group_t;
258 typedef struct libvlc_event_manager_t
261 struct libvlc_instance_t * p_libvlc_instance;
262 DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
263 vlc_mutex_t object_lock;
264 vlc_mutex_t event_sending_lock;
265 } libvlc_event_sender_t;
268 /***************************************************************************
269 * Other internal functions
270 ***************************************************************************/
271 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
272 ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
275 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
276 ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
278 VLC_EXPORT (void, libvlc_media_instance_destroy,
279 ( libvlc_media_instance_t * ) );
281 /* Media Descriptor */
282 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
283 ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
285 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
286 ( libvlc_media_descriptor_t * ) );
288 /* Media List View */
289 VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
290 ( libvlc_media_list_t * p_mlist,
291 libvlc_media_list_view_count_func_t pf_count,
292 libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
293 libvlc_media_list_view_release_func_t pf_release,
294 void * this_view_data,
295 libvlc_exception_t * p_e ) );
297 VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
298 libvlc_media_list_view_t * p_mlv,
299 void (*item_added)(const libvlc_event_t *, void *),
300 void (*item_removed)(const libvlc_event_t *, void *) ));
303 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
305 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
307 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
309 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
311 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 ) );
312 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,
313 void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
315 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
318 /* Exception shorcuts */
320 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
322 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
324 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \