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

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

Laurent Aimar's avatar
Laurent Aimar committed
28 29 30
static char *ppsz_sout_acodec[] = { "", "mpga", "a52", NULL };
static char *ppsz_sout_vcodec[] = { "", "mpgv", "mp4v", "DIV3", "h263", NULL };

31
static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
32
                                 "ja", "nl", "no", "pl", "ru", "sv", NULL };
33

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

46
#define EXTRAINTF_TEXT N_("Extra interface modules")
47
#define EXTRAINTF_LONGTEXT N_( \
48
    "This option allows you to select additional interfaces used by VLC. " \
Sam Hocevar's avatar
Sam Hocevar committed
49
    "They will be launched in the background in addition to the default " \
50 51
    "interface. Use a comma separated list of interface modules.")

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

57
#define QUIET_TEXT N_("Be quiet")
58 59 60
#define QUIET_LONGTEXT N_( \
    "This options turns off all warning and information messages.")

61 62 63 64
#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
65

66
#define COLOR_TEXT N_("Color messages")
67 68 69 70
#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.")

71
#define ADVANCED_TEXT N_("Show advanced options")
72 73 74 75
#define ADVANCED_LONGTEXT N_( \
    "When this option is turned on, the interfaces will show all the " \
    "available options, including those that most users should never touch")

76
#define INTF_PATH_TEXT N_("Interface default search path")
77 78 79 80
#define INTF_PATH_LONGTEXT N_( \
    "This option allows you to set the default path that the interface will " \
    "open when looking for a file.")

81
#define PLUGIN_PATH_TEXT N_("Plugin search path")
82
#define PLUGIN_PATH_LONGTEXT N_( \
83
    "This option allows you to specify an additional path for VLC to look " \
84 85
    "for its plugins.")

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

92
#define AUDIO_TEXT N_("Enable audio")
93 94 95 96
#define AUDIO_LONGTEXT N_( \
    "You can completely disable the audio output. In this case the audio " \
    "decoding stage won't be done, and it will save some processing power.")

97
#define MONO_TEXT N_("Force mono audio")
98 99
#define MONO_LONGTEXT N_("This will force a mono audio output")

100
#define VOLUME_TEXT N_("Audio output volume")
101 102 103 104
#define VOLUME_LONGTEXT N_( \
    "You can set the default audio output volume here, in a range from 0 to " \
    "1024.")

105
#define VOLUME_SAVE_TEXT N_("Audio output saved volume")
106 107 108
#define VOLUME_SAVE_LONGTEXT N_( \
    "This saves the audio output volume when you select mute.")

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

114
#define DESYNC_TEXT N_("Compensate desynchronization of audio (in ms)")
115 116 117 118
#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.")

119
#define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
Gildas Bazin's avatar
 
Gildas Bazin committed
120 121 122 123
#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.")

124
#define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
125 126 127 128 129 130 131 132
#define HEADPHONE_LONGTEXT N_( \
    "This effect gives you the feeling that you stands in a real room " \
    "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.")

133
#define VOUT_TEXT N_("Video output module")
134
#define VOUT_LONGTEXT N_( \
135
    "This option allows you to select the video output method used by VLC. " \
136 137 138
    "The default behavior is to automatically select the best " \
    "method available.")

139
#define VIDEO_TEXT N_("Enable video")
140 141 142 143
#define VIDEO_LONGTEXT N_( \
    "You can completely disable the video output. In this case the video " \
    "decoding stage won't be done, which will save some processing power.")

144
#define DISPLAY_TEXT N_("Display identifier")
145 146 147 148
#define DISPLAY_LONGTEXT N_( \
    "This is the local display port that will be used for X11 drawing. " \
    "For instance :0.1.")

149
#define WIDTH_TEXT N_("Video width")
150
#define WIDTH_LONGTEXT N_( \
151
    "You can enforce the video width here. By default VLC will " \
152 153
    "adapt to the video characteristics.")

154
#define HEIGHT_TEXT N_("Video height")
155
#define HEIGHT_LONGTEXT N_( \
156
    "You can enforce the video height here. By default VLC will " \
157 158
    "adapt to the video characteristics.")

159
#define ZOOM_TEXT N_("Zoom video")
160 161 162
#define ZOOM_LONGTEXT N_( \
    "You can zoom the video by the specified factor.")

163
#define GRAYSCALE_TEXT N_("Grayscale video output")
164 165 166 167
#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).")

168
#define FULLSCREEN_TEXT N_("Fullscreen video output")
169
#define FULLSCREEN_LONGTEXT N_( \
170
    "If this option is enabled, VLC will always start a video in fullscreen " \
171 172
    "mode.")

173
#define OVERLAY_TEXT N_("Overlay video output")
174
#define OVERLAY_LONGTEXT N_( \
175
    "If enabled, VLC will try to take advantage of the overlay capabilities " \
176
    "of your graphic card.")
177

178
#define SPUMARGIN_TEXT N_("Force SPU position")
179 180 181 182
#define SPUMARGIN_LONGTEXT N_( \
    "You can use this option to place the subtitles under the movie, " \
    "instead of over the movie. Try several positions.")

183
#define FILTER_TEXT N_("Video filter module")
184 185 186 187 188
#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.")

189
#define ASPECT_RATIO_TEXT N_("Source aspect ratio")
190 191 192 193 194 195 196 197 198
#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
199
#define PIXEL_RATIO_TEXT N_("Destination aspect ratio")
200 201 202 203 204 205 206 207
#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

208
#define SERVER_PORT_TEXT N_("Server port")
209 210 211
#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
212
#define MTU_TEXT N_("MTU of the network interface")
Christophe Massiot's avatar
Christophe Massiot committed
213 214 215 216
#define MTU_LONGTEXT N_( \
    "This is the typical size of UDP packets that we expect. On Ethernet " \
    "it is usually 1500.")

217
#define IFACE_ADDR_TEXT N_("Network interface address")
218 219 220
#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 " \
221
    "of your multicasting interface here.")
222

223
#define TTL_TEXT N_("Time to live")
224 225 226 227
#define TTL_LONGTEXT N_( \
    "Indicate here the Time To Live of the multicast packets sent by " \
    "the stream output.")

228
#define INPUT_PROGRAM_TEXT N_("Choose program (SID)")
229 230 231
#define INPUT_PROGRAM_LONGTEXT N_( \
    "Choose the program to select by giving its Service ID.")

232
#define INPUT_AUDIO_TEXT N_("Choose audio")
233 234 235
#define INPUT_AUDIO_LONGTEXT N_( \
    "Give the default type of audio you want to use in a DVD.")

236
#define INPUT_CHAN_TEXT N_("Choose channel")
237 238 239 240
#define INPUT_CHAN_LONGTEXT N_( \
    "Give the stream number of the audio channel you want to use in a DVD " \
    "(from 1 to n).")

241
#define INPUT_SUBT_TEXT N_("Choose subtitles")
242 243 244 245 246
#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
247 248 249 250 251
#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
252 253
#define DVD_DEV_LONGTEXT N_( \
    "This is the default DVD device to use.")
Gildas Bazin's avatar
 
Gildas Bazin committed
254
#endif
255 256 257 258 259

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

260
#define IPV6_TEXT N_("Force IPv6")
261 262 263 264
#define IPV6_LONGTEXT N_( \
    "If you check this box, IPv6 will be used by default for all UDP and " \
    "HTTP connections.")

265
#define IPV4_TEXT N_("Force IPv4")
266 267 268 269
#define IPV4_LONGTEXT N_( \
    "If you check this box, IPv4 will be used by default for all UDP and " \
    "HTTP connections.")

270
#define CODEC_TEXT N_("Choose preferred codec list")
271
#define CODEC_LONGTEXT N_( \
272
    "This allows you to select the order in which VLC will choose its " \
273
    "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
274
    "before the new one. Please be aware that VLC does not make any " \
275 276 277
    "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.")
278

279
#define ENCODER_VIDEO_TEXT N_("Choose preferred video encoder list")
280
#define ENCODER_VIDEO_LONGTEXT N_( \
281
    "This allows you to select the order in which VLC will choose its " \
282
    "codecs. " )
283
#define ENCODER_AUDIO_TEXT N_("Choose preferred audio encoder list")
284
#define ENCODER_AUDIO_LONGTEXT N_( \
285
    "This allows you to select the order in which VLC will choose its " \
286 287
    "codecs. " )

288
#define SOUT_TEXT N_("Choose a stream output")
289 290
#define SOUT_LONGTEXT N_( \
    "Empty if no stream output.")
Gildas Bazin's avatar
 
Gildas Bazin committed
291

292
#define SOUT_DISPLAY_TEXT N_("Display while streaming")
293 294 295
#define SOUT_DISPLAY_LONGTEXT N_( \
    "This allows you to play the stream while streaming it.")

296
#define SOUT_VIDEO_TEXT N_("Enable video stream output")
Gildas Bazin's avatar
 
Gildas Bazin committed
297 298 299 300
#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.")

301
#define SOUT_VCODEC_TEXT N_("Video encoding codec" )
302 303 304
#define SOUT_VCODEC_LONGTEXT N_( \
    "This allows you to force video encoding")

305
#define SOUT_VBITRATE_TEXT N_("Video bitrate encoding (kB/s)" )
306 307 308
#define SOUT_VBITRATE_LONGTEXT N_( \
    "This allows you to specify video bitrate in kB/s.")

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

314
#define SOUT_ACODEC_TEXT N_("Audio encoding codec" )
315 316 317
#define SOUT_ACODEC_LONGTEXT N_( \
    "This allows you to force audio encoding")

318
#define SOUT_ABITRATE_TEXT N_("Audio bitrate encoding (kB/s)" )
319 320 321
#define SOUT_ABITRATE_LONGTEXT N_( \
    "This allows you to specify audio bitrate in kB/s.")

322
#define PACKETIZER_TEXT N_("Choose preferred packetizer list")
323
#define PACKETIZER_LONGTEXT N_( \
324
    "This allows you to select the order in which VLC will choose its " \
325
    "packetizers."  )
Gildas Bazin's avatar
 
Gildas Bazin committed
326

327
#define MUX_TEXT N_("Mux module")
328 329
#define MUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure mux modules")
Gildas Bazin's avatar
 
Gildas Bazin committed
330

331
#define ACCESS_OUTPUT_TEXT N_("Access output module")
332 333 334
#define ACCESS_OUTPUT_LONGTEXT N_( \
    "This is a legacy entry to let you configure access output modules")

335

336
#define MMX_TEXT N_("Enable CPU MMX support")
337
#define MMX_LONGTEXT N_( \
338
    "If your processor supports the MMX instructions set, VLC can take " \
339 340
    "advantage of them.")

341
#define THREE_DN_TEXT N_("Enable CPU 3D Now! support")
342
#define THREE_DN_LONGTEXT N_( \
343
    "If your processor supports the 3D Now! instructions set, VLC can take " \
344 345
    "advantage of them.")

346
#define MMXEXT_TEXT N_("Enable CPU MMX EXT support")
347
#define MMXEXT_LONGTEXT N_( \
348
    "If your processor supports the MMX EXT instructions set, VLC can take " \
349 350
    "advantage of them.")

351
#define SSE_TEXT N_("Enable CPU SSE support")
352
#define SSE_LONGTEXT N_( \
353
    "If your processor supports the SSE instructions set, VLC can take " \
354
    "advantage of them.")
355

356
#define ALTIVEC_TEXT N_("Enable CPU AltiVec support")
357
#define ALTIVEC_LONGTEXT N_( \
358
    "If your processor supports the AltiVec instructions set, VLC can take " \
359 360
    "advantage of them.")

361
#define RANDOM_TEXT N_("Play files randomly forever")
362
#define RANDOM_LONGTEXT N_( \
363
    "When selected, VLC will randomly play files in the playlist until " \
364 365
    "interrupted.")

366
#define LAUNCH_TEXT N_("Launch playlist on startup")
367
#define LAUNCH_LONGTEXT N_( \
368
    "If you want VLC to start playing on startup, then enable this option.")
369

370
#define ENQUEUE_TEXT N_("Enqueue items in playlist")
371
#define ENQUEUE_LONGTEXT N_( \
372
    "If you want VLC to add items to the playlist as you open them, then " \
373 374
    "enable this option.")

375
#define LOOP_TEXT N_("Loop playlist on end")
376
#define LOOP_LONGTEXT N_( \
377
    "If you want VLC to keep playing the playlist indefinitely then enable " \
378 379
    "this option.")

380
#define MEMCPY_TEXT N_("Memory copy module")
381
#define MEMCPY_LONGTEXT N_( \
382 383
    "You can select which memory copy module you want to use. By default " \
    "VLC will select the fastest one supported by your hardware.")
384

385
#define ACCESS_TEXT N_("Access module")
386 387 388
#define ACCESS_LONGTEXT N_( \
    "This is a legacy entry to let you configure access modules")

389
#define DEMUX_TEXT N_("Demux module")
390 391 392
#define DEMUX_LONGTEXT N_( \
    "This is a legacy entry to let you configure demux modules")

393
#define FAST_MUTEX_TEXT N_("Dast mutex on NT/2K/XP (developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
394 395 396 397 398 399 400
#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 " \
401
    "(developers only)")
Gildas Bazin's avatar
 
Gildas Bazin committed
402 403 404 405 406 407 408 409
#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.")
410

411 412
#define RT_PRIORITY_TEXT N_("Real-time priority")

Gildas Bazin's avatar
 
Gildas Bazin committed
413 414 415 416 417 418 419 420 421 422 423 424 425
#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")

426

427 428 429
/*
 * Quick usage guide for the configuration options:
 *
430 431 432 433 434 435 436 437 438
 * 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) );
439 440
 */

