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