libvlc.h 34.3 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * libvlc.h: main libvlc header
 *****************************************************************************
 * Copyright (C) 1998-2002 VideoLAN
5
 * $Id: libvlc.h,v 1.93 2003/10/03 23:31:43 sigmunau Exp $
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
 *          Gildas Bazin <gbazin@netcourrier.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

26
#define Nothing here, this is just to prevent update-po from being stupid
27
#include "vlc_keys.h"
28

29
static char *ppsz_language[] = { "auto", "en", "en_GB", "de", "fr", "it", "ja",
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
30
                                "nl", "no", "pl", "pt_BR", "ru", "sv", NULL };
31

32 33 34 35 36 37
/*****************************************************************************
 * Configuration options for the main program. Each module will also separatly
 * define its own configuration options.
 * Look into configuration.h if you need to know more about the following
 * macros.
 *****************************************************************************/
38 39

#define INTF_CAT_LONGTEXT N_( \
40 41 42
    "These options allow you to configure the interfaces used by VLC.\n" \
    "You can select the main interface, additional\n" \
    "interface modules, and define various related options." )
43

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 48 49
    "The default behavior is to automatically select the best module " \
    "available.")

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. " \
Sam Hocevar's avatar
Sam Hocevar committed
53
    "They will be launched in the background in addition to the default " \
54 55
    "interface. Use a comma separated list of interface modules. (common " \
    "values are: logger,gestures,sap,rc,http,screensaver)")
56

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).")
61

62
#define QUIET_TEXT N_("Be quiet")
63 64 65
#define QUIET_LONGTEXT N_( \
    "This options turns off all warning and information messages.")

66 67 68 69
#define LANGUAGE_TEXT N_("Language")
#define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
    "of the interface. The system language is auto-detected if \"auto\" is " \
    "specified here." )
Gildas Bazin's avatar
 
Gildas Bazin committed
70

71
#define COLOR_TEXT N_("Color messages")
72 73 74 75
#define COLOR_LONGTEXT N_( \
    "When this option is turned on, the messages sent to the console will " \
    "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 79 80
    "When this option is turned on, the preferences and/or interfaces  will " \
    "show all the available options, including those that most users should " \
    "never touch")
81

82
#define INTF_PATH_TEXT N_("Interface default search path")
83 84 85 86
#define INTF_PATH_LONGTEXT N_( \
    "This option allows you to set the default path that the interface will " \
    "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 " \
90 91
    "for its plugins.")

92 93 94 95 96 97 98
#define AOUT_CAT_LONGTEXT N_( \
    "These options allow you to tune VLC's audio subsystem, \n" \
    "and to add audio filters which can be used for \n" \
    "postprocessing or visual effects (spectrum analyser,...) \n" \
    "To tune these filters, have a look at the \"audio filter\"\n" \
    "plugin options.")

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 103
    "The default behavior is to automatically select the best method " \
    "available.")
104

105
#define AUDIO_TEXT N_("Enable audio")
106 107
#define AUDIO_LONGTEXT N_( \
    "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.")
109

110
#define MONO_TEXT N_("Force mono audio")
111 112
#define MONO_LONGTEXT N_("This will force a mono audio output")

113
#define VOLUME_TEXT N_("Audio output volume")
114 115 116 117
#define VOLUME_LONGTEXT N_( \
    "You can set the default audio output volume here, in a range from 0 to " \
    "1024.")

118
#define VOLUME_SAVE_TEXT N_("Audio output saved volume")
119 120 121
#define VOLUME_SAVE_LONGTEXT N_( \
    "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 " \
Gildas Bazin's avatar
 
Gildas Bazin committed
125
    "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
126

Gildas Bazin's avatar
 
Gildas Bazin committed
127 128 129 130 131 132 133
#if !defined( SYS_DARWIN )
#define AOUT_RESAMP_TEXT N_("High quality audio resampling")
#define AOUT_RESAMP_LONGTEXT N_( \
    "High quality audio resampling can be processor intensive so you can " \
    "disable it and a cheaper resampling algorithm will be used instead.")
#endif

134
#define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
135 136 137 138
#define DESYNC_LONGTEXT N_( \
    "This option allows you to delay the audio output. This can be handy if " \
    "you notice a lag between the video and the audio.")

Gildas Bazin's avatar
 
Gildas Bazin committed
139 140 141 142 143 144
#define MULTICHA_TEXT N_("Choose prefered audio output channels mode")
#define MULTICHA_LONGTEXT N_( \
    "This option allows you to set the audio output channels mode that will " \
    "be used by default when possible (ie. if your hardware supports it as " \
    "well as the audio stream being played)")

145
#define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
Gildas Bazin's avatar
 
Gildas Bazin committed
146 147 148 149
#define SPDIF_LONGTEXT N_( \
    "This option allows you to use the S/PDIF audio output by default when " \
    "your hardware supports it as well as the audio stream being played.")

Clément Stenac's avatar
Clément Stenac committed
150 151 152 153 154
#define AUDIO_FILTER_TEXT N_("Audio filters")
#define AUDIO_FILTER_LONGTEXT N_( \
    "This allows you to add audio postprocessing filters, to modify" \
    "the sound.")

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 159 160 161 162 163
    "with a complete 5.1 speaker set when using only a headphone, " \
    "providing a more realistic sound experience. It should also be " \
    "more comfortable and less tiring when listening to music for " \
    "long periods of time.\nIt works with any source format from mono " \
    "to 5.1.")

164 165 166 167 168 169 170
#define VOUT_CAT_LONGTEXT N_( \
    "These options allow you to modify options related to \n" \
    "the video output subsystem. You can for example enable \n" \
    "video filters, like deinterlacing, constrast / hue / \n " \
    "saturation adjusting, ... \n" \
    "Enable these filters here and configure them in the video \n" \
    "filters plugins section." )
Clément Stenac's avatar
Clément Stenac committed
171

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 176 177
    "The default behavior is to automatically select the best " \
    "method available.")

178
#define VIDEO_TEXT N_("Enable video")
179 180
#define VIDEO_LONGTEXT N_( \
    "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.")
182

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 187
    "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 192
    "adapt to the video characteristics.")

Gildas Bazin's avatar
 
Gildas Bazin committed
193 194 195 196 197 198
#define ALIGN_TEXT N_("Video alignment")
#define ALIGN_LONGTEXT N_( \
    "You can enforce the video alignement in its window. By default (0) it " \
    "will be centered (0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
    "also use combinations of these values).")

199
#define ZOOM_TEXT N_("Zoom video")
200 201 202
#define ZOOM_LONGTEXT N_( \
    "You can zoom the video by the specified factor.")

203
#define GRAYSCALE_TEXT N_("Grayscale video output")
204 205 206 207
#define GRAYSCALE_LONGTEXT N_( \
    "When enabled, the color information from the video won't be decoded " \
    "(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 " \
211 212
    "mode.")

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.")
217

218
#define SPUMARGIN_TEXT N_("Force SPU position")
219 220 221 222
#define SPUMARGIN_LONGTEXT N_( \
    "You can use this option to place the subtitles under the movie, " \
    "instead of over the movie. Try several positions.")

223
#define FILTER_TEXT N_("Video filter module")
224 225 226 227 228
#define FILTER_LONGTEXT N_( \
    "This will allow you to add a post-processing filter to enhance the " \
    "picture quality, for instance deinterlacing, or to clone or distort " \
    "the video window.")

229
#define ASPECT_RATIO_TEXT N_("Source aspect ratio")
230 231 232 233 234 235 236 237 238
#define ASPECT_RATIO_LONGTEXT N_( \
    "This will force the source aspect ratio. For instance, some DVDs claim " \
    "to be 16:9 while they are actually 4:3. This can also be used as a " \
    "hint for VLC when a movie does not have aspect ratio information. " \
    "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
    "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
    "squareness.")

#if 0
239
#define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
240 241 242 243 244 245 246 247
#define PIXEL_RATIO_LONGTEXT N_( \
    "This will force the destination pixel size. By default VLC assumes " \
    "your pixels are square, unless your hardware has a way to tell it " \
    "otherwise. This may be used when you output VLC's signal to another " \
    "device such as a TV set. Accepted format is a float value (1, 1.25, " \
    "1.3333, etc.) expressing pixel squareness.")
#endif

248 249
#define INPUT_CAT_LONGTEXT N_( " " )

