vlc_config.h 10.7 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_config.h: limits and configuration
Michel Kaempf's avatar
Michel Kaempf committed
3
 * Defines all compilation-time configuration constants and size limits
4
 *****************************************************************************
5
 * Copyright (C) 1999-2003 VideoLAN
6
 *
7 8
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@via.ecp.fr>
9 10 11 12 13
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
14
 * 
15 16
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
19
 *
20 21 22
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
24

Vincent Seguin's avatar
Vincent Seguin committed
25 26 27 28 29 30 31
/* Conventions regarding names of symbols and variables
 * ----------------------------------------------------
 *
 * - Symbols should begin with a prefix indicating in which module they are
 *   used, such as INTF_, VOUT_ or ADEC_.
 */

32
/*****************************************************************************
33
 * General configuration
34
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
35

Michel Lespinasse's avatar
 
Michel Lespinasse committed
36 37 38
#define CLOCK_FREQ 1000000


39
/* Automagically spawn audio and video decoder threads */
40
#define AUTO_SPAWN
Christophe Massiot's avatar
Christophe Massiot committed
41

42 43
/* When creating or destroying threads in blocking mode, delay to poll thread
 * status */
44
#define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
45

46 47
/* When a thread waits on a condition in debug mode, delay to wait before
 * outputting an error message (in second) */
48
#define THREAD_COND_TIMEOUT             1
49

Sam Hocevar's avatar
 
Sam Hocevar committed
50
/* The configuration file and directory */
51
#ifdef SYS_BEOS
Olivier Teulière's avatar
 
Olivier Teulière committed
52
#  define CONFIG_DIR                    "config/settings"
53
#elif defined( WIN32 ) || defined( UNDER_CE )
54
#  define CONFIG_DIR                    "vlc"
55
#else
56
#  define CONFIG_DIR                    ".vlc"
57
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
58 59
#define CONFIG_FILE                     "vlcrc"

60
/*****************************************************************************
61
 * Interface configuration
62
 *****************************************************************************/
63 64

/* Base delay in micro second for interface sleeps */
65
#define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
66

Vincent Seguin's avatar
Vincent Seguin committed
67 68
/* Step for changing gamma, and minimum and maximum values */
#define INTF_GAMMA_STEP                 .1
69
#define INTF_GAMMA_LIMIT                3
70

71
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
72
 * Input thread configuration
73
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
74

75
/* Used in ErrorThread */
76
#define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
77

78 79 80
/* Time to wait in case of read error */
#define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))

81 82 83 84
/* Number of read() calls needed until we check the file size through
 * fstat() */
#define INPUT_FSTAT_NB_READS            10

Michel Kaempf's avatar
Michel Kaempf committed
85 86 87 88 89 90 91 92
/*
 * General limitations
 */

/* Maximum number of input threads - this value is used exclusively by
 * interface, and is in fact an interface limitation */
#define INPUT_MAX_THREADS               10

93
/* Maximum size of a data packet (128 kB) */
Sam Hocevar's avatar
 
Sam Hocevar committed
94
#define INPUT_MAX_PACKET_SIZE           131072
95

96
/* Maximum length of a pre-parsed chunk (4 MB) */
Sam Hocevar's avatar
 
Sam Hocevar committed
97
#define INPUT_PREPARSE_LENGTH           4194304
98

99
/* Maximum length of a hostname or source name */
100
#define INPUT_MAX_SOURCE_LENGTH         100
Michel Kaempf's avatar
Michel Kaempf committed
101

102
/* Maximum memory the input is allowed to use (20 MB) */
Christophe Massiot's avatar
Christophe Massiot committed
103
#define INPUT_MAX_ALLOCATION            20971520
104

Michel Kaempf's avatar
Michel Kaempf committed
105
/*
Henri Fallon's avatar
 
Henri Fallon committed
106
 * Channel method
107
 */
Michel Kaempf's avatar
Michel Kaempf committed
108

Henri Fallon's avatar
 
Henri Fallon committed
109 110
/* Delay between channel changes - this is required to avoid flooding the 
 * channel server */
111
#define INPUT_CHANNEL_CHANGE_DELAY      (mtime_t)(5*CLOCK_FREQ)
112

