53fb3ae53ca130008a43183742379ccccc16deff
[vlc.git] / src / libvlc.h
1 /*****************************************************************************
2  * libvlc.h: main libvlc header
3  *****************************************************************************
4  * Copyright (C) 1998-2002 VideoLAN
5  * $Id: libvlc.h,v 1.14 2002/08/16 12:31:04 sam 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 /*****************************************************************************
29  * Configuration options for the main program. Each module will also separatly
30  * define its own configuration options.
31  * Look into configuration.h if you need to know more about the following
32  * macros.
33  *****************************************************************************/
34 #define INTF_TEXT N_("interface module")
35 #define INTF_LONGTEXT N_( \
36     "This option allows you to select the interface used by vlc. " \
37     "The default behavior is to automatically select the best module " \
38     "available.")
39
40 #define VERBOSE_TEXT N_("be verbose")
41 #define VERBOSE_LONGTEXT N_( \
42     "This options activates the output of information messages.")
43
44 #define QUIET_TEXT N_("be quiet")
45 #define QUIET_LONGTEXT N_( \
46     "This options turns off all warning and information messages.")
47
48 #define COLOR_TEXT N_("color messages")
49 #define COLOR_LONGTEXT N_( \
50     "When this option is turned on, the messages sent to the console will " \
51     "be colorized. Your terminal needs Linux color support for this to work.")
52
53 #define INTF_PATH_TEXT N_("interface default search path")
54 #define INTF_PATH_LONGTEXT N_( \
55     "This option allows you to set the default path that the interface will " \
56     "open when looking for a file.")
57
58 #define PLUGIN_PATH_TEXT N_("plugin search path")
59 #define PLUGIN_PATH_LONGTEXT N_( \
60     "This option allows you to specify an additional path for vlc to look" \
61     "for its plugins.")
62
63 #define AOUT_TEXT N_("audio output module")
64 #define AOUT_LONGTEXT N_( \
65     "This option allows you to select the audio output method used by vlc. " \
66     "The default behavior is to automatically select the best method " \
67     "available.")
68
69 #define AUDIO_TEXT N_("enable audio")
70 #define AUDIO_LONGTEXT N_( \
71     "You can completely disable the audio output. In this case the audio " \
72     "decoding stage won't be done, and it will save some processing power.")
73
74 #define MONO_TEXT N_("force mono audio")
75 #define MONO_LONGTEXT N_("This will force a mono audio output")
76
77 #define VOLUME_TEXT N_("audio output volume")
78 #define VOLUME_LONGTEXT N_( \
79     "You can set the default audio output volume here, in a range from 0 to " \
80     "1024.")
81
82 #define FORMAT_TEXT N_("audio output format")
83 #define FORMAT_LONGTEXT N_( \
84     "You can force the audio output format here.\n" \
85     "0 -> 16 bits signed native endian (default)\n" \
86     "1 ->  8 bits unsigned\n"                       \
87     "2 -> 16 bits signed little endian\n"           \
88     "3 -> 16 bits signed big endian\n"              \
89     "4 ->  8 bits signed\n"                         \
90     "5 -> 16 bits unsigned little endian\n"         \
91     "6 -> 16 bits unsigned big endian\n"            \
92     "7 -> MPEG2 audio (unsupported)\n"              \
93     "8 -> A52 pass-through")
94
95 #define AOUT_RATE_TEXT N_("audio output frequency (Hz)")
96 #define AOUT_RATE_LONGTEXT N_( \
97     "You can force the audio output frequency here. Common values are " \
98     "48000, 44100, 32000, 22050, 16000, 11025, 8000.")
99
100 #define AOUT_CHANNELS_TEXT N_("number of channels of audio output")
101 #define AOUT_CHANNELS_LONGTEXT N_( \
102     "Mono is 1, stereo is 2. Higher value (used for 5.1) may not be " \
103     "supported by your audio output module.")
104
105 #define DESYNC_TEXT N_("compensate desynchronization of audio (in ms)")
106 #define DESYNC_LONGTEXT N_( \
107     "This option allows you to delay the audio output. This can be handy if " \
108     "you notice a lag between the video and the audio.")
109
110 #define VOUT_TEXT N_("video output module")
111 #define VOUT_LONGTEXT N_( \
112     "This option allows you to select the video output method used by vlc. " \
113     "The default behavior is to automatically select the best " \
114     "method available.")
115
116 #define VIDEO_TEXT N_("enable video")
117 #define VIDEO_LONGTEXT N_( \
118     "You can completely disable the video output. In this case the video " \
119     "decoding stage won't be done, which will save some processing power.")
120
121 #define DISPLAY_TEXT N_("display identifier")
122 #define DISPLAY_LONGTEXT N_( \
123     "This is the local display port that will be used for X11 drawing. " \
124     "For instance :0.1.")
125
126 #define WIDTH_TEXT N_("video width")
127 #define WIDTH_LONGTEXT N_( \
128     "You can enforce the video width here. By default vlc will " \
129     "adapt to the video characteristics.")
130
131 #define HEIGHT_TEXT N_("video height")
132 #define HEIGHT_LONGTEXT N_( \
133     "You can enforce the video height here. By default vlc will " \
134     "adapt to the video characteristics.")
135
136 #define ZOOM_TEXT N_("zoom video")
137 #define ZOOM_LONGTEXT N_( \
138     "You can zoom the video by the specified factor.")
139
140 #define GRAYSCALE_TEXT N_("grayscale video output")
141 #define GRAYSCALE_LONGTEXT N_( \
142     "When enabled, the color information from the video won't be decoded " \
143     "(this can also allow you to save some processing power).")
144
145 #define FULLSCREEN_TEXT N_("fullscreen video output")
146 #define FULLSCREEN_LONGTEXT N_( \
147     "If this option is enabled, vlc will always start a video in fullscreen " \
148     "mode.")
149
150 #define OVERLAY_TEXT N_("overlay video output")
151 #define OVERLAY_LONGTEXT N_( \
152     "If enabled, vlc will try to take advantage of the overlay capabilities " \
153     "of you graphics card.")
154
155 #define SPUMARGIN_TEXT N_("force SPU position")
156 #define SPUMARGIN_LONGTEXT N_( \
157     "You can use this option to place the subtitles under the movie, " \
158     "instead of over the movie. Try several positions.")
159
160 #define FILTER_TEXT N_("video filter module")
161 #define FILTER_LONGTEXT N_( \
162     "This will allow you to add a post-processing filter to enhance the " \
163     "picture quality, for instance deinterlacing, or to clone or distort " \
164     "the video window.")
165
166 #define SERVER_PORT_TEXT N_("server port")
167 #define SERVER_PORT_LONGTEXT N_( \
168     "This is the port used for UDP streams. By default, we chose 1234.")
169
170 #define MTU_TEXT N_("MTU of the interface")
171 #define MTU_LONGTEXT N_( \
172     "This is the typical size of UDP packets that we expect. On Ethernet " \
173     "it is usually 1500.")
174
175 #define NETCHANNEL_TEXT N_("enable network channel mode")
176 #define NETCHANNEL_LONGTEXT N_( \
177     "Activate this option if you want to use the VideoLAN Channel Server.")
178
179 #define CHAN_SERV_TEXT N_("channel server address")
180 #define CHAN_SERV_LONGTEXT N_( \
181     "Indicate here the address of the VideoLAN Channel Server.")
182
183 #define CHAN_PORT_TEXT N_("channel server port")
184 #define CHAN_PORT_LONGTEXT N_( \
185     "Indicate here the port on which the VideoLAN Channel Server runs.")
186
187 #define IFACE_TEXT N_("network interface")
188 #define IFACE_LONGTEXT N_( \
189     "If you have several interfaces on your Linux machine and use the " \
190     "VLAN solution, you may indicate here which interface to use.")
191
192 #define INPUT_PROGRAM_TEXT N_("choose program (SID)")
193 #define INPUT_PROGRAM_LONGTEXT N_( \
194     "Choose the program to select by giving its Service ID.")
195
196 #define INPUT_AUDIO_TEXT N_("choose audio")
197 #define INPUT_AUDIO_LONGTEXT N_( \
198     "Give the default type of audio you want to use in a DVD.")
199
200 #define INPUT_CHAN_TEXT N_("choose channel")
201 #define INPUT_CHAN_LONGTEXT N_( \
202     "Give the stream number of the audio channel you want to use in a DVD " \
203     "(from 1 to n).")
204
205 #define INPUT_SUBT_TEXT N_("choose subtitles")
206 #define INPUT_SUBT_LONGTEXT N_( \
207     "Give the stream number of the subtitle channel you want to use in a " \
208     "DVD (from 1 to n).")
209
210 #define DVD_DEV_TEXT N_("DVD device")
211 #define DVD_DEV_LONGTEXT N_( \
212     "This is the default DVD device to use.")
213
214 #define VCD_DEV_TEXT N_("VCD device")
215 #define VCD_DEV_LONGTEXT N_( \
216     "This is the default VCD device to use.")
217
218 #define IPV6_TEXT N_("force IPv6")
219 #define IPV6_LONGTEXT N_( \
220     "If you check this box, IPv6 will be used by default for all UDP and " \
221     "HTTP connections.")
222
223 #define IPV4_TEXT N_("force IPv4")
224 #define IPV4_LONGTEXT N_( \
225     "If you check this box, IPv4 will be used by default for all UDP and " \
226     "HTTP connections.")
227
228 #define CODEC_TEXT N_("choose preferred codec list")
229 #define CODEC_LONGTEXT N_( \
230     "This allows you to select the order in which vlc will choose its " \
231     "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
232     "before the new one. Please be aware that vlc does not make any " \
233     "difference between audio or video codecs, so you should always specify " \
234     "'any' at the end of the list to make sure there is a fallback for the " \
235     "types you didn't specify.")
236
237 #define SOUT_TEXT N_("choose a stream output")
238 #define SOUT_LONGTEXT N_( \
239     "Empty if no stream output.")
240
241 #define MMX_TEXT N_("enable CPU MMX support")
242 #define MMX_LONGTEXT N_( \
243     "If your processor supports the MMX instructions set, vlc can take " \
244     "advantage of them.")
245
246 #define THREE_DN_TEXT N_("enable CPU 3D Now! support")
247 #define THREE_DN_LONGTEXT N_( \
248     "If your processor supports the 3D Now! instructions set, vlc can take "\
249     "advantage of them.")
250
251 #define MMXEXT_TEXT N_("enable CPU MMX EXT support")
252 #define MMXEXT_LONGTEXT N_( \
253     "If your processor supports the MMX EXT instructions set, vlc can take "\
254     "advantage of them.")
255
256 #define SSE_TEXT N_("enable CPU SSE support")
257 #define SSE_LONGTEXT N_( \
258     "If your processor supports the SSE instructions set, vlc can take " \
259     "can take advantage of them.")
260
261 #define ALTIVEC_TEXT N_("enable CPU AltiVec support")
262 #define ALTIVEC_LONGTEXT N_( \
263     "If your processor supports the AltiVec instructions set, vlc can take "\
264     "advantage of them.")
265
266 #define RANDOM_TEXT N_("play files randomly forever")
267 #define RANDOM_LONGTEXT N_( \
268     "When selected, vlc will randomly play files in the playlist until " \
269     "interrupted.")
270
271 #define LAUNCH_TEXT N_("launch playlist on startup")
272 #define LAUNCH_LONGTEXT N_( \
273     "If you want vlc to start playing on startup, then enable this option.")
274
275 #define ENQUEUE_TEXT N_("enqueue items in playlist")
276 #define ENQUEUE_LONGTEXT N_( \
277     "If you want vlc to add items to the playlist as you open them, then " \
278     "enable this option.")
279
280 #define LOOP_TEXT N_("loop playlist on end")
281 #define LOOP_LONGTEXT N_( \
282     "If you want vlc to keep playing the playlist indefinitely then enable " \
283     "this option.")
284
285 #define MEMCPY_TEXT N_("memory copy module")
286 #define MEMCPY_LONGTEXT N_( \
287     "You can select wich memory copy module you want to use. By default vlc " \
288     "will select the fastest one supported by your hardware.")
289
290 #define ACCESS_TEXT N_("access module")
291 #define ACCESS_LONGTEXT N_( \
292     "This is a legacy entry to let you configure access modules")
293
294 #define DEMUX_TEXT N_("demux module")
295 #define DEMUX_LONGTEXT N_( \
296     "This is a legacy entry to let you configure demux modules")
297
298 #define FAST_MUTEX_TEXT N_("fast mutex on NT/2K/XP (developpers only)")
299 #define FAST_MUTEX_LONGTEXT N_( \
300     "On Windows NT/2K/XP we use a slow mutex implementation but which " \
301     "allows us to correctely implement condition variables. " \
302     "You can also use the faster Win9x implementation but you might " \
303     "experience problems with it.")
304
305 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
306     "(developpers only)")
307 #define WIN9X_CV_LONGTEXT N_( \
308     "On Windows 9x/Me we use a fast but not correct condition variables " \
309     "implementation (more precisely there is a possibility for a race " \
310     "condition to happen). " \
311     "However it is possible to use slower alternatives which should be more " \
312     "robust. " \
313     "Currently you can choose between implementation 0 (which is the " \
314     "default and the fastest), 1 and 2.")
315
316 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
317     "\n  *.mpg, *.vob                   plain MPEG-1/2 files" \
318     "\n  [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
319     "\n                                 DVD device" \
320     "\n  [vcd:][device][@[title][,[chapter]]" \
321     "\n                                 VCD device" \
322     "\n  udpstream:[@[<bind address>][:<bind port>]]" \
323     "\n                                 UDP stream sent by VLS" \
324     "\n  vlc:pause                      pause execution of " \
325     "playlist items" \
326     "\n  vlc:quit                       quit VLC" \
327     "\n")
328
329 /*
330  * Quick usage guide for the configuration options:
331  *
332  * add_category_hint( N_(text), N_(longtext) );
333  * add_subcategory_hint( N_(text), N_(longtext) );
334  * add_usage_hint( N_(text) );
335  * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
336  * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
337  * add_module( option_name, psz_value, i_capability, p_callback,
338  *             N_(text), N_(longtext) );
339  * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
340  * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
341  */
342
343 vlc_module_begin();
344     /* Interface options */
345     add_category_hint( N_("Interface"), NULL);
346     add_module_with_short( "intf", 'I', "interface", NULL, NULL,
347                            INTF_TEXT, INTF_LONGTEXT );
348     add_bool_with_short( "verbose", 'v', 0, NULL,
349                          VERBOSE_TEXT, VERBOSE_LONGTEXT );
350     add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT );
351     add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT );
352     add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT );
353     add_string( "plugin-path", NULL, NULL,
354                 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT );
355
356     /* Audio options */
357     add_category_hint( N_("Audio"), NULL);
358     add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
359                            AOUT_TEXT, AOUT_LONGTEXT );
360     add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT );
361     add_integer( "volume", VOLUME_DEFAULT, NULL, VOLUME_TEXT, VOLUME_LONGTEXT );
362     add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT );
363     add_integer( "aout-channels", -1, NULL,
364                  AOUT_CHANNELS_TEXT, AOUT_CHANNELS_LONGTEXT );
365     add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT );
366     add_integer( "audio-format", 0, NULL, FORMAT_TEXT, FORMAT_LONGTEXT );
367
368     /* Video options */
369     add_category_hint( N_("Video"), NULL );
370     add_module_with_short( "vout", 'V', "video output", NULL, NULL,
371                            VOUT_TEXT, VOUT_LONGTEXT );
372     add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT );
373     add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT );
374     add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT );
375     add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT );
376     add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT );
377     add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT );
378     add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT );
379     add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT );
380     add_module( "filter", "video filter", NULL, NULL,
381                 FILTER_TEXT, FILTER_LONGTEXT );
382
383     /* Input options */
384     add_category_hint( N_("Input"), NULL );
385     add_integer( "server-port", 1234, NULL,
386                  SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT );
387     add_bool( "network-channel", 0, NULL,
388               NETCHANNEL_TEXT, NETCHANNEL_LONGTEXT );
389     add_string( "channel-server", "localhost", NULL,
390                 CHAN_SERV_TEXT, CHAN_SERV_LONGTEXT );
391     add_integer( "channel-port", 6010, NULL,
392                  CHAN_PORT_TEXT, CHAN_PORT_LONGTEXT );
393     add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT );
394     add_string( "iface", "eth0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
395
396     add_integer( "program", 0, NULL,
397                  INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT );
398     add_integer( "audio-type", -1, NULL,
399                  INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT );
400     add_integer( "audio-channel", -1, NULL,
401                  INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT );
402     add_integer( "spu-channel", -1, NULL,
403                  INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT );
404
405     add_string( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT );
406     add_string( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT );
407
408     add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT );
409     add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT );
410
411     /* Decoder options */
412     add_category_hint( N_("Decoders"), NULL );
413     add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT );
414
415     /* CPU options */
416     add_category_hint( N_("CPU"), NULL );
417 #if defined( __i386__ )
418     add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT );
419     add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT );
420     add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT );
421     add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT );
422 #endif
423 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
424     add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT );
425 #endif
426
427     /* Playlist options */
428     add_category_hint( N_("Playlist"), NULL );
429     add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT );
430     add_bool( "playlist", 0, NULL, LAUNCH_TEXT, LAUNCH_LONGTEXT );
431     add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT );
432     add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT );
433
434     /* Misc options */
435     add_category_hint( N_("Miscellaneous"), NULL );
436     add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT );
437     add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT );
438     add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT );
439     add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT );
440
441 #if defined(WIN32)
442     add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT );
443     add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT );
444 #endif
445
446     /* Usage (mainly useful for cmd line stuff) */
447     add_usage_hint( PLAYLIST_USAGE );
448
449     set_description( N_("main program") );
450     set_capability( "main", 100 );
451 vlc_module_end();
452
453 static module_config_t p_help_config[] =
454 {
455     { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help") },
456     { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help") },
457     { CONFIG_ITEM_BOOL, NULL, "list", 'l',
458                               N_("print a list of available modules") },
459     { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module") },
460     { CONFIG_ITEM_BOOL, NULL, "version", '\0',
461                               N_("print version information") },
462     { CONFIG_HINT_END, NULL, NULL, '\0' }
463 };
464
465 /*****************************************************************************
466  * End configuration.
467  *****************************************************************************/