Drawable: separate XIDs and HWNDs
[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$
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 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc/vlc.h>
33 #include <vlc/libvlc_structures.h>
34
35 #include <vlc_common.h>
36 #include <vlc_arrays.h>
37 #include <vlc_input.h>
38
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 * ) );
46
47 VLC_EXPORT (int, libvlc_InternalAddIntf, ( libvlc_int_t *, const char * ) );
48 VLC_EXPORT (void, libvlc_InternalWait, ( libvlc_int_t * ) );
49
50 /***************************************************************************
51  * Opaque structures for libvlc API
52  ***************************************************************************/
53
54 typedef int * libvlc_media_list_path_t; /* (Media List Player Internal) */
55
56 typedef enum libvlc_lock_state_t
57 {
58     libvlc_Locked,
59     libvlc_UnLocked
60 } libvlc_lock_state_t;
61
62 struct libvlc_instance_t
63 {
64     libvlc_int_t *p_libvlc_int;
65     vlm_t        *p_vlm;
66     int           b_playlist_locked;
67     unsigned      ref_count;
68     vlc_mutex_t   instance_lock;
69     vlc_mutex_t   event_callback_lock;
70     struct libvlc_callback_entry_list_t *p_callback_list;
71 };
72
73 struct libvlc_media_t
74 {
75     libvlc_event_manager_t * p_event_manager;
76     int                b_preparsed;
77     input_item_t      *p_input_item;
78     int                i_refcount;
79     libvlc_instance_t *p_libvlc_instance;
80     libvlc_state_t     state;
81     struct libvlc_media_list_t *p_subitems; /* A media descriptor can have
82                                            * Sub item */
83     void *p_user_data; /* Allows for VLC.framework to hook into media descriptor without creating a new VLCMedia object. */
84 };
85
86 struct libvlc_media_list_t
87 {
88     libvlc_event_manager_t *    p_event_manager;
89     libvlc_instance_t *         p_libvlc_instance;
90     int                         i_refcount;
91     vlc_mutex_t                 object_lock;
92     libvlc_media_t * p_md; /* The media from which the
93                                        * mlist comes, if any. */
94     vlc_array_t                items;
95
96     /* Other way to see that media list */
97     /* Used in flat_media_list.c */
98     libvlc_media_list_t *       p_flat_mlist;
99
100     /* This indicates if this media list is read-only
101      * from a user point of view */
102     bool                  b_read_only;
103 };
104
105 typedef libvlc_media_list_view_t * (*libvlc_media_list_view_constructor_func_t)( libvlc_media_list_t * p_mlist, libvlc_exception_t * p_e ) ;
106 typedef void (*libvlc_media_list_view_release_func_t)( libvlc_media_list_view_t * p_mlv ) ;
107
108 typedef int (*libvlc_media_list_view_count_func_t)( libvlc_media_list_view_t * p_mlv,
109         libvlc_exception_t * ) ;
110
111 typedef libvlc_media_t *
112         (*libvlc_media_list_view_item_at_index_func_t)(
113                 libvlc_media_list_view_t * p_mlv,
114                 int index,
115                 libvlc_exception_t * ) ;
116
117 typedef libvlc_media_list_view_t *
118         (*libvlc_media_list_view_children_at_index_func_t)(
119                 libvlc_media_list_view_t * p_mlv,
120                 int index,
121                 libvlc_exception_t * ) ;
122
123 /* A way to see a media list */
124 struct libvlc_media_list_view_t
125 {
126     libvlc_event_manager_t *    p_event_manager;
127     libvlc_instance_t *         p_libvlc_instance;
128     int                         i_refcount;
129     vlc_mutex_t                 object_lock;
130
131     libvlc_media_list_t *       p_mlist;
132
133     struct libvlc_media_list_view_private_t * p_this_view_data;
134
135     /* Accessors */
136     libvlc_media_list_view_count_func_t              pf_count;
137     libvlc_media_list_view_item_at_index_func_t      pf_item_at_index;
138     libvlc_media_list_view_children_at_index_func_t  pf_children_at_index;
139
140     libvlc_media_list_view_constructor_func_t         pf_constructor;
141     libvlc_media_list_view_release_func_t            pf_release;
142
143     /* Notification callback */
144     void (*pf_ml_item_added)(const libvlc_event_t *, libvlc_media_list_view_t *);
145     void (*pf_ml_item_removed)(const libvlc_event_t *, libvlc_media_list_view_t *);
146 };
147
148 struct libvlc_media_player_t
149 {
150     int                i_refcount;
151     vlc_mutex_t        object_lock;
152     input_thread_t *   p_input_thread;
153     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
154     libvlc_media_t * p_md; /* current media descriptor */
155     libvlc_event_manager_t *    p_event_manager;
156     union
157     {
158         void *hwnd;
159         uint32_t xid;
160     } drawable;
161
162     bool        b_own_its_input_thread;
163 };
164
165 struct libvlc_media_list_player_t
166 {
167     libvlc_event_manager_t *    p_event_manager;
168     libvlc_instance_t *         p_libvlc_instance;
169     int                         i_refcount;
170     vlc_mutex_t                 object_lock;
171     libvlc_media_list_path_t    current_playing_item_path;
172     libvlc_media_t * p_current_playing_item;
173     libvlc_media_list_t *       p_mlist;
174     libvlc_media_player_t *   p_mi;
175 };
176
177 struct libvlc_media_library_t
178 {
179     libvlc_event_manager_t * p_event_manager;
180     libvlc_instance_t *      p_libvlc_instance;
181     int                      i_refcount;
182     libvlc_media_list_t *    p_mlist;
183 };
184
185 struct libvlc_media_discoverer_t
186 {
187     libvlc_event_manager_t * p_event_manager;
188     libvlc_instance_t *      p_libvlc_instance;
189     services_discovery_t *   p_sd;
190     libvlc_media_list_t *    p_mlist;
191     bool               running;
192     vlc_dictionary_t         catname_to_submedialist;
193 };
194
195 /*
196  * Event Handling
197  */
198 /* Example usage
199  *
200  * struct libvlc_cool_object_t
201  * {
202  *        ...
203  *        libvlc_event_manager_t * p_event_manager;
204  *        ...
205  * }
206  *
207  * libvlc_my_cool_object_new()
208  * {
209  *        ...
210  *        p_self->p_event_manager = libvlc_event_manager_new( p_self,
211  *                                                   p_self->p_libvlc_instance, p_e);
212  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
213  *                libvlc_MyCoolObjectDidSomething, p_e)
214  *        ...
215  * }
216  *
217  * libvlc_my_cool_object_release()
218  * {
219  *         ...
220  *         libvlc_event_manager_release( p_self->p_event_manager );
221  *         ...
222  * }
223  *
224  * libvlc_my_cool_object_do_something()
225  * {
226  *        ...
227  *        libvlc_event_t event;
228  *        event.type = libvlc_MyCoolObjectDidSomething;
229  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
230  *        libvlc_event_send( p_self->p_event_manager, &event );
231  * }
232  * */
233
234 typedef struct libvlc_event_listener_t
235 {
236     libvlc_event_type_t event_type;
237     void *              p_user_data;
238     libvlc_callback_t   pf_callback;
239 } libvlc_event_listener_t;
240
241 typedef struct libvlc_event_listeners_group_t
242 {
243     libvlc_event_type_t event_type;
244     vlc_array_t listeners;
245     bool b_sublistener_removed;
246 } libvlc_event_listeners_group_t;
247
248 typedef struct libvlc_event_manager_t
249 {
250     void * p_obj;
251     struct libvlc_instance_t * p_libvlc_instance;
252     vlc_array_t listeners_groups;
253     vlc_mutex_t object_lock;
254     vlc_mutex_t event_sending_lock;
255 } libvlc_event_sender_t;
256
257
258 /***************************************************************************
259  * Other internal functions
260  ***************************************************************************/
261 input_thread_t *libvlc_get_input_thread(
262      libvlc_media_player_t *,
263     libvlc_exception_t * );
264
265 /* Media instance */
266 libvlc_media_player_t *
267 libvlc_media_player_new_from_input_thread( libvlc_instance_t *,
268                                            input_thread_t *,
269                                            libvlc_exception_t * );
270
271 void libvlc_media_player_destroy(
272         libvlc_media_player_t * );
273
274 /* Media Descriptor */
275 libvlc_media_t * libvlc_media_new_from_input_item(
276         libvlc_instance_t *, input_item_t *,
277         libvlc_exception_t * );
278
279 void libvlc_media_set_state(
280         libvlc_media_t *, libvlc_state_t,
281         libvlc_exception_t * );
282
283 /* Media List */
284 void _libvlc_media_list_add_media(
285         libvlc_media_list_t * p_mlist,
286         libvlc_media_t * p_md,
287         libvlc_exception_t * p_e );
288
289 void _libvlc_media_list_insert_media(
290         libvlc_media_list_t * p_mlist,
291         libvlc_media_t * p_md, int index,
292         libvlc_exception_t * p_e );
293
294 void _libvlc_media_list_remove_index(
295         libvlc_media_list_t * p_mlist, int index,
296         libvlc_exception_t * p_e );
297
298 /* Media List View */
299 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 );
308
309 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 *) );
313
314 void libvlc_media_list_view_will_delete_item(
315         libvlc_media_list_view_t * p_mlv,
316         libvlc_media_t * p_item, int index );
317
318 void libvlc_media_list_view_item_deleted(
319         libvlc_media_list_view_t * p_mlv,
320         libvlc_media_t * p_item, int index );
321
322 void libvlc_media_list_view_will_add_item (
323         libvlc_media_list_view_t * p_mlv,
324         libvlc_media_t * p_item, int index );
325
326 void libvlc_media_list_view_item_added(
327         libvlc_media_list_view_t * p_mlv,
328         libvlc_media_t * p_item, int index );
329
330 /* Events */
331 libvlc_event_manager_t * libvlc_event_manager_new(
332         void * p_obj, libvlc_instance_t * p_libvlc_inst,
333         libvlc_exception_t *p_e );
334
335 void libvlc_event_manager_release(
336         libvlc_event_manager_t * p_em );
337
338 void libvlc_event_manager_register_event_type(
339         libvlc_event_manager_t * p_em,
340         libvlc_event_type_t event_type,
341         libvlc_exception_t * p_e );
342
343 void libvlc_event_send(
344         libvlc_event_manager_t * p_em,
345         libvlc_event_t * p_event );
346
347 /* Media player - audio, video */
348 libvlc_track_description_t * libvlc_get_track_description(
349         libvlc_media_player_t *p_mi,
350         const char *psz_variable,
351         libvlc_exception_t *p_e );
352
353
354 /* Exception shorcuts */
355
356 #define RAISENULL( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
357                            return NULL; }
358 #define RAISEVOID( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
359                            return; }
360 #define RAISEZERO( ... ) { libvlc_exception_raise( p_e, __VA_ARGS__ ); \
361                            return 0; }
362
363 #endif