libvlc.h 33.8 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * libvlc.h: main libvlc header
 *****************************************************************************
 * Copyright (C) 1998-2002 VideoLAN
Gildas Bazin's avatar
 
Gildas Bazin committed
5
 * $Id: libvlc.h,v 1.89 2003/09/24 21:31:54 gbazin 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 40 41

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

42
#define INTF_TEXT N_("Interface module")
43
#define INTF_LONGTEXT N_( \
44
    "This option allows you to select the interface used by VLC. \n" \
45 46 47
    "The default behavior is to automatically select the best module " \
    "available.")

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

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

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

64 65 66 67
#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
68

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

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

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

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

90 91 92 93 94 95 96
#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.")

97
#define AOUT_TEXT N_("Audio output module")
98
#define AOUT_LONGTEXT N_( \
99
    "This option allows you to select the audio output method used by VLC. " \
100 101
    "The default behavior is to automatically select the best method " \
    "available.")
102

103
#define AUDIO_TEXT N_("Enable audio")
104 105
#define AUDIO_LONGTEXT N_( \
    "You can completely disable the audio output. In this case the audio " \
106
    "decoding will not take place, and it will save some processing power.")
107

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

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

116
#define VOLUME_SAVE_TEXT N_("Audio output saved volume")
117 118 119
#define VOLUME_SAVE_LONGTEXT N_( \
    "This saves the audio output volume when you select mute.")

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

Gildas Bazin's avatar
 
Gildas Bazin committed
125 126 127 128 129 130 131
#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

132
#define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
133 134 135 136
#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
137 138 139 140 141 142
#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)")

143
#define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
Gildas Bazin's avatar
 
Gildas Bazin committed
144 145 146 147
#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
148 149 150 151 152
#define AUDIO_FILTER_TEXT N_("Audio filters")
#define AUDIO_FILTER_LONGTEXT N_( \
    "This allows you to add audio postprocessing filters, to modify" \
    "the sound.")

153
#define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
154
#define HEADPHONE_LONGTEXT N_( \
155
    "This effect gives you the feeling that you are standing in a room " \
156 157 158 159 160 161
    "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.")

162 163 164 165 166 167 168
#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
169

170
#define VOUT_TEXT N_("Video output module")
171
#define VOUT_LONGTEXT N_( \
172
    "This option allows you to select the video output method used by VLC. " \
173 174 175
    "The default behavior is to automatically select the best " \
    "method available.")

176
#define VIDEO_TEXT N_("Enable video")
177 178
#define VIDEO_LONGTEXT N_( \
    "You can completely disable the video output. In this case the video " \
179
    "decoding stage will not take place, which will save some processing power.")
180

181
#define WIDTH_TEXT N_("Video width")
182
#define WIDTH_LONGTEXT N_( \
183
    "You can enforce the video width here. By default (-1) VLC will " \
184 185
    "adapt to the video characteristics.")

186
#define HEIGHT_TEXT N_("Video height")
187
#define HEIGHT_LONGTEXT N_( \
188
    "You can enforce the video height here. By default (-1) VLC will " \
189 190
    "adapt to the video characteristics.")

Gildas Bazin's avatar
 
Gildas Bazin committed
191 192 193 194 195 196
#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).")

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

201
#define GRAYSCALE_TEXT N_("Grayscale video output")
202 203 204 205
#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).")

206
#define FULLSCREEN_TEXT N_("Fullscreen video output")
207
#define FULLSCREEN_LONGTEXT N_( \
208
    "If this option is enabled, VLC will always start a video in fullscreen " \
209 210
    "mode.")

211
#define OVERLAY_TEXT N_("Overlay video output")
212
#define OVERLAY_LONGTEXT N_( \
213
    "If enabled, VLC will try to take advantage of the overlay capabilities " \
214
    "of your graphics card.")
215

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

221
#define FILTER_TEXT N_("Video filter module")
222 223 224 225 226
#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.")

227
#define ASPECT_RATIO_TEXT N_("Source aspect ratio")
228 229 230 231 232 233 234 235 236
#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
237
#define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
238 239 240 241 242 243 244 245
#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

246 247
#define INPUT_CAT_LONGTEXT N_( " " )

248
#define SERVER_PORT_TEXT N_("Server port")
249 250 251
#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
252
#define MTU_TEXT N_("MTU of the network interface")
Christophe Massiot's avatar
Christophe Massiot committed
253 254 255 256
#define MTU_LONGTEXT N_( \
    "This is the typical size of UDP packets that we expect. On Ethernet " \
    "it is usually 1500.")

