1 /*****************************************************************************
2 * libvlc.h: main libvlc header
3 *****************************************************************************
4 * Copyright (C) 1998-2002 VideoLAN
5 * $Id: libvlc.h,v 1.87 2003/09/22 03:40:06 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
29 static char *ppsz_language[] = { "auto", "en", "en_GB", "es", "de", "fr", "it", "ja",
30 "nl", "no", "pl", "pt_BR", "ru", "sv", NULL };
32 /*****************************************************************************
33 * Configuration options for the main program. Each module will also separatly
34 * define its own configuration options.
35 * Look into configuration.h if you need to know more about the following
37 *****************************************************************************/
38 #define INTF_TEXT N_("Interface module")
39 #define INTF_LONGTEXT N_( \
40 "This option allows you to select the interface used by VLC. " \
41 "The default behavior is to automatically select the best module " \
44 #define EXTRAINTF_TEXT N_("Extra interface modules")
45 #define EXTRAINTF_LONGTEXT N_( \
46 "This option allows you to select additional interfaces used by VLC. " \
47 "They will be launched in the background in addition to the default " \
48 "interface. Use a comma separated list of interface modules. (common " \
49 "values are: logger,gestures,sap,rc,http,screensaver)")
51 #define VERBOSE_TEXT N_("Verbosity (0,1,2)")
52 #define VERBOSE_LONGTEXT N_( \
53 "This options sets the verbosity level (0=only errors and " \
54 "standard messages, 1=warnings, 2=debug).")
56 #define QUIET_TEXT N_("Be quiet")
57 #define QUIET_LONGTEXT N_( \
58 "This options turns off all warning and information messages.")
60 #define LANGUAGE_TEXT N_("Language")
61 #define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
62 "of the interface. The system language is auto-detected if \"auto\" is " \
65 #define COLOR_TEXT N_("Color messages")
66 #define COLOR_LONGTEXT N_( \
67 "When this option is turned on, the messages sent to the console will " \
68 "be colorized. Your terminal needs Linux color support for this to work.")
70 #define ADVANCED_TEXT N_("Show advanced options")
71 #define ADVANCED_LONGTEXT N_( \
72 "When this option is turned on, the preferences and/or interfaces will " \
73 "show all the available options, including those that most users should " \
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 will not take place, 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 MULTICHA_TEXT N_("Choose prefered audio output channels mode")
127 #define MULTICHA_LONGTEXT N_( \
128 "This option allows you to set the audio output channels mode that will " \
129 "be used by default when possible (ie. if your hardware supports it as " \
130 "well as the audio stream being played)")
132 #define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
133 #define SPDIF_LONGTEXT N_( \
134 "This option allows you to use the S/PDIF audio output by default when " \
135 "your hardware supports it as well as the audio stream being played.")
137 #define AUDIO_FILTER_TEXT N_("Audio filters")
138 #define AUDIO_FILTER_LONGTEXT N_( \
139 "This allows you to add audio postprocessing filters, to modify" \
142 #define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
143 #define HEADPHONE_LONGTEXT N_( \
144 "This effect gives you the feeling that you are standing in a room " \
145 "with a complete 5.1 speaker set when using only a headphone, " \
146 "providing a more realistic sound experience. It should also be " \
147 "more comfortable and less tiring when listening to music for " \
148 "long periods of time.\nIt works with any source format from mono " \
152 #define VOUT_TEXT N_("Video output module")
153 #define VOUT_LONGTEXT N_( \
154 "This option allows you to select the video output method used by VLC. " \
155 "The default behavior is to automatically select the best " \
158 #define VIDEO_TEXT N_("Enable video")
159 #define VIDEO_LONGTEXT N_( \
160 "You can completely disable the video output. In this case the video " \
161 "decoding stage will not take place, which will save some processing power.")
163 #define WIDTH_TEXT N_("Video width")
164 #define WIDTH_LONGTEXT N_( \
165 "You can enforce the video width here. By default (-1) VLC will " \
166 "adapt to the video characteristics.")
168 #define HEIGHT_TEXT N_("Video height")
169 #define HEIGHT_LONGTEXT N_( \
170 "You can enforce the video height here. By default (-1) VLC will " \
171 "adapt to the video characteristics.")
173 #define ALIGN_TEXT N_("Video alignment")
174 #define ALIGN_LONGTEXT N_( \
175 "You can enforce the video alignement in its window. By default (0) it " \
176 "will be centered (0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
177 "also use combinations of these values).")
179 #define ZOOM_TEXT N_("Zoom video")
180 #define ZOOM_LONGTEXT N_( \
181 "You can zoom the video by the specified factor.")
183 #define GRAYSCALE_TEXT N_("Grayscale video output")
184 #define GRAYSCALE_LONGTEXT N_( \
185 "When enabled, the color information from the video won't be decoded " \
186 "(this can also allow you to save some processing power).")
188 #define FULLSCREEN_TEXT N_("Fullscreen video output")
189 #define FULLSCREEN_LONGTEXT N_( \
190 "If this option is enabled, VLC will always start a video in fullscreen " \
193 #define OVERLAY_TEXT N_("Overlay video output")
194 #define OVERLAY_LONGTEXT N_( \
195 "If enabled, VLC will try to take advantage of the overlay capabilities " \
196 "of your graphics card.")
198 #define SPUMARGIN_TEXT N_("Force SPU position")
199 #define SPUMARGIN_LONGTEXT N_( \
200 "You can use this option to place the subtitles under the movie, " \
201 "instead of over the movie. Try several positions.")
203 #define FILTER_TEXT N_("Video filter module")
204 #define FILTER_LONGTEXT N_( \
205 "This will allow you to add a post-processing filter to enhance the " \
206 "picture quality, for instance deinterlacing, or to clone or distort " \
209 #define ASPECT_RATIO_TEXT N_("Source aspect ratio")
210 #define ASPECT_RATIO_LONGTEXT N_( \
211 "This will force the source aspect ratio. For instance, some DVDs claim " \
212 "to be 16:9 while they are actually 4:3. This can also be used as a " \
213 "hint for VLC when a movie does not have aspect ratio information. " \
214 "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
215 "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
219 #define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
220 #define PIXEL_RATIO_LONGTEXT N_( \
221 "This will force the destination pixel size. By default VLC assumes " \
222 "your pixels are square, unless your hardware has a way to tell it " \
223 "otherwise. This may be used when you output VLC's signal to another " \
224 "device such as a TV set. Accepted format is a float value (1, 1.25, " \
225 "1.3333, etc.) expressing pixel squareness.")
228 #define SERVER_PORT_TEXT N_("Server port")
229 #define SERVER_PORT_LONGTEXT N_( \
230 "This is the port used for UDP streams. By default, we chose 1234.")
232 #define MTU_TEXT N_("MTU of the network interface")
233 #define MTU_LONGTEXT N_( \
234 "This is the typical size of UDP packets that we expect. On Ethernet " \
235 "it is usually 1500.")
237 #define IFACE_ADDR_TEXT N_("Network interface address")
238 #define IFACE_ADDR_LONGTEXT N_( \
239 "If you have several interfaces on your machine and use the " \
240 "multicast solution, you will probably have to indicate the IP address " \
241 "of your multicasting interface here.")
243 #define TTL_TEXT N_("Time to live")
244 #define TTL_LONGTEXT N_( \
245 "Indicate here the Time To Live of the multicast packets sent by " \
246 "the stream output.")
248 #define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
249 #define INPUT_PROGRAM_LONGTEXT N_( \
250 "Choose the program to select by giving its Service ID.")
252 #define INPUT_AUDIO_TEXT N_("Choose audio")
253 #define INPUT_AUDIO_LONGTEXT N_( \
254 "Give the default type of audio you want to use in a DVD. " \
257 #define INPUT_CHAN_TEXT N_("Choose channel")
258 #define INPUT_CHAN_LONGTEXT N_( \
259 "Give the stream number of the audio channel you want to use in a DVD " \
262 #define INPUT_SUBT_TEXT N_("Choose subtitles track")
263 #define INPUT_SUBT_LONGTEXT N_( \
264 "Give the stream number of the subtitle channel you want to use " \
267 #define SUB_AUTO_TEXT N_("Autodetect subtitle files")
268 #define SUB_AUTO_LONGTEXT \
269 "Automatically detect a subtitle file, if no subtitle filename is" \
272 #define SUB_FILE_TEXT N_("Use subtitle file")
273 #define SUB_FILE_LONGTEXT \
274 "Load this subtitle file. To be used when autodetect cannot detect " \
277 #define DVD_DEV_TEXT N_("DVD device")
279 #define DVD_DEV_LONGTEXT N_( \
280 "This is the default DVD drive (or file) to use. Don't forget the colon " \
281 "after the drive letter (eg D:)")
283 #define DVD_DEV_LONGTEXT N_( \
284 "This is the default DVD device to use.")
287 #define VCD_DEV_TEXT N_("VCD device")
288 #define VCD_DEV_LONGTEXT N_( \
289 "This is the default VCD device to use.")
291 #define IPV6_TEXT N_("Force IPv6")
292 #define IPV6_LONGTEXT N_( \
293 "If you check this box, IPv6 will be used by default for all UDP and " \
296 #define IPV4_TEXT N_("Force IPv4")
297 #define IPV4_LONGTEXT N_( \
298 "If you check this box, IPv4 will be used by default for all UDP and " \
301 #define CODEC_TEXT N_("Choose preferred codec list")
302 #define CODEC_LONGTEXT N_( \
303 "This allows you to select the order in which VLC will choose its " \
304 "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
305 "before the new one. Please be aware that VLC does not make any " \
306 "difference between audio or video codecs, so you should always specify " \
307 "'any' at the end of the list to make sure there is a fallback for the " \
308 "types you didn't specify.")
310 #define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
311 #define ENCODER_VIDEO_LONGTEXT N_( \
312 "This allows you to select the order in which VLC will choose its " \
314 #define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
315 #define ENCODER_AUDIO_LONGTEXT N_( \
316 "This allows you to select the order in which VLC will choose its " \
319 #define SOUT_TEXT N_("Choose a stream output")
320 #define SOUT_LONGTEXT N_( \
321 "Empty if no stream output.")
323 #define SOUT_DISPLAY_TEXT N_("Display while streaming")
324 #define SOUT_DISPLAY_LONGTEXT N_( \
325 "This allows you to play the stream while streaming it.")
327 #define SOUT_VIDEO_TEXT N_("Enable video stream output")
328 #define SOUT_VIDEO_LONGTEXT N_( \
329 "This allows you to choose if the video stream should be redirected to " \
330 "the stream output facility when this last one is enabled.")
332 #define SOUT_AUDIO_TEXT N_("Enable audio stream output")
333 #define SOUT_AUDIO_LONGTEXT N_( \
334 "This allows you to choose if the video stream should be redirected to " \
335 "the stream output facility when this last one is enabled.")
337 #define SOUT_KEEP_TEXT N_("Keep sout open" )
338 #define SOUT_KEEP_LONGTEXT N_( \
339 "This allows you to keep an unique sout instance across " \
340 "multiple playlist item (automatically insert gather stream_out " \
341 "if not specified)" )
343 #define PACKETIZER_TEXT N_("Choose preferred packetizer list")
344 #define PACKETIZER_LONGTEXT N_( \
345 "This allows you to select the order in which VLC will choose its " \
348 #define MUX_TEXT N_("Mux module")
349 #define MUX_LONGTEXT N_( \
350 "This is a legacy entry to let you configure mux modules")
352 #define ACCESS_OUTPUT_TEXT N_("Access output module")
353 #define ACCESS_OUTPUT_LONGTEXT N_( \
354 "This is a legacy entry to let you configure access output modules")
357 #define MMX_TEXT N_("Enable CPU MMX support")
358 #define MMX_LONGTEXT N_( \
359 "If your processor supports the MMX instructions set, VLC can take " \
360 "advantage of them.")
362 #define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
363 #define THREE_DN_LONGTEXT N_( \
364 "If your processor supports the 3D Now! instructions set, VLC can take " \
365 "advantage of them.")
367 #define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
368 #define MMXEXT_LONGTEXT N_( \
369 "If your processor supports the MMX EXT instructions set, VLC can take " \
370 "advantage of them.")
372 #define SSE_TEXT N_("Enable CPU SSE support")
373 #define SSE_LONGTEXT N_( \
374 "If your processor supports the SSE instructions set, VLC can take " \
375 "advantage of them.")
377 #define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
378 #define ALTIVEC_LONGTEXT N_( \
379 "If your processor supports the AltiVec instructions set, VLC can take " \
380 "advantage of them.")
382 #define RANDOM_TEXT N_("Play files randomly forever")
383 #define RANDOM_LONGTEXT N_( \
384 "When selected, VLC will randomly play files in the playlist until " \
387 #define LOOP_TEXT N_("Loop playlist on end")
388 #define LOOP_LONGTEXT N_( \
389 "If you want VLC to keep playing the playlist indefinitely then enable " \
392 #define REPEAT_TEXT N_("Repeat the current playlistitem")
393 #define REPEAT_LONGTEXT N_( \
394 "When this is active VLC will keep playing the current playlistitem " \
395 "over and over again.")
397 #define MEMCPY_TEXT N_("Memory copy module")
398 #define MEMCPY_LONGTEXT N_( \
399 "You can select which memory copy module you want to use. By default " \
400 "VLC will select the fastest one supported by your hardware.")
402 #define ACCESS_TEXT N_("Access module")
403 #define ACCESS_LONGTEXT N_( \
404 "This is a legacy entry to let you configure access modules")
406 #define DEMUX_TEXT N_("Demux module")
407 #define DEMUX_LONGTEXT N_( \
408 "This is a legacy entry to let you configure demux modules")
410 #define HPRIORITY_TEXT N_("Increase the priority of the process")
411 #define HPRIORITY_LONGTEXT N_( \
412 "Increasing the priority of the process will very likely improve your " \
413 "playing experience as it allows VLC not to be disturbed by other " \
414 "applications that could otherwise take too much processor time.\n" \
415 "However be advise that in certain circumstances (bugs) VLC could take " \
416 "all the processor time and render the whole system unresponsive which " \
417 "might require a reboot of your machine.")
419 #define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
420 #define FAST_MUTEX_LONGTEXT N_( \
421 "On Windows NT/2K/XP we use a slow mutex implementation but which " \
422 "allows us to correctely implement condition variables. " \
423 "You can also use the faster Win9x implementation but you might " \
424 "experience problems with it.")
426 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
428 #define WIN9X_CV_LONGTEXT N_( \
429 "On Windows 9x/Me we use a fast but not correct condition variables " \
430 "implementation (more precisely there is a possibility for a race " \
431 "condition to happen). " \
432 "However it is possible to use slower alternatives which should be more " \
434 "Currently you can choose between implementation 0 (which is the " \
435 "default and the fastest), 1 and 2.")
437 #define FULLSCREEN_KEY_TEXT N_("Fullscreen")
438 #define FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to swap fullscreen state")
439 #define PLAY_PAUSE_KEY_TEXT N_("Pause")
440 #define PLAY_PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to swap paused state")
441 #define PAUSE_KEY_TEXT N_("Pause only")
442 #define PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to pause")
443 #define PLAY_KEY_TEXT N_("Play only")
444 #define PLAY_KEY_LONGTEXT N_("Select the hotkey to use to play")
445 #define FASTER_KEY_TEXT N_("Faster")
446 #define FASTER_KEY_LONGTEXT N_("Select the hotkey to use for fast forward playback")
447 #define SLOWER_KEY_TEXT N_("Slower")
448 #define SLOWER_KEY_LONGTEXT N_("Select the hotkey to use for slow motion playback")
449 #define NEXT_KEY_TEXT N_("Next")
450 #define NEXT_KEY_LONGTEXT N_("Select the hotkey to use to skip to the next item in the playlist")
451 #define PREV_KEY_TEXT N_("Previous")
452 #define PREV_KEY_LONGTEXT N_("Select the hotkey to use to skip to the previous item in the playlist")
453 #define STOP_KEY_TEXT N_("Stop")
454 #define STOP_KEY_LONGTEXT N_("Select the hotkey to stop the playback")
455 #define QUIT_KEY_TEXT N_("Quit")
456 #define QUIT_KEY_LONGTEXT N_("Select the hotkey to quit the application")
457 #define NAV_UP_KEY_TEXT N_("Navigate up")
458 #define NAV_UP_KEY_LONGTEXT N_("Select the key to move the selector up in dvd menus")
459 #define NAV_DOWN_KEY_TEXT N_("Navigate down")
460 #define NAV_DOWN_KEY_LONGTEXT N_("Select the key to move the selector down in dvd menus")
461 #define NAV_LEFT_KEY_TEXT N_("Navigate left")
462 #define NAV_LEFT_KEY_LONGTEXT N_("Select the key to move the selector left in dvd menus")
463 #define NAV_RIGHT_KEY_TEXT N_("Navigate right")
464 #define NAV_RIGHT_KEY_LONGTEXT N_("Select the key to move the selector right in dvd menus")
465 #define NAV_ACTIVATE_KEY_TEXT N_("Activate")
466 #define NAV_ACTIVATE_KEY_LONGTEXT N_("Select the key to activate selected item in dvd menus")
467 #define VOL_UP_KEY_TEXT N_("Volume up")
468 #define VOL_UP_KEY_LONGTEXT N_("Select the key to turn up audio volume")
469 #define VOL_DOWN_KEY_TEXT N_("Volume down")
470 #define VOL_DOWN_KEY_LONGTEXT N_("Select the key to turn down audio volume")
472 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
473 "\n *.mpg, *.vob plain MPEG-1/2 files" \
474 "\n [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
476 "\n [vcd:][device][@[title][,[chapter]]" \
478 "\n udpstream:[@[<bind address>][:<bind port>]]" \
479 "\n UDP stream sent by a streaming server" \
480 "\n vlc:pause pause execution of " \
482 "\n vlc:quit quit VLC" \
487 * Quick usage guide for the configuration options:
489 * add_category_hint( N_(text), N_(longtext) );
490 * add_subcategory_hint( N_(text), N_(longtext) );
491 * add_usage_hint( N_(text) );
492 * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
493 * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
494 * add_module( option_name, psz_value, i_capability, p_callback,
495 * N_(text), N_(longtext) );
496 * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
497 * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
501 /* Interface options */
502 add_category_hint( N_("Interface"), NULL, VLC_FALSE );
503 add_module_with_short( "intf", 'I', "interface", NULL, NULL,
504 INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
505 add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
506 add_integer_with_short( "verbose", 'v', 0, NULL,
507 VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
508 add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
509 add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
510 add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
511 add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
512 add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
513 add_directory( "plugin-path", NULL, NULL,
514 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
517 add_category_hint( N_("Audio"), NULL, VLC_FALSE );
518 add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
519 AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
520 add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
521 add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
522 AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
523 VOLUME_LONGTEXT, VLC_FALSE );
524 add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
525 AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
526 VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
527 add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
528 #if !defined( SYS_DARWIN )
529 add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
531 add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
532 add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
533 add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
534 add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
535 AUDIO_FILTER_LONGTEXT,VLC_FALSE);
538 add_category_hint( N_("Video"), NULL, VLC_FALSE );
539 add_module_with_short( "vout", 'V', "video output", NULL, NULL,
540 VOUT_TEXT, VOUT_LONGTEXT, VLC_FALSE );
541 add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
542 add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
543 add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
544 add_integer( "align", -1, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
545 add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
546 add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
547 add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
549 add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
551 add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
552 add_module( "filter", "video filter", NULL, NULL,
553 FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
554 add_string( "aspect-ratio", "", NULL,
555 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
557 add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
561 add_category_hint( N_("Input"), NULL, VLC_FALSE );
562 add_integer( "server-port", 1234, NULL,
563 SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
564 add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
565 add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
567 add_integer( "program", 0, NULL,
568 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
569 add_integer( "audio-type", -1, NULL,
570 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
571 add_integer( "audio-channel", -1, NULL,
572 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
573 add_integer( "spu-channel", -1, NULL,
574 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
575 add_bool( "sub-autodetect-file", VLC_TRUE, NULL,
576 SUB_AUTO_TEXT, SUB_AUTO_LONGTEXT, VLC_FALSE );
577 add_file( "sub-file", NULL, NULL,
578 SUB_FILE_TEXT, SUB_FILE_LONGTEXT, VLC_TRUE );
581 add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
582 add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
584 add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
585 add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
587 /* Decoder options */
588 add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
589 add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
592 /* Stream output options */
593 add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
594 add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
595 add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
596 add_bool( "sout-keep", VLC_FALSE, NULL, SOUT_KEEP_TEXT, SOUT_KEEP_LONGTEXT, VLC_TRUE );
598 add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
599 add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );
601 add_module( "packetizer", "packetizer", NULL, NULL,
602 PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
603 add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
604 add_module( "access_output", "sout access", NULL, NULL,
605 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
606 add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
610 add_category_hint( N_("CPU"), NULL, VLC_TRUE );
611 #if defined( __i386__ )
612 add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
613 add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
614 add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
615 add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
617 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
618 add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
621 /* Playlist options */
622 add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
623 add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
624 add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
625 add_bool( "repeat", 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
628 add_category_hint( N_("Miscellaneous"), NULL, VLC_TRUE );
629 add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
630 add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
631 add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
634 add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
635 add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
636 add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
640 add_category_hint( N_("Hot keys"), NULL, VLC_FALSE );
641 add_key( "fullscreen-key", 'f', NULL, FULLSCREEN_KEY_TEXT, FULLSCREEN_KEY_LONGTEXT, VLC_FALSE );
642 add_key( "play-pause-key", KEY_SPACE, NULL, PLAY_PAUSE_KEY_TEXT, PLAY_PAUSE_KEY_LONGTEXT, VLC_FALSE );
643 add_key( "pause-key", 0, NULL, PAUSE_KEY_TEXT, PAUSE_KEY_LONGTEXT, VLC_TRUE );
644 add_key( "play-key", 0, NULL, PLAY_KEY_TEXT, PLAY_KEY_LONGTEXT, VLC_TRUE );
645 add_key( "faster-key", '+', NULL, FASTER_KEY_TEXT, FASTER_KEY_LONGTEXT, VLC_FALSE );
646 add_key( "slower-key", '-', NULL, SLOWER_KEY_TEXT, SLOWER_KEY_LONGTEXT, VLC_FALSE );
647 add_key( "next-key", 'n', NULL, NEXT_KEY_TEXT, NEXT_KEY_LONGTEXT, VLC_FALSE );
648 add_key( "prev-key", 'p', NULL, PREV_KEY_TEXT, PREV_KEY_LONGTEXT, VLC_FALSE );
649 add_key( "stop-key", 's', NULL, STOP_KEY_TEXT, STOP_KEY_LONGTEXT, VLC_FALSE );
650 add_key( "nav-activate-key", KEY_ENTER, NULL, NAV_ACTIVATE_KEY_TEXT, NAV_ACTIVATE_KEY_LONGTEXT, VLC_FALSE );
651 add_key( "nav-up-key", KEY_UP, NULL, NAV_UP_KEY_TEXT, NAV_UP_KEY_LONGTEXT, VLC_FALSE );
652 add_key( "nav-down-key", KEY_DOWN, NULL, NAV_DOWN_KEY_TEXT, NAV_DOWN_KEY_LONGTEXT, VLC_FALSE );
653 add_key( "nav-left-key", KEY_LEFT, NULL, NAV_LEFT_KEY_TEXT, NAV_LEFT_KEY_LONGTEXT, VLC_FALSE );
654 add_key( "nav-right-key", KEY_RIGHT, NULL, NAV_RIGHT_KEY_TEXT, NAV_RIGHT_KEY_LONGTEXT, VLC_FALSE );
655 add_key( "quit-key", KEY_MODIFIER_CTRL|KEY_SPACE, NULL, QUIT_KEY_TEXT, QUIT_KEY_LONGTEXT, VLC_FALSE );
656 add_key( "vol-up-key", 'a', NULL, VOL_UP_KEY_TEXT, VOL_UP_KEY_LONGTEXT, VLC_FALSE );
657 add_key( "vol-down-key", 'z', NULL, VOL_DOWN_KEY_TEXT, VOL_DOWN_KEY_LONGTEXT, VLC_FALSE );
659 /* Usage (mainly useful for cmd line stuff) */
660 add_usage_hint( PLAYLIST_USAGE );
662 set_description( N_("main program") );
663 set_capability( "main", 100 );
666 static module_config_t p_help_config[] =
668 { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
669 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
670 { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
671 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
672 { CONFIG_ITEM_BOOL, NULL, "list", 'l',
673 N_("print a list of available modules"),
674 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
675 { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
676 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
677 { CONFIG_ITEM_BOOL, NULL, "version", '\0',
678 N_("print version information"),
679 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
680 { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
681 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
684 /*****************************************************************************
686 *****************************************************************************/