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, 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;
70 vlc_mutex_t instance_lock;
71 vlc_mutex_t event_callback_lock;
72 struct libvlc_callback_entry_list_t *p_callback_list;
75 struct libvlc_tags_storage_t
81 struct libvlc_media_descriptor_t
83 libvlc_event_manager_t * p_event_manager;
85 input_item_t *p_input_item;
87 libvlc_instance_t *p_libvlc_instance;
88 vlc_dictionary_t tags; /* To be merged with core's meta soon */
89 struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
91 void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
94 struct libvlc_tag_query_t
96 struct libvlc_instance_t *p_libvlc_instance; /* Parent instance */
102 struct libvlc_media_list_t
104 libvlc_event_manager_t * p_event_manager;
105 libvlc_instance_t * p_libvlc_instance;
107 vlc_mutex_t object_lock;
108 libvlc_media_descriptor_t * p_md; /* The media_descriptor from which the
109 * mlist comes, if any. */
112 /* Other way to see that media list */
113 /* Used in flat_media_list.c */
114 libvlc_media_list_t * p_flat_mlist;
117 typedef int (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
119 typedef int (*libvlc_media_list_view_count_func_t)( struct libvlc_media_list_view_t * p_mlv,
120 libvlc_exception_t * ) ;
122 typedef libvlc_media_descriptor_t *
123 (*libvlc_media_list_view_item_at_index_func_t)(
124 struct libvlc_media_list_view_t * p_mlv,
126 libvlc_exception_t * ) ;
128 /* A way to see a media list */
129 struct libvlc_media_list_view_t
131 libvlc_event_manager_t * p_event_manager;
132 libvlc_instance_t * p_libvlc_instance;
134 vlc_mutex_t object_lock;
136 libvlc_media_list_t * p_mlist;
138 struct libvlc_media_list_view_private_t * p_this_view_data;
141 libvlc_media_list_view_count_func_t pf_count;
142 libvlc_media_list_view_item_at_index_func_t pf_item_at_index;
144 libvlc_media_list_view_release_func_t pf_release;
146 /* Notification callback */
147 void (*pf_ml_item_added)(const libvlc_event_t *, void *);
148 void (*pf_ml_item_removed)(const libvlc_event_t *, void *);
151 struct libvlc_dynamic_media_list_t
153 libvlc_instance_t * p_libvlc_instance;
155 libvlc_media_list_t * p_media_provider;
156 libvlc_tag_query_t * p_query;
159 struct libvlc_media_list_t * p_mlist;
160 struct libvlc_media_list_t * p_provider;
163 struct libvlc_media_instance_t
166 vlc_mutex_t object_lock;
167 int i_input_id; /* Input object id. We don't use a pointer to
169 struct libvlc_instance_t * p_libvlc_instance; /* Parent instance */
170 libvlc_media_descriptor_t * p_md; /* current media descriptor */
171 libvlc_event_manager_t * p_event_manager;
172 libvlc_drawable_t drawable;
174 vlc_bool_t b_own_its_input_thread;
177 struct libvlc_media_list_player_t
179 libvlc_event_manager_t * p_event_manager;
180 libvlc_instance_t * p_libvlc_instance;
182 vlc_mutex_t object_lock;
183 libvlc_media_list_path_t current_playing_item_path;
184 libvlc_media_descriptor_t * p_current_playing_item;
185 libvlc_media_list_t * p_mlist;
186 libvlc_media_instance_t * p_mi;
189 struct libvlc_media_library_t
191 libvlc_event_manager_t * p_event_manager;
192 libvlc_instance_t * p_libvlc_instance;
194 libvlc_media_list_t * p_mlist;
197 struct libvlc_media_discoverer_t
199 libvlc_event_manager_t * p_event_manager;
200 libvlc_instance_t * p_libvlc_instance;
201 services_discovery_t * p_sd;
202 libvlc_media_list_t * p_mlist;
210 * struct libvlc_cool_object_t
213 * libvlc_event_manager_t * p_event_manager;
217 * libvlc_my_cool_object_new()
220 * p_self->p_event_manager = libvlc_event_manager_init( p_self,
221 * p_self->p_libvlc_instance, p_e);
222 * libvlc_event_manager_register_event_type(p_self->p_event_manager,
223 * libvlc_MyCoolObjectDidSomething, p_e)
227 * libvlc_my_cool_object_release()
230 * libvlc_event_manager_release( p_self->p_event_manager );
234 * libvlc_my_cool_object_do_something()
237 * libvlc_event_t event;
238 * event.type = libvlc_MyCoolObjectDidSomething;
239 * event.u.my_cool_object_did_something.what_it_did = kSomething;
240 * libvlc_event_send( p_self->p_event_manager, &event );
244 typedef struct libvlc_event_listener_t
246 libvlc_event_type_t event_type;
248 libvlc_callback_t pf_callback;
249 } libvlc_event_listener_t;
251 typedef struct libvlc_event_listeners_group_t
253 libvlc_event_type_t event_type;
254 DECL_ARRAY(libvlc_event_listener_t *) listeners;
255 } libvlc_event_listeners_group_t;
257 typedef struct libvlc_event_manager_t
260 struct libvlc_instance_t * p_libvlc_instance;
261 DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
262 vlc_mutex_t object_lock;
263 vlc_mutex_t event_sending_lock;
264 } libvlc_event_sender_t;
267 /***************************************************************************
268 * Other internal functions
269 ***************************************************************************/
270 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
271 ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
274 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
275 ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
277 VLC_EXPORT (void, libvlc_media_instance_destroy,
278 ( libvlc_media_instance_t * ) );
280 /* Media Descriptor */
281 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
282 ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
284 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
285 ( libvlc_media_descriptor_t * ) );
287 /* Media List View */
288 VLC_EXPORT ( libvlc_media_list_view_t *, libvlc_media_list_view_new,
289 ( libvlc_media_list_t * p_mlist,
290 libvlc_media_list_view_count_func_t pf_count,
291 libvlc_media_list_view_item_at_index_func_t pf_item_at_index,
292 libvlc_media_list_view_release_func_t pf_release,
293 void * this_view_data,
294 libvlc_exception_t * p_e ) );
296 VLC_EXPORT ( void, libvlc_media_list_view_set_ml_notification_callback, (
297 libvlc_media_list_view_t * p_mlv,
298 void (*item_added)(const libvlc_event_t *, void *),
299 void (*item_removed)(const libvlc_event_t *, void *) ));
302 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
304 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
306 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
308 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
310 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 ) );
311 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,
312 void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
314 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
317 /* Exception shorcuts */
319 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
321 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
323 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \