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 * );
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 * Creates a VLC object.
79 * Note that because the object name pointer must remain valid, potentially
80 * even after the destruction of the object (through the message queues), this
81 * function CANNOT be exported to plugins as is. In this case, the old
82 * vlc_object_create() must be used instead.
84 * @param p_this an existing VLC object
85 * @param i_size byte size of the object structure
86 * @param i_type object type, usually VLC_OBJECT_CUSTOM
87 * @param psz_type object type name
88 * @return the created object, or NULL.
91 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
92 const char *psz_type);
94 /*****************************************************************************
95 * libvlc_global_data_t (global variable)
96 *****************************************************************************
97 * This structure has an unique instance, statically allocated in main and
98 * never accessed from the outside. It stores once-initialized data such as
99 * the CPU capabilities or the global lock.
100 *****************************************************************************/
101 struct libvlc_global_data_t
105 vlc_bool_t b_ready; ///< Initialization boolean
107 /* Object structure data */
108 int i_counter; ///< object counter
109 int i_objects; ///< Attached objects count
110 vlc_object_t ** pp_objects; ///< Array of all objects
112 module_bank_t * p_module_bank; ///< The module bank
113 intf_thread_t *p_probe; ///< Devices prober
115 /* Arch-specific variables */
116 #if !defined( WIN32 )
119 #if defined( SYS_BEOS )
120 vlc_object_t * p_appthread;
122 #elif defined( __APPLE__ )
124 vlc_iconv_t iconv_macosx; /* for HFS+ file names */
125 vlc_mutex_t iconv_lock;
126 #elif defined( WIN32 )
132 libvlc_global_data_t *vlc_global (void);
133 libvlc_int_t *vlc_current_object (int i_object);
135 /* Private LibVLC data for each objects */
136 struct vlc_object_internals_t
138 /* Object variables */
140 vlc_mutex_t var_lock;
143 /* Thread properties, if any */
144 vlc_thread_t thread_id;
147 /* Objects thread synchronization */
151 /* Objects management */
153 vlc_destructor_t pf_destructor;
154 vlc_bool_t b_attached;
157 #define ZOOM_SECTION N_("Zoom")
158 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
159 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
160 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
161 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
163 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
165 return obj->p_internals;
168 extern module_config_t libvlc_config[];
169 extern const size_t libvlc_config_count;
174 void var_OptionParse (vlc_object_t *, const char *, bool trusted);