803a618b9f04d4807caa8dda7cd32fa62866ce91
[vlc.git] / src / control / libvlc_internal.h
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 $
7  *
8  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 #ifndef _LIBVLC_INTERNAL_H
26 #define _LIBVLC_INTERNAL_H 1
27
28 #include <vlc/vlc.h>
29 #include <vlc/libvlc_structures.h>
30
31 #include <vlc_arrays.h>
32 #include <vlc_input.h>
33
34 # ifdef __cplusplus
35 extern "C" {
36 # endif
37
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 ) );
45
46 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char *, vlc_bool_t,
47                             vlc_bool_t, int, const char *const * ) );
48
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 * ) );
51
52
53 /***************************************************************************
54  * Opaque structures for libvlc API
55  ***************************************************************************/
56
57 typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */
58
59 typedef enum libvlc_lock_state_t
60 {
61     libvlc_Locked,
62     libvlc_UnLocked
63 } libvlc_lock_state_t;
64
65 struct libvlc_instance_t
66 {
67     libvlc_int_t *p_libvlc_int;
68     vlm_t        *p_vlm;
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;
73 };
74
75 struct libvlc_tags_storage_t
76 {
77     char ** ppsz_tags;
78     int i_count;
79 };
80
81 struct libvlc_media_descriptor_t
82 {
83     libvlc_event_manager_t * p_event_manager;
84     int                b_preparsed;
85     input_item_t      *p_input_item;
86     int                i_refcount;
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
90                                            * Sub item */
91 };
92
93 struct libvlc_tag_query_t
94 {
95     struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
96     int                i_refcount;
97     libvlc_tag_t       tag;
98     char *             psz_tag_key;
99 };
100
101 struct libvlc_media_list_t
102 {
103     libvlc_event_manager_t * p_event_manager;
104     libvlc_instance_t *      p_libvlc_instance;
105     int                      i_refcount;
106     vlc_mutex_t              object_lock;
107     char *                   psz_name; /* Usually NULL */
108     DECL_ARRAY(void *)       items;
109     
110     /* Other way to see that media list */
111     /* Used in flat_media_list.c */
112     libvlc_media_list_t *    p_flat_mlist;
113 };
114
115 struct libvlc_dynamic_media_list_t
116 {
117     libvlc_instance_t *     p_libvlc_instance;
118     int                     i_refcount;
119     libvlc_media_list_t *   p_media_provider;
120     libvlc_tag_query_t *    p_query;
121     char *                  psz_tag_key;
122     libvlc_tag_t            tag;
123     struct libvlc_media_list_t *  p_mlist;
124     struct libvlc_media_list_t *  p_provider;
125 };
126
127 struct libvlc_media_instance_t
128 {
129     int                i_refcount;
130     vlc_mutex_t        object_lock;
131     int i_input_id;  /* Input object id. We don't use a pointer to
132                         avoid any crash */
133     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
134     libvlc_media_descriptor_t * p_md; /* current media descriptor */
135     libvlc_event_manager_t *    p_event_manager;
136     libvlc_drawable_t           drawable;
137 };
138
139 struct libvlc_media_list_player_t
140 {
141     libvlc_event_manager_t *    p_event_manager;
142     libvlc_instance_t *         p_libvlc_instance;
143     int                         i_refcount;
144     vlc_mutex_t                 object_lock;
145     libvlc_media_list_path_t    current_playing_item_path;
146     libvlc_media_descriptor_t * p_current_playing_item;
147     libvlc_media_list_t *       p_mlist;
148     libvlc_media_instance_t *   p_mi;
149 };
150
151 struct libvlc_media_library_t
152 {
153     libvlc_event_manager_t * p_event_manager;
154     libvlc_instance_t *      p_libvlc_instance;
155     int                      i_refcount;
156     libvlc_media_list_t *    p_mlist;
157 };
158
159 struct libvlc_media_discoverer_t
160 {
161     libvlc_event_manager_t * p_event_manager;
162     libvlc_instance_t *      p_libvlc_instance;
163     services_discovery_t *   p_sd;
164     libvlc_media_list_t *    p_mlist;
165 };
166
167 /* 
168  * Event Handling
169  */
170 /* Example usage
171  *
172  * struct libvlc_cool_object_t
173  * {
174  *        ...
175  *        libvlc_event_manager_t * p_event_manager;
176  *        ...
177  * }
178  *
179  * libvlc_my_cool_object_new()
180  * {
181  *        ...
182  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
183  *                                                   p_self->p_libvlc_instance, p_e);
184  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
185  *                libvlc_MyCoolObjectDidSomething, p_e)
186  *        ...
187  * }
188  *
189  * libvlc_my_cool_object_release()
190  * {
191  *         ...
192  *         libvlc_event_manager_release( p_self->p_event_manager );
193  *         ...
194  * }
195  *
196  * libvlc_my_cool_object_do_something()
197  * {
198  *        ...
199  *        libvlc_event_t event;
200  *        event.type = libvlc_MyCoolObjectDidSomething;
201  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
202  *        libvlc_event_send( p_self->p_event_manager, &event );
203  * }
204  * */
205
206 typedef struct libvlc_event_listener_t
207 {
208     libvlc_event_type_t event_type;
209     void *              p_user_data;
210     libvlc_callback_t   pf_callback;
211 } libvlc_event_listener_t;
212
213 typedef struct libvlc_event_listeners_group_t
214 {
215     libvlc_event_type_t event_type;
216     DECL_ARRAY(libvlc_event_listener_t *) listeners;
217 } libvlc_event_listeners_group_t;
218
219 typedef struct libvlc_event_manager_t
220 {
221     void * p_obj;
222     struct libvlc_instance_t * p_libvlc_instance;
223     DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
224     vlc_mutex_t object_lock;
225     vlc_mutex_t event_sending_lock;
226 } libvlc_event_sender_t;
227
228
229 /***************************************************************************
230  * Other internal functions
231  ***************************************************************************/
232 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
233                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
234
235 /* Media instance */
236 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
237                         ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
238
239 VLC_EXPORT (void, libvlc_media_instance_destroy,
240                         ( libvlc_media_instance_t * ) );
241
242 /* Media Descriptor */
243 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
244                         ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
245
246 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
247                         ( libvlc_media_descriptor_t * ) );
248
249 /* Media List */
250 VLC_EXPORT ( void, libvlc_media_list_flat_media_list_release, ( libvlc_media_list_t * ) );
251
252 /* Events */
253 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
254
255 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
256
257 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
258
259 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
260
261 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 ) );
262 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,
263                                                     void *p_user_data, libvlc_lock_state_t lockstate, libvlc_exception_t *p_e ) );
264
265 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
266
267
268 /* Exception shorcuts */
269
270 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
271                                 return NULL; }
272 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
273                                 return; }
274 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
275                                 return 0; }
276
277 # ifdef __cplusplus
278 }
279 # endif
280
281 #endif