libvlc.h 31.8 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * libvlc.h: main libvlc header
 *****************************************************************************
 * Copyright (C) 1998-2002 VideoLAN
5
 * $Id: libvlc.h,v 1.81 2003/08/19 11:26:59 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_sout_acodec[] = { "", "mpga", "mp3", "vorb", "a52", NULL };
hartman's avatar
hartman committed
30
static char *ppsz_sout_vcodec[] = { "", "mpgv", "mp4v", "DIV1", "DIV2", 
31 32
                                 "DIV3", "h263", "i263", "WMV1", "WMV2",
                                 "MJPG", NULL };
Laurent Aimar's avatar
Laurent Aimar committed
33

34 35
static char *ppsz_language[] = { "auto", "en", "en_GB", "de", "fr", "it", "ja",
 i                               "nl", "no", "pl", "pt_BR", "ru", "sv", NULL };
36

37 38 39 40 41 42
/*****************************************************************************
 * 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.
 *****************************************************************************/
43
#define INTF_TEXT N_("Interface module")
44
#define INTF_LONGTEXT N_( \
45
    "This option allows you to select the interface used by VLC. " \
46 47 48
    "The default behavior is to automatically select the best module " \
    "available.")

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

56
#define VERBOSE_TEXT N_("Verbosity (0,1,2)")
57
#define VERBOSE_LONGTEXT N_( \
58
    "This options sets the verbosity level (0=only errors and " \
ipkiss's avatar
ipkiss committed
59
    "standard messages, 1=warnings, 2=debug).")
60

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

65 66 67 68
#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." )
gbazin's avatar
 
gbazin committed
69

70
#define COLOR_TEXT N_("Color messages")
71 72 73 74
#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.")

75
#define ADVANCED_TEXT N_("Show advanced options")
76
#define ADVANCED_LONGTEXT N_( \
77 78 79
    "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")
80

81
#define INTF_PATH_TEXT N_("Interface default search path")
82 83 84 85
#define INTF_PATH_LONGTEXT N_( \
    "This option allows you to set the default path that the interface will " \
    "open when looking for a file.")

86
#define PLUGIN_PATH_TEXT N_("Plugin search path")
87
#define PLUGIN_PATH_LONGTEXT N_( \
88
    "This option allows you to specify an additional path for VLC to look " \
89 90
    "for its plugins.")

91
#define AOUT_TEXT N_("Audio output module")
92
#define AOUT_LONGTEXT N_( \
93
    "This option allows you to select the audio output method used by VLC. " \
94 95
    "The default behavior is to automatically select the best method " \
    "available.")
96

97
#define AUDIO_TEXT N_("Enable audio")
98 99
#define AUDIO_LONGTEXT N_( \
    "You can completely disable the audio output. In this case the audio " \
100
    "decoding will not take place, and it will save some processing power.")
101

102
#define MONO_TEXT N_("Force mono audio")
103 104
#define MONO_LONGTEXT N_("This will force a mono audio output")

105
#define VOLUME_TEXT N_("Audio output volume")
106 107 108 109
#define VOLUME_LONGTEXT N_( \
    "You can set the default audio output volume here, in a range from 0 to " \
    "1024.")

110
#define VOLUME_SAVE_TEXT N_("Audio output saved volume")
111 112 113
#define VOLUME_SAVE_LONGTEXT N_( \
    "This saves the audio output volume when you select mute.")

114
#define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
115
#define AOUT_RATE_LONGTEXT N_( \
116
    "You can force the audio output frequency here. Common values are " \
gbazin's avatar
 
gbazin committed
117
    "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
118

gbazin's avatar
 
gbazin committed
119 120 121 122 123 124 125
#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

126
#define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
127 128 129 130
#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.")

gbazin's avatar
 
gbazin committed
131 132 133 134 135 136
#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)")

137
#define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
gbazin's avatar
 
gbazin committed
138 139 140 141
#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.")

zorglub's avatar
zorglub committed
142 143 144 145 146
#define AUDIO_FILTER_TEXT N_("Audio filters")
#define AUDIO_FILTER_LONGTEXT N_( \
    "This allows you to add audio postprocessing filters, to modify" \
    "the sound.")

147
#define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
148
#define HEADPHONE_LONGTEXT N_( \
149
    "This effect gives you the feeling that you are standing in a room " \
150 151 152 153 154 155
    "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.")

zorglub's avatar
zorglub committed
156

157
#define VOUT_TEXT N_("Video output module")
158
#define VOUT_LONGTEXT N_( \
159
    "This option allows you to select the video output method used by VLC. " \
160 161 162
    "The default behavior is to automatically select the best " \
    "method available.")

163
#define VIDEO_TEXT N_("Enable video")
164 165
#define VIDEO_LONGTEXT N_( \
    "You can completely disable the video output. In this case the video " \
166
    "decoding stage will not take place, which will save some processing power.")
167

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

173
#define HEIGHT_TEXT N_("Video height")
174
#define HEIGHT_LONGTEXT N_( \
175
    "You can enforce the video height here. By default (-1) VLC will " \