113
/* Duration between the time we receive the data packet, and the time we will
114
 * mark it to be presented */
115
#define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
116

Gildas Bazin's avatar
 
Gildas Bazin committed
117
/* DVD and VCD devices */
118
#if !defined( WIN32 ) && !defined( UNDER_CE )
119 120
#   define DVD_DEVICE "/dev/dvd"
#   define VCD_DEVICE "/dev/cdrom"
Gildas Bazin's avatar
 
Gildas Bazin committed
121
#else
Gildas Bazin's avatar
 
Gildas Bazin committed
122 123
#   define DVD_DEVICE "D:"
#   define VCD_DEVICE "D:"
Gildas Bazin's avatar
 
Gildas Bazin committed
124 125
#endif

126
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
127
 * Audio configuration
128
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
129

Sam Hocevar's avatar
 
Sam Hocevar committed
130 131 132
/* Maximum number of audio output threads */
#define AOUT_MAX_THREADS                10

133
/* Volume */
134 135 136 137
#define AOUT_VOLUME_DEFAULT             256
#define AOUT_VOLUME_STEP                32
#define AOUT_VOLUME_MAX                 1024
#define AOUT_VOLUME_MIN                 0
138

Christophe Massiot's avatar
Christophe Massiot committed
139
/* Max number of pre-filters per input, and max number of post-filters */
140 141 142 143
#define AOUT_MAX_FILTERS                10

/* Max number of inputs */
#define AOUT_MAX_INPUTS                 5
144

Christophe Massiot's avatar
Christophe Massiot committed
145 146 147 148
/* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 * will cause the calling thread to sleep */
#define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)

149 150 151 152
/* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 * to avoid too heavy resampling */
#define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)

153 154
/* Max acceptable delay between the coded PTS and the actual presentation
 * time, without resampling */
155
#define AOUT_PTS_TOLERANCE              (mtime_t)(.02*CLOCK_FREQ)
156

157 158 159
/* Max acceptable resampling (in %) */
#define AOUT_MAX_RESAMPLING             10

160
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
161
 * Video configuration
162
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
163

Sam Hocevar's avatar
 
Sam Hocevar committed
164
/* Maximum number of video output threads */
Sam Hocevar's avatar
 
Sam Hocevar committed
165
#define VOUT_MAX_THREADS                256
Sam Hocevar's avatar
 
Sam Hocevar committed
166

Michel Kaempf's avatar
Michel Kaempf committed
167 168 169 170
/*
 * Default settings for video output threads
 */

Sam Hocevar's avatar
 
Sam Hocevar committed
171 172
/* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
#define VOUT_ASPECT_FACTOR              432000
Sam Hocevar's avatar
 
Sam Hocevar committed
173

174
/* Maximum width of a scaled source picture - this should be relatively high,
175 176 177
 * since higher stream values will result in no display at all. */
#define VOUT_MAX_WIDTH                  4096

Sam Hocevar's avatar
 
Sam Hocevar committed
178 179 180
/* Number of planes in a picture */
#define VOUT_MAX_PLANES                 5

181
/* Video heap size - remember that a decompressed picture is big
Vincent Seguin's avatar
Vincent Seguin committed
182
 * (~1 Mbyte) before using huge values */
183
#define VOUT_MAX_PICTURES               8
Michel Kaempf's avatar
Michel Kaempf committed
184

Gildas Bazin's avatar
 
Gildas Bazin committed
185 186 187 188
/* Minimum number of direct pictures the video output will accept without
 * creating additional pictures in system memory */
#define VOUT_MIN_DIRECT_PICTURES        6

189
/* Number of simultaneous subpictures */
190
#define VOUT_MAX_SUBPICTURES            8
191

192
/* Maximum number of active areas in a rendering buffer. Active areas are areas
193
 * of the picture which need to be cleared before re-using the buffer. If a
194
 * picture, including its many additions such as subtitles, additionnal user
195
 * informations and interface, has too many active areas, some of them are
196 197 198
 * joined. */
#define VOUT_MAX_AREAS                  5

Vincent Seguin's avatar
Vincent Seguin committed
199
/* Default fonts */
200 201
#define VOUT_DEFAULT_FONT               "default8x9.psf"
#define VOUT_LARGE_FONT                 "default8x16.psf"
Vincent Seguin's avatar
Vincent Seguin committed
202

