* ./include/main.h, ./plugins/beos/intf_beos.cpp: BeOS compilation fixes.
[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.2 2002/06/01 17:09:25 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 AOUT_TEXT N_("audio output module")
59 #define AOUT_LONGTEXT N_( \
60     "This option allows you to select the audio audio output method used by " \
61     "vlc. The default behavior is to automatically select the " \
62     "best method available.")
63
64 #define AUDIO_TEXT N_("enable audio")
65 #define AUDIO_LONGTEXT N_( \
66     "You can completely disable the audio output. In this case the audio " \
67     "decoding stage won't be done, and it will save some processing power.")
68
69 #define MONO_TEXT N_("force mono audio")
70 #define MONO_LONGTEXT N_("This will force a mono audio output")
71
72 #define VOLUME_TEXT N_("audio output volume")
73 #define VOLUME_LONGTEXT N_( \
74     "You can set the default audio output volume here, in a range from 0 to " \
75     "1024.")
76
77 #define FORMAT_TEXT N_("audio output format")
78 #define FORMAT_LONGTEXT N_( \
79     "You can force the audio output format here.\n" \
80     "0 -> 16 bits signed native endian (default)\n" \
81     "1 ->  8 bits unsigned\n"                       \
82     "2 -> 16 bits signed little endian\n"           \
83     "3 -> 16 bits signed big endian\n"              \
84     "4 ->  8 bits signed\n"                         \
85     "5 -> 16 bits unsigned little endian\n"         \
86     "6 -> 16 bits unsigned big endian\n"            \
87     "7 -> mpeg2 audio (unsupported)\n"              \
88     "8 -> ac3 pass-through")
89
90 #define RATE_TEXT N_("audio output frequency (Hz)")
91 #define RATE_LONGTEXT N_( \
92     "You can force the audio output frequency here. Common values are " \
93     "48000, 44100, 32000, 22050, 16000, 11025, 8000.")
94
95 #define DESYNC_TEXT N_("compensate desynchronization of audio (in ms)")
96 #define DESYNC_LONGTEXT N_( \
97     "This option allows you to delay the audio output. This can be handy if " \
98     "you notice a lag between the video and the audio.")
99
100 #define VOUT_TEXT N_("video output module")
101 #define VOUT_LONGTEXT N_( \
102     "This option allows you to select the video output method used by vlc. " \
103     "The default behavior is to automatically select the best " \
104     "method available.")
105
106 #define VIDEO_TEXT N_("enable video")
107 #define VIDEO_LONGTEXT N_( \
108     "You can completely disable the video output. In this case the video " \
109     "decoding stage won't be done, which will save some processing power.")
110
111 #define DISPLAY_TEXT N_("display identifier")
112 #define DISPLAY_LONGTEXT N_( \
113     "This is the local display port that will be used for X11 drawing. " \
114     "For instance :0.1.")
115
116 #define WIDTH_TEXT N_("video width")
117 #define WIDTH_LONGTEXT N_( \
118     "You can enforce the video width here. By default vlc will " \
119     "adapt to the video characteristics.")
120
121 #define HEIGHT_TEXT N_("video height")
122 #define HEIGHT_LONGTEXT N_( \
123     "You can enforce the video height here. By default vlc will " \
124     "adapt to the video characteristics.")
125
126 #define ZOOM_TEXT N_("zoom video")
127 #define ZOOM_LONGTEXT N_( \
128     "You can zoom the video by the specified factor.")
129
130 #define GRAYSCALE_TEXT N_("grayscale video output")
131 #define GRAYSCALE_LONGTEXT N_( \
132     "When enabled, the color information from the video won't be decoded " \
133     "(this can also allow you to save some processing power).")
134
135 #define FULLSCREEN_TEXT N_("fullscreen video output")
136 #define FULLSCREEN_LONGTEXT N_( \
137     "If this option is enabled, vlc will always start a video in fullscreen " \
138     "mode.")
139
140 #define OVERLAY_TEXT N_("overlay video output")
141 #define OVERLAY_LONGTEXT N_( \
142     "If enabled, vlc will try to take advantage of the overlay capabilities " \
143     "of you graphics card.")
144
145 #define SPUMARGIN_TEXT N_("force SPU position")
146 #define SPUMARGIN_LONGTEXT N_( \
147     "You can use this option to place the subtitles under the movie, " \
148     "instead of over the movie. Try several positions.")
149
150 #define FILTER_TEXT N_("video filter module")
151 #define FILTER_LONGTEXT N_( \
152     "This will allow you to add a post-processing filter to enhance the " \
153     "picture quality, for instance deinterlacing, or to clone or distort " \
154     "the video window.")
155
156 #define SERVER_PORT_TEXT N_("server port")
157 #define SERVER_PORT_LONGTEXT N_( \
158     "This is the port used for UDP streams. By default, we chose 1234.")
159
160 #define NETCHANNEL_TEXT N_("enable network channel mode")
161 #define NETCHANNEL_LONGTEXT N_( \
162     "Activate this option if you want to use the VideoLAN Channel Server.")
163
164 #define CHAN_SERV_TEXT N_("channel server address")
165 #define CHAN_SERV_LONGTEXT N_( \
166     "Indicate here the address of the VideoLAN Channel Server.")
167
168 #define CHAN_PORT_TEXT N_("channel server port")
169 #define CHAN_PORT_LONGTEXT N_( \
170     "Indicate here the port on which the VideoLAN Channel Server runs.")
171
172 #define IFACE_TEXT N_("network interface")
173 #define IFACE_LONGTEXT N_( \
174     "If you have several interfaces on your Linux machine and use the " \
175     "VLAN solution, you may indicate here which interface to use.")
176
177 #define INPUT_PROGRAM_TEXT N_("choose program (SID)")
178 #define INPUT_PROGRAM_LONGTEXT N_( \
179     "Choose the program to select by giving its Service ID.")
180
181 #define INPUT_AUDIO_TEXT N_("choose audio")
182 #define INPUT_AUDIO_LONGTEXT N_( \
183     "Give the default type of audio you want to use in a DVD.")
184
185 #define INPUT_CHAN_TEXT N_("choose channel")
186 #define INPUT_CHAN_LONGTEXT N_( \
187     "Give the stream number of the audio channel you want to use in a DVD " \
188     "(from 1 to n).")
189
190 #define INPUT_SUBT_TEXT N_("choose subtitles")
191 #define INPUT_SUBT_LONGTEXT N_( \
192     "Give the stream number of the subtitle channel you want to use in a " \
193     "DVD (from 1 to n).")
194
195 #define DVD_DEV_TEXT N_("DVD device")
196 #define DVD_DEV_LONGTEXT N_( \
197     "This is the default DVD device to use.")
198
199 #define VCD_DEV_TEXT N_("VCD device")
200 #define VCD_DEV_LONGTEXT N_( \
201     "This is the default VCD device to use.")
202
203 #define IPV6_TEXT N_("force IPv6")
204 #define IPV6_LONGTEXT N_( \
205     "If you check this box, IPv6 will be used by default for all UDP and " \
206     "HTTP connections.")
207
208 #define IPV4_TEXT N_("force IPv4")
209 #define IPV4_LONGTEXT N_( \
210     "If you check this box, IPv4 will be used by default for all UDP and " \
211     "HTTP connections.")
212
213 #define ADEC_MPEG_TEXT N_("choose MPEG audio decoder")
214 #define ADEC_MPEG_LONGTEXT N_( \
215     "This allows you to select the MPEG audio decoder you want to use. " \
216     "Common choices are builtin and mad.")
217
218 #define ADEC_AC3_TEXT N_("choose AC3 audio decoder")
219 #define ADEC_AC3_LONGTEXT N_( \
220     "This allows you to select the AC3/A52 audio decoder you want to use. " \
221     "Common choices are builtin and a52.")
222
223 #define MMX_TEXT N_("enable CPU MMX support")
224 #define MMX_LONGTEXT N_( \
225     "If your processor supports the MMX instructions set, vlc can take " \
226     "advantage of them.")
227
228 #define THREE_DN_TEXT N_("enable CPU 3D Now! support")
229 #define THREE_DN_LONGTEXT N_( \
230     "If your processor supports the 3D Now! instructions set, vlc can take "\
231     "advantage of them.")
232
233 #define MMXEXT_TEXT N_("enable CPU MMX EXT support")
234 #define MMXEXT_LONGTEXT N_( \
235     "If your processor supports the MMX EXT instructions set, vlc can take "\
236     "advantage of them.")
237
238 #define SSE_TEXT N_("enable CPU SSE support")
239 #define SSE_LONGTEXT N_( \
240     "If your processor supports the SSE instructions set, vlc can take " \
241     "can take advantage of them.")
242
243 #define ALTIVEC_TEXT N_("enable CPU AltiVec support")
244 #define ALTIVEC_LONGTEXT N_( \
245     "If your processor supports the AltiVec instructions set, vlc can take "\
246     "advantage of them.")
247
248 #define PL_LAUNCH_TEXT N_("launch playlist on startup")
249 #define PL_LAUNCH_LONGTEXT N_( \
250     "If you want vlc to start playing on startup, then enable this option.")
251
252 #define PL_ENQUEUE_TEXT N_("enqueue items in playlist")
253 #define PL_ENQUEUE_LONGTEXT N_( \
254     "If you want vlc to add items to the playlist as you open them, then " \
255     "enable this option.")
256
257 #define PL_LOOP_TEXT N_("loop playlist on end")
258 #define PL_LOOP_LONGTEXT N_( \
259     "If you want vlc to keep playing the playlist indefinitely then enable " \
260     "this option.")
261
262 #define MEMCPY_TEXT N_("memory copy module")
263 #define MEMCPY_LONGTEXT N_( \
264     "You can select wich memory copy module you want to use. By default vlc " \
265     "will select the fastest one supported by your hardware.")
266
267 #define ACCESS_TEXT N_("access module")
268 #define ACCESS_LONGTEXT N_( \
269     "This is a legacy entry to let you configure access modules")
270
271 #define DEMUX_TEXT N_("demux module")
272 #define DEMUX_LONGTEXT N_( \
273     "This is a legacy entry to let you configure demux modules")
274
275 #define FAST_PTHREAD_TEXT N_("fast pthread on NT/2K/XP (developpers only)")
276 #define FAST_PTHREAD_LONGTEXT N_( \
277     "On Windows NT/2K/XP we use a slow but correct pthread implementation, " \
278     "you can also use this faster implementation but you might experience " \
279     "problems with it.")
280
281 /*
282  * Quick usage guide for the configuration options:
283  *
284  * MODULE_CONFIG_START
285  * MODULE_CONFIG_STOP
286  * ADD_CATEGORY_HINT( N_(text), longtext )
287  * ADD_SUBCATEGORY_HINT( N_(text), longtext )
288  * ADD_STRING( option_name, value, p_callback, N_(text), N_(longtext) )
289  * ADD_FILE( option_name, psz_value, p_callback, N_(text), N_(longtext) )
290  * ADD_MODULE( option_name, psz_value, i_capability, p_callback,
291  *             N_(text), N_(longtext) )
292  * ADD_INTEGER( option_name, i_value, p_callback, N_(text), N_(longtext) )
293  * ADD_BOOL( option_name, b_value, p_callback, N_(text), N_(longtext) )
294  */
295
296 MODULE_CONFIG_START
297
298 /* Interface options */
299 ADD_CATEGORY_HINT( N_("Interface"), NULL)
300 ADD_MODULE_WITH_SHORT  ( "intf", 'I', MODULE_CAPABILITY_INTF, NULL, NULL, INTF_TEXT, INTF_LONGTEXT )
301 ADD_BOOL_WITH_SHORT ( "verbose", 'v', 0, NULL, VERBOSE_TEXT, VERBOSE_LONGTEXT )
302 ADD_BOOL_WITH_SHORT ( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT )
303 ADD_BOOL            ( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT )
304 ADD_STRING  ( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT )
305
306 /* Audio options */
307 ADD_CATEGORY_HINT( N_("Audio"), NULL)
308 ADD_MODULE_WITH_SHORT  ( "aout", 'A', MODULE_CAPABILITY_AOUT, NULL, NULL, AOUT_TEXT, AOUT_LONGTEXT )
309 ADD_BOOL    ( "audio", 1, NULL, AUDIO_TEXT, AUDIO_LONGTEXT )
310 ADD_BOOL    ( "mono", 0, NULL, MONO_TEXT, MONO_LONGTEXT )
311 ADD_INTEGER ( "volume", VOLUME_DEFAULT, NULL, VOLUME_TEXT, VOLUME_LONGTEXT )
312 ADD_INTEGER ( "rate", 44100, NULL, RATE_TEXT, RATE_LONGTEXT )
313 ADD_INTEGER ( "desync", 0, NULL, DESYNC_TEXT, DESYNC_LONGTEXT )
314 ADD_INTEGER ( "audio-format", 0, NULL, FORMAT_TEXT, FORMAT_LONGTEXT )
315
316 /* Video options */
317 ADD_CATEGORY_HINT( N_("Video"), NULL )
318 ADD_MODULE_WITH_SHORT  ( "vout", 'V', MODULE_CAPABILITY_VOUT, NULL, NULL, VOUT_TEXT, VOUT_LONGTEXT )
319 ADD_BOOL    ( "video", 1, NULL, VIDEO_TEXT, VIDEO_LONGTEXT )
320 ADD_INTEGER ( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT )
321 ADD_INTEGER ( "height", -1, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT )
322 ADD_FLOAT   ( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT )
323 ADD_BOOL    ( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT )
324 ADD_BOOL    ( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT )
325 ADD_BOOL    ( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT )
326 ADD_INTEGER ( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT )
327 ADD_MODULE  ( "filter", MODULE_CAPABILITY_VOUT, NULL, NULL, FILTER_TEXT, FILTER_LONGTEXT )
328
329 /* Input options */
330 ADD_CATEGORY_HINT( N_("Input"), NULL )
331 ADD_INTEGER ( "server-port", 1234, NULL, SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT )
332 ADD_BOOL    ( "network-channel", 0, NULL, NETCHANNEL_TEXT, NETCHANNEL_LONGTEXT )
333 ADD_STRING  ( "channel-server", "localhost", NULL, CHAN_SERV_TEXT, CHAN_SERV_LONGTEXT )
334 ADD_INTEGER ( "channel-port", 6010, NULL, CHAN_PORT_TEXT, CHAN_PORT_LONGTEXT )
335 ADD_STRING  ( "iface", "eth0", NULL, IFACE_TEXT, IFACE_LONGTEXT )
336
337 ADD_INTEGER ( "program", 0, NULL, INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT )
338 ADD_INTEGER ( "audio-type", -1, NULL, INPUT_AUDIO_TEXT, INPUT_AUDIO_LONGTEXT )
339 ADD_INTEGER ( "audio-channel", -1, NULL, INPUT_CHAN_TEXT, INPUT_CHAN_LONGTEXT )
340 ADD_INTEGER ( "spu-channel", -1, NULL, INPUT_SUBT_TEXT, INPUT_SUBT_LONGTEXT )
341
342 ADD_STRING  ( "dvd", DVD_DEVICE, NULL, DVD_DEV_TEXT, DVD_DEV_LONGTEXT )
343 ADD_STRING  ( "vcd", VCD_DEVICE, NULL, VCD_DEV_TEXT, VCD_DEV_LONGTEXT )
344
345 ADD_BOOL_WITH_SHORT    ( "ipv6", '6', 0, NULL, IPV6_TEXT, IPV6_LONGTEXT )
346 ADD_BOOL_WITH_SHORT    ( "ipv4", '4', 0, NULL, IPV4_TEXT, IPV4_LONGTEXT )
347
348 /* Decoder options */
349 ADD_CATEGORY_HINT( N_("Decoders"), NULL )
350 ADD_MODULE  ( "mpeg-adec", MODULE_CAPABILITY_DECODER, NULL, NULL, ADEC_MPEG_TEXT, ADEC_MPEG_LONGTEXT )
351 ADD_MODULE  ( "ac3-adec", MODULE_CAPABILITY_DECODER, NULL, NULL, ADEC_AC3_TEXT, ADEC_AC3_LONGTEXT )
352
353 /* CPU options */
354 ADD_CATEGORY_HINT( N_("CPU"), NULL )
355 ADD_BOOL ( "mmx", 1, NULL, MMX_TEXT, MMX_LONGTEXT )
356 ADD_BOOL ( "3dn", 1, NULL, THREE_DN_TEXT, THREE_DN_LONGTEXT )
357 ADD_BOOL ( "mmxext", 1, NULL, MMXEXT_TEXT, MMXEXT_LONGTEXT )
358 ADD_BOOL ( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT )
359 ADD_BOOL ( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT )
360
361 /* Playlist options */
362 ADD_CATEGORY_HINT( N_("Playlist"), NULL )
363 ADD_BOOL ( "launch-playlist", 0, NULL, PL_LAUNCH_TEXT, PL_LAUNCH_LONGTEXT )
364 ADD_BOOL ( "enqueue-playlist", 0, NULL, PL_ENQUEUE_TEXT, PL_ENQUEUE_LONGTEXT )
365 ADD_BOOL ( "loop-playlist", 0, NULL, PL_LOOP_TEXT, PL_LOOP_LONGTEXT )
366
367 /* Misc options */
368 ADD_CATEGORY_HINT( N_("Miscellaneous"), NULL )
369 ADD_MODULE  ( "memcpy", MODULE_CAPABILITY_MEMCPY, NULL, NULL, MEMCPY_TEXT, MEMCPY_LONGTEXT )
370 ADD_MODULE  ( "access", MODULE_CAPABILITY_ACCESS, NULL, NULL, ACCESS_TEXT, ACCESS_LONGTEXT )
371 ADD_MODULE  ( "demux", MODULE_CAPABILITY_DEMUX, NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT )
372
373 #if defined(WIN32)
374 ADD_BOOL ( "fast-pthread", 0, NULL, FAST_PTHREAD_TEXT, FAST_PTHREAD_LONGTEXT )
375 #endif
376
377 MODULE_CONFIG_STOP
378
379 MODULE_INIT_START
380     SET_DESCRIPTION( N_("main program") )
381     ADD_CAPABILITY( MAIN, 100/*whatever*/ )
382 MODULE_INIT_STOP
383
384 MODULE_ACTIVATE_START
385 MODULE_ACTIVATE_STOP
386
387 MODULE_DEACTIVATE_START
388 MODULE_DEACTIVATE_STOP
389
390 static module_config_t p_help_config[] =
391 {
392     { MODULE_CONFIG_ITEM_BOOL, "help", 'h', N_("print help"),
393       NULL, NULL, 0, 0, NULL, NULL, 0 },
394     { MODULE_CONFIG_ITEM_BOOL, "longhelp", 'H', N_("print detailed help"),
395       NULL, NULL, 0, 0, NULL, NULL, 0 },
396     { MODULE_CONFIG_ITEM_BOOL, "list", 'l', N_("print a list of available "
397       "modules"), NULL, NULL, 0, 0, NULL, NULL, 0 },
398     { MODULE_CONFIG_ITEM_STRING, "module", 'p', N_("print help on module"),
399       NULL, NULL, 0, 0, NULL, NULL, 0 },
400     { MODULE_CONFIG_ITEM_BOOL, "version", '\0',
401       N_("print version information"), NULL, NULL, 0, 0, NULL, NULL, 0 },
402     { MODULE_CONFIG_ITEM_BOOL, "build", '\0',
403       N_("print build information"), NULL, NULL, 0, 0, NULL, NULL, 0 },
404     { MODULE_CONFIG_HINT_END, NULL, '\0', NULL, NULL, NULL, 0, 0,
405       NULL, NULL, 0 }
406 };
407
408 /*****************************************************************************
409  * End configuration.
410  *****************************************************************************/
411