* Renamed all tags (eg. v0_2_83 -> 0.2.83).
[vlc.git] / src / libvlc.h
blob5f0ce916504e09ed40a5301a52fab1111276ef06
1 /*****************************************************************************
2 * libvlc.h: main libvlc header
3 *****************************************************************************
4 * Copyright (C) 1998-2002 VideoLAN
5 * $Id: libvlc.h,v 1.48 2003/03/10 00:04:14 massiot Exp $
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@netcourrier.com>
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.
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.
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 *****************************************************************************/
26 #define Nothing here, this is just to prevent update-po from being stupid
28 static char *ppsz_sout_acodec[] = { "", "mpeg1", "mpeg2", "mpeg4", "vorbis", NULL };
29 static char *ppsz_sout_vcodec[] = { "", "mpeg1", "mpeg2", "mpeg4", NULL };
31 /*****************************************************************************
32 * Configuration options for the main program. Each module will also separatly
33 * define its own configuration options.
34 * Look into configuration.h if you need to know more about the following
35 * macros.
36 *****************************************************************************/
37 #define INTF_TEXT N_("interface module")
38 #define INTF_LONGTEXT N_( \
39 "This option allows you to select the interface used by VLC. " \
40 "The default behavior is to automatically select the best module " \
41 "available.")
43 #define EXTRAINTF_TEXT N_("extra interface modules")
44 #define EXTRAINTF_LONGTEXT N_( \
45 "This option allows you to select additional interfaces used by VLC. " \
46 "They will be launched in the background in addition to the default " \
47 "interface. Use a comma separated list of interface modules.")
49 #define VERBOSE_TEXT N_("verbosity (0,1,2)")
50 #define VERBOSE_LONGTEXT N_( \
51 "This options sets the verbosity level (0=only errors and " \
52 "standard messages, 1=warnings, 2=debug).")
54 #define QUIET_TEXT N_("be quiet")
55 #define QUIET_LONGTEXT N_( \
56 "This options turns off all warning and information messages.")
58 #define COLOR_TEXT N_("color messages")
59 #define COLOR_LONGTEXT N_( \
60 "When this option is turned on, the messages sent to the console will " \
61 "be colorized. Your terminal needs Linux color support for this to work.")
63 #define ADVANCED_TEXT N_("show advanced options")
64 #define ADVANCED_LONGTEXT N_( \
65 "When this option is turned on, the interfaces will show all the " \
66 "available options, including those that most users should never touch")
68 #define INTF_PATH_TEXT N_("interface default search path")
69 #define INTF_PATH_LONGTEXT N_( \
70 "This option allows you to set the default path that the interface will " \
71 "open when looking for a file.")
73 #define PLUGIN_PATH_TEXT N_("plugin search path")
74 #define PLUGIN_PATH_LONGTEXT N_( \
75 "This option allows you to specify an additional path for VLC to look " \
76 "for its plugins.")
78 #define AOUT_TEXT N_("audio output module")
79 #define AOUT_LONGTEXT N_( \
80 "This option allows you to select the audio output method used by VLC. " \
81 "The default behavior is to automatically select the best method " \
82 "available.")
84 #define AUDIO_TEXT N_("enable audio")
85 #define AUDIO_LONGTEXT N_( \
86 "You can completely disable the audio output. In this case the audio " \
87 "decoding stage won't be done, and it will save some processing power.")
89 #define MONO_TEXT N_("force mono audio")
90 #define MONO_LONGTEXT N_("This will force a mono audio output")
92 #define VOLUME_TEXT N_("audio output volume")
93 #define VOLUME_LONGTEXT N_( \
94 "You can set the default audio output volume here, in a range from 0 to " \
95 "1024.")
97 #define VOLUME_SAVE_TEXT N_("audio output saved volume")
98 #define VOLUME_SAVE_LONGTEXT N_( \
99 "This saves the audio output volume when you select mute.")
101 #define AOUT_RATE_TEXT N_("audio output frequency (Hz)")
102 #define AOUT_RATE_LONGTEXT N_( \
103 "You can force the audio output frequency here. Common values are " \
104 "48000, 44100, 32000, 22050, 16000, 11025, 8000.")
106 #define DESYNC_TEXT N_("compensate desynchronization of audio (in ms)")
107 #define DESYNC_LONGTEXT N_( \
108 "This option allows you to delay the audio output. This can be handy if " \
109 "you notice a lag between the video and the audio.")
111 #define SPDIF_TEXT N_("use the S/PDIF audio output when available")
112 #define SPDIF_LONGTEXT N_( \
113 "This option allows you to use the S/PDIF audio output by default when " \
114 "your hardware supports it as well as the audio stream being played.")
116 #define HEADPHONE_TEXT N_("headphone virtual spatialization effect")
117 #define HEADPHONE_LONGTEXT N_( \
118 "This effect gives you the feeling that you stands in a real room " \
119 "with a complete 5.1 speaker set when using only a headphone, " \
120 "providing a more realistic sound experience. It should also be " \
121 "more comfortable and less tiring when listening to music for " \
122 "long periods of time.\nIt works with any source format from mono " \
123 "to 5.1.")
125 #define HEADPHONE_DIM_TEXT N_("characteristic dimension")
126 #define HEADPHONE_DIM_LONGTEXT N_( \
127 "Headphone virtual spatialization effect parameter: "\
128 "distance between front left speaker and listener in meters.")
130 #define VOUT_TEXT N_("video output module")
131 #define VOUT_LONGTEXT N_( \
132 "This option allows you to select the video output method used by VLC. " \
133 "The default behavior is to automatically select the best " \
134 "method available.")
136 #define VIDEO_TEXT N_("enable video")
137 #define VIDEO_LONGTEXT N_( \
138 "You can completely disable the video output. In this case the video " \
139 "decoding stage won't be done, which will save some processing power.")
141 #define DISPLAY_TEXT N_("display identifier")
142 #define DISPLAY_LONGTEXT N_( \
143 "This is the local display port that will be used for X11 drawing. " \
144 "For instance :0.1.")
146 #define WIDTH_TEXT N_("video width")
147 #define WIDTH_LONGTEXT N_( \
148 "You can enforce the video width here. By default VLC will " \
149 "adapt to the video characteristics.")
151 #define HEIGHT_TEXT N_("video height")
152 #define HEIGHT_LONGTEXT N_( \
153 "You can enforce the video height here. By default VLC will " \
154 "adapt to the video characteristics.")
156 #define ZOOM_TEXT N_("zoom video")
157 #define ZOOM_LONGTEXT N_( \
158 "You can zoom the video by the specified factor.")
160 #define GRAYSCALE_TEXT N_("grayscale video output")
161 #define GRAYSCALE_LONGTEXT N_( \
162 "When enabled, the color information from the video won't be decoded " \
163 "(this can also allow you to save some processing power).")
165 #define FULLSCREEN_TEXT N_("fullscreen video output")
166 #define FULLSCREEN_LONGTEXT N_( \
167 "If this option is enabled, VLC will always start a video in fullscreen " \
168 "mode.")
170 #define OVERLAY_TEXT N_("overlay video output")
171 #define OVERLAY_LONGTEXT N_( \
172 "If enabled, VLC will try to take advantage of the overlay capabilities " \
173 "of your graphic card.")
175 #define SPUMARGIN_TEXT N_("force SPU position")
176 #define SPUMARGIN_LONGTEXT N_( \
177 "You can use this option to place the subtitles under the movie, " \
178 "instead of over the movie. Try several positions.")
180 #define FILTER_TEXT N_("video filter module")
181 #define FILTER_LONGTEXT N_( \
182 "This will allow you to add a post-processing filter to enhance the " \
183 "picture quality, for instance deinterlacing, or to clone or distort " \
184 "the video window.")
186 #define ASPECT_RATIO_TEXT N_("source aspect ratio")
187 #define ASPECT_RATIO_LONGTEXT N_( \
188 "This will force the source aspect ratio. For instance, some DVDs claim " \
189 "to be 16:9 while they are actually 4:3. This can also be used as a " \
190 "hint for VLC when a movie does not have aspect ratio information. " \
191 "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
192 "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
193 "squareness.")
195 #if 0
196 #define PIXEL_RATIO_TEXT N_("destination aspect ratio")
197 #define PIXEL_RATIO_LONGTEXT N_( \
198 "This will force the destination pixel size. By default VLC assumes " \
199 "your pixels are square, unless your hardware has a way to tell it " \
200 "otherwise. This may be used when you output VLC's signal to another " \
201 "device such as a TV set. Accepted format is a float value (1, 1.25, " \
202 "1.3333, etc.) expressing pixel squareness.")
203 #endif
205 #define SERVER_PORT_TEXT N_("server port")
206 #define SERVER_PORT_LONGTEXT N_( \
207 "This is the port used for UDP streams. By default, we chose 1234.")
209 #define MTU_TEXT N_("MTU of the network interface")
210 #define MTU_LONGTEXT N_( \
211 "This is the typical size of UDP packets that we expect. On Ethernet " \
212 "it is usually 1500.")
214 #define NETCHANNEL_TEXT N_("enable network channel mode")
215 #define NETCHANNEL_LONGTEXT N_( \
216 "Activate this option if you want to use the VideoLAN Channel Server.")
218 #define CHAN_SERV_TEXT N_("channel server address")
219 #define CHAN_SERV_LONGTEXT N_( \
220 "Indicate here the address of the VideoLAN Channel Server.")
222 #define CHAN_PORT_TEXT N_("channel server port")
223 #define CHAN_PORT_LONGTEXT N_( \
224 "Indicate here the port on which the VideoLAN Channel Server runs.")
226 #define IFACE_TEXT N_("network interface")
227 #define IFACE_LONGTEXT N_( \
228 "If you have several interfaces on your Linux machine and use the " \
229 "VLAN solution, you may indicate here which interface to use.")
231 #define IFACE_ADDR_TEXT N_("network interface address")
232 #define IFACE_ADDR_LONGTEXT N_( \
233 "If you have several interfaces on your machine and use the " \
234 "multicast solution, you will probably have to indicate the IP address " \
235 "of your multicasting interface here.")
237 #define TTL_TEXT N_("time to live")
238 #define TTL_LONGTEXT N_( \
239 "Indicate here the Time To Live of the multicast packets sent by " \
240 "the stream output.")
242 #define INPUT_PROGRAM_TEXT N_("choose program (SID)")
243 #define INPUT_PROGRAM_LONGTEXT N_( \
244 "Choose the program to select by giving its Service ID.")
246 #define INPUT_AUDIO_TEXT N_("choose audio")
247 #define INPUT_AUDIO_LONGTEXT N_( \
248 "Give the default type of audio you want to use in a DVD.")
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).")
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).")
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
270 #define VCD_DEV_TEXT N_("VCD device")
271 #define VCD_DEV_LONGTEXT N_( \
272 "This is the default VCD device to use.")
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.")
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.")
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.")
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. " )
302 #define SOUT_TEXT N_("choose a stream output")
303 #define SOUT_LONGTEXT N_( \
304 "Empty if no stream output.")
306 #define SOUT_VIDEO_TEXT N_("enable video stream output")
307 #define SOUT_VIDEO_LONGTEXT N_( \
308 "This allows you to choose if the video stream should be redirected to " \
309 "the stream output facility when this last one is enabled.")
311 #define SOUT_VCODEC_TEXT N_("video encoding codec" )
312 #define SOUT_VCODEC_LONGTEXT N_( \
313 "This allows you to force video encoding")
315 #define SOUT_AUDIO_TEXT N_("enable audio stream output")
316 #define SOUT_AUDIO_LONGTEXT N_( \
317 "This allows you to choose if the video stream should be redirected to " \
318 "the stream output facility when this last one is enabled.")
320 #define SOUT_ACODEC_TEXT N_("audio encoding codec" )
321 #define SOUT_ACODEC_LONGTEXT N_( \
322 "This allows you to force audio encoding")
324 #define PACKETIZER_TEXT N_("choose preferred packetizer list")
325 #define PACKETIZER_LONGTEXT N_( \
326 "This allows you to select the order in which VLC will choose its " \
327 "packetizers." )
329 #define MUX_TEXT N_("mux module")
330 #define MUX_LONGTEXT N_( \
331 "This is a legacy entry to let you configure mux modules")
333 #define ACCESS_OUTPUT_TEXT N_("access output module")
334 #define ACCESS_OUTPUT_LONGTEXT N_( \
335 "This is a legacy entry to let you configure access output modules")
338 #define MMX_TEXT N_("enable CPU MMX support")
339 #define MMX_LONGTEXT N_( \
340 "If your processor supports the MMX instructions set, VLC can take " \
341 "advantage of them.")
343 #define THREE_DN_TEXT N_("enable CPU 3D Now! support")
344 #define THREE_DN_LONGTEXT N_( \
345 "If your processor supports the 3D Now! instructions set, VLC can take " \
346 "advantage of them.")
348 #define MMXEXT_TEXT N_("enable CPU MMX EXT support")
349 #define MMXEXT_LONGTEXT N_( \
350 "If your processor supports the MMX EXT instructions set, VLC can take " \
351 "advantage of them.")
353 #define SSE_TEXT N_("enable CPU SSE support")
354 #define SSE_LONGTEXT N_( \
355 "If your processor supports the SSE instructions set, VLC can take " \
356 "advantage of them.")
358 #define ALTIVEC_TEXT N_("enable CPU AltiVec support")
359 #define ALTIVEC_LONGTEXT N_( \
360 "If your processor supports the AltiVec instructions set, VLC can take " \
361 "advantage of them.")
363 #define RANDOM_TEXT N_("play files randomly forever")
364 #define RANDOM_LONGTEXT N_( \
365 "When selected, VLC will randomly play files in the playlist until " \
366 "interrupted.")
368 #define LAUNCH_TEXT N_("launch playlist on startup")
369 #define LAUNCH_LONGTEXT N_( \
370 "If you want VLC to start playing on startup, then enable this option.")
372 #define ENQUEUE_TEXT N_("enqueue items in playlist")
373 #define ENQUEUE_LONGTEXT N_( \
374 "If you want VLC to add items to the playlist as you open them, then " \
375 "enable this option.")
377 #define LOOP_TEXT N_("loop playlist on end")
378 #define LOOP_LONGTEXT N_( \
379 "If you want VLC to keep playing the playlist indefinitely then enable " \
380 "this option.")
382 #define MEMCPY_TEXT N_("memory copy module")
383 #define MEMCPY_LONGTEXT N_( \
384 "You can select which memory copy module you want to use. By default " \
385 "VLC will select the fastest one supported by your hardware.")
387 #define ACCESS_TEXT N_("access module")
388 #define ACCESS_LONGTEXT N_( \
389 "This is a legacy entry to let you configure access modules")
391 #define DEMUX_TEXT N_("demux module")
392 #define DEMUX_LONGTEXT N_( \
393 "This is a legacy entry to let you configure demux modules")
395 #define FAST_MUTEX_TEXT N_("fast mutex on NT/2K/XP (developers only)")
396 #define FAST_MUTEX_LONGTEXT N_( \
397 "On Windows NT/2K/XP we use a slow mutex implementation but which " \
398 "allows us to correctely implement condition variables. " \
399 "You can also use the faster Win9x implementation but you might " \
400 "experience problems with it.")
402 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
403 "(developers only)")
404 #define WIN9X_CV_LONGTEXT N_( \
405 "On Windows 9x/Me we use a fast but not correct condition variables " \
406 "implementation (more precisely there is a possibility for a race " \
407 "condition to happen). " \
408 "However it is possible to use slower alternatives which should be more " \
409 "robust. " \
410 "Currently you can choose between implementation 0 (which is the " \
411 "default and the fastest), 1 and 2.")
413 #define RT_PRIORITY_TEXT N_("Real-time priority")
415 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
416 "\n *.mpg, *.vob plain MPEG-1/2 files" \
417 "\n [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
418 "\n DVD device" \
419 "\n [vcd:][device][@[title][,[chapter]]" \
420 "\n VCD device" \
421 "\n udpstream:[@[<bind address>][:<bind port>]]" \
422 "\n UDP stream sent by VLS" \
423 "\n vlc:pause pause execution of " \
424 "playlist items" \
425 "\n vlc:quit quit VLC" \
426 "\n")
430 * Quick usage guide for the configuration options:
432 * add_category_hint( N_(text), N_(longtext) );
433 * add_subcategory_hint( N_(text), N_(longtext) );
434 * add_usage_hint( N_(text) );
435 * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
436 * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
437 * add_module( option_name, psz_value, i_capability, p_callback,
438 * N_(text), N_(longtext) );
439 * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
440 * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
443 vlc_module_begin();
444 /* Interface options */
445 add_category_hint( N_("Interface"), NULL, VLC_FALSE );
446 add_module_with_short( "intf", 'I', "interface", NULL, NULL,
447 INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
448 add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
449 add_integer_with_short( "verbose", 'v', -1, NULL,
450 VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
451 add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
452 add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
453 add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
454 add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
455 add_string( "plugin-path", NULL, NULL,
456 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
458 /* Audio options */
459 add_category_hint( N_("Audio"), NULL, VLC_FALSE );
460 add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
461 AOUT_TEXT, AOUT_LONGTEXT, VLC_FALSE );
462 add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT, VLC_TRUE );
463 add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
464 AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
465 VOLUME_LONGTEXT, VLC_FALSE );
466 add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
467 AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
468 VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT, VLC_TRUE );
469 add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT, VLC_TRUE );
470 add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT, VLC_TRUE );
471 add_bool( "spdif", 0, NULL, SPDIF_TEXT, SPDIF_LONGTEXT, VLC_FALSE );
472 add_bool( "headphone", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT, VLC_FALSE );
473 add_integer( "headphone-dim", 5, NULL, HEADPHONE_DIM_TEXT,
474 HEADPHONE_DIM_LONGTEXT, VLC_TRUE );
476 /* Video options */
477 add_category_hint( N_("Video"), NULL, VLC_FALSE );
478 add_module_with_short( "vout", 'V', "video output", NULL, NULL,
479 VOUT_TEXT, VOUT_LONGTEXT, VLC_FALSE );
480 add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT, VLC_TRUE );
481 add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
482 add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_TRUE );
483 add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
484 add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
485 add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
486 add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
487 add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
488 add_module( "filter", "video filter", NULL, NULL,
489 FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
490 add_string( "aspect-ratio", "", NULL,
491 ASPECT_RATIO_TEXT, ASPECT_RATIO_TEXT, VLC_TRUE );
492 #if 0
493 add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
494 #endif
496 /* Input options */
497 add_category_hint( N_("Input"), NULL, VLC_FALSE );
498 add_integer( "server-port", 1234, NULL,
499 SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
500 add_bool( "network-channel", 0, NULL,
501 NETCHANNEL_TEXT, NETCHANNEL_LONGTEXT, VLC_TRUE );
502 add_string( "channel-server", "localhost", NULL,
503 CHAN_SERV_TEXT, CHAN_SERV_LONGTEXT, VLC_TRUE );
504 add_integer( "channel-port", 6010, NULL,
505 CHAN_PORT_TEXT, CHAN_PORT_LONGTEXT, VLC_TRUE );
506 add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
507 #ifdef SYS_DARWIN
508 add_string( "iface", "en0", NULL, IFACE_TEXT, IFACE_LONGTEXT, VLC_TRUE );
509 #else
510 add_string( "iface", "eth0", NULL, IFACE_TEXT, IFACE_LONGTEXT, VLC_TRUE );
511 #endif
512 add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
513 add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
515 add_integer( "program", 0, NULL,
516 INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
517 add_integer( "audio-type", -1, NULL,
518 INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT, VLC_TRUE );
519 add_integer( "audio-channel", -1, NULL,
520 INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT, VLC_TRUE );
521 add_integer( "spu-channel", -1, NULL,
522 INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT, VLC_TRUE );
524 add_string( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT, VLC_FALSE );
525 add_string( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT, VLC_FALSE );
527 add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT, VLC_FALSE );
528 add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT, VLC_FALSE );
530 /* Decoder options */
531 add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
532 add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
534 add_category_hint( N_("Encoders"), NULL, VLC_TRUE );
535 add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT, VLC_TRUE );
536 add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT, VLC_TRUE );
538 /* Stream output options */
539 add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
540 add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT, VLC_TRUE );
541 add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT, VLC_TRUE );
542 add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT, VLC_TRUE );
543 add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT, VLC_TRUE );
544 add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT, VLC_TRUE );
545 add_module( "packetizer", "packetizer", NULL, NULL,
546 PACKETIZER_TEXT, PACKETIZER_LONGTEXT, VLC_TRUE );
547 add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
548 add_module( "access_output", "sout access", NULL, NULL,
549 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
551 /* CPU options */
552 add_category_hint( N_("CPU"), NULL, VLC_FALSE );
553 #if defined( __i386__ )
554 add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT, VLC_FALSE );
555 add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT, VLC_FALSE );
556 add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT, VLC_FALSE );
557 add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_FALSE );
558 #endif
559 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
560 add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_FALSE );
561 #endif
563 /* Playlist options */
564 add_category_hint( N_("Playlist"), NULL, VLC_FALSE );
565 add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
566 add_bool( "playlist", 0, NULL, LAUNCH_TEXT, LAUNCH_LONGTEXT, VLC_FALSE );
567 add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT, VLC_FALSE );
568 add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
570 /* Misc options */
571 add_category_hint( N_("Miscellaneous"), NULL, VLC_TRUE );
572 add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT, VLC_TRUE );
573 add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT, VLC_TRUE );
574 add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
576 #if defined(WIN32)
577 add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
578 add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
579 #endif
581 /* Usage (mainly useful for cmd line stuff) */
582 add_usage_hint( PLAYLIST_USAGE );
584 set_description( N_("main program") );
585 set_capability( "main", 100 );
586 vlc_module_end();
588 static module_config_t p_help_config[] =
590 { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
591 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
592 { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
593 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
594 { CONFIG_ITEM_BOOL, NULL, "list", 'l',
595 N_("print a list of available modules"),
596 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
597 { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
598 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
599 { CONFIG_ITEM_BOOL, NULL, "version", '\0',
600 N_("print version information"),
601 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
602 { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
603 NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
606 /*****************************************************************************
607 * End configuration.
608 *****************************************************************************/