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
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 /* Conventions regarding names of symbols and variables
26 * ----------------------------------------------------
28 * - Symbols should begin with a prefix indicating in which module they are
29 * used, such as INTF_, VOUT_ or ADEC_.
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'
39 /*****************************************************************************
41 *****************************************************************************/
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"
50 #define VERSION "@VLC_VERSION@"
52 /*****************************************************************************
53 * Debugging options - define or undefine symbols
54 *****************************************************************************/
56 /* General trace support, which depends of the TRACE define, is determined
59 /* Modules specific debugging - this will produce a lot of output, but can be
60 * useful to track a bug */
67 /* Trace log file - if defined, a file can be used to store all messages. If
68 * TRACE_LOG_ONLY is defined, debug messages will only be printed to the log and
69 * will not appear on the screen */
70 #define TRACE_LOG "vlc-trace.log"
71 #define TRACE_LOG_ONLY
75 /*****************************************************************************
76 * General configuration
77 *****************************************************************************/
79 #define CLOCK_FREQ 1000000
82 /* Automagically spawn audio and video decoder threads */
85 /* When creating or destroying threads in blocking mode, delay to poll thread
87 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
89 /* When a thread waits on a condition in debug mode, delay to wait before
90 * outputting an error message (in second) */
91 #define THREAD_COND_TIMEOUT 5
93 /* Environment variable containing the memcpy method */
94 #define MEMCPY_METHOD_VAR "vlc_memcpy"
97 * Decoders FIFO configuration
100 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
101 #define FIFO_SIZE 1023
107 #define DATA_PATH "@prefix@/share/videolan"
108 #define PLUGIN_PATH "@prefix@/lib/videolan/vlc"
110 #define MAX_PLUGIN_COUNT 32
112 /*****************************************************************************
113 * Interface configuration
114 *****************************************************************************/
116 /* Environment variable containing the display method */
117 #define INTF_METHOD_VAR "vlc_intf"
118 #define INTF_METHOD_DEFAULT "gtk"
120 /* Environment variable used to store startup script name and default value */
121 #define INTF_INIT_SCRIPT_VAR "vlcrc"
122 #define INTF_INIT_SCRIPT_DEFAULT ".vlcrc"
124 /* Environment variable used to store channels file and default value */
125 #define INTF_CHANNELS_VAR "vlc_channels"
126 #define INTF_CHANNELS_DEFAULT "vlc.channels"
128 /* Base delay in micro second for interface sleeps */
129 #define INTF_IDLE_SLEEP ((int)(0.050*CLOCK_FREQ))
131 /* Step for changing gamma, and minimum and maximum values */
132 #define INTF_GAMMA_STEP .1
133 #define INTF_GAMMA_LIMIT 3
135 /* Maximum number of channels */
136 #define INTF_MAX_CHANNELS 10
138 /* Default search path for interface file browser */
139 #define INTF_PATH_VAR "vlc_search_path"
140 #define INTF_PATH_DEFAULT ""
142 /* Environment variable containing the standard output method */
143 #define INTF_STDOUT_VAR "vlc_stdout"
144 #define INTF_STDOUT_DEFAULT ""
146 /*****************************************************************************
147 * Input thread configuration
148 *****************************************************************************/
150 /* Environment variable containing the input method */
151 #define INPUT_METHOD_VAR "vlc_input"
152 #define INPUT_METHOD_DEFAULT "ps"
155 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
158 * General limitations
161 /* Maximum number of input threads - this value is used exclusively by
162 * interface, and is in fact an interface limitation */
163 #define INPUT_MAX_THREADS 10
165 /* Maximum size of a data packet (128 kB) */
166 #define INPUT_MAX_PACKET_SIZE 131072
168 /* Maximum length of a pre-parsed chunk (4 MB) */
169 #define INPUT_PREPARSE_LENGTH 4194304
171 /* Maximum length of a hostname or source name */
172 #define INPUT_MAX_SOURCE_LENGTH 100
174 /* Default network protocol */
175 #define INPUT_NETWORK_PROTOCOL_VAR "vlc_network_protocol"
176 #define INPUT_NETWORK_PROTOCOL_DEFAULT "ts"
178 /* Default remote server */
179 #define INPUT_SERVER_VAR "vlc_server"
180 #define INPUT_SERVER_DEFAULT "138.195.143.220"
182 /* Default input port */
183 #define INPUT_PORT_VAR "vlc_server_port"
184 #define INPUT_PORT_DEFAULT 1234
186 /* Default broadcast address */
187 #define INPUT_BCAST_ADDR_VAR "vlc_broadcast_addr"
188 #define INPUT_BCAST_ADDR_DEFAULT "138.195.143.255"
191 #define INPUT_BROADCAST_VAR "vlc_broadcast"
192 #define INPUT_BROADCAST_DEFAULT 0
195 #define INPUT_NETWORK_CHANNEL_VAR "vlc_channel"
196 #define INPUT_NETWORK_CHANNEL_DEFAULT 0
202 /* Default network interface and environment variable */
203 #define INPUT_IFACE_VAR "vlc_iface"
204 #define INPUT_IFACE_DEFAULT "eth0"
206 /* Default server and port */
207 #define INPUT_CHANNEL_SERVER_VAR "vlc_channel_server"
208 #define INPUT_CHANNEL_SERVER_DEFAULT "138.195.143.120"
209 #define INPUT_CHANNEL_PORT_VAR "vlc_channel_port"
210 #define INPUT_CHANNEL_PORT_DEFAULT 6010
212 /* Delay between channel changes - this is required to avoid flooding the
214 #define INPUT_CHANNEL_CHANGE_DELAY (mtime_t)(5*CLOCK_FREQ)
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)
221 #define INPUT_DVD_DEVICE_VAR "vlc_dvd_device"
222 #define INPUT_DVD_DEVICE_DEFAULT "/dev/dvd"
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"
232 #define INPUT_VCD_DEVICE_VAR "vlc_vcd_device"
233 #define INPUT_VCD_DEVICE_DEFAULT "/dev/cdrom"
235 /*****************************************************************************
236 * Audio configuration
237 *****************************************************************************/
239 /* Maximum number of audio output threads */
240 #define AOUT_MAX_THREADS 10
242 /* Environment variable containing the audio output method */
243 #define AOUT_METHOD_VAR "vlc_aout"
244 #define AOUT_METHOD_DEFAULT "dsp"
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"
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 */
259 /* Environment variable for stereo, and default value */
260 #define AOUT_STEREO_VAR "vlc_stereo"
261 #define AOUT_STEREO_DEFAULT 1
263 /* Environment variable for spdif mode */
264 #define AOUT_SPDIF_VAR "vlc_spdif"
265 #define AOUT_SPDIF_DEFAULT 0
267 /* Environment variable containing the AC3 downmix method */
268 #define DOWNMIX_METHOD_VAR "vlc_downmix"
270 /* Environment variable containing the AC3 IMDCT method */
271 #define IMDCT_METHOD_VAR "vlc_imdct"
274 #define VOLUME_DEFAULT 512
275 #define VOLUME_STEP 128
276 #define VOLUME_MAX 1024
278 /* Environment variable for volume */
279 #define AOUT_VOLUME_VAR "vlc_volume"
281 /* Environment variable for output rate, and default value */
282 #define AOUT_RATE_VAR "vlc_audio_rate"
283 #define AOUT_RATE_DEFAULT 44100
285 /* Number of audio output frames contained in an audio output fifo.
286 * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
287 * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
288 * With 511 we have at least 511*384/2/48000=2 seconds of sound */
289 #define AOUT_FIFO_SIZE 511
291 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
292 * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
293 * operations with '>>' and '<<' (gcc changes this at compilation-time) */
294 #define AOUT_MAX_FIFOS 2
296 /* Duration (in microseconds) of an audio output buffer should be :
297 * - short, in order to be able to play a new song very quickly (especially a
298 * song from the interface)
299 * - long, in order to perform the buffer calculations as few as possible */
300 #define AOUT_BUFFER_DURATION 100000
302 /*****************************************************************************
303 * Video configuration
304 *****************************************************************************/
306 /* Maximum number of video output threads */
307 #define VOUT_MAX_THREADS 10
310 * Default settings for video output threads
313 /* Environment variable containing the display method */
314 #define VOUT_METHOD_VAR "vlc_vout"
315 #define VOUT_METHOD_DEFAULT "x11"
317 /* Environment variable containing the motion compensation method */
318 #define MOTION_METHOD_VAR "vlc_motion"
320 /* Environment variable containing the IDCT method */
321 #define IDCT_METHOD_VAR "vlc_idct"
323 /* Environment variable containing the YUV method */
324 #define YUV_METHOD_VAR "vlc_yuv"
326 /* Environment variable used in place of DISPLAY if available */
327 #define VOUT_DISPLAY_VAR "vlc_display"
329 /* Default dimensions for display window - these dimensions are enough for the
330 * standard width and height broadcasted MPEG-2 streams or DVDs */
331 #define VOUT_WIDTH_VAR "vlc_width"
332 #define VOUT_WIDTH_DEFAULT 720
333 #define VOUT_HEIGHT_VAR "vlc_height"
334 #define VOUT_HEIGHT_DEFAULT 576
335 #define VOUT_DEPTH_VAR "vlc_depth"
336 #define VOUT_DEPTH_DEFAULT 15
337 #define VOUT_FULLSCREEN_DEPTH_VAR "vlc_fullscreen_depth"
338 #define VOUT_FULLSCREEN_DEPTH_DEFAULT 32
340 /* Maximum width of a scaled source picture - this should be relatively high,
341 * since higher stream values will result in no display at all. */
342 #define VOUT_MAX_WIDTH 4096
344 /* Video heap size - remember that a decompressed picture is big
345 * (~1 Mbyte) before using huge values */
346 #define VOUT_MAX_PICTURES 8
348 /* Number of simultaneous subpictures */
349 #define VOUT_MAX_SUBPICTURES 8
351 /* Maximum number of active areas in a rendering buffer. Active areas are areas
352 * of the picture which need to be cleared before re-using the buffer. If a
353 * picture, including its many additions such as subtitles, additionnal user
354 * informations and interface, has too many active areas, some of them are
356 #define VOUT_MAX_AREAS 5
358 /* Environment variable for grayscale output mode, and default value */
359 #define VOUT_GRAYSCALE_VAR "vlc_grayscale"
360 #define VOUT_GRAYSCALE_DEFAULT 0
362 /* Environment variable for fullscreen mode, and default value */
363 #define VOUT_FULLSCREEN_VAR "vlc_fullscreen"
364 #define VOUT_FULLSCREEN_DEFAULT 0
366 /* Environment variable for overlay mode, and default value */
367 #define VOUT_OVERLAY_VAR "vlc_overlay"
368 #define VOUT_OVERLAY_DEFAULT 0
371 #define VOUT_GAMMA_VAR "vlc_gamma"
372 #define VOUT_GAMMA_DEFAULT 0.
375 #define VOUT_DEFAULT_FONT "default8x9.psf"
376 #define VOUT_LARGE_FONT "default8x16.psf"
378 /* Statistics are displayed every n loops (=~ pictures) */
379 #define VOUT_STATS_NB_LOOPS 100
385 /* Time during which the thread will sleep if it has nothing to
386 * display (in micro-seconds) */
387 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
389 /* Maximum lap of time allowed between the beginning of rendering and
390 * display. If, compared to the current date, the next image is too
391 * late, the thread will perform an idle loop. This time should be
392 * at least VOUT_IDLE_SLEEP plus the time required to render a few
393 * images, to avoid trashing of decoded images */
394 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
396 /* Delay (in microseconds) before an idle screen is displayed */
397 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
399 /* Number of pictures required to computes the FPS rate */
400 #define VOUT_FPS_SAMPLES 20
402 /* Better be in advance when awakening than late... */
403 #define VOUT_MWAIT_TOLERANCE ((int)(0.020*CLOCK_FREQ))
405 /* The default video output window title */
406 #define VOUT_TITLE "VideoLAN Client @VLC_VERSION@"
408 /* Environment variable for framebuffer device, and default value */
409 #define VOUT_FB_DEV_VAR "vlc_fb_dev"
410 #define VOUT_FB_DEV_DEFAULT "/dev/fb0"
412 /* Environment variable for XVideo adaptor, and default value */
413 #define VOUT_XVADAPTOR_VAR "vlc_xv_adaptor"
415 /*****************************************************************************
416 * Video parser configuration
417 *****************************************************************************/
419 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
421 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
422 * It should be approximately the time needed to perform a complete picture
423 * loop. Since it only happens when the video heap is full, it does not need
424 * to be too low, even if it blocks the decoder. */
425 #define VPAR_OUTMEM_SLEEP ((int)(0.020*CLOCK_FREQ))
427 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
428 * that raising this level dramatically lengthens the compilation time. */
430 # define VPAR_OPTIM_LEVEL 2
432 # define VPAR_OPTIM_LEVEL 1
435 /* Maximum number of macroblocks in a picture. */
438 /* The synchro variable name */
439 #define VPAR_SYNCHRO_VAR "vlc_synchro"
441 /*****************************************************************************
442 * Video decoder configuration
443 *****************************************************************************/
445 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
447 /* Maximum range of values out of the IDCT + motion compensation. */
448 #define VDEC_CROPRANGE 2048
450 /* Environment variable containing the SMP value. */
451 #define VDEC_SMP_VAR "vlc_smp"
453 /* No SMP by default, since it slows down things on non-smp machines. */
454 #define VDEC_SMP_DEFAULT 0
456 /* Nice increments for decoders -- necessary for x11 scheduling */
459 /*****************************************************************************
460 * Messages and console interfaces configuration
461 *****************************************************************************/
463 /* Maximal size of a message to be stored in the mesage queue,
464 * it is needed when vasprintf is not avalaible */
465 #define INTF_MAX_MSG_SIZE 512
467 /* Maximal size of the message queue - in case of overflow, all messages in the
468 * queue are printed by the calling thread */
469 #define INTF_MSG_QSIZE 64
471 /* Interface warnig message level */
472 #define INTF_WARNING_VAR "vlc_warning_level"
473 #define INTF_WARNING_DEFAULT 0
475 /* Define to enable messages queues - disabling messages queue can be useful
476 * when debugging, since it allows messages which would not be printed
477 * due to a crash to be printed anyway */
479 #define INTF_MSG_QUEUE
482 /* Format of the header for debug messages. The arguments following this header
483 * are the file (char *), the function (char *) and the line (int) in which the
484 * message function was called */
485 #define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
487 /* Max number of arguments on a command line, including the function name */
488 #define INTF_MAX_ARGS 20
490 /* Maximal size of a command line in a script */
491 #define INTF_MAX_CMD_SIZE 240
493 /* Number of memorized lines in console window text zone */
494 #define INTF_CONSOLE_MAX_TEXT 100
496 /* Maximal number of commands which can be saved in history list */
497 #define INTF_CONSOLE_MAX_HISTORY 20
499 /****************************************************************************
501 ****************************************************************************/
503 /* Launch on start-up */
504 #define PLAYLIST_STARTUP_VAR "vlc_playlist_on_start_up"
505 #define PLAYLIST_STARTUP_DEFAULT 0
507 /* Enqueue drag'n dropped item */
508 #define PLAYLIST_ENQUEUE_VAR "vlc_playlist_enqueue"
509 #define PLAYLIST_ENQUEUE_DEFAULT 0
511 /* Loop on playlist end */
512 #define PLAYLIST_LOOP_VAR "vlc_playlist_loop"
513 #define PLAYLIST_LOOP_DEFAULT 0