1 /*****************************************************************************
2 * libvlc.h: main libvlc header
3 *****************************************************************************
4 * Copyright (C) 1998-2002 VideoLAN
5 * $Id: libvlc.h,v 1.19 2002/10/08 18:10:09 sam Exp $
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@netcourrier.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 #define Nothing here, this is just to prevent update-po from being stupid
28 /*****************************************************************************
29 * Configuration options for the main program. Each module will also separatly
30 * define its own configuration options.
31 * Look into configuration.h if you need to know more about the following
33 *****************************************************************************/
34 #define INTF_TEXT N_("interface module")
35 #define INTF_LONGTEXT N_( \
36 "This option allows you to select the interface used by vlc. " \
37 "The default behavior is to automatically select the best module " \
40 #define VERBOSE_TEXT N_("verbosity (0,1,2)")
41 #define VERBOSE_LONGTEXT N_( \
42 "This options sets the verbosity level (0=only errors and " \
43 "standard messages, 1=warnings, 2=debug.")
45 #define QUIET_TEXT N_("be quiet")
46 #define QUIET_LONGTEXT N_( \
47 "This options turns off all warning and information messages.")
49 #define COLOR_TEXT N_("color messages")
50 #define COLOR_LONGTEXT N_( \
51 "When this option is turned on, the messages sent to the console will " \
52 "be colorized. Your terminal needs Linux color support for this to work.")
54 #define INTF_PATH_TEXT N_("interface default search path")
55 #define INTF_PATH_LONGTEXT N_( \
56 "This option allows you to set the default path that the interface will " \
57 "open when looking for a file.")
59 #define PLUGIN_PATH_TEXT N_("plugin search path")
60 #define PLUGIN_PATH_LONGTEXT N_( \
61 "This option allows you to specify an additional path for vlc to look" \
64 #define AOUT_TEXT N_("audio output module")
65 #define AOUT_LONGTEXT N_( \
66 "This option allows you to select the audio output method used by vlc. " \
67 "The default behavior is to automatically select the best method " \
70 #define AUDIO_TEXT N_("enable audio")
71 #define AUDIO_LONGTEXT N_( \
72 "You can completely disable the audio output. In this case the audio " \
73 "decoding stage won't be done, and it will save some processing power.")
75 #define MONO_TEXT N_("force mono audio")
76 #define MONO_LONGTEXT N_("This will force a mono audio output")
78 #define VOLUME_TEXT N_("audio output volume")
79 #define VOLUME_LONGTEXT N_( \
80 "You can set the default audio output volume here, in a range from 0 to " \
83 #define FORMAT_TEXT N_("audio output format")
84 #define FORMAT_LONGTEXT N_( \
85 "You can force the audio output format here.\n" \
86 "0 -> 16 bits signed native endian (default)\n" \
87 "1 -> 8 bits unsigned\n" \
88 "2 -> 16 bits signed little endian\n" \
89 "3 -> 16 bits signed big endian\n" \
90 "4 -> 8 bits signed\n" \
91 "5 -> 16 bits unsigned little endian\n" \
92 "6 -> 16 bits unsigned big endian\n" \
93 "7 -> MPEG2 audio (unsupported)\n" \
94 "8 -> A52 pass-through")
96 #define AOUT_RATE_TEXT N_("audio output frequency (Hz)")
97 #define AOUT_RATE_LONGTEXT N_( \
98 "You can force the audio output frequency here. Common values are " \
99 "48000, 44100, 32000, 22050, 16000, 11025, 8000.")
101 #define AOUT_CHANNELS_TEXT N_("number of channels of audio output")
102 #define AOUT_CHANNELS_LONGTEXT N_( \
103 "Mono is 1, stereo is 2. Higher value (used for 5.1) may not be " \
104 "supported by your audio output module.")
106 #define DESYNC_TEXT N_("compensate desynchronization of audio (in ms)")
107 #define DESYNC_LONGTEXT N_( \
108 "This option allows you to delay the audio output. This can be handy if " \
109 "you notice a lag between the video and the audio.")
111 #define VOUT_TEXT N_("video output module")
112 #define VOUT_LONGTEXT N_( \
113 "This option allows you to select the video output method used by vlc. " \
114 "The default behavior is to automatically select the best " \
117 #define VIDEO_TEXT N_("enable video")
118 #define VIDEO_LONGTEXT N_( \
119 "You can completely disable the video output. In this case the video " \
120 "decoding stage won't be done, which will save some processing power.")
122 #define DISPLAY_TEXT N_("display identifier")
123 #define DISPLAY_LONGTEXT N_( \
124 "This is the local display port that will be used for X11 drawing. " \
125 "For instance :0.1.")
127 #define WIDTH_TEXT N_("video width")
128 #define WIDTH_LONGTEXT N_( \
129 "You can enforce the video width here. By default vlc will " \
130 "adapt to the video characteristics.")
132 #define HEIGHT_TEXT N_("video height")
133 #define HEIGHT_LONGTEXT N_( \
134 "You can enforce the video height here. By default vlc will " \
135 "adapt to the video characteristics.")
137 #define ZOOM_TEXT N_("zoom video")
138 #define ZOOM_LONGTEXT N_( \
139 "You can zoom the video by the specified factor.")
141 #define GRAYSCALE_TEXT N_("grayscale video output")
142 #define GRAYSCALE_LONGTEXT N_( \
143 "When enabled, the color information from the video won't be decoded " \
144 "(this can also allow you to save some processing power).")
146 #define FULLSCREEN_TEXT N_("fullscreen video output")
147 #define FULLSCREEN_LONGTEXT N_( \
148 "If this option is enabled, vlc will always start a video in fullscreen " \
151 #define OVERLAY_TEXT N_("overlay video output")
152 #define OVERLAY_LONGTEXT N_( \
153 "If enabled, vlc will try to take advantage of the overlay capabilities " \
154 "of you graphics card.")
156 #define SPUMARGIN_TEXT N_("force SPU position")
157 #define SPUMARGIN_LONGTEXT N_( \
158 "You can use this option to place the subtitles under the movie, " \
159 "instead of over the movie. Try several positions.")
161 #define FILTER_TEXT N_("video filter module")
162 #define FILTER_LONGTEXT N_( \
163 "This will allow you to add a post-processing filter to enhance the " \
164 "picture quality, for instance deinterlacing, or to clone or distort " \
167 #define SERVER_PORT_TEXT N_("server port")
168 #define SERVER_PORT_LONGTEXT N_( \
169 "This is the port used for UDP streams. By default, we chose 1234.")
171 #define MTU_TEXT N_("MTU of the interface")
172 #define MTU_LONGTEXT N_( \
173 "This is the typical size of UDP packets that we expect. On Ethernet " \
174 "it is usually 1500.")
176 #define NETCHANNEL_TEXT N_("enable network channel mode")
177 #define NETCHANNEL_LONGTEXT N_( \
178 "Activate this option if you want to use the VideoLAN Channel Server.")
180 #define CHAN_SERV_TEXT N_("channel server address")
181 #define CHAN_SERV_LONGTEXT N_( \
182 "Indicate here the address of the VideoLAN Channel Server.")
184 #define CHAN_PORT_TEXT N_("channel server port")
185 #define CHAN_PORT_LONGTEXT N_( \
186 "Indicate here the port on which the VideoLAN Channel Server runs.")
188 #define IFACE_TEXT N_("network interface")
189 #define IFACE_LONGTEXT N_( \
190 "If you have several interfaces on your Linux machine and use the " \
191 "VLAN solution, you may indicate here which interface to use.")
193 #define IFACE_ADDR_TEXT N_("network interface address")
194 #define IFACE_ADDR_LONGTEXT N_( \
195 "If you have several interfaces on your machine and use the " \
196 "multicast solution, you will probably have to indicate the IP address " \
197 "of your multicasting interface here.")
199 #define INPUT_PROGRAM_TEXT N_("choose program (SID)")
200 #define INPUT_PROGRAM_LONGTEXT N_( \
201 "Choose the program to select by giving its Service ID.")
203 #define INPUT_AUDIO_TEXT N_("choose audio")
204 #define INPUT_AUDIO_LONGTEXT N_( \
205 "Give the default type of audio you want to use in a DVD.")
207 #define INPUT_CHAN_TEXT N_("choose channel")
208 #define INPUT_CHAN_LONGTEXT N_( \
209 "Give the stream number of the audio channel you want to use in a DVD " \
212 #define INPUT_SUBT_TEXT N_("choose subtitles")
213 #define INPUT_SUBT_LONGTEXT N_( \
214 "Give the stream number of the subtitle channel you want to use in a " \
215 "DVD (from 1 to n).")
217 #define DVD_DEV_TEXT N_("DVD device")
218 #define DVD_DEV_LONGTEXT N_( \
219 "This is the default DVD device to use.")
221 #define VCD_DEV_TEXT N_("VCD device")
222 #define VCD_DEV_LONGTEXT N_( \
223 "This is the default VCD device to use.")
225 #define IPV6_TEXT N_("force IPv6")
226 #define IPV6_LONGTEXT N_( \
227 "If you check this box, IPv6 will be used by default for all UDP and " \
230 #define IPV4_TEXT N_("force IPv4")
231 #define IPV4_LONGTEXT N_( \
232 "If you check this box, IPv4 will be used by default for all UDP and " \
235 #define CODEC_TEXT N_("choose preferred codec list")
236 #define CODEC_LONGTEXT N_( \
237 "This allows you to select the order in which vlc will choose its " \
238 "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
239 "before the new one. Please be aware that vlc does not make any " \
240 "difference between audio or video codecs, so you should always specify " \
241 "'any' at the end of the list to make sure there is a fallback for the " \
242 "types you didn't specify.")
244 #define SOUT_TEXT N_("choose a stream output")
245 #define SOUT_LONGTEXT N_( \
246 "Empty if no stream output.")
248 #define MMX_TEXT N_("enable CPU MMX support")
249 #define MMX_LONGTEXT N_( \
250 "If your processor supports the MMX instructions set, vlc can take " \
251 "advantage of them.")
253 #define THREE_DN_TEXT N_("enable CPU 3D Now! support")
254 #define THREE_DN_LONGTEXT N_( \
255 "If your processor supports the 3D Now! instructions set, vlc can take "\
256 "advantage of them.")
258 #define MMXEXT_TEXT N_("enable CPU MMX EXT support")
259 #define MMXEXT_LONGTEXT N_( \
260 "If your processor supports the MMX EXT instructions set, vlc can take "\
261 "advantage of them.")
263 #define SSE_TEXT N_("enable CPU SSE support")
264 #define SSE_LONGTEXT N_( \
265 "If your processor supports the SSE instructions set, vlc can take " \
266 "can take advantage of them.")
268 #define ALTIVEC_TEXT N_("enable CPU AltiVec support")
269 #define ALTIVEC_LONGTEXT N_( \
270 "If your processor supports the AltiVec instructions set, vlc can take "\
271 "advantage of them.")
273 #define RANDOM_TEXT N_("play files randomly forever")
274 #define RANDOM_LONGTEXT N_( \
275 "When selected, vlc will randomly play files in the playlist until " \
278 #define LAUNCH_TEXT N_("launch playlist on startup")
279 #define LAUNCH_LONGTEXT N_( \
280 "If you want vlc to start playing on startup, then enable this option.")
282 #define ENQUEUE_TEXT N_("enqueue items in playlist")
283 #define ENQUEUE_LONGTEXT N_( \
284 "If you want vlc to add items to the playlist as you open them, then " \
285 "enable this option.")
287 #define LOOP_TEXT N_("loop playlist on end")
288 #define LOOP_LONGTEXT N_( \
289 "If you want vlc to keep playing the playlist indefinitely then enable " \
292 #define MEMCPY_TEXT N_("memory copy module")
293 #define MEMCPY_LONGTEXT N_( \
294 "You can select wich memory copy module you want to use. By default vlc " \
295 "will select the fastest one supported by your hardware.")
297 #define ACCESS_TEXT N_("access module")
298 #define ACCESS_LONGTEXT N_( \
299 "This is a legacy entry to let you configure access modules")
301 #define DEMUX_TEXT N_("demux module")
302 #define DEMUX_LONGTEXT N_( \
303 "This is a legacy entry to let you configure demux modules")
305 #define FAST_MUTEX_TEXT N_("fast mutex on NT/2K/XP (developpers only)")
306 #define FAST_MUTEX_LONGTEXT N_( \
307 "On Windows NT/2K/XP we use a slow mutex implementation but which " \
308 "allows us to correctely implement condition variables. " \
309 "You can also use the faster Win9x implementation but you might " \
310 "experience problems with it.")
312 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
313 "(developpers only)")
314 #define WIN9X_CV_LONGTEXT N_( \
315 "On Windows 9x/Me we use a fast but not correct condition variables " \
316 "implementation (more precisely there is a possibility for a race " \
317 "condition to happen). " \
318 "However it is possible to use slower alternatives which should be more " \
320 "Currently you can choose between implementation 0 (which is the " \
321 "default and the fastest), 1 and 2.")
323 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
324 "\n *.mpg, *.vob plain MPEG-1/2 files" \
325 "\n [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
327 "\n [vcd:][device][@[title][,[chapter]]" \
329 "\n udpstream:[@[<bind address>][:<bind port>]]" \
330 "\n UDP stream sent by VLS" \
331 "\n vlc:pause pause execution of " \
333 "\n vlc:quit quit VLC" \
337 * Quick usage guide for the configuration options:
339 * add_category_hint( N_(text), N_(longtext) );
340 * add_subcategory_hint( N_(text), N_(longtext) );
341 * add_usage_hint( N_(text) );
342 * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
343 * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
344 * add_module( option_name, psz_value, i_capability, p_callback,
345 * N_(text), N_(longtext) );
346 * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
347 * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
351 /* Interface options */
352 add_category_hint( N_("Interface"), NULL);
353 add_module_with_short( "intf", 'I', "interface", NULL, NULL,
354 INTF_TEXT, INTF_LONGTEXT );
355 add_integer_with_short( "verbose", 'v', -1, NULL,
356 VERBOSE_TEXT, VERBOSE_LONGTEXT );
357 add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT );
358 add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT );
359 add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT );
360 add_string( "plugin-path", NULL, NULL,
361 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT );
364 add_category_hint( N_("Audio"), NULL);
365 add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
366 AOUT_TEXT, AOUT_LONGTEXT );
367 add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT );
368 add_integer( "volume", -1, NULL, VOLUME_TEXT, VOLUME_LONGTEXT );
369 add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT );
370 add_integer( "aout-channels", -1, NULL,
371 AOUT_CHANNELS_TEXT, AOUT_CHANNELS_LONGTEXT );
372 add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT );
373 add_integer( "audio-format", 0, NULL, FORMAT_TEXT, FORMAT_LONGTEXT );
376 add_category_hint( N_("Video"), NULL );
377 add_module_with_short( "vout", 'V', "video output", NULL, NULL,
378 VOUT_TEXT, VOUT_LONGTEXT );
379 add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT );
380 add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT );
381 add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT );
382 add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT );
383 add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT );
384 add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT );
385 add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT );
386 add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT );
387 add_module( "filter", "video filter", NULL, NULL,
388 FILTER_TEXT, FILTER_LONGTEXT );
391 add_category_hint( N_("Input"), NULL );
392 add_integer( "server-port", 1234, NULL,
393 SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT );
394 add_bool( "network-channel", 0, NULL,
395 NETCHANNEL_TEXT, NETCHANNEL_LONGTEXT );
396 add_string( "channel-server", "localhost", NULL,
397 CHAN_SERV_TEXT, CHAN_SERV_LONGTEXT );
398 add_integer( "channel-port", 6010, NULL,
399 CHAN_PORT_TEXT, CHAN_PORT_LONGTEXT );
400 add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT );
402 add_string( "iface", "en0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
404 add_string( "iface", "eth0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
406 add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT );
408 add_integer( "program", 0, NULL,
409 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT );
410 add_integer( "audio-type", -1, NULL,
411 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT );
412 add_integer( "audio-channel", -1, NULL,
413 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT );
414 add_integer( "spu-channel", -1, NULL,
415 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT );
417 add_string( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT );
418 add_string( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT );
420 add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT );
421 add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT );
423 /* Decoder options */
424 add_category_hint( N_("Decoders"), NULL );
425 add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT );
428 add_category_hint( N_("CPU"), NULL );
429 #if defined( __i386__ )
430 add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT );
431 add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT );
432 add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT );
433 add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT );
435 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
436 add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT );
439 /* Playlist options */
440 add_category_hint( N_("Playlist"), NULL );
441 add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT );
442 add_bool( "playlist", 0, NULL, LAUNCH_TEXT, LAUNCH_LONGTEXT );
443 add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT );
444 add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT );
447 add_category_hint( N_("Miscellaneous"), NULL );
448 add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT );
449 add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT );
450 add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT );
451 add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT );
454 add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT );
455 add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT );
458 /* Usage (mainly useful for cmd line stuff) */
459 add_usage_hint( PLAYLIST_USAGE );
461 set_description( N_("main program") );
462 set_capability( "main", 100 );
465 static module_config_t p_help_config[] =
467 { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help") },
468 { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help") },
469 { CONFIG_ITEM_BOOL, NULL, "list", 'l',
470 N_("print a list of available modules") },
471 { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module") },
472 { CONFIG_ITEM_BOOL, NULL, "version", '\0',
473 N_("print version information") },
474 { CONFIG_HINT_END, NULL, NULL, '\0' }
477 /*****************************************************************************
479 *****************************************************************************/