250
#define SERVER_PORT_TEXT N_("Server port")
251 252 253
#define SERVER_PORT_LONGTEXT N_( \
    "This is the port used for UDP streams. By default, we chose 1234.")

Sam Hocevar's avatar
Sam Hocevar committed
254
#define MTU_TEXT N_("MTU of the network interface")
Christophe Massiot's avatar
Christophe Massiot committed
255 256 257 258
#define MTU_LONGTEXT N_( \
    "This is the typical size of UDP packets that we expect. On Ethernet " \
    "it is usually 1500.")

259
#define IFACE_ADDR_TEXT N_("Network interface address")
260 261 262
#define IFACE_ADDR_LONGTEXT N_( \
    "If you have several interfaces on your machine and use the " \
    "multicast solution, you will probably have to indicate the IP address " \
263
    "of your multicasting interface here.")
264

265
#define TTL_TEXT N_("Time to live")
266 267 268 269
#define TTL_LONGTEXT N_( \
    "Indicate here the Time To Live of the multicast packets sent by " \
    "the stream output.")

270
#define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
271 272 273
#define INPUT_PROGRAM_LONGTEXT N_( \
    "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 277
    "Give the default type of audio you want to use in a DVD. " \
    "(Developers only)")
278

279
#define INPUT_CHAN_TEXT N_("Choose channel")
280 281 282 283
#define INPUT_CHAN_LONGTEXT N_( \
    "Give the stream number of the audio channel you want to use in a DVD " \
    "(from 1 to n).")

284
#define INPUT_SUBT_TEXT N_("Choose subtitles track")
285
#define INPUT_SUBT_LONGTEXT N_( \
286 287 288 289 290
    "Give the stream number of the subtitle channel you want to use " \
    "(from 1 to n).")

#define SUB_AUTO_TEXT N_("Autodetect subtitle files")
#define SUB_AUTO_LONGTEXT \
291 292
    "Automatically detect a subtitle file, if no subtitle filename is " \
    "specified."
293 294 295 296 297

#define SUB_FILE_TEXT N_("Use subtitle file")
#define SUB_FILE_LONGTEXT \
    "Load this subtitle file. To be used when autodetect cannot detect " \
    "your subtitlefile."
298 299

#define DVD_DEV_TEXT N_("DVD device")
Gildas Bazin's avatar
 
Gildas Bazin committed
300 301 302 303 304
#ifdef WIN32
#define DVD_DEV_LONGTEXT N_( \
    "This is the default DVD drive (or file) to use. Don't forget the colon " \
    "after the drive letter (eg D:)")
#else
305 306
#define DVD_DEV_LONGTEXT N_( \
    "This is the default DVD device to use.")
Gildas Bazin's avatar
 
Gildas Bazin committed
307
#endif
308 309 310 311 312

#define VCD_DEV_TEXT N_("VCD device")
#define VCD_DEV_LONGTEXT N_( \
    "This is the default VCD device to use.")

313
#define IPV6_TEXT N_("Force IPv6")
314 315 316 317
#define IPV6_LONGTEXT N_( \
    "If you check this box, IPv6 will be used by default for all UDP and " \
    "HTTP connections.")

318
#define IPV4_TEXT N_("Force IPv4")
319 320 321 322
#define IPV4_LONGTEXT N_( \
    "If you check this box, IPv4 will be used by default for all UDP and " \
    "HTTP connections.")

323 324 325 326 327
#define CODEC_CAT_LONGTEXT N_( \
    "This option can be used to alter the way VLC selects \n" \
    "its codecs (decompression methods). Only advanced users should \n" \
    "alter this option as it can break playback of all your streams." )

328
#define CODEC_TEXT N_("Choose preferred codec list")
329
#define CODEC_LONGTEXT N_( \
330
    "This allows you to select the order in which VLC will choose its " \
331
    "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
332
    "before the new one. Please be aware that VLC does not make any " \
333 334 335
    "difference between audio or video codecs, so you should always specify " \
    "'any' at the end of the list to make sure there is a fallback for the " \
    "types you didn't specify.")
336

337

338
#define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
339
#define ENCODER_VIDEO_LONGTEXT N_( \
340
    "This allows you to select the order in which VLC will choose its " \
341
    "codecs. " )
