libvlc.h 41.3 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * libvlc.h: main libvlc header
 *****************************************************************************
 * Copyright (C) 1998-2002 VideoLAN
5
 * $Id: libvlc.h,v 1.109 2003/11/27 05:46:01 fenrir 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[] =
30 31 32
{ "auto", "en", "en_GB", "es", "de",
  "fr", "hu", "it", "ja", "nl", "no",
  "pl", "pt_BR", "ru", "sv" };
33 34
static char *ppsz_language_text[] =
{ N_("Auto"), N_("English US"), N_("English GB"), N_("Spanish"), N_("German"),
35 36
  N_("French"), N_("Hungarian"), N_("Italian"), N_("Japanese"), N_("Dutch"), N_("Norwegian"),
  N_("Polish"), N_("Portuguese BR"), N_("Russian"), N_("Swedish") };
37

38 39 40 41 42 43
/*****************************************************************************
 * 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.
 *****************************************************************************/
44 45

#define INTF_CAT_LONGTEXT N_( \
46
    "These options allow you to configure the interfaces used by VLC.\n" \
Gildas Bazin's avatar
 
Gildas Bazin committed
47
    "You can select the main interface, additional " \
48
    "interface modules, and define various related options." )
49

50
#define INTF_TEXT N_("Interface module")
51
#define INTF_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
52
    "This option allows you to select the interface used by VLC.\n" \
53 54 55
    "The default behavior is to automatically select the best module " \
    "available.")

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

63
#define VERBOSE_TEXT N_("Verbosity (0,1,2)")
64
#define VERBOSE_LONGTEXT N_( \
65
    "This options sets the verbosity level (0=only errors and " \
66
    "standard messages, 1=warnings, 2=debug).")
67

68
#define QUIET_TEXT N_("Be quiet")
69 70 71
#define QUIET_LONGTEXT N_( \
    "This options turns off all warning and information messages.")

72 73 74 75
#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
76

77
#define COLOR_TEXT N_("Color messages")
78 79 80 81
#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.")

82
#define ADVANCED_TEXT N_("Show advanced options")
83
#define ADVANCED_LONGTEXT N_( \
84 85 86
    "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")
87

88
#define INTF_PATH_TEXT N_("Interface default search path")
89 90 91 92
#define INTF_PATH_LONGTEXT N_( \
    "This option allows you to set the default path that the interface will " \
    "open when looking for a file.")

93
#define PLUGIN_PATH_TEXT N_("Plugin search path")
94
#define PLUGIN_PATH_LONGTEXT N_( \
95
    "This option allows you to specify an additional path for VLC to look " \
96 97
    "for its plugins.")

98
#define AOUT_CAT_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
99 100 101 102
    "These options allow you to tune VLC's audio subsystem, " \
    "and to add audio filters which can be used for " \
    "postprocessing or visual effects (spectrum analyser,...).\n" \
    "To tune these filters, have a look at the \"audio filter\" " \
103 104
    "plugin options.")

105
#define AOUT_TEXT N_("Audio output module")
106
#define AOUT_LONGTEXT N_( \
107
    "This option allows you to select the audio output method used by VLC. " \
108 109
    "The default behavior is to automatically select the best method " \
    "available.")
110

111
#define AUDIO_TEXT N_("Enable audio")
112 113
#define AUDIO_LONGTEXT N_( \
    "You can completely disable the audio output. In this case the audio " \
114
    "decoding will not take place, and it will save some processing power.")
115

116
#define MONO_TEXT N_("Force mono audio")
117 118
#define MONO_LONGTEXT N_("This will force a mono audio output")

119
#define VOLUME_TEXT N_("Audio output volume")
120 121 122 123
#define VOLUME_LONGTEXT N_( \
    "You can set the default audio output volume here, in a range from 0 to " \
    "1024.")

124
#define VOLUME_SAVE_TEXT N_("Audio output saved volume")
125 126 127
#define VOLUME_SAVE_LONGTEXT N_( \
    "This saves the audio output volume when you select mute.")

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

Gildas Bazin's avatar
 
Gildas Bazin committed
133 134 135 136 137 138 139
#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

140
#define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
141 142 143 144
#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
145 146 147 148 149 150
#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)")

151
#define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
Gildas Bazin's avatar
 
Gildas Bazin committed
152 153 154 155
#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
156 157
#define AUDIO_FILTER_TEXT N_("Audio filters")
#define AUDIO_FILTER_LONGTEXT N_( \
158
    "This allows you to add audio postprocessing filters, to modify " \
Clément Stenac's avatar
Clément Stenac committed
159 160
    "the sound.")

