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
30 extern const char vlc_usage[];
32 extern const struct hotkey libvlc_hotkeys[];
33 extern const size_t libvlc_hotkeys_size;
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 * );
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));
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
59 int __vlc_threads_init( vlc_object_t * );
60 int __vlc_threads_end( vlc_object_t * );
65 extern uint32_t cpu_flags;
66 uint32_t CPUCapabilities( void );
73 * LibVLC objects stuff
77 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
78 const char *psz_type);
80 /*****************************************************************************
81 * libvlc_global_data_t (global variable)
82 *****************************************************************************
83 * This structure has an unique instance, statically allocated in main and
84 * never accessed from the outside. It stores once-initialized data such as
85 * the CPU capabilities or the global lock.
86 *****************************************************************************/
87 struct libvlc_global_data_t
91 vlc_bool_t b_ready; ///< Initialization boolean
93 /* Object structure data */
94 int i_counter; ///< object counter
95 int i_objects; ///< Attached objects count
96 vlc_object_t ** pp_objects; ///< Array of all objects
98 module_bank_t * p_module_bank; ///< The module bank
99 intf_thread_t *p_probe; ///< Devices prober
101 /* Arch-specific variables */
102 #if !defined( WIN32 )
105 #if defined( SYS_BEOS )
106 vlc_object_t * p_appthread;
108 #elif defined( __APPLE__ )
110 vlc_iconv_t iconv_macosx; /* for HFS+ file names */
111 vlc_mutex_t iconv_lock;
112 #elif defined( WIN32 )
118 libvlc_global_data_t *vlc_global (void);
119 libvlc_int_t *vlc_current_object (int i_object);
121 /* Private LibVLC data for each objects */
122 struct vlc_object_internals_t
124 /* Object variables */
126 vlc_mutex_t var_lock;
129 /* Thread properties, if any */
130 vlc_thread_t thread_id;
133 /* Objects thread synchronization */
137 /* Objects management */
139 vlc_bool_t b_attached;
142 #define ZOOM_SECTION N_("Zoom")
143 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
144 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
145 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
146 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
148 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
150 return obj->p_internals;
153 extern module_config_t libvlc_config[];
154 extern const size_t libvlc_config_count;
159 void var_OptionParse (vlc_object_t *, const char *, bool trusted);