]> git.sesse.net Git - vlc/blob - src/libvlc.h
Sanitize/rewrite the message subscription API
[vlc] / src / libvlc.h
1 /*****************************************************************************
2  * libvlc.h: Internal libvlc generic/misc declaration
3  *****************************************************************************
4  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
5  * Copyright © 2006-2007 Rémi Denis-Courmont
6  * $Id$
7  *
8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
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_LIBVLC_H
26 # define LIBVLC_LIBVLC_H 1
27
28 typedef struct variable_t variable_t;
29
30 extern const char vlc_usage[];
31
32 /* Hotkey stuff */
33 extern const struct hotkey libvlc_hotkeys[];
34 extern const size_t libvlc_hotkeys_size;
35 extern int vlc_key_to_action (vlc_object_t *, const char *,
36                               vlc_value_t, vlc_value_t, void *);
37
38 /*
39  * OS-specific initialization
40  */
41 void system_Init      ( libvlc_int_t *, int *, const char *[] );
42 void system_Configure ( libvlc_int_t *, int *, const char *[] );
43 void system_End       ( libvlc_int_t * );
44
45 /*
46  * Threads subsystem
47  */
48
49 /* Hopefully, no need to export this. There is a new thread API instead. */
50 void vlc_thread_cancel (vlc_object_t *);
51 int vlc_object_waitpipe (vlc_object_t *obj);
52
53 void vlc_trace (const char *fn, const char *file, unsigned line);
54 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
55
56 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
57 # define vlc_assert_locked( m ) \
58          assert (pthread_mutex_lock (m) == EDEADLK)
59 #else
60 # define vlc_assert_locked( m ) (void)m
61 #endif
62
63 /*
64  * CPU capabilities
65  */
66 extern uint32_t cpu_flags;
67 uint32_t CPUCapabilities( void );
68
69 /*
70  * Message/logging stuff
71  */
72
73 /**
74  * Store all data required by messages interfaces.
75  */
76 typedef struct msg_bank_t
77 {
78     /** Message queue lock */
79     vlc_mutex_t lock;
80     vlc_cond_t  wait;
81
82     /* Message queue */
83     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
84     int i_start;
85     int i_stop;
86     bool b_overflow;
87
88     /* Subscribers */
89     int i_sub;
90     msg_subscription_t **pp_sub;
91
92     /* Logfile for WinCE */
93 #ifdef UNDER_CE
94     FILE *logfile;
95 #endif
96 } msg_bank_t;
97
98 void msg_Create  (libvlc_int_t *);
99 void msg_Flush   (libvlc_int_t *);
100 void msg_Destroy (libvlc_int_t *);
101
102 /** Internal message stack context */
103 void msg_StackSet ( int, const char*, ... );
104 void msg_StackAdd ( const char*, ... );
105 const char* msg_StackMsg ( void );
106 void msg_StackDestroy (void *);
107
108 /*
109  * Unicode stuff
110  */
111 char *vlc_fix_readdir (const char *);
112
113 /*
114  * LibVLC objects stuff
115  */
116
117 /**
118  * Creates a VLC object.
119  *
120  * Note that because the object name pointer must remain valid, potentially
121  * even after the destruction of the object (through the message queues), this
122  * function CANNOT be exported to plugins as is. In this case, the old
123  * vlc_object_create() must be used instead.
124  *
125  * @param p_this an existing VLC object
126  * @param i_size byte size of the object structure
127  * @param i_type object type, usually VLC_OBJECT_CUSTOM
128  * @param psz_type object type name
129  * @return the created object, or NULL.
130  */
131 extern void *
132 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
133                      const char *psz_type);
134 #define vlc_custom_create(o, s, t, n) \
135         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
136
137 /*
138  * To be cleaned-up module stuff:
139  */
140 extern char *psz_vlcpath;
141
142 /* Return a NULL terminated array with the names of the modules that have a
143  * certain capability.
144  * Free after uses both the string and the table. */
145 VLC_EXPORT(char **, module_GetModulesNamesForCapability,
146                     ( const char * psz_capability, char ***psz_longname ) );
147
148 #ifdef LIBVLC_USE_PTHREAD
149 # include <semaphore.h> /* TODO: get rid of vlc_thread_ready and this */
150 #endif
151
152 /**
153  * Private LibVLC data for each object.
154  */
155 typedef struct vlc_object_internals_t
156 {
157     /* Object variables */
158     variable_t *    p_vars;
159     vlc_mutex_t     var_lock;
160     int             i_vars;
161
162     /* Thread properties, if any */
163     vlc_thread_t    thread_id;
164     bool            b_thread;
165 #ifdef LIBVLC_USE_PTHREAD
166     sem_t           thread_ready;
167 #elif defined (WIN32)
168     HANDLE          thread_ready;
169 #endif
170
171     /* Objects thread synchronization */
172     vlc_mutex_t     lock;
173     vlc_cond_t      wait;
174     int             pipes[2];
175     vlc_spinlock_t  spin;
176
177     /* Objects management */
178     vlc_spinlock_t   ref_spin;
179     unsigned         i_refcount;
180     vlc_destructor_t pf_destructor;
181
182     /* Objects tree structure */
183     vlc_object_t    *prev, *next;
184     vlc_object_t   **pp_children;
185     int              i_children;
186 } vlc_object_internals_t;
187
188 #define ZOOM_SECTION N_("Zoom")
189 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
190 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
191 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
192 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
193
194 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
195
196 typedef struct sap_handler_t sap_handler_t;
197
198 /**
199  * Private LibVLC instance data.
200  */
201 typedef struct libvlc_priv_t
202 {
203     libvlc_int_t       public_data;
204
205     /* Configuration */
206     vlc_mutex_t        config_lock; ///< config file lock
207     char *             psz_configfile;   ///< location of config file
208
209     int                i_last_input_id ; ///< Last id of input item
210
211     /* Messages */
212     msg_bank_t         msg_bank;    ///< The message bank
213     int                i_verbose;   ///< info messages
214     bool               b_color;     ///< color messages?
215     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
216     bool               msg_all_objects_enabled; ///< Should we print all objects?
217
218     /* Timer stats */
219     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
220     counter_t        **pp_timers;   ///< Array of all timers
221     int                i_timers;    ///< Number of timers
222     bool               b_stats;     ///< Whether to collect stats
223
224     void              *p_stats_computer;  ///< Input thread computing stats
225                                           /// (needs cleanup)
226
227     /* Singleton objects */
228     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
229     playlist_t        *p_playlist; //< the playlist singleton
230     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
231     interaction_t     *p_interaction;    ///< interface interaction object
232     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
233 #ifdef ENABLE_SOUT
234     sap_handler_t     *p_sap; ///< SAP SDP advertiser
235 #endif
236     vlc_mutex_t        structure_lock;
237 } libvlc_priv_t;
238
239 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
240 {
241     return (libvlc_priv_t *)libvlc;
242 }
243
244 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
245
246 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
247
248 /**
249  * LibVLC "main module" configuration settings array.
250  */
251 extern module_config_t libvlc_config[];
252 extern const size_t libvlc_config_count;
253
254 /*
255  * Variables stuff
256  */
257 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
258
259 /*
260  * Replacement functions
261  */
262 # ifndef HAVE_DIRENT_H
263 typedef void DIR;
264 #  ifndef FILENAME_MAX
265 #      define FILENAME_MAX (260)
266 #  endif
267 struct dirent
268 {
269     long            d_ino;          /* Always zero. */
270     unsigned short  d_reclen;       /* Always zero. */
271     unsigned short  d_namlen;       /* Length of name in d_name. */
272     char            d_name[FILENAME_MAX]; /* File name. */
273 };
274 #  define opendir vlc_opendir
275 #  define readdir vlc_readdir
276 #  define closedir vlc_closedir
277 #  define rewinddir vlc_rewindir
278 void *vlc_opendir (const char *);
279 void *vlc_readdir (void *);
280 int   vlc_closedir(void *);
281 void  vlc_rewinddir(void *);
282 # endif
283
284 #if defined (WIN32)
285 #   include <dirent.h>
286 void *vlc_wopendir (const wchar_t *);
287 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
288 struct _wdirent *vlc_wreaddir (void *);
289 void vlc_rewinddir (void *);
290 #   define _wopendir vlc_wopendir
291 #   define _wreaddir vlc_wreaddir
292 #   define _wclosedir vlc_wclosedir
293 #   define rewinddir vlc_rewinddir
294 #endif
295
296 #endif