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
93 struct libvlc_tag_query_t
95 struct libvlc_instance_t *p_libvlc_instance; /* Parent instance */
101 struct libvlc_media_list_t
103 libvlc_event_manager_t * p_event_manager;
104 libvlc_instance_t * p_libvlc_instance;
106 vlc_mutex_t object_lock;
107 libvlc_media_descriptor_t * p_md; /* The media_descriptor from which the
108 * mlist comes, if any. */
109 DECL_ARRAY(void *) items;
111 /* Other way to see that media list */
112 /* Used in flat_media_list.c */
113 libvlc_media_list_t * p_flat_mlist;
116 /* A way to see a media list */
117 struct libvlc_media_list_view_t
119 libvlc_event_manager_t * p_event_manager;
120 libvlc_instance_t * p_libvlc_instance;
122 vlc_mutex_t object_lock;
124 libvlc_media_list_t * p_mlist;
126 void * this_view_data;
129 int (*pf_count)( struct libvlc_media_list_view_t * p_mlv,
130 libvlc_exception_t * );
131 libvlc_media_descriptor_t *
132 (*pf_item_at_index)( struct libvlc_media_list_view_t * p_mlv,
134 libvlc_exception_t * );
135 int (*pf_index_of_item)( struct libvlc_media_list_view_t * p_mlv,
136 libvlc_media_descriptor_t * p_md,
137 libvlc_exception_t * );
140 void (*pf_insert_at_index)( struct libvlc_media_list_view_t * p_mlv,
141 libvlc_media_descriptor_t * p_md,
143 libvlc_exception_t * );
144 void (*pf_remove_at_index)( struct libvlc_media_list_view_t * p_mlv,
146 libvlc_exception_t * );
147 void (*pf_add_item)( struct libvlc_media_list_view_t * p_mlv,
148 libvlc_media_descriptor_t * p_md,
149 libvlc_exception_t * );
153 struct libvlc_dynamic_media_list_t
155 libvlc_instance_t * p_libvlc_instance;
157 libvlc_media_list_t * p_media_provider;
158 libvlc_tag_query_t * p_query;
161 struct libvlc_media_list_t * p_mlist;
162 struct libvlc_media_list_t * p_provider;
165 struct libvlc_media_instance_t
168 vlc_mutex_t object_lock;
169 int i_input_id; /* Input object id. We don't use a pointer to
171 struct libvlc_instance_t * p_libvlc_instance; /* Parent instance */
172 libvlc_media_descriptor_t * p_md; /* current media descriptor */
173 libvlc_event_manager_t * p_event_manager;
174 libvlc_drawable_t drawable;
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 * ) );
288 VLC_EXPORT ( void, libvlc_media_list_flat_media_list_release, ( libvlc_media_list_t * ) );
291 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
293 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
295 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
297 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
299 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 ) );
300 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,
301 void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
303 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
306 /* Exception shorcuts */
308 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
310 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
312 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \