]> git.sesse.net Git - vlc/blob - src/libvlc.h
a8367e977ac7305710793d2d1f4c06e19927c6fd
[vlc] / src / libvlc.h
1 /*****************************************************************************
2  * libvlc.h: main libvlc header
3  *****************************************************************************
4  * Copyright (C) 1998-2002 VideoLAN
5  * $Id: libvlc.h,v 1.43 2003/02/18 18:33:44 titer 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
28 static char *ppsz_sout_acodec[] = { "", "mpeg1", "mpeg2", "mpeg4", "vorbis", NULL };
29 static char *ppsz_sout_vcodec[] = { "", "mpeg1", "mpeg2", "mpeg4", NULL };
30
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.")
42
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.")
48
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).")
53
54 #define QUIET_TEXT N_("be quiet")
55 #define QUIET_LONGTEXT N_( \
56     "This options turns off all warning and information messages.")
57
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.")
62
63 #define INTF_PATH_TEXT N_("interface default search path")
64 #define INTF_PATH_LONGTEXT N_( \
65     "This option allows you to set the default path that the interface will " \
66     "open when looking for a file.")
67
68 #define PLUGIN_PATH_TEXT N_("plugin search path")
69 #define PLUGIN_PATH_LONGTEXT N_( \
70     "This option allows you to specify an additional path for VLC to look " \
71     "for its plugins.")
72
73 #define AOUT_TEXT N_("audio output module")
74 #define AOUT_LONGTEXT N_( \
75     "This option allows you to select the audio output method used by VLC. " \
76     "The default behavior is to automatically select the best method " \
77     "available.")
78
79 #define AUDIO_TEXT N_("enable audio")
80 #define AUDIO_LONGTEXT N_( \
81     "You can completely disable the audio output. In this case the audio " \
82     "decoding stage won't be done, and it will save some processing power.")
83
84 #define MONO_TEXT N_("force mono audio")
85 #define MONO_LONGTEXT N_("This will force a mono audio output")
86
87 #define VOLUME_TEXT N_("audio output volume")
88 #define VOLUME_LONGTEXT N_( \
89     "You can set the default audio output volume here, in a range from 0 to " \
90     "1024.")
91
92 #define VOLUME_SAVE_TEXT N_("audio output saved volume")
93 #define VOLUME_SAVE_LONGTEXT N_( \
94     "This saves the audio output volume when you select mute.")
95
96 #define AOUT_RATE_TEXT N_("audio output frequency (Hz)")
97 #define AOUT_RATE_LONGTEXT N_( \
98     "You can force the audio output frequency here. Common values are " \
99     "48000, 44100, 32000, 22050, 16000, 11025, 8000.")
100
101 #define DESYNC_TEXT N_("compensate desynchronization of audio (in ms)")
102 #define DESYNC_LONGTEXT N_( \
103     "This option allows you to delay the audio output. This can be handy if " \
104     "you notice a lag between the video and the audio.")
105
106 #define HEADPHONE_TEXT N_("headphone virtual spatialization effect")
107 #define HEADPHONE_LONGTEXT N_( \
108     "This effect gives you the feeling that you stands in a real room " \
109     "with a complete 5.1 speaker set when using only a headphone, " \
110     "providing a more realistic sound experience. It should also be " \
111     "more comfortable and less tiring when listening to music for " \
112     "long periods of time.\nIt works with any source format from mono " \
113     "to 5.1.")
114
115 #define HEADPHONE_DIM_TEXT N_("characteristic dimension")
116 #define HEADPHONE_DIM_LONGTEXT N_( \
117      "Headphone virtual spatialization effect parameter: "\
118      "distance between front left speaker and listener in meters.")
119
120 #define VOUT_TEXT N_("video output module")
121 #define VOUT_LONGTEXT N_( \
122     "This option allows you to select the video output method used by VLC. " \
123     "The default behavior is to automatically select the best " \
124     "method available.")
125
126 #define VIDEO_TEXT N_("enable video")
127 #define VIDEO_LONGTEXT N_( \
128     "You can completely disable the video output. In this case the video " \
129     "decoding stage won't be done, which will save some processing power.")
130
131 #define DISPLAY_TEXT N_("display identifier")
132 #define DISPLAY_LONGTEXT N_( \
133     "This is the local display port that will be used for X11 drawing. " \
134     "For instance :0.1.")
135
136 #define WIDTH_TEXT N_("video width")
137 #define WIDTH_LONGTEXT N_( \
138     "You can enforce the video width here. By default VLC will " \
139     "adapt to the video characteristics.")
140
141 #define HEIGHT_TEXT N_("video height")
142 #define HEIGHT_LONGTEXT N_( \
143     "You can enforce the video height here. By default VLC will " \
144     "adapt to the video characteristics.")
145
146 #define ZOOM_TEXT N_("zoom video")
147 #define ZOOM_LONGTEXT N_( \
148     "You can zoom the video by the specified factor.")
149
150 #define GRAYSCALE_TEXT N_("grayscale video output")
151 #define GRAYSCALE_LONGTEXT N_( \
152     "When enabled, the color information from the video won't be decoded " \
153     "(this can also allow you to save some processing power).")
154
155 #define FULLSCREEN_TEXT N_("fullscreen video output")
156 #define FULLSCREEN_LONGTEXT N_( \
157     "If this option is enabled, VLC will always start a video in fullscreen " \
158     "mode.")
159
160 #define OVERLAY_TEXT N_("overlay video output")
161 #define OVERLAY_LONGTEXT N_( \
162     "If enabled, VLC will try to take advantage of the overlay capabilities " \
163     "of your graphic card.")
164
165 #define SPUMARGIN_TEXT N_("force SPU position")
166 #define SPUMARGIN_LONGTEXT N_( \
167     "You can use this option to place the subtitles under the movie, " \
168     "instead of over the movie. Try several positions.")
169
170 #define FILTER_TEXT N_("video filter module")
171 #define FILTER_LONGTEXT N_( \
172     "This will allow you to add a post-processing filter to enhance the " \
173     "picture quality, for instance deinterlacing, or to clone or distort " \
174     "the video window.")
175
176 #define ASPECT_RATIO_TEXT N_("source aspect ratio")
177 #define ASPECT_RATIO_LONGTEXT N_( \
178     "This will force the source aspect ratio. For instance, some DVDs claim " \
179     "to be 16:9 while they are actually 4:3. This can also be used as a " \
180     "hint for VLC when a movie does not have aspect ratio information. " \
181     "Accepted formats are x:y (4:3, 16:9, etc.) expressing the global image " \
182     "aspect, or a float value (1.25, 1.3333, etc.) expressing pixel " \
183     "squareness.")
184
185 #if 0
186 #define PIXEL_RATIO_TEXT N_("destination aspect ratio")
187 #define PIXEL_RATIO_LONGTEXT N_( \
188     "This will force the destination pixel size. By default VLC assumes " \
189     "your pixels are square, unless your hardware has a way to tell it " \
190     "otherwise. This may be used when you output VLC's signal to another " \
191     "device such as a TV set. Accepted format is a float value (1, 1.25, " \
192     "1.3333, etc.) expressing pixel squareness.")
193 #endif
194
195 #define SERVER_PORT_TEXT N_("server port")
196 #define SERVER_PORT_LONGTEXT N_( \
197     "This is the port used for UDP streams. By default, we chose 1234.")
198
199 #define MTU_TEXT N_("MTU of the network interface")
200 #define MTU_LONGTEXT N_( \
201     "This is the typical size of UDP packets that we expect. On Ethernet " \
202     "it is usually 1500.")
203
204 #define NETCHANNEL_TEXT N_("enable network channel mode")
205 #define NETCHANNEL_LONGTEXT N_( \
206     "Activate this option if you want to use the VideoLAN Channel Server.")
207
208 #define CHAN_SERV_TEXT N_("channel server address")
209 #define CHAN_SERV_LONGTEXT N_( \
210     "Indicate here the address of the VideoLAN Channel Server.")
211
212 #define CHAN_PORT_TEXT N_("channel server port")
213 #define CHAN_PORT_LONGTEXT N_( \
214     "Indicate here the port on which the VideoLAN Channel Server runs.")
215
216 #define IFACE_TEXT N_("network interface")
217 #define IFACE_LONGTEXT N_( \
218     "If you have several interfaces on your Linux machine and use the " \
219     "VLAN solution, you may indicate here which interface to use.")
220
221 #define IFACE_ADDR_TEXT N_("network interface address")
222 #define IFACE_ADDR_LONGTEXT N_( \
223     "If you have several interfaces on your machine and use the " \
224     "multicast solution, you will probably have to indicate the IP address " \
225     "of your multicasting interface here.")
226
227 #define TTL_TEXT N_("time to live")
228 #define TTL_LONGTEXT N_( \
229     "Indicate here the Time To Live of the multicast packets sent by " \
230     "the stream output.")
231
232 #define INPUT_PROGRAM_TEXT N_("choose program (SID)")
233 #define INPUT_PROGRAM_LONGTEXT N_( \
234     "Choose the program to select by giving its Service ID.")
235
236 #define INPUT_AUDIO_TEXT N_("choose audio")
237 #define INPUT_AUDIO_LONGTEXT N_( \
238     "Give the default type of audio you want to use in a DVD.")
239
240 #define INPUT_CHAN_TEXT N_("choose channel")
241 #define INPUT_CHAN_LONGTEXT N_( \
242     "Give the stream number of the audio channel you want to use in a DVD " \
243     "(from 1 to n).")
244
245 #define INPUT_SUBT_TEXT N_("choose subtitles")
246 #define INPUT_SUBT_LONGTEXT N_( \
247     "Give the stream number of the subtitle channel you want to use in a " \
248     "DVD (from 1 to n).")
249
250 #define DVD_DEV_TEXT N_("DVD device")
251 #ifdef WIN32
252 #define DVD_DEV_LONGTEXT N_( \
253     "This is the default DVD drive (or file) to use. Don't forget the colon " \
254     "after the drive letter (eg D:)")
255 #else
256 #define DVD_DEV_LONGTEXT N_( \
257     "This is the default DVD device to use.")
258 #endif
259
260 #define VCD_DEV_TEXT N_("VCD device")
261 #define VCD_DEV_LONGTEXT N_( \
262     "This is the default VCD device to use.")
263
264 #define IPV6_TEXT N_("force IPv6")
265 #define IPV6_LONGTEXT N_( \
266     "If you check this box, IPv6 will be used by default for all UDP and " \
267     "HTTP connections.")
268
269 #define IPV4_TEXT N_("force IPv4")
270 #define IPV4_LONGTEXT N_( \
271     "If you check this box, IPv4 will be used by default for all UDP and " \
272     "HTTP connections.")
273
274 #define CODEC_TEXT N_("choose preferred codec list")
275 #define CODEC_LONGTEXT N_( \
276     "This allows you to select the order in which VLC will choose its " \
277     "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
278     "before the new one. Please be aware that VLC does not make any " \
279     "difference between audio or video codecs, so you should always specify " \
280     "'any' at the end of the list to make sure there is a fallback for the " \
281     "types you didn't specify.")
282
283 #define ENCODER_VIDEO_TEXT N_("choose preferred video encoder list")
284 #define ENCODER_VIDEO_LONGTEXT N_( \
285     "This allows you to select the order in which VLC will choose its " \
286     "codecs. " )
287 #define ENCODER_AUDIO_TEXT N_("choose preferred audio encoder list")
288 #define ENCODER_AUDIO_LONGTEXT N_( \
289     "This allows you to select the order in which VLC will choose its " \
290     "codecs. " )
291
292 #define SOUT_TEXT N_("choose a stream output")
293 #define SOUT_LONGTEXT N_( \
294     "Empty if no stream output.")
295
296 #define SOUT_VIDEO_TEXT N_("enable video stream output")
297 #define SOUT_VIDEO_LONGTEXT N_( \
298     "This allows you to choose if the video stream should be redirected to " \
299     "the stream output facility when this last one is enabled.")
300
301 #define SOUT_VCODEC_TEXT N_("video encoding codec" )
302 #define SOUT_VCODEC_LONGTEXT N_( \
303     "This allows you to force video encoding")
304
305 #define SOUT_AUDIO_TEXT N_("enable audio stream output")
306 #define SOUT_AUDIO_LONGTEXT N_( \
307     "This allows you to choose if the video stream should be redirected to " \
308     "the stream output facility when this last one is enabled.")
309
310 #define SOUT_ACODEC_TEXT N_("audio encoding codec" )
311 #define SOUT_ACODEC_LONGTEXT N_( \
312     "This allows you to force audio encoding")
313
314 #define PACKETIZER_TEXT N_("choose preferred packetizer list")
315 #define PACKETIZER_LONGTEXT N_( \
316     "This allows you to select the order in which VLC will choose its " \
317     "packetizers."  )
318
319 #define MUX_TEXT N_("mux module")
320 #define MUX_LONGTEXT N_( \
321     "This is a legacy entry to let you configure mux modules")
322
323 #define ACCESS_OUTPUT_TEXT N_("access output module")
324 #define ACCESS_OUTPUT_LONGTEXT N_( \
325     "This is a legacy entry to let you configure access output modules")
326
327
328 #define MMX_TEXT N_("enable CPU MMX support")
329 #define MMX_LONGTEXT N_( \
330     "If your processor supports the MMX instructions set, VLC can take " \
331     "advantage of them.")
332
333 #define THREE_DN_TEXT N_("enable CPU 3D Now! support")
334 #define THREE_DN_LONGTEXT N_( \
335     "If your processor supports the 3D Now! instructions set, VLC can take " \
336     "advantage of them.")
337
338 #define MMXEXT_TEXT N_("enable CPU MMX EXT support")
339 #define MMXEXT_LONGTEXT N_( \
340     "If your processor supports the MMX EXT instructions set, VLC can take " \
341     "advantage of them.")
342
343 #define SSE_TEXT N_("enable CPU SSE support")
344 #define SSE_LONGTEXT N_( \
345     "If your processor supports the SSE instructions set, VLC can take " \
346     "advantage of them.")
347
348 #define ALTIVEC_TEXT N_("enable CPU AltiVec support")
349 #define ALTIVEC_LONGTEXT N_( \
350     "If your processor supports the AltiVec instructions set, VLC can take " \
351     "advantage of them.")
352
353 #define RANDOM_TEXT N_("play files randomly forever")
354 #define RANDOM_LONGTEXT N_( \
355     "When selected, VLC will randomly play files in the playlist until " \
356     "interrupted.")
357
358 #define LAUNCH_TEXT N_("launch playlist on startup")
359 #define LAUNCH_LONGTEXT N_( \
360     "If you want VLC to start playing on startup, then enable this option.")
361
362 #define ENQUEUE_TEXT N_("enqueue items in playlist")
363 #define ENQUEUE_LONGTEXT N_( \
364     "If you want VLC to add items to the playlist as you open them, then " \
365     "enable this option.")
366
367 #define LOOP_TEXT N_("loop playlist on end")
368 #define LOOP_LONGTEXT N_( \
369     "If you want VLC to keep playing the playlist indefinitely then enable " \
370     "this option.")
371
372 #define MEMCPY_TEXT N_("memory copy module")
373 #define MEMCPY_LONGTEXT N_( \
374     "You can select which memory copy module you want to use. By default " \
375     "VLC will select the fastest one supported by your hardware.")
376
377 #define ACCESS_TEXT N_("access module")
378 #define ACCESS_LONGTEXT N_( \
379     "This is a legacy entry to let you configure access modules")
380
381 #define DEMUX_TEXT N_("demux module")
382 #define DEMUX_LONGTEXT N_( \
383     "This is a legacy entry to let you configure demux modules")
384
385 #define FAST_MUTEX_TEXT N_("fast mutex on NT/2K/XP (developers only)")
386 #define FAST_MUTEX_LONGTEXT N_( \
387     "On Windows NT/2K/XP we use a slow mutex implementation but which " \
388     "allows us to correctely implement condition variables. " \
389     "You can also use the faster Win9x implementation but you might " \
390     "experience problems with it.")
391
392 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
393     "(developers only)")
394 #define WIN9X_CV_LONGTEXT N_( \
395     "On Windows 9x/Me we use a fast but not correct condition variables " \
396     "implementation (more precisely there is a possibility for a race " \
397     "condition to happen). " \
398     "However it is possible to use slower alternatives which should be more " \
399     "robust. " \
400     "Currently you can choose between implementation 0 (which is the " \
401     "default and the fastest), 1 and 2.")
402
403 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
404     "\n  *.mpg, *.vob                   plain MPEG-1/2 files" \
405     "\n  [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
406     "\n                                 DVD device" \
407     "\n  [vcd:][device][@[title][,[chapter]]" \
408     "\n                                 VCD device" \
409     "\n  udpstream:[@[<bind address>][:<bind port>]]" \
410     "\n                                 UDP stream sent by VLS" \
411     "\n  vlc:pause                      pause execution of " \
412     "playlist items" \
413     "\n  vlc:quit                       quit VLC" \
414     "\n")
415
416
417 /*
418  * Quick usage guide for the configuration options:
419  *
420  * add_category_hint( N_(text), N_(longtext) );
421  * add_subcategory_hint( N_(text), N_(longtext) );
422  * add_usage_hint( N_(text) );
423  * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
424  * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
425  * add_module( option_name, psz_value, i_capability, p_callback,
426  *             N_(text), N_(longtext) );
427  * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
428  * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
429  */
430
431 vlc_module_begin();
432     /* Interface options */
433     add_category_hint( N_("Interface"), NULL);
434     add_module_with_short( "intf", 'I', "interface", NULL, NULL,
435                            INTF_TEXT, INTF_LONGTEXT );
436     add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT );
437     add_integer_with_short( "verbose", 'v', -1, NULL,
438                             VERBOSE_TEXT, VERBOSE_LONGTEXT );
439     add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT );
440     add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT );
441     add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT );
442     add_string( "plugin-path", NULL, NULL,
443                 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT );
444
445     /* Audio options */
446     add_category_hint( N_("Audio"), NULL);
447     add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
448                            AOUT_TEXT, AOUT_LONGTEXT );
449     add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT );
450     add_integer_with_range( "volume", AOUT_VOLUME_DEFAULT, AOUT_VOLUME_MIN,
451                             AOUT_VOLUME_MAX, NULL, VOLUME_TEXT,
452                             VOLUME_LONGTEXT );
453     add_integer_with_range( "saved-volume", AOUT_VOLUME_DEFAULT,
454                             AOUT_VOLUME_MIN, AOUT_VOLUME_MAX, NULL,
455                             VOLUME_SAVE_TEXT, VOLUME_SAVE_LONGTEXT );
456     add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT );
457     add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT );
458     add_bool( "headphone", 0, NULL, HEADPHONE_TEXT, HEADPHONE_LONGTEXT );
459     add_integer( "headphone-dim", 5, NULL, HEADPHONE_DIM_TEXT,
460                  HEADPHONE_DIM_LONGTEXT );
461
462     /* Video options */
463     add_category_hint( N_("Video"), NULL );
464     add_module_with_short( "vout", 'V', "video output", NULL, NULL,
465                            VOUT_TEXT, VOUT_LONGTEXT );
466     add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT );
467     add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT );
468     add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT );
469     add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT );
470     add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT );
471     add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT );
472     add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT );
473     add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT );
474     add_module( "filter", "video filter", NULL, NULL,
475                 FILTER_TEXT, FILTER_LONGTEXT );
476     add_string( "aspect-ratio", "", NULL,
477                 ASPECT_RATIO_TEXT, ASPECT_RATIO_TEXT );
478 #if 0
479     add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
480 #endif
481
482     /* Input options */
483     add_category_hint( N_("Input"), NULL );
484     add_integer( "server-port", 1234, NULL,
485                  SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT );
486     add_bool( "network-channel", 0, NULL,
487               NETCHANNEL_TEXT, NETCHANNEL_LONGTEXT );
488     add_string( "channel-server", "localhost", NULL,
489                 CHAN_SERV_TEXT, CHAN_SERV_LONGTEXT );
490     add_integer( "channel-port", 6010, NULL,
491                  CHAN_PORT_TEXT, CHAN_PORT_LONGTEXT );
492     add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT );
493 #ifdef SYS_DARWIN
494     add_string( "iface", "en0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
495 #else
496     add_string( "iface", "eth0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
497 #endif
498     add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT );
499     add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT );
500
501     add_integer( "program", 0, NULL,
502                  INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT );
503     add_integer( "audio-type", -1, NULL,
504                  INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT );
505     add_integer( "audio-channel", -1, NULL,
506                  INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT );
507     add_integer( "spu-channel", -1, NULL,
508                  INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT );
509
510     add_string( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT );
511     add_string( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT );
512
513     add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT );
514     add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT );
515
516     /* Decoder options */
517     add_category_hint( N_("Decoders"), NULL );
518     add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT );
519
520     add_category_hint( N_("Encoders"), NULL );
521     add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT );
522     add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT );
523
524     /* Stream output options */
525     add_category_hint( N_("Stream output"), NULL );
526     add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT );
527     add_bool( "sout-audio", 1, NULL, SOUT_AUDIO_TEXT, SOUT_AUDIO_LONGTEXT );
528     add_bool( "sout-video", 1, NULL, SOUT_VIDEO_TEXT, SOUT_VIDEO_LONGTEXT );
529     add_string_from_list( "sout-acodec", "", ppsz_sout_acodec, NULL, SOUT_ACODEC_TEXT, SOUT_ACODEC_LONGTEXT );
530     add_string_from_list( "sout-vcodec", "", ppsz_sout_vcodec, NULL, SOUT_VCODEC_TEXT, SOUT_VCODEC_LONGTEXT );
531     add_module( "packetizer", "packetizer", NULL, NULL,
532                 PACKETIZER_TEXT, PACKETIZER_LONGTEXT );
533     add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT );
534     add_module( "access_output", "sout access", NULL, NULL,
535                 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT );
536
537     /* CPU options */
538     add_category_hint( N_("CPU"), NULL );
539 #if defined( __i386__ )
540     add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT );
541     add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT );
542     add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT );
543     add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT );
544 #endif
545 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
546     add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT );
547 #endif
548
549     /* Playlist options */
550     add_category_hint( N_("Playlist"), NULL );
551     add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT );
552     add_bool( "playlist", 0, NULL, LAUNCH_TEXT, LAUNCH_LONGTEXT );
553     add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT );
554     add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT );
555
556     /* Misc options */
557     add_category_hint( N_("Miscellaneous"), NULL );
558     add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT );
559     add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT );
560     add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT );
561
562 #if defined(WIN32)
563     add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT );
564     add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT );
565 #endif
566
567     /* Usage (mainly useful for cmd line stuff) */
568     add_usage_hint( PLAYLIST_USAGE );
569
570     set_description( N_("main program") );
571     set_capability( "main", 100 );
572 vlc_module_end();
573
574 static module_config_t p_help_config[] =
575 {
576     { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help"),
577       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
578     { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help"),
579       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
580     { CONFIG_ITEM_BOOL, NULL, "list", 'l',
581                               N_("print a list of available modules"),
582       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
583     { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module"),
584       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
585     { CONFIG_ITEM_BOOL, NULL, "version", '\0',
586                               N_("print version information"),
587       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE },
588     { CONFIG_HINT_END, NULL, NULL, '\0', NULL,
589       NULL, NULL, 0, 0.0, 0, 0, 0.0, 0.0, NULL, NULL, NULL, VLC_FALSE }
590 };
591
592 /*****************************************************************************
593  * End configuration.
594  *****************************************************************************/