342
#define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
343
#define ENCODER_AUDIO_LONGTEXT N_( \
344
    "This allows you to select the order in which VLC will choose its " \
345 346
    "codecs. " )

347 348 349 350
#define SOUT_CAT_LONGTEXT N_( \
    "These options allow you to set default global options for the\n " \
    "stream output subsystem." )

351
#define SOUT_TEXT N_("Choose a stream output")
352 353
#define SOUT_LONGTEXT N_( \
    "Empty if no stream output.")
Gildas Bazin's avatar
 
Gildas Bazin committed
354

355
#define SOUT_DISPLAY_TEXT N_("Display while streaming")
356 357 358
#define SOUT_DISPLAY_LONGTEXT N_( \
    "This allows you to play the stream while streaming it.")

359
#define SOUT_VIDEO_TEXT N_("Enable video stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
360 361 362 363
#define SOUT_VIDEO_LONGTEXT N_( \
    "This allows you to choose if the video stream should be redirected to " \
    "the stream output facility when this last one is enabled.")

364
#define SOUT_AUDIO_TEXT N_("Enable audio stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
365 366 367 368
#define SOUT_AUDIO_LONGTEXT N_( \
    "This allows you to choose if the video stream should be redirected to " \
    "the stream output facility when this last one is enabled.")

369 370 371 372 373
#define SOUT_KEEP_TEXT N_("Keep sout open" )
#define SOUT_KEEP_LONGTEXT N_( \
    "This allows you to keep an unique sout instance across " \
    "multiple playlist item (automatically insert gather stream_out " \
    "if not specified)" )
374

375
#define PACKETIZER_TEXT N_("Choose preferred packetizer list")
376
#define PACKETIZER_LONGTEXT N_( \
377
    "This allows you to select the order in which VLC will choose its " \
378
    "packetizers."  )
Gildas Bazin's avatar
 
Gildas Bazin committed
379

380
#define MUX_TEXT N_("Mux module")
381 382
#define MUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure mux modules")
Gildas Bazin's avatar
 
Gildas Bazin committed
383

384
#define ACCESS_OUTPUT_TEXT N_("Access output module")
385 386 387
#define ACCESS_OUTPUT_LONGTEXT N_( \
    "This is a legacy entry to let you configure access output modules")

388 389 390
#define CPU_CAT_LONGTEXT N_( \
    "These options allow you to enable special CPU \n " \
    "optimizations. You should always leave all these enabled." )
391

392
#define MMX_TEXT N_("Enable CPU MMX support")
393
#define MMX_LONGTEXT N_( \
394
    "If your processor supports the MMX instructions set, VLC can take " \
395 396
    "advantage of them.")

397
#define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
398
#define THREE_DN_LONGTEXT N_( \
399
    "If your processor supports the 3D Now! instructions set, VLC can take " \
400 401
    "advantage of them.")

402
#define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
403
#define MMXEXT_LONGTEXT N_( \
404
    "If your processor supports the MMX EXT instructions set, VLC can take " \
405 406
    "advantage of them.")

407
#define SSE_TEXT N_("Enable CPU SSE support")
408
#define SSE_LONGTEXT N_( \
409
    "If your processor supports the SSE instructions set, VLC can take " \
410
    "advantage of them.")
411

412
#define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
413
#define ALTIVEC_LONGTEXT N_( \
414
    "If your processor supports the AltiVec instructions set, VLC can take " \
415 416
    "advantage of them.")

417 418 419 420
#define PLAYLIST_CAT_LONGTEXT N_( \
     "These options define the behaviour of the playlist. Some \n" \
     "of them can be overriden in the playlist dialog box." ) 

421
#define RANDOM_TEXT N_("Play files randomly forever")
422
#define RANDOM_LONGTEXT N_( \
423
    "When selected, VLC will randomly play files in the playlist until " \
424 425
    "interrupted.")

426
#define LOOP_TEXT N_("Loop playlist on end")
427
#define LOOP_LONGTEXT N_( \
428
    "If you want VLC to keep playing the playlist indefinitely then enable " \
429
    "this option.")
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
430 431 432 433 434
    
#define REPEAT_TEXT N_("Repeat the current playlistitem")
#define REPEAT_LONGTEXT N_( \
    "When this is active VLC will keep playing the current playlistitem " \
    "over and over again.")
