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