libvlc.h 30.8 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * libvlc.h: main libvlc header
 *****************************************************************************
 * Copyright (C) 1998-2002 VideoLAN
5
 * $Id: libvlc.h,v 1.85 2003/09/20 02:47:41 hartman 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", "es", "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
#define INTF_TEXT N_("Interface module")
39
#define INTF_LONGTEXT N_( \
40
    "This option allows you to select the interface used by VLC. " \
41 42 43
    "The default behavior is to automatically select the best module " \
    "available.")

44
#define EXTRAINTF_TEXT N_("Extra interface modules")
45
#define EXTRAINTF_LONGTEXT N_( \
46
    "This option allows you to select additional interfaces used by VLC. " \
Sam Hocevar's avatar
Sam Hocevar committed
47
    "They will be launched in the background in addition to the default " \
48 49
    "interface. Use a comma separated list of interface modules. (common " \
    "values are: logger,gestures,sap,rc,http,screensaver)")
50

51
#define VERBOSE_TEXT N_("Verbosity (0,1,2)")
52
#define VERBOSE_LONGTEXT N_( \
53
    "This options sets the verbosity level (0=only errors and " \
54
    "standard messages, 1=warnings, 2=debug).")
55

56
#define QUIET_TEXT N_("Be quiet")
57 58 59
#define QUIET_LONGTEXT N_( \
    "This options turns off all warning and information messages.")

60 61 62 63
#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
64

65
#define COLOR_TEXT N_("Color messages")
66 67 68 69
#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.")

70
#define ADVANCED_TEXT N_("Show advanced options")
71
#define ADVANCED_LONGTEXT N_( \
72 73 74
    "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")
75

76
#define INTF_PATH_TEXT N_("Interface default search path")
77 78 79 80
#define INTF_PATH_LONGTEXT N_( \
    "This option allows you to set the default path that the interface will " \
    "open when looking for a file.")

81
#define PLUGIN_PATH_TEXT N_("Plugin search path")
82
#define PLUGIN_PATH_LONGTEXT N_( \
83
    "This option allows you to specify an additional path for VLC to look " \
84 85
    "for its plugins.")

86
#define AOUT_TEXT N_("Audio output module")
87
#define AOUT_LONGTEXT N_( \
88
    "This option allows you to select the audio output method used by VLC. " \
89 90
    "The default behavior is to automatically select the best method " \
    "available.")
91

92
#define AUDIO_TEXT N_("Enable audio")
93 94
#define AUDIO_LONGTEXT N_( \
    "You can completely disable the audio output. In this case the audio " \
95
    "decoding will not take place, and it will save some processing power.")
96

97
#define MONO_TEXT N_("Force mono audio")
98 99
#define MONO_LONGTEXT N_("This will force a mono audio output")

100
#define VOLUME_TEXT N_("Audio output volume")
101 102 103 104
#define VOLUME_LONGTEXT N_( \
    "You can set the default audio output volume here, in a range from 0 to " \
    "1024.")

105
#define VOLUME_SAVE_TEXT N_("Audio output saved volume")
106 107 108
#define VOLUME_SAVE_LONGTEXT N_( \
    "This saves the audio output volume when you select mute.")

109
#define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
110
#define AOUT_RATE_LONGTEXT N_( \
111
    "You can force the audio output frequency here. Common values are " \
Gildas Bazin's avatar
 
Gildas Bazin committed
112
    "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
113

Gildas Bazin's avatar
 
Gildas Bazin committed
114 115 116 117 118 119 120
#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

121
#define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
122 123 124 125
#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
126 127 128 129 130 131
#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)")

132
#define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
Gildas Bazin's avatar
 
Gildas Bazin committed
133 134 135 136
#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
137 138 139 140 141
#define AUDIO_FILTER_TEXT N_("Audio filters")
#define AUDIO_FILTER_LONGTEXT N_( \
    "This allows you to add audio postprocessing filters, to modify" \
    "the sound.")

142
#define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
143
#define HEADPHONE_LONGTEXT N_( \
144
    "This effect gives you the feeling that you are standing in a room " \
145 146 147 148 149 150
    "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.")

Clément Stenac's avatar
Clément Stenac committed
151

152
#define VOUT_TEXT N_("Video output module")
153
#define VOUT_LONGTEXT N_( \
154
    "This option allows you to select the video output method used by VLC. " \
155 156 157
    "The default behavior is to automatically select the best " \
    "method available.")

158
#define VIDEO_TEXT N_("Enable video")
159 160
#define VIDEO_LONGTEXT N_( \
    "You can completely disable the video output. In this case the video " \
161
    "decoding stage will not take place, which will save some processing power.")
162