435

436 437 438 439
#define MISC_CAT_LONGTEXT N_( \
    "These options allow you to select default modules. Leave these \n" \
    "alone unless you really know what you are doing." )

440
#define MEMCPY_TEXT N_("Memory copy module")
441
#define MEMCPY_LONGTEXT N_( \
442 443
    "You can select which memory copy module you want to use. By default " \
    "VLC will select the fastest one supported by your hardware.")
444

445
#define ACCESS_TEXT N_("Access module")
446 447 448
#define ACCESS_LONGTEXT N_( \
    "This is a legacy entry to let you configure access modules")

449
#define DEMUX_TEXT N_("Demux module")
450 451 452
#define DEMUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure demux modules")

Gildas Bazin's avatar
 
Gildas Bazin committed
453 454 455 456 457 458 459 460
#define ONEINSTANCE_TEXT N_("Allow only one running instance of VLC")
#define ONEINSTANCE_LONGTEXT N_( \
    "Allowing only one running instance of VLC can sometimes be useful, " \
    "for instance if you associated VLC with some media types and you " \
    "don't want a new instance of VLC to be opened each time you " \
    "double-click on a file in the explorer. This option will allow you " \
    "to play the file with the already running instance or enqueue it.")

Gildas Bazin's avatar
 
Gildas Bazin committed
461 462 463 464 465 466 467 468 469
#define HPRIORITY_TEXT N_("Increase the priority of the process")
#define HPRIORITY_LONGTEXT N_( \
    "Increasing the priority of the process will very likely improve your " \
    "playing experience as it allows VLC not to be disturbed by other " \
    "applications that could otherwise take too much processor time.\n" \
    "However be advise that in certain circumstances (bugs) VLC could take " \
    "all the processor time and render the whole system unresponsive which " \
    "might require a reboot of your machine.")

Gildas Bazin's avatar
 
Gildas Bazin committed
470
#define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
471 472 473 474 475 476 477
#define FAST_MUTEX_LONGTEXT N_( \
    "On Windows NT/2K/XP we use a slow mutex implementation but which " \
    "allows us to correctely implement condition variables. " \
    "You can also use the faster Win9x implementation but you might " \
    "experience problems with it.")

#define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
478
    "(developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
479 480 481 482 483 484 485 486
#define WIN9X_CV_LONGTEXT N_( \
    "On Windows 9x/Me we use a fast but not correct condition variables " \
    "implementation (more precisely there is a possibility for a race " \
    "condition to happen). " \
    "However it is possible to use slower alternatives which should be more " \
    "robust. " \
    "Currently you can choose between implementation 0 (which is the " \
    "default and the fastest), 1 and 2.")
487

488 489
#define HOTKEY_CAT_LONGTEXT N_( " " )

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
#define FULLSCREEN_KEY_TEXT N_("Fullscreen")
#define FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to swap fullscreen state")
#define PLAY_PAUSE_KEY_TEXT N_("Pause")
#define PLAY_PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to swap paused state")
#define PAUSE_KEY_TEXT N_("Pause only")
#define PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to pause")
#define PLAY_KEY_TEXT N_("Play only")
#define PLAY_KEY_LONGTEXT N_("Select the hotkey to use to play")
#define FASTER_KEY_TEXT N_("Faster")
#define FASTER_KEY_LONGTEXT N_("Select the hotkey to use for fast forward playback")
#define SLOWER_KEY_TEXT N_("Slower")
#define SLOWER_KEY_LONGTEXT N_("Select the hotkey to use for slow motion playback")
#define NEXT_KEY_TEXT N_("Next")
#define NEXT_KEY_LONGTEXT N_("Select the hotkey to use to skip to the next item in the playlist")
#define PREV_KEY_TEXT N_("Previous")
#define PREV_KEY_LONGTEXT N_("Select the hotkey to use to skip to the previous item in the playlist")
#define STOP_KEY_TEXT N_("Stop")
#define STOP_KEY_LONGTEXT N_("Select the hotkey to stop the playback")
#define QUIT_KEY_TEXT N_("Quit")
#define QUIT_KEY_LONGTEXT N_("Select the hotkey to quit the application")
#define NAV_UP_KEY_TEXT N_("Navigate up")
#define NAV_UP_KEY_LONGTEXT N_("Select the key to move the selector up in dvd menus")
#define NAV_DOWN_KEY_TEXT N_("Navigate down")
#define NAV_DOWN_KEY_LONGTEXT N_("Select the key to move the selector down in dvd menus")
#define NAV_LEFT_KEY_TEXT N_("Navigate left")
#define NAV_LEFT_KEY_LONGTEXT N_("Select the key to move the selector left in dvd menus")
#define NAV_RIGHT_KEY_TEXT N_("Navigate right")
#define NAV_RIGHT_KEY_LONGTEXT N_("Select the key to move the selector right in dvd menus")
#define NAV_ACTIVATE_KEY_TEXT N_("Activate")
#define NAV_ACTIVATE_KEY_LONGTEXT N_("Select the key to activate selected item in dvd menus")
#define VOL_UP_KEY_TEXT N_("Volume up")
#define VOL_UP_KEY_LONGTEXT N_("Select the key to turn up audio volume")
#define VOL_DOWN_KEY_TEXT N_("Volume down")
#define VOL_DOWN_KEY_LONGTEXT N_("Select the key to turn down audio volume")

