1 /*****************************************************************************
2 * libvlc.h: main libvlc header
3 *****************************************************************************
4 * Copyright (C) 1998-2002 VideoLAN
5 * $Id: libvlc.h,v 1.71 2003/05/24 02:48:55 hartman 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 static char *ppsz_sout_acodec[] = { "", "mpga", "a52", NULL };
29 static char *ppsz_sout_vcodec[] = { "", "mpgv", "mp4v", "DIV3", "h263", NULL };
31 static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
32 "ja", "nl", "no", "pl", "ru", "sv", NULL };
34 /*****************************************************************************
35 * Configuration options for the main program. Each module will also separatly
36 * define its own configuration options.
37 * Look into configuration.h if you need to know more about the following
39 *****************************************************************************/
40 #define INTF_TEXT N_("Interface module")
41 #define INTF_LONGTEXT N_( \
42 "This option allows you to select the interface used by VLC. " \
43 "The default behavior is to automatically select the best module " \
46 #define EXTRAINTF_TEXT N_("Extra interface modules")
47 #define EXTRAINTF_LONGTEXT N_( \
48 "This option allows you to select additional interfaces used by VLC. " \
49 "They will be launched in the background in addition to the default " \
50 "interface. Use a comma separated list of interface modules.")
52 #define VERBOSE_TEXT N_("Verbosity (0,1,2)")
53 #define VERBOSE_LONGTEXT N_( \
54 "This options sets the verbosity level (0=only errors and " \
55 "standard messages, 1=warnings, 2=debug).")
57 #define QUIET_TEXT N_("Be quiet")
58 #define QUIET_LONGTEXT N_( \
59 "This options turns off all warning and information messages.")
61 #define LANGUAGE_TEXT N_("Language")
62 #define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
63 "of the interface. The system language is auto-detected if \"auto\" is " \
66 #define COLOR_TEXT N_("Color messages")
67 #define COLOR_LONGTEXT N_( \
68 "When this option is turned on, the messages sent to the console will " \
69 "be colorized. Your terminal needs Linux color support for this to work.")
71 #define ADVANCED_TEXT N_("Show advanced options")
72 #define ADVANCED_LONGTEXT N_( \
73 "When this option is turned on, the interfaces will show all the " \
74 "available options, including those that most users should never touch")
76 #define INTF_PATH_TEXT N_("Interface default search path")
77 #define INTF_PATH_LONGTEXT N_( \
78 "This option allows you to set the default path that the interface will " \
79 "open when looking for a file.")
81 #define PLUGIN_PATH_TEXT N_("Plugin search path")
82 #define PLUGIN_PATH_LONGTEXT N_( \
83 "This option allows you to specify an additional path for VLC to look " \
86 #define AOUT_TEXT N_("Audio output module")
87 #define AOUT_LONGTEXT N_( \
88 "This option allows you to select the audio output method used by VLC. " \
89 "The default behavior is to automatically select the best method " \
92 #define AUDIO_TEXT N_("Enable audio")
93 #define AUDIO_LONGTEXT N_( \
94 "You can completely disable the audio output. In this case the audio " \
95 "decoding stage won't be done, and it will save some processing power.")
97 #define MONO_TEXT N_("Force mono audio")
98 #define MONO_LONGTEXT N_("This will force a mono audio output")
100 #define VOLUME_TEXT N_("Audio output volume")
101 #define VOLUME_LONGTEXT N_( \
102 "You can set the default audio output volume here, in a range from 0 to " \
105 #define VOLUME_SAVE_TEXT N_("Audio output saved volume")
106 #define VOLUME_SAVE_LONGTEXT N_( \
107 "This saves the audio output volume when you select mute.")
109 #define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
110 #define AOUT_RATE_LONGTEXT N_( \
111 "You can force the audio output frequency here. Common values are " \
112 "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
114 #if !defined( SYS_DARWIN )
115 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
116 #define AOUT_RESAMP_LONGTEXT N_( \
117 "High quality audio resampling can be processor intensive so you can " \
118 "disable it and a cheaper resampling algorithm will be used instead.")
121 #define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
122 #define DESYNC_LONGTEXT N_( \
123 "This option allows you to delay the audio output. This can be handy if " \
124 "you notice a lag between the video and the audio.")
126 #define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
127 #define SPDIF_LONGTEXT N_( \
128 "This option allows you to use the S/PDIF audio output by default when " \
129 "your hardware supports it as well as the audio stream being played.")
131 #define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
132 #define HEADPHONE_LONGTEXT N_( \
133 "This effect gives you the feeling that you stands in a real room " \
134 "with a complete 5.1 speaker set when using only a headphone, " \
135 "providing a more realistic sound experience. It should also be " \
136 "more comfortable and less tiring when listening to music for " \
137 "long periods of time.\nIt works with any source format from mono " \
140 #define VOUT_TEXT N_("Video output module")
141 #define VOUT_LONGTEXT N_( \
142 "This option allows you to select the video output method used by VLC. " \
143 "The default behavior is to automatically select the best " \
146 #define VIDEO_TEXT N_("Enable video")
147 #define VIDEO_LONGTEXT N_( \
148 "You can completely disable the video output. In this case the video " \
149 "decoding stage won't be done, which will save some processing power.")
151 #define WIDTH_TEXT N_("Video width")
152 #define WIDTH_LONGTEXT N_( \
153 "You can enforce the video width here. By default VLC will " \
154 "adapt to the video characteristics.")
156 #define HEIGHT_TEXT N_("Video height")
157 #define HEIGHT_LONGTEXT N_( \
158 "You can enforce the video height here. By default VLC will " \
159 "adapt to the video characteristics.")
161 #define ZOOM_TEXT N_("Zoom video")
162 #define ZOOM_LONGTEXT N_( \
163 "You can zoom the video by the specified factor.")
165 #define GRAYSCALE_TEXT N_("Grayscale video output")
166 #define GRAYSCALE_LONGTEXT N_( \
167 "When enabled, the color information from the video won't be decoded " \
168 "(this can also allow you to save some processing power).")
170 #define FULLSCREEN_TEXT N_("Fullscreen video output")
171 #define FULLSCREEN_LONGTEXT N_( \
172 "If this option is enabled, VLC will always start a video in fullscreen " \
175 #define OVERLAY_TEXT N_("Overlay video output")
176 #define OVERLAY_LONGTEXT N_( \
177 "If enabled, VLC will try to take advantage of the overlay capabilities " \
178 "of your graphic card.")
180 #define SPUMARGIN_TEXT N_("Force SPU position")
181 #define SPUMARGIN_LONGTEXT N_( \
182 "You can use this option to place the subtitles under the movie, " \
183 "instead of over the movie. Try several positions.")
185 #define FILTER_TEXT N_("Video filter module")
186 #define FILTER_LONGTEXT N_( \
187 "This will allow you to add a post-processing filter to enhance the " \
188 "picture quality, for instance deinterlacing, or to clone or distort " \
191 #define ASPECT_RATIO_TEXT N_("Source aspect ratio")
192 #define ASPECT_RATIO_LONGTEXT N_( \
193 "This will force the source aspect ratio. For instance, some DVDs claim " \
194 "to be 16:9 while they are actually 4:3. This can also be used as a " \
195 "hint for VLC when a movie does not have aspect ratio information. " \
196 "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
197 "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
201 #define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
202 #define PIXEL_RATIO_LONGTEXT N_( \
203 "This will force the destination pixel size. By default VLC assumes " \
204 "your pixels are square, unless your hardware has a way to tell it " \
205 "otherwise. This may be used when you output VLC's signal to another " \
206 "device such as a TV set. Accepted format is a float value (1, 1.25, " \
207 "1.3333, etc.) expressing pixel squareness.")
210 #define SERVER_PORT_TEXT N_("Server port")
211 #define SERVER_PORT_LONGTEXT N_( \
212 "This is the port used for UDP streams. By default, we chose 1234.")
214 #define MTU_TEXT N_("MTU of the network interface")
215 #define MTU_LONGTEXT N_( \
216 "This is the typical size of UDP packets that we expect. On Ethernet " \
217 "it is usually 1500.")
219 #define IFACE_ADDR_TEXT N_("Network interface address")
220 #define IFACE_ADDR_LONGTEXT N_( \
221 "If you have several interfaces on your machine and use the " \
222 "multicast solution, you will probably have to indicate the IP address " \
223 "of your multicasting interface here.")
225 #define TTL_TEXT N_("Time to live")
226 #define TTL_LONGTEXT N_( \
227 "Indicate here the Time To Live of the multicast packets sent by " \
228 "the stream output.")
230 #define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
231 #define INPUT_PROGRAM_LONGTEXT N_( \
232 "Choose the program to select by giving its Service ID.")
234 #define INPUT_AUDIO_TEXT N_("Choose audio")
235 #define INPUT_AUDIO_LONGTEXT N_( \
236 "Give the default type of audio you want to use in a DVD.")
238 #define INPUT_CHAN_TEXT N_("Choose channel")
239 #define INPUT_CHAN_LONGTEXT N_( \
240 "Give the stream number of the audio channel you want to use in a DVD " \
243 #define INPUT_SUBT_TEXT N_("Choose subtitles")
244 #define INPUT_SUBT_LONGTEXT N_( \
245 "Give the stream number of the subtitle channel you want to use in a " \
246 "DVD (from 1 to n).")
248 #define DVD_DEV_TEXT N_("DVD device")
250 #define DVD_DEV_LONGTEXT N_( \
251 "This is the default DVD drive (or file) to use. Don't forget the colon " \
252 "after the drive letter (eg D:)")
254 #define DVD_DEV_LONGTEXT N_( \
255 "This is the default DVD device to use.")
258 #define VCD_DEV_TEXT N_("VCD device")
259 #define VCD_DEV_LONGTEXT N_( \
260 "This is the default VCD device to use.")
262 #define IPV6_TEXT N_("Force IPv6")
263 #define IPV6_LONGTEXT N_( \
264 "If you check this box, IPv6 will be used by default for all UDP and " \
267 #define IPV4_TEXT N_("Force IPv4")
268 #define IPV4_LONGTEXT N_( \
269 "If you check this box, IPv4 will be used by default for all UDP and " \
272 #define CODEC_TEXT N_("Choose preferred codec list")
273 #define CODEC_LONGTEXT N_( \
274 "This allows you to select the order in which VLC will choose its " \
275 "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
276 "before the new one. Please be aware that VLC does not make any " \
277 "difference between audio or video codecs, so you should always specify " \
278 "'any' at the end of the list to make sure there is a fallback for the " \
279 "types you didn't specify.")
281 #define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
282 #define ENCODER_VIDEO_LONGTEXT N_( \
283 "This allows you to select the order in which VLC will choose its " \
285 #define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
286 #define ENCODER_AUDIO_LONGTEXT N_( \
287 "This allows you to select the order in which VLC will choose its " \
290 #define SOUT_TEXT N_("Choose a stream output")
291 #define SOUT_LONGTEXT N_( \
292 "Empty if no stream output.")
294 #define SOUT_DISPLAY_TEXT N_("Display while streaming")
295 #define SOUT_DISPLAY_LONGTEXT N_( \
296 "This allows you to play the stream while streaming it.")
298 #define SOUT_VIDEO_TEXT N_("Enable video stream output")
299 #define SOUT_VIDEO_LONGTEXT N_( \
300 "This allows you to choose if the video stream should be redirected to " \
301 "the stream output facility when this last one is enabled.")
303 #define SOUT_VCODEC_TEXT N_("Video encoding codec" )
304 #define SOUT_VCODEC_LONGTEXT N_( \
305 "This allows you to force video encoding")
307 #define SOUT_VBITRATE_TEXT N_("Video bitrate encoding (kB/s)" )
308 #define SOUT_VBITRATE_LONGTEXT N_( \
309 "This allows you to specify video bitrate in kB/s.")
311 #define SOUT_AUDIO_TEXT N_("Enable audio stream output")
312 #define SOUT_AUDIO_LONGTEXT N_( \
313 "This allows you to choose if the video stream should be redirected to " \
314 "the stream output facility when this last one is enabled.")
316 #define SOUT_ACODEC_TEXT N_("Audio encoding codec" )
317 #define SOUT_ACODEC_LONGTEXT N_( \
318 "This allows you to force audio encoding")
320 #define SOUT_ABITRATE_TEXT N_("Audio bitrate encoding (kB/s)" )
321 #define SOUT_ABITRATE_LONGTEXT N_( \
322 "This allows you to specify audio bitrate in kB/s.")
324 #define PACKETIZER_TEXT N_("Choose preferred packetizer list")
325 #define PACKETIZER_LONGTEXT N_( \
326 "This allows you to select the order in which VLC will choose its " \
329 #define MUX_TEXT N_("Mux module")
330 #define MUX_LONGTEXT N_( \
331 "This is a legacy entry to let you configure mux modules")
333 #define ACCESS_OUTPUT_TEXT N_("Access output module")
334 #define ACCESS_OUTPUT_LONGTEXT N_( \
335 "This is a legacy entry to let you configure access output modules")
338 #define MMX_TEXT N_("Enable CPU MMX support")
339 #define MMX_LONGTEXT N_( \
340 "If your processor supports the MMX instructions set, VLC can take " \
341 "advantage of them.")
343 #define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
344 #define THREE_DN_LONGTEXT N_( \
345 "If your processor supports the 3D Now! instructions set, VLC can take " \
346 "advantage of them.")
348 #define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
349 #define MMXEXT_LONGTEXT N_( \
350 "If your processor supports the MMX EXT instructions set, VLC can take " \
351 "advantage of them.")
353 #define SSE_TEXT N_("Enable CPU SSE support")
354 #define SSE_LONGTEXT N_( \
355 "If your processor supports the SSE instructions set, VLC can take " \
356 "advantage of them.")
358 #define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
359 #define ALTIVEC_LONGTEXT N_( \
360 "If your processor supports the AltiVec instructions set, VLC can take " \
361 "advantage of them.")
363 #define RANDOM_TEXT N_("Play files randomly forever")
364 #define RANDOM_LONGTEXT N_( \
365 "When selected, VLC will randomly play files in the playlist until " \
368 #define ENQUEUE_TEXT N_("Enqueue items in playlist")
369 #define ENQUEUE_LONGTEXT N_( \
370 "If you want VLC to add items to the playlist as you open them, then " \
371 "enable this option.")
373 #define LOOP_TEXT N_("Loop playlist on end")
374 #define LOOP_LONGTEXT N_( \
375 "If you want VLC to keep playing the playlist indefinitely then enable " \
378 #define MEMCPY_TEXT N_("Memory copy module")
379 #define MEMCPY_LONGTEXT N_( \
380 "You can select which memory copy module you want to use. By default " \
381 "VLC will select the fastest one supported by your hardware.")
383 #define ACCESS_TEXT N_("Access module")
384 #define ACCESS_LONGTEXT N_( \
385 "This is a legacy entry to let you configure access modules")
387 #define DEMUX_TEXT N_("Demux module")
388 #define DEMUX_LONGTEXT N_( \
389 "This is a legacy entry to let you configure demux modules")
391 #define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
392 #define FAST_MUTEX_LONGTEXT N_( \
393 "On Windows NT/2K/XP we use a slow mutex implementation but which " \
394 "allows us to correctely implement condition variables. " \
395 "You can also use the faster Win9x implementation but you might " \
396 "experience problems with it.")
398 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
400 #define WIN9X_CV_LONGTEXT N_( \
401 "On Windows 9x/Me we use a fast but not correct condition variables " \
402 "implementation (more precisely there is a possibility for a race " \
403 "condition to happen). " \
404 "However it is possible to use slower alternatives which should be more " \
406 "Currently you can choose between implementation 0 (which is the " \
407 "default and the fastest), 1 and 2.")
409 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
410 "\n *.mpg, *.vob plain MPEG-1/2 files" \
411 "\n [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
413 "\n [vcd:][device][@[title][,[chapter]]" \
415 "\n udpstream:[@[<bind address>][:<bind port>]]" \
416 "\n UDP stream sent by VLS" \
417 "\n vlc:pause pause execution of " \
419 "\n vlc:quit quit VLC" \
424 * Quick usage guide for the configuration options:
426 * add_category_hint( N_(text), N_(longtext) );
427 * add_subcategory_hint( N_(text), N_(longtext) );
428 * add_usage_hint( N_(text) );
429 * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
430 * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
431 * add_module( option_name, psz_value, i_capability, p_callback,
432 * N_(text), N_(longtext) );
433 * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
434 * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
438 /* Interface options */
439 add_category_hint( N_("Interface"), NULL, VLC_FALSE );
440 add_module_with_short( "intf", 'I', "interface", NULL, NULL,
441 INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
442 add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
443 add_integer_with_short( "verbose", 'v', -1, NULL,
444 VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
445 add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
446 add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
447 add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
448 add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
449 add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
450 add_string( "plugin-path", NULL, NULL,
451 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
454 add_category_hint( N_("Audio"), NULL, VLC_FALSE );
455 add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
456 AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
457 add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
458 add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
459 AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
460 VOLUME_LONGTEXT, VLC_FALSE );
461 add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
462 AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
463 VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
464 add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
465 #if !defined( SYS_DARWIN )
466 add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
468 add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
469 add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
470 add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
473 add_category_hint( N_("Video"), NULL, VLC_FALSE );
474 add_module_with_short( "vout", 'V', "video output", NULL, NULL,
475 VOUT_TEXT, VOUT_LONGTEXT, VLC_FALSE );
476 add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
477 add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
478 add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
479 add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
480 add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
481 add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
482 add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
483 add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
484 add_module( "filter", "video filter", NULL, NULL,
485 FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
486 add_string( "aspect-ratio", "", NULL,
487 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
489 add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
493 add_category_hint( N_("Input"), NULL, VLC_FALSE );
494 add_integer( "server-port", 1234, NULL,
495 SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
496 add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
497 add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
498 add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
500 add_integer( "program", 0, NULL,
501 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
502 add_integer( "audio-type", -1, NULL,
503 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
504 add_integer( "audio-channel", -1, NULL,
505 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
506 add_integer( "spu-channel", -1, NULL,
507 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
509 add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
510 add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
512 add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
513 add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
515 /* Decoder options */
516 add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
517 add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
519 add_category_hint( N_("Encoders"), NULL, VLC_TRUE );
520 add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT, VLC_TRUE );
521 add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT, VLC_TRUE );
523 /* Stream output options */
524 add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
525 add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
526 add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
528 add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
529 add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT, VLC_TRUE );
530 add_bool( "sout-abitrate", 0, NULL, SOUT_ABITRATE_TEXT, SOUT_ABITRATE_LONGTEXT, VLC_TRUE );
532 add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );
533 add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT, VLC_TRUE );
534 add_bool( "sout-vbitrate", 0, NULL, SOUT_VBITRATE_TEXT, SOUT_VBITRATE_LONGTEXT, VLC_TRUE );
536 add_module( "packetizer", "packetizer", NULL, NULL,
537 PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
538 add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
539 add_module( "access_output", "sout access", NULL, NULL,
540 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
543 add_category_hint( N_("CPU"), NULL, VLC_TRUE );
544 #if defined( __i386__ )
545 add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
546 add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
547 add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
548 add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
550 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
551 add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
554 /* Playlist options */
555 add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
556 add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
557 add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT, VLC_FALSE );
558 add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
561 add_category_hint( N_("Miscellaneous"), NULL, VLC_TRUE );
562 add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
563 add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
564 add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
567 add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
568 add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
571 /* Usage (mainly useful for cmd line stuff) */
572 add_usage_hint( PLAYLIST_USAGE );
574 set_description( N_("main program") );
575 set_capability( "main", 100 );
578 static module_config_t p_help_config[] =
580 { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
581 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
582 { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
583 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
584 { CONFIG_ITEM_BOOL, NULL, "list", 'l',
585 N_("print a list of available modules"),
586 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
587 { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
588 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
589 { CONFIG_ITEM_BOOL, NULL, "version", '\0',
590 N_("print version information"),
591 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
592 { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
593 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
596 /*****************************************************************************
598 *****************************************************************************/