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