1 /*****************************************************************************
2 * libvlc.h: main libvlc header
3 *****************************************************************************
4 * Copyright (C) 1998-2002 VideoLAN
5 * $Id: libvlc.h,v 1.98 2003/10/29 01:33:27 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
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 *****************************************************************************/
39 #define INTF_CAT_LONGTEXT N_( \
40 "These options allow you to configure the interfaces used by VLC.\n" \
41 "You can select the main interface, additional " \
42 "interface modules, and define various related options." )
44 #define INTF_TEXT N_("Interface module")
45 #define INTF_LONGTEXT N_( \
46 "This option allows you to select the interface used by VLC.\n" \
47 "The default behavior is to automatically select the best module " \
50 #define EXTRAINTF_TEXT N_("Extra interface modules")
51 #define EXTRAINTF_LONGTEXT N_( \
52 "This option allows you to select additional interfaces used by VLC. " \
53 "They will be launched in the background in addition to the default " \
54 "interface. Use a comma separated list of interface modules. (common " \
55 "values are: logger,gestures,sap,rc,http,screensaver)")
57 #define VERBOSE_TEXT N_("Verbosity (0,1,2)")
58 #define VERBOSE_LONGTEXT N_( \
59 "This options sets the verbosity level (0=only errors and " \
60 "standard messages, 1=warnings, 2=debug).")
62 #define QUIET_TEXT N_("Be quiet")
63 #define QUIET_LONGTEXT N_( \
64 "This options turns off all warning and information messages.")
66 #define LANGUAGE_TEXT N_("Language")
67 #define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
68 "of the interface. The system language is auto-detected if \"auto\" is " \
71 #define COLOR_TEXT N_("Color messages")
72 #define COLOR_LONGTEXT N_( \
73 "When this option is turned on, the messages sent to the console will " \
74 "be colorized. Your terminal needs Linux color support for this to work.")
76 #define ADVANCED_TEXT N_("Show advanced options")
77 #define ADVANCED_LONGTEXT N_( \
78 "When this option is turned on, the preferences and/or interfaces will " \
79 "show all the available options, including those that most users should " \
82 #define INTF_PATH_TEXT N_("Interface default search path")
83 #define INTF_PATH_LONGTEXT N_( \
84 "This option allows you to set the default path that the interface will " \
85 "open when looking for a file.")
87 #define PLUGIN_PATH_TEXT N_("Plugin search path")
88 #define PLUGIN_PATH_LONGTEXT N_( \
89 "This option allows you to specify an additional path for VLC to look " \
92 #define AOUT_CAT_LONGTEXT N_( \
93 "These options allow you to tune VLC's audio subsystem, " \
94 "and to add audio filters which can be used for " \
95 "postprocessing or visual effects (spectrum analyser,...).\n" \
96 "To tune these filters, have a look at the \"audio filter\" " \
99 #define AOUT_TEXT N_("Audio output module")
100 #define AOUT_LONGTEXT N_( \
101 "This option allows you to select the audio output method used by VLC. " \
102 "The default behavior is to automatically select the best method " \
105 #define AUDIO_TEXT N_("Enable audio")
106 #define AUDIO_LONGTEXT N_( \
107 "You can completely disable the audio output. In this case the audio " \
108 "decoding will not take place, and it will save some processing power.")
110 #define MONO_TEXT N_("Force mono audio")
111 #define MONO_LONGTEXT N_("This will force a mono audio output")
113 #define VOLUME_TEXT N_("Audio output volume")
114 #define VOLUME_LONGTEXT N_( \
115 "You can set the default audio output volume here, in a range from 0 to " \
118 #define VOLUME_SAVE_TEXT N_("Audio output saved volume")
119 #define VOLUME_SAVE_LONGTEXT N_( \
120 "This saves the audio output volume when you select mute.")
122 #define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
123 #define AOUT_RATE_LONGTEXT N_( \
124 "You can force the audio output frequency here. Common values are " \
125 "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
127 #if !defined( SYS_DARWIN )
128 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
129 #define AOUT_RESAMP_LONGTEXT N_( \
130 "High quality audio resampling can be processor intensive so you can " \
131 "disable it and a cheaper resampling algorithm will be used instead.")
134 #define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
135 #define DESYNC_LONGTEXT N_( \
136 "This option allows you to delay the audio output. This can be handy if " \
137 "you notice a lag between the video and the audio.")
139 #define MULTICHA_TEXT N_("Choose prefered audio output channels mode")
140 #define MULTICHA_LONGTEXT N_( \
141 "This option allows you to set the audio output channels mode that will " \
142 "be used by default when possible (ie. if your hardware supports it as " \
143 "well as the audio stream being played)")
145 #define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
146 #define SPDIF_LONGTEXT N_( \
147 "This option allows you to use the S/PDIF audio output by default when " \
148 "your hardware supports it as well as the audio stream being played.")
150 #define AUDIO_FILTER_TEXT N_("Audio filters")
151 #define AUDIO_FILTER_LONGTEXT N_( \
152 "This allows you to add audio postprocessing filters, to modify " \
155 #define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
156 #define HEADPHONE_LONGTEXT N_( \
157 "This effect gives you the feeling that you are standing in a room " \
158 "with a complete 5.1 speaker set when using only a headphone, " \
159 "providing a more realistic sound experience. It should also be " \
160 "more comfortable and less tiring when listening to music for " \
161 "long periods of time.\nIt works with any source format from mono " \
164 #define VOUT_CAT_LONGTEXT N_( \
165 "These options allow you to modify options related to " \
166 "the video output subsystem. You can for example enable " \
167 "video filters, like deinterlacing, constrast / hue / " \
168 "saturation adjusting, ...\n" \
169 "Enable these filters here and configure them in the video " \
170 "filters plugins section." )
172 #define VOUT_TEXT N_("Video output module")
173 #define VOUT_LONGTEXT N_( \
174 "This option allows you to select the video output method used by VLC. " \
175 "The default behavior is to automatically select the best " \
178 #define VIDEO_TEXT N_("Enable video")
179 #define VIDEO_LONGTEXT N_( \
180 "You can completely disable the video output. In this case the video " \
181 "decoding stage will not take place, which will save some processing power.")
183 #define WIDTH_TEXT N_("Video width")
184 #define WIDTH_LONGTEXT N_( \
185 "You can enforce the video width here. By default (-1) VLC will " \
186 "adapt to the video characteristics.")
188 #define HEIGHT_TEXT N_("Video height")
189 #define HEIGHT_LONGTEXT N_( \
190 "You can enforce the video height here. By default (-1) VLC will " \
191 "adapt to the video characteristics.")
193 #define ALIGN_TEXT N_("Video alignment")
194 #define ALIGN_LONGTEXT N_( \
195 "You can enforce the video alignement in its window. By default (0) it " \
196 "will be centered (0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
197 "also use combinations of these values).")
199 #define ZOOM_TEXT N_("Zoom video")
200 #define ZOOM_LONGTEXT N_( \
201 "You can zoom the video by the specified factor.")
203 #define GRAYSCALE_TEXT N_("Grayscale video output")
204 #define GRAYSCALE_LONGTEXT N_( \
205 "When enabled, the color information from the video won't be decoded " \
206 "(this can also allow you to save some processing power).")
208 #define FULLSCREEN_TEXT N_("Fullscreen video output")
209 #define FULLSCREEN_LONGTEXT N_( \
210 "If this option is enabled, VLC will always start a video in fullscreen " \
213 #define OVERLAY_TEXT N_("Overlay video output")
214 #define OVERLAY_LONGTEXT N_( \
215 "If enabled, VLC will try to take advantage of the overlay capabilities " \
216 "of your graphics card.")
218 #define SPUMARGIN_TEXT N_("Force SPU position")
219 #define SPUMARGIN_LONGTEXT N_( \
220 "You can use this option to place the subtitles under the movie, " \
221 "instead of over the movie. Try several positions.")
223 #define FILTER_TEXT N_("Video filter module")
224 #define FILTER_LONGTEXT N_( \
225 "This will allow you to add a post-processing filter to enhance the " \
226 "picture quality, for instance deinterlacing, or to clone or distort " \
229 #define ASPECT_RATIO_TEXT N_("Source aspect ratio")
230 #define ASPECT_RATIO_LONGTEXT N_( \
231 "This will force the source aspect ratio. For instance, some DVDs claim " \
232 "to be 16:9 while they are actually 4:3. This can also be used as a " \
233 "hint for VLC when a movie does not have aspect ratio information. " \
234 "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
235 "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
239 #define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
240 #define PIXEL_RATIO_LONGTEXT N_( \
241 "This will force the destination pixel size. By default VLC assumes " \
242 "your pixels are square, unless your hardware has a way to tell it " \
243 "otherwise. This may be used when you output VLC's signal to another " \
244 "device such as a TV set. Accepted format is a float value (1, 1.25, " \
245 "1.3333, etc.) expressing pixel squareness.")
248 #define INPUT_CAT_LONGTEXT N_( " " )
250 #define SERVER_PORT_TEXT N_("Server port")
251 #define SERVER_PORT_LONGTEXT N_( \
252 "This is the port used for UDP streams. By default, we chose 1234.")
254 #define MTU_TEXT N_("MTU of the network interface")
255 #define MTU_LONGTEXT N_( \
256 "This is the typical size of UDP packets that we expect. On Ethernet " \
257 "it is usually 1500.")
259 #define IFACE_ADDR_TEXT N_("Network interface address")
260 #define IFACE_ADDR_LONGTEXT N_( \
261 "If you have several interfaces on your machine and use the " \
262 "multicast solution, you will probably have to indicate the IP address " \
263 "of your multicasting interface here.")
265 #define TTL_TEXT N_("Time to live")
266 #define TTL_LONGTEXT N_( \
267 "Indicate here the Time To Live of the multicast packets sent by " \
268 "the stream output.")
270 #define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
271 #define INPUT_PROGRAM_LONGTEXT N_( \
272 "Choose the program to select by giving its Service ID.")
274 #define INPUT_AUDIO_TEXT N_("Choose audio")
275 #define INPUT_AUDIO_LONGTEXT N_( \
276 "Give the default type of audio you want to use in a DVD. " \
279 #define INPUT_CHAN_TEXT N_("Choose channel")
280 #define INPUT_CHAN_LONGTEXT N_( \
281 "Give the stream number of the audio channel you want to use in a DVD " \
284 #define INPUT_SUBT_TEXT N_("Choose subtitles track")
285 #define INPUT_SUBT_LONGTEXT N_( \
286 "Give the stream number of the subtitle channel you want to use " \
289 #define SUB_AUTO_TEXT N_("Autodetect subtitle files")
290 #define SUB_AUTO_LONGTEXT \
291 "Automatically detect a subtitle file, if no subtitle filename is " \
294 #define SUB_FUZZY_TEXT N_("Subtitle autodection fuzziness")
295 #define SUB_FUZZY_LONGTEXT \
296 "This determines how fuzzy subtitle and movie filenaming matching " \
297 "will be. Options are:\n" \
298 "0 = no subtitles autodetected\n" \
299 "1 = any subtitle file\n" \
300 "2 = any subtitle file containing the movie name\n" \
301 "3 = subtitle file matching the movie name with additional chars\n" \
302 "4 = subtitle file matching the movie name exactly"
304 #define SUB_FILE_TEXT N_("Use subtitle file")
305 #define SUB_FILE_LONGTEXT \
306 "Load this subtitle file. To be used when autodetect cannot detect " \
309 #define DVD_DEV_TEXT N_("DVD device")
311 #define DVD_DEV_LONGTEXT N_( \
312 "This is the default DVD drive (or file) to use. Don't forget the colon " \
313 "after the drive letter (eg D:)")
315 #define DVD_DEV_LONGTEXT N_( \
316 "This is the default DVD device to use.")
319 #define VCD_DEV_TEXT N_("VCD device")
320 #define VCD_DEV_LONGTEXT N_( \
321 "This is the default VCD device to use.")
323 #define IPV6_TEXT N_("Force IPv6")
324 #define IPV6_LONGTEXT N_( \
325 "If you check this box, IPv6 will be used by default for all UDP and " \
328 #define IPV4_TEXT N_("Force IPv4")
329 #define IPV4_LONGTEXT N_( \
330 "If you check this box, IPv4 will be used by default for all UDP and " \
333 #define CODEC_CAT_LONGTEXT N_( \
334 "This option can be used to alter the way VLC selects " \
335 "its codecs (decompression methods). Only advanced users should " \
336 "alter this option as it can break playback of all your streams." )
338 #define CODEC_TEXT N_("Choose preferred codec list")
339 #define CODEC_LONGTEXT N_( \
340 "This allows you to select the order in which VLC will choose its " \
341 "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
342 "before the new one. Please be aware that VLC does not make any " \
343 "difference between audio or video codecs, so you should always specify " \
344 "'any' at the end of the list to make sure there is a fallback for the " \
345 "types you didn't specify.")
348 #define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
349 #define ENCODER_VIDEO_LONGTEXT N_( \
350 "This allows you to select the order in which VLC will choose its " \
352 #define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
353 #define ENCODER_AUDIO_LONGTEXT N_( \
354 "This allows you to select the order in which VLC will choose its " \
357 #define SOUT_CAT_LONGTEXT N_( \
358 "These options allow you to set default global options for the " \
359 "stream output subsystem." )
361 #define SOUT_TEXT N_("Choose a stream output")
362 #define SOUT_LONGTEXT N_( \
363 "Empty if no stream output.")
365 #define SOUT_DISPLAY_TEXT N_("Display while streaming")
366 #define SOUT_DISPLAY_LONGTEXT N_( \
367 "This allows you to play the stream while streaming it.")
369 #define SOUT_VIDEO_TEXT N_("Enable video stream output")
370 #define SOUT_VIDEO_LONGTEXT N_( \
371 "This allows you to choose if the video stream should be redirected to " \
372 "the stream output facility when this last one is enabled.")
374 #define SOUT_AUDIO_TEXT N_("Enable audio stream output")
375 #define SOUT_AUDIO_LONGTEXT N_( \
376 "This allows you to choose if the video stream should be redirected to " \
377 "the stream output facility when this last one is enabled.")
379 #define SOUT_KEEP_TEXT N_("Keep sout open" )
380 #define SOUT_KEEP_LONGTEXT N_( \
381 "This allows you to keep an unique sout instance across " \
382 "multiple playlist item (automatically insert gather stream_out " \
383 "if not specified)" )
385 #define PACKETIZER_TEXT N_("Choose preferred packetizer list")
386 #define PACKETIZER_LONGTEXT N_( \
387 "This allows you to select the order in which VLC will choose its " \
390 #define MUX_TEXT N_("Mux module")
391 #define MUX_LONGTEXT N_( \
392 "This is a legacy entry to let you configure mux modules")
394 #define ACCESS_OUTPUT_TEXT N_("Access output module")
395 #define ACCESS_OUTPUT_LONGTEXT N_( \
396 "This is a legacy entry to let you configure access output modules")
398 #define CPU_CAT_LONGTEXT N_( \
399 "These options allow you to enable special CPU optimizations.\n" \
400 "You should always leave all these enabled." )
402 #define MMX_TEXT N_("Enable CPU MMX support")
403 #define MMX_LONGTEXT N_( \
404 "If your processor supports the MMX instructions set, VLC can take " \
405 "advantage of them.")
407 #define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
408 #define THREE_DN_LONGTEXT N_( \
409 "If your processor supports the 3D Now! instructions set, VLC can take " \
410 "advantage of them.")
412 #define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
413 #define MMXEXT_LONGTEXT N_( \
414 "If your processor supports the MMX EXT instructions set, VLC can take " \
415 "advantage of them.")
417 #define SSE_TEXT N_("Enable CPU SSE support")
418 #define SSE_LONGTEXT N_( \
419 "If your processor supports the SSE instructions set, VLC can take " \
420 "advantage of them.")
422 #define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
423 #define ALTIVEC_LONGTEXT N_( \
424 "If your processor supports the AltiVec instructions set, VLC can take " \
425 "advantage of them.")
427 #define PLAYLIST_CAT_LONGTEXT N_( \
428 "These options define the behaviour of the playlist. Some " \
429 "of them can be overriden in the playlist dialog box." )
431 #define RANDOM_TEXT N_("Play files randomly forever")
432 #define RANDOM_LONGTEXT N_( \
433 "When selected, VLC will randomly play files in the playlist until " \
436 #define LOOP_TEXT N_("Loop playlist on end")
437 #define LOOP_LONGTEXT N_( \
438 "If you want VLC to keep playing the playlist indefinitely then enable " \
441 #define REPEAT_TEXT N_("Repeat the current playlistitem")
442 #define REPEAT_LONGTEXT N_( \
443 "When this is active VLC will keep playing the current playlistitem " \
444 "over and over again.")
446 #define MISC_CAT_LONGTEXT N_( \
447 "These options allow you to select default modules. Leave these " \
448 "alone unless you really know what you are doing." )
450 #define MEMCPY_TEXT N_("Memory copy module")
451 #define MEMCPY_LONGTEXT N_( \
452 "You can select which memory copy module you want to use. By default " \
453 "VLC will select the fastest one supported by your hardware.")
455 #define ACCESS_TEXT N_("Access module")
456 #define ACCESS_LONGTEXT N_( \
457 "This is a legacy entry to let you configure access modules")
459 #define DEMUX_TEXT N_("Demux module")
460 #define DEMUX_LONGTEXT N_( \
461 "This is a legacy entry to let you configure demux modules")
463 #define ONEINSTANCE_TEXT N_("Allow only one running instance of VLC")
464 #define ONEINSTANCE_LONGTEXT N_( \
465 "Allowing only one running instance of VLC can sometimes be useful, " \
466 "for instance if you associated VLC with some media types and you " \
467 "don't want a new instance of VLC to be opened each time you " \
468 "double-click on a file in the explorer. This option will allow you " \
469 "to play the file with the already running instance or enqueue it.")
471 #define HPRIORITY_TEXT N_("Increase the priority of the process")
472 #define HPRIORITY_LONGTEXT N_( \
473 "Increasing the priority of the process will very likely improve your " \
474 "playing experience as it allows VLC not to be disturbed by other " \
475 "applications that could otherwise take too much processor time.\n" \
476 "However be advise that in certain circumstances (bugs) VLC could take " \
477 "all the processor time and render the whole system unresponsive which " \
478 "might require a reboot of your machine.")
480 #define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
481 #define FAST_MUTEX_LONGTEXT N_( \
482 "On Windows NT/2K/XP we use a slow mutex implementation but which " \
483 "allows us to correctely implement condition variables. " \
484 "You can also use the faster Win9x implementation but you might " \
485 "experience problems with it.")
487 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
489 #define WIN9X_CV_LONGTEXT N_( \
490 "On Windows 9x/Me we use a fast but not correct condition variables " \
491 "implementation (more precisely there is a possibility for a race " \
492 "condition to happen). " \
493 "However it is possible to use slower alternatives which should be more " \
495 "Currently you can choose between implementation 0 (which is the " \
496 "default and the fastest), 1 and 2.")
498 #define HOTKEY_CAT_LONGTEXT N_( " " )
500 #define FULLSCREEN_KEY_TEXT N_("Fullscreen")
501 #define FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to swap fullscreen state")
502 #define PLAY_PAUSE_KEY_TEXT N_("Pause")
503 #define PLAY_PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to swap paused state")
504 #define PAUSE_KEY_TEXT N_("Pause only")
505 #define PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to pause")
506 #define PLAY_KEY_TEXT N_("Play only")
507 #define PLAY_KEY_LONGTEXT N_("Select the hotkey to use to play")
508 #define FASTER_KEY_TEXT N_("Faster")
509 #define FASTER_KEY_LONGTEXT N_("Select the hotkey to use for fast forward playback")
510 #define SLOWER_KEY_TEXT N_("Slower")
511 #define SLOWER_KEY_LONGTEXT N_("Select the hotkey to use for slow motion playback")
512 #define NEXT_KEY_TEXT N_("Next")
513 #define NEXT_KEY_LONGTEXT N_("Select the hotkey to use to skip to the next item in the playlist")
514 #define PREV_KEY_TEXT N_("Previous")
515 #define PREV_KEY_LONGTEXT N_("Select the hotkey to use to skip to the previous item in the playlist")
516 #define STOP_KEY_TEXT N_("Stop")
517 #define STOP_KEY_LONGTEXT N_("Select the hotkey to stop the playback")
518 #define QUIT_KEY_TEXT N_("Quit")
519 #define QUIT_KEY_LONGTEXT N_("Select the hotkey to quit the application")
520 #define NAV_UP_KEY_TEXT N_("Navigate up")
521 #define NAV_UP_KEY_LONGTEXT N_("Select the key to move the selector up in dvd menus")
522 #define NAV_DOWN_KEY_TEXT N_("Navigate down")
523 #define NAV_DOWN_KEY_LONGTEXT N_("Select the key to move the selector down in dvd menus")
524 #define NAV_LEFT_KEY_TEXT N_("Navigate left")
525 #define NAV_LEFT_KEY_LONGTEXT N_("Select the key to move the selector left in dvd menus")
526 #define NAV_RIGHT_KEY_TEXT N_("Navigate right")
527 #define NAV_RIGHT_KEY_LONGTEXT N_("Select the key to move the selector right in dvd menus")
528 #define NAV_ACTIVATE_KEY_TEXT N_("Activate")
529 #define NAV_ACTIVATE_KEY_LONGTEXT N_("Select the key to activate selected item in dvd menus")
530 #define VOL_UP_KEY_TEXT N_("Volume up")
531 #define VOL_UP_KEY_LONGTEXT N_("Select the key to turn up audio volume")
532 #define VOL_DOWN_KEY_TEXT N_("Volume down")
533 #define VOL_DOWN_KEY_LONGTEXT N_("Select the key to turn down audio volume")
535 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
536 "\n *.mpg, *.vob plain MPEG-1/2 files" \
537 "\n [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
539 "\n [vcd:][device][@[title][,[chapter]]" \
541 "\n udpstream:[@[<bind address>][:<bind port>]]" \
542 "\n UDP stream sent by a streaming server" \
543 "\n vlc:pause pause execution of " \
545 "\n vlc:quit quit VLC" \
550 * Quick usage guide for the configuration options:
552 * add_category_hint( N_(text), N_(longtext) );
553 * add_subcategory_hint( N_(text), N_(longtext) );
554 * add_usage_hint( N_(text) );
555 * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
556 * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
557 * add_module( option_name, psz_value, i_capability, p_callback,
558 * N_(text), N_(longtext) );
559 * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
560 * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
564 /* Interface options */
565 add_category_hint( N_("Interface"), INTF_CAT_LONGTEXT , VLC_FALSE );
566 add_module_with_short( "intf", 'I', "interface", NULL, NULL,
567 INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
568 add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT,
569 EXTRAINTF_LONGTEXT, VLC_FALSE );
570 add_integer_with_short( "verbose", 'v', 0, NULL,
571 VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
572 add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT,
573 QUIET_LONGTEXT, VLC_TRUE );
574 add_string_from_list( "language", "auto", ppsz_language, NULL,
575 LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
576 add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
577 add_bool( "advanced", 0, NULL, ADVANCED_TEXT,
578 ADVANCED_LONGTEXT, VLC_FALSE );
579 add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT,
580 INTF_PATH_LONGTEXT, VLC_TRUE );
581 add_directory( "plugin-path", NULL, NULL,
582 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
585 add_category_hint( N_("Audio"), AOUT_CAT_LONGTEXT , VLC_FALSE );
586 add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
587 AOUT_TEXT, AOUT_LONGTEXT, VLC_TRUE);
588 add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_FALSE );
589 add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
590 AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
591 VOLUME_LONGTEXT, VLC_FALSE );
592 add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
593 AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
594 VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
595 add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
596 #if !defined( SYS_DARWIN )
597 add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
599 add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
601 add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT,
602 HEADPHONE_LONGTEXT, VLC_FALSE );
604 add_integer( "audio-desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
605 add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
606 AUDIO_FILTER_LONGTEXT,VLC_FALSE);
609 add_category_hint( N_("Video"), VOUT_CAT_LONGTEXT , VLC_FALSE );
610 add_module_with_short( "vout", 'V', "video output", NULL, NULL,
611 VOUT_TEXT, VOUT_LONGTEXT, VLC_TRUE );
612 add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
613 add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
614 add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
615 add_integer( "align", -1, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
616 add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
617 add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
618 add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT,
619 FULLSCREEN_LONGTEXT, VLC_FALSE );
621 add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
623 add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT,
624 SPUMARGIN_LONGTEXT, VLC_TRUE );
625 add_module( "filter", "video filter", NULL, NULL,
626 FILTER_TEXT, FILTER_LONGTEXT, VLC_FALSE );
627 add_string( "aspect-ratio", "", NULL,
628 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
630 add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
634 add_category_hint( N_("Input"), INPUT_CAT_LONGTEXT , VLC_FALSE );
635 add_integer( "server-port", 1234, NULL,
636 SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
637 add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
638 add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
640 add_integer( "program", 0, NULL,
641 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
642 add_integer( "audio-type", -1, NULL,
643 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
644 add_integer( "audio-channel", -1, NULL,
645 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
646 add_integer( "spu-channel", -1, NULL,
647 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
648 add_bool( "sub-autodetect-file", VLC_TRUE, NULL,
649 SUB_AUTO_TEXT, SUB_AUTO_LONGTEXT, VLC_FALSE );
650 add_integer( "sub-autodetect-fuzzy", 3, NULL,
651 SUB_FUZZY_TEXT, SUB_FUZZY_LONGTEXT, VLC_TRUE );
652 add_file( "sub-file", NULL, NULL,
653 SUB_FILE_TEXT, SUB_FILE_LONGTEXT, VLC_TRUE );
656 add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
657 add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
659 add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
660 add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
662 /* Decoder options */
663 add_category_hint( N_("Decoders"), CODEC_CAT_LONGTEXT , VLC_TRUE );
664 add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
667 /* Stream output options */
668 add_category_hint( N_("Stream output"), SOUT_CAT_LONGTEXT , VLC_TRUE );
669 add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
670 add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT,
671 SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
672 add_bool( "sout-keep", VLC_FALSE, NULL, SOUT_KEEP_TEXT,
673 SOUT_KEEP_LONGTEXT, VLC_TRUE );
675 add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT,
676 SOUT_AUDIO_LONGTEXT, VLC_TRUE );
677 add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT,
678 SOUT_VIDEO_LONGTEXT, VLC_TRUE );
680 add_module( "packetizer", "packetizer", NULL, NULL,
681 PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
682 add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT,
683 MUX_LONGTEXT, VLC_TRUE );
684 add_module( "access_output", "sout access", NULL, NULL,
685 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
686 add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
690 add_category_hint( N_("CPU"), CPU_CAT_LONGTEXT, VLC_TRUE );
691 #if defined( __i386__ )
692 add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
693 add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
694 add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
695 add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
697 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
698 add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
701 /* Playlist options */
702 add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
703 add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
704 add_bool_with_short( "loop", 'L', 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
705 add_bool_with_short( "repeat", 'R', 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
708 add_category_hint( N_("Miscellaneous"), MISC_CAT_LONGTEXT, VLC_TRUE );
709 add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
710 add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
711 add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
714 add_bool( "one-instance", 0, NULL, ONEINSTANCE_TEXT, ONEINSTANCE_LONGTEXT, VLC_TRUE );
715 add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
716 add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
717 add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
721 add_category_hint( N_("Hot keys"), HOTKEY_CAT_LONGTEXT , VLC_FALSE );
722 add_key( "key-fullscreen", 'f', NULL, FULLSCREEN_KEY_TEXT, FULLSCREEN_KEY_LONGTEXT, VLC_FALSE );
723 add_key( "key-play-pause", KEY_SPACE, NULL, PLAY_PAUSE_KEY_TEXT, PLAY_PAUSE_KEY_LONGTEXT, VLC_FALSE );
724 add_key( "key-pause", 0, NULL, PAUSE_KEY_TEXT, PAUSE_KEY_LONGTEXT, VLC_TRUE );
725 add_key( "key-play", 0, NULL, PLAY_KEY_TEXT, PLAY_KEY_LONGTEXT, VLC_TRUE );
726 add_key( "key-faster", '+', NULL, FASTER_KEY_TEXT, FASTER_KEY_LONGTEXT, VLC_FALSE );
727 add_key( "key-slower", '-', NULL, SLOWER_KEY_TEXT, SLOWER_KEY_LONGTEXT, VLC_FALSE );
728 add_key( "key-next", 'n', NULL, NEXT_KEY_TEXT, NEXT_KEY_LONGTEXT, VLC_FALSE );
729 add_key( "key-prev", 'p', NULL, PREV_KEY_TEXT, PREV_KEY_LONGTEXT, VLC_FALSE );
730 add_key( "key-stop", 's', NULL, STOP_KEY_TEXT, STOP_KEY_LONGTEXT, VLC_FALSE );
731 add_key( "key-nav-activate", KEY_ENTER, NULL, NAV_ACTIVATE_KEY_TEXT, NAV_ACTIVATE_KEY_LONGTEXT, VLC_FALSE );
732 add_key( "key-nav-up", KEY_UP, NULL, NAV_UP_KEY_TEXT, NAV_UP_KEY_LONGTEXT, VLC_FALSE );
733 add_key( "key-nav-down", KEY_DOWN, NULL, NAV_DOWN_KEY_TEXT, NAV_DOWN_KEY_LONGTEXT, VLC_FALSE );
734 add_key( "key-nav-left", KEY_LEFT, NULL, NAV_LEFT_KEY_TEXT, NAV_LEFT_KEY_LONGTEXT, VLC_FALSE );
735 add_key( "key-nav-right", KEY_RIGHT, NULL, NAV_RIGHT_KEY_TEXT, NAV_RIGHT_KEY_LONGTEXT, VLC_FALSE );
736 add_key( "key-quit", KEY_MODIFIER_CTRL|KEY_SPACE, NULL, QUIT_KEY_TEXT, QUIT_KEY_LONGTEXT, VLC_FALSE );
737 add_key( "key-vol-up", 'a', NULL, VOL_UP_KEY_TEXT, VOL_UP_KEY_LONGTEXT, VLC_FALSE );
738 add_key( "key-vol-down", 'z', NULL, VOL_DOWN_KEY_TEXT, VOL_DOWN_KEY_LONGTEXT, VLC_FALSE );
740 /* Usage (mainly useful for cmd line stuff) */
741 add_usage_hint( PLAYLIST_USAGE );
743 set_description( N_("main program") );
744 set_capability( "main", 100 );
747 static module_config_t p_help_config[] =
749 { CONFIG_ITEM_BOOL, NULL, "help", 'h',
750 N_("print help (can be combined with --advanced)") },
751 { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H',
752 N_("print detailed help (can be combined with --advanced)") },
753 { CONFIG_ITEM_BOOL, NULL, "list", 'l',
754 N_("print a list of available modules") },
755 { CONFIG_ITEM_STRING, NULL, "module", 'p',
756 N_("print help on module (can be combined with --advanced)") },
757 { CONFIG_ITEM_BOOL, NULL, "save-config", '\0',
758 N_("save the current command line options in the config") },
759 { CONFIG_ITEM_BOOL, NULL, "reset-config", '\0',
760 N_("reset the current config to the default values") },
761 { CONFIG_ITEM_STRING, NULL, "config", '\0',
762 N_("use alternate config file") },
763 { CONFIG_ITEM_BOOL, NULL, "version", '\0',
764 N_("print version information") },
765 { CONFIG_HINT_END, NULL, NULL, '\0', NULL }
768 /*****************************************************************************
770 *****************************************************************************/
772 /*****************************************************************************
773 * Initializer for the vlc_t structure storing the action / key associations
774 *****************************************************************************/
775 static struct hotkey p_hotkeys[] =
777 { "key-quit", ACTIONID_QUIT, 0 },
778 { "key-play-pause", ACTIONID_PLAY_PAUSE, 0 },
779 { "key-play", ACTIONID_PLAY, 0 },
780 { "key-pause", ACTIONID_PAUSE, 0 },
781 { "key-stop", ACTIONID_STOP, 0 },
782 { "key-prev", ACTIONID_PREV, 0 },
783 { "key-next", ACTIONID_NEXT, 0 },
784 { "key-faster", ACTIONID_FASTER, 0 },
785 { "key-slower", ACTIONID_SLOWER, 0 },
786 { "key-fullscreen", ACTIONID_FULLSCREEN, 0 },
787 { "key-vol-up", ACTIONID_VOL_UP, 0 },
788 { "key-vol-down", ACTIONID_VOL_DOWN, 0 },
789 { "key-nav-activate", ACTIONID_NAV_ACTIVATE, 0 },
790 { "key-nav-up", ACTIONID_NAV_UP, 0 },
791 { "key-nav-down", ACTIONID_NAV_DOWN, 0 },
792 { "key-nav-left", ACTIONID_NAV_LEFT, 0 },
793 { "key-nav-right", ACTIONID_NAV_RIGHT, 0 },