Gildas Bazin's avatar
 
Gildas Bazin committed
525 526 527 528 529 530 531
#define PLAYLIST_USAGE N_("\nPlaylist items:" \
    "\n  *.mpg, *.vob                   plain MPEG-1/2 files" \
    "\n  [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
    "\n                                 DVD device" \
    "\n  [vcd:][device][@[title][,[chapter]]" \
    "\n                                 VCD device" \
    "\n  udpstream:[@[<bind address>][:<bind port>]]" \
532
    "\n                                 UDP stream sent by a streaming server" \
Gildas Bazin's avatar
 
Gildas Bazin committed
533 534 535 536 537
    "\n  vlc:pause                      pause execution of " \
    "playlist items" \
    "\n  vlc:quit                       quit VLC" \
    "\n")

538

539 540 541
/*
 * Quick usage guide for the configuration options:
 *
542 543 544 545 546 547 548 549 550
 * add_category_hint( N_(text), N_(longtext) );
 * add_subcategory_hint( N_(text), N_(longtext) );
 * add_usage_hint( N_(text) );
 * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
 * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
 * add_module( option_name, psz_value, i_capability, p_callback,
 *             N_(text), N_(longtext) );
 * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
 * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
551 552
 */

553 554
vlc_module_begin();
    /* Interface options */
555
    add_category_hint( N_("Interface"), INTF_CAT_LONGTEXT , VLC_FALSE );
556
    add_module_with_short( "intf", 'I', "interface", NULL, NULL,
557
                           INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
558 559
    add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, 
                     EXTRAINTF_LONGTEXT, VLC_FALSE );
560
    add_integer_with_short( "verbose", 'v', 0, NULL,
561
                            VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
562 563 564 565
    add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, 
                            QUIET_LONGTEXT, VLC_TRUE );
    add_string_from_list( "language", "auto", ppsz_language, NULL,
                            LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
566
    add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
567 568 569 570
    add_bool( "advanced", 0, NULL, ADVANCED_TEXT, 
                            ADVANCED_LONGTEXT, VLC_FALSE );
    add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, 
                            INTF_PATH_LONGTEXT, VLC_TRUE );
571
    add_directory( "plugin-path", NULL, NULL,
572
                PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
573 574

    /* Audio options */
575
    add_category_hint( N_("Audio"), AOUT_CAT_LONGTEXT , VLC_FALSE );
576
    add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
577 578
                           AOUT_TEXT, AOUT_LONGTEXT, VLC_TRUE);
    add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_FALSE );
579 580
    add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
                            AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
581
                            VOLUME_LONGTEXT, VLC_FALSE );
582 583
    add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
                            AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
584 585
                            VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
    add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
586 587 588
#if !defined( SYS_DARWIN )
    add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
#endif
589
    add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
590
    add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
591 592 593 594
#if 0
    add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, 
                        HEADPHONE_LONGTEXT, VLC_FALSE );
#endif
Clément Stenac's avatar
Clément Stenac committed
595 596 597
    add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
                    AUDIO_FILTER_LONGTEXT,VLC_FALSE);
    
598
    /* Video options */