Christophe Massiot's avatar
Christophe Massiot committed
203 204 205
/* Statistics are displayed every n loops (=~ pictures) */
#define VOUT_STATS_NB_LOOPS             100

Michel Kaempf's avatar
Michel Kaempf committed
206
/*
Vincent Seguin's avatar
Vincent Seguin committed
207
 * Time settings
Michel Kaempf's avatar
Michel Kaempf committed
208 209
 */

210
/* Time during which the thread will sleep if it has nothing to
Michel Kaempf's avatar
Michel Kaempf committed
211
 * display (in micro-seconds) */
Michel Lespinasse's avatar
 
Michel Lespinasse committed
212
#define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
213 214 215 216 217 218

/* Maximum lap of time allowed between the beginning of rendering and
 * display. If, compared to the current date, the next image is too
 * late, the thread will perform an idle loop. This time should be
 * at least VOUT_IDLE_SLEEP plus the time required to render a few
 * images, to avoid trashing of decoded images */
219 220 221 222 223
#define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))

/* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
 * a bogus PTS and won't be displayed */
#define VOUT_BOGUS_DELAY                ((int)(0.800*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
224

225
/* Delay (in microseconds) before an idle screen is displayed */
Michel Lespinasse's avatar
 
Michel Lespinasse committed
226
#define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
227 228

/* Number of pictures required to computes the FPS rate */
229
#define VOUT_FPS_SAMPLES                20
230

231
/* Better be in advance when awakening than late... */
232
#define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
233

Sam Hocevar's avatar
 
Sam Hocevar committed
234 235 236 237
/* Time to sleep when waiting for a buffer (from vout or the video fifo).
 * It should be approximately the time needed to perform a complete picture
 * loop. Since it only happens when the video heap is full, it does not need
 * to be too low, even if it blocks the decoder. */
238
#define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
Sam Hocevar's avatar
 
Sam Hocevar committed
239

Sam Hocevar's avatar
 
Sam Hocevar committed
240
/* The default video output window title */
Sam Hocevar's avatar
 
Sam Hocevar committed
241
#define VOUT_TITLE                      "VideoLAN Client " VERSION
242

243
/*****************************************************************************
244
 * Video parser configuration
245
 *****************************************************************************/
246

247
#define VPAR_IDLE_SLEEP                 ((mtime_t)(0.010*CLOCK_FREQ))
248

249 250
/* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
 * that raising this level dramatically lengthens the compilation time. */
251
#if defined( HAVE_RELEASE )
252 253 254 255
#   define VPAR_OPTIM_LEVEL             2
#else
#   define VPAR_OPTIM_LEVEL             1
#endif
256

257
/* Maximum number of macroblocks in a picture. */
Christophe Massiot's avatar
Christophe Massiot committed
258
#define MAX_MB                          2048
259

260
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
261
 * Video decoder configuration
262
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
263

264
#define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
265

266
/* Maximum range of values out of the IDCT + motion compensation. */
267 268
#define VDEC_CROPRANGE                  2048

269
/* No SMP by default, since it slows down things on non-smp machines. */
270 271 272 273
#define VDEC_SMP_DEFAULT                0

/* Nice increments for decoders -- necessary for x11 scheduling */
#define VDEC_NICE                       3
Michel Kaempf's avatar
Michel Kaempf committed
274

275
/*****************************************************************************
276
 * Messages and console interfaces configuration
277
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
278

279
/* Maximal size of a message to be stored in the mesage queue,
280
 * it is needed when vasprintf is not available */
Sam Hocevar's avatar
 
Sam Hocevar committed
281
#define INTF_MAX_MSG_SIZE               512
282

Vincent Seguin's avatar
Vincent Seguin committed
283
/* Maximal size of the message queue - in case of overflow, all messages in the
Sam Hocevar's avatar
 
Sam Hocevar committed
284
 * queue are printed, but not sent to the threads */
285
#define VLC_MSG_QSIZE                   256
286 287 288

/* Maximal depth of the object tree output by vlc_dumpstructure */
#define MAX_DUMPSTRUCTURE_DEPTH         100