161
#define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
162
#define HEADPHONE_LONGTEXT N_( \
163
    "This effect gives you the feeling that you are standing in a room " \
164 165 166 167 168 169
    "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.")

170
#define VOUT_CAT_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
171 172 173 174 175
    "These options allow you to modify options related to " \
    "the video output subsystem. You can for example enable " \
    "video filters, like deinterlacing, constrast / hue / " \
    "saturation adjusting, ...\n" \
    "Enable these filters here and configure them in the video " \
176
    "filters plugins section." )
Clément Stenac's avatar
Clément Stenac committed
177

178
#define VOUT_TEXT N_("Video output module")
179
#define VOUT_LONGTEXT N_( \
180
    "This option allows you to select the video output method used by VLC. " \
181 182 183
    "The default behavior is to automatically select the best " \
    "method available.")

184
#define VIDEO_TEXT N_("Enable video")
185 186
#define VIDEO_LONGTEXT N_( \
    "You can completely disable the video output. In this case the video " \
187
    "decoding stage will not take place, which will save some processing power.")
188

189
#define WIDTH_TEXT N_("Video width")
190
#define WIDTH_LONGTEXT N_( \
191
    "You can enforce the video width here. By default (-1) VLC will " \
192 193
    "adapt to the video characteristics.")

194
#define HEIGHT_TEXT N_("Video height")
195
#define HEIGHT_LONGTEXT N_( \
196
    "You can enforce the video height here. By default (-1) VLC will " \
197 198
    "adapt to the video characteristics.")

Gildas Bazin's avatar
 
Gildas Bazin committed
199 200 201 202 203 204
#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).")

205
#define ZOOM_TEXT N_("Zoom video")
206 207 208
#define ZOOM_LONGTEXT N_( \
    "You can zoom the video by the specified factor.")

209
#define GRAYSCALE_TEXT N_("Grayscale video output")
210 211 212 213
#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).")

214
#define FULLSCREEN_TEXT N_("Fullscreen video output")
215
#define FULLSCREEN_LONGTEXT N_( \
216
    "If this option is enabled, VLC will always start a video in fullscreen " \
217 218
    "mode.")

219
#define OVERLAY_TEXT N_("Overlay video output")
220
#define OVERLAY_LONGTEXT N_( \
221
    "If enabled, VLC will try to take advantage of the overlay capabilities " \
222
    "of your graphics card.")
223

224
#define SPUMARGIN_TEXT N_("Force SPU position")
225 226 227 228
#define SPUMARGIN_LONGTEXT N_( \
    "You can use this option to place the subtitles under the movie, " \
    "instead of over the movie. Try several positions.")

229 230 231 232
#define OSD_TEXT N_("On Screen Display")
#define OSD_LONGTEXT N_( \
    "You can disable the messages VLC creates in the video.")

233
#define FILTER_TEXT N_("Video filter module")
234 235 236 237 238
#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.")

239
#define ASPECT_RATIO_TEXT N_("Source aspect ratio")
240 241 242 243 244 245 246 247 248
#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
249
#define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
250 251 252 253 254 255 256 257
#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

258 259
#define INPUT_CAT_LONGTEXT N_( " " )

260
#define SERVER_PORT_TEXT N_("Server port")
261 262 263
#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
264
#define MTU_TEXT N_("MTU of the network interface")
Christophe Massiot's avatar
Christophe Massiot committed
265 266 267 268
#define MTU_LONGTEXT N_( \
    "This is the typical size of UDP packets that we expect. On Ethernet " \
    "it is usually 1500.")

269
#define IFACE_ADDR_TEXT N_("Network interface address")
270 271 272
#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 " \
273
    "of your multicasting interface here.")
274

275
#define TTL_TEXT N_("Time to live")
276 277 278 279
#define TTL_LONGTEXT N_( \
    "Indicate here the Time To Live of the multicast packets sent by " \
    "the stream output.")

280
#define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
281 282 283
#define INPUT_PROGRAM_LONGTEXT N_( \
    "Choose the program to select by giving its Service ID.")

284
#define INPUT_AUDIO_TEXT N_("Choose audio")
285
#define INPUT_AUDIO_LONGTEXT N_( \
286 287
    "Give the default type of audio you want to use in a DVD. " \
    "(Developers only)")
288

289
#define INPUT_CHAN_TEXT N_("Choose channel")
290 291 292 293
#define INPUT_CHAN_LONGTEXT N_( \
    "Give the stream number of the audio channel you want to use in a DVD " \
    "(from 1 to n).")

