git.sesse.net Git - vlc/blob - src/libvlc.h

   1 /*****************************************************************************
   2  * libvlc.h: main libvlc header
   3  *****************************************************************************
   4  * Copyright (C) 1998-2002 VideoLAN
   5  * $Id: libvlc.h,v 1.88 2003/09/22 14:40:12 zorglub Exp $
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *          Gildas Bazin <gbazin@netcourrier.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  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",
  30                                 "nl", "no", "pl", "pt_BR", "ru", "sv", NULL };
  31
  32 /*****************************************************************************
  33  * Configuration options for the main program. Each module will also separatly
  34  * define its own configuration options.
  35  * Look into configuration.h if you need to know more about the following
  36  * macros.
  37  *****************************************************************************/
  38
  39 #define INTF_CAT_LONGTEXT N_( \
  40     "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." )
  41
  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     "The default behavior is to automatically select the best module " \
  46     "available.")
  47
  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. " \
  51     "They will be launched in the background in addition to the default " \
  52     "interface. Use a comma separated list of interface modules. (common " \
  53     "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 #define QUIET_LONGTEXT N_( \
  62     "This options turns off all warning and information messages.")
  63
  64 #define LANGUAGE_TEXT N_("Language")
  65 #define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
  66     "of the interface. The system language is auto-detected if \"auto\" is " \
  67     "specified here." )
  68
  69 #define COLOR_TEXT N_("Color messages")
  70 #define COLOR_LONGTEXT N_( \
  71     "When this option is turned on, the messages sent to the console will " \
  72     "be colorized. Your terminal needs Linux color support for this to work.")
  73
  74 #define ADVANCED_TEXT N_("Show advanced options")
  75 #define ADVANCED_LONGTEXT N_( \
  76     "When this option is turned on, the preferences and/or interfaces  will " \
  77     "show all the available options, including those that most users should " \
  78     "never touch")
  79
  80 #define INTF_PATH_TEXT N_("Interface default search path")
  81 #define INTF_PATH_LONGTEXT N_( \
  82     "This option allows you to set the default path that the interface will " \
  83     "open when looking for a file.")
  84
  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     "for its plugins.")
  89
  90 #define AOUT_CAT_LONGTEXT N_( \
  91     "These options allow you to tune VLC's audio subsystem, \n" \
  92     "and to add audio filters which can be used for \n" \
  93     "postprocessing or visual effects (spectrum analyser,...) \n" \
  94     "To tune these filters, have a look at the \"audio filter\"\n" \
  95     "plugin options.")
  96
  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     "The default behavior is to automatically select the best method " \
 101     "available.")
 102
 103 #define AUDIO_TEXT N_("Enable audio")
 104 #define AUDIO_LONGTEXT N_( \
 105     "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 #define MONO_LONGTEXT N_("This will force a mono audio output")
 110
 111 #define VOLUME_TEXT N_("Audio output volume")
 112 #define VOLUME_LONGTEXT N_( \
 113     "You can set the default audio output volume here, in a range from 0 to " \
 114     "1024.")
 115
 116 #define VOLUME_SAVE_TEXT N_("Audio output saved volume")
 117 #define VOLUME_SAVE_LONGTEXT N_( \
 118     "This saves the audio output volume when you select mute.")
 119
 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 " \
 123     "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
 124
 125 #if !defined( SYS_DARWIN )
 126 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
 127 #define AOUT_RESAMP_LONGTEXT N_( \
 128     "High quality audio resampling can be processor intensive so you can " \
 129     "disable it and a cheaper resampling algorithm will be used instead.")
 130 #endif
 131
 132 #define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
 133 #define DESYNC_LONGTEXT N_( \
 134     "This option allows you to delay the audio output. This can be handy if " \
 135     "you notice a lag between the video and the audio.")
 136
 137 #define MULTICHA_TEXT N_("Choose prefered audio output channels mode")
 138 #define MULTICHA_LONGTEXT N_( \
 139     "This option allows you to set the audio output channels mode that will " \
 140     "be used by default when possible (ie. if your hardware supports it as " \
 141     "well as the audio stream being played)")
 142
 143 #define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
 144 #define SPDIF_LONGTEXT N_( \
 145     "This option allows you to use the S/PDIF audio output by default when " \
 146     "your hardware supports it as well as the audio stream being played.")
 147
 148 #define AUDIO_FILTER_TEXT N_("Audio filters")
 149 #define AUDIO_FILTER_LONGTEXT N_( \
 150     "This allows you to add audio postprocessing filters, to modify" \
 151     "the sound.")
 152
 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     "with a complete 5.1 speaker set when using only a headphone, " \
 157     "providing a more realistic sound experience. It should also be " \
 158     "more comfortable and less tiring when listening to music for " \
 159     "long periods of time.\nIt works with any source format from mono " \
 160     "to 5.1.")
 161
 162 #define VOUT_CAT_LONGTEXT N_( \
 163     "These options allow you to modify options related to \n" \
 164     "the video output subsystem. You can for example enable \n" \
 165     "video filters, like deinterlacing, constrast / hue / \n " \
 166     "saturation adjusting, ... \n" \
 167     "Enable these filters here and configure them in the video \n" \
 168     "filters plugins section." )
 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     "The default behavior is to automatically select the best " \
 174     "method available.")
 175
 176 #define VIDEO_TEXT N_("Enable video")
 177 #define VIDEO_LONGTEXT N_( \
 178     "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     "adapt to the video characteristics.")
 185
 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     "adapt to the video characteristics.")
 190
 191 #define ALIGN_TEXT N_("Video alignment")
 192 #define ALIGN_LONGTEXT N_( \
 193     "You can enforce the video alignement in its window. By default (0) it " \
 194     "will be centered (0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
 195     "also use combinations of these values).")
 196
 197 #define ZOOM_TEXT N_("Zoom video")
 198 #define ZOOM_LONGTEXT N_( \
 199     "You can zoom the video by the specified factor.")
 200
 201 #define GRAYSCALE_TEXT N_("Grayscale video output")
 202 #define GRAYSCALE_LONGTEXT N_( \
 203     "When enabled, the color information from the video won't be decoded " \
 204     "(this can also allow you to save some processing power).")
 205
 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     "mode.")
 210
 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 #define SPUMARGIN_LONGTEXT N_( \
 218     "You can use this option to place the subtitles under the movie, " \
 219     "instead of over the movie. Try several positions.")
 220
 221 #define FILTER_TEXT N_("Video filter module")
 222 #define FILTER_LONGTEXT N_( \
 223     "This will allow you to add a post-processing filter to enhance the " \
 224     "picture quality, for instance deinterlacing, or to clone or distort " \
 225     "the video window.")
 226
 227 #define ASPECT_RATIO_TEXT N_("Source aspect ratio")
 228 #define ASPECT_RATIO_LONGTEXT N_( \
 229     "This will force the source aspect ratio. For instance, some DVDs claim " \
 230     "to be 16:9 while they are actually 4:3. This can also be used as a " \
 231     "hint for VLC when a movie does not have aspect ratio information. " \
 232     "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
 233     "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
 234     "squareness.")
 235
 236 #if 0
 237 #define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
 238 #define PIXEL_RATIO_LONGTEXT N_( \
 239     "This will force the destination pixel size. By default VLC assumes " \
 240     "your pixels are square, unless your hardware has a way to tell it " \
 241     "otherwise. This may be used when you output VLC's signal to another " \
 242     "device such as a TV set. Accepted format is a float value (1, 1.25, " \
 243     "1.3333, etc.) expressing pixel squareness.")
 244 #endif
 245
 246 #define INPUT_CAT_LONGTEXT N_( " " )
 247
 248 #define SERVER_PORT_TEXT N_("Server port")
 249 #define SERVER_PORT_LONGTEXT N_( \
 250     "This is the port used for UDP streams. By default, we chose 1234.")
 251
 252 #define MTU_TEXT N_("MTU of the network interface")
 253 #define MTU_LONGTEXT N_( \
 254     "This is the typical size of UDP packets that we expect. On Ethernet " \
 255     "it is usually 1500.")
 256
 257 #define IFACE_ADDR_TEXT N_("Network interface address")
 258 #define IFACE_ADDR_LONGTEXT N_( \
 259     "If you have several interfaces on your machine and use the " \
 260     "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 #define TTL_LONGTEXT N_( \
 265     "Indicate here the Time To Live of the multicast packets sent by " \
 266     "the stream output.")
 267
 268 #define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
 269 #define INPUT_PROGRAM_LONGTEXT N_( \
 270     "Choose the program to select by giving its Service ID.")
 271
 272 #define INPUT_AUDIO_TEXT N_("Choose audio")
 273 #define INPUT_AUDIO_LONGTEXT N_( \
 274     "Give the default type of audio you want to use in a DVD. " \
 275     "(Developers only)")
 276
 277 #define INPUT_CHAN_TEXT N_("Choose channel")
 278 #define INPUT_CHAN_LONGTEXT N_( \
 279     "Give the stream number of the audio channel you want to use in a DVD " \
 280     "(from 1 to n).")
 281
 282 #define INPUT_SUBT_TEXT N_("Choose subtitles track")
 283 #define INPUT_SUBT_LONGTEXT N_( \
 284     "Give the stream number of the subtitle channel you want to use " \
 285     "(from 1 to n).")
 286
 287 #define SUB_AUTO_TEXT N_("Autodetect subtitle files")
 288 #define SUB_AUTO_LONGTEXT \
 289     "Automatically detect a subtitle file, if no subtitle filename is" \
 290     "is specified."
 291
 292 #define SUB_FILE_TEXT N_("Use subtitle file")
 293 #define SUB_FILE_LONGTEXT \
 294     "Load this subtitle file. To be used when autodetect cannot detect " \
 295     "your subtitlefile."
 296
 297 #define DVD_DEV_TEXT N_("DVD device")
 298 #ifdef WIN32
 299 #define DVD_DEV_LONGTEXT N_( \
 300     "This is the default DVD drive (or file) to use. Don't forget the colon " \
 301     "after the drive letter (eg D:)")
 302 #else
 303 #define DVD_DEV_LONGTEXT N_( \
 304     "This is the default DVD device to use.")
 305 #endif
 306
 307 #define VCD_DEV_TEXT N_("VCD device")
 308 #define VCD_DEV_LONGTEXT N_( \
 309     "This is the default VCD device to use.")
 310
 311 #define IPV6_TEXT N_("Force IPv6")
 312 #define IPV6_LONGTEXT N_( \
 313     "If you check this box, IPv6 will be used by default for all UDP and " \
 314     "HTTP connections.")
 315
 316 #define IPV4_TEXT N_("Force IPv4")
 317 #define IPV4_LONGTEXT N_( \
 318     "If you check this box, IPv4 will be used by default for all UDP and " \
 319     "HTTP connections.")
 320
 321 #define CODEC_CAT_LONGTEXT N_( \
 322     "This option can be used to alter the way VLC selects \n" \
 323     "its codecs (decompression methods). Only advanced users should \n" \
 324     "alter this option as it can break playback of all your streams." )
 325
 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     "difference between audio or video codecs, so you should always specify " \
 332     "'any' at the end of the list to make sure there is a fallback for the " \
 333     "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     "codecs. " )
 344
 345 #define SOUT_CAT_LONGTEXT N_( \
 346     "These options allow you to set default global options for the\n " \
 347     "stream output subsystem." )
 348
 349 #define SOUT_TEXT N_("Choose a stream output")
 350 #define SOUT_LONGTEXT N_( \
 351     "Empty if no stream output.")
 352
 353 #define SOUT_DISPLAY_TEXT N_("Display while streaming")
 354 #define SOUT_DISPLAY_LONGTEXT N_( \
 355     "This allows you to play the stream while streaming it.")
 356
 357 #define SOUT_VIDEO_TEXT N_("Enable video stream output")
 358 #define SOUT_VIDEO_LONGTEXT N_( \
 359     "This allows you to choose if the video stream should be redirected to " \
 360     "the stream output facility when this last one is enabled.")
 361
 362 #define SOUT_AUDIO_TEXT N_("Enable audio stream output")
 363 #define SOUT_AUDIO_LONGTEXT N_( \
 364     "This allows you to choose if the video stream should be redirected to " \
 365     "the stream output facility when this last one is enabled.")
 366
 367 #define SOUT_KEEP_TEXT N_("Keep sout open" )
 368 #define SOUT_KEEP_LONGTEXT N_( \
 369     "This allows you to keep an unique sout instance across " \
 370     "multiple playlist item (automatically insert gather stream_out " \
 371     "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."  )
 377
 378 #define MUX_TEXT N_("Mux module")
 379 #define MUX_LONGTEXT N_( \
 380     "This is a legacy entry to let you configure mux modules")
 381
 382 #define ACCESS_OUTPUT_TEXT N_("Access output module")
 383 #define ACCESS_OUTPUT_LONGTEXT N_( \
 384     "This is a legacy entry to let you configure access output modules")
 385
 386 #define CPU_CAT_LONGTEXT N_( \
 387     "These options allow you to enable special CPU \n " \
 388     "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     "advantage of them.")
 394
 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     "advantage of them.")
 399
 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     "advantage of them.")
 404
 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     "advantage of them.")
 414
 415 #define PLAYLIST_CAT_LONGTEXT N_( \
 416      "These options define the behaviour of the playlist. Some \n" \
 417      "of them can be overriden in the playlist dialog box." )
 418
 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     "interrupted.")
 423
 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.")
 428
 429 #define REPEAT_TEXT N_("Repeat the current playlistitem")
 430 #define REPEAT_LONGTEXT N_( \
 431     "When this is active VLC will keep playing the current playlistitem " \
 432     "over and over again.")
 433
 434 #define MISC_CAT_LONGTEXT N_( \
 435     "These options allow you to select default modules. Leave these \n" \
 436     "alone unless you really know what you are doing." )
 437
 438 #define MEMCPY_TEXT N_("Memory copy module")
 439 #define MEMCPY_LONGTEXT N_( \
 440     "You can select which memory copy module you want to use. By default " \
 441     "VLC will select the fastest one supported by your hardware.")
 442
 443 #define ACCESS_TEXT N_("Access module")
 444 #define ACCESS_LONGTEXT N_( \
 445     "This is a legacy entry to let you configure access modules")
 446
 447 #define DEMUX_TEXT N_("Demux module")
 448 #define DEMUX_LONGTEXT N_( \
 449     "This is a legacy entry to let you configure demux modules")
 450
 451 #define HPRIORITY_TEXT N_("Increase the priority of the process")
 452 #define HPRIORITY_LONGTEXT N_( \
 453     "Increasing the priority of the process will very likely improve your " \
 454     "playing experience as it allows VLC not to be disturbed by other " \
 455     "applications that could otherwise take too much processor time.\n" \
 456     "However be advise that in certain circumstances (bugs) VLC could take " \
 457     "all the processor time and render the whole system unresponsive which " \
 458     "might require a reboot of your machine.")
 459
 460 #define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
 461 #define FAST_MUTEX_LONGTEXT N_( \
 462     "On Windows NT/2K/XP we use a slow mutex implementation but which " \
 463     "allows us to correctely implement condition variables. " \
 464     "You can also use the faster Win9x implementation but you might " \
 465     "experience problems with it.")
 466
 467 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
 468     "(developers only)")
 469 #define WIN9X_CV_LONGTEXT N_( \
 470     "On Windows 9x/Me we use a fast but not correct condition variables " \
 471     "implementation (more precisely there is a possibility for a race " \
 472     "condition to happen). " \
 473     "However it is possible to use slower alternatives which should be more " \
 474     "robust. " \
 475     "Currently you can choose between implementation 0 (which is the " \
 476     "default and the fastest), 1 and 2.")
 477
 478 #define HOTKEY_CAT_LONGTEXT N_( " " )
 479
 480 #define FULLSCREEN_KEY_TEXT N_("Fullscreen")
 481 #define FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to swap fullscreen state")
 482 #define PLAY_PAUSE_KEY_TEXT N_("Pause")
 483 #define PLAY_PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to swap paused state")
 484 #define PAUSE_KEY_TEXT N_("Pause only")
 485 #define PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to pause")
 486 #define PLAY_KEY_TEXT N_("Play only")
 487 #define PLAY_KEY_LONGTEXT N_("Select the hotkey to use to play")
 488 #define FASTER_KEY_TEXT N_("Faster")
 489 #define FASTER_KEY_LONGTEXT N_("Select the hotkey to use for fast forward playback")
 490 #define SLOWER_KEY_TEXT N_("Slower")
 491 #define SLOWER_KEY_LONGTEXT N_("Select the hotkey to use for slow motion playback")
 492 #define NEXT_KEY_TEXT N_("Next")
 493 #define NEXT_KEY_LONGTEXT N_("Select the hotkey to use to skip to the next item in the playlist")
 494 #define PREV_KEY_TEXT N_("Previous")
 495 #define PREV_KEY_LONGTEXT N_("Select the hotkey to use to skip to the previous item in the playlist")
 496 #define STOP_KEY_TEXT N_("Stop")
 497 #define STOP_KEY_LONGTEXT N_("Select the hotkey to stop the playback")
 498 #define QUIT_KEY_TEXT N_("Quit")
 499 #define QUIT_KEY_LONGTEXT N_("Select the hotkey to quit the application")
 500 #define NAV_UP_KEY_TEXT N_("Navigate up")
 501 #define NAV_UP_KEY_LONGTEXT N_("Select the key to move the selector up in dvd menus")
 502 #define NAV_DOWN_KEY_TEXT N_("Navigate down")
 503 #define NAV_DOWN_KEY_LONGTEXT N_("Select the key to move the selector down in dvd menus")
 504 #define NAV_LEFT_KEY_TEXT N_("Navigate left")
 505 #define NAV_LEFT_KEY_LONGTEXT N_("Select the key to move the selector left in dvd menus")
 506 #define NAV_RIGHT_KEY_TEXT N_("Navigate right")
 507 #define NAV_RIGHT_KEY_LONGTEXT N_("Select the key to move the selector right in dvd menus")
 508 #define NAV_ACTIVATE_KEY_TEXT N_("Activate")
 509 #define NAV_ACTIVATE_KEY_LONGTEXT N_("Select the key to activate selected item in dvd menus")
 510 #define VOL_UP_KEY_TEXT N_("Volume up")
 511 #define VOL_UP_KEY_LONGTEXT N_("Select the key to turn up audio volume")
 512 #define VOL_DOWN_KEY_TEXT N_("Volume down")
 513 #define VOL_DOWN_KEY_LONGTEXT N_("Select the key to turn down audio volume")
 514
 515 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
 516     "\n  *.mpg, *.vob                   plain MPEG-1/2 files" \
 517     "\n  [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
 518     "\n                                 DVD device" \
 519     "\n  [vcd:][device][@[title][,[chapter]]" \
 520     "\n                                 VCD device" \
 521     "\n  udpstream:[@[<bind address>][:<bind port>]]" \
 522     "\n                                 UDP stream sent by a streaming server" \
 523     "\n  vlc:pause                      pause execution of " \
 524     "playlist items" \
 525     "\n  vlc:quit                       quit VLC" \
 526     "\n")
 527
 528
 529 /*
 530  * Quick usage guide for the configuration options:
 531  *
 532  * add_category_hint( N_(text), N_(longtext) );
 533  * add_subcategory_hint( N_(text), N_(longtext) );
 534  * add_usage_hint( N_(text) );
 535  * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
 536  * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
 537  * add_module( option_name, psz_value, i_capability, p_callback,
 538  *             N_(text), N_(longtext) );
 539  * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
 540  * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
 541  */
 542
 543 vlc_module_begin();
 544     /* 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     add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT,
 549                      EXTRAINTF_LONGTEXT, VLC_FALSE );
 550     add_integer_with_short( "verbose", 'v', 0, NULL,
 551                             VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
 552     add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT,
 553                             QUIET_LONGTEXT, VLC_TRUE );
 554     add_string_from_list( "language", "auto", ppsz_language, NULL,
 555                             LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
 556     add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
 557     add_bool( "advanced", 0, NULL, ADVANCED_TEXT,
 558                             ADVANCED_LONGTEXT, VLC_FALSE );
 559     add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT,
 560                             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                            AOUT_TEXT, AOUT_LONGTEXT, VLC_TRUE);
 568     add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_FALSE );
 569     add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
 570                             AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
 571                             VOLUME_LONGTEXT, VLC_FALSE );
 572     add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
 573                             AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
 574                             VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
 575     add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
 576 #if !defined( SYS_DARWIN )
 577     add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
 578 #endif
 579     add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
 580     add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
 581 #if 0
 582     add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT,
 583                         HEADPHONE_LONGTEXT, VLC_FALSE );
 584 #endif
 585     add_string("audio-filter",0,NULL,AUDIO_FILTER_TEXT,
 586                     AUDIO_FILTER_LONGTEXT,VLC_FALSE);
 587
 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     add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
 593     add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
 594     add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
 595     add_integer( "align", -1, NULL, ALIGN_TEXT, ALIGN_LONGTEXT, VLC_TRUE );
 596     add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
 597     add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
 598     add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT,
 599                         FULLSCREEN_LONGTEXT, VLC_FALSE );
 600 #ifndef SYS_DARWIN
 601     add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
 602 #endif
 603     add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT,
 604                         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 #if 0
 610     add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
 611 #endif
 612
 613     /* Input options */
 614     add_category_hint( N_("Input"), INPUT_CAT_LONGTEXT , VLC_FALSE );
 615     add_integer( "server-port", 1234, NULL,
 616                  SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
 617     add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
 618     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     add_bool( "sub-autodetect-file", VLC_TRUE, NULL,
 629                  SUB_AUTO_TEXT, SUB_AUTO_LONGTEXT, VLC_FALSE );
 630     add_file( "sub-file", NULL, NULL,
 631                  SUB_FILE_TEXT, SUB_FILE_LONGTEXT, VLC_TRUE );
 632
 633
 634     add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
 635     add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
 636
 637     add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
 638     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
 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     add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT,
 649                                 SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
 650     add_bool( "sout-keep", VLC_FALSE, NULL, SOUT_KEEP_TEXT,
 651                                 SOUT_KEEP_LONGTEXT, VLC_TRUE );
 652
 653     add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT,
 654                                 SOUT_AUDIO_LONGTEXT, VLC_TRUE );
 655     add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT,
 656                                 SOUT_VIDEO_LONGTEXT, VLC_TRUE );
 657
 658     add_module( "packetizer", "packetizer", NULL, NULL,
 659                 PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
 660     add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT,
 661                                 MUX_LONGTEXT, VLC_TRUE );
 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__ )
 670     add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
 671     add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
 672     add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
 673     add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
 674 #endif
 675 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
 676     add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
 677 #endif
 678
 679     /* Playlist options */
 680     add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
 681     add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT,
 682                                 RANDOM_LONGTEXT, VLC_FALSE );
 683     add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
 684     add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
 685     add_bool( "repeat", 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
 686
 687     /* Misc options */
 688     add_category_hint( N_("Miscellaneous"), MISC_CAT_LONGTEXT, VLC_TRUE );
 689     add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
 690     add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
 691     add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
 692
 693 #if defined(WIN32)
 694     add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
 695     add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
 696     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     add_key( "fullscreen-key", 'f', NULL, FULLSCREEN_KEY_TEXT, FULLSCREEN_KEY_LONGTEXT, VLC_FALSE );
 702     add_key( "play-pause-key", KEY_SPACE, NULL, PLAY_PAUSE_KEY_TEXT, PLAY_PAUSE_KEY_LONGTEXT, VLC_FALSE );
 703     add_key( "pause-key", 0, NULL, PAUSE_KEY_TEXT, PAUSE_KEY_LONGTEXT, VLC_TRUE );
 704     add_key( "play-key", 0, NULL, PLAY_KEY_TEXT, PLAY_KEY_LONGTEXT, VLC_TRUE );
 705     add_key( "faster-key", '+', NULL, FASTER_KEY_TEXT, FASTER_KEY_LONGTEXT, VLC_FALSE );
 706     add_key( "slower-key", '-', NULL, SLOWER_KEY_TEXT, SLOWER_KEY_LONGTEXT, VLC_FALSE );
 707     add_key( "next-key", 'n', NULL, NEXT_KEY_TEXT, NEXT_KEY_LONGTEXT, VLC_FALSE );
 708     add_key( "prev-key", 'p', NULL, PREV_KEY_TEXT, PREV_KEY_LONGTEXT, VLC_FALSE );
 709     add_key( "stop-key", 's', NULL, STOP_KEY_TEXT, STOP_KEY_LONGTEXT, VLC_FALSE );
 710     add_key( "nav-activate-key", KEY_ENTER, NULL, NAV_ACTIVATE_KEY_TEXT, NAV_ACTIVATE_KEY_LONGTEXT, VLC_FALSE );
 711     add_key( "nav-up-key", KEY_UP, NULL, NAV_UP_KEY_TEXT, NAV_UP_KEY_LONGTEXT, VLC_FALSE );
 712     add_key( "nav-down-key", KEY_DOWN, NULL, NAV_DOWN_KEY_TEXT, NAV_DOWN_KEY_LONGTEXT, VLC_FALSE );
 713     add_key( "nav-left-key", KEY_LEFT, NULL, NAV_LEFT_KEY_TEXT, NAV_LEFT_KEY_LONGTEXT, VLC_FALSE );
 714     add_key( "nav-right-key", KEY_RIGHT, NULL, NAV_RIGHT_KEY_TEXT, NAV_RIGHT_KEY_LONGTEXT, VLC_FALSE );
 715     add_key( "quit-key", KEY_MODIFIER_CTRL|KEY_SPACE, NULL, QUIT_KEY_TEXT, QUIT_KEY_LONGTEXT, VLC_FALSE );
 716     add_key( "vol-up-key", 'a', NULL, VOL_UP_KEY_TEXT, VOL_UP_KEY_LONGTEXT, VLC_FALSE );
 717     add_key( "vol-down-key", 'z', NULL, VOL_DOWN_KEY_TEXT, VOL_DOWN_KEY_LONGTEXT, VLC_FALSE );
 718
 719     /* Usage (mainly useful for cmd line stuff) */
 720     add_usage_hint( PLAYLIST_USAGE );
 721
 722     set_description( N_("main program") );
 723     set_capability( "main", 100 );
 724 vlc_module_end();
 725
 726 static module_config_t p_help_config[] =
 727 {
 728     { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
 729       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 730     { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
 731       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 732     { CONFIG_ITEM_BOOL, NULL, "list", 'l',
 733                               N_("print a list of available modules"),
 734       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 735     { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
 736       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 737     { CONFIG_ITEM_BOOL, NULL, "version", '\0',
 738                               N_("print version information"),
 739       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 740     { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
 741       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
 742 };
 743
 744 /*****************************************************************************
 745  * End configuration.
 746  *****************************************************************************/