257
#define IFACE_ADDR_TEXT N_("Network interface address")
258 259 260
#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 " \
261
    "of your multicasting interface here.")
262

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

268
#define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
269 270 271
#define INPUT_PROGRAM_LONGTEXT N_( \
    "Choose the program to select by giving its Service ID.")

272
#define INPUT_AUDIO_TEXT N_("Choose audio")
273
#define INPUT_AUDIO_LONGTEXT N_( \
274 275
    "Give the default type of audio you want to use in a DVD. " \
    "(Developers only)")
276

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

282
#define INPUT_SUBT_TEXT N_("Choose subtitles track")
283
#define INPUT_SUBT_LONGTEXT N_( \
284 285 286 287 288 289 290 291 292 293 294 295
    "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 \
    "Automatically detect a subtitle file, if no subtitle filename is" \
    "is specified."

#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."
296 297

#define DVD_DEV_TEXT N_("DVD device")
Gildas Bazin's avatar
 
Gildas Bazin committed
298 299 300 301 302
#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
303 304
#define DVD_DEV_LONGTEXT N_( \
    "This is the default DVD device to use.")
Gildas Bazin's avatar
 
Gildas Bazin committed
305
#endif
306 307 308 309 310

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

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

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

321 322 323 324 325
#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." )

326
#define CODEC_TEXT N_("Choose preferred codec list")
327
#define CODEC_LONGTEXT N_( \
328
    "This allows you to select the order in which VLC will choose its " \
329
    "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
330
    "before the new one. Please be aware that VLC does not make any " \
331 332 333
    "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.")
334

335

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

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

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

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

357
#define SOUT_VIDEO_TEXT N_("Enable video stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
358 359 360 361
#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.")

362
#define SOUT_AUDIO_TEXT N_("Enable audio stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
363 364 365 366
#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.")

367 368 369 370 371
#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)" )
372

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

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

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

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

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

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

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

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

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

415 416 417 418
#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." ) 

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

424
#define LOOP_TEXT N_("Loop playlist on end")
425
#define LOOP_LONGTEXT N_( \
426
    "If you want VLC to keep playing the playlist indefinitely then enable " \
427
    "this option.")
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
428 429 430 431 432
    
#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.")
433

434 435 436 437
#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." )

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

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
451 452 453 454 455 456 457 458 459
#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
460
#define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
461 462 463 464 465 466 467
#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 " \
468
    "(developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
469 470 471 472 473 474 475 476
#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.")
477

478 479
#define HOTKEY_CAT_LONGTEXT N_( " " )

480 481 482 483 484 485 486 487 488 489 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
#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
515 516 517 518 519 520 521
#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>]]" \
522
    "\n                                 UDP stream sent by a streaming server" \
Gildas Bazin's avatar
 
Gildas Bazin committed
523 524 525 526 527
    "\n  vlc:pause                      pause execution of " \
    "playlist items" \
    "\n  vlc:quit                       quit VLC" \
    "\n")

528

529 530 531
/*
 * Quick usage guide for the configuration options:
 *
532 533 534 535 536 537 538 539 540
 * 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) );
541 542
 */

543 544
vlc_module_begin();
    /* Interface options */
545
    add_category_hint( N_("Interface"), INTF_CAT_LONGTEXT , VLC_FALSE );
546
    add_module_with_short( "intf", 'I', "interface", NULL, NULL,
547
                           INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
548 549
    add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, 
                     EXTRAINTF_LONGTEXT, VLC_FALSE );
550
    add_integer_with_short( "verbose", 'v', 0, NULL,
551
                            VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
552 553 554 555
    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 );
556
    add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
557 558 559 560
    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 );
561
    add_directory( "plugin-path", NULL, NULL,
562
                PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
563 564

    /* Audio options */
565
    add_category_hint( N_("Audio"), AOUT_CAT_LONGTEXT , VLC_FALSE );
566
    add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
567 568
                           AOUT_TEXT, AOUT_LONGTEXT, VLC_TRUE);
    add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_FALSE );
569 570
    add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
                            AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
571
                            VOLUME_LONGTEXT, VLC_FALSE );
572 573
    add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
                            AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
574 575
                            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
576 577 578
#if !defined( SYS_DARWIN )
    add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
#endif
579
    add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
580
    add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
581 582 583 584
#if 0
    add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, 
                        HEADPHONE_LONGTEXT, VLC_FALSE );