294
#define INPUT_SUBT_TEXT N_("Choose subtitles track")
295
#define INPUT_SUBT_LONGTEXT N_( \
296 297 298 299 300
    "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 \
301 302
    "Automatically detect a subtitle file, if no subtitle filename is " \
    "specified."
303

304 305 306 307 308 309 310 311 312 313
#define SUB_FUZZY_TEXT N_("Subtitle autodection fuzziness")
#define SUB_FUZZY_LONGTEXT \
    "This determines how fuzzy subtitle and movie filenaming matching " \
    "will be. Options are:\n" \
    "0 = no subtitles autodetected\n" \
    "1 = any subtitle file\n" \
    "2 = any subtitle file containing the movie name\n" \
    "3 = subtitle file matching the movie name with additional chars\n" \
    "4 = subtitle file matching the movie name exactly"

314 315 316 317
#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."
318 319

#define DVD_DEV_TEXT N_("DVD device")
Gildas Bazin's avatar
 
Gildas Bazin committed
320 321 322 323 324
#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
325 326
#define DVD_DEV_LONGTEXT N_( \
    "This is the default DVD device to use.")
Gildas Bazin's avatar
 
Gildas Bazin committed
327
#endif
328 329 330 331 332

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

333
#define IPV6_TEXT N_("Force IPv6")
334 335 336 337
#define IPV6_LONGTEXT N_( \
    "If you check this box, IPv6 will be used by default for all UDP and " \
    "HTTP connections.")

338
#define IPV4_TEXT N_("Force IPv4")
339 340 341 342
#define IPV4_LONGTEXT N_( \
    "If you check this box, IPv4 will be used by default for all UDP and " \
    "HTTP connections.")

343
#define CODEC_CAT_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
344 345
    "This option can be used to alter the way VLC selects " \
    "its codecs (decompression methods). Only advanced users should " \
346 347
    "alter this option as it can break playback of all your streams." )

Gildas Bazin's avatar
 
Gildas Bazin committed
348
#define CODEC_TEXT N_("Choose preferred codecs list")
349
#define CODEC_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
350 351 352
    "This allows you to select a list of codecs that VLC will use in " \
    "priority. For instance, 'dummy,a52' will try the dummy and a52 codecs " \
    "before trying the other ones.")
353

Gildas Bazin's avatar
 
Gildas Bazin committed
354 355 356 357
#define ENCODER_TEXT N_("Choose preferred encoders list")
#define ENCODER_LONGTEXT N_( \
    "This allows you to select a list of encoders that VLC will use in " \
    "priority")
358

359
#define SOUT_CAT_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
360
    "These options allow you to set default global options for the " \
361 362
    "stream output subsystem." )

363
#define SOUT_TEXT N_("Choose a stream output")
364 365
#define SOUT_LONGTEXT N_( \
    "Empty if no stream output.")
Gildas Bazin's avatar
 
Gildas Bazin committed
366

367 368 369 370
#define SOUT_ALL_TEXT N_("Enable streaming of all ES")
#define SOUT_ALL_LONGTEXT N_( \
    "This allows you to stream all ES (video, audio and subtitles)")

371
#define SOUT_DISPLAY_TEXT N_("Display while streaming")
372 373 374
#define SOUT_DISPLAY_LONGTEXT N_( \
    "This allows you to play the stream while streaming it.")

375
#define SOUT_VIDEO_TEXT N_("Enable video stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
376 377 378 379
#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.")

380
#define SOUT_AUDIO_TEXT N_("Enable audio stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
381 382 383 384
#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.")

385 386 387 388 389
#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)" )
390

391
#define PACKETIZER_TEXT N_("Choose preferred packetizer list")
392
#define PACKETIZER_LONGTEXT N_( \
393
    "This allows you to select the order in which VLC will choose its " \
394
    "packetizers."  )
Gildas Bazin's avatar
 
Gildas Bazin committed
395

396
#define MUX_TEXT N_("Mux module")
397 398
#define MUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure mux modules")
Gildas Bazin's avatar
 
Gildas Bazin committed
399

400
#define ACCESS_OUTPUT_TEXT N_("Access output module")
401 402 403
#define ACCESS_OUTPUT_LONGTEXT N_( \
    "This is a legacy entry to let you configure access output modules")

404
#define CPU_CAT_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
405 406
    "These options allow you to enable special CPU optimizations.\n" \
    "You should always leave all these enabled." )
407

408
#define MMX_TEXT N_("Enable CPU MMX support")
409
#define MMX_LONGTEXT N_( \
410
    "If your processor supports the MMX instructions set, VLC can take " \
411 412
    "advantage of them.")

