vlc_config.h 10.6 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-2002 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) */
Sam Hocevar's avatar
 
Sam Hocevar committed
48
#define THREAD_COND_TIMEOUT             5
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))

Michel Kaempf's avatar
Michel Kaempf committed
81 82 83 84 85 86 87 88
/*
 * 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

89
/* Maximum size of a data packet (128 kB) */
Sam Hocevar's avatar
 
Sam Hocevar committed
90
#define INPUT_MAX_PACKET_SIZE           131072
91

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

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

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

Michel Kaempf's avatar
Michel Kaempf committed
101
/*
Henri Fallon's avatar
 
Henri Fallon committed
102
 * Channel method
103
 */
Michel Kaempf's avatar
Michel Kaempf committed
104

Henri Fallon's avatar
 
Henri Fallon committed
105 106 107
/* Delay between channel changes - this is required to avoid flooding the 
 * channel server */
#define INPUT_CHANNEL_CHANGE_DELAY         (mtime_t)(5*CLOCK_FREQ)
108

109
/* Duration between the time we receive the data packet, and the time we will
110
 * mark it to be presented */
111
#define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
112

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

122
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
123
 * Audio configuration
124
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
125

Sam Hocevar's avatar
 
Sam Hocevar committed
126 127 128
/* Maximum number of audio output threads */
#define AOUT_MAX_THREADS                10

129
/* Volume */
130 131 132 133
#define AOUT_VOLUME_DEFAULT             256
#define AOUT_VOLUME_STEP                32
#define AOUT_VOLUME_MAX                 1024
#define AOUT_VOLUME_MIN                 0
134

Christophe Massiot's avatar
Christophe Massiot committed
135
/* Max number of pre-filters per input, and max number of post-filters */
136 137 138 139
#define AOUT_MAX_FILTERS                10

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

Christophe Massiot's avatar
Christophe Massiot committed
141 142 143 144
/* 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)

145 146 147 148
/* 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)

149 150
/* Max acceptable delay between the coded PTS and the actual presentation
 * time, without resampling */
151
#define AOUT_PTS_TOLERANCE              (mtime_t)(.02*CLOCK_FREQ)
152

153 154 155
/* Max acceptable resampling (in %) */
#define AOUT_MAX_RESAMPLING             10

156
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
157
 * Video configuration
158
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
159

Sam Hocevar's avatar
 
Sam Hocevar committed
160
/* Maximum number of video output threads */
Sam Hocevar's avatar
 
Sam Hocevar committed
161
#define VOUT_MAX_THREADS                256
Sam Hocevar's avatar
 
Sam Hocevar committed
162

Michel Kaempf's avatar
Michel Kaempf committed
163 164 165 166
/*
 * Default settings for video output threads
 */

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

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

Sam Hocevar's avatar
 
Sam Hocevar committed
174 175 176
/* Number of planes in a picture */
#define VOUT_MAX_PLANES                 5

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

Gildas Bazin's avatar
 
Gildas Bazin committed
181 182 183 184
/* Minimum number of direct pictures the video output will accept without
 * creating additional pictures in system memory */
#define VOUT_MIN_DIRECT_PICTURES        6

185
/* Number of simultaneous subpictures */
186
#define VOUT_MAX_SUBPICTURES            8
187

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

Vincent Seguin's avatar
Vincent Seguin committed
195
/* Default fonts */
196 197
#define VOUT_DEFAULT_FONT               "default8x9.psf"
#define VOUT_LARGE_FONT                 "default8x16.psf"
Vincent Seguin's avatar
Vincent Seguin committed
198

Christophe Massiot's avatar
Christophe Massiot committed
199 200 201
/* Statistics are displayed every n loops (=~ pictures) */
#define VOUT_STATS_NB_LOOPS             100

Michel Kaempf's avatar
Michel Kaempf committed
202
/*
Vincent Seguin's avatar
Vincent Seguin committed
203
 * Time settings
Michel Kaempf's avatar
Michel Kaempf committed
204 205
 */

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

/* 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 */
215 216 217 218 219
#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
220

221
/* Delay (in microseconds) before an idle screen is displayed */
Michel Lespinasse's avatar
 
Michel Lespinasse committed
222
#define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
223 224

/* Number of pictures required to computes the FPS rate */
225
#define VOUT_FPS_SAMPLES                20
226

227
/* Better be in advance when awakening than late... */
228
#define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
229

Sam Hocevar's avatar
 
Sam Hocevar committed
230 231 232 233
/* 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. */
234
#define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
Sam Hocevar's avatar
 
Sam Hocevar committed
235

Sam Hocevar's avatar
 
Sam Hocevar committed
236
/* The default video output window title */
Sam Hocevar's avatar
 
Sam Hocevar committed
237
#define VOUT_TITLE                      "VideoLAN Client " VERSION
238

239
/*****************************************************************************
240
 * Video parser configuration
241
 *****************************************************************************/
242

243
#define VPAR_IDLE_SLEEP                 ((mtime_t)(0.010*CLOCK_FREQ))
244

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

253
/* Maximum number of macroblocks in a picture. */
Christophe Massiot's avatar
Christophe Massiot committed
254
#define MAX_MB                          2048
255

256
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
257
 * Video decoder configuration
258
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
259

260
#define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
261

262
/* Maximum range of values out of the IDCT + motion compensation. */
263 264
#define VDEC_CROPRANGE                  2048

265
/* No SMP by default, since it slows down things on non-smp machines. */
266 267 268 269
#define VDEC_SMP_DEFAULT                0

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

271
/*****************************************************************************
272
 * Messages and console interfaces configuration
273
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
274

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

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

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