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