413
#define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
414
#define THREE_DN_LONGTEXT N_( \
415
    "If your processor supports the 3D Now! instructions set, VLC can take " \
416 417
    "advantage of them.")

418
#define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
419
#define MMXEXT_LONGTEXT N_( \
420
    "If your processor supports the MMX EXT instructions set, VLC can take " \
421 422
    "advantage of them.")

423
#define SSE_TEXT N_("Enable CPU SSE support")
424
#define SSE_LONGTEXT N_( \
425
    "If your processor supports the SSE instructions set, VLC can take " \
426
    "advantage of them.")
427

428
#define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
429
#define ALTIVEC_LONGTEXT N_( \
430
    "If your processor supports the AltiVec instructions set, VLC can take " \
431 432
    "advantage of them.")

433
#define PLAYLIST_CAT_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
434
     "These options define the behaviour of the playlist. Some " \
435
     "of them can be overriden in the playlist dialog box." )
436

437
#define RANDOM_TEXT N_("Play files randomly forever")
438
#define RANDOM_LONGTEXT N_( \
439
    "When selected, VLC will randomly play files in the playlist until " \
440 441
    "interrupted.")

442
#define LOOP_TEXT N_("Loop playlist on end")
443
#define LOOP_LONGTEXT N_( \
444
    "If you want VLC to keep playing the playlist indefinitely then enable " \
445
    "this option.")
446

Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
447 448 449 450
#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.")
451

452
#define MISC_CAT_LONGTEXT N_( \
Gildas Bazin's avatar
 
Gildas Bazin committed
453
    "These options allow you to select default modules. Leave these " \
454 455
    "alone unless you really know what you are doing." )

456
#define MEMCPY_TEXT N_("Memory copy module")
457
#define MEMCPY_LONGTEXT N_( \
458 459
    "You can select which memory copy module you want to use. By default " \
    "VLC will select the fastest one supported by your hardware.")
460

461
#define ACCESS_TEXT N_("Access module")
462 463 464
#define ACCESS_LONGTEXT N_( \
    "This is a legacy entry to let you configure access modules")

465
#define DEMUX_TEXT N_("Demux module")
466 467 468
#define DEMUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure demux modules")

469 470 471 472 473 474 475 476
#define RT_PRIORITY_TEXT N_("Allow VLC to run with a real-time priority")
#define RT_PRIORITY_LONGTEXT N_( \
    "Running VLC in real-time priority will allow for much more precise " \
    "scheduling and yield better, especially when streaming content. " \
    "It can however lock up your whole machine, or make it very very " \
    "slow. You should only activate this if you know what you're " \
    "doing.")

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

Gildas Bazin's avatar
 
Gildas Bazin committed
485 486 487 488 489 490 491 492 493
#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
494
#define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
495 496 497 498 499 500 501
#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 " \
502
    "(developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
503 504 505 506 507 508 509 510
#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.")
511

512 513
#define HOTKEY_CAT_LONGTEXT N_( " " )

514 515
#define FULLSCREEN_KEY_TEXT N_("Fullscreen")
#define FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to swap fullscreen state")
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
516
#define PLAY_PAUSE_KEY_TEXT N_("Play/Pause")
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
#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")
Gildas Bazin's avatar
 
Gildas Bazin committed
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548

#define JB10SEC_KEY_TEXT N_("Jump backward 10 seconds")
#define JB10SEC_KEY_LONGTEXT N_("Select the hotkey to jump backward by 10 seconds")

#define JB1MIN_KEY_TEXT N_("Jump backward 1 minute")
#define JB1MIN_KEY_LONGTEXT N_("Select the hotkey to jump backward by 1 minute")
#define JB5MIN_KEY_TEXT N_("Jump backward 5 minutes")
#define JB5MIN_KEY_LONGTEXT N_("Select the hotkey to jump backward by 5 minutes")
#define JF10SEC_KEY_TEXT N_("Jump forward 10 seconds")
#define JF10SEC_KEY_LONGTEXT N_("Select the hotkey to jump forward by 10 seconds")

#define JF1MIN_KEY_TEXT N_("Jump forward 1 minute")
#define JF1MIN_KEY_LONGTEXT N_("Select the hotkey to jump forward by 1 minute")

#define JF5MIN_KEY_TEXT N_("Jump forward 5 minutes")
#define JF5MIN_KEY_LONGTEXT N_("Select the hotkey to jump forward by 5 minutes")

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
#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
566 567 568 569 570 571 572
#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>]]" \
573
    "\n                                 UDP stream sent by a streaming server" \
Gildas Bazin's avatar
 
Gildas Bazin committed
574 575 576 577 578
    "\n  vlc:pause                      pause execution of " \
    "playlist items" \
    "\n  vlc:quit                       quit VLC" \
    "\n")

579

580 581 582
/*
 * Quick usage guide for the configuration options:
 *
583 584 585 586 587 588 589 590 591
 * 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) );
592 593
 */

594 595
vlc_module_begin();
    /* Interface options */
596
    add_category_hint( N_("Interface"), INTF_CAT_LONGTEXT , VLC_FALSE );
597 598 599
    add_module( "intf", "interface", NULL, NULL, INTF_TEXT,
                INTF_LONGTEXT, VLC_TRUE );
        change_short('I');
600
    add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT,
601
                     EXTRAINTF_LONGTEXT, VLC_FALSE );
602 603 604 605 606 607 608 609
    add_integer( "verbose", 0, NULL, VERBOSE_TEXT, VERBOSE_LONGTEXT,
                 VLC_FALSE );
        change_short('v');
    add_bool( "quiet", 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
        change_short('q');
    add_string( "language", "auto", NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT,
                VLC_FALSE );
        change_string_list( ppsz_language, ppsz_language_text, 0 );
610
    add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
611
    add_bool( "advanced", 0, NULL, ADVANCED_TEXT,
612
                            ADVANCED_LONGTEXT, VLC_FALSE );
613
    add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT,
614
                            INTF_PATH_LONGTEXT, VLC_TRUE );
615
    add_directory( "plugin-path", NULL, NULL,
616
                PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
617 618

    /* Audio options */
619
    add_category_hint( N_("Audio"), AOUT_CAT_LONGTEXT , VLC_FALSE );
620 621 622
    add_module( "aout", "audio output", NULL, NULL, AOUT_TEXT, AOUT_LONGTEXT,
                VLC_TRUE );
        change_short('A');
623
    add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_FALSE );
624 625
    add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
                            AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
626
                            VOLUME_LONGTEXT, VLC_FALSE );
627 628
    add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
                            AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
629 630
                            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
631 632 633
#if !defined( SYS_DARWIN )
    add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
#endif
Gildas Bazin's avatar
 
Gildas Bazin committed
634
    add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
635
#if 0
636
    add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT,
637 638
                        HEADPHONE_LONGTEXT, VLC_FALSE );
#endif
Gildas Bazin's avatar
 
Gildas Bazin committed
639
    add_integer( "audio-desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
Clément Stenac's avatar
Clément Stenac committed
640 641
    add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
                    AUDIO_FILTER_LONGTEXT,VLC_FALSE);
642

643
    /* Video options */
644
    add_category_hint( N_("Video"), VOUT_CAT_LONGTEXT , VLC_FALSE );
645 646 647
    add_module( "vout", "video output", NULL, NULL, VOUT_TEXT, VOUT_LONGTEXT,
                VLC_TRUE );
        change_short('V');
648 649 650
    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
651
    add_integer( "align", -1, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
652 653
    add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
    add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
654
    add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT,
655
                        FULLSCREEN_LONGTEXT, VLC_FALSE );
656
#ifndef SYS_DARWIN
657
    add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
658
#endif
659
    add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT,
660
                        SPUMARGIN_LONGTEXT, VLC_TRUE );
661
    add_bool( "osd", 1, NULL, OSD_TEXT, OSD_LONGTEXT, VLC_FALSE );
662
    add_module( "filter", "video filter", NULL, NULL,
663
                FILTER_TEXT, FILTER_LONGTEXT, VLC_FALSE );
664
    add_string( "aspect-ratio", "", NULL,
665
                ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
666 667 668
#if 0
    add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
#endif
669 670

    /* Input options */
671
    add_category_hint( N_("Input"), INPUT_CAT_LONGTEXT , VLC_FALSE );
672
    add_integer( "server-port", 1234, NULL,
673 674 675
                 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 );
676 677

    add_integer( "program", 0, NULL,
678
                 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
679
    add_integer( "audio-type", -1, NULL,
680
                 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
681
    add_integer( "audio-channel", -1, NULL,
682
                 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
683
    add_integer( "spu-channel", -1, NULL,
684
                 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
685 686
    add_bool( "sub-autodetect-file", VLC_TRUE, NULL,
                 SUB_AUTO_TEXT, SUB_AUTO_LONGTEXT, VLC_FALSE );
687 688
    add_integer( "sub-autodetect-fuzzy", 3, NULL,
                 SUB_FUZZY_TEXT, SUB_FUZZY_LONGTEXT, VLC_TRUE );
689 690 691
    add_file( "sub-file", NULL, NULL,
                 SUB_FILE_TEXT, SUB_FILE_LONGTEXT, VLC_TRUE );

692

Gildas Bazin's avatar
 
Gildas Bazin committed
693 694
    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 );
695

696 697 698 699
    add_bool( "ipv6", 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
        change_short('6');
    add_bool( "ipv4", 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
        change_short('4');
700 701

    /* Decoder options */
702
    add_category_hint( N_("Decoders"), CODEC_CAT_LONGTEXT , VLC_TRUE );
703
    add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
704
    add_module( "encoder", "encoder", NULL, NULL, ENCODER_TEXT, ENCODER_LONGTEXT, VLC_TRUE );
705

706

Gildas Bazin's avatar
 
Gildas Bazin committed
707
    /* Stream output options */
708
    add_category_hint( N_("Stream output"), SOUT_CAT_LONGTEXT , VLC_TRUE );
709
    add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
710
    add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT,
711
                                SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
712
    add_bool( "sout-keep", VLC_FALSE, NULL, SOUT_KEEP_TEXT,
713
                                SOUT_KEEP_LONGTEXT, VLC_TRUE );
714 715
    add_bool( "sout-all", 0, NULL, SOUT_ALL_TEXT,
                                SOUT_ALL_LONGTEXT, VLC_TRUE );
716
    add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT,
717
                                SOUT_AUDIO_LONGTEXT, VLC_TRUE );
718
    add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT,
719
                                SOUT_VIDEO_LONGTEXT, VLC_TRUE );
720

Gildas Bazin's avatar
 
Gildas Bazin committed
721
    add_module( "packetizer", "packetizer", NULL, NULL,
722
                PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
723
    add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT,
724
                                MUX_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
725
    add_module( "access_output", "sout access", NULL, NULL,
726
                ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
727
    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
728

729

730
    /* CPU options */
731
    add_category_hint( N_("CPU"), CPU_CAT_LONGTEXT, VLC_TRUE );
732
#if defined( __i386__ )
Gildas Bazin's avatar
 
Gildas Bazin committed
733 734 735 736
    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 );
737 738
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
Gildas Bazin's avatar
 
Gildas Bazin committed
739
    add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
740 741
#endif

742
    /* Playlist options */
743
    add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
744 745 746 747 748 749
    add_bool( "random", 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
        change_short('Z');
    add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
        change_short('L');
    add_bool( "repeat", 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
        change_short('R');
Gildas Bazin's avatar
 
Gildas Bazin committed
750

751
    /* Misc options */
752
    add_category_hint( N_("Miscellaneous"), MISC_CAT_LONGTEXT, VLC_TRUE );
753 754 755
    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 );
756

757
#if !defined(SYS_DARWIN) && !defined(SYS_BEOS) && defined(PTHREAD_COND_T_IN_PTHREAD_H)
758 759 760
    add_bool( "rt-priority", 0, NULL, RT_PRIORITY_TEXT, RT_PRIORITY_LONGTEXT, VLC_TRUE );
#endif

761
#if defined(WIN32)
Gildas Bazin's avatar
 
Gildas Bazin committed
762
    add_bool( "one-instance", 0, NULL, ONEINSTANCE_TEXT, ONEINSTANCE_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
763
    add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
764 765
    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 );
766
#endif
767

768
    /* Hotkey options*/
769
    add_category_hint( N_("Hot keys"), HOTKEY_CAT_LONGTEXT , VLC_FALSE );
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
#if defined(SYS_DARWIN)
    add_key( "key-fullscreen", KEY_MODIFIER_COMMAND|'f', NULL, FULLSCREEN_KEY_TEXT, FULLSCREEN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-play-pause", KEY_MODIFIER_COMMAND|'p', NULL, PLAY_PAUSE_KEY_TEXT, PLAY_PAUSE_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-pause", 0, NULL, PAUSE_KEY_TEXT, PAUSE_KEY_LONGTEXT, VLC_TRUE );
    add_key( "key-play", 0, NULL, PLAY_KEY_TEXT, PLAY_KEY_LONGTEXT, VLC_TRUE );
    add_key( "key-faster", KEY_MODIFIER_COMMAND|'=', NULL, FASTER_KEY_TEXT, FASTER_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-slower", KEY_MODIFIER_COMMAND|'-', NULL, SLOWER_KEY_TEXT, SLOWER_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-next", KEY_MODIFIER_COMMAND|KEY_RIGHT, NULL, NEXT_KEY_TEXT, NEXT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-prev", KEY_MODIFIER_COMMAND|KEY_LEFT, NULL, PREV_KEY_TEXT, PREV_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-stop", KEY_MODIFIER_COMMAND|'.', NULL, STOP_KEY_TEXT, STOP_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump-10sec", KEY_MODIFIER_COMMAND|KEY_MODIFIER_ALT|KEY_LEFT, NULL, JB10SEC_KEY_TEXT, JB10SEC_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump+10sec", KEY_MODIFIER_COMMAND|KEY_MODIFIER_ALT|KEY_RIGHT, NULL, JF10SEC_KEY_TEXT, JF10SEC_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump-1min", KEY_MODIFIER_COMMAND|KEY_MODIFIER_SHIFT|KEY_LEFT, NULL, JB1MIN_KEY_TEXT, JB1MIN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump+1min", KEY_MODIFIER_COMMAND|KEY_MODIFIER_SHIFT|KEY_RIGHT, NULL, JF1MIN_KEY_TEXT, JF1MIN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump-5min", KEY_MODIFIER_COMMAND|KEY_MODIFIER_SHIFT|KEY_MODIFIER_ALT|KEY_LEFT, NULL, JB5MIN_KEY_TEXT, JB5MIN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump+5min", KEY_MODIFIER_COMMAND|KEY_MODIFIER_SHIFT|KEY_MODIFIER_ALT|KEY_RIGHT, NULL, JF5MIN_KEY_TEXT, JF5MIN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-activate", KEY_ENTER, NULL, NAV_ACTIVATE_KEY_TEXT, NAV_ACTIVATE_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-up", KEY_UP, NULL, NAV_UP_KEY_TEXT, NAV_UP_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-down", KEY_DOWN, NULL, NAV_DOWN_KEY_TEXT, NAV_DOWN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-left", KEY_LEFT, NULL, NAV_LEFT_KEY_TEXT, NAV_LEFT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-right", KEY_RIGHT, NULL, NAV_RIGHT_KEY_TEXT, NAV_RIGHT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-quit", KEY_MODIFIER_COMMAND|'q', NULL, QUIT_KEY_TEXT, QUIT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-vol-up", KEY_MODIFIER_COMMAND|KEY_UP, NULL, VOL_UP_KEY_TEXT, VOL_UP_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-vol-down", KEY_MODIFIER_COMMAND|KEY_DOWN, NULL, VOL_DOWN_KEY_TEXT, VOL_DOWN_KEY_LONGTEXT, VLC_FALSE );
#else
Gildas Bazin's avatar
 
Gildas Bazin committed
795 796 797 798 799 800 801 802 803
    add_key( "key-fullscreen", 'f', NULL, FULLSCREEN_KEY_TEXT, FULLSCREEN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-play-pause", KEY_SPACE, NULL, PLAY_PAUSE_KEY_TEXT, PLAY_PAUSE_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-pause", 0, NULL, PAUSE_KEY_TEXT, PAUSE_KEY_LONGTEXT, VLC_TRUE );
    add_key( "key-play", 0, NULL, PLAY_KEY_TEXT, PLAY_KEY_LONGTEXT, VLC_TRUE );
    add_key( "key-faster", '+', NULL, FASTER_KEY_TEXT, FASTER_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-slower", '-', NULL, SLOWER_KEY_TEXT, SLOWER_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-next", 'n', NULL, NEXT_KEY_TEXT, NEXT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-prev", 'p', NULL, PREV_KEY_TEXT, PREV_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-stop", 's', NULL, STOP_KEY_TEXT, STOP_KEY_LONGTEXT, VLC_FALSE );
Gildas Bazin's avatar
 
Gildas Bazin committed
804 805 806 807 808 809
    add_key( "key-jump-10sec", KEY_MODIFIER_ALT|KEY_LEFT, NULL, JB10SEC_KEY_TEXT, JB10SEC_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump+10sec", KEY_MODIFIER_ALT|KEY_RIGHT, NULL, JF10SEC_KEY_TEXT, JF10SEC_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump-1min", KEY_MODIFIER_CTRL|KEY_LEFT, NULL, JB1MIN_KEY_TEXT, JB1MIN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump+1min", KEY_MODIFIER_CTRL|KEY_RIGHT, NULL, JF1MIN_KEY_TEXT, JF1MIN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump-5min", KEY_MODIFIER_CTRL|KEY_MODIFIER_ALT|KEY_LEFT, NULL, JB5MIN_KEY_TEXT, JB5MIN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-jump+5min", KEY_MODIFIER_CTRL|KEY_MODIFIER_ALT|KEY_RIGHT, NULL, JF5MIN_KEY_TEXT, JF5MIN_KEY_LONGTEXT, VLC_FALSE );
Gildas Bazin's avatar
 
Gildas Bazin committed
810 811 812 813 814
    add_key( "key-nav-activate", KEY_ENTER, NULL, NAV_ACTIVATE_KEY_TEXT, NAV_ACTIVATE_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-up", KEY_UP, NULL, NAV_UP_KEY_TEXT, NAV_UP_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-down", KEY_DOWN, NULL, NAV_DOWN_KEY_TEXT, NAV_DOWN_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-left", KEY_LEFT, NULL, NAV_LEFT_KEY_TEXT, NAV_LEFT_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-nav-right", KEY_RIGHT, NULL, NAV_RIGHT_KEY_TEXT, NAV_RIGHT_KEY_LONGTEXT, VLC_FALSE );
815
    add_key( "key-quit", KEY_MODIFIER_CTRL|'q', NULL, QUIT_KEY_TEXT, QUIT_KEY_LONGTEXT, VLC_FALSE );
Gildas Bazin's avatar
 
Gildas Bazin committed
816 817
    add_key( "key-vol-up", 'a', NULL, VOL_UP_KEY_TEXT, VOL_UP_KEY_LONGTEXT, VLC_FALSE );
    add_key( "key-vol-down", 'z', NULL, VOL_DOWN_KEY_TEXT, VOL_DOWN_KEY_LONGTEXT, VLC_FALSE );
818
#endif
819

820 821
    /* Usage (mainly useful for cmd line stuff) */
    add_usage_hint( PLAYLIST_USAGE );
822

823 824 825
    set_description( N_("main program") );
    set_capability( "main", 100 );
vlc_module_end();
826 827 828

static module_config_t p_help_config[] =
{
Gildas Bazin's avatar
 
Gildas Bazin committed
829 830 831 832
    { 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)") },
833
    { CONFIG_ITEM_BOOL, NULL, "list", 'l',
Gildas Bazin's avatar
 
Gildas Bazin committed
834 835 836 837 838 839 840 841 842
      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") },
843
    { CONFIG_ITEM_BOOL, NULL, "version", '\0',
Gildas Bazin's avatar
 
Gildas Bazin committed
844 845
      N_("print version information") },
    { CONFIG_HINT_END, NULL, NULL, '\0', NULL }
846 847 848 849 850
};

/*****************************************************************************
 * End configuration.
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
851 852 853 854 855 856 857 858 859 860 861

/*****************************************************************************
 * Initializer for the vlc_t structure storing the action / key associations
 *****************************************************************************/
static struct hotkey p_hotkeys[] =
{
    { "key-quit", ACTIONID_QUIT, 0 },
    { "key-play-pause", ACTIONID_PLAY_PAUSE, 0 },
    { "key-play", ACTIONID_PLAY, 0 },
    { "key-pause", ACTIONID_PAUSE, 0 },
    { "key-stop", ACTIONID_STOP, 0 },
Gildas Bazin's avatar
 
Gildas Bazin committed
862 863 864 865 866 867
    { "key-jump-10sec", ACTIONID_JUMP_BACKWARD_10SEC, 0 },
    { "key-jump+10sec", ACTIONID_JUMP_FORWARD_10SEC, 0 },
    { "key-jump-1min", ACTIONID_JUMP_BACKWARD_1MIN, 0 },
    { "key-jump+1min", ACTIONID_JUMP_FORWARD_1MIN, 0 },
    { "key-jump-5min", ACTIONID_JUMP_BACKWARD_5MIN, 0 },
    { "key-jump+5min", ACTIONID_JUMP_FORWARD_5MIN, 0 },
Gildas Bazin's avatar
 
Gildas Bazin committed
868 869 870 871 872 873 874 875 876 877 878 879 880 881
    { "key-prev", ACTIONID_PREV, 0 },
    { "key-next", ACTIONID_NEXT, 0 },
    { "key-faster", ACTIONID_FASTER, 0 },
    { "key-slower", ACTIONID_SLOWER, 0 },
    { "key-fullscreen", ACTIONID_FULLSCREEN, 0 },
    { "key-vol-up", ACTIONID_VOL_UP, 0 },
    { "key-vol-down", ACTIONID_VOL_DOWN, 0 },
    { "key-nav-activate", ACTIONID_NAV_ACTIVATE, 0 },
    { "key-nav-up", ACTIONID_NAV_UP, 0 },
    { "key-nav-down", ACTIONID_NAV_DOWN, 0 },
    { "key-nav-left", ACTIONID_NAV_LEFT, 0 },
    { "key-nav-right", ACTIONID_NAV_RIGHT, 0 },
    { NULL, 0, 0 }
};