1 /*****************************************************************************
2 * config.h: limits and configuration
3 * Defines all compilation-time configuration constants and size limits
4 *****************************************************************************
5 * Copyright (C) 1999, 2000 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-2000 VideoLAN\n"
47 #define COPYRIGHT_MESSAGE "VideoLAN Client - version @VLC_VERSION@" \
48 " @VLC_CODENAME@ - (c)1996-2000 VideoLAN\n"
50 #define VERSION "@VLC_VERSION@"
52 /*****************************************************************************
53 * General compilation options
54 *****************************************************************************/
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
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
66 /* Define for profiling and statistics support - such informations, like FPS
67 * or pictures count won't be available if it not set */
68 /* #define STATS --moved in Makefile */
70 /* Define for unthreaded version of the program FIXME: not yet implemented ??*/
73 /*****************************************************************************
74 * Debugging options - define or undefine symbols
75 *****************************************************************************/
77 /* General debugging support, which depends of the DEBUG define, is determined
80 /* Modules specific debugging - this will produce a lot of output, but can be
81 * usefull to track a bug */
88 /* Debugging log file - if defined, a file can be used to store all messages. If
89 * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
90 * will not appear on the screen */
91 #define DEBUG_LOG "vlc-debug.log"
92 #define DEBUG_LOG_ONLY
96 /*****************************************************************************
97 * General configuration
98 *****************************************************************************/
100 #define CLOCK_FREQ 1000000
103 /* Automagically spawn input, audio and video threads ? */
107 /* When creating or destroying threads in blocking mode, delay to poll thread
109 #define THREAD_SLEEP ((int)(0.010*CLOCK_FREQ))
112 * Decoders FIFO configuration
115 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
116 #define FIFO_SIZE 1023
122 #define DATA_PATH "@prefix@/share/videolan"
123 #define PLUGIN_PATH "@prefix@/lib/videolan/vlc"
125 #define MAX_PLUGIN_COUNT 32
127 /*****************************************************************************
128 * Interface configuration
129 *****************************************************************************/
131 /* Environment variable used to store startup script name and default value */
132 #define INTF_INIT_SCRIPT_VAR "vlcrc"
133 #define INTF_INIT_SCRIPT_DEFAULT ".vlcrc"
135 /* Environment variable used to store channels file and default value */
136 #define INTF_CHANNELS_VAR "vlc_channels"
137 #define INTF_CHANNELS_DEFAULT "vlc.channels"
139 /* Base delay in micro second for interface sleeps */
140 #define INTF_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
142 /* Step for changing gamma, and minimum and maximum values */
143 #define INTF_GAMMA_STEP .1
144 #define INTF_GAMMA_LIMIT 3
146 /* Maximum number of channels */
147 #define INTF_MAX_CHANNELS 10
153 /* Title of the X11 window */
154 #define VOUT_TITLE "VideoLAN Client"
156 /*****************************************************************************
157 * Input thread configuration
158 *****************************************************************************/
161 #define INPUT_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
164 * General limitations
167 /* Broadcast address, in case of a broadcasted stream */
168 #define INPUT_BCAST_ADDR "138.195.143.255"
170 /* Maximum number of input threads - this value is used exclusively by
171 * interface, and is in fact an interface limitation */
172 #define INPUT_MAX_THREADS 10
174 /* Maximum number of programs definitions in a TS stream */
175 #define INPUT_MAX_PGRM 10
177 /* Maximum number of ES definitions in a TS stream */
178 #define INPUT_MAX_ES 10
180 /* Maximum number of ES in a single program */
181 #define INPUT_MAX_PROGRAM_ES 10
183 /* Maximum number of selected ES in an input thread */
184 #define INPUT_MAX_SELECTED_ES 10
186 /* Maximum number of TS packets in the client at any time
187 * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
188 * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
189 * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
190 #define INPUT_MAX_TS 32767 /* INPUT_MAX_TS + 1 = 2^15 */
192 /* Same thing with PES packets */
193 #define INPUT_MAX_PES 16383
195 /* Maximum number of TS packets we read from the socket in one readv().
196 * Since you can't put more than 7 TS packets in an Ethernet frame,
197 * the maximum value is 7. This number should also limit the stream server,
198 * otherwise any supplementary packet is lost. */
199 #define INPUT_TS_READ_ONCE 7
201 /* Use a LIFO or FIFO for TS netlist ? */
202 #undef INPUT_LIFO_TS_NETLIST
204 /* Use a LIFO or FIFO for PES netlist ? */
205 #undef INPUT_LIFO_PES_NETLIST
207 /* Maximum length of a hostname or source name */
208 #define INPUT_MAX_SOURCE_LENGTH 100
210 /* Default remote server */
211 #define INPUT_SERVER_VAR "vlc_server"
212 #define INPUT_SERVER_DEFAULT "138.195.143.220"
214 /* Default input port */
215 #define INPUT_PORT_VAR "vlc_server_port"
216 #define INPUT_PORT_DEFAULT 1234
219 #define INPUT_BROADCAST_VAR "vlc_broadcast"
220 #define INPUT_BROADCAST_DEFAULT 0
226 /* Default network interface and environment variable */
227 #define INPUT_IFACE_VAR "vlc_iface"
228 #define INPUT_IFACE_DEFAULT "eth0"
230 /* Default server and port */
231 #define INPUT_VLAN_SERVER_VAR "vlc_vlan_server"
232 #define INPUT_VLAN_SERVER_DEFAULT "138.195.140.31"
233 #define INPUT_VLAN_PORT_VAR "vlc_vlan_port"
234 #define INPUT_VLAN_PORT_DEFAULT 6010
236 /* Delay between vlan changes - this is required to avoid flooding the VLAN
238 #define INPUT_VLAN_CHANGE_DELAY (5*CLOCK_FREQ)
240 /* Duration between the time we receive the TS packet, and the time we will
241 * mark it to be presented */
242 #define DEFAULT_PTS_DELAY (.5*CLOCK_FREQ)
244 #define INPUT_DVD_AUDIO_VAR "vlc_dvd_audio"
245 #define INPUT_DVD_CHANNEL_VAR "vlc_dvd_channel"
246 #define INPUT_DVD_SUBTITLE_VAR "vlc_dvd_subtitle"
248 /*****************************************************************************
249 * Audio configuration
250 *****************************************************************************/
252 /* Environment variable containing the audio output method */
253 #define AOUT_METHOD_VAR "vlc_aout"
255 /* The fallback method */
256 #define AOUT_DEFAULT_METHOD "dsp"
258 /* Environment variable used to store dsp device name, and default value */
259 #define AOUT_DSP_VAR "vlc_dsp"
260 #define AOUT_DSP_DEFAULT "/dev/dsp"
262 /* Environment variable for stereo, and default value */
263 #define AOUT_STEREO_VAR "vlc_stereo"
264 #define AOUT_STEREO_DEFAULT 1
266 /* Environment variable for output rate, and default value */
267 #define AOUT_RATE_VAR "vlc_audio_rate"
268 #define AOUT_RATE_DEFAULT 44100
270 /*****************************************************************************
271 * Video configuration
272 *****************************************************************************/
275 * Default settings for video output threads
278 /* Environment variable containing the display method */
279 #define VOUT_METHOD_VAR "vlc_vout"
281 /* Environment variable containing the YUV method */
282 #define YUV_METHOD_VAR "vlc_yuv"
284 /* The fallback method */
285 #define VOUT_DEFAULT_METHOD "x11"
287 /* Environment variable used in place of DISPLAY if available */
288 #define VOUT_DISPLAY_VAR "vlc_display"
290 /* Default dimensions for display window - these dimensions are enough for the
291 * standard width and height broadcasted MPEG-2 streams or DVDs */
292 #define VOUT_WIDTH_VAR "vlc_width"
293 #define VOUT_HEIGHT_VAR "vlc_height"
294 #define VOUT_WIDTH_DEFAULT 720
295 #define VOUT_HEIGHT_DEFAULT 576
297 /* Maximum width of a scaled source picture - this should be relatively high,
298 * since higher stream values will result in no display at all. */
299 #define VOUT_MAX_WIDTH 4096
301 /* Video heap size - remember that a decompressed picture is big
302 * (~1 Mbyte) before using huge values */
303 #define VOUT_MAX_PICTURES 10
305 /* Number of simultaneous subpictures */
306 #define VOUT_MAX_SUBPICTURES 10
308 /* Maximum number of active areas in a rendering buffer. Active areas are areas
309 * of the picture which need to be cleared before re-using the buffer. If a
310 * picture, including its many additions such as subtitles, additionnal user
311 * informations and interface, has too many active areas, some of them are
313 #define VOUT_MAX_AREAS 5
315 /* Environment variable for grayscale output mode, and default value */
316 #define VOUT_GRAYSCALE_VAR "vlc_grayscale"
317 #define VOUT_GRAYSCALE_DEFAULT 0
320 #define VOUT_GAMMA 0.
323 #define VOUT_DEFAULT_FONT "default8x9.psf"
324 #define VOUT_LARGE_FONT "default8x16.psf"
326 /* Statistics are displayed every n loops (=~ pictures) */
327 #define VOUT_STATS_NB_LOOPS 100
333 /* Time during which the thread will sleep if it has nothing to
334 * display (in micro-seconds) */
335 #define VOUT_IDLE_SLEEP ((int)(0.020*CLOCK_FREQ))
337 /* Maximum lap of time allowed between the beginning of rendering and
338 * display. If, compared to the current date, the next image is too
339 * late, the thread will perform an idle loop. This time should be
340 * at least VOUT_IDLE_SLEEP plus the time required to render a few
341 * images, to avoid trashing of decoded images */
342 #define VOUT_DISPLAY_DELAY ((int)(0.500*CLOCK_FREQ))
344 /* Delay (in microseconds) before an idle screen is displayed */
345 #define VOUT_IDLE_DELAY (5*CLOCK_FREQ)
347 /* Number of pictures required to computes the FPS rate */
348 #define VOUT_FPS_SAMPLES 20
350 /* Better be in advance when awakening than late... */
351 #define VOUT_MWAIT_TOLERANCE ((int)(0.020*CLOCK_FREQ))
354 * Framebuffer settings
357 /* Environment variable for framebuffer device, and default value */
358 #define VOUT_FB_DEV_VAR "vlc_fb_dev"
359 #define VOUT_FB_DEV_DEFAULT "/dev/fb0"
361 /* Some frame buffers aren't able to support double buffering.
362 * We don't want to lose one frame out of 2, so we may set the
368 /*****************************************************************************
369 * Video parser configuration
370 *****************************************************************************/
372 #define VPAR_IDLE_SLEEP ((int)(0.010*CLOCK_FREQ))
374 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
375 * It should be approximately the time needed to perform a complete picture
376 * loop. Since it only happens when the video heap is full, it does not need
377 * to be too low, even if it blocks the decoder. */
378 #define VPAR_OUTMEM_SLEEP ((int)(0.020*CLOCK_FREQ))
380 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
381 * that raising this level dramatically lengthens the compilation time. */
382 #define VPAR_OPTIM_LEVEL 2
384 /* The following directives only apply if you define VDEC_SMP below. */
386 /* Number of macroblock buffers available. It should be always greater than
387 * twice the number of macroblocks in a picture. VFIFO_SIZE + 1 should also
388 * be a power of two. */
389 #define VFIFO_SIZE 8191
391 /* Maximum number of macroblocks in a picture. */
394 /* The synchro variable name */
395 #define VPAR_SYNCHRO_VAR "vlc_synchro"
397 /*****************************************************************************
398 * Video decoder configuration
399 *****************************************************************************/
403 #define VDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
405 /* Number of video_decoder threads to launch on startup of the video_parser.
406 * It should always be less than half the number of macroblocks of a
407 * picture. Only available if you defined VDEC_SMP above. */
410 /* Maximum range of values out of the IDCT + motion compensation. */
411 #define VDEC_CROPRANGE 2048
413 /* Nice increments for decoders -- necessary for x11 scheduling */
416 /*****************************************************************************
417 * Generic decoder configuration
418 *****************************************************************************/
420 #define GDEC_IDLE_SLEEP ((int)(0.100*CLOCK_FREQ))
422 /*****************************************************************************
423 * Messages and console interfaces configuration
424 *****************************************************************************/
426 /* Maximal size of a message to be stored in the mesage queue,
427 * it is needed when vasprintf is not avalaible */
428 #define INTF_MAX_MSG_SIZE 512
430 /* Maximal size of the message queue - in case of overflow, all messages in the
431 * queue are printed by the calling thread */
432 #define INTF_MSG_QSIZE 64
434 /* Interface warnig message level */
435 #define INTF_WARNING_VAR "warning_level"
436 #define INTF_WARNING_DEFAULT 12
438 /* Define to enable messages queues - disabling messages queue can be usefull
439 * when debugging, since it allows messages which would not otherwise be printed,
440 * due to a crash, to be printed anyway */
442 #define INTF_MSG_QUEUE
445 /* Format of the header for debug messages. The arguments following this header
446 * are the file (char *), the function (char *) and the line (int) in which the
447 * message function was called */
448 #define INTF_MSG_DBG_FORMAT "## %s:%s(),%i: "
450 /* Maximal number of arguments on a command line, including the function name */
451 #define INTF_MAX_ARGS 20
453 /* Maximal size of a command line in a script */
454 #define INTF_MAX_CMD_SIZE 240
456 /* Number of memorized lines in console window text zone */
457 #define INTF_CONSOLE_MAX_TEXT 100
459 /* Maximal number of commands which can be saved in history list */
460 #define INTF_CONSOLE_MAX_HISTORY 20