599
    add_category_hint( N_("Video"), VOUT_CAT_LONGTEXT , VLC_FALSE );
600
    add_module_with_short( "vout", 'V', "video output", NULL, NULL,
601
                           VOUT_TEXT, VOUT_LONGTEXT, VLC_TRUE );
602 603 604
    add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
    add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
    add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
605
    add_integer( "align", -1, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
606 607
    add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
    add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
608 609
    add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, 
                        FULLSCREEN_LONGTEXT, VLC_FALSE );
610
#ifndef SYS_DARWIN
611
    add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
612
#endif
613 614
    add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, 
                        SPUMARGIN_LONGTEXT, VLC_TRUE );
615
    add_module( "filter", "video filter", NULL, NULL,
616
                FILTER_TEXT, FILTER_LONGTEXT, VLC_FALSE );
617
    add_string( "aspect-ratio", "", NULL,
618
                ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
619 620 621
#if 0
    add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
#endif
622 623

    /* Input options */
624
    add_category_hint( N_("Input"), INPUT_CAT_LONGTEXT , VLC_FALSE );
625
    add_integer( "server-port", 1234, NULL,
626 627 628
                 SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
    add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
    add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
629 630

    add_integer( "program", 0, NULL,
631
                 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
632
    add_integer( "audio-type", -1, NULL,
633
                 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
634
    add_integer( "audio-channel", -1, NULL,
635
                 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
636
    add_integer( "spu-channel", -1, NULL,
637
                 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
638 639 640 641 642
    add_bool( "sub-autodetect-file", VLC_TRUE, NULL,
                 SUB_AUTO_TEXT, SUB_AUTO_LONGTEXT, VLC_FALSE );
    add_file( "sub-file", NULL, NULL,
                 SUB_FILE_TEXT, SUB_FILE_LONGTEXT, VLC_TRUE );

643

Gildas Bazin's avatar
 
Gildas Bazin committed
644 645
    add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
    add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
646

647 648
    add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
    add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
649 650

    /* Decoder options */
651
    add_category_hint( N_("Decoders"), CODEC_CAT_LONGTEXT , VLC_TRUE );
652
    add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
653

654

Gildas Bazin's avatar
 
Gildas Bazin committed
655
    /* Stream output options */
656
    add_category_hint( N_("Stream output"), SOUT_CAT_LONGTEXT , VLC_TRUE );
657
    add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
658 659 660 661
    add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, 
                                SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
    add_bool( "sout-keep", VLC_FALSE, NULL, SOUT_KEEP_TEXT, 
                                SOUT_KEEP_LONGTEXT, VLC_TRUE );
662

663 664 665 666
    add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, 
                                SOUT_AUDIO_LONGTEXT, VLC_TRUE );
    add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, 
                                SOUT_VIDEO_LONGTEXT, VLC_TRUE );
667

Gildas Bazin's avatar
 
Gildas Bazin committed
668
    add_module( "packetizer", "packetizer", NULL, NULL,
669
                PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
670 671
    add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, 
                                MUX_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
672
    add_module( "access_output", "sout access", NULL, NULL,
673
                ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
674
    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
675

676

677
    /* CPU options */
678
    add_category_hint( N_("CPU"), CPU_CAT_LONGTEXT, VLC_TRUE );
679
#if defined( __i386__ )
Gildas Bazin's avatar
 
Gildas Bazin committed
680 681 682 683
    add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
    add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
    add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
    add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
684 685
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
Gildas Bazin's avatar
 
Gildas Bazin committed
686
    add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
687 688
#endif

689
    /* Playlist options */
690
    add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
691
    add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
692 693
    add_bool_with_short( "loop", 'L', 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
    add_bool_with_short( "repeat", 'R', 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
694

695
    /* Misc options */
696
    add_category_hint( N_("Miscellaneous"), MISC_CAT_LONGTEXT, VLC_TRUE );
697 698 699
    add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
    add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
    add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
700

701
#if defined(WIN32)
Gildas Bazin's avatar
 
Gildas Bazin committed
702
    add_bool( "one-instance", 0, NULL, ONEINSTANCE_TEXT, ONEINSTANCE_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
703
    add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
704 705
    add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
    add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
706
#endif
707

708
    /* Hotkey options*/
709
    add_category_hint( N_("Hot keys"), HOTKEY_CAT_LONGTEXT , VLC_FALSE );
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
    add_key( "fullscreen-key", 'f', NULL, FULLSCREEN_KEY_TEXT, FULLSCREEN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "play-pause-key", KEY_SPACE, NULL, PLAY_PAUSE_KEY_TEXT, PLAY_PAUSE_KEY_LONGTEXT, VLC_FALSE );
    add_key( "pause-key", 0, NULL, PAUSE_KEY_TEXT, PAUSE_KEY_LONGTEXT, VLC_TRUE );
    add_key( "play-key", 0, NULL, PLAY_KEY_TEXT, PLAY_KEY_LONGTEXT, VLC_TRUE );
    add_key( "faster-key", '+', NULL, FASTER_KEY_TEXT, FASTER_KEY_LONGTEXT, VLC_FALSE );
    add_key( "slower-key", '-', NULL, SLOWER_KEY_TEXT, SLOWER_KEY_LONGTEXT, VLC_FALSE );
    add_key( "next-key", 'n', NULL, NEXT_KEY_TEXT, NEXT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "prev-key", 'p', NULL, PREV_KEY_TEXT, PREV_KEY_LONGTEXT, VLC_FALSE );
    add_key( "stop-key", 's', NULL, STOP_KEY_TEXT, STOP_KEY_LONGTEXT, VLC_FALSE );
    add_key( "nav-activate-key", KEY_ENTER, NULL, NAV_ACTIVATE_KEY_TEXT, NAV_ACTIVATE_KEY_LONGTEXT, VLC_FALSE );
    add_key( "nav-up-key", KEY_UP, NULL, NAV_UP_KEY_TEXT, NAV_UP_KEY_LONGTEXT, VLC_FALSE );
    add_key( "nav-down-key", KEY_DOWN, NULL, NAV_DOWN_KEY_TEXT, NAV_DOWN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "nav-left-key", KEY_LEFT, NULL, NAV_LEFT_KEY_TEXT, NAV_LEFT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "nav-right-key", KEY_RIGHT, NULL, NAV_RIGHT_KEY_TEXT, NAV_RIGHT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "quit-key", KEY_MODIFIER_CTRL|KEY_SPACE, NULL, QUIT_KEY_TEXT, QUIT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "vol-up-key", 'a', NULL, VOL_UP_KEY_TEXT, VOL_UP_KEY_LONGTEXT, VLC_FALSE );
    add_key( "vol-down-key", 'z', NULL, VOL_DOWN_KEY_TEXT, VOL_DOWN_KEY_LONGTEXT, VLC_FALSE );

728 729
    /* Usage (mainly useful for cmd line stuff) */
    add_usage_hint( PLAYLIST_USAGE );
730

731 732 733
    set_description( N_("main program") );
    set_capability( "main", 100 );
vlc_module_end();
734 735 736

static module_config_t p_help_config[] =
{
Gildas Bazin's avatar
 
Gildas Bazin committed
737 738 739 740
    { CONFIG_ITEM_BOOL, NULL, "help", 'h',
      N_("print help (can be combined with --advanced)") },
    { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H',
      N_("print detailed help (can be combined with --advanced)") },
741
    { CONFIG_ITEM_BOOL, NULL, "list", 'l',
Gildas Bazin's avatar
 
Gildas Bazin committed
742 743 744 745 746 747 748 749 750
      N_("print a list of available modules") },
    { CONFIG_ITEM_STRING, NULL, "module", 'p',
      N_("print help on module (can be combined with --advanced)") },
    { CONFIG_ITEM_BOOL, NULL, "save-config", '\0',
      N_("save the current command line options in the config") },
    { CONFIG_ITEM_BOOL, NULL, "reset-config", '\0',
      N_("reset the current config to the default values") },
    { CONFIG_ITEM_STRING, NULL, "config", '\0',
      N_("use alternate config file") },
751
    { CONFIG_ITEM_BOOL, NULL, "version", '\0',
Gildas Bazin's avatar
 
Gildas Bazin committed
752 753
      N_("print version information") },
    { CONFIG_HINT_END, NULL, NULL, '\0', NULL }
754 755 756 757 758
};

/*****************************************************************************
 * End configuration.
 *****************************************************************************/