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