441 442
vlc_module_begin();
    /* Interface options */
443
    add_category_hint( N_("Interface"), NULL, VLC_FALSE );
444
    add_module_with_short( "intf", 'I', "interface", NULL, NULL,
445 446
                           INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
    add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
447
    add_integer_with_short( "verbose", 'v', -1, NULL,
448 449
                            VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
    add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
450
    add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
451 452 453
    add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
    add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
    add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
454
    add_string( "plugin-path", NULL, NULL,
455
                PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
456 457

    /* Audio options */
458
    add_category_hint( N_("Audio"), NULL, VLC_FALSE );
459
    add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
460 461
                           AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
    add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
462 463
    add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
                            AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
464
                            VOLUME_LONGTEXT, VLC_FALSE );
465 466
    add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
                            AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
467 468 469
                            VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
    add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
    add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
Gildas Bazin's avatar
 
Gildas Bazin committed
470
    add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
471
    add_bool( "headphone-opt", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
472 473

    /* Video options */
474
    add_category_hint( N_("Video"), NULL, VLC_FALSE );
475
    add_module_with_short( "vout", 'V', "video output", NULL, NULL,
476 477 478 479 480 481 482 483 484
                           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 );
    add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
    add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
485
    add_module( "filter", "video filter", NULL, NULL,
486
                FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
487
    add_string( "aspect-ratio", "", NULL,
488
                ASPECT_RATIO_TEXT, ASPECT_RATIO_LONGTEXT, VLC_TRUE );
489 490 491
#if 0
    add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
#endif
492 493

    /* Input options */
494
    add_category_hint( N_("Input"), NULL, VLC_FALSE );
495
    add_integer( "server-port", 1234, NULL,
496 497 498 499
                 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 );
    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
500 501

    add_integer( "program", 0, NULL,
502
                 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
503
    add_integer( "audio-type", -1, NULL,
504
                 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
505
    add_integer( "audio-channel", -1, NULL,
506
                 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
507
    add_integer( "spu-channel", -1, NULL,
508
                 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
509

Gildas Bazin's avatar
 
Gildas Bazin committed
510 511
    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 );
512

513 514
    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 );
515 516

    /* Decoder options */
517 518
    add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
    add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
519

520 521 522
    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 );
523

Gildas Bazin's avatar
 
Gildas Bazin committed
524
    /* Stream output options */
525 526
    add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
    add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
527 528
    add_bool( "sout-display", VLC_FALSE, NULL, SOUT_DISPLAY_TEXT, SOUT_DISPLAY_LONGTEXT, VLC_TRUE );

529 530
    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 );
531 532 533
    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 );
534
    add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT, VLC_TRUE );
535 536
    add_bool( "sout-vbitrate", 0, NULL, SOUT_VBITRATE_TEXT, SOUT_VBITRATE_LONGTEXT, VLC_TRUE );

Gildas Bazin's avatar
 
Gildas Bazin committed
537
    add_module( "packetizer", "packetizer", NULL, NULL,
538 539
                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
540
    add_module( "access_output", "sout access", NULL, NULL,
541
                ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
542

543
    /* CPU options */
Gildas Bazin's avatar
 
Gildas Bazin committed
544
    add_category_hint( N_("CPU"), NULL, VLC_TRUE );
545
#if defined( __i386__ )
Gildas Bazin's avatar
 
Gildas Bazin committed
546 547 548 549
    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 );
550 551
#endif
#if defined( __powerpc__ ) || defined( SYS_DARWIN )
Gildas Bazin's avatar
 
Gildas Bazin committed
552
    add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
553 554
#endif

555
    /* Playlist options */
556 557 558 559 560
    add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
    add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
    add_bool( "playlist", 0, NULL, LAUNCH_TEXT, LAUNCH_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
561

562
    /* Misc options */
563 564 565 566
    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 );
567

568
#if defined(WIN32)
569 570
    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 );
571
#endif
572

573 574
    /* Usage (mainly useful for cmd line stuff) */
    add_usage_hint( PLAYLIST_USAGE );
575

576 577 578
    set_description( N_("main program") );
    set_capability( "main", 100 );
vlc_module_end();
579 580 581

static module_config_t p_help_config[] =
{
582
    { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
583
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
584
    { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
585
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
586
    { CONFIG_ITEM_BOOL, NULL, "list", 'l',
587
                              N_("print a list of available modules"),
588
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
589
    { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
590
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
591
    { CONFIG_ITEM_BOOL, NULL, "version", '\0',
592
                              N_("print version information"),
593
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
594
    { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
595
      NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
596 597 598 599 600
};

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