1 /*****************************************************************************
2 * libvlc.h: main libvlc header
3 *****************************************************************************
4 * Copyright (C) 1998-2002 VideoLAN
5 * $Id: libvlc.h,v 1.102 2003/11/07 19:30:28 massiot 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[] =
30 { "auto", "en", "en_GB", "es", "de", "fr", "it", "ja",
31 "nl", "no", "pl", "pt_BR", "ru", "sv" };
32 static char *ppsz_language_text[] =
33 { N_("Auto"), N_("English US"), N_("English GB"), N_("Spanish"), N_("German"),
34 N_("French"), N_("Italian"), N_("Japanese"), N_("Dutch"), N_("Norwegian"),
35 N_("Polish"), N_("Portugese BR"), N_("Russian"), N_("Swedish") };
37 /*****************************************************************************
38 * Configuration options for the main program. Each module will also separatly
39 * define its own configuration options.
40 * Look into configuration.h if you need to know more about the following
42 *****************************************************************************/
44 #define INTF_CAT_LONGTEXT N_( \
45 "These options allow you to configure the interfaces used by VLC.\n" \
46 "You can select the main interface, additional " \
47 "interface modules, and define various related options." )
49 #define INTF_TEXT N_("Interface module")
50 #define INTF_LONGTEXT N_( \
51 "This option allows you to select the interface used by VLC.\n" \
52 "The default behavior is to automatically select the best module " \
55 #define EXTRAINTF_TEXT N_("Extra interface modules")
56 #define EXTRAINTF_LONGTEXT N_( \
57 "This option allows you to select additional interfaces used by VLC. " \
58 "They will be launched in the background in addition to the default " \
59 "interface. Use a comma separated list of interface modules. (common " \
60 "values are: logger,gestures,sap,rc,http,screensaver)")
62 #define VERBOSE_TEXT N_("Verbosity (0,1,2)")
63 #define VERBOSE_LONGTEXT N_( \
64 "This options sets the verbosity level (0=only errors and " \
65 "standard messages, 1=warnings, 2=debug).")
67 #define QUIET_TEXT N_("Be quiet")
68 #define QUIET_LONGTEXT N_( \
69 "This options turns off all warning and information messages.")
71 #define LANGUAGE_TEXT N_("Language")
72 #define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
73 "of the interface. The system language is auto-detected if \"auto\" is " \
76 #define COLOR_TEXT N_("Color messages")
77 #define COLOR_LONGTEXT N_( \
78 "When this option is turned on, the messages sent to the console will " \
79 "be colorized. Your terminal needs Linux color support for this to work.")
81 #define ADVANCED_TEXT N_("Show advanced options")
82 #define ADVANCED_LONGTEXT N_( \
83 "When this option is turned on, the preferences and/or interfaces will " \
84 "show all the available options, including those that most users should " \
87 #define INTF_PATH_TEXT N_("Interface default search path")
88 #define INTF_PATH_LONGTEXT N_( \
89 "This option allows you to set the default path that the interface will " \
90 "open when looking for a file.")
92 #define PLUGIN_PATH_TEXT N_("Plugin search path")
93 #define PLUGIN_PATH_LONGTEXT N_( \
94 "This option allows you to specify an additional path for VLC to look " \
97 #define AOUT_CAT_LONGTEXT N_( \
98 "These options allow you to tune VLC's audio subsystem, " \
99 "and to add audio filters which can be used for " \
100 "postprocessing or visual effects (spectrum analyser,...).\n" \
101 "To tune these filters, have a look at the \"audio filter\" " \
104 #define AOUT_TEXT N_("Audio output module")
105 #define AOUT_LONGTEXT N_( \
106 "This option allows you to select the audio output method used by VLC. " \
107 "The default behavior is to automatically select the best method " \
110 #define AUDIO_TEXT N_("Enable audio")
111 #define AUDIO_LONGTEXT N_( \
112 "You can completely disable the audio output. In this case the audio " \
113 "decoding will not take place, and it will save some processing power.")
115 #define MONO_TEXT N_("Force mono audio")
116 #define MONO_LONGTEXT N_("This will force a mono audio output")
118 #define VOLUME_TEXT N_("Audio output volume")
119 #define VOLUME_LONGTEXT N_( \
120 "You can set the default audio output volume here, in a range from 0 to " \
123 #define VOLUME_SAVE_TEXT N_("Audio output saved volume")
124 #define VOLUME_SAVE_LONGTEXT N_( \
125 "This saves the audio output volume when you select mute.")
127 #define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
128 #define AOUT_RATE_LONGTEXT N_( \
129 "You can force the audio output frequency here. Common values are " \
130 "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
132 #if !defined( SYS_DARWIN )
133 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
134 #define AOUT_RESAMP_LONGTEXT N_( \
135 "High quality audio resampling can be processor intensive so you can " \
136 "disable it and a cheaper resampling algorithm will be used instead.")
139 #define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
140 #define DESYNC_LONGTEXT N_( \
141 "This option allows you to delay the audio output. This can be handy if " \
142 "you notice a lag between the video and the audio.")
144 #define MULTICHA_TEXT N_("Choose prefered audio output channels mode")
145 #define MULTICHA_LONGTEXT N_( \
146 "This option allows you to set the audio output channels mode that will " \
147 "be used by default when possible (ie. if your hardware supports it as " \
148 "well as the audio stream being played)")
150 #define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
151 #define SPDIF_LONGTEXT N_( \
152 "This option allows you to use the S/PDIF audio output by default when " \
153 "your hardware supports it as well as the audio stream being played.")
155 #define AUDIO_FILTER_TEXT N_("Audio filters")
156 #define AUDIO_FILTER_LONGTEXT N_( \
157 "This allows you to add audio postprocessing filters, to modify " \
160 #define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
161 #define HEADPHONE_LONGTEXT N_( \
162 "This effect gives you the feeling that you are standing in a room " \
163 "with a complete 5.1 speaker set when using only a headphone, " \
164 "providing a more realistic sound experience. It should also be " \
165 "more comfortable and less tiring when listening to music for " \
166 "long periods of time.\nIt works with any source format from mono " \
169 #define VOUT_CAT_LONGTEXT N_( \
170 "These options allow you to modify options related to " \
171 "the video output subsystem. You can for example enable " \
172 "video filters, like deinterlacing, constrast / hue / " \
173 "saturation adjusting, ...\n" \
174 "Enable these filters here and configure them in the video " \
175 "filters plugins section." )
177 #define VOUT_TEXT N_("Video output module")
178 #define VOUT_LONGTEXT N_( \
179 "This option allows you to select the video output method used by VLC. " \
180 "The default behavior is to automatically select the best " \
183 #define VIDEO_TEXT N_("Enable video")
184 #define VIDEO_LONGTEXT N_( \
185 "You can completely disable the video output. In this case the video " \
186 "decoding stage will not take place, which will save some processing power.")
188 #define WIDTH_TEXT N_("Video width")
189 #define WIDTH_LONGTEXT N_( \
190 "You can enforce the video width here. By default (-1) VLC will " \
191 "adapt to the video characteristics.")
193 #define HEIGHT_TEXT N_("Video height")
194 #define HEIGHT_LONGTEXT N_( \
195 "You can enforce the video height here. By default (-1) VLC will " \
196 "adapt to the video characteristics.")
198 #define ALIGN_TEXT N_("Video alignment")
199 #define ALIGN_LONGTEXT N_( \
200 "You can enforce the video alignement in its window. By default (0) it " \
201 "will be centered (0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
202 "also use combinations of these values).")
204 #define ZOOM_TEXT N_("Zoom video")
205 #define ZOOM_LONGTEXT N_( \
206 "You can zoom the video by the specified factor.")
208 #define GRAYSCALE_TEXT N_("Grayscale video output")
209 #define GRAYSCALE_LONGTEXT N_( \
210 "When enabled, the color information from the video won't be decoded " \
211 "(this can also allow you to save some processing power).")
213 #define FULLSCREEN_TEXT N_("Fullscreen video output")
214 #define FULLSCREEN_LONGTEXT N_( \
215 "If this option is enabled, VLC will always start a video in fullscreen " \
218 #define OVERLAY_TEXT N_("Overlay video output")
219 #define OVERLAY_LONGTEXT N_( \
220 "If enabled, VLC will try to take advantage of the overlay capabilities " \
221 "of your graphics card.")
223 #define SPUMARGIN_TEXT N_("Force SPU position")
224 #define SPUMARGIN_LONGTEXT N_( \
225 "You can use this option to place the subtitles under the movie, " \
226 "instead of over the movie. Try several positions.")
228 #define OSD_TEXT N_("On Screen Display")
229 #define OSD_LONGTEXT N_( \
230 "You can disable the messages VLC creates in the video.")
232 #define FILTER_TEXT N_("Video filter module")
233 #define FILTER_LONGTEXT N_( \
234 "This will allow you to add a post-processing filter to enhance the " \
235 "picture quality, for instance deinterlacing, or to clone or distort " \
238 #define ASPECT_RATIO_TEXT N_("Source aspect ratio")
239 #define ASPECT_RATIO_LONGTEXT N_( \
240 "This will force the source aspect ratio. For instance, some DVDs claim " \
241 "to be 16:9 while they are actually 4:3. This can also be used as a " \
242 "hint for VLC when a movie does not have aspect ratio information. " \
243 "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
244 "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
248 #define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
249 #define PIXEL_RATIO_LONGTEXT N_( \
250 "This will force the destination pixel size. By default VLC assumes " \
251 "your pixels are square, unless your hardware has a way to tell it " \
252 "otherwise. This may be used when you output VLC's signal to another " \
253 "device such as a TV set. Accepted format is a float value (1, 1.25, " \
254 "1.3333, etc.) expressing pixel squareness.")
257 #define INPUT_CAT_LONGTEXT N_( " " )
259 #define SERVER_PORT_TEXT N_("Server port")
260 #define SERVER_PORT_LONGTEXT N_( \
261 "This is the port used for UDP streams. By default, we chose 1234.")
263 #define MTU_TEXT N_("MTU of the network interface")
264 #define MTU_LONGTEXT N_( \
265 "This is the typical size of UDP packets that we expect. On Ethernet " \
266 "it is usually 1500.")
268 #define IFACE_ADDR_TEXT N_("Network interface address")
269 #define IFACE_ADDR_LONGTEXT N_( \
270 "If you have several interfaces on your machine and use the " \
271 "multicast solution, you will probably have to indicate the IP address " \
272 "of your multicasting interface here.")
274 #define TTL_TEXT N_("Time to live")
275 #define TTL_LONGTEXT N_( \
276 "Indicate here the Time To Live of the multicast packets sent by " \
277 "the stream output.")
279 #define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
280 #define INPUT_PROGRAM_LONGTEXT N_( \
281 "Choose the program to select by giving its Service ID.")
283 #define INPUT_AUDIO_TEXT N_("Choose audio")
284 #define INPUT_AUDIO_LONGTEXT N_( \
285 "Give the default type of audio you want to use in a DVD. " \
288 #define INPUT_CHAN_TEXT N_("Choose channel")
289 #define INPUT_CHAN_LONGTEXT N_( \
290 "Give the stream number of the audio channel you want to use in a DVD " \
293 #define INPUT_SUBT_TEXT N_("Choose subtitles track")
294 #define INPUT_SUBT_LONGTEXT N_( \
295 "Give the stream number of the subtitle channel you want to use " \
298 #define SUB_AUTO_TEXT N_("Autodetect subtitle files")
299 #define SUB_AUTO_LONGTEXT \
300 "Automatically detect a subtitle file, if no subtitle filename is " \
303 #define SUB_FUZZY_TEXT N_("Subtitle autodection fuzziness")
304 #define SUB_FUZZY_LONGTEXT \
305 "This determines how fuzzy subtitle and movie filenaming matching " \
306 "will be. Options are:\n" \
307 "0 = no subtitles autodetected\n" \
308 "1 = any subtitle file\n" \
309 "2 = any subtitle file containing the movie name\n" \
310 "3 = subtitle file matching the movie name with additional chars\n" \
311 "4 = subtitle file matching the movie name exactly"
313 #define SUB_FILE_TEXT N_("Use subtitle file")
314 #define SUB_FILE_LONGTEXT \
315 "Load this subtitle file. To be used when autodetect cannot detect " \
318 #define DVD_DEV_TEXT N_("DVD device")
320 #define DVD_DEV_LONGTEXT N_( \
321 "This is the default DVD drive (or file) to use. Don't forget the colon " \
322 "after the drive letter (eg D:)")
324 #define DVD_DEV_LONGTEXT N_( \
325 "This is the default DVD device to use.")
328 #define VCD_DEV_TEXT N_("VCD device")
329 #define VCD_DEV_LONGTEXT N_( \
330 "This is the default VCD device to use.")
332 #define IPV6_TEXT N_("Force IPv6")
333 #define IPV6_LONGTEXT N_( \
334 "If you check this box, IPv6 will be used by default for all UDP and " \
337 #define IPV4_TEXT N_("Force IPv4")
338 #define IPV4_LONGTEXT N_( \
339 "If you check this box, IPv4 will be used by default for all UDP and " \
342 #define CODEC_CAT_LONGTEXT N_( \
343 "This option can be used to alter the way VLC selects " \
344 "its codecs (decompression methods). Only advanced users should " \
345 "alter this option as it can break playback of all your streams." )
347 #define CODEC_TEXT N_("Choose preferred codec list")
348 #define CODEC_LONGTEXT N_( \
349 "This allows you to select the order in which VLC will choose its " \
350 "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
351 "before the new one. Please be aware that VLC does not make any " \
352 "difference between audio or video codecs, so you should always specify " \
353 "'any' at the end of the list to make sure there is a fallback for the " \
354 "types you didn't specify.")
357 #define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
358 #define ENCODER_VIDEO_LONGTEXT N_( \
359 "This allows you to select the order in which VLC will choose its " \
361 #define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
362 #define ENCODER_AUDIO_LONGTEXT N_( \
363 "This allows you to select the order in which VLC will choose its " \
366 #define SOUT_CAT_LONGTEXT N_( \
367 "These options allow you to set default global options for the " \
368 "stream output subsystem." )
370 #define SOUT_TEXT N_("Choose a stream output")
371 #define SOUT_LONGTEXT N_( \
372 "Empty if no stream output.")
374 #define SOUT_DISPLAY_TEXT N_("Display while streaming")
375 #define SOUT_DISPLAY_LONGTEXT N_( \
376 "This allows you to play the stream while streaming it.")
378 #define SOUT_VIDEO_TEXT N_("Enable video stream output")
379 #define SOUT_VIDEO_LONGTEXT N_( \
380 "This allows you to choose if the video stream should be redirected to " \
381 "the stream output facility when this last one is enabled.")
383 #define SOUT_AUDIO_TEXT N_("Enable audio stream output")
384 #define SOUT_AUDIO_LONGTEXT N_( \
385 "This allows you to choose if the video stream should be redirected to " \
386 "the stream output facility when this last one is enabled.")
388 #define SOUT_KEEP_TEXT N_("Keep sout open" )
389 #define SOUT_KEEP_LONGTEXT N_( \
390 "This allows you to keep an unique sout instance across " \
391 "multiple playlist item (automatically insert gather stream_out " \
392 "if not specified)" )
394 #define PACKETIZER_TEXT N_("Choose preferred packetizer list")
395 #define PACKETIZER_LONGTEXT N_( \
396 "This allows you to select the order in which VLC will choose its " \
399 #define MUX_TEXT N_("Mux module")
400 #define MUX_LONGTEXT N_( \
401 "This is a legacy entry to let you configure mux modules")
403 #define ACCESS_OUTPUT_TEXT N_("Access output module")
404 #define ACCESS_OUTPUT_LONGTEXT N_( \
405 "This is a legacy entry to let you configure access output modules")
407 #define CPU_CAT_LONGTEXT N_( \
408 "These options allow you to enable special CPU optimizations.\n" \
409 "You should always leave all these enabled." )
411 #define MMX_TEXT N_("Enable CPU MMX support")
412 #define MMX_LONGTEXT N_( \
413 "If your processor supports the MMX instructions set, VLC can take " \
414 "advantage of them.")
416 #define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
417 #define THREE_DN_LONGTEXT N_( \
418 "If your processor supports the 3D Now! instructions set, VLC can take " \
419 "advantage of them.")
421 #define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
422 #define MMXEXT_LONGTEXT N_( \
423 "If your processor supports the MMX EXT instructions set, VLC can take " \
424 "advantage of them.")
426 #define SSE_TEXT N_("Enable CPU SSE support")
427 #define SSE_LONGTEXT N_( \
428 "If your processor supports the SSE instructions set, VLC can take " \
429 "advantage of them.")
431 #define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
432 #define ALTIVEC_LONGTEXT N_( \
433 "If your processor supports the AltiVec instructions set, VLC can take " \
434 "advantage of them.")
436 #define PLAYLIST_CAT_LONGTEXT N_( \
437 "These options define the behaviour of the playlist. Some " \
438 "of them can be overriden in the playlist dialog box." )
440 #define RANDOM_TEXT N_("Play files randomly forever")
441 #define RANDOM_LONGTEXT N_( \
442 "When selected, VLC will randomly play files in the playlist until " \
445 #define LOOP_TEXT N_("Loop playlist on end")
446 #define LOOP_LONGTEXT N_( \
447 "If you want VLC to keep playing the playlist indefinitely then enable " \
450 #define REPEAT_TEXT N_("Repeat the current playlistitem")
451 #define REPEAT_LONGTEXT N_( \
452 "When this is active VLC will keep playing the current playlistitem " \
453 "over and over again.")
455 #define MISC_CAT_LONGTEXT N_( \
456 "These options allow you to select default modules. Leave these " \
457 "alone unless you really know what you are doing." )
459 #define MEMCPY_TEXT N_("Memory copy module")
460 #define MEMCPY_LONGTEXT N_( \
461 "You can select which memory copy module you want to use. By default " \
462 "VLC will select the fastest one supported by your hardware.")
464 #define ACCESS_TEXT N_("Access module")
465 #define ACCESS_LONGTEXT N_( \
466 "This is a legacy entry to let you configure access modules")
468 #define DEMUX_TEXT N_("Demux module")
469 #define DEMUX_LONGTEXT N_( \
470 "This is a legacy entry to let you configure demux modules")
472 #define RT_PRIORITY_TEXT N_("Allow VLC to run with a real-time priority")
473 #define RT_PRIORITY_LONGTEXT N_( \
474 "Running VLC in real-time priority will allow for much more precise " \
475 "scheduling and yield better, especially when streaming content. " \
476 "It can however lock up your whole machine, or make it very very " \
477 "slow. You should only activate this if you know what you're " \
480 #define ONEINSTANCE_TEXT N_("Allow only one running instance of VLC")
481 #define ONEINSTANCE_LONGTEXT N_( \
482 "Allowing only one running instance of VLC can sometimes be useful, " \
483 "for instance if you associated VLC with some media types and you " \
484 "don't want a new instance of VLC to be opened each time you " \
485 "double-click on a file in the explorer. This option will allow you " \
486 "to play the file with the already running instance or enqueue it.")
488 #define HPRIORITY_TEXT N_("Increase the priority of the process")
489 #define HPRIORITY_LONGTEXT N_( \
490 "Increasing the priority of the process will very likely improve your " \
491 "playing experience as it allows VLC not to be disturbed by other " \
492 "applications that could otherwise take too much processor time.\n" \
493 "However be advise that in certain circumstances (bugs) VLC could take " \
494 "all the processor time and render the whole system unresponsive which " \
495 "might require a reboot of your machine.")
497 #define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
498 #define FAST_MUTEX_LONGTEXT N_( \
499 "On Windows NT/2K/XP we use a slow mutex implementation but which " \
500 "allows us to correctely implement condition variables. " \
501 "You can also use the faster Win9x implementation but you might " \
502 "experience problems with it.")
504 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
506 #define WIN9X_CV_LONGTEXT N_( \
507 "On Windows 9x/Me we use a fast but not correct condition variables " \
508 "implementation (more precisely there is a possibility for a race " \
509 "condition to happen). " \
510 "However it is possible to use slower alternatives which should be more " \
512 "Currently you can choose between implementation 0 (which is the " \
513 "default and the fastest), 1 and 2.")
515 #define HOTKEY_CAT_LONGTEXT N_( " " )
517 #define FULLSCREEN_KEY_TEXT N_("Fullscreen")
518 #define FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to swap fullscreen state")
519 #define PLAY_PAUSE_KEY_TEXT N_("Pause")
520 #define PLAY_PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to swap paused state")
521 #define PAUSE_KEY_TEXT N_("Pause only")
522 #define PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to pause")
523 #define PLAY_KEY_TEXT N_("Play only")
524 #define PLAY_KEY_LONGTEXT N_("Select the hotkey to use to play")
525 #define FASTER_KEY_TEXT N_("Faster")
526 #define FASTER_KEY_LONGTEXT N_("Select the hotkey to use for fast forward playback")
527 #define SLOWER_KEY_TEXT N_("Slower")
528 #define SLOWER_KEY_LONGTEXT N_("Select the hotkey to use for slow motion playback")
529 #define NEXT_KEY_TEXT N_("Next")
530 #define NEXT_KEY_LONGTEXT N_("Select the hotkey to use to skip to the next item in the playlist")
531 #define PREV_KEY_TEXT N_("Previous")
532 #define PREV_KEY_LONGTEXT N_("Select the hotkey to use to skip to the previous item in the playlist")
533 #define STOP_KEY_TEXT N_("Stop")
534 #define STOP_KEY_LONGTEXT N_("Select the hotkey to stop the playback")
536 #define JB10SEC_KEY_TEXT N_("Jump backward 10 seconds")
537 #define JB10SEC_KEY_LONGTEXT N_("Select the hotkey to jump backward by 10 seconds")
539 #define JB1MIN_KEY_TEXT N_("Jump backward 1 minute")
540 #define JB1MIN_KEY_LONGTEXT N_("Select the hotkey to jump backward by 1 minute")
541 #define JB5MIN_KEY_TEXT N_("Jump backward 5 minutes")
542 #define JB5MIN_KEY_LONGTEXT N_("Select the hotkey to jump backward by 5 minutes")
543 #define JF10SEC_KEY_TEXT N_("Jump forward 10 seconds")
544 #define JF10SEC_KEY_LONGTEXT N_("Select the hotkey to jump forward by 10 seconds")
546 #define JF1MIN_KEY_TEXT N_("Jump forward 1 minute")
547 #define JF1MIN_KEY_LONGTEXT N_("Select the hotkey to jump forward by 1 minute")
549 #define JF5MIN_KEY_TEXT N_("Jump forward 5 minutes")
550 #define JF5MIN_KEY_LONGTEXT N_("Select the hotkey to jump forward by 5 minutes")
552 #define QUIT_KEY_TEXT N_("Quit")
553 #define QUIT_KEY_LONGTEXT N_("Select the hotkey to quit the application")
554 #define NAV_UP_KEY_TEXT N_("Navigate up")
555 #define NAV_UP_KEY_LONGTEXT N_("Select the key to move the selector up in dvd menus")
556 #define NAV_DOWN_KEY_TEXT N_("Navigate down")
557 #define NAV_DOWN_KEY_LONGTEXT N_("Select the key to move the selector down in dvd menus")
558 #define NAV_LEFT_KEY_TEXT N_("Navigate left")
559 #define NAV_LEFT_KEY_LONGTEXT N_("Select the key to move the selector left in dvd menus")
560 #define NAV_RIGHT_KEY_TEXT N_("Navigate right")
561 #define NAV_RIGHT_KEY_LONGTEXT N_("Select the key to move the selector right in dvd menus")
562 #define NAV_ACTIVATE_KEY_TEXT N_("Activate")
563 #define NAV_ACTIVATE_KEY_LONGTEXT N_("Select the key to activate selected item in dvd menus")
564 #define VOL_UP_KEY_TEXT N_("Volume up")
565 #define VOL_UP_KEY_LONGTEXT N_("Select the key to turn up audio volume")
566 #define VOL_DOWN_KEY_TEXT N_("Volume down")
567 #define VOL_DOWN_KEY_LONGTEXT N_("Select the key to turn down audio volume")
569 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
570 "\n *.mpg, *.vob plain MPEG-1/2 files" \
571 "\n [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
573 "\n [vcd:][device][@[title][,[chapter]]" \
575 "\n udpstream:[@[<bind address>][:<bind port>]]" \
576 "\n UDP stream sent by a streaming server" \
577 "\n vlc:pause pause execution of " \
579 "\n vlc:quit quit VLC" \
584 * Quick usage guide for the configuration options:
586 * add_category_hint( N_(text), N_(longtext) );
587 * add_subcategory_hint( N_(text), N_(longtext) );
588 * add_usage_hint( N_(text) );
589 * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
590 * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
591 * add_module( option_name, psz_value, i_capability, p_callback,
592 * N_(text), N_(longtext) );
593 * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
594 * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
598 /* Interface options */
599 add_category_hint( N_("Interface"), INTF_CAT_LONGTEXT , VLC_FALSE );
600 add_module( "intf", "interface", NULL, NULL, INTF_TEXT,
601 INTF_LONGTEXT, VLC_TRUE );
603 add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT,
604 EXTRAINTF_LONGTEXT, VLC_FALSE );
605 add_integer( "verbose", 0, NULL, VERBOSE_TEXT, VERBOSE_LONGTEXT,
608 add_bool( "quiet", 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
610 add_string( "language", "auto", NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT,
612 change_string_list( ppsz_language, ppsz_language_text, 0 );
613 add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
614 add_bool( "advanced", 0, NULL, ADVANCED_TEXT,
615 ADVANCED_LONGTEXT, VLC_FALSE );
616 add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT,
617 INTF_PATH_LONGTEXT, VLC_TRUE );
618 add_directory( "plugin-path", NULL, NULL,
619 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
622 add_category_hint( N_("Audio"), AOUT_CAT_LONGTEXT , VLC_FALSE );
623 add_module( "aout", "audio output", NULL, NULL, AOUT_TEXT, AOUT_LONGTEXT,
626 add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_FALSE );
627 add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
628 AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
629 VOLUME_LONGTEXT, VLC_FALSE );
630 add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
631 AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
632 VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
633 add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
634 #if !defined( SYS_DARWIN )
635 add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
637 add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
639 add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT,
640 HEADPHONE_LONGTEXT, VLC_FALSE );
642 add_integer( "audio-desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
643 add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
644 AUDIO_FILTER_LONGTEXT,VLC_FALSE);
647 add_category_hint( N_("Video"), VOUT_CAT_LONGTEXT , VLC_FALSE );
648 add_module( "vout", "video output", NULL, NULL, VOUT_TEXT, VOUT_LONGTEXT,
651 add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
652 add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
653 add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
654 add_integer( "align", -1, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
655 add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
656 add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
657 add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT,
658 FULLSCREEN_LONGTEXT, VLC_FALSE );
660 add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
662 add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT,
663 SPUMARGIN_LONGTEXT, VLC_TRUE );
664 add_bool( "osd", 1, NULL, OSD_TEXT, OSD_LONGTEXT, VLC_FALSE );
665 add_module( "filter", "video filter", NULL, NULL,
666 FILTER_TEXT, FILTER_LONGTEXT, VLC_FALSE );
667 add_string( "aspect-ratio", "", NULL,
668 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
670 add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
674 add_category_hint( N_("Input"), INPUT_CAT_LONGTEXT , VLC_FALSE );
675 add_integer( "server-port", 1234, NULL,
676 SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
677 add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
678 add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
680 add_integer( "program", 0, NULL,
681 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
682 add_integer( "audio-type", -1, NULL,
683 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
684 add_integer( "audio-channel", -1, NULL,
685 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
686 add_integer( "spu-channel", -1, NULL,
687 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
688 add_bool( "sub-autodetect-file", VLC_TRUE, NULL,
689 SUB_AUTO_TEXT, SUB_AUTO_LONGTEXT, VLC_FALSE );
690 add_integer( "sub-autodetect-fuzzy", 3, NULL,
691 SUB_FUZZY_TEXT, SUB_FUZZY_LONGTEXT, VLC_TRUE );
692 add_file( "sub-file", NULL, NULL,
693 SUB_FILE_TEXT, SUB_FILE_LONGTEXT, VLC_TRUE );
696 add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
697 add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
699 add_bool( "ipv6", 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
701 add_bool( "ipv4", 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
704 /* Decoder options */
705 add_category_hint( N_("Decoders"), CODEC_CAT_LONGTEXT , VLC_TRUE );
706 add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
709 /* Stream output options */
710 add_category_hint( N_("Stream output"), SOUT_CAT_LONGTEXT , VLC_TRUE );
711 add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
712 add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT,
713 SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
714 add_bool( "sout-keep", VLC_FALSE, NULL, SOUT_KEEP_TEXT,
715 SOUT_KEEP_LONGTEXT, VLC_TRUE );
717 add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT,
718 SOUT_AUDIO_LONGTEXT, VLC_TRUE );
719 add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT,
720 SOUT_VIDEO_LONGTEXT, VLC_TRUE );
722 add_module( "packetizer", "packetizer", NULL, NULL,
723 PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
724 add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT,
725 MUX_LONGTEXT, VLC_TRUE );
726 add_module( "access_output", "sout access", NULL, NULL,
727 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
728 add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
732 add_category_hint( N_("CPU"), CPU_CAT_LONGTEXT, VLC_TRUE );
733 #if defined( __i386__ )
734 add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
735 add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
736 add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
737 add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
739 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
740 add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
743 /* Playlist options */
744 add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
745 add_bool( "random", 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
747 add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
749 add_bool( "repeat", 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
753 add_category_hint( N_("Miscellaneous"), MISC_CAT_LONGTEXT, VLC_TRUE );
754 add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
755 add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
756 add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
758 #if !defined(SYS_DARWIN) && defined(PTHREAD_COND_T_IN_PTHREAD_H)
759 add_bool( "rt-priority", 0, NULL, RT_PRIORITY_TEXT, RT_PRIORITY_LONGTEXT, VLC_TRUE );
763 add_bool( "one-instance", 0, NULL, ONEINSTANCE_TEXT, ONEINSTANCE_LONGTEXT, VLC_TRUE );
764 add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
765 add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
766 add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
770 add_category_hint( N_("Hot keys"), HOTKEY_CAT_LONGTEXT , VLC_FALSE );
771 add_key( "key-fullscreen", 'f', NULL, FULLSCREEN_KEY_TEXT, FULLSCREEN_KEY_LONGTEXT, VLC_FALSE );
772 add_key( "key-play-pause", KEY_SPACE, NULL, PLAY_PAUSE_KEY_TEXT, PLAY_PAUSE_KEY_LONGTEXT, VLC_FALSE );
773 add_key( "key-pause", 0, NULL, PAUSE_KEY_TEXT, PAUSE_KEY_LONGTEXT, VLC_TRUE );
774 add_key( "key-play", 0, NULL, PLAY_KEY_TEXT, PLAY_KEY_LONGTEXT, VLC_TRUE );
775 add_key( "key-faster", '+', NULL, FASTER_KEY_TEXT, FASTER_KEY_LONGTEXT, VLC_FALSE );
776 add_key( "key-slower", '-', NULL, SLOWER_KEY_TEXT, SLOWER_KEY_LONGTEXT, VLC_FALSE );
777 add_key( "key-next", 'n', NULL, NEXT_KEY_TEXT, NEXT_KEY_LONGTEXT, VLC_FALSE );
778 add_key( "key-prev", 'p', NULL, PREV_KEY_TEXT, PREV_KEY_LONGTEXT, VLC_FALSE );
779 add_key( "key-stop", 's', NULL, STOP_KEY_TEXT, STOP_KEY_LONGTEXT, VLC_FALSE );
780 add_key( "key-jump-10sec", KEY_MODIFIER_ALT|KEY_LEFT, NULL, JB10SEC_KEY_TEXT, JB10SEC_KEY_LONGTEXT, VLC_FALSE );
781 add_key( "key-jump+10sec", KEY_MODIFIER_ALT|KEY_RIGHT, NULL, JF10SEC_KEY_TEXT, JF10SEC_KEY_LONGTEXT, VLC_FALSE );
782 add_key( "key-jump-1min", KEY_MODIFIER_CTRL|KEY_LEFT, NULL, JB1MIN_KEY_TEXT, JB1MIN_KEY_LONGTEXT, VLC_FALSE );
783 add_key( "key-jump+1min", KEY_MODIFIER_CTRL|KEY_RIGHT, NULL, JF1MIN_KEY_TEXT, JF1MIN_KEY_LONGTEXT, VLC_FALSE );
784 add_key( "key-jump-5min", KEY_MODIFIER_CTRL|KEY_MODIFIER_ALT|KEY_LEFT, NULL, JB5MIN_KEY_TEXT, JB5MIN_KEY_LONGTEXT, VLC_FALSE );
785 add_key( "key-jump+5min", KEY_MODIFIER_CTRL|KEY_MODIFIER_ALT|KEY_RIGHT, NULL, JF5MIN_KEY_TEXT, JF5MIN_KEY_LONGTEXT, VLC_FALSE );
786 add_key( "key-nav-activate", KEY_ENTER, NULL, NAV_ACTIVATE_KEY_TEXT, NAV_ACTIVATE_KEY_LONGTEXT, VLC_FALSE );
787 add_key( "key-nav-up", KEY_UP, NULL, NAV_UP_KEY_TEXT, NAV_UP_KEY_LONGTEXT, VLC_FALSE );
788 add_key( "key-nav-down", KEY_DOWN, NULL, NAV_DOWN_KEY_TEXT, NAV_DOWN_KEY_LONGTEXT, VLC_FALSE );
789 add_key( "key-nav-left", KEY_LEFT, NULL, NAV_LEFT_KEY_TEXT, NAV_LEFT_KEY_LONGTEXT, VLC_FALSE );
790 add_key( "key-nav-right", KEY_RIGHT, NULL, NAV_RIGHT_KEY_TEXT, NAV_RIGHT_KEY_LONGTEXT, VLC_FALSE );
791 add_key( "key-quit", KEY_MODIFIER_CTRL|KEY_SPACE, NULL, QUIT_KEY_TEXT, QUIT_KEY_LONGTEXT, VLC_FALSE );
792 add_key( "key-vol-up", 'a', NULL, VOL_UP_KEY_TEXT, VOL_UP_KEY_LONGTEXT, VLC_FALSE );
793 add_key( "key-vol-down", 'z', NULL, VOL_DOWN_KEY_TEXT, VOL_DOWN_KEY_LONGTEXT, VLC_FALSE );
795 /* Usage (mainly useful for cmd line stuff) */
796 add_usage_hint( PLAYLIST_USAGE );
798 set_description( N_("main program") );
799 set_capability( "main", 100 );
802 static module_config_t p_help_config[] =
804 { CONFIG_ITEM_BOOL, NULL, "help", 'h',
805 N_("print help (can be combined with --advanced)") },
806 { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H',
807 N_("print detailed help (can be combined with --advanced)") },
808 { CONFIG_ITEM_BOOL, NULL, "list", 'l',
809 N_("print a list of available modules") },
810 { CONFIG_ITEM_STRING, NULL, "module", 'p',
811 N_("print help on module (can be combined with --advanced)") },
812 { CONFIG_ITEM_BOOL, NULL, "save-config", '\0',
813 N_("save the current command line options in the config") },
814 { CONFIG_ITEM_BOOL, NULL, "reset-config", '\0',
815 N_("reset the current config to the default values") },
816 { CONFIG_ITEM_STRING, NULL, "config", '\0',
817 N_("use alternate config file") },
818 { CONFIG_ITEM_BOOL, NULL, "version", '\0',
819 N_("print version information") },
820 { CONFIG_HINT_END, NULL, NULL, '\0', NULL }
823 /*****************************************************************************
825 *****************************************************************************/
827 /*****************************************************************************
828 * Initializer for the vlc_t structure storing the action / key associations
829 *****************************************************************************/
830 static struct hotkey p_hotkeys[] =
832 { "key-quit", ACTIONID_QUIT, 0 },
833 { "key-play-pause", ACTIONID_PLAY_PAUSE, 0 },
834 { "key-play", ACTIONID_PLAY, 0 },
835 { "key-pause", ACTIONID_PAUSE, 0 },
836 { "key-stop", ACTIONID_STOP, 0 },
837 { "key-jump-10sec", ACTIONID_JUMP_BACKWARD_10SEC, 0 },
838 { "key-jump+10sec", ACTIONID_JUMP_FORWARD_10SEC, 0 },
839 { "key-jump-1min", ACTIONID_JUMP_BACKWARD_1MIN, 0 },
840 { "key-jump+1min", ACTIONID_JUMP_FORWARD_1MIN, 0 },
841 { "key-jump-5min", ACTIONID_JUMP_BACKWARD_5MIN, 0 },
842 { "key-jump+5min", ACTIONID_JUMP_FORWARD_5MIN, 0 },
843 { "key-prev", ACTIONID_PREV, 0 },
844 { "key-next", ACTIONID_NEXT, 0 },
845 { "key-faster", ACTIONID_FASTER, 0 },
846 { "key-slower", ACTIONID_SLOWER, 0 },
847 { "key-fullscreen", ACTIONID_FULLSCREEN, 0 },
848 { "key-vol-up", ACTIONID_VOL_UP, 0 },
849 { "key-vol-down", ACTIONID_VOL_DOWN, 0 },
850 { "key-nav-activate", ACTIONID_NAV_ACTIVATE, 0 },
851 { "key-nav-up", ACTIONID_NAV_UP, 0 },
852 { "key-nav-down", ACTIONID_NAV_DOWN, 0 },
853 { "key-nav-left", ACTIONID_NAV_LEFT, 0 },
854 { "key-nav-right", ACTIONID_NAV_RIGHT, 0 },