1 /*****************************************************************************
2 * config.h: limits and configuration
3 * Defines all compilation-time configuration constants and size limits
4 *****************************************************************************
5 * Copyright (C) 1999, 2000 VideoLAN
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /* Conventions regarding names of symbols and variables
25 * ----------------------------------------------------
27 * - Symbols should begin with a prefix indicating in which module they are
28 * used, such as INTF_, VOUT_ or ADEC_.
30 * - Regarding environment variables, which are used as initialization parameters
32 * + variable names should end with '_VAR'
33 * + environment variable default value should end with '_DEFAULT'
34 * + values having a special meaning with '_VAL'
38 /*****************************************************************************
40 *****************************************************************************/
42 /* Program version and copyright message */
43 #define VERSION_MESSAGE "vlc @VLC_VERSION@ @VLC_CODENAME@ " \
44 /* "(" PROGRAM_BUILD ") (" PROGRAM_OPTIONS ")\n" */ \
45 "Copyright 1996-2000 VideoLAN\n"
46 #define COPYRIGHT_MESSAGE "VideoLAN Client - version @VLC_VERSION@" \
47 " @VLC_CODENAME@ - (c)1996-2000 VideoLAN"
49 #define VERSION "@VLC_VERSION@"
51 /*****************************************************************************
52 * General compilation options
53 *****************************************************************************/
55 /* Define for DVB support - Note that some extensions or restrictions may be
56 * incompatible with native MPEG2 streams */
57 //#define DVB_EXTENSIONS
58 //#define DVB_RESTRICTIONS
60 /* Define to disable some obscure heuristics behind the video_parser and the
61 * video_decoder that improve performance but are not fully MPEG2 compliant
62 * and might cause problems with some very weird streams. */
63 //#define MPEG2_COMPLIANT
65 /* Define for profiling and statistics support - such informations, like FPS
66 * or pictures count won't be available if it not set */
69 /* Define for unthreaded version of the program FIXME: not yet implemented ??*/
72 /*****************************************************************************
73 * Debugging options - define or undefine symbols
74 *****************************************************************************/
76 /* General debugging support, which depends of the DEBUG define, is determined
79 /* Modules specific debugging - this will produce a lot of output, but can be
80 * usefull to track a bug */
86 /* Debugging log file - if defined, a file can be used to store all messages. If
87 * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
88 * will not appear on the screen */
89 #define DEBUG_LOG "vlc-debug.log"
90 #define DEBUG_LOG_ONLY
94 /*****************************************************************************
95 * General configuration
96 *****************************************************************************/
98 #define CLOCK_FREQ 1000000
101 /* Automagically spawn input, audio and video threads ? */
105 /* When creating or destroying threads in blocking mode, delay to poll thread
107 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
110 * Decoders FIFO configuration
113 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
114 #define FIFO_SIZE 1023
117 /*****************************************************************************
118 * Interface configuration
119 *****************************************************************************/
121 /* Environment variable used to store startup script name and default value */
122 #define INTF_INIT_SCRIPT_VAR "vlc_init"
123 #define INTF_INIT_SCRIPT_DEFAULT "vlc.init"
125 /* Environment variable used to store channels file and default value */
126 #define INTF_CHANNELS_VAR "vlc_channels"
127 #define INTF_CHANNELS_DEFAULT "vlc.channels"
129 /* Base delay in micro second for interface sleeps */
130 #define INTF_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
132 /* Step for changing gamma, and minimum and maximum values */
133 #define INTF_GAMMA_STEP .1
134 #define INTF_GAMMA_LIMIT 3
136 /* Maximum number of channels */
137 #define INTF_MAX_CHANNELS 10
143 /* Title of the X11 window */
144 #define VOUT_TITLE "VideoLAN Client"
146 /*****************************************************************************
147 * Input thread configuration
148 *****************************************************************************/
151 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
154 * General limitations
157 /* Broadcast address, in case of a broadcasted stream */
158 #define INPUT_BCAST_ADDR "138.195.143.255"
160 /* Maximum number of input threads - this value is used exclusively by
161 * interface, and is in fact an interface limitation */
162 #define INPUT_MAX_THREADS 10
164 /* Maximum number of programs definitions in a TS stream */
165 #define INPUT_MAX_PGRM 10
167 /* Maximum number of ES definitions in a TS stream */
168 #define INPUT_MAX_ES 10
170 /* Maximum number of ES in a single program */
171 #define INPUT_MAX_PROGRAM_ES 10
173 /* Maximum number of selected ES in an input thread */
174 #define INPUT_MAX_SELECTED_ES 10
176 /* Maximum number of TS packets in the client at any time
177 * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
178 * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
179 * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
180 #define INPUT_MAX_TS 32767 /* INPUT_MAX_TS + 1 = 2^15 */
182 /* Same thing with PES packets */
183 #define INPUT_MAX_PES 16383
185 /* Maximum number of TS packets we read from the socket in one readv().
186 * Since you can't put more than 7 TS packets in an Ethernet frame,
187 * the maximum value is 7. This number should also limit the stream server,
188 * otherwise any supplementary packet is lost. */
189 #define INPUT_TS_READ_ONCE 7
191 /* Use a LIFO or FIFO for TS netlist ? */
192 #undef INPUT_LIFO_TS_NETLIST
194 /* Use a LIFO or FIFO for PES netlist ? */
195 #undef INPUT_LIFO_PES_NETLIST
197 /* Maximum length of a hostname or source name */
198 #define INPUT_MAX_SOURCE_LENGTH 100
200 /* Default remote server */
201 #define INPUT_SERVER_VAR "vlc_server"
202 #define INPUT_SERVER_DEFAULT "138.195.143.220"
204 /* Default input port */
205 #define INPUT_PORT_VAR "vlc_server_port"
206 #define INPUT_PORT_DEFAULT 1234
212 /* Default network interface and environment variable */
213 #define INPUT_IFACE_VAR "vlc_iface"
214 #define INPUT_IFACE_DEFAULT "eth0"
216 /* Default server and port */
217 #define INPUT_VLAN_SERVER_VAR "vlc_vlan_server"
218 #define INPUT_VLAN_SERVER_DEFAULT "138.195.140.31"
219 #define INPUT_VLAN_PORT_VAR "vlc_vlan_port"
220 #define INPUT_VLAN_PORT_DEFAULT 6010
222 /* Delay between vlan changes - this is required to avoid flooding the VLAN
224 #define INPUT_VLAN_CHANGE_DELAY (5*CLOCK_FREQ)
226 /* Duration between the time we receive the TS packet, and the time we will
227 * mark it to be presented */
228 #define INPUT_PTS_DELAY (2*CLOCK_FREQ)
230 #define INPUT_DVD_AUDIO_VAR "vlc_dvd_audio"
231 #define INPUT_DVD_CHANNEL_VAR "vlc_dvd_channel"
232 #define INPUT_DVD_SUBTITLE_VAR "vlc_dvd_subtitle"
234 /*****************************************************************************
235 * Audio configuration
236 *****************************************************************************/
238 /* Environment variable containing the audio output method */
239 #define AOUT_METHOD_VAR "vlc_aout"
241 /* The fallback method */
242 #define AOUT_DEFAULT_METHOD "dsp"
244 /* Environment variable used to store dsp device name, and default value */
245 #define AOUT_DSP_VAR "vlc_dsp"
246 #define AOUT_DSP_DEFAULT "/dev/dsp"
248 /* Environment variable for stereo, and default value */
249 #define AOUT_STEREO_VAR "vlc_stereo"
250 #define AOUT_STEREO_DEFAULT 1
252 /* Environment variable for output rate, and default value */
253 #define AOUT_RATE_VAR "vlc_audio_rate"
254 #define AOUT_RATE_DEFAULT 44100
256 /*****************************************************************************
257 * Video configuration
258 *****************************************************************************/
261 * Default settings for video output threads
264 /* Environment variable containing the display method */
265 #define VOUT_METHOD_VAR "vlc_vout"
267 /* The fallback method */
268 #define VOUT_DEFAULT_METHOD "x11"
270 /* Environment variable used in place of DISPLAY if available */
271 #define VOUT_DISPLAY_VAR "vlc_display"
273 /* Default dimensions for display window - these dimensions are enough for the
274 * standard width and height broadcasted MPEG-2 streams */
275 #define VOUT_WIDTH_VAR "vlc_width"
276 #define VOUT_HEIGHT_VAR "vlc_height"
277 #define VOUT_WIDTH_DEFAULT 720
278 #define VOUT_HEIGHT_DEFAULT 576
280 /* Maximum width of a scaled source picture - this should be relatively high,
281 * since higher stream values will result in no display at all. */
282 #define VOUT_MAX_WIDTH 4096
284 /* Video heap size - remember that a decompressed picture is big
285 * (~1 Mbyte) before using huge values */
286 #define VOUT_MAX_PICTURES 10
288 /* Number of simultaneous subpictures */
289 #define VOUT_MAX_SUBPICTURES 10
291 /* Maximum number of active areas in a rendering buffer. Active areas are areas
292 * of the picture which need to be cleared before re-using the buffer. If a
293 * picture, including its many additions such as subtitles, additionnal user
294 * informations and interface, has too many active areas, some of them are
296 #define VOUT_MAX_AREAS 5
298 /* Environment variable for grayscale output mode, and default value */
299 #define VOUT_GRAYSCALE_VAR "vlc_grayscale"
300 #define VOUT_GRAYSCALE_DEFAULT 0
303 #define VOUT_GAMMA 0.
306 #define VOUT_DEFAULT_FONT "default8x9.psf"
307 #define VOUT_LARGE_FONT "default8x16.psf"
313 /* Time during which the thread will sleep if it has nothing to
314 * display (in micro-seconds) */
315 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
317 /* Maximum lap of time allowed between the beginning of rendering and
318 * display. If, compared to the current date, the next image is too
319 * late, the thread will perform an idle loop. This time should be
320 * at least VOUT_IDLE_SLEEP plus the time required to render a few
321 * images, to avoid trashing of decoded images */
322 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
324 /* Delay (in microseconds) before an idle screen is displayed */
325 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
327 /* Number of pictures required to computes the FPS rate */
328 #define VOUT_FPS_SAMPLES 20
331 * Framebuffer settings
334 /* Environment variable for framebuffer device, and default value */
335 #define VOUT_FB_DEV_VAR "vlc_fb_dev"
336 #define VOUT_FB_DEV_DEFAULT "/dev/fb0"
338 /*****************************************************************************
339 * Video parser configuration
340 *****************************************************************************/
342 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
344 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
345 * It should be approximately the time needed to perform a complete picture
346 * loop. Since it only happens when the video heap is full, it does not need
347 * to be too low, even if it blocks the decoder. */
348 #define VPAR_OUTMEM_SLEEP ((int)(0.050*CLOCK_FREQ))
350 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
351 * that raising this level dramatically lengthens the compilation time. */
352 #define VPAR_OPTIM_LEVEL 1
354 /* The following directives only apply if you define VDEC_SMP below. */
356 /* Number of macroblock buffers available. It should be always greater than
357 * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
358 * be a power of two. */
359 #define VFIFO_SIZE 8191
361 /* Maximum number of macroblocks in a picture. */
364 /*****************************************************************************
365 * Video decoder configuration
366 *****************************************************************************/
370 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
372 /* Number of video_decoder threads to launch on startup of the video_parser.
373 * It should always be less than half the number of macroblocks of a
374 * picture. Only available if you defined VDEC_SMP above. */
377 /* Maximum range of values out of the IDCT + motion compensation. */
378 #define VDEC_CROPRANGE 2048
380 /*****************************************************************************
381 * Generic decoder configuration
382 *****************************************************************************/
384 #define GDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
386 /*****************************************************************************
387 * Messages and console interfaces configuration
388 *****************************************************************************/
390 /* Maximal size of a message to be stored in the mesage queue,
391 * it is needed when vasprintf is not avalaible */
392 #define INTF_MAX_MSG_SIZE 512
394 /* Maximal size of the message queue - in case of overflow, all messages in the
395 * queue are printed by the calling thread */
396 #define INTF_MSG_QSIZE 64
398 /* Define to enable messages queues - disabling messages queue can be usefull
399 * when debugging, since it allows messages which would not otherwise be printed,
400 * due to a crash, to be printed anyway */
402 #define INTF_MSG_QUEUE
405 /* Format of the header for debug messages. The arguments following this header
406 * are the file (char *), the function (char *) and the line (int) in which the
407 * message function was called */
408 #define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
410 /* Maximal number of arguments on a command line, including the function name */
411 #define INTF_MAX_ARGS 20
413 /* Maximal size of a command line in a script */
414 #define INTF_MAX_CMD_SIZE 240
416 /* Number of memorized lines in console window text zone */
417 #define INTF_CONSOLE_MAX_TEXT 100
419 /* Maximal number of commands which can be saved in history list */
420 #define INTF_CONSOLE_MAX_HISTORY 20
422 /*****************************************************************************
423 * Synchro configuration
424 *****************************************************************************/
426 #define VOUT_SYNCHRO_LEVEL_START 5
427 #define VOUT_SYNCHRO_LEVEL_MAX 15
428 #define VOUT_SYNCHRO_HEAP_IDEAL_SIZE 5