f2b34e05f7311f683d8ba2af384da57613ed7979
[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.16 2002/10/01 22:29:09 massiot 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 IFACE_ADDR_TEXT N_("network interface address")
193 #define IFACE_ADDR_LONGTEXT N_( \
194     "If you have several interfaces on your machine and use the " \
195     "multicast solution, you will probably have to indicate the IP address " \
196     "of your multicasting interface here.")    
197
198 #define INPUT_PROGRAM_TEXT N_("choose program (SID)")
199 #define INPUT_PROGRAM_LONGTEXT N_( \
200     "Choose the program to select by giving its Service ID.")
201
202 #define INPUT_AUDIO_TEXT N_("choose audio")
203 #define INPUT_AUDIO_LONGTEXT N_( \
204     "Give the default type of audio you want to use in a DVD.")
205
206 #define INPUT_CHAN_TEXT N_("choose channel")
207 #define INPUT_CHAN_LONGTEXT N_( \
208     "Give the stream number of the audio channel you want to use in a DVD " \
209     "(from 1 to n).")
210
211 #define INPUT_SUBT_TEXT N_("choose subtitles")
212 #define INPUT_SUBT_LONGTEXT N_( \
213     "Give the stream number of the subtitle channel you want to use in a " \
214     "DVD (from 1 to n).")
215
216 #define DVD_DEV_TEXT N_("DVD device")
217 #define DVD_DEV_LONGTEXT N_( \
218     "This is the default DVD device to use.")
219
220 #define VCD_DEV_TEXT N_("VCD device")
221 #define VCD_DEV_LONGTEXT N_( \
222     "This is the default VCD device to use.")
223
224 #define IPV6_TEXT N_("force IPv6")
225 #define IPV6_LONGTEXT N_( \
226     "If you check this box, IPv6 will be used by default for all UDP and " \
227     "HTTP connections.")
228
229 #define IPV4_TEXT N_("force IPv4")
230 #define IPV4_LONGTEXT N_( \
231     "If you check this box, IPv4 will be used by default for all UDP and " \
232     "HTTP connections.")
233
234 #define CODEC_TEXT N_("choose preferred codec list")
235 #define CODEC_LONGTEXT N_( \
236     "This allows you to select the order in which vlc will choose its " \
237     "codecs. For instance, 'a52old,a52,any' will try the old a52 codec " \
238     "before the new one. Please be aware that vlc does not make any " \
239     "difference between audio or video codecs, so you should always specify " \
240     "'any' at the end of the list to make sure there is a fallback for the " \
241     "types you didn't specify.")
242
243 #define SOUT_TEXT N_("choose a stream output")
244 #define SOUT_LONGTEXT N_( \
245     "Empty if no stream output.")
246
247 #define MMX_TEXT N_("enable CPU MMX support")
248 #define MMX_LONGTEXT N_( \
249     "If your processor supports the MMX instructions set, vlc can take " \
250     "advantage of them.")
251
252 #define THREE_DN_TEXT N_("enable CPU 3D Now! support")
253 #define THREE_DN_LONGTEXT N_( \
254     "If your processor supports the 3D Now! instructions set, vlc can take "\
255     "advantage of them.")
256
257 #define MMXEXT_TEXT N_("enable CPU MMX EXT support")
258 #define MMXEXT_LONGTEXT N_( \
259     "If your processor supports the MMX EXT instructions set, vlc can take "\
260     "advantage of them.")
261
262 #define SSE_TEXT N_("enable CPU SSE support")
263 #define SSE_LONGTEXT N_( \
264     "If your processor supports the SSE instructions set, vlc can take " \
265     "can take advantage of them.")
266
267 #define ALTIVEC_TEXT N_("enable CPU AltiVec support")
268 #define ALTIVEC_LONGTEXT N_( \
269     "If your processor supports the AltiVec instructions set, vlc can take "\
270     "advantage of them.")
271
272 #define RANDOM_TEXT N_("play files randomly forever")
273 #define RANDOM_LONGTEXT N_( \
274     "When selected, vlc will randomly play files in the playlist until " \
275     "interrupted.")
276
277 #define LAUNCH_TEXT N_("launch playlist on startup")
278 #define LAUNCH_LONGTEXT N_( \
279     "If you want vlc to start playing on startup, then enable this option.")
280
281 #define ENQUEUE_TEXT N_("enqueue items in playlist")
282 #define ENQUEUE_LONGTEXT N_( \
283     "If you want vlc to add items to the playlist as you open them, then " \
284     "enable this option.")
285
286 #define LOOP_TEXT N_("loop playlist on end")
287 #define LOOP_LONGTEXT N_( \
288     "If you want vlc to keep playing the playlist indefinitely then enable " \
289     "this option.")
290
291 #define MEMCPY_TEXT N_("memory copy module")
292 #define MEMCPY_LONGTEXT N_( \
293     "You can select wich memory copy module you want to use. By default vlc " \
294     "will select the fastest one supported by your hardware.")
295
296 #define ACCESS_TEXT N_("access module")
297 #define ACCESS_LONGTEXT N_( \
298     "This is a legacy entry to let you configure access modules")
299
300 #define DEMUX_TEXT N_("demux module")
301 #define DEMUX_LONGTEXT N_( \
302     "This is a legacy entry to let you configure demux modules")
303
304 #define FAST_MUTEX_TEXT N_("fast mutex on NT/2K/XP (developpers only)")
305 #define FAST_MUTEX_LONGTEXT N_( \
306     "On Windows NT/2K/XP we use a slow mutex implementation but which " \
307     "allows us to correctely implement condition variables. " \
308     "You can also use the faster Win9x implementation but you might " \
309     "experience problems with it.")
310
311 #define WIN9X_CV_TEXT N_("Condition variables implementation for Win9x " \
312     "(developpers only)")
313 #define WIN9X_CV_LONGTEXT N_( \
314     "On Windows 9x/Me we use a fast but not correct condition variables " \
315     "implementation (more precisely there is a possibility for a race " \
316     "condition to happen). " \
317     "However it is possible to use slower alternatives which should be more " \
318     "robust. " \
319     "Currently you can choose between implementation 0 (which is the " \
320     "default and the fastest), 1 and 2.")
321
322 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
323     "\n  *.mpg, *.vob                   plain MPEG-1/2 files" \
324     "\n  [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
325     "\n                                 DVD device" \
326     "\n  [vcd:][device][@[title][,[chapter]]" \
327     "\n                                 VCD device" \
328     "\n  udpstream:[@[<bind address>][:<bind port>]]" \
329     "\n                                 UDP stream sent by VLS" \
330     "\n  vlc:pause                      pause execution of " \
331     "playlist items" \
332     "\n  vlc:quit                       quit VLC" \
333     "\n")
334
335 /*
336  * Quick usage guide for the configuration options:
337  *
338  * add_category_hint( N_(text), N_(longtext) );
339  * add_subcategory_hint( N_(text), N_(longtext) );
340  * add_usage_hint( N_(text) );
341  * add_string( option_name, value, p_callback, N_(text), N_(longtext) );
342  * add_file( option_name, psz_value, p_callback, N_(text), N_(longtext) );
343  * add_module( option_name, psz_value, i_capability, p_callback,
344  *             N_(text), N_(longtext) );
345  * add_integer( option_name, i_value, p_callback, N_(text), N_(longtext) );
346  * add_bool( option_name, b_value, p_callback, N_(text), N_(longtext) );
347  */
348
349 vlc_module_begin();
350     /* Interface options */
351     add_category_hint( N_("Interface"), NULL);
352     add_module_with_short( "intf", 'I', "interface", NULL, NULL,
353                            INTF_TEXT, INTF_LONGTEXT );
354     add_bool_with_short( "verbose", 'v', 0, NULL,
355                          VERBOSE_TEXT, VERBOSE_LONGTEXT );
356     add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT );
357     add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT );
358     add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT );
359     add_string( "plugin-path", NULL, NULL,
360                 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT );
361
362     /* Audio options */
363     add_category_hint( N_("Audio"), NULL);
364     add_module_with_short( "aout", 'A', "audio output", NULL, NULL,
365                            AOUT_TEXT, AOUT_LONGTEXT );
366     add_bool( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT );
367     add_integer( "volume", -1, NULL, VOLUME_TEXT, VOLUME_LONGTEXT );
368     add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT, AOUT_RATE_LONGTEXT );
369     add_integer( "aout-channels", -1, NULL,
370                  AOUT_CHANNELS_TEXT, AOUT_CHANNELS_LONGTEXT );
371     add_integer( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT );
372     add_integer( "audio-format", 0, NULL, FORMAT_TEXT, FORMAT_LONGTEXT );
373
374     /* Video options */
375     add_category_hint( N_("Video"), NULL );
376     add_module_with_short( "vout", 'V', "video output", NULL, NULL,
377                            VOUT_TEXT, VOUT_LONGTEXT );
378     add_bool( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT );
379     add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT );
380     add_integer( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT );
381     add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT );
382     add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT );
383     add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT );
384     add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT );
385     add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT );
386     add_module( "filter", "video filter", NULL, NULL,
387                 FILTER_TEXT, FILTER_LONGTEXT );
388
389     /* Input options */
390     add_category_hint( N_("Input"), NULL );
391     add_integer( "server-port", 1234, NULL,
392                  SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT );
393     add_bool( "network-channel", 0, NULL,
394               NETCHANNEL_TEXT, NETCHANNEL_LONGTEXT );
395     add_string( "channel-server", "localhost", NULL,
396                 CHAN_SERV_TEXT, CHAN_SERV_LONGTEXT );
397     add_integer( "channel-port", 6010, NULL,
398                  CHAN_PORT_TEXT, CHAN_PORT_LONGTEXT );
399     add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT );
400     add_string( "iface", "eth0", NULL, IFACE_TEXT, IFACE_LONGTEXT );
401     add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT );
402
403     add_integer( "program", 0, NULL,
404                  INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT );
405     add_integer( "audio-type", -1, NULL,
406                  INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT );
407     add_integer( "audio-channel", -1, NULL,
408                  INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT );
409     add_integer( "spu-channel", -1, NULL,
410                  INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT );
411
412     add_string( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT );
413     add_string( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT );
414
415     add_bool_with_short( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT );
416     add_bool_with_short( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT );
417
418     /* Decoder options */
419     add_category_hint( N_("Decoders"), NULL );
420     add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT );
421
422     /* CPU options */
423     add_category_hint( N_("CPU"), NULL );
424 #if defined( __i386__ )
425     add_bool( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT );
426     add_bool( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT );
427     add_bool( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT );
428     add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT );
429 #endif
430 #if defined( __powerpc__ ) || defined( SYS_DARWIN )
431     add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT );
432 #endif
433
434     /* Playlist options */
435     add_category_hint( N_("Playlist"), NULL );
436     add_bool_with_short( "random", 'Z', 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT );
437     add_bool( "playlist", 0, NULL, LAUNCH_TEXT, LAUNCH_LONGTEXT );
438     add_bool( "enqueue", 0, NULL, ENQUEUE_TEXT, ENQUEUE_LONGTEXT );
439     add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT );
440
441     /* Misc options */
442     add_category_hint( N_("Miscellaneous"), NULL );
443     add_module( "memcpy", "memcpy", NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT );
444     add_module( "access", "access", NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT );
445     add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT );
446     add_string( "sout", NULL, NULL, SOUT_TEXT, SOUT_LONGTEXT );
447
448 #if defined(WIN32)
449     add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT );
450     add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT );
451 #endif
452
453     /* Usage (mainly useful for cmd line stuff) */
454     add_usage_hint( PLAYLIST_USAGE );
455
456     set_description( N_("main program") );
457     set_capability( "main", 100 );
458 vlc_module_end();
459
460 static module_config_t p_help_config[] =
461 {
462     { CONFIG_ITEM_BOOL, NULL, "help", 'h', N_("print help") },
463     { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H', N_("print detailed help") },
464     { CONFIG_ITEM_BOOL, NULL, "list", 'l',
465                               N_("print a list of available modules") },
466     { CONFIG_ITEM_STRING, NULL, "module", 'p', N_("print help on module") },
467     { CONFIG_ITEM_BOOL, NULL, "version", '\0',
468                               N_("print version information") },
469     { CONFIG_HINT_END, NULL, NULL, '\0' }
470 };
471
472 /*****************************************************************************
473  * End configuration.
474  *****************************************************************************/