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_common.h>
36 #include <vlc_arrays.h>
37 #include <vlc_input.h>
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 * ) );
47 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char * ) );
48 VLC_EXPORT (void, libvlc_InternalWait, ( libvlc_int_t * ) );
50 /***************************************************************************
51 * Opaque structures for libvlc API
52 ***************************************************************************/
54 typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */
56 typedef enum libvlc_lock_state_t
60 } libvlc_lock_state_t;
62 struct libvlc_instance_t
64 libvlc_int_t *p_libvlc_int;
66 int b_playlist_locked;
69 vlc_mutex_t instance_lock;
70 vlc_mutex_t event_callback_lock;
71 struct libvlc_callback_entry_list_t *p_callback_list;
76 libvlc_event_manager_t * p_event_manager;
78 input_item_t *p_input_item;
80 libvlc_instance_t *p_libvlc_instance;
82 struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
84 void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
87 struct libvlc_media_list_t
89 libvlc_event_manager_t * p_event_manager;
90 libvlc_instance_t * p_libvlc_instance;
92 vlc_mutex_t object_lock;
93 libvlc_media_t * p_md; /* The media from which the
94 * mlist comes, if any. */
97 /* Other way to see that media list */
98 /* Used in flat_media_list.c */
99 libvlc_media_list_t * p_flat_mlist;
101 /* This indicates if this media list is read-only
102 * from a user point of view */
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 ) ;
109 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
110 libvlc_exception_t * ) ;
112 typedef libvlc_media_t *
113 (*libvlc_media_list_view_item_at_index_func_t)(
114 libvlc_media_list_view_t * p_mlv,
116 libvlc_exception_t * ) ;
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,
122 libvlc_exception_t * ) ;
124 /* A way to see a media list */
125 struct libvlc_media_list_view_t
127 libvlc_event_manager_t * p_event_manager;
128 libvlc_instance_t * p_libvlc_instance;
130 vlc_mutex_t object_lock;
132 libvlc_media_list_t * p_mlist;
134 struct libvlc_media_list_view_private_t * p_this_view_data;
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;
141 libvlc_media_list_view_constructor_func_t pf_constructor;
142 libvlc_media_list_view_release_func_t pf_release;
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 *);
149 struct libvlc_media_player_t
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;
163 bool b_own_its_input_thread;
166 struct libvlc_media_list_player_t
168 libvlc_event_manager_t * p_event_manager;
169 libvlc_instance_t * p_libvlc_instance;
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;
178 struct libvlc_media_library_t
180 libvlc_event_manager_t * p_event_manager;
181 libvlc_instance_t * p_libvlc_instance;
183 libvlc_media_list_t * p_mlist;
186 struct libvlc_media_discoverer_t
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;
193 vlc_dictionary_t catname_to_submedialist;
201 * struct libvlc_cool_object_t
204 * libvlc_event_manager_t * p_event_manager;
208 * libvlc_my_cool_object_new()
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)
218 * libvlc_my_cool_object_release()
221 * libvlc_event_manager_release( p_self->p_event_manager );
225 * libvlc_my_cool_object_do_something()
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 );
235 typedef struct libvlc_event_listener_t
237 libvlc_event_type_t event_type;
239 libvlc_callback_t pf_callback;
240 } libvlc_event_listener_t;
242 typedef struct libvlc_event_listeners_group_t
244 libvlc_event_type_t event_type;
245 vlc_array_t listeners;
246 bool b_sublistener_removed;
247 } libvlc_event_listeners_group_t;
249 typedef struct libvlc_event_manager_t
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;
259 /***************************************************************************
260 * Other internal functions
261 ***************************************************************************/
262 input_thread_t *libvlc_get_input_thread(
263 libvlc_media_player_t *,
264 libvlc_exception_t * );
267 libvlc_media_player_t *
268 libvlc_media_player_new_from_input_thread( libvlc_instance_t *,
270 libvlc_exception_t * );
272 void libvlc_media_player_destroy(
273 libvlc_media_player_t * );
275 /* Media Descriptor */
276 libvlc_media_t * libvlc_media_new_from_input_item(
277 libvlc_instance_t *, input_item_t *,
278 libvlc_exception_t * );
280 void libvlc_media_set_state(
281 libvlc_media_t *, libvlc_state_t,
282 libvlc_exception_t * );
285 void _libvlc_media_list_add_media(
286 libvlc_media_list_t * p_mlist,
287 libvlc_media_t * p_md,
288 libvlc_exception_t * p_e );
290 void _libvlc_media_list_insert_media(
291 libvlc_media_list_t * p_mlist,
292 libvlc_media_t * p_md, int index,
293 libvlc_exception_t * p_e );
295 void _libvlc_media_list_remove_index(
296 libvlc_media_list_t * p_mlist, int index,
297 libvlc_exception_t * p_e );
299 /* Media List View */
300 libvlc_media_list_view_t * libvlc_media_list_view_new(
301 libvlc_media_list_t * p_mlist,
302 libvlc_media_list_view_count_func_t pf_count,
303 libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
304 libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
305 libvlc_media_list_view_constructor_func_t pf_constructor,
306 libvlc_media_list_view_release_func_t pf_release,
307 void * this_view_data,
308 libvlc_exception_t * p_e );
310 void libvlc_media_list_view_set_ml_notification_callback(
311 libvlc_media_list_view_t * p_mlv,
312 void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
313 void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) );
315 void libvlc_media_list_view_will_delete_item(
316 libvlc_media_list_view_t * p_mlv,
317 libvlc_media_t * p_item, int index );
319 void libvlc_media_list_view_item_deleted(
320 libvlc_media_list_view_t * p_mlv,
321 libvlc_media_t * p_item, int index );
323 void libvlc_media_list_view_will_add_item (
324 libvlc_media_list_view_t * p_mlv,
325 libvlc_media_t * p_item, int index );
327 void libvlc_media_list_view_item_added(
328 libvlc_media_list_view_t * p_mlv,
329 libvlc_media_t * p_item, int index );
332 libvlc_event_manager_t * libvlc_event_manager_new(
333 void * p_obj, libvlc_instance_t * p_libvlc_inst,
334 libvlc_exception_t *p_e );
336 void libvlc_event_manager_release(
337 libvlc_event_manager_t * p_em );
339 void libvlc_event_manager_register_event_type(
340 libvlc_event_manager_t * p_em,
341 libvlc_event_type_t event_type,
342 libvlc_exception_t * p_e );
344 void libvlc_event_send(
345 libvlc_event_manager_t * p_em,
346 libvlc_event_t * p_event );
348 /* Media player - audio, video */
349 libvlc_track_description_t * libvlc_get_track_description(
350 libvlc_media_player_t *p_mi,
351 const char *psz_variable,
352 libvlc_exception_t *p_e );
355 /* Exception shorcuts */
357 #define RAISENULL( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
359 #define RAISEVOID( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
361 #define RAISEZERO( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \