ec8d7c898d671017674a415f63b06403ae8d75ec
[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 extern const char vlc_usage[];
29
30 /* Hotkey stuff */
31 extern const struct hotkey libvlc_hotkeys[];
32 extern const size_t libvlc_hotkeys_size;
33 extern int vlc_key_to_action (vlc_object_t *, const char *,
34                               vlc_value_t, vlc_value_t, void *);
35
36 /*
37  * OS-specific initialization
38  */
39 void system_Init      ( libvlc_int_t *, int *, const char *[] );
40 void system_Configure ( libvlc_int_t *, int *, const char *[] );
41 void system_End       ( libvlc_int_t * );
42
43 #if defined( SYS_BEOS )
44 /* Nothing at the moment, create beos_specific.h when needed */
45 #elif defined( __APPLE__ )
46 /* Nothing at the moment, create darwin_specific.h when needed */
47 #elif defined( WIN32 ) || defined( UNDER_CE )
48 VLC_EXPORT( const char * , system_VLCPath, (void));
49 #else
50 # define system_Init( a, b, c )      (void)0
51 # define system_Configure( a, b, c ) (void)0
52 # define system_End( a )             (void)0
53 #endif
54
55
56 /*
57  * Threads subsystem
58  */
59 int vlc_threads_init( void );
60 void vlc_threads_end( void );
61
62 /** The global thread var for msg stack context
63  *  We store this as a static global variable so we don't need a vlc_object_t
64  *  everywhere.
65  *  This key is created in vlc_threads_init and is therefore ready to use at
66  *  the very beginning of the universe */
67 extern vlc_threadvar_t msg_context_global_key;
68
69 /*
70  * CPU capabilities
71  */
72 extern uint32_t cpu_flags;
73 uint32_t CPUCapabilities( void );
74
75 /*
76  * Message/logging stuff
77  */
78
79 #define NB_QUEUES 2
80
81 typedef struct msg_queue_t
82 {
83     int                     i_id;
84
85     /** Message queue lock */
86     vlc_mutex_t             lock;
87     bool              b_overflow;
88
89     /* Message queue */
90     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
91     int i_start;
92     int i_stop;
93
94     /* Subscribers */
95     int i_sub;
96     msg_subscription_t **pp_sub;
97
98     /* Logfile for WinCE */
99 #ifdef UNDER_CE
100     FILE *logfile;
101 #endif
102 } msg_queue_t;
103
104 /**
105  * Store all data requiered by messages interfaces.
106  */
107 typedef struct msg_bank_t
108 {
109     vlc_mutex_t             lock;
110     msg_queue_t             queues[NB_QUEUES];
111 } msg_bank_t;
112
113 /*
114  * Unicode stuff
115  */
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
139 /**
140  * libvlc_global_data_t (global variable)
141  *
142  * This structure has an unique instance, statically allocated in libvlc and
143  * never accessed from the outside. It stores process-wide VLC variables,
144  * mostly process-wide locks, and (currently) the module bank and objects tree.
145  */
146 typedef struct libvlc_global_data_t
147 {
148     VLC_COMMON_MEMBERS
149
150    /* Object structure data */
151     int                    i_counter;   ///< object counter
152     int                    i_objects;   ///< Attached objects count
153     vlc_object_t **        pp_objects;  ///< Array of all objects
154
155     module_bank_t *        p_module_bank; ///< The module bank
156
157     /* Arch-specific variables */
158 #if defined( SYS_BEOS )
159     char *                 psz_vlcpath;
160 #elif defined( __APPLE__ )
161     char *                 psz_vlcpath;
162 #elif defined( WIN32 )
163     char *                 psz_vlcpath;
164 #endif
165 } libvlc_global_data_t;
166
167
168 libvlc_global_data_t *vlc_global (void);
169 libvlc_int_t *vlc_current_object (int i_object);
170
171 /**
172  * Private LibVLC data for each object.
173  */
174 struct vlc_object_internals_t
175 {
176     /* Object variables */
177     variable_t *    p_vars;
178     vlc_mutex_t     var_lock;
179     int             i_vars;
180
181     /* Thread properties, if any */
182     vlc_thread_t    thread_id;
183     bool            b_thread;
184
185     /* Objects thread synchronization */
186     int             pipes[2];
187     vlc_spinlock_t  spin;
188
189     /* Objects management */
190     unsigned         i_refcount;
191     vlc_destructor_t pf_destructor;
192     bool             b_attached;
193 };
194
195 #define ZOOM_SECTION N_("Zoom")
196 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
197 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
198 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
199 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
200
201 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
202 {
203     return ((vlc_object_internals_t *)obj) - 1;
204 }
205
206 /**
207  * Private LibVLC instance data.
208  */
209 typedef struct libvlc_priv_t
210 {
211     /* Configuration */
212     vlc_mutex_t        config_lock; ///< config file lock
213     char *             psz_configfile;   ///< location of config file
214
215     /* There is no real reason to keep a list of items, but not to break
216      * everything, let's keep it */
217     input_item_array_t input_items; ///< Array of all created input items
218     int                i_last_input_id ; ///< Last id of input item
219
220     /* Messages */
221     msg_bank_t         msg_bank;    ///< The message bank
222     int                i_verbose;   ///< info messages
223     bool               b_color;     ///< color messages?
224
225     /* Timer stats */
226     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
227     counter_t        **pp_timers;   ///< Array of all timers
228     int                i_timers;    ///< Number of timers
229     bool               b_stats;     ///< Whether to collect stats
230
231     void              *p_stats_computer;  ///< Input thread computing stats
232                                           /// (needs cleanup)
233
234     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
235     vlm_t             *p_vlm;  ///< VLM if created from libvlc-common.c
236     vlc_object_t      *p_interaction;    ///< interface interaction object
237     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
238 } libvlc_priv_t;
239
240 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
241 {
242     return (libvlc_priv_t *)(libvlc + 1);
243 }
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 #endif