libvlc.h 27.8 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * libvlc.h: main libvlc header
 *****************************************************************************
 * Copyright (C) 1998-2002 VideoLAN
5
 * $Id: libvlc.h,v 1.77 2003/07/20 19:48:30 hartman Exp $
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
 *          Gildas Bazin <gbazin@netcourrier.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

26 27
#define Nothing here, this is just to prevent update-po from being stupid

28
static char *ppsz_sout_acodec[] = { "", "mpga", "mp3", "vorb", "a52", NULL };
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
29
static char *ppsz_sout_vcodec[] = { "", "mpgv", "mp4v", "DIV1", "DIV2", 
30 31
                                 "DIV3", "h263", "i263", "WMV1", "WMV2",
                                 "MJPG", NULL };
Laurent Aimar's avatar
Laurent Aimar committed
32

Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
33
static char *ppsz_language[] = { "auto", "en", "en_GB", "de", "fr", "it",
34
                                 "ja", "nl", "no", "pl", "ru", "sv", NULL };
35

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

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

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

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

64 65 66 67
#define LANGUAGE_TEXT N_("Language")
#define LANGUAGE_LONGTEXT N_( "This option allows you to set the language " \
    "of the interface. The system language is auto-detected if \"auto\" is " \
    "specified here." )
Gildas Bazin's avatar
 
Gildas Bazin committed
68

69
#define COLOR_TEXT N_("Color messages")
70 71 72 73
#define COLOR_LONGTEXT N_( \
    "When this option is turned on, the messages sent to the console will " \
    "be colorized. Your terminal needs Linux color support for this to work.")

74
#define ADVANCED_TEXT N_("Show advanced options")
75
#define ADVANCED_LONGTEXT N_( \
76 77 78
    "When this option is turned on, the preferences and/or interfaces  will " \
    "show all the available options, including those that most users should " \
    "never touch")
79

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

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

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

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

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

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

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
118 119 120 121 122 123 124
#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

125
#define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
126 127 128 129
#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
130 131 132 133 134 135
#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)")

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

141
#define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
142
#define HEADPHONE_LONGTEXT N_( \
143
    "This effect gives you the feeling that you are standing in a room " \
144 145 146 147 148 149
    "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.")

150
#define VOUT_TEXT N_("Video output module")
151
#define VOUT_LONGTEXT N_( \
152
    "This option allows you to select the video output method used by VLC. " \
153 154 155
    "The default behavior is to automatically select the best " \
    "method available.")

156
#define VIDEO_TEXT N_("Enable video")
157 158
#define VIDEO_LONGTEXT N_( \
    "You can completely disable the video output. In this case the video " \
159
    "decoding stage will not take place, which will save some processing power.")
160

161
#define WIDTH_TEXT N_("Video width")
162
#define WIDTH_LONGTEXT N_( \
163
    "You can enforce the video width here. By default (-1) VLC will " \
164 165
    "adapt to the video characteristics.")

166
#define HEIGHT_TEXT N_("Video height")
167
#define HEIGHT_LONGTEXT N_( \
168
    "You can enforce the video height here. By default (-1) VLC will " \
169 170
    "adapt to the video characteristics.")

171
#define ZOOM_TEXT N_("Zoom video")
172 173 174
#define ZOOM_LONGTEXT N_( \
    "You can zoom the video by the specified factor.")

175
#define GRAYSCALE_TEXT N_("Grayscale video output")
176 177 178 179
#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).")

180
#define FULLSCREEN_TEXT N_("Fullscreen video output")
181
#define FULLSCREEN_LONGTEXT N_( \
182
    "If this option is enabled, VLC will always start a video in fullscreen " \
183 184
    "mode.")

185
#define OVERLAY_TEXT N_("Overlay video output")
186
#define OVERLAY_LONGTEXT N_( \
187
    "If enabled, VLC will try to take advantage of the overlay capabilities " \
188
    "of your graphics card.")
189

190
#define SPUMARGIN_TEXT N_("Force SPU position")
191 192 193 194
#define SPUMARGIN_LONGTEXT N_( \
    "You can use this option to place the subtitles under the movie, " \
    "instead of over the movie. Try several positions.")

195
#define FILTER_TEXT N_("Video filter module")
196 197 198 199 200
#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.")

201
#define ASPECT_RATIO_TEXT N_("Source aspect ratio")
202 203 204 205 206 207 208 209 210
#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
211
#define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
212 213 214 215 216 217 218 219
#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

