1 /*****************************************************************************
2 * libvlc.h: main libvlc header
3 *****************************************************************************
4 * Copyright (C) 1998-2002 VideoLAN
5 * $Id: libvlc.h,v 1.76 2003/07/18 20:52:10 gbazin 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", "DIV1", "DIV2",
30 "DIV3", "h263", "i263", "WMV1", NULL };
32 static char *ppsz_language[] = { "auto", "en", "en_GB", "de", "fr", "it",
33 "ja", "nl", "no", "pl", "ru", "sv", NULL };
35 /*****************************************************************************
36 * Configuration options for the main program. Each module will also separatly
37 * define its own configuration options.
38 * Look into configuration.h if you need to know more about the following
40 *****************************************************************************/
41 #define INTF_TEXT N_("Interface module")
42 #define INTF_LONGTEXT N_( \
43 "This option allows you to select the interface used by VLC. " \
44 "The default behavior is to automatically select the best module " \
47 #define EXTRAINTF_TEXT N_("Extra interface modules")
48 #define EXTRAINTF_LONGTEXT N_( \
49 "This option allows you to select additional interfaces used by VLC. " \
50 "They will be launched in the background in addition to the default " \
51 "interface. Use a comma separated list of interface modules. (common " \
52 "values are: logger,gestures,sap,rc,http,screensaver)")
54 #define VERBOSE_TEXT N_("Verbosity (0,1,2)")
55 #define VERBOSE_LONGTEXT N_( \
56 "This options sets the verbosity level (0=only errors and " \
57 "standard messages, 1=warnings, 2=debug).")
59 #define QUIET_TEXT N_("Be quiet")
60 #define QUIET_LONGTEXT N_( \
61 "This options turns off all warning and information messages.")
63 #define LANGUAGE_TEXT N_("Language")
64 #define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
65 "of the interface. The system language is auto-detected if \"auto\" is " \
68 #define COLOR_TEXT N_("Color messages")
69 #define COLOR_LONGTEXT N_( \
70 "When this option is turned on, the messages sent to the console will " \
71 "be colorized. Your terminal needs Linux color support for this to work.")
73 #define ADVANCED_TEXT N_("Show advanced options")
74 #define ADVANCED_LONGTEXT N_( \
75 "When this option is turned on, the preferences and/or interfaces will " \
76 "show all the available options, including those that most users should " \
79 #define INTF_PATH_TEXT N_("Interface default search path")
80 #define INTF_PATH_LONGTEXT N_( \
81 "This option allows you to set the default path that the interface will " \
82 "open when looking for a file.")
84 #define PLUGIN_PATH_TEXT N_("Plugin search path")
85 #define PLUGIN_PATH_LONGTEXT N_( \
86 "This option allows you to specify an additional path for VLC to look " \
89 #define AOUT_TEXT N_("Audio output module")
90 #define AOUT_LONGTEXT N_( \
91 "This option allows you to select the audio output method used by VLC. " \
92 "The default behavior is to automatically select the best method " \
95 #define AUDIO_TEXT N_("Enable audio")
96 #define AUDIO_LONGTEXT N_( \
97 "You can completely disable the audio output. In this case the audio " \
98 "decoding will not take place, and it will save some processing power.")
100 #define MONO_TEXT N_("Force mono audio")
101 #define MONO_LONGTEXT N_("This will force a mono audio output")
103 #define VOLUME_TEXT N_("Audio output volume")
104 #define VOLUME_LONGTEXT N_( \
105 "You can set the default audio output volume here, in a range from 0 to " \
108 #define VOLUME_SAVE_TEXT N_("Audio output saved volume")
109 #define VOLUME_SAVE_LONGTEXT N_( \
110 "This saves the audio output volume when you select mute.")
112 #define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
113 #define AOUT_RATE_LONGTEXT N_( \
114 "You can force the audio output frequency here. Common values are " \
115 "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
117 #if !defined( SYS_DARWIN )
118 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
119 #define AOUT_RESAMP_LONGTEXT N_( \
120 "High quality audio resampling can be processor intensive so you can " \
121 "disable it and a cheaper resampling algorithm will be used instead.")
124 #define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
125 #define DESYNC_LONGTEXT N_( \
126 "This option allows you to delay the audio output. This can be handy if " \
127 "you notice a lag between the video and the audio.")
129 #define MULTICHA_TEXT N_("Choose prefered audio output channels mode")
130 #define MULTICHA_LONGTEXT N_( \
131 "This option allows you to set the audio output channels mode that will " \
132 "be used by default when possible (ie. if your hardware supports it as " \
133 "well as the audio stream being played)")
135 #define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
136 #define SPDIF_LONGTEXT N_( \
137 "This option allows you to use the S/PDIF audio output by default when " \
138 "your hardware supports it as well as the audio stream being played.")
140 #define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
141 #define HEADPHONE_LONGTEXT N_( \
142 "This effect gives you the feeling that you are standing in a room " \
143 "with a complete 5.1 speaker set when using only a headphone, " \
144 "providing a more realistic sound experience. It should also be " \
145 "more comfortable and less tiring when listening to music for " \
146 "long periods of time.\nIt works with any source format from mono " \
149 #define VOUT_TEXT N_("Video output module")
150 #define VOUT_LONGTEXT N_( \
151 "This option allows you to select the video output method used by VLC. " \
152 "The default behavior is to automatically select the best " \
155 #define VIDEO_TEXT N_("Enable video")
156 #define VIDEO_LONGTEXT N_( \
157 "You can completely disable the video output. In this case the video " \
158 "decoding stage will not take place, which will save some processing power.")
160 #define WIDTH_TEXT N_("Video width")
161 #define WIDTH_LONGTEXT N_( \
162 "You can enforce the video width here. By default (-1) VLC will " \
163 "adapt to the video characteristics.")
165 #define HEIGHT_TEXT N_("Video height")
166 #define HEIGHT_LONGTEXT N_( \
167 "You can enforce the video height here. By default (-1) VLC will " \
168 "adapt to the video characteristics.")
170 #define ZOOM_TEXT N_("Zoom video")
171 #define ZOOM_LONGTEXT N_( \
172 "You can zoom the video by the specified factor.")
174 #define GRAYSCALE_TEXT N_("Grayscale video output")
175 #define GRAYSCALE_LONGTEXT N_( \
176 "When enabled, the color information from the video won't be decoded " \
177 "(this can also allow you to save some processing power).")
179 #define FULLSCREEN_TEXT N_("Fullscreen video output")
180 #define FULLSCREEN_LONGTEXT N_( \
181 "If this option is enabled, VLC will always start a video in fullscreen " \
184 #define OVERLAY_TEXT N_("Overlay video output")
185 #define OVERLAY_LONGTEXT N_( \
186 "If enabled, VLC will try to take advantage of the overlay capabilities " \
187 "of your graphics card.")
189 #define SPUMARGIN_TEXT N_("Force SPU position")
190 #define SPUMARGIN_LONGTEXT N_( \
191 "You can use this option to place the subtitles under the movie, " \
192 "instead of over the movie. Try several positions.")
194 #define FILTER_TEXT N_("Video filter module")
195 #define FILTER_LONGTEXT N_( \
196 "This will allow you to add a post-processing filter to enhance the " \
197 "picture quality, for instance deinterlacing, or to clone or distort " \
200 #define ASPECT_RATIO_TEXT N_("Source aspect ratio")
201 #define ASPECT_RATIO_LONGTEXT N_( \
202 "This will force the source aspect ratio. For instance, some DVDs claim " \
203 "to be 16:9 while they are actually 4:3. This can also be used as a " \
204 "hint for VLC when a movie does not have aspect ratio information. " \
205 "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
206 "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
210 #define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
211 #define PIXEL_RATIO_LONGTEXT N_( \
212 "This will force the destination pixel size. By default VLC assumes " \
213 "your pixels are square, unless your hardware has a way to tell it " \
214 "otherwise. This may be used when you output VLC's signal to another " \
215 "device such as a TV set. Accepted format is a float value (1, 1.25, " \
216 "1.3333, etc.) expressing pixel squareness.")
219 #define SERVER_PORT_TEXT N_("Server port")
220 #define SERVER_PORT_LONGTEXT N_( \
221 "This is the port used for UDP streams. By default, we chose 1234.")
223 #define MTU_TEXT N_("MTU of the network interface")
224 #define MTU_LONGTEXT N_( \
225 "This is the typical size of UDP packets that we expect. On Ethernet " \
226 "it is usually 1500.")
228 #define IFACE_ADDR_TEXT N_("Network interface address")
229 #define IFACE_ADDR_LONGTEXT N_( \
230 "If you have several interfaces on your machine and use the " \
231 "multicast solution, you will probably have to indicate the IP address " \
232 "of your multicasting interface here.")
234 #define TTL_TEXT N_("Time to live")
235 #define TTL_LONGTEXT N_( \
236 "Indicate here the Time To Live of the multicast packets sent by " \
237 "the stream output.")
239 #define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
240 #define INPUT_PROGRAM_LONGTEXT N_( \
241 "Choose the program to select by giving its Service ID.")
243 #define INPUT_AUDIO_TEXT N_("Choose audio")
244 #define INPUT_AUDIO_LONGTEXT N_( \
245 "Give the default type of audio you want to use in a DVD. " \
248 #define INPUT_CHAN_TEXT N_("Choose channel")
249 #define INPUT_CHAN_LONGTEXT N_( \
250 "Give the stream number of the audio channel you want to use in a DVD " \
253 #define INPUT_SUBT_TEXT N_("Choose subtitles")
254 #define INPUT_SUBT_LONGTEXT N_( \
255 "Give the stream number of the subtitle channel you want to use in a " \
256 "DVD (from 1 to n).")
258 #define DVD_DEV_TEXT N_("DVD device")
260 #define DVD_DEV_LONGTEXT N_( \
261 "This is the default DVD drive (or file) to use. Don't forget the colon " \
262 "after the drive letter (eg D:)")
264 #define DVD_DEV_LONGTEXT N_( \
265 "This is the default DVD device to use.")
268 #define VCD_DEV_TEXT N_("VCD device")
269 #define VCD_DEV_LONGTEXT N_( \
270 "This is the default VCD device to use.")
272 #define IPV6_TEXT N_("Force IPv6")
273 #define IPV6_LONGTEXT N_( \
274 "If you check this box, IPv6 will be used by default for all UDP and " \
277 #define IPV4_TEXT N_("Force IPv4")
278 #define IPV4_LONGTEXT N_( \
279 "If you check this box, IPv4 will be used by default for all UDP and " \
282 #define CODEC_TEXT N_("Choose preferred codec list")
283 #define CODEC_LONGTEXT N_( \
284 "This allows you to select the order in which VLC will choose its " \
285 "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
286 "before the new one. Please be aware that VLC does not make any " \
287 "difference between audio or video codecs, so you should always specify " \
288 "'any' at the end of the list to make sure there is a fallback for the " \
289 "types you didn't specify.")
291 #define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
292 #define ENCODER_VIDEO_LONGTEXT N_( \
293 "This allows you to select the order in which VLC will choose its " \
295 #define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
296 #define ENCODER_AUDIO_LONGTEXT N_( \
297 "This allows you to select the order in which VLC will choose its " \
300 #define SOUT_TEXT N_("Choose a stream output")
301 #define SOUT_LONGTEXT N_( \
302 "Empty if no stream output.")
304 #define SOUT_DISPLAY_TEXT N_("Display while streaming")
305 #define SOUT_DISPLAY_LONGTEXT N_( \
306 "This allows you to play the stream while streaming it.")
308 #define SOUT_VIDEO_TEXT N_("Enable video stream output")
309 #define SOUT_VIDEO_LONGTEXT N_( \
310 "This allows you to choose if the video stream should be redirected to " \
311 "the stream output facility when this last one is enabled.")
313 #define SOUT_VCODEC_TEXT N_("Video encoding codec" )
314 #define SOUT_VCODEC_LONGTEXT N_( \
315 "This allows you to force video encoding")
317 #define SOUT_VBITRATE_TEXT N_("Video bitrate encoding (kB/s)" )
318 #define SOUT_VBITRATE_LONGTEXT N_( \
319 "This allows you to specify video bitrate in kB/s.")
321 #define SOUT_AUDIO_TEXT N_("Enable audio stream output")
322 #define SOUT_AUDIO_LONGTEXT N_( \
323 "This allows you to choose if the video stream should be redirected to " \
324 "the stream output facility when this last one is enabled.")
326 #define SOUT_ACODEC_TEXT N_("Audio encoding codec" )
327 #define SOUT_ACODEC_LONGTEXT N_( \
328 "This allows you to force audio encoding")
330 #define SOUT_ABITRATE_TEXT N_("Audio bitrate encoding (kB/s)" )
331 #define SOUT_ABITRATE_LONGTEXT N_( \
332 "This allows you to specify audio bitrate in kB/s.")
334 #define PACKETIZER_TEXT N_("Choose preferred packetizer list")
335 #define PACKETIZER_LONGTEXT N_( \
336 "This allows you to select the order in which VLC will choose its " \
339 #define MUX_TEXT N_("Mux module")
340 #define MUX_LONGTEXT N_( \
341 "This is a legacy entry to let you configure mux modules")
343 #define ACCESS_OUTPUT_TEXT N_("Access output module")
344 #define ACCESS_OUTPUT_LONGTEXT N_( \
345 "This is a legacy entry to let you configure access output modules")
348 #define MMX_TEXT N_("Enable CPU MMX support")
349 #define MMX_LONGTEXT N_( \
350 "If your processor supports the MMX instructions set, VLC can take " \
351 "advantage of them.")
353 #define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
354 #define THREE_DN_LONGTEXT N_( \
355 "If your processor supports the 3D Now! instructions set, VLC can take " \
356 "advantage of them.")
358 #define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
359 #define MMXEXT_LONGTEXT N_( \
360 "If your processor supports the MMX EXT instructions set, VLC can take " \
361 "advantage of them.")
363 #define SSE_TEXT N_("Enable CPU SSE support")
364 #define SSE_LONGTEXT N_( \
365 "If your processor supports the SSE instructions set, VLC can take " \
366 "advantage of them.")
368 #define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
369 #define ALTIVEC_LONGTEXT N_( \
370 "If your processor supports the AltiVec instructions set, VLC can take " \
371 "advantage of them.")
373 #define RANDOM_TEXT N_("Play files randomly forever")
374 #define RANDOM_LONGTEXT N_( \
375 "When selected, VLC will randomly play files in the playlist until " \
378 #define ENQUEUE_TEXT N_("Enqueue items in playlist")
379 #define ENQUEUE_LONGTEXT N_( \
380 "If you want VLC to add items to the playlist as you open them, then " \
381 "enable this option.")
383 #define LOOP_TEXT N_("Loop playlist on end")
384 #define LOOP_LONGTEXT N_( \
385 "If you want VLC to keep playing the playlist indefinitely then enable " \
388 #define MEMCPY_TEXT N_("Memory copy module")
389 #define MEMCPY_LONGTEXT N_( \
390 "You can select which memory copy module you want to use. By default " \
391 "VLC will select the fastest one supported by your hardware.")
393 #define ACCESS_TEXT N_("Access module")
394 #define ACCESS_LONGTEXT N_( \
395 "This is a legacy entry to let you configure access modules")
397 #define DEMUX_TEXT N_("Demux module")
398 #define DEMUX_LONGTEXT N_( \
399 "This is a legacy entry to let you configure demux modules")
401 #define HPRIORITY_TEXT N_("Increase the priority of the process")
402 #define HPRIORITY_LONGTEXT N_( \
403 "Increasing the priority of the process will very likely improve your " \
404 "playing experience as it allows VLC not to be disturbed by other " \
405 "applications that could otherwise take too much processor time.\n" \
406 "However be advise that in certain circumstances (bugs) VLC could take " \
407 "all the processor time and render the whole system unresponsive which " \
408 "might require a reboot of your machine.")
410 #define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
411 #define FAST_MUTEX_LONGTEXT N_( \
412 "On Windows NT/2K/XP we use a slow mutex implementation but which " \
413 "allows us to correctely implement condition variables. " \
414 "You can also use the faster Win9x implementation but you might " \
415 "experience problems with it.")
417 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
419 #define WIN9X_CV_LONGTEXT N_( \
420 "On Windows 9x/Me we use a fast but not correct condition variables " \
421 "implementation (more precisely there is a possibility for a race " \
422 "condition to happen). " \
423 "However it is possible to use slower alternatives which should be more " \
425 "Currently you can choose between implementation 0 (which is the " \
426 "default and the fastest), 1 and 2.")
428 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
429 "\n *.mpg, *.vob plain MPEG-1/2 files" \
430 "\n [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
432 "\n [vcd:][device][@[title][,[chapter]]" \
434 "\n udpstream:[@[<bind address>][:<bind port>]]" \
435 "\n UDP stream sent by VLS" \
436 "\n vlc:pause pause execution of " \
438 "\n vlc:quit quit VLC" \
443 * Quick usage guide for the configuration options:
445 * add_category_hint( N_(text), N_(longtext) );
446 * add_subcategory_hint( N_(text), N_(longtext) );
447 * add_usage_hint( N_(text) );
448 * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
449 * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
450 * add_module( option_name, psz_value, i_capability, p_callback,
451 * N_(text), N_(longtext) );
452 * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
453 * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
457 /* Interface options */
458 add_category_hint( N_("Interface"), NULL, VLC_FALSE );
459 add_module_with_short( "intf", 'I', "interface", NULL, NULL,
460 INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
461 add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
462 add_integer_with_short( "verbose", 'v', 0, NULL,
463 VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
464 add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
465 add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
466 add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
467 add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
468 add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
469 add_directory( "plugin-path", NULL, NULL,
470 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
473 add_category_hint( N_("Audio"), NULL, VLC_FALSE );
474 add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
475 AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
476 add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
477 add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
478 AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
479 VOLUME_LONGTEXT, VLC_FALSE );
480 add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
481 AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
482 VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
483 add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
484 #if !defined( SYS_DARWIN )
485 add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
487 add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
488 add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
489 add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
492 add_category_hint( N_("Video"), NULL, VLC_FALSE );
493 add_module_with_short( "vout", 'V', "video output", NULL, NULL,
494 VOUT_TEXT, VOUT_LONGTEXT, VLC_FALSE );
495 add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
496 add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
497 add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
498 add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
499 add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
500 add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
502 add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
504 add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
505 add_module( "filter", "video filter", NULL, NULL,
506 FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
507 add_string( "aspect-ratio", "", NULL,
508 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
510 add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
514 add_category_hint( N_("Input"), NULL, VLC_FALSE );
515 add_integer( "server-port", 1234, NULL,
516 SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
517 add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
518 add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
520 add_integer( "program", 0, NULL,
521 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
522 add_integer( "audio-type", -1, NULL,
523 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
524 add_integer( "audio-channel", -1, NULL,
525 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
526 add_integer( "spu-channel", -1, NULL,
527 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
529 add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
530 add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
532 add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
533 add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
535 /* Decoder options */
536 add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
537 add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
539 #if 0 // Encoders have been disabled for now as we are using the stream output transcoder instead
540 add_category_hint( N_("Encoders"), NULL, VLC_TRUE );
541 add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT, VLC_TRUE );
542 add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT, VLC_TRUE );
545 /* Stream output options */
546 add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
547 add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
548 add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
550 add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
551 add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT, VLC_TRUE );
552 add_bool( "sout-abitrate", 0, NULL, SOUT_ABITRATE_TEXT, SOUT_ABITRATE_LONGTEXT, VLC_TRUE );
554 add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );
555 add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT, VLC_TRUE );
556 add_bool( "sout-vbitrate", 0, NULL, SOUT_VBITRATE_TEXT, SOUT_VBITRATE_LONGTEXT, VLC_TRUE );
558 add_module( "packetizer", "packetizer", NULL, NULL,
559 PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
560 add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
561 add_module( "access_output", "sout access", NULL, NULL,
562 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
563 add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
566 add_category_hint( N_("CPU"), NULL, VLC_TRUE );
567 #if defined( __i386__ )
568 add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
569 add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
570 add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
571 add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
573 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
574 add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
577 /* Playlist options */
578 add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
579 add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
580 add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT, VLC_FALSE );
581 add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
584 add_category_hint( N_("Miscellaneous"), NULL, VLC_TRUE );
585 add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
586 add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
587 add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
590 add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
591 add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
592 add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
595 /* Usage (mainly useful for cmd line stuff) */
596 add_usage_hint( PLAYLIST_USAGE );
598 set_description( N_("main program") );
599 set_capability( "main", 100 );
602 static module_config_t p_help_config[] =
604 { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
605 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
606 { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
607 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
608 { CONFIG_ITEM_BOOL, NULL, "list", 'l',
609 N_("print a list of available modules"),
610 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
611 { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
612 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
613 { CONFIG_ITEM_BOOL, NULL, "version", '\0',
614 N_("print version information"),
615 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
616 { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
617 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
620 /*****************************************************************************
622 *****************************************************************************/