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 );
52 extern uint32_t cpu_flags;
53 uint32_t CPUCapabilities( void );
56 * Message/logging stuff
59 typedef struct msg_queue_t
61 /** Message queue lock */
66 msg_item_t msg[VLC_MSG_QSIZE]; /**< message queue */
72 msg_subscription_t **pp_sub;
74 /* Logfile for WinCE */
81 * Store all data required by messages interfaces.
83 typedef struct msg_bank_t
89 void msg_Create (libvlc_int_t *);
90 void msg_Flush (libvlc_int_t *);
91 void msg_Destroy (libvlc_int_t *);
93 /** Internal message stack context */
100 void msg_StackSet ( int, const char*, ... );
101 void msg_StackAdd ( const char*, ... );
102 const char* msg_StackMsg ( void );
103 /** The global thread var for msg stack context
104 * We store this as a static global variable so we don't need a vlc_object_t
106 * This key is created in vlc_threads_init and is therefore ready to use at
107 * the very beginning of the universe */
108 extern vlc_threadvar_t msg_context_global_key;
109 void msg_StackDestroy (void *);
114 char *vlc_fix_readdir (const char *);
115 bool vlc_current_charset (char **);
118 * LibVLC objects stuff
122 * Creates a VLC object.
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.
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.
136 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
137 const char *psz_type);
140 * libvlc_global_data_t (global variable)
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.
146 typedef struct libvlc_global_data_t
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
155 module_bank_t * p_module_bank; ///< The module bank
158 } libvlc_global_data_t;
161 libvlc_global_data_t *vlc_global (void);
162 libvlc_int_t *vlc_current_object (int i_object);
165 * Private LibVLC data for each object.
167 struct vlc_object_internals_t
169 /* Object variables */
171 vlc_mutex_t var_lock;
174 /* Thread properties, if any */
175 vlc_thread_t thread_id;
178 /* Objects thread synchronization */
182 /* Objects management */
183 vlc_spinlock_t ref_spin;
185 vlc_destructor_t pf_destructor;
187 vlc_object_t **pp_children;
191 #define ZOOM_SECTION N_("Zoom")
192 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
193 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
194 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
195 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
197 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
199 return ((vlc_object_internals_t *)obj) - 1;
203 * Private LibVLC instance data.
205 typedef struct libvlc_priv_t
208 vlc_mutex_t config_lock; ///< config file lock
209 char * psz_configfile; ///< location of config file
211 /* There is no real reason to keep a list of items, but not to break
212 * everything, let's keep it */
213 input_item_array_t input_items; ///< Array of all created input items
214 int i_last_input_id ; ///< Last id of input item
217 msg_bank_t msg_bank; ///< The message bank
218 int i_verbose; ///< info messages
219 bool b_color; ///< color messages?
222 vlc_mutex_t timer_lock; ///< Lock to protect timers
223 counter_t **pp_timers; ///< Array of all timers
224 int i_timers; ///< Number of timers
225 bool b_stats; ///< Whether to collect stats
227 void *p_stats_computer; ///< Input thread computing stats
230 module_t *p_memcpy_module; ///< Fast memcpy plugin used
231 playlist_t *p_playlist; //< the playlist singleton
232 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
233 vlc_object_t *p_interaction; ///< interface interaction object
234 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
237 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
239 return (libvlc_priv_t *)(libvlc + 1);
242 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
245 * LibVLC "main module" configuration settings array.
247 extern module_config_t libvlc_config[];
248 extern const size_t libvlc_config_count;
253 void var_OptionParse (vlc_object_t *, const char *, bool trusted);