#endif
Clément Stenac's avatar
Clément Stenac committed
585 586 587
    add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
                    AUDIO_FILTER_LONGTEXT,VLC_FALSE);
    
588
    /* Video options */
589
    add_category_hint( N_("Video"), VOUT_CAT_LONGTEXT , VLC_FALSE );
590
    add_module_with_short( "vout", 'V', "video output", NULL, NULL,
591
                           VOUT_TEXT, VOUT_LONGTEXT, VLC_TRUE );
592 593 594
    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
595
    add_integer( "align", -1, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
596 597
    add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
    add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
598 599
    add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, 
                        FULLSCREEN_LONGTEXT, VLC_FALSE );
600
#ifndef SYS_DARWIN
601
    add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
602
#endif
603 604
    add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, 
                        SPUMARGIN_LONGTEXT, VLC_TRUE );
605
    add_module( "filter", "video filter", NULL, NULL,
606
                FILTER_TEXT, FILTER_LONGTEXT, VLC_FALSE );
607
    add_string( "aspect-ratio", "", NULL,
608
                ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
609 610 611
#if 0
    add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
#endif
612 613

    /* Input options */
614
    add_category_hint( N_("Input"), INPUT_CAT_LONGTEXT , VLC_FALSE );
615
    add_integer( "server-port", 1234, NULL,
616 617 618
                 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 );
619 620

    add_integer( "program", 0, NULL,
621
                 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
622
    add_integer( "audio-type", -1, NULL,
623
                 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
624
    add_integer( "audio-channel", -1, NULL,
625
                 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
626
    add_integer( "spu-channel", -1, NULL,
627
                 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
628 629 630 631 632
    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 );

633

Gildas Bazin's avatar
 
Gildas Bazin committed
634 635
    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 );
636

637 638
    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 );
639 640

    /* Decoder options */
641
    add_category_hint( N_("Decoders"), CODEC_CAT_LONGTEXT , VLC_TRUE );
642
    add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
643

644

Gildas Bazin's avatar
 
Gildas Bazin committed
645
    /* Stream output options */
646
    add_category_hint( N_("Stream output"), SOUT_CAT_LONGTEXT , VLC_TRUE );
647
    add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
648 649 650 651
    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 );
652

653 654 655 656
    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 );
657

Gildas Bazin's avatar
 
Gildas Bazin committed
658
    add_module( "packetizer", "packetizer", NULL, NULL,
659
                PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
660 661
    add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, 
                                MUX_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
662
    add_module( "access_output", "sout access", NULL, NULL,
663
                ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
664
    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
665

666

667
    /* CPU options */
668
    add_category_hint( N_("CPU"), CPU_CAT_LONGTEXT, VLC_TRUE );
669
#if defined( __i386__ )
Gildas Bazin's avatar
 
Gildas Bazin committed
670 671 672 673
    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 );
674 675
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
Gildas Bazin's avatar
 
Gildas Bazin committed
676
    add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
677 678
#endif

679
    /* Playlist options */
680 681 682
    add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
    add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, 
                                RANDOM_LONGTEXT, VLC_FALSE );
683 684
    add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
    add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
685
    add_bool( "repeat", 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
686

687
    /* Misc options */
688
    add_category_hint( N_("Miscellaneous"), MISC_CAT_LONGTEXT, VLC_TRUE );
689 690 691
    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 );
692

693
#if defined(WIN32)
Gildas Bazin's avatar
 
Gildas Bazin committed
694
    add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
695 696
    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 );
697
#endif
698

699
    /* Hotkey options*/
700
    add_category_hint( N_("Hot keys"), HOTKEY_CAT_LONGTEXT , VLC_FALSE );
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
    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 );

719 720
    /* Usage (mainly useful for cmd line stuff) */
    add_usage_hint( PLAYLIST_USAGE );
721

722 723 724
    set_description( N_("main program") );
    set_capability( "main", 100 );
vlc_module_end();
725 726 727

static module_config_t p_help_config[] =
{
Gildas Bazin's avatar
 
Gildas Bazin committed
728 729 730 731
    { 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)") },
732
    { CONFIG_ITEM_BOOL, NULL, "list", 'l',
Gildas Bazin's avatar
 
Gildas Bazin committed
733 734 735 736 737 738 739 740 741
      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") },
742
    { CONFIG_ITEM_BOOL, NULL, "version", '\0',
Gildas Bazin's avatar
 
Gildas Bazin committed
743 744
      N_("print version information") },
    { CONFIG_HINT_END, NULL, NULL, '\0', NULL }
745 746 747 748 749
};

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