220
#define SERVER_PORT_TEXT N_("Server port")
221 222 223
#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
224
#define MTU_TEXT N_("MTU of the network interface")
Christophe Massiot's avatar
Christophe Massiot committed
225 226 227 228
#define MTU_LONGTEXT N_( \
    "This is the typical size of UDP packets that we expect. On Ethernet " \
    "it is usually 1500.")

229
#define IFACE_ADDR_TEXT N_("Network interface address")
230 231 232
#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 " \
233
    "of your multicasting interface here.")
234

235
#define TTL_TEXT N_("Time to live")
236 237 238 239
#define TTL_LONGTEXT N_( \
    "Indicate here the Time To Live of the multicast packets sent by " \
    "the stream output.")

240
#define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
241 242 243
#define INPUT_PROGRAM_LONGTEXT N_( \
    "Choose the program to select by giving its Service ID.")

244
#define INPUT_AUDIO_TEXT N_("Choose audio")
245
#define INPUT_AUDIO_LONGTEXT N_( \
246 247
    "Give the default type of audio you want to use in a DVD. " \
    "(Developers only)")
248

249
#define INPUT_CHAN_TEXT N_("Choose channel")
250 251 252 253
#define INPUT_CHAN_LONGTEXT N_( \
    "Give the stream number of the audio channel you want to use in a DVD " \
    "(from 1 to n).")

254
#define INPUT_SUBT_TEXT N_("Choose subtitles")
255 256 257 258 259
#define INPUT_SUBT_LONGTEXT N_( \
    "Give the stream number of the subtitle channel you want to use in a " \
    "DVD (from 1 to n).")

#define DVD_DEV_TEXT N_("DVD device")
Gildas Bazin's avatar
 
Gildas Bazin committed
260 261 262 263 264
#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
265 266
#define DVD_DEV_LONGTEXT N_( \
    "This is the default DVD device to use.")
Gildas Bazin's avatar
 
Gildas Bazin committed
267
#endif
268 269 270 271 272

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

273
#define IPV6_TEXT N_("Force IPv6")
274 275 276 277
#define IPV6_LONGTEXT N_( \
    "If you check this box, IPv6 will be used by default for all UDP and " \
    "HTTP connections.")

278
#define IPV4_TEXT N_("Force IPv4")
279 280 281 282
#define IPV4_LONGTEXT N_( \
    "If you check this box, IPv4 will be used by default for all UDP and " \
    "HTTP connections.")

283
#define CODEC_TEXT N_("Choose preferred codec list")
284
#define CODEC_LONGTEXT N_( \
285
    "This allows you to select the order in which VLC will choose its " \
286
    "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
287
    "before the new one. Please be aware that VLC does not make any " \
288 289 290
    "difference between audio or video codecs, so you should always specify " \
    "'any' at the end of the list to make sure there is a fallback for the " \
    "types you didn't specify.")
291

292
#define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
293
#define ENCODER_VIDEO_LONGTEXT N_( \
294
    "This allows you to select the order in which VLC will choose its " \
295
    "codecs. " )
296
#define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
297
#define ENCODER_AUDIO_LONGTEXT N_( \
298
    "This allows you to select the order in which VLC will choose its " \
299 300
    "codecs. " )

301
#define SOUT_TEXT N_("Choose a stream output")
302 303
#define SOUT_LONGTEXT N_( \
    "Empty if no stream output.")
Gildas Bazin's avatar
 
Gildas Bazin committed
304

305
#define SOUT_DISPLAY_TEXT N_("Display while streaming")
306 307 308
#define SOUT_DISPLAY_LONGTEXT N_( \
    "This allows you to play the stream while streaming it.")

309
#define SOUT_VIDEO_TEXT N_("Enable video stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
310 311 312 313
#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.")

314
#define SOUT_VCODEC_TEXT N_("Video encoding codec" )
315 316 317
#define SOUT_VCODEC_LONGTEXT N_( \
    "This allows you to force video encoding")

318
#define SOUT_VBITRATE_TEXT N_("Video bitrate encoding (kB/s)" )
319 320 321
#define SOUT_VBITRATE_LONGTEXT N_( \
    "This allows you to specify video bitrate in kB/s.")

322
#define SOUT_AUDIO_TEXT N_("Enable audio stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
323 324 325 326
#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.")

327
#define SOUT_ACODEC_TEXT N_("Audio encoding codec" )
328 329 330
#define SOUT_ACODEC_LONGTEXT N_( \
    "This allows you to force audio encoding")

331
#define SOUT_ABITRATE_TEXT N_("Audio bitrate encoding (kB/s)" )
332 333 334
#define SOUT_ABITRATE_LONGTEXT N_( \
    "This allows you to specify audio bitrate in kB/s.")

335
#define PACKETIZER_TEXT N_("Choose preferred packetizer list")
336
#define PACKETIZER_LONGTEXT N_( \
337
    "This allows you to select the order in which VLC will choose its " \
338
    "packetizers."  )
Gildas Bazin's avatar
 
Gildas Bazin committed
339

340
#define MUX_TEXT N_("Mux module")
341 342
#define MUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure mux modules")
Gildas Bazin's avatar
 
Gildas Bazin committed
343

344
#define ACCESS_OUTPUT_TEXT N_("Access output module")
345 346 347
#define ACCESS_OUTPUT_LONGTEXT N_( \
    "This is a legacy entry to let you configure access output modules")

348

349
#define MMX_TEXT N_("Enable CPU MMX support")
350
#define MMX_LONGTEXT N_( \
351
    "If your processor supports the MMX instructions set, VLC can take " \
352 353
    "advantage of them.")

354
#define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
355
#define THREE_DN_LONGTEXT N_( \
356
    "If your processor supports the 3D Now! instructions set, VLC can take " \
357 358
    "advantage of them.")

359
#define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
360
#define MMXEXT_LONGTEXT N_( \
361
    "If your processor supports the MMX EXT instructions set, VLC can take " \
362 363
    "advantage of them.")

364
#define SSE_TEXT N_("Enable CPU SSE support")
365
#define SSE_LONGTEXT N_( \
366
    "If your processor supports the SSE instructions set, VLC can take " \
367
    "advantage of them.")
368

369
#define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
370
#define ALTIVEC_LONGTEXT N_( \
371
    "If your processor supports the AltiVec instructions set, VLC can take " \
372 373
    "advantage of them.")

374
#define RANDOM_TEXT N_("Play files randomly forever")
375
#define RANDOM_LONGTEXT N_( \
376
    "When selected, VLC will randomly play files in the playlist until " \
377 378
    "interrupted.")

379
#define ENQUEUE_TEXT N_("Enqueue items in playlist")
380
#define ENQUEUE_LONGTEXT N_( \
381
    "If you want VLC to add items to the playlist as you open them, then " \
382 383
    "enable this option.")

384
#define LOOP_TEXT N_("Loop playlist on end")
385
#define LOOP_LONGTEXT N_( \
386
    "If you want VLC to keep playing the playlist indefinitely then enable " \
387 388
    "this option.")

389
#define MEMCPY_TEXT N_("Memory copy module")
390
#define MEMCPY_LONGTEXT N_( \
391 392
    "You can select which memory copy module you want to use. By default " \
    "VLC will select the fastest one supported by your hardware.")
393

394
#define ACCESS_TEXT N_("Access module")
395 396 397
#define ACCESS_LONGTEXT N_( \
    "This is a legacy entry to let you configure access modules")

398
#define DEMUX_TEXT N_("Demux module")
399 400 401
#define DEMUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure demux modules")

Gildas Bazin's avatar
 
Gildas Bazin committed
402 403 404 405 406 407 408 409 410
#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
411
#define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
412 413 414 415 416 417 418
#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 " \
419
    "(developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
420 421 422 423 424 425 426 427
#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.")
428

Gildas Bazin's avatar
 
Gildas Bazin committed
429 430 431 432 433 434 435 436 437 438 439 440 441
#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>]]" \
    "\n                                 UDP stream sent by VLS" \
    "\n  vlc:pause                      pause execution of " \
    "playlist items" \
    "\n  vlc:quit                       quit VLC" \
    "\n")

442

443 444 445
/*
 * Quick usage guide for the configuration options:
 *
446 447 448 449 450 451 452 453 454
 * 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) );
455 456
 */

457 458
vlc_module_begin();
    /* Interface options */
459
    add_category_hint( N_("Interface"), NULL, VLC_FALSE );
460
    add_module_with_short( "intf", 'I', "interface", NULL, NULL,
461 462
                           INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
    add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
463
    add_integer_with_short( "verbose", 'v', 0, NULL,
464 465
                            VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
    add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
466
    add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
467 468
    add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
    add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
469 470
    add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
    add_directory( "plugin-path", NULL, NULL,
471
                PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
472 473

    /* Audio options */
474
    add_category_hint( N_("Audio"), NULL, VLC_FALSE );
475
    add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
476 477
                           AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
    add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
478 479
    add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
                            AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
480
                            VOLUME_LONGTEXT, VLC_FALSE );
481 482
    add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
                            AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
483 484
                            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
485 486 487
#if !defined( SYS_DARWIN )
    add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT, AOUT_RESAMP_LONGTEXT, VLC_TRUE );
#endif
488
    add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
489
    add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
490
    add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
491 492

    /* Video options */
493
    add_category_hint( N_("Video"), NULL, VLC_FALSE );
494
    add_module_with_short( "vout", 'V', "video output", NULL, NULL,
495 496 497 498 499 500 501
                           VOUT_TEXT, VOUT_LONGTEXT, VLC_FALSE );
    add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
    add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
    add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
    add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
    add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
    add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
502
#ifndef SYS_DARWIN
503
    add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
504
#endif
505
    add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
506
    add_module( "filter", "video filter", NULL, NULL,
507
                FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
508
    add_string( "aspect-ratio", "", NULL,
509
                ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
510 511 512
#if 0
    add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
#endif
513 514

    /* Input options */
515
    add_category_hint( N_("Input"), NULL, VLC_FALSE );
516
    add_integer( "server-port", 1234, NULL,
517 518 519
                 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 );
520 521

    add_integer( "program", 0, NULL,
522
                 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
523
    add_integer( "audio-type", -1, NULL,
524
                 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
525
    add_integer( "audio-channel", -1, NULL,
526
                 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
527
    add_integer( "spu-channel", -1, NULL,
528
                 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
529

Gildas Bazin's avatar
 
Gildas Bazin committed
530 531
    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 );
532

533 534
    add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
    add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
535 536

    /* Decoder options */
537 538
    add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
    add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
539

Gildas Bazin's avatar
 
Gildas Bazin committed
540
#if 0 // Encoders have been disabled for now as we are using the stream output transcoder instead
541 542 543
    add_category_hint( N_("Encoders"), NULL, VLC_TRUE );
    add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT, VLC_TRUE );
    add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
544
#endif
545

Gildas Bazin's avatar
 
Gildas Bazin committed
546
    /* Stream output options */
547 548
    add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
    add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
549 550
    add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );

551 552
    add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
    add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT, VLC_TRUE );
553 554 555
    add_bool( "sout-abitrate", 0, NULL, SOUT_ABITRATE_TEXT, SOUT_ABITRATE_LONGTEXT, VLC_TRUE );

    add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );
556
    add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT, VLC_TRUE );
557 558
    add_bool( "sout-vbitrate", 0, NULL, SOUT_VBITRATE_TEXT, SOUT_VBITRATE_LONGTEXT, VLC_TRUE );

Gildas Bazin's avatar
 
Gildas Bazin committed
559
    add_module( "packetizer", "packetizer", NULL, NULL,
560 561
                PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
    add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
562
    add_module( "access_output", "sout access", NULL, NULL,
563
                ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
564
    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
565

566
    /* CPU options */
Gildas Bazin's avatar
 
Gildas Bazin committed
567
    add_category_hint( N_("CPU"), NULL, VLC_TRUE );
568
#if defined( __i386__ )
Gildas Bazin's avatar
 
Gildas Bazin committed
569 570 571 572
    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 );
573 574
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
Gildas Bazin's avatar
 
Gildas Bazin committed
575
    add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
576 577
#endif

578
    /* Playlist options */
579 580 581 582
    add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
    add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
    add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT, VLC_FALSE );
    add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
Gildas Bazin's avatar
 
Gildas Bazin committed
583

584
    /* Misc options */
585 586 587 588
    add_category_hint( N_("Miscellaneous"), NULL, VLC_TRUE );
    add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
    add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
    add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
589

590
#if defined(WIN32)
Gildas Bazin's avatar
 
Gildas Bazin committed
591
    add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
592 593
    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 );
594
#endif
595

596 597
    /* Usage (mainly useful for cmd line stuff) */
    add_usage_hint( PLAYLIST_USAGE );
598

599 600 601
    set_description( N_("main program") );
    set_capability( "main", 100 );
vlc_module_end();
602 603 604

static module_config_t p_help_config[] =
{
605
    { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
606
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
607
    { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
608
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
609
    { CONFIG_ITEM_BOOL, NULL, "list", 'l',
610
                              N_("print a list of available modules"),
611
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
612
    { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
613
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
614
    { CONFIG_ITEM_BOOL, NULL, "version", '\0',
615
                              N_("print version information"),
616
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
617
    { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
618
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
619 620 621 622 623
};

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