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
8 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 #ifndef LIBVLC_LIBVLC_H
26 # define LIBVLC_LIBVLC_H 1
28 extern const char vlc_usage[];
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 *);
37 * OS-specific initialization
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 * );
46 int vlc_threads_init( void );
47 void vlc_threads_end( void );
49 /** The global thread var for msg stack context
50 * We store this as a static global variable so we don't need a vlc_object_t
52 * This key is created in vlc_threads_init and is therefore ready to use at
53 * the very beginning of the universe */
54 extern vlc_threadvar_t msg_context_global_key;
59 extern uint32_t cpu_flags;
60 uint32_t CPUCapabilities( void );
63 * Message/logging stuff
66 typedef struct msg_queue_t
68 /** Message queue lock */
73 msg_item_t msg[VLC_MSG_QSIZE]; /**< message queue */
79 msg_subscription_t **pp_sub;
81 /* Logfile for WinCE */
88 * Store all data required by messages interfaces.
90 typedef struct msg_bank_t
96 void msg_Create (libvlc_int_t *);
97 void msg_Flush (libvlc_int_t *);
98 void msg_Destroy (libvlc_int_t *);
100 /** Internal message stack context */
107 void msg_StackSet ( int, const char*, ... );
108 void msg_StackAdd ( const char*, ... );
109 const char* msg_StackMsg ( void );
116 * LibVLC objects stuff
120 * Creates a VLC object.
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.
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.
134 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
135 const char *psz_type);
138 * libvlc_global_data_t (global variable)
140 * This structure has an unique instance, statically allocated in libvlc and
141 * never accessed from the outside. It stores process-wide VLC variables,
142 * mostly process-wide locks, and (currently) the module bank and objects tree.
144 typedef struct libvlc_global_data_t
148 /* Object structure data */
149 int i_counter; ///< object counter
150 int i_objects; ///< Attached objects count
151 vlc_object_t ** pp_objects; ///< Array of all objects
153 module_bank_t * p_module_bank; ///< The module bank
156 } libvlc_global_data_t;
159 libvlc_global_data_t *vlc_global (void);
160 libvlc_int_t *vlc_current_object (int i_object);
163 * Private LibVLC data for each object.
165 struct vlc_object_internals_t
167 /* Object variables */
169 vlc_mutex_t var_lock;
172 /* Thread properties, if any */
173 vlc_thread_t thread_id;
176 /* Objects thread synchronization */
180 /* Objects management */
181 vlc_spinlock_t ref_spin;
183 vlc_destructor_t pf_destructor;
187 #define ZOOM_SECTION N_("Zoom")
188 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
189 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
190 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
191 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
193 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
195 return ((vlc_object_internals_t *)obj) - 1;
199 * Private LibVLC instance data.
201 typedef struct libvlc_priv_t
204 vlc_mutex_t config_lock; ///< config file lock
205 char * psz_configfile; ///< location of config file
207 /* There is no real reason to keep a list of items, but not to break
208 * everything, let's keep it */
209 input_item_array_t input_items; ///< Array of all created input items
210 int i_last_input_id ; ///< Last id of input item
213 msg_bank_t msg_bank; ///< The message bank
214 int i_verbose; ///< info messages
215 bool b_color; ///< color messages?
218 vlc_mutex_t timer_lock; ///< Lock to protect timers
219 counter_t **pp_timers; ///< Array of all timers
220 int i_timers; ///< Number of timers
221 bool b_stats; ///< Whether to collect stats
223 void *p_stats_computer; ///< Input thread computing stats
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 vlc_object_t *p_interaction; ///< interface interaction object
230 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
233 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
235 return (libvlc_priv_t *)(libvlc + 1);
238 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
241 * LibVLC "main module" configuration settings array.
243 extern module_config_t libvlc_config[];
244 extern const size_t libvlc_config_count;
249 void var_OptionParse (vlc_object_t *, const char *, bool trusted);