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
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
33 #include <vlc/libvlc_structures.h>
35 #include <vlc_arrays.h>
36 #include <vlc_input.h>
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 *, vlc_bool_t ) );
50 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, vlc_bool_t,
51 vlc_bool_t, int, const char *const * ) );
53 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *, libvlc_exception_t * ) );
54 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t * ) );
57 /***************************************************************************
58 * Opaque structures for libvlc API
59 ***************************************************************************/
61 typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */
63 typedef enum libvlc_lock_state_t
67 } libvlc_lock_state_t;
69 struct libvlc_instance_t
71 libvlc_int_t *p_libvlc_int;
73 int b_playlist_locked;
75 vlc_mutex_t instance_lock;
76 vlc_mutex_t event_callback_lock;
77 struct libvlc_callback_entry_list_t *p_callback_list;
80 struct libvlc_tags_storage_t
86 struct libvlc_media_descriptor_t
88 libvlc_event_manager_t * p_event_manager;
90 input_item_t *p_input_item;
92 libvlc_instance_t *p_libvlc_instance;
93 vlc_dictionary_t tags; /* To be merged with core's meta soon */
95 struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
97 void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
100 struct libvlc_tag_query_t
102 struct libvlc_instance_t *p_libvlc_instance; /* Parent instance */
108 struct libvlc_media_list_t
110 libvlc_event_manager_t * p_event_manager;
111 libvlc_instance_t * p_libvlc_instance;
113 vlc_mutex_t object_lock;
114 libvlc_media_descriptor_t * p_md; /* The media_descriptor from which the
115 * mlist comes, if any. */
118 /* Other way to see that media list */
119 /* Used in flat_media_list.c */
120 libvlc_media_list_t * p_flat_mlist;
122 /* This indicates if this media list is read-only
123 * from a user point of view */
124 vlc_bool_t b_read_only;
127 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
129 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
130 libvlc_exception_t * ) ;
132 typedef libvlc_media_descriptor_t *
133 (*libvlc_media_list_view_item_at_index_func_t)(
134 libvlc_media_list_view_t * p_mlv,
136 libvlc_exception_t * ) ;
138 typedef libvlc_media_list_view_t *
139 (*libvlc_media_list_view_children_at_index_func_t)(
140 libvlc_media_list_view_t * p_mlv,
142 libvlc_exception_t * ) ;
144 /* A way to see a media list */
145 struct libvlc_media_list_view_t
147 libvlc_event_manager_t * p_event_manager;
148 libvlc_instance_t * p_libvlc_instance;
150 vlc_mutex_t object_lock;
152 libvlc_media_list_t * p_mlist;
154 struct libvlc_media_list_view_private_t * p_this_view_data;
157 libvlc_media_list_view_count_func_t pf_count;
158 libvlc_media_list_view_item_at_index_func_t pf_item_at_index;
159 libvlc_media_list_view_children_at_index_func_t pf_children_at_index;
161 libvlc_media_list_view_release_func_t pf_release;
163 /* Notification callback */
164 void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
165 void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
168 struct libvlc_dynamic_media_list_t
170 libvlc_instance_t * p_libvlc_instance;
172 libvlc_media_list_t * p_media_provider;
173 libvlc_tag_query_t * p_query;
176 struct libvlc_media_list_t * p_mlist;
177 struct libvlc_media_list_t * p_provider;
180 struct libvlc_media_instance_t
183 vlc_mutex_t object_lock;
184 int i_input_id; /* Input object id. We don't use a pointer to
186 struct libvlc_instance_t * p_libvlc_instance; /* Parent instance */
187 libvlc_media_descriptor_t * p_md; /* current media descriptor */
188 libvlc_event_manager_t * p_event_manager;
189 libvlc_drawable_t drawable;
191 vlc_bool_t b_own_its_input_thread;
194 struct libvlc_media_list_player_t
196 libvlc_event_manager_t * p_event_manager;
197 libvlc_instance_t * p_libvlc_instance;
199 vlc_mutex_t object_lock;
200 libvlc_media_list_path_t current_playing_item_path;
201 libvlc_media_descriptor_t * p_current_playing_item;
202 libvlc_media_list_t * p_mlist;
203 libvlc_media_instance_t * p_mi;
206 struct libvlc_media_library_t
208 libvlc_event_manager_t * p_event_manager;
209 libvlc_instance_t * p_libvlc_instance;
211 libvlc_media_list_t * p_mlist;
214 struct libvlc_media_discoverer_t
216 libvlc_event_manager_t * p_event_manager;
217 libvlc_instance_t * p_libvlc_instance;
218 services_discovery_t * p_sd;
219 libvlc_media_list_t * p_mlist;
228 * struct libvlc_cool_object_t
231 * libvlc_event_manager_t * p_event_manager;
235 * libvlc_my_cool_object_new()
238 * p_self->p_event_manager = libvlc_event_manager_init( p_self,
239 * p_self->p_libvlc_instance, p_e);
240 * libvlc_event_manager_register_event_type(p_self->p_event_manager,
241 * libvlc_MyCoolObjectDidSomething, p_e)
245 * libvlc_my_cool_object_release()
248 * libvlc_event_manager_release( p_self->p_event_manager );
252 * libvlc_my_cool_object_do_something()
255 * libvlc_event_t event;
256 * event.type = libvlc_MyCoolObjectDidSomething;
257 * event.u.my_cool_object_did_something.what_it_did = kSomething;
258 * libvlc_event_send( p_self->p_event_manager, &event );
262 typedef struct libvlc_event_listener_t
264 libvlc_event_type_t event_type;
266 libvlc_callback_t pf_callback;
267 } libvlc_event_listener_t;
269 typedef struct libvlc_event_listeners_group_t
271 libvlc_event_type_t event_type;
272 DECL_ARRAY(libvlc_event_listener_t *) listeners;
273 } libvlc_event_listeners_group_t;
275 typedef struct libvlc_event_manager_t
278 struct libvlc_instance_t * p_libvlc_instance;
279 DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
280 vlc_mutex_t object_lock;
281 vlc_mutex_t event_sending_lock;
282 } libvlc_event_sender_t;
285 /***************************************************************************
286 * Other internal functions
287 ***************************************************************************/
288 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
289 ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
292 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
293 ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
295 VLC_EXPORT (void, libvlc_media_instance_destroy,
296 ( libvlc_media_instance_t * ) );
298 /* Media Descriptor */
299 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
300 ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
302 VLC_EXPORT (void, libvlc_media_descriptor_set_state,
303 ( libvlc_media_descriptor_t *, libvlc_state_t, libvlc_exception_t * ) );
306 VLC_EXPORT ( void, _libvlc_media_list_add_media_descriptor,
307 ( libvlc_media_list_t * p_mlist,
308 libvlc_media_descriptor_t * p_md,
309 libvlc_exception_t * p_e ) );
311 VLC_EXPORT ( void, _libvlc_media_list_insert_media_descriptor,
312 ( libvlc_media_list_t * p_mlist,
313 libvlc_media_descriptor_t * p_md,
315 libvlc_exception_t * p_e ) );
317 VLC_EXPORT ( void, _libvlc_media_list_remove_index,
318 ( libvlc_media_list_t * p_mlist,
320 libvlc_exception_t * p_e ) );
322 /* Media List View */
323 VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
324 ( libvlc_media_list_t * p_mlist,
325 libvlc_media_list_view_count_func_t pf_count,
326 libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
327 libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
328 libvlc_media_list_view_release_func_t pf_release,
329 void * this_view_data,
330 libvlc_exception_t * p_e ) );
332 VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
333 libvlc_media_list_view_t * p_mlv,
334 void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
335 void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) ));
337 VLC_EXPORT ( void, libvlc_media_list_view_will_delete_item, ( libvlc_media_list_view_t * p_mlv,
338 libvlc_media_descriptor_t * p_item,
340 VLC_EXPORT ( void, libvlc_media_list_view_item_deleted, ( libvlc_media_list_view_t * p_mlv,
341 libvlc_media_descriptor_t * p_item,
343 VLC_EXPORT ( void, libvlc_media_list_view_will_add_item, ( libvlc_media_list_view_t * p_mlv,
344 libvlc_media_descriptor_t * p_item,
346 VLC_EXPORT ( void, libvlc_media_list_view_item_added, ( libvlc_media_list_view_t * p_mlv,
347 libvlc_media_descriptor_t * p_item,
351 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
353 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
355 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 ) );
356 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,
357 void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
359 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
362 /* Exception shorcuts */
364 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
366 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
368 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \