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[];
30 extern const struct hotkey libvlc_hotkeys[];
31 extern const size_t libvlc_hotkeys_size;
37 int __vlc_threads_init( vlc_object_t * );
38 int __vlc_threads_end( vlc_object_t * );
43 extern uint32_t cpu_flags;
44 uint32_t CPUCapabilities( void );
51 * LibVLC objects stuff
55 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
56 const char *psz_type);
58 /*****************************************************************************
59 * libvlc_global_data_t (global variable)
60 *****************************************************************************
61 * This structure has an unique instance, statically allocated in main and
62 * never accessed from the outside. It stores once-initialized data such as
63 * the CPU capabilities or the global lock.
64 *****************************************************************************/
65 struct libvlc_global_data_t
69 vlc_bool_t b_ready; ///< Initialization boolean
71 /* Object structure data */
72 int i_counter; ///< object counter
73 int i_objects; ///< Attached objects count
74 vlc_object_t ** pp_objects; ///< Array of all objects
76 module_bank_t * p_module_bank; ///< The module bank
77 intf_thread_t *p_probe; ///< Devices prober
79 /* Arch-specific variables */
83 #if defined( SYS_BEOS )
84 vlc_object_t * p_appthread;
86 #elif defined( __APPLE__ )
88 vlc_iconv_t iconv_macosx; /* for HFS+ file names */
89 vlc_mutex_t iconv_lock;
90 #elif defined( WIN32 )
96 libvlc_global_data_t *vlc_global (void);
97 libvlc_int_t *vlc_current_object (int i_object);
99 /* Private LibVLC data for each objects */
100 struct vlc_object_internals_t
102 /* Object variables */
104 vlc_mutex_t var_lock;
107 /* Thread properties, if any */
108 vlc_thread_t thread_id;
111 /* Objects thread synchronization */
112 vlc_bool_t b_signaled;
116 /* Objects management */
118 vlc_bool_t b_attached;
122 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
124 return obj->p_internals;
128 * Configuration stuff
131 struct module_config_t
133 int i_type; /* Configuration type */
134 const char *psz_type; /* Configuration subtype */
135 const char *psz_name; /* Option name */
136 char i_short; /* Optional short option name */
137 const char *psz_text; /* Short comment on the configuration option */
138 const char *psz_longtext; /* Long comment on the configuration option */
139 module_value_t value; /* Option value */
141 module_value_t saved;
145 /* Function to call when commiting a change */
146 vlc_callback_t pf_callback;
147 void *p_callback_data;
150 const char **ppsz_list; /* List of possible values for the option */
151 int *pi_list; /* Idem for integers */
152 const char **ppsz_list_text; /* Friendly names for list values */
153 int i_list; /* Options list size */
156 vlc_callback_t *ppf_action; /* List of possible actions for a config */
157 const char **ppsz_action_text; /* Friendly names for actions */
158 int i_action; /* actions list size */
161 vlc_mutex_t *p_lock; /* Lock to use when modifying the config */
162 vlc_bool_t b_dirty; /* Dirty flag to indicate a config change */
163 vlc_bool_t b_advanced; /* Flag to indicate an advanced option */
164 vlc_bool_t b_internal; /* Flag to indicate option is not to be shown */
165 vlc_bool_t b_restart; /* Flag to indicate the option needs a restart */
169 const char *psz_current; /* Good option name */
170 vlc_bool_t b_strict; /* Transitionnal or strict */
172 /* Option values loaded from config file */
173 vlc_bool_t b_autosave; /* Config will be auto-saved at exit time */
174 vlc_bool_t b_unsaveable; /* Config should be saved */
178 extern module_config_t libvlc_config[];
179 extern const size_t libvlc_config_count;