4d74fc3c9d51a15e38fe863062da1ee32de2880e
[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 # ifdef __cplusplus
29 extern "C" {
30 # endif
31
32 #include <vlc/vlc.h>
33 #include <vlc/libvlc_structures.h>
34
35 #include <vlc_arrays.h>
36 #include <vlc_input.h>
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  * Opaque structures for libvlc API
54  ***************************************************************************/
55
56 struct libvlc_instance_t
57 {
58     libvlc_int_t *p_libvlc_int;
59     vlm_t        *p_vlm;
60     int           b_playlist_locked;
61     vlc_mutex_t   instance_lock;
62     vlc_mutex_t   event_callback_lock;
63     struct libvlc_callback_entry_list_t *p_callback_list;
64 };
65
66 struct libvlc_media_descriptor_t
67 {
68     libvlc_event_manager_t * p_event_manager;
69     int                b_preparsed;
70     input_item_t      *p_input_item;
71     int                i_refcount;
72     libvlc_instance_t *p_libvlc_instance;
73     vlc_dictionary_t   tags; /* To be merged with core's meta soon */
74 };
75
76 struct libvlc_tag_query_t
77 {
78     struct libvlc_instance_t  *p_libvlc_instance; /* Parent instance */
79     int                i_refcount;
80 };
81
82
83 struct libvlc_tree_t
84 {
85     int     i_refcount;
86     void *  p_item; /* For dynamic sublist */
87     libvlc_retain_function  pf_item_retain;
88     libvlc_release_function pf_item_release;
89     DECL_ARRAY(struct libvlc_tree_t *)  subtrees; /* For dynamic sublist */
90 };
91
92 struct libvlc_media_list_t
93 {
94     libvlc_event_manager_t * p_event_manager;
95     libvlc_instance_t *      p_libvlc_instance;
96     int                      i_refcount;
97     vlc_mutex_t              object_lock;
98     libvlc_media_list_t *    p_media_provider; /* For dynamic sublist */
99     libvlc_tag_query_t *     p_query;              /* For dynamic sublist */
100     char *                   psz_name; /* Usually NULL */
101     DECL_ARRAY(void *) items;
102 };
103
104 struct libvlc_media_instance_t
105 {
106     int                i_refcount;
107     vlc_mutex_t        object_lock;
108     int i_input_id;  /* Input object id. We don't use a pointer to
109                         avoid any crash */
110     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
111     libvlc_media_descriptor_t * p_md; /* current media descriptor */
112     libvlc_event_manager_t *    p_event_manager;
113     libvlc_drawable_t           drawable;
114 };
115
116 struct libvlc_media_list_player_t
117 {
118     libvlc_event_manager_t * p_event_manager;
119     libvlc_instance_t *      p_libvlc_instance;
120     int                      i_refcount;
121     vlc_mutex_t              object_lock;
122     int                      i_current_playing_index;
123     libvlc_media_descriptor_t * p_current_playing_item;
124     libvlc_media_list_t *    p_mlist;
125     libvlc_media_instance_t *  p_mi;
126 };
127
128 struct libvlc_media_library_t
129 {
130     libvlc_event_manager_t * p_event_manager;
131     libvlc_instance_t *      p_libvlc_instance;
132     int                      i_refcount;
133     libvlc_media_list_t *    p_mlist;
134 };
135
136 struct libvlc_media_discoverer_t
137 {
138     libvlc_event_manager_t * p_event_manager;
139     libvlc_instance_t *      p_libvlc_instance;
140     services_discovery_t *   p_sd;
141     libvlc_media_list_t *    p_mlist;
142 };
143
144 /* 
145  * Event Handling
146  */
147 /* Example usage
148  *
149  * struct libvlc_cool_object_t
150  * {
151  *        ...
152  *        libvlc_event_manager_t * p_event_manager;
153  *        ...
154  * }
155  *
156  * libvlc_my_cool_object_new()
157  * {
158  *        ...
159  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
160  *                                                   p_self->p_libvlc_instance, p_e);
161  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
162  *                libvlc_MyCoolObjectDidSomething, p_e)
163  *        ...
164  * }
165  *
166  * libvlc_my_cool_object_release()
167  * {
168  *         ...
169  *         libvlc_event_manager_release( p_self->p_event_manager );
170  *         ...
171  * }
172  *
173  * libvlc_my_cool_object_do_something()
174  * {
175  *        ...
176  *        libvlc_event_t event;
177  *        event.type = libvlc_MyCoolObjectDidSomething;
178  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
179  *        libvlc_event_send( p_self->p_event_manager, &event );
180  * }
181  * */
182
183 typedef struct libvlc_event_listener_t
184 {
185     libvlc_event_type_t event_type;
186     void *              p_user_data;
187     libvlc_callback_t   pf_callback;
188 } libvlc_event_listener_t;
189
190 typedef struct libvlc_event_listeners_group_t
191 {
192     libvlc_event_type_t event_type;
193     DECL_ARRAY(libvlc_event_listener_t *) listeners;
194 } libvlc_event_listeners_group_t;
195
196 typedef struct libvlc_event_manager_t
197 {
198     void * p_obj;
199     struct libvlc_instance_t * p_libvlc_instance;
200     DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
201 } libvlc_event_sender_t;
202
203
204 /***************************************************************************
205  * Other internal functions
206  ***************************************************************************/
207 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
208                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
209
210 /* Media instance */
211 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
212                         ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
213
214 VLC_EXPORT (void, libvlc_media_instance_destroy,
215                         ( libvlc_media_instance_t * ) );
216
217 /* Media Descriptor */
218 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
219                         ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
220
221 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
222                         ( libvlc_media_descriptor_t * ) );
223
224 /* Events */
225 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
226
227 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
228
229 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
230
231 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
232
233 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 ) );
234
235 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
236
237
238 /* Exception shorcuts */
239
240 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
241                                 return NULL; }
242 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
243                                 return; }
244 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
245                                 return 0; }
246
247 # ifdef __cplusplus
248 }
249 # endif
250
251 #endif