1e985e9bf1dde226782215102200b1dc790276fa
[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_media_list_t
84 {
85     libvlc_event_manager_t * p_event_manager;
86     libvlc_instance_t *      p_libvlc_instance;
87     int                      i_refcount;
88     vlc_mutex_t              object_lock;
89     libvlc_media_list_t *    p_media_provider; /* For dynamic sublist */
90     libvlc_tag_query_t *     p_query;              /* For dynamic sublist */
91     char *                   psz_name; /* Usually NULL */
92     DECL_ARRAY(void *) items;
93 };
94
95 struct libvlc_media_instance_t
96 {
97     int                i_refcount;
98     vlc_mutex_t        object_lock;
99     int i_input_id;  /* Input object id. We don't use a pointer to
100                         avoid any crash */
101     struct libvlc_instance_t *  p_libvlc_instance; /* Parent instance */
102     libvlc_media_descriptor_t * p_md; /* current media descriptor */
103     libvlc_event_manager_t *    p_event_manager;
104     libvlc_drawable_t           drawable;
105 };
106
107 struct libvlc_media_list_player_t
108 {
109     libvlc_event_manager_t * p_event_manager;
110     libvlc_instance_t *      p_libvlc_instance;
111     int                      i_refcount;
112     vlc_mutex_t              object_lock;
113     int                      i_current_playing_index;
114     libvlc_media_descriptor_t * p_current_playing_item;
115     libvlc_media_list_t *    p_mlist;
116     libvlc_media_instance_t *  p_mi;
117 };
118
119 struct libvlc_media_library_t
120 {
121     libvlc_event_manager_t * p_event_manager;
122     libvlc_instance_t *      p_libvlc_instance;
123     int                      i_refcount;
124     libvlc_media_list_t *    p_mlist;
125 };
126
127 struct libvlc_media_discoverer_t
128 {
129     libvlc_event_manager_t * p_event_manager;
130     libvlc_instance_t *      p_libvlc_instance;
131     services_discovery_t *   p_sd;
132     libvlc_media_list_t *    p_mlist;
133 };
134
135 /* 
136  * Event Handling
137  */
138 /* Example usage
139  *
140  * struct libvlc_cool_object_t
141  * {
142  *        ...
143  *        libvlc_event_manager_t * p_event_manager;
144  *        ...
145  * }
146  *
147  * libvlc_my_cool_object_new()
148  * {
149  *        ...
150  *        p_self->p_event_manager = libvlc_event_manager_init( p_self,
151  *                                                   p_self->p_libvlc_instance, p_e);
152  *        libvlc_event_manager_register_event_type(p_self->p_event_manager,
153  *                libvlc_MyCoolObjectDidSomething, p_e)
154  *        ...
155  * }
156  *
157  * libvlc_my_cool_object_release()
158  * {
159  *         ...
160  *         libvlc_event_manager_release( p_self->p_event_manager );
161  *         ...
162  * }
163  *
164  * libvlc_my_cool_object_do_something()
165  * {
166  *        ...
167  *        libvlc_event_t event;
168  *        event.type = libvlc_MyCoolObjectDidSomething;
169  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
170  *        libvlc_event_send( p_self->p_event_manager, &event );
171  * }
172  * */
173
174 typedef struct libvlc_event_listener_t
175 {
176     libvlc_event_type_t event_type;
177     void *              p_user_data;
178     libvlc_callback_t   pf_callback;
179 } libvlc_event_listener_t;
180
181 typedef struct libvlc_event_listeners_group_t
182 {
183     libvlc_event_type_t event_type;
184     DECL_ARRAY(libvlc_event_listener_t *) listeners;
185 } libvlc_event_listeners_group_t;
186
187 typedef struct libvlc_event_manager_t
188 {
189     void * p_obj;
190     struct libvlc_instance_t * p_libvlc_instance;
191     DECL_ARRAY(libvlc_event_listeners_group_t *) listeners_groups;
192 } libvlc_event_sender_t;
193
194
195 /***************************************************************************
196  * Other internal functions
197  ***************************************************************************/
198 VLC_EXPORT (input_thread_t *, libvlc_get_input_thread,
199                         ( struct libvlc_media_instance_t *, libvlc_exception_t * ) );
200
201 /* Media instance */
202 VLC_EXPORT (libvlc_media_instance_t *, libvlc_media_instance_new_from_input_thread,
203                         ( struct libvlc_instance_t *, input_thread_t *, libvlc_exception_t * ) );
204
205 VLC_EXPORT (void, libvlc_media_instance_destroy,
206                         ( libvlc_media_instance_t * ) );
207
208 /* Media Descriptor */
209 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_new_from_input_item,
210                         ( struct libvlc_instance_t *, input_item_t *, libvlc_exception_t * ) );
211
212 VLC_EXPORT (libvlc_media_descriptor_t *, libvlc_media_descriptor_duplicate,
213                         ( libvlc_media_descriptor_t * ) );
214
215 /* Events */
216 VLC_EXPORT (void, libvlc_event_init, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
217
218 VLC_EXPORT (void, libvlc_event_fini, ( libvlc_instance_t *p_instance, libvlc_exception_t *p_e ) );
219
220 VLC_EXPORT (libvlc_event_manager_t *, libvlc_event_manager_new, ( void * p_obj, libvlc_instance_t * p_libvlc_inst, libvlc_exception_t *p_e ) );
221
222 VLC_EXPORT (void, libvlc_event_manager_release, ( libvlc_event_manager_t * p_em ) );
223
224 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 ) );
225
226 VLC_EXPORT (void, libvlc_event_send, ( libvlc_event_manager_t * p_em, libvlc_event_t * p_event ) );
227
228
229 /* Exception shorcuts */
230
231 #define RAISENULL( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
232                                 return NULL; }
233 #define RAISEVOID( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
234                                 return; }
235 #define RAISEZERO( psz,a... ) { libvlc_exception_raise( p_e, psz,##a ); \
236                                 return 0; }
237
238 # ifdef __cplusplus
239 }
240 # endif
241
242 #endif