Less aggressive debug message.
[vlc.git] / include / vlc_config.h
1 /*****************************************************************************
2  * vlc_config.h: limits and configuration
3  * Defines all compilation-time configuration constants and size limits
4  *****************************************************************************
5  * Copyright (C) 1999-2003 VideoLAN
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel Hocevar <sam@via.ecp.fr>
9  *
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.
14  * 
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.
19  *
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  *****************************************************************************/
24
25 /* Conventions regarding names of symbols and variables
26  * ----------------------------------------------------
27  *
28  * - Symbols should begin with a prefix indicating in which module they are
29  *   used, such as INTF_, VOUT_ or ADEC_.
30  */
31
32 /*****************************************************************************
33  * General configuration
34  *****************************************************************************/
35
36 #define CLOCK_FREQ 1000000
37
38
39 /* Automagically spawn audio and video decoder threads */
40 #define AUTO_SPAWN
41
42 /* When creating or destroying threads in blocking mode, delay to poll thread
43  * status */
44 #define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
45
46 /* When a thread waits on a condition in debug mode, delay to wait before
47  * outputting an error message (in second) */
48 #define THREAD_COND_TIMEOUT             1
49
50 /* The configuration file and directory */
51 #ifdef SYS_BEOS
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
58 #define CONFIG_FILE                     "vlcrc"
59
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))
66
67 /* Step for changing gamma, and minimum and maximum values */
68 #define INTF_GAMMA_STEP                 .1
69 #define INTF_GAMMA_LIMIT                3
70
71 /*****************************************************************************
72  * Input thread configuration
73  *****************************************************************************/
74
75 /* Used in ErrorThread */
76 #define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
77
78 /* Time to wait in case of read error */
79 #define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))
80
81 /* Number of read() calls needed until we check the file size through
82  * fstat() */
83 #define INPUT_FSTAT_NB_READS            10
84
85 /*
86  * General limitations
87  */
88
89 /* Maximum number of input threads - this value is used exclusively by
90  * interface, and is in fact an interface limitation */
91 #define INPUT_MAX_THREADS               10
92
93 /* Maximum size of a data packet (128 kB) */
94 #define INPUT_MAX_PACKET_SIZE           131072
95
96 /* Maximum length of a pre-parsed chunk (4 MB) */
97 #define INPUT_PREPARSE_LENGTH           4194304
98
99 /* Maximum length of a hostname or source name */
100 #define INPUT_MAX_SOURCE_LENGTH         100
101
102 /* Maximum memory the input is allowed to use (20 MB) */
103 #define INPUT_MAX_ALLOCATION            20971520
104
105 /*
106  * Channel method
107  */
108
109 /* Delay between channel changes - this is required to avoid flooding the 
110  * 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
117 /* DVD and VCD devices */
118 #if !defined( WIN32 ) && !defined( UNDER_CE )
119 #   define DVD_DEVICE "/dev/dvd"
120 #   define VCD_DEVICE "/dev/cdrom"
121 #else
122 #   define DVD_DEVICE "D:"
123 #   define VCD_DEVICE "D:"
124 #endif
125
126 /*****************************************************************************
127  * Audio configuration
128  *****************************************************************************/
129
130 /* Maximum number of audio output threads */
131 #define AOUT_MAX_THREADS                10
132
133 /* Volume */
134 #define AOUT_VOLUME_DEFAULT             256
135 #define AOUT_VOLUME_STEP                32
136 #define AOUT_VOLUME_MAX                 1024
137 #define AOUT_VOLUME_MIN                 0
138
139 /* Max number of pre-filters per input, and max number of post-filters */
140 #define AOUT_MAX_FILTERS                10
141
142 /* Max number of inputs */
143 #define AOUT_MAX_INPUTS                 5
144
145 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
146  * will cause the calling thread to sleep */
147 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
148
149 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
150  * to avoid too heavy resampling */
151 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
152
153 /* Max acceptable delay between the coded PTS and the actual presentation
154  * time, without resampling */
155 #define AOUT_PTS_TOLERANCE              (mtime_t)(.02*CLOCK_FREQ)
156
157 /* Max acceptable resampling (in %) */
158 #define AOUT_MAX_RESAMPLING             10
159
160 /*****************************************************************************
161  * Video configuration
162  *****************************************************************************/
163
164 /* Maximum number of video output threads */
165 #define VOUT_MAX_THREADS                256
166
167 /*
168  * Default settings for video output threads
169  */
170
171 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
172 #define VOUT_ASPECT_FACTOR              432000
173
174 /* Maximum width of a scaled source picture - this should be relatively high,
175  * since higher stream values will result in no display at all. */
176 #define VOUT_MAX_WIDTH                  4096
177
178 /* Number of planes in a picture */
179 #define VOUT_MAX_PLANES                 5
180
181 /* Video heap size - remember that a decompressed picture is big
182  * (~1 Mbyte) before using huge values */
183 #define VOUT_MAX_PICTURES               8
184
185 /* Minimum number of direct pictures the video output will accept without
186  * creating additional pictures in system memory */
187 #define VOUT_MIN_DIRECT_PICTURES        6
188
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  * joined. */
197 #define VOUT_MAX_AREAS                  5
198
199 /* Default fonts */
200 #define VOUT_DEFAULT_FONT               "default8x9.psf"
201 #define VOUT_LARGE_FONT                 "default8x16.psf"
202
203 /* Statistics are displayed every n loops (=~ pictures) */
204 #define VOUT_STATS_NB_LOOPS             100
205
206 /*
207  * Time settings
208  */
209
210 /* Time during which the thread will sleep if it has nothing to
211  * display (in micro-seconds) */
212 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
213
214 /* Maximum lap of time allowed between the beginning of rendering and
215  * display. If, compared to the current date, the next image is too
216  * late, the thread will perform an idle loop. This time should be
217  * at least VOUT_IDLE_SLEEP plus the time required to render a few
218  * images, to avoid trashing of decoded images */
219 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
220
221 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
222  * a bogus PTS and won't be displayed */
223 #define VOUT_BOGUS_DELAY                ((int)(0.800*CLOCK_FREQ))
224
225 /* Delay (in microseconds) before an idle screen is displayed */
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
234 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
235  * It should be approximately the time needed to perform a complete picture
236  * loop. Since it only happens when the video heap is full, it does not need
237  * to be too low, even if it blocks the decoder. */
238 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
239
240 /* The default video output window title */
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 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
250  * that raising this level dramatically lengthens the compilation time. */
251 #if defined( HAVE_RELEASE )
252 #   define VPAR_OPTIM_LEVEL             2
253 #else
254 #   define VPAR_OPTIM_LEVEL             1
255 #endif
256
257 /* Maximum number of macroblocks in a picture. */
258 #define MAX_MB                          2048
259
260 /*****************************************************************************
261  * Video decoder configuration
262  *****************************************************************************/
263
264 #define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
265
266 /* Maximum range of values out of the IDCT + motion compensation. */
267 #define VDEC_CROPRANGE                  2048
268
269 /* No SMP by default, since it slows down things on non-smp machines. */
270 #define VDEC_SMP_DEFAULT                0
271
272 /* Nice increments for decoders -- necessary for x11 scheduling */
273 #define VDEC_NICE                       3
274
275 /*****************************************************************************
276  * Messages and console interfaces configuration
277  *****************************************************************************/
278
279 /* Maximal size of a message to be stored in the mesage queue,
280  * it is needed when vasprintf is not available */
281 #define INTF_MAX_MSG_SIZE               512
282
283 /* Maximal size of the message queue - in case of overflow, all messages in the
284  * queue are printed, but not sent to the threads */
285 #define VLC_MSG_QSIZE                   256
286
287 /* Maximal depth of the object tree output by vlc_dumpstructure */
288 #define MAX_DUMPSTRUCTURE_DEPTH         100