176 177
    "adapt to the video characteristics.")

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

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

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

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

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

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

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

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

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

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

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

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

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

261
#define INPUT_SUBT_TEXT N_("Choose subtitles")
262 263 264 265 266
#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")
gbazin's avatar
 
gbazin committed
267 268 269 270 271
#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
272 273
#define DVD_DEV_LONGTEXT N_( \
    "This is the default DVD device to use.")
gbazin's avatar
 
gbazin committed
274
#endif
275 276 277 278 279

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

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

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

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

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

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

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

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

321
#define SOUT_VCODEC_TEXT N_("Video encoding codec" )
322 323 324
#define SOUT_VCODEC_LONGTEXT N_( \
    "This allows you to force video encoding")

325
#define SOUT_VBITRATE_TEXT N_("Video bitrate encoding (kB/s)" )
326 327 328
#define SOUT_VBITRATE_LONGTEXT N_( \
    "This allows you to specify video bitrate in kB/s.")

329
#define SOUT_AUDIO_TEXT N_("Enable audio stream output")
gbazin's avatar
 
gbazin committed
330 331 332 333
#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.")

334
#define SOUT_ACODEC_TEXT N_("Audio encoding codec" )
335 336 337
#define SOUT_ACODEC_LONGTEXT N_( \
    "This allows you to force audio encoding")

338
#define SOUT_ABITRATE_TEXT N_("Audio bitrate encoding (kB/s)" )
339 340 341
#define SOUT_ABITRATE_LONGTEXT N_( \
    "This allows you to specify audio bitrate in kB/s.")

342
#define PACKETIZER_TEXT N_("Choose preferred packetizer list")
343
#define PACKETIZER_LONGTEXT N_( \
344
    "This allows you to select the order in which VLC will choose its " \
345
    "packetizers."  )
gbazin's avatar
 
gbazin committed
346

347
#define MUX_TEXT N_("Mux module")
348 349
#define MUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure mux modules")
gbazin's avatar
 
gbazin committed
350

351
#define ACCESS_OUTPUT_TEXT N_("Access output module")
352 353 354
#define ACCESS_OUTPUT_LONGTEXT N_( \
    "This is a legacy entry to let you configure access output modules")

355

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

361
#define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
362
#define THREE_DN_LONGTEXT N_( \
363
    "If your processor supports the 3D Now! instructions set, VLC can take " \
364 365
    "advantage of them.")

366
#define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
367
#define MMXEXT_LONGTEXT N_( \
368
    "If your processor supports the MMX EXT instructions set, VLC can take " \
369 370
    "advantage of them.")

371
#define SSE_TEXT N_("Enable CPU SSE support")
372
#define SSE_LONGTEXT N_( \
373
    "If your processor supports the SSE instructions set, VLC can take " \
ipkiss's avatar
ipkiss committed
374
    "advantage of them.")
375

376
#define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
377
#define ALTIVEC_LONGTEXT N_( \
378
    "If your processor supports the AltiVec instructions set, VLC can take " \
379 380
    "advantage of them.")

381
#define RANDOM_TEXT N_("Play files randomly forever")
382
#define RANDOM_LONGTEXT N_( \
383
    "When selected, VLC will randomly play files in the playlist until " \
384 385
    "interrupted.")

386
#define ENQUEUE_TEXT N_("Enqueue items in playlist")
387
#define ENQUEUE_LONGTEXT N_( \
388
    "If you want VLC to add items to the playlist as you open them, then " \
389 390
    "enable this option.")

391
#define LOOP_TEXT N_("Loop playlist on end")
392
#define LOOP_LONGTEXT N_( \
393
    "If you want VLC to keep playing the playlist indefinitely then enable " \
394 395
    "this option.")

396
#define MEMCPY_TEXT N_("Memory copy module")
397
#define MEMCPY_LONGTEXT N_( \
398 399
    "You can select which memory copy module you want to use. By default " \
    "VLC will select the fastest one supported by your hardware.")
400

401
#define ACCESS_TEXT N_("Access module")
402 403 404
#define ACCESS_LONGTEXT N_( \
    "This is a legacy entry to let you configure access modules")

405
#define DEMUX_TEXT N_("Demux module")
406 407 408
#define DEMUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure demux modules")

gbazin's avatar
 
gbazin committed
409 410 411 412 413 414 415 416 417
#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.")

gbazin's avatar
 
gbazin committed
418
#define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
gbazin's avatar
 
gbazin committed
419 420 421 422 423 424 425
#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 " \
ipkiss's avatar
ipkiss committed
426
    "(developers only)")
gbazin's avatar
 
gbazin committed
427 428 429 430 431 432 433 434
#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.")
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 462 463 464 465 466 467 468 469 470
#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")

gbazin's avatar
 
gbazin committed
471 472 473 474 475 476 477
#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>]]" \
478
    "\n                                 UDP stream sent by a streaming server" \
gbazin's avatar
 
gbazin committed
479 480 481 482 483
    "\n  vlc:pause                      pause execution of " \
    "playlist items" \
    "\n  vlc:quit                       quit VLC" \
    "\n")

484

485 486 487
/*
 * Quick usage guide for the configuration options:
 *
488 489 490 491 492 493 494 495 496
 * 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) );
497 498
 */

499 500
vlc_module_begin();
    /* Interface options */
501
    add_category_hint( N_("Interface"), NULL, VLC_FALSE );
502
    add_module_with_short( "intf", 'I', "interface", NULL, NULL,
503 504
                           INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
    add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
505
    add_integer_with_short( "verbose", 'v', 0, NULL,
506 507
                            VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
    add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
508
    add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
509 510
    add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
    add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
511 512
    add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
    add_directory( "plugin-path", NULL, NULL,
513
                PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
514 515

    /* Audio options */
516
    add_category_hint( N_("Audio"), NULL, VLC_FALSE );
517
    add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
518 519
                           AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
    add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
520 521
    add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
                            AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
522
                            VOLUME_LONGTEXT, VLC_FALSE );
523 524
    add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
                            AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
525 526
                            VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
    add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
gbazin's avatar
 
gbazin committed
527 528 529
#if !defined( SYS_DARWIN )
    add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
#endif
530
    add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
gbazin's avatar
 
gbazin committed
531
    add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
532
    add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
zorglub's avatar
zorglub committed
533 534 535
    add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
                    AUDIO_FILTER_LONGTEXT,VLC_FALSE);
    
536
    /* Video options */
537
    add_category_hint( N_("Video"), NULL, VLC_FALSE );
538
    add_module_with_short( "vout", 'V', "video output", NULL, NULL,
539 540 541 542 543 544 545
                           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 );
    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 );
546
#ifndef SYS_DARWIN
547
    add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
548
#endif
549
    add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
550
    add_module( "filter", "video filter", NULL, NULL,
551
                FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
552
    add_string( "aspect-ratio", "", NULL,
553
                ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
554 555 556
#if 0
    add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
#endif
557 558

    /* Input options */
559
    add_category_hint( N_("Input"), NULL, VLC_FALSE );
560
    add_integer( "server-port", 1234, NULL,
561 562 563
                 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 );
564 565

    add_integer( "program", 0, NULL,
566
                 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
567
    add_integer( "audio-type", -1, NULL,
568
                 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
569
    add_integer( "audio-channel", -1, NULL,
570
                 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
571
    add_integer( "spu-channel", -1, NULL,
572
                 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
573

gbazin's avatar
 
gbazin committed
574 575
    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 );
576

577 578
    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 );
579 580

    /* Decoder options */
581 582
    add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
    add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
583

gbazin's avatar
 
gbazin committed
584
#if 0 // Encoders have been disabled for now as we are using the stream output transcoder instead
585 586 587
    add_category_hint( N_("Encoders"), NULL, VLC_TRUE );
    add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT, VLC_TRUE );
    add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT, VLC_TRUE );
gbazin's avatar
 
gbazin committed
588
#endif
589

gbazin's avatar
 
gbazin committed
590
    /* Stream output options */
591 592
    add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
    add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
593 594
    add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );

595 596
    add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
    add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT, VLC_TRUE );
597 598 599
    add_bool( "sout-abitrate", 0, NULL, SOUT_ABITRATE_TEXT, SOUT_ABITRATE_LONGTEXT, VLC_TRUE );

    add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );
600
    add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT, VLC_TRUE );
601 602
    add_bool( "sout-vbitrate", 0, NULL, SOUT_VBITRATE_TEXT, SOUT_VBITRATE_LONGTEXT, VLC_TRUE );

gbazin's avatar
 
gbazin committed
603
    add_module( "packetizer", "packetizer", NULL, NULL,
604 605
                PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
    add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
gbazin's avatar
 
gbazin committed
606
    add_module( "access_output", "sout access", NULL, NULL,
607
                ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
608
    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
609

610
    /* CPU options */
gbazin's avatar
 
gbazin committed
611
    add_category_hint( N_("CPU"), NULL, VLC_TRUE );
612
#if defined( __i386__ )
gbazin's avatar
 
gbazin committed
613 614 615 616
    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 );
617 618
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
gbazin's avatar
 
gbazin committed
619
    add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
620 621
#endif

622
    /* Playlist options */
623 624 625 626
    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 );
gbazin's avatar
 
gbazin committed
627

628
    /* Misc options */
629 630 631 632
    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 );
633

634
#if defined(WIN32)
gbazin's avatar
 
gbazin committed
635
    add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
636 637
    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 );
638
#endif
639

640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
    /* 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 );

660 661
    /* Usage (mainly useful for cmd line stuff) */
    add_usage_hint( PLAYLIST_USAGE );
662

663 664 665
    set_description( N_("main program") );
    set_capability( "main", 100 );
vlc_module_end();
666 667 668

static module_config_t p_help_config[] =
{
669
    { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
670
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
671
    { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
672
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
673
    { CONFIG_ITEM_BOOL, NULL, "list", 'l',
674
                              N_("print a list of available modules"),
675
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
676
    { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
677
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
678
    { CONFIG_ITEM_BOOL, NULL, "version", '\0',
679
                              N_("print version information"),
680
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
681
    { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
682
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
683 684 685 686 687
};

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