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.78 2003/08/14 19:25:56 sigmunau 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_sout_acodec[] = { "", "mpga", "mp3", "vorb", "a52", NULL };
  30 static char *ppsz_sout_vcodec[] = { "", "mpgv", "mp4v", "DIV1", "DIV2",
  31                                  "DIV3", "h263", "i263", "WMV1", "WMV2",
  32                                  "MJPG", NULL };
  33
  34 static char *ppsz_language[] = { "auto", "en", "en_GB", "de", "fr", "it",
  35                                  "ja", "nl", "no", "pl", "ru", "sv", NULL };
  36
  37 /*****************************************************************************
  38  * Configuration options for the main program. Each module will also separatly
  39  * define its own configuration options.
  40  * Look into configuration.h if you need to know more about the following
  41  * macros.
  42  *****************************************************************************/
  43 #define INTF_TEXT N_("Interface module")
  44 #define INTF_LONGTEXT N_( \
  45     "This option allows you to select the interface used by VLC. " \
  46     "The default behavior is to automatically select the best module " \
  47     "available.")
  48
  49 #define EXTRAINTF_TEXT N_("Extra interface modules")
  50 #define EXTRAINTF_LONGTEXT N_( \
  51     "This option allows you to select additional interfaces used by VLC. " \
  52     "They will be launched in the background in addition to the default " \
  53     "interface. Use a comma separated list of interface modules. (common " \
  54     "values are: logger,gestures,sap,rc,http,screensaver)")
  55
  56 #define VERBOSE_TEXT N_("Verbosity (0,1,2)")
  57 #define VERBOSE_LONGTEXT N_( \
  58     "This options sets the verbosity level (0=only errors and " \
  59     "standard messages, 1=warnings, 2=debug).")
  60
  61 #define QUIET_TEXT N_("Be quiet")
  62 #define QUIET_LONGTEXT N_( \
  63     "This options turns off all warning and information messages.")
  64
  65 #define LANGUAGE_TEXT N_("Language")
  66 #define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
  67     "of the interface. The system language is auto-detected if \"auto\" is " \
  68     "specified here." )
  69
  70 #define COLOR_TEXT N_("Color messages")
  71 #define COLOR_LONGTEXT N_( \
  72     "When this option is turned on, the messages sent to the console will " \
  73     "be colorized. Your terminal needs Linux color support for this to work.")
  74
  75 #define ADVANCED_TEXT N_("Show advanced options")
  76 #define ADVANCED_LONGTEXT N_( \
  77     "When this option is turned on, the preferences and/or interfaces  will " \
  78     "show all the available options, including those that most users should " \
  79     "never touch")
  80
  81 #define INTF_PATH_TEXT N_("Interface default search path")
  82 #define INTF_PATH_LONGTEXT N_( \
  83     "This option allows you to set the default path that the interface will " \
  84     "open when looking for a file.")
  85
  86 #define PLUGIN_PATH_TEXT N_("Plugin search path")
  87 #define PLUGIN_PATH_LONGTEXT N_( \
  88     "This option allows you to specify an additional path for VLC to look " \
  89     "for its plugins.")
  90
  91 #define AOUT_TEXT N_("Audio output module")
  92 #define AOUT_LONGTEXT N_( \
  93     "This option allows you to select the audio output method used by VLC. " \
  94     "The default behavior is to automatically select the best method " \
  95     "available.")
  96
  97 #define AUDIO_TEXT N_("Enable audio")
  98 #define AUDIO_LONGTEXT N_( \
  99     "You can completely disable the audio output. In this case the audio " \
 100     "decoding will not take place, and it will save some processing power.")
 101
 102 #define MONO_TEXT N_("Force mono audio")
 103 #define MONO_LONGTEXT N_("This will force a mono audio output")
 104
 105 #define VOLUME_TEXT N_("Audio output volume")
 106 #define VOLUME_LONGTEXT N_( \
 107     "You can set the default audio output volume here, in a range from 0 to " \
 108     "1024.")
 109
 110 #define VOLUME_SAVE_TEXT N_("Audio output saved volume")
 111 #define VOLUME_SAVE_LONGTEXT N_( \
 112     "This saves the audio output volume when you select mute.")
 113
 114 #define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
 115 #define AOUT_RATE_LONGTEXT N_( \
 116     "You can force the audio output frequency here. Common values are " \
 117     "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
 118
 119 #if !defined( SYS_DARWIN )
 120 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
 121 #define AOUT_RESAMP_LONGTEXT N_( \
 122     "High quality audio resampling can be processor intensive so you can " \
 123     "disable it and a cheaper resampling algorithm will be used instead.")
 124 #endif
 125
 126 #define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
 127 #define DESYNC_LONGTEXT N_( \
 128     "This option allows you to delay the audio output. This can be handy if " \
 129     "you notice a lag between the video and the audio.")
 130
 131 #define MULTICHA_TEXT N_("Choose prefered audio output channels mode")
 132 #define MULTICHA_LONGTEXT N_( \
 133     "This option allows you to set the audio output channels mode that will " \
 134     "be used by default when possible (ie. if your hardware supports it as " \
 135     "well as the audio stream being played)")
 136
 137 #define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
 138 #define SPDIF_LONGTEXT N_( \
 139     "This option allows you to use the S/PDIF audio output by default when " \
 140     "your hardware supports it as well as the audio stream being played.")
 141
 142 #define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
 143 #define HEADPHONE_LONGTEXT N_( \
 144     "This effect gives you the feeling that you are standing in a room " \
 145     "with a complete 5.1 speaker set when using only a headphone, " \
 146     "providing a more realistic sound experience. It should also be " \
 147     "more comfortable and less tiring when listening to music for " \
 148     "long periods of time.\nIt works with any source format from mono " \
 149     "to 5.1.")
 150
 151 #define VOUT_TEXT N_("Video output module")
 152 #define VOUT_LONGTEXT N_( \
 153     "This option allows you to select the video output method used by VLC. " \
 154     "The default behavior is to automatically select the best " \
 155     "method available.")
 156
 157 #define VIDEO_TEXT N_("Enable video")
 158 #define VIDEO_LONGTEXT N_( \
 159     "You can completely disable the video output. In this case the video " \
 160     "decoding stage will not take place, which will save some processing power.")
 161
 162 #define WIDTH_TEXT N_("Video width")
 163 #define WIDTH_LONGTEXT N_( \
 164     "You can enforce the video width here. By default (-1) VLC will " \
 165     "adapt to the video characteristics.")
 166
 167 #define HEIGHT_TEXT N_("Video height")
 168 #define HEIGHT_LONGTEXT N_( \
 169     "You can enforce the video height here. By default (-1) VLC will " \
 170     "adapt to the video characteristics.")
 171
 172 #define ZOOM_TEXT N_("Zoom video")
 173 #define ZOOM_LONGTEXT N_( \
 174     "You can zoom the video by the specified factor.")
 175
 176 #define GRAYSCALE_TEXT N_("Grayscale video output")
 177 #define GRAYSCALE_LONGTEXT N_( \
 178     "When enabled, the color information from the video won't be decoded " \
 179     "(this can also allow you to save some processing power).")
 180
 181 #define FULLSCREEN_TEXT N_("Fullscreen video output")
 182 #define FULLSCREEN_LONGTEXT N_( \
 183     "If this option is enabled, VLC will always start a video in fullscreen " \
 184     "mode.")
 185
 186 #define OVERLAY_TEXT N_("Overlay video output")
 187 #define OVERLAY_LONGTEXT N_( \
 188     "If enabled, VLC will try to take advantage of the overlay capabilities " \
 189     "of your graphics card.")
 190
 191 #define SPUMARGIN_TEXT N_("Force SPU position")
 192 #define SPUMARGIN_LONGTEXT N_( \
 193     "You can use this option to place the subtitles under the movie, " \
 194     "instead of over the movie. Try several positions.")
 195
 196 #define FILTER_TEXT N_("Video filter module")
 197 #define FILTER_LONGTEXT N_( \
 198     "This will allow you to add a post-processing filter to enhance the " \
 199     "picture quality, for instance deinterlacing, or to clone or distort " \
 200     "the video window.")
 201
 202 #define ASPECT_RATIO_TEXT N_("Source aspect ratio")
 203 #define ASPECT_RATIO_LONGTEXT N_( \
 204     "This will force the source aspect ratio. For instance, some DVDs claim " \
 205     "to be 16:9 while they are actually 4:3. This can also be used as a " \
 206     "hint for VLC when a movie does not have aspect ratio information. " \
 207     "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
 208     "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
 209     "squareness.")
 210
 211 #if 0
 212 #define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
 213 #define PIXEL_RATIO_LONGTEXT N_( \
 214     "This will force the destination pixel size. By default VLC assumes " \
 215     "your pixels are square, unless your hardware has a way to tell it " \
 216     "otherwise. This may be used when you output VLC's signal to another " \
 217     "device such as a TV set. Accepted format is a float value (1, 1.25, " \
 218     "1.3333, etc.) expressing pixel squareness.")
 219 #endif
 220
 221 #define SERVER_PORT_TEXT N_("Server port")
 222 #define SERVER_PORT_LONGTEXT N_( \
 223     "This is the port used for UDP streams. By default, we chose 1234.")
 224
 225 #define MTU_TEXT N_("MTU of the network interface")
 226 #define MTU_LONGTEXT N_( \
 227     "This is the typical size of UDP packets that we expect. On Ethernet " \
 228     "it is usually 1500.")
 229
 230 #define IFACE_ADDR_TEXT N_("Network interface address")
 231 #define IFACE_ADDR_LONGTEXT N_( \
 232     "If you have several interfaces on your machine and use the " \
 233     "multicast solution, you will probably have to indicate the IP address " \
 234     "of your multicasting interface here.")
 235
 236 #define TTL_TEXT N_("Time to live")
 237 #define TTL_LONGTEXT N_( \
 238     "Indicate here the Time To Live of the multicast packets sent by " \
 239     "the stream output.")
 240
 241 #define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
 242 #define INPUT_PROGRAM_LONGTEXT N_( \
 243     "Choose the program to select by giving its Service ID.")
 244
 245 #define INPUT_AUDIO_TEXT N_("Choose audio")
 246 #define INPUT_AUDIO_LONGTEXT N_( \
 247     "Give the default type of audio you want to use in a DVD. " \
 248     "(Developers only)")
 249
 250 #define INPUT_CHAN_TEXT N_("Choose channel")
 251 #define INPUT_CHAN_LONGTEXT N_( \
 252     "Give the stream number of the audio channel you want to use in a DVD " \
 253     "(from 1 to n).")
 254
 255 #define INPUT_SUBT_TEXT N_("Choose subtitles")
 256 #define INPUT_SUBT_LONGTEXT N_( \
 257     "Give the stream number of the subtitle channel you want to use in a " \
 258     "DVD (from 1 to n).")
 259
 260 #define DVD_DEV_TEXT N_("DVD device")
 261 #ifdef WIN32
 262 #define DVD_DEV_LONGTEXT N_( \
 263     "This is the default DVD drive (or file) to use. Don't forget the colon " \
 264     "after the drive letter (eg D:)")
 265 #else
 266 #define DVD_DEV_LONGTEXT N_( \
 267     "This is the default DVD device to use.")
 268 #endif
 269
 270 #define VCD_DEV_TEXT N_("VCD device")
 271 #define VCD_DEV_LONGTEXT N_( \
 272     "This is the default VCD device to use.")
 273
 274 #define IPV6_TEXT N_("Force IPv6")
 275 #define IPV6_LONGTEXT N_( \
 276     "If you check this box, IPv6 will be used by default for all UDP and " \
 277     "HTTP connections.")
 278
 279 #define IPV4_TEXT N_("Force IPv4")
 280 #define IPV4_LONGTEXT N_( \
 281     "If you check this box, IPv4 will be used by default for all UDP and " \
 282     "HTTP connections.")
 283
 284 #define CODEC_TEXT N_("Choose preferred codec list")
 285 #define CODEC_LONGTEXT N_( \
 286     "This allows you to select the order in which VLC will choose its " \
 287     "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
 288     "before the new one. Please be aware that VLC does not make any " \
 289     "difference between audio or video codecs, so you should always specify " \
 290     "'any' at the end of the list to make sure there is a fallback for the " \
 291     "types you didn't specify.")
 292
 293 #define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
 294 #define ENCODER_VIDEO_LONGTEXT N_( \
 295     "This allows you to select the order in which VLC will choose its " \
 296     "codecs. " )
 297 #define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
 298 #define ENCODER_AUDIO_LONGTEXT N_( \
 299     "This allows you to select the order in which VLC will choose its " \
 300     "codecs. " )
 301
 302 #define SOUT_TEXT N_("Choose a stream output")
 303 #define SOUT_LONGTEXT N_( \
 304     "Empty if no stream output.")
 305
 306 #define SOUT_DISPLAY_TEXT N_("Display while streaming")
 307 #define SOUT_DISPLAY_LONGTEXT N_( \
 308     "This allows you to play the stream while streaming it.")
 309
 310 #define SOUT_VIDEO_TEXT N_("Enable video stream output")
 311 #define SOUT_VIDEO_LONGTEXT N_( \
 312     "This allows you to choose if the video stream should be redirected to " \
 313     "the stream output facility when this last one is enabled.")
 314
 315 #define SOUT_VCODEC_TEXT N_("Video encoding codec" )
 316 #define SOUT_VCODEC_LONGTEXT N_( \
 317     "This allows you to force video encoding")
 318
 319 #define SOUT_VBITRATE_TEXT N_("Video bitrate encoding (kB/s)" )
 320 #define SOUT_VBITRATE_LONGTEXT N_( \
 321     "This allows you to specify video bitrate in kB/s.")
 322
 323 #define SOUT_AUDIO_TEXT N_("Enable audio stream output")
 324 #define SOUT_AUDIO_LONGTEXT N_( \
 325     "This allows you to choose if the video stream should be redirected to " \
 326     "the stream output facility when this last one is enabled.")
 327
 328 #define SOUT_ACODEC_TEXT N_("Audio encoding codec" )
 329 #define SOUT_ACODEC_LONGTEXT N_( \
 330     "This allows you to force audio encoding")
 331
 332 #define SOUT_ABITRATE_TEXT N_("Audio bitrate encoding (kB/s)" )
 333 #define SOUT_ABITRATE_LONGTEXT N_( \
 334     "This allows you to specify audio bitrate in kB/s.")
 335
 336 #define PACKETIZER_TEXT N_("Choose preferred packetizer list")
 337 #define PACKETIZER_LONGTEXT N_( \
 338     "This allows you to select the order in which VLC will choose its " \
 339     "packetizers."  )
 340
 341 #define MUX_TEXT N_("Mux module")
 342 #define MUX_LONGTEXT N_( \
 343     "This is a legacy entry to let you configure mux modules")
 344
 345 #define ACCESS_OUTPUT_TEXT N_("Access output module")
 346 #define ACCESS_OUTPUT_LONGTEXT N_( \
 347     "This is a legacy entry to let you configure access output modules")
 348
 349
 350 #define MMX_TEXT N_("Enable CPU MMX support")
 351 #define MMX_LONGTEXT N_( \
 352     "If your processor supports the MMX instructions set, VLC can take " \
 353     "advantage of them.")
 354
 355 #define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
 356 #define THREE_DN_LONGTEXT N_( \
 357     "If your processor supports the 3D Now! instructions set, VLC can take " \
 358     "advantage of them.")
 359
 360 #define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
 361 #define MMXEXT_LONGTEXT N_( \
 362     "If your processor supports the MMX EXT instructions set, VLC can take " \
 363     "advantage of them.")
 364
 365 #define SSE_TEXT N_("Enable CPU SSE support")
 366 #define SSE_LONGTEXT N_( \
 367     "If your processor supports the SSE instructions set, VLC can take " \
 368     "advantage of them.")
 369
 370 #define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
 371 #define ALTIVEC_LONGTEXT N_( \
 372     "If your processor supports the AltiVec instructions set, VLC can take " \
 373     "advantage of them.")
 374
 375 #define RANDOM_TEXT N_("Play files randomly forever")
 376 #define RANDOM_LONGTEXT N_( \
 377     "When selected, VLC will randomly play files in the playlist until " \
 378     "interrupted.")
 379
 380 #define ENQUEUE_TEXT N_("Enqueue items in playlist")
 381 #define ENQUEUE_LONGTEXT N_( \
 382     "If you want VLC to add items to the playlist as you open them, then " \
 383     "enable this option.")
 384
 385 #define LOOP_TEXT N_("Loop playlist on end")
 386 #define LOOP_LONGTEXT N_( \
 387     "If you want VLC to keep playing the playlist indefinitely then enable " \
 388     "this option.")
 389
 390 #define MEMCPY_TEXT N_("Memory copy module")
 391 #define MEMCPY_LONGTEXT N_( \
 392     "You can select which memory copy module you want to use. By default " \
 393     "VLC will select the fastest one supported by your hardware.")
 394
 395 #define ACCESS_TEXT N_("Access module")
 396 #define ACCESS_LONGTEXT N_( \
 397     "This is a legacy entry to let you configure access modules")
 398
 399 #define DEMUX_TEXT N_("Demux module")
 400 #define DEMUX_LONGTEXT N_( \
 401     "This is a legacy entry to let you configure demux modules")
 402
 403 #define HPRIORITY_TEXT N_("Increase the priority of the process")
 404 #define HPRIORITY_LONGTEXT N_( \
 405     "Increasing the priority of the process will very likely improve your " \
 406     "playing experience as it allows VLC not to be disturbed by other " \
 407     "applications that could otherwise take too much processor time.\n" \
 408     "However be advise that in certain circumstances (bugs) VLC could take " \
 409     "all the processor time and render the whole system unresponsive which " \
 410     "might require a reboot of your machine.")
 411
 412 #define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
 413 #define FAST_MUTEX_LONGTEXT N_( \
 414     "On Windows NT/2K/XP we use a slow mutex implementation but which " \
 415     "allows us to correctely implement condition variables. " \
 416     "You can also use the faster Win9x implementation but you might " \
 417     "experience problems with it.")
 418
 419 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
 420     "(developers only)")
 421 #define WIN9X_CV_LONGTEXT N_( \
 422     "On Windows 9x/Me we use a fast but not correct condition variables " \
 423     "implementation (more precisely there is a possibility for a race " \
 424     "condition to happen). " \
 425     "However it is possible to use slower alternatives which should be more " \
 426     "robust. " \
 427     "Currently you can choose between implementation 0 (which is the " \
 428     "default and the fastest), 1 and 2.")
 429
 430 #define FULLSCREEN_KEY_TEXT N_("Fullscreen")
 431 #define FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to swap fullscreen state")
 432 #define PLAY_PAUSE_KEY_TEXT N_("Pause")
 433 #define PLAY_PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to swap paused state")
 434 #define PAUSE_KEY_TEXT N_("Pause only")
 435 #define PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to pause")
 436 #define PLAY_KEY_TEXT N_("Play only")
 437 #define PLAY_KEY_LONGTEXT N_("Select the hotkey to use to play")
 438 #define FASTER_KEY_TEXT N_("Faster")
 439 #define FASTER_KEY_LONGTEXT N_("Select the hotkey to use for fast forward playback")
 440 #define SLOWER_KEY_TEXT N_("Slower")
 441 #define SLOWER_KEY_LONGTEXT N_("Select the hotkey to use for slow motion playback")
 442 #define NEXT_KEY_TEXT N_("Next")
 443 #define NEXT_KEY_LONGTEXT N_("Select the hotkey to use to skip to the next item in the playlist")
 444 #define PREV_KEY_TEXT N_("Previous")
 445 #define PREV_KEY_LONGTEXT N_("Select the hotkey to use to skip to the previous item in the playlist")
 446 #define STOP_KEY_TEXT N_("Stop")
 447 #define STOP_KEY_LONGTEXT N_("Select the hotkey to stop the playback")
 448 #define QUIT_KEY_TEXT N_("Quit")
 449 #define QUIT_KEY_LONGTEXT N_("Select the hotkey to quit the application")
 450 #define NAV_UP_KEY_TEXT N_("Navigate up")
 451 #define NAV_UP_KEY_LONGTEXT N_("Select the key to move the selector up in dvd menus")
 452 #define NAV_DOWN_KEY_TEXT N_("Navigate down")
 453 #define NAV_DOWN_KEY_LONGTEXT N_("Select the key to move the selector down in dvd menus")
 454 #define NAV_LEFT_KEY_TEXT N_("Navigate left")
 455 #define NAV_LEFT_KEY_LONGTEXT N_("Select the key to move the selector left in dvd menus")
 456 #define NAV_RIGHT_KEY_TEXT N_("Navigate right")
 457 #define NAV_RIGHT_KEY_LONGTEXT N_("Select the key to move the selector right in dvd menus")
 458 #define NAV_ACTIVATE_KEY_TEXT N_("Activate")
 459 #define NAV_ACTIVATE_KEY_LONGTEXT N_("Select the key to activate selected item in dvd menus")
 460 #define VOL_UP_KEY_TEXT N_("Volume up")
 461 #define VOL_UP_KEY_LONGTEXT N_("Select the key to turn up audio volume")
 462 #define VOL_DOWN_KEY_TEXT N_("Volume down")
 463 #define VOL_DOWN_KEY_LONGTEXT N_("Select the key to turn down audio volume")
 464
 465 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
 466     "\n  *.mpg, *.vob                   plain MPEG-1/2 files" \
 467     "\n  [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
 468     "\n                                 DVD device" \
 469     "\n  [vcd:][device][@[title][,[chapter]]" \
 470     "\n                                 VCD device" \
 471     "\n  udpstream:[@[<bind address>][:<bind port>]]" \
 472     "\n                                 UDP stream sent by VLS" \
 473     "\n  vlc:pause                      pause execution of " \
 474     "playlist items" \
 475     "\n  vlc:quit                       quit VLC" \
 476     "\n")
 477
 478
 479 /*
 480  * Quick usage guide for the configuration options:
 481  *
 482  * add_category_hint( N_(text), N_(longtext) );
 483  * add_subcategory_hint( N_(text), N_(longtext) );
 484  * add_usage_hint( N_(text) );
 485  * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
 486  * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
 487  * add_module( option_name, psz_value, i_capability, p_callback,
 488  *             N_(text), N_(longtext) );
 489  * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
 490  * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
 491  */
 492
 493 vlc_module_begin();
 494     /* Interface options */
 495     add_category_hint( N_("Interface"), NULL, VLC_FALSE );
 496     add_module_with_short( "intf", 'I', "interface", NULL, NULL,
 497                            INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
 498     add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
 499     add_integer_with_short( "verbose", 'v', 0, NULL,
 500                             VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
 501     add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
 502     add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
 503     add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
 504     add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
 505     add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
 506     add_directory( "plugin-path", NULL, NULL,
 507                 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
 508
 509     /* Audio options */
 510     add_category_hint( N_("Audio"), NULL, VLC_FALSE );
 511     add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
 512                            AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
 513     add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
 514     add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
 515                             AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
 516                             VOLUME_LONGTEXT, VLC_FALSE );
 517     add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
 518                             AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
 519                             VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
 520     add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
 521 #if !defined( SYS_DARWIN )
 522     add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
 523 #endif
 524     add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
 525     add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
 526     add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
 527
 528     /* Video options */
 529     add_category_hint( N_("Video"), NULL, VLC_FALSE );
 530     add_module_with_short( "vout", 'V', "video output", NULL, NULL,
 531                            VOUT_TEXT, VOUT_LONGTEXT, VLC_FALSE );
 532     add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
 533     add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
 534     add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
 535     add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
 536     add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
 537     add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
 538 #ifndef SYS_DARWIN
 539     add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
 540 #endif
 541     add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
 542     add_module( "filter", "video filter", NULL, NULL,
 543                 FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
 544     add_string( "aspect-ratio", "", NULL,
 545                 ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
 546 #if 0
 547     add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
 548 #endif
 549
 550     /* Input options */
 551     add_category_hint( N_("Input"), NULL, VLC_FALSE );
 552     add_integer( "server-port", 1234, NULL,
 553                  SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
 554     add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
 555     add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
 556
 557     add_integer( "program", 0, NULL,
 558                  INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
 559     add_integer( "audio-type", -1, NULL,
 560                  INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
 561     add_integer( "audio-channel", -1, NULL,
 562                  INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
 563     add_integer( "spu-channel", -1, NULL,
 564                  INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
 565
 566     add_file( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
 567     add_file( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
 568
 569     add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
 570     add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
 571
 572     /* Decoder options */
 573     add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
 574     add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
 575
 576 #if 0 // Encoders have been disabled for now as we are using the stream output transcoder instead
 577     add_category_hint( N_("Encoders"), NULL, VLC_TRUE );
 578     add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT, VLC_TRUE );
 579     add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT, VLC_TRUE );
 580 #endif
 581
 582     /* Stream output options */
 583     add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
 584     add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
 585     add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );
 586
 587     add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
 588     add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT, VLC_TRUE );
 589     add_bool( "sout-abitrate", 0, NULL, SOUT_ABITRATE_TEXT, SOUT_ABITRATE_LONGTEXT, VLC_TRUE );
 590
 591     add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );
 592     add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT, VLC_TRUE );
 593     add_bool( "sout-vbitrate", 0, NULL, SOUT_VBITRATE_TEXT, SOUT_VBITRATE_LONGTEXT, VLC_TRUE );
 594
 595     add_module( "packetizer", "packetizer", NULL, NULL,
 596                 PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
 597     add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
 598     add_module( "access_output", "sout access", NULL, NULL,
 599                 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
 600     add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
 601
 602     /* CPU options */
 603     add_category_hint( N_("CPU"), NULL, VLC_TRUE );
 604 #if defined( __i386__ )
 605     add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_TRUE );
 606     add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_TRUE );
 607     add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_TRUE );
 608     add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
 609 #endif
 610 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
 611     add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
 612 #endif
 613
 614     /* Playlist options */
 615     add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
 616     add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
 617     add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT, VLC_FALSE );
 618     add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
 619
 620     /* Misc options */
 621     add_category_hint( N_("Miscellaneous"), NULL, VLC_TRUE );
 622     add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
 623     add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
 624     add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
 625
 626 #if defined(WIN32)
 627     add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
 628     add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
 629     add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
 630 #endif
 631
 632     /* Hotkey options*/
 633     add_category_hint( N_("Hot keys"), NULL, VLC_FALSE );
 634     add_key( "fullscreen-key", 'f', NULL, FULLSCREEN_KEY_TEXT, FULLSCREEN_KEY_LONGTEXT, VLC_FALSE );
 635     add_key( "play-pause-key", KEY_SPACE, NULL, PLAY_PAUSE_KEY_TEXT, PLAY_PAUSE_KEY_LONGTEXT, VLC_FALSE );
 636     add_key( "pause-key", 0, NULL, PAUSE_KEY_TEXT, PAUSE_KEY_LONGTEXT, VLC_TRUE );
 637     add_key( "play-key", 0, NULL, PLAY_KEY_TEXT, PLAY_KEY_LONGTEXT, VLC_TRUE );
 638     add_key( "faster-key", '+', NULL, FASTER_KEY_TEXT, FASTER_KEY_LONGTEXT, VLC_FALSE );
 639     add_key( "slower-key", '-', NULL, SLOWER_KEY_TEXT, SLOWER_KEY_LONGTEXT, VLC_FALSE );
 640     add_key( "next-key", 'n', NULL, NEXT_KEY_TEXT, NEXT_KEY_LONGTEXT, VLC_FALSE );
 641     add_key( "prev-key", 'p', NULL, PREV_KEY_TEXT, PREV_KEY_LONGTEXT, VLC_FALSE );
 642     add_key( "stop-key", 's', NULL, STOP_KEY_TEXT, STOP_KEY_LONGTEXT, VLC_FALSE );
 643     add_key( "nav-activate-key", KEY_ENTER, NULL, NAV_ACTIVATE_KEY_TEXT, NAV_ACTIVATE_KEY_LONGTEXT, VLC_FALSE );
 644     add_key( "nav-up-key", KEY_UP, NULL, NAV_UP_KEY_TEXT, NAV_UP_KEY_LONGTEXT, VLC_FALSE );
 645     add_key( "nav-down-key", KEY_DOWN, NULL, NAV_DOWN_KEY_TEXT, NAV_DOWN_KEY_LONGTEXT, VLC_FALSE );
 646     add_key( "nav-left-key", KEY_LEFT, NULL, NAV_LEFT_KEY_TEXT, NAV_LEFT_KEY_LONGTEXT, VLC_FALSE );
 647     add_key( "nav-right-key", KEY_RIGHT, NULL, NAV_RIGHT_KEY_TEXT, NAV_RIGHT_KEY_LONGTEXT, VLC_FALSE );
 648     add_key( "quit-key", KEY_MODIFIER_CTRL|KEY_SPACE, NULL, QUIT_KEY_TEXT, QUIT_KEY_LONGTEXT, VLC_FALSE );
 649     add_key( "vol-up-key", 'a', NULL, VOL_UP_KEY_TEXT, VOL_UP_KEY_LONGTEXT, VLC_FALSE );
 650     add_key( "vol-down-key", 'z', NULL, VOL_DOWN_KEY_TEXT, VOL_DOWN_KEY_LONGTEXT, VLC_FALSE );
 651
 652     /* Usage (mainly useful for cmd line stuff) */
 653     add_usage_hint( PLAYLIST_USAGE );
 654
 655     set_description( N_("main program") );
 656     set_capability( "main", 100 );
 657 vlc_module_end();
 658
 659 static module_config_t p_help_config[] =
 660 {
 661     { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
 662       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 663     { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
 664       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 665     { CONFIG_ITEM_BOOL, NULL, "list", 'l',
 666                               N_("print a list of available modules"),
 667       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 668     { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
 669       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 670     { CONFIG_ITEM_BOOL, NULL, "version", '\0',
 671                               N_("print version information"),
 672       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
 673     { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
 674       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
 675 };
 676
 677 /*****************************************************************************
 678  * End configuration.
 679  *****************************************************************************/