163
#define WIDTH_TEXT N_("Video width")
164
#define WIDTH_LONGTEXT N_( \
165
    "You can enforce the video width here. By default (-1) VLC will " \
166 167
    "adapt to the video characteristics.")

168
#define HEIGHT_TEXT N_("Video height")
169
#define HEIGHT_LONGTEXT N_( \
170
    "You can enforce the video height here. By default (-1) VLC will " \
171 172
    "adapt to the video characteristics.")

Gildas Bazin's avatar
 
Gildas Bazin committed
173 174 175 176 177 178
#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).")

179
#define ZOOM_TEXT N_("Zoom video")
180 181 182
#define ZOOM_LONGTEXT N_( \
    "You can zoom the video by the specified factor.")

183
#define GRAYSCALE_TEXT N_("Grayscale video output")
184 185 186 187
#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).")

188
#define FULLSCREEN_TEXT N_("Fullscreen video output")
189
#define FULLSCREEN_LONGTEXT N_( \
190
    "If this option is enabled, VLC will always start a video in fullscreen " \
191 192
    "mode.")

193
#define OVERLAY_TEXT N_("Overlay video output")
194
#define OVERLAY_LONGTEXT N_( \
195
    "If enabled, VLC will try to take advantage of the overlay capabilities " \
196
    "of your graphics card.")
197

198
#define SPUMARGIN_TEXT N_("Force SPU position")
199 200 201 202
#define SPUMARGIN_LONGTEXT N_( \
    "You can use this option to place the subtitles under the movie, " \
    "instead of over the movie. Try several positions.")

203
#define FILTER_TEXT N_("Video filter module")
204 205 206 207 208
#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.")

209
#define ASPECT_RATIO_TEXT N_("Source aspect ratio")
210 211 212 213 214 215 216 217 218
#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
219
#define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
220 221 222 223 224 225 226 227
#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

228
#define SERVER_PORT_TEXT N_("Server port")
229 230 231
#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
232
#define MTU_TEXT N_("MTU of the network interface")
Christophe Massiot's avatar
Christophe Massiot committed
233 234 235 236
#define MTU_LONGTEXT N_( \
    "This is the typical size of UDP packets that we expect. On Ethernet " \
    "it is usually 1500.")

237
#define IFACE_ADDR_TEXT N_("Network interface address")
238 239 240
#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 " \
241
    "of your multicasting interface here.")
242

243
#define TTL_TEXT N_("Time to live")
244 245 246 247
#define TTL_LONGTEXT N_( \
    "Indicate here the Time To Live of the multicast packets sent by " \
    "the stream output.")

248
#define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
249 250 251
#define INPUT_PROGRAM_LONGTEXT N_( \
    "Choose the program to select by giving its Service ID.")

252
#define INPUT_AUDIO_TEXT N_("Choose audio")
253
#define INPUT_AUDIO_LONGTEXT N_( \
254 255
    "Give the default type of audio you want to use in a DVD. " \
    "(Developers only)")
256

257
#define INPUT_CHAN_TEXT N_("Choose channel")
258 259 260 261
#define INPUT_CHAN_LONGTEXT N_( \
    "Give the stream number of the audio channel you want to use in a DVD " \
    "(from 1 to n).")

262
#define INPUT_SUBT_TEXT N_("Choose subtitles")
263 264 265 266 267
#define INPUT_SUBT_LONGTEXT N_( \
    "Give the stream number of the subtitle channel you want to use in a " \
    "DVD (from 1 to n).")

#define DVD_DEV_TEXT N_("DVD device")
Gildas Bazin's avatar
 
Gildas Bazin committed
268 269 270 271 272
#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
273 274
#define DVD_DEV_LONGTEXT N_( \
    "This is the default DVD device to use.")
Gildas Bazin's avatar
 
Gildas Bazin committed
275
#endif
276 277 278 279 280

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

281
#define IPV6_TEXT N_("Force IPv6")
282 283 284 285
#define IPV6_LONGTEXT N_( \
    "If you check this box, IPv6 will be used by default for all UDP and " \
    "HTTP connections.")

286
#define IPV4_TEXT N_("Force IPv4")
287 288 289 290
#define IPV4_LONGTEXT N_( \
    "If you check this box, IPv4 will be used by default for all UDP and " \
    "HTTP connections.")

291
#define CODEC_TEXT N_("Choose preferred codec list")
292
#define CODEC_LONGTEXT N_( \
293
    "This allows you to select the order in which VLC will choose its " \
294
    "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
295
    "before the new one. Please be aware that VLC does not make any " \
296 297 298
    "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.")
299

300
#define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
301
#define ENCODER_VIDEO_LONGTEXT N_( \
302
    "This allows you to select the order in which VLC will choose its " \
303
    "codecs. " )
304
#define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
305
#define ENCODER_AUDIO_LONGTEXT N_( \
306
    "This allows you to select the order in which VLC will choose its " \
307 308
    "codecs. " )

309
#define SOUT_TEXT N_("Choose a stream output")
310 311
#define SOUT_LONGTEXT N_( \
    "Empty if no stream output.")
Gildas Bazin's avatar
 
Gildas Bazin committed
312

313
#define SOUT_DISPLAY_TEXT N_("Display while streaming")
314 315 316
#define SOUT_DISPLAY_LONGTEXT N_( \
    "This allows you to play the stream while streaming it.")

317
#define SOUT_VIDEO_TEXT N_("Enable video stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
318 319 320 321
#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.")

322
#define SOUT_AUDIO_TEXT N_("Enable audio stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
323 324 325 326
#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.")

327 328 329 330 331
#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)" )
332

333
#define PACKETIZER_TEXT N_("Choose preferred packetizer list")
334
#define PACKETIZER_LONGTEXT N_( \
335
    "This allows you to select the order in which VLC will choose its " \
336
    "packetizers."  )
Gildas Bazin's avatar
 
Gildas Bazin committed
337

338
#define MUX_TEXT N_("Mux module")
339 340
#define MUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure mux modules")
Gildas Bazin's avatar
 
Gildas Bazin committed
341

342
#define ACCESS_OUTPUT_TEXT N_("Access output module")
343 344 345
#define ACCESS_OUTPUT_LONGTEXT N_( \
    "This is a legacy entry to let you configure access output modules")

346

347
#define MMX_TEXT N_("Enable CPU MMX support")
348
#define MMX_LONGTEXT N_( \
349
    "If your processor supports the MMX instructions set, VLC can take " \
350 351
    "advantage of them.")

352
#define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
353
#define THREE_DN_LONGTEXT N_( \
354
    "If your processor supports the 3D Now! instructions set, VLC can take " \
355 356
    "advantage of them.")

357
#define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
358
#define MMXEXT_LONGTEXT N_( \
359
    "If your processor supports the MMX EXT instructions set, VLC can take " \
360 361
    "advantage of them.")

362
#define SSE_TEXT N_("Enable CPU SSE support")
363
#define SSE_LONGTEXT N_( \
364
    "If your processor supports the SSE instructions set, VLC can take " \
365
    "advantage of them.")
366

367
#define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
368
#define ALTIVEC_LONGTEXT N_( \
369
    "If your processor supports the AltiVec instructions set, VLC can take " \
370 371
    "advantage of them.")

372
#define RANDOM_TEXT N_("Play files randomly forever")
373
#define RANDOM_LONGTEXT N_( \
374
    "When selected, VLC will randomly play files in the playlist until " \
375 376
    "interrupted.")

377
#define ENQUEUE_TEXT N_("Enqueue items in playlist")
378
#define ENQUEUE_LONGTEXT N_( \
379
    "If you want VLC to add items to the playlist as you open them, then " \
380 381
    "enable this option.")

382
#define LOOP_TEXT N_("Loop playlist on end")
383
#define LOOP_LONGTEXT N_( \
384
    "If you want VLC to keep playing the playlist indefinitely then enable " \
385 386
    "this option.")

387
#define MEMCPY_TEXT N_("Memory copy module")
388
#define MEMCPY_LONGTEXT N_( \
389 390
    "You can select which memory copy module you want to use. By default " \
    "VLC will select the fastest one supported by your hardware.")
391

392
#define ACCESS_TEXT N_("Access module")
393 394 395
#define ACCESS_LONGTEXT N_( \
    "This is a legacy entry to let you configure access modules")

396
#define DEMUX_TEXT N_("Demux module")
397 398 399
#define DEMUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure demux modules")

Gildas Bazin's avatar
 
Gildas Bazin committed
400 401 402 403 404 405 406 407 408
#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
409
#define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
410 411 412 413 414 415 416
#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 " \
417
    "(developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
418 419 420 421 422 423 424 425
#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.")
426

427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
#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
462 463 464 465 466 467 468
#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>]]" \
469
    "\n                                 UDP stream sent by a streaming server" \
Gildas Bazin's avatar
 
Gildas Bazin committed
470 471 472 473 474
    "\n  vlc:pause                      pause execution of " \
    "playlist items" \
    "\n  vlc:quit                       quit VLC" \
    "\n")

475

476 477 478
/*
 * Quick usage guide for the configuration options:
 *
479 480 481 482 483 484 485 486 487
 * 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) );
488 489
 */

490 491
vlc_module_begin();
    /* Interface options */
492
    add_category_hint( N_("Interface"), NULL, VLC_FALSE );
493
    add_module_with_short( "intf", 'I', "interface", NULL, NULL,
494 495
                           INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
    add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
496
    add_integer_with_short( "verbose", 'v', 0, NULL,
497 498
                            VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
    add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
499
    add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
500 501
    add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
    add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
502 503
    add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
    add_directory( "plugin-path", NULL, NULL,
504
                PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
505 506

    /* Audio options */
507
    add_category_hint( N_("Audio"), NULL, VLC_FALSE );
508
    add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
509 510
                           AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
    add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
511 512
    add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
                            AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
513
                            VOLUME_LONGTEXT, VLC_FALSE );
514 515
    add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
                            AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
516 517
                            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
518 519 520
#if !defined( SYS_DARWIN )
    add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
#endif
521
    add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
522
    add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
523
    add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
Clément Stenac's avatar
Clément Stenac committed
524 525 526
    add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
                    AUDIO_FILTER_LONGTEXT,VLC_FALSE);
    
527
    /* Video options */
528
    add_category_hint( N_("Video"), NULL, VLC_FALSE );
529
    add_module_with_short( "vout", 'V', "video output", NULL, NULL,
530 531 532 533
                           VOUT_TEXT, VOUT_LONGTEXT, VLC_FALSE );
    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
534
    add_integer( "align", -1, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
535 536 537
    add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
    add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
    add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
538
#ifndef SYS_DARWIN
539
    add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
540
#endif
541
    add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
542
    add_module( "filter", "video filter", NULL, NULL,
543
                FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
544
    add_string( "aspect-ratio", "", NULL,
545
                ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
546 547 548
#if 0
    add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
#endif
549 550

    /* Input options */
551
    add_category_hint( N_("Input"), NULL, VLC_FALSE );
552
    add_integer( "server-port", 1234, NULL,
553 554 555
                 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 );
556 557

    add_integer( "program", 0, NULL,
558
                 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
559
    add_integer( "audio-type", -1, NULL,
560
                 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
561
    add_integer( "audio-channel", -1, NULL,
562
                 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
563
    add_integer( "spu-channel", -1, NULL,
564
                 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
565

Gildas Bazin's avatar
 
Gildas Bazin committed
566 567
    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 );
568

569 570
    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 );
571 572

    /* Decoder options */
573 574
    add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
    add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
575

576

Gildas Bazin's avatar
 
Gildas Bazin committed
577
    /* Stream output options */
578 579
    add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
    add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
580
    add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
581
    add_bool( "sout-keep", VLC_FALSE, NULL, SOUT_KEEP_TEXT, SOUT_KEEP_LONGTEXT, VLC_TRUE );
582

583
    add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
584 585
    add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );

Gildas Bazin's avatar
 
Gildas Bazin committed
586
    add_module( "packetizer", "packetizer", NULL, NULL,
587 588
                PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
    add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
589
    add_module( "access_output", "sout access", NULL, NULL,
590
                ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
591
    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
592

593

594
    /* CPU options */
Gildas Bazin's avatar
 
Gildas Bazin committed
595
    add_category_hint( N_("CPU"), NULL, VLC_TRUE );
596
#if defined( __i386__ )
Gildas Bazin's avatar
 
Gildas Bazin committed
597 598 599 600
    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 );
601 602
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
Gildas Bazin's avatar
 
Gildas Bazin committed
603
    add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
604 605
#endif

606
    /* Playlist options */
607 608 609 610
    add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
    add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
    add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT, VLC_FALSE );
    add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
Gildas Bazin's avatar
 
Gildas Bazin committed
611

612
    /* Misc options */
613 614 615 616
    add_category_hint( N_("Miscellaneous"), NULL, VLC_TRUE );
    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 );
617

618
#if defined(WIN32)
Gildas Bazin's avatar
 
Gildas Bazin committed
619
    add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
620 621
    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 );
622
#endif
623

624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
    /* Hotkey options*/
    add_category_hint( N_("Hot keys"), NULL, VLC_FALSE );
    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 );

644 645
    /* Usage (mainly useful for cmd line stuff) */
    add_usage_hint( PLAYLIST_USAGE );
646

647 648 649
    set_description( N_("main program") );
    set_capability( "main", 100 );
vlc_module_end();
650 651 652

static module_config_t p_help_config[] =
{
653
    { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
654
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
655
    { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
656
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
657
    { CONFIG_ITEM_BOOL, NULL, "list", 'l',
658
                              N_("print a list of available modules"),
659
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
660
    { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
661
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
662
    { CONFIG_ITEM_BOOL, NULL, "version", '\0',
663
                              N_("print version information"),
664
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
665
    { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
666
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
667 668 669 670 671
};

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