]> git.sesse.net Git - vlc/blob - include/config.h.in
* AC3 IMDCT and downmix functions are now in plugins, --imdct and
[vlc] / include / config.h.in
1 /*****************************************************************************
2  * config.h: limits and configuration
3  * Defines all compilation-time configuration constants and size limits
4  *****************************************************************************
5  * Copyright (C) 1999, 2000, 2001 VideoLAN
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel Hocevar <sam@via.ecp.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  * 
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /* Conventions regarding names of symbols and variables
26  * ----------------------------------------------------
27  *
28  * - Symbols should begin with a prefix indicating in which module they are
29  *   used, such as INTF_, VOUT_ or ADEC_.
30  *
31  * - Regarding environment variables, which are used as initialization
32  *  parameters for threads :
33  *   + variable names should end with '_VAR'
34  *   + environment variable default value should end with '_DEFAULT'
35  *   + values having a special meaning with '_VAL'
36  *
37  */
38
39 /*****************************************************************************
40  * Program information
41  *****************************************************************************/
42
43 /* Program version and copyright message */
44 #define VERSION_MESSAGE     "vlc @VLC_VERSION@ @VLC_CODENAME@ " \
45                           /* "(" PROGRAM_BUILD ") (" PROGRAM_OPTIONS ")\n" */ \
46                             "Copyright 1996-2001 VideoLAN\n"
47 #define COPYRIGHT_MESSAGE   "VideoLAN Client - version @VLC_VERSION@" \
48                             " @VLC_CODENAME@ - (C)1996-2001 VideoLAN\n"
49
50 #define VERSION             "@VLC_VERSION@"
51
52 /*****************************************************************************
53  * General compilation options
54  *****************************************************************************/
55
56 /* Define for DVB support - Note that some extensions or restrictions may be
57  * incompatible with native MPEG2 streams */
58 //#define DVB_EXTENSIONS
59 //#define DVB_RESTRICTIONS
60
61 /* Define to disable some obscure heuristics behind the video_parser and the
62  * video_decoder that improve performance but are not fully MPEG2 compliant
63  * and might cause problems with some very weird streams. */
64 //#define MPEG2_COMPLIANT
65
66 /*****************************************************************************
67  * Debugging options - define or undefine symbols
68  *****************************************************************************/
69 #ifdef TRACE
70 /* General trace support, which depends of the TRACE define, is determined
71  * in the Makefile */
72
73 /* Modules specific debugging - this will produce a lot of output, but can be
74  * useful to track a bug */
75 //#define TRACE_INTF
76 //#define TRACE_INPUT
77 //#define TRACE_AUDIO
78 #define TRACE_VOUT
79 #define TRACE_VPAR
80
81 /* Trace log file - if defined, a file can be used to store all messages. If
82  * TRACE_LOG_ONLY is defined, debug messages will only be printed to the log and
83  * will not appear on the screen */
84 #define TRACE_LOG                       "vlc-trace.log"
85 #define TRACE_LOG_ONLY
86
87 #endif
88
89 /*****************************************************************************
90  * General configuration
91  *****************************************************************************/
92
93 #define CLOCK_FREQ 1000000
94
95
96 /* Automagically spawn input, audio and video threads ? */
97 /* XXX?? used ? */
98 #define AUTO_SPAWN
99
100 /* When creating or destroying threads in blocking mode, delay to poll thread
101  * status */
102 #define THREAD_SLEEP                    ((int)(0.010*CLOCK_FREQ))
103
104 /*
105  * Decoders FIFO configuration
106  */
107
108 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
109 #define FIFO_SIZE                       1023
110
111 /*
112  * Paths
113  */
114
115 #define DATA_PATH                       "@prefix@/share/videolan"
116 #define PLUGIN_PATH                     "@prefix@/lib/videolan/vlc"
117
118 #define MAX_PLUGIN_COUNT                32
119
120 /*****************************************************************************
121  * Interface configuration
122  *****************************************************************************/
123
124 /* Environment variable containing the display method */
125 #define INTF_METHOD_VAR                 "vlc_intf"
126 #define INTF_METHOD_DEFAULT             "gtk"
127
128 /* Environment variable used to store startup script name and default value */
129 #define INTF_INIT_SCRIPT_VAR            "vlcrc"
130 #define INTF_INIT_SCRIPT_DEFAULT        ".vlcrc"
131
132 /* Environment variable used to store channels file and default value */
133 #define INTF_CHANNELS_VAR               "vlc_channels"
134 #define INTF_CHANNELS_DEFAULT           "vlc.channels"
135
136 /* Base delay in micro second for interface sleeps */
137 #define INTF_IDLE_SLEEP                 ((int)(0.050*CLOCK_FREQ))
138
139 /* Step for changing gamma, and minimum and maximum values */
140 #define INTF_GAMMA_STEP                 .1
141 #define INTF_GAMMA_LIMIT                3
142
143 /* Maximum number of channels */
144 #define INTF_MAX_CHANNELS               10
145
146 /* Default search path for interface file browser */
147 #define INTF_PATH_VAR                   "vlc_search_path"
148 #define INTF_PATH_DEFAULT               ""
149
150 /*****************************************************************************
151  * Input thread configuration
152  *****************************************************************************/
153
154 /* Environment variable containing the input method */
155 #define INPUT_METHOD_VAR                "vlc_input"
156 #define INPUT_METHOD_DEFAULT            "ps"
157
158 /* XXX?? */
159 #define INPUT_IDLE_SLEEP                ((int)(0.100*CLOCK_FREQ))
160
161 /*
162  * General limitations
163  */
164
165 /* Maximum number of input threads - this value is used exclusively by
166  * interface, and is in fact an interface limitation */
167 #define INPUT_MAX_THREADS               10
168
169 /* Maximum size of a data packet (128 kB) */
170 #define INPUT_MAX_PACKET_SIZE           131072
171
172 /* Maximum length of a pre-parsed chunk (4 MB) */
173 #define INPUT_PREPARSE_LENGTH           4194304
174
175 /* Maximum length of a hostname or source name */
176 #define INPUT_MAX_SOURCE_LENGTH         100
177
178 /* Default network protocol */
179 #define INPUT_NETWORK_PROTOCOL_VAR      "vlc_network_protocol"
180 #define INPUT_NETWORK_PROTOCOL_DEFAULT  "ts"
181
182 /* Default remote server */
183 #define INPUT_SERVER_VAR                "vlc_server"
184 #define INPUT_SERVER_DEFAULT            "138.195.143.220"
185
186 /* Default input port */
187 #define INPUT_PORT_VAR                  "vlc_server_port"
188 #define INPUT_PORT_DEFAULT              1234
189
190 /* Default broadcast address */
191 #define INPUT_BCAST_ADRR_VAR            "vlc_broadcast_addr"
192 #define INPUT_BCAST_ADDR_DEFAULT        "138.195.143.255"
193
194 /* Broadcast mode */
195 #define INPUT_BROADCAST_VAR             "vlc_broadcast"
196 #define INPUT_BROADCAST_DEFAULT         0
197
198 /*
199  * Channel method
200  */
201
202 /* Default network interface and environment variable */
203 #define INPUT_IFACE_VAR                 "vlc_iface"
204 #define INPUT_IFACE_DEFAULT             "eth0"
205
206 /* Default server and port */
207 #define INPUT_CHANNEL_SERVER_VAR           "vlc_channel_server"
208 #define INPUT_CHANNEL_SERVER_DEFAULT       "138.195.139.95"
209 #define INPUT_CHANNEL_PORT_VAR             "vlc_channel_port"
210 #define INPUT_CHANNEL_PORT_DEFAULT         6010
211
212 /* Delay between channel changes - this is required to avoid flooding the 
213  * channel server */
214 #define INPUT_CHANNEL_CHANGE_DELAY         (mtime_t)(5*CLOCK_FREQ)
215
216 /* Duration between the time we receive the data packet, and the time we will
217  * mark it to be presented */
218 #define DEFAULT_PTS_DELAY               (mtime_t)(.2*CLOCK_FREQ)
219
220 /* DVD defaults */
221 #define INPUT_DVD_DEVICE_VAR            "vlc_dvd_device"
222 #define INPUT_DVD_DEVICE_DEFAULT        "/dev/dvd"
223
224 #define INPUT_TITLE_VAR                 "vlc_input_title"
225 #define INPUT_CHAPTER_VAR               "vlc_input_chapter"
226 #define INPUT_ANGLE_VAR                 "vlc_input_angle"
227 #define INPUT_AUDIO_VAR                 "vlc_input_audio"
228 #define INPUT_CHANNEL_VAR               "vlc_input_channel"
229 #define INPUT_SUBTITLE_VAR              "vlc_input_subtitle"
230
231 /* VCD defaults */
232 #define INPUT_VCD_DEVICE_VAR            "vlc_vcd_device"
233 #define INPUT_VCD_DEVICE_DEFAULT        "/dev/cdrom"
234
235 /*****************************************************************************
236  * Audio configuration
237  *****************************************************************************/
238
239 /* Maximum number of audio output threads */
240 #define AOUT_MAX_THREADS                10
241
242 /* Environment variable containing the audio output method */
243 #define AOUT_METHOD_VAR                 "vlc_aout"
244 #define AOUT_METHOD_DEFAULT             "dsp"
245
246 /* Environment variable used to store dsp device name, and default value */
247 #define AOUT_DSP_VAR                    "vlc_dsp"
248 #define AOUT_DSP_DEFAULT                "/dev/dsp"
249
250 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
251 #define AOUT_FORMAT_DEFAULT             AOUT_FMT_S16_NE
252 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S8 */
253 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U8 */
254 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_BE */
255 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_LE */
256 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_BE */
257 /* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_LE */
258
259 /* Environment variable for stereo, and default value */
260 #define AOUT_STEREO_VAR                 "vlc_stereo"
261 #define AOUT_STEREO_DEFAULT             1
262
263 /* Environment variable for spdif mode */
264 #define AOUT_SPDIF_VAR                  "vlc_spdif"
265 #define AOUT_SPDIF_DEFAULT              0
266
267 /* Environment variable containing the AC3 downmix method */
268 #define DOWNMIX_METHOD_VAR              "vlc_downmix"
269
270 /* Environment variable containing the AC3 IMDCT method */
271 #define IMDCT_METHOD_VAR                "vlc_imdct"
272
273 /* Volume */
274 #define VOLUME_DEFAULT                  512
275 #define VOLUME_STEP                     128
276 #define VOLUME_MAX                      1024
277
278 /* Environment variable for output rate, and default value */
279 #define AOUT_RATE_VAR                   "vlc_audio_rate"
280 #define AOUT_RATE_DEFAULT               44100
281
282 /* Number of audio output frames contained in an audio output fifo.
283  * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
284  * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
285  * With 511 we have at least 511*384/2/48000=2 seconds of sound */
286 #define AOUT_FIFO_SIZE                  511
287
288 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
289  * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
290  * operations with '>>' and '<<' (gcc changes this at compilation-time) */
291 #define AOUT_MAX_FIFOS                  2
292
293 /* Duration (in microseconds) of an audio output buffer should be :
294  * - short, in order to be able to play a new song very quickly (especially a
295  *   song from the interface)
296  * - long, in order to perform the buffer calculations as few as possible */
297 #define AOUT_BUFFER_DURATION            100000
298
299 /*****************************************************************************
300  * Video configuration
301  *****************************************************************************/
302
303 /* Maximum number of video output threads */
304 #define VOUT_MAX_THREADS                10
305
306 /*
307  * Default settings for video output threads
308  */
309
310 /* Environment variable containing the display method */
311 #define VOUT_METHOD_VAR                 "vlc_vout"
312 #define VOUT_METHOD_DEFAULT             "x11"
313
314 /* Environment variable containing the motion compensation method */
315 #define MOTION_METHOD_VAR               "vlc_motion"
316
317 /* Environment variable containing the IDCT method */
318 #define IDCT_METHOD_VAR                 "vlc_idct"
319
320 /* Environment variable containing the YUV method */
321 #define YUV_METHOD_VAR                  "vlc_yuv"
322
323 /* Environment variable used in place of DISPLAY if available */
324 #define VOUT_DISPLAY_VAR                "vlc_display"
325
326 /* Default dimensions for display window - these dimensions are enough for the
327  * standard width and height broadcasted MPEG-2 streams or DVDs */
328 #define VOUT_WIDTH_VAR                  "vlc_width"
329 #define VOUT_HEIGHT_VAR                 "vlc_height"
330 #define VOUT_WIDTH_DEFAULT              720
331 #define VOUT_HEIGHT_DEFAULT             576
332
333 #define VOUT_DEPTH_VAR                  "vlc_depth"
334 #define VOUT_DEPTH_DEFAULT              15
335
336 #define VOUT_FULLSCREEN_VAR             "vlc_fullscreen"
337 #define VOUT_FULLSCREEN_DEFAULT         0
338
339 #define VOUT_FULLSCREEN_DEPTH_VAR       "vlc_fullscreen_depth"
340 #define VOUT_FULLSCREEN_DEPTH_DEFAULT   32
341
342 /* Maximum width of a scaled source picture - this should be relatively high,
343  * since higher stream values will result in no display at all. */
344 #define VOUT_MAX_WIDTH                  4096
345
346 /* Video heap size - remember that a decompressed picture is big
347  * (~1 Mbyte) before using huge values */
348 #define VOUT_MAX_PICTURES               5
349
350 /* Number of simultaneous subpictures */
351 #define VOUT_MAX_SUBPICTURES            5
352
353 /* Maximum number of active areas in a rendering buffer. Active areas are areas
354  * of the picture which need to be cleared before re-using the buffer. If a
355  * picture, including its many additions such as subtitles, additionnal user
356  * informations and interface, has too many active areas, some of them are
357  * joined. */
358 #define VOUT_MAX_AREAS                  5
359
360 /* Environment variable for grayscale output mode, and default value */
361 #define VOUT_GRAYSCALE_VAR              "vlc_grayscale"
362 #define VOUT_GRAYSCALE_DEFAULT          0
363
364 /* Environment variable for fullscreen mode, and default value */
365 #define VOUT_FULLSCREEN_VAR             "vlc_fullscreen"
366 #define VOUT_FULLSCREEN_DEFAULT         0
367
368 /* Environment variable for overlay mode, and default value */
369 #define VOUT_OVERLAY_VAR                "vlc_overlay"
370 #define VOUT_OVERLAY_DEFAULT            0
371
372 /* Default gamma */
373 #define VOUT_GAMMA_VAR                  "vlc_gamma"
374 #define VOUT_GAMMA_DEFAULT              0.
375
376 /* Default fonts */
377 #define VOUT_DEFAULT_FONT               "default8x9.psf"
378 #define VOUT_LARGE_FONT                 "default8x16.psf"
379
380 /* Statistics are displayed every n loops (=~ pictures) */
381 #define VOUT_STATS_NB_LOOPS             100
382
383 /*
384  * Time settings
385  */
386
387 /* Time during which the thread will sleep if it has nothing to
388  * display (in micro-seconds) */
389 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
390
391 /* Maximum lap of time allowed between the beginning of rendering and
392  * display. If, compared to the current date, the next image is too
393  * late, the thread will perform an idle loop. This time should be
394  * at least VOUT_IDLE_SLEEP plus the time required to render a few
395  * images, to avoid trashing of decoded images */
396 #define VOUT_DISPLAY_DELAY              ((int)(0.500*CLOCK_FREQ))
397
398 /* Delay (in microseconds) before an idle screen is displayed */
399 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
400
401 /* Number of pictures required to computes the FPS rate */
402 #define VOUT_FPS_SAMPLES                20
403
404 /* Better be in advance when awakening than late... */
405 #define VOUT_MWAIT_TOLERANCE            ((int)(0.020*CLOCK_FREQ))
406
407 /*
408  * Framebuffer settings
409  */
410
411 /* Environment variable for framebuffer device, and default value */
412 #define VOUT_FB_DEV_VAR                 "vlc_fb_dev"
413 #define VOUT_FB_DEV_DEFAULT             "/dev/fb0"
414
415 /* The default video output window title */
416 #define VOUT_TITLE                      "VideoLAN Client @VLC_VERSION@"
417
418 /*****************************************************************************
419  * Video parser configuration
420  *****************************************************************************/
421
422 #define VPAR_IDLE_SLEEP                 ((int)(0.010*CLOCK_FREQ))
423
424 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
425  * It should be approximately the time needed to perform a complete picture
426  * loop. Since it only happens when the video heap is full, it does not need
427  * to be too low, even if it blocks the decoder. */
428 #define VPAR_OUTMEM_SLEEP               ((int)(0.020*CLOCK_FREQ))
429
430 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
431  * that raising this level dramatically lengthens the compilation time. */
432 #define VPAR_OPTIM_LEVEL                2
433
434 /* The following directives only apply if you define VDEC_SMP below. */
435
436 /* Number of macroblock buffers available. It should be always greater than
437  * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
438  * be a power of two. */
439 #define VFIFO_SIZE                      8191
440
441 /* Maximum number of macroblocks in a picture. */
442 #define MAX_MB                          2048
443
444 /* The synchro variable name */
445 #define VPAR_SYNCHRO_VAR                "vlc_synchro"
446
447 /*****************************************************************************
448  * Video decoder configuration
449  *****************************************************************************/
450
451 //#define VDEC_SMP
452
453 #define VDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
454
455 /* Number of video_decoder threads to launch on startup of the video_parser.
456  * It should always be less than half the number of macroblocks of a
457  * picture. Only available if you defined VDEC_SMP above. */
458 #define NB_VDEC                         1
459
460 /* Maximum range of values out of the IDCT + motion compensation. */
461 #define VDEC_CROPRANGE                  2048
462
463 /* Nice increments for decoders -- necessary for x11 scheduling */
464 #define VDEC_NICE                       3
465
466 /*****************************************************************************
467  * Generic decoder configuration
468  *****************************************************************************/
469
470 #define GDEC_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
471
472 /*****************************************************************************
473  * Messages and console interfaces configuration
474  *****************************************************************************/
475
476 /* Maximal size of a message to be stored in the mesage queue,
477  * it is needed when vasprintf is not avalaible */
478 #define INTF_MAX_MSG_SIZE              512
479
480 /* Maximal size of the message queue - in case of overflow, all messages in the
481  * queue are printed by the calling thread */
482 #define INTF_MSG_QSIZE                  64
483
484 /* Interface warnig message level */
485 #define INTF_WARNING_VAR                "vlc_warning_level"
486 #define INTF_WARNING_DEFAULT            0
487
488 /* Define to enable messages queues - disabling messages queue can be useful
489  * when debugging, since it allows messages which would not be printed
490  * due to a crash to be printed anyway */
491 #ifndef DEBUG
492 #define INTF_MSG_QUEUE
493 #endif
494
495 /* Format of the header for debug messages. The arguments following this header
496  * are the file (char *), the function (char *) and the line (int) in which the
497  * message function was called */
498 #define INTF_MSG_DBG_FORMAT             "## %s:%s(),%i: "
499
500 /* Max number of arguments on a command line, including the function name */
501 #define INTF_MAX_ARGS                   20
502
503 /* Maximal size of a command line in a script */
504 #define INTF_MAX_CMD_SIZE               240
505
506 /* Number of memorized lines in console window text zone */
507 #define INTF_CONSOLE_MAX_TEXT           100
508
509 /* Maximal number of commands which can be saved in history list */
510 #define INTF_CONSOLE_MAX_HISTORY        20
511
512 /****************************************************************************
513  * Playlist defaults
514  ****************************************************************************/
515
516 /* Launch on start-up */
517 #define PLAYLIST_STARTUP_VAR            "vlc_playlist_on_start_up"
518 #define PLAYLIST_STARTUP_DEFAULT        0
519
520 /* Enqueue drag'n dropped item */
521 #define PLAYLIST_ENQUEUE_VAR            "vlc_playlist_enqueue"
522 #define PLAYLIST_ENQUEUE_DEFAULT        0
523
524 /* Loop on playlist end */
525 #define PLAYLIST_LOOP_VAR               "vlc_playlist_loop"
526 #define PLAYLIST_LOOP_DEFAULT           0
527