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 *, bool ) );
50 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, bool,
51 bool, 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;
82 libvlc_event_manager_t * p_event_manager;
84 input_item_t *p_input_item;
86 libvlc_instance_t *p_libvlc_instance;
88 struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
90 void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
93 struct libvlc_media_list_t
95 libvlc_event_manager_t * p_event_manager;
96 libvlc_instance_t * p_libvlc_instance;
98 vlc_mutex_t object_lock;
99 libvlc_media_t * p_md; /* The media from which the
100 * mlist comes, if any. */
103 /* Other way to see that media list */
104 /* Used in flat_media_list.c */
105 libvlc_media_list_t * p_flat_mlist;
107 /* This indicates if this media list is read-only
108 * from a user point of view */
112 typedef libvlc_media_list_view_t * (*libvlc_media_list_view_constructor_func_t)( libvlc_media_list_t * p_mlist, libvlc_exception_t * p_e ) ;
113 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
115 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
116 libvlc_exception_t * ) ;
118 typedef libvlc_media_t *
119 (*libvlc_media_list_view_item_at_index_func_t)(
120 libvlc_media_list_view_t * p_mlv,
122 libvlc_exception_t * ) ;
124 typedef libvlc_media_list_view_t *
125 (*libvlc_media_list_view_children_at_index_func_t)(
126 libvlc_media_list_view_t * p_mlv,
128 libvlc_exception_t * ) ;
130 /* A way to see a media list */
131 struct libvlc_media_list_view_t
133 libvlc_event_manager_t * p_event_manager;
134 libvlc_instance_t * p_libvlc_instance;
136 vlc_mutex_t object_lock;
138 libvlc_media_list_t * p_mlist;
140 struct libvlc_media_list_view_private_t * p_this_view_data;
143 libvlc_media_list_view_count_func_t pf_count;
144 libvlc_media_list_view_item_at_index_func_t pf_item_at_index;
145 libvlc_media_list_view_children_at_index_func_t pf_children_at_index;
147 libvlc_media_list_view_constructor_func_t pf_constructor;
148 libvlc_media_list_view_release_func_t pf_release;
150 /* Notification callback */
151 void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
152 void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
155 struct libvlc_media_player_t
158 vlc_mutex_t object_lock;
159 input_thread_t * p_input_thread;
160 struct libvlc_instance_t * p_libvlc_instance; /* Parent instance */
161 libvlc_media_t * p_md; /* current media descriptor */
162 libvlc_event_manager_t * p_event_manager;
163 libvlc_drawable_t drawable;
165 bool b_own_its_input_thread;
168 struct libvlc_media_list_player_t
170 libvlc_event_manager_t * p_event_manager;
171 libvlc_instance_t * p_libvlc_instance;
173 vlc_mutex_t object_lock;
174 libvlc_media_list_path_t current_playing_item_path;
175 libvlc_media_t * p_current_playing_item;
176 libvlc_media_list_t * p_mlist;
177 libvlc_media_player_t * p_mi;
180 struct libvlc_media_library_t
182 libvlc_event_manager_t * p_event_manager;
183 libvlc_instance_t * p_libvlc_instance;
185 libvlc_media_list_t * p_mlist;
188 struct libvlc_media_discoverer_t
190 libvlc_event_manager_t * p_event_manager;
191 libvlc_instance_t * p_libvlc_instance;
192 services_discovery_t * p_sd;
193 libvlc_media_list_t * p_mlist;
195 vlc_dictionary_t catname_to_submedialist;
203 * struct libvlc_cool_object_t
206 * libvlc_event_manager_t * p_event_manager;
210 * libvlc_my_cool_object_new()
213 * p_self->p_event_manager = libvlc_event_manager_init( p_self,
214 * p_self->p_libvlc_instance, p_e);
215 * libvlc_event_manager_register_event_type(p_self->p_event_manager,
216 * libvlc_MyCoolObjectDidSomething, p_e)
220 * libvlc_my_cool_object_release()
223 * libvlc_event_manager_release( p_self->p_event_manager );
227 * libvlc_my_cool_object_do_something()
230 * libvlc_event_t event;
231 * event.type = libvlc_MyCoolObjectDidSomething;
232 * event.u.my_cool_object_did_something.what_it_did = kSomething;
233 * libvlc_event_send( p_self->p_event_manager, &event );
237 typedef struct libvlc_event_listener_t
239 libvlc_event_type_t event_type;
241 libvlc_callback_t pf_callback;
242 } libvlc_event_listener_t;
244 typedef struct libvlc_event_listeners_group_t
246 libvlc_event_type_t event_type;
247 vlc_array_t listeners;
248 bool b_sublistener_removed;
249 } libvlc_event_listeners_group_t;
251 typedef struct libvlc_event_manager_t
254 struct libvlc_instance_t * p_libvlc_instance;
255 vlc_array_t listeners_groups;
256 vlc_mutex_t object_lock;
257 vlc_mutex_t event_sending_lock;
258 } libvlc_event_sender_t;
261 /***************************************************************************
262 * Other internal functions
263 ***************************************************************************/
264 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
265 ( struct libvlc_media_player_t *, libvlc_exception_t * ) );
268 VLC_EXPORT (libvlc_media_player_t *, libvlc_media_player_new_from_input_thread,
269 ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
271 VLC_EXPORT (void, libvlc_media_player_destroy,
272 ( libvlc_media_player_t * ) );
274 /* Media Descriptor */
275 VLC_EXPORT (libvlc_media_t *, libvlc_media_new_from_input_item,
276 ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
278 VLC_EXPORT (void, libvlc_media_set_state,
279 ( libvlc_media_t *, libvlc_state_t, libvlc_exception_t * ) );
282 VLC_EXPORT ( void, _libvlc_media_list_add_media,
283 ( libvlc_media_list_t * p_mlist,
284 libvlc_media_t * p_md,
285 libvlc_exception_t * p_e ) );
287 VLC_EXPORT ( void, _libvlc_media_list_insert_media,
288 ( libvlc_media_list_t * p_mlist,
289 libvlc_media_t * p_md,
291 libvlc_exception_t * p_e ) );
293 VLC_EXPORT ( void, _libvlc_media_list_remove_index,
294 ( libvlc_media_list_t * p_mlist,
296 libvlc_exception_t * p_e ) );
298 /* Media List View */
299 VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
300 ( libvlc_media_list_t * p_mlist,
301 libvlc_media_list_view_count_func_t pf_count,
302 libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
303 libvlc_media_list_view_children_at_index_func_t pf_children_at_index,
304 libvlc_media_list_view_constructor_func_t pf_constructor,
305 libvlc_media_list_view_release_func_t pf_release,
306 void * this_view_data,
307 libvlc_exception_t * p_e ) );
309 VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
310 libvlc_media_list_view_t * p_mlv,
311 void (*item_added)(const libvlc_event_t *, libvlc_media_list_view_t *),
312 void (*item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *) ));
314 VLC_EXPORT ( void, libvlc_media_list_view_will_delete_item, ( libvlc_media_list_view_t * p_mlv,
315 libvlc_media_t * p_item,
317 VLC_EXPORT ( void, libvlc_media_list_view_item_deleted, ( libvlc_media_list_view_t * p_mlv,
318 libvlc_media_t * p_item,
320 VLC_EXPORT ( void, libvlc_media_list_view_will_add_item, ( libvlc_media_list_view_t * p_mlv,
321 libvlc_media_t * p_item,
323 VLC_EXPORT ( void, libvlc_media_list_view_item_added, ( libvlc_media_list_view_t * p_mlv,
324 libvlc_media_t * p_item,
328 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
330 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
332 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 ) );
334 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
337 /* Exception shorcuts */
339 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
341 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
343 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \