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