]> git.sesse.net Git - vlc/blob - include/vlc_config.h
* src/misc/darwin_specific.m: Partial attempt at fixing a memory leak,
[vlc] / 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-2002 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             5
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 /*
82  * General limitations
83  */
84
85 /* Maximum number of input threads - this value is used exclusively by
86  * interface, and is in fact an interface limitation */
87 #define INPUT_MAX_THREADS               10
88
89 /* Maximum size of a data packet (128 kB) */
90 #define INPUT_MAX_PACKET_SIZE           131072
91
92 /* Maximum length of a pre-parsed chunk (4 MB) */
93 #define INPUT_PREPARSE_LENGTH           4194304
94
95 /* Maximum length of a hostname or source name */
96 #define INPUT_MAX_SOURCE_LENGTH         100
97
98 /* Maximum memory the input is allowed to use (20 MB) */
99 #define INPUT_MAX_ALLOCATION            20971520
100
101 /*
102  * Channel method
103  */
104
105 /* Delay between channel changes - this is required to avoid flooding the 
106  * channel server */
107 #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
113 /* DVD and VCD devices */
114 #if !defined( WIN32 ) && !defined( UNDER_CE )
115 #   define DVD_DEVICE "/dev/dvd"
116 #   define VCD_DEVICE "/dev/cdrom"
117 #else
118 #   define DVD_DEVICE "D:"
119 #   define VCD_DEVICE "D:"
120 #endif
121
122 /*****************************************************************************
123  * Audio configuration
124  *****************************************************************************/
125
126 /* Maximum number of audio output threads */
127 #define AOUT_MAX_THREADS                10
128
129 /* Volume */
130 #define AOUT_VOLUME_DEFAULT             256
131 #define AOUT_VOLUME_STEP                32
132 #define AOUT_VOLUME_MAX                 1024
133 #define AOUT_VOLUME_MIN                 0
134
135 /* Max number of pre-filters per input, and max number of post-filters */
136 #define AOUT_MAX_FILTERS                10
137
138 /* Max number of inputs */
139 #define AOUT_MAX_INPUTS                 5
140
141 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
142  * will cause the calling thread to sleep */
143 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
144
145 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
146  * to avoid too heavy resampling */
147 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
148
149 /* Max acceptable delay between the coded PTS and the actual presentation
150  * time, without resampling */
151 #define AOUT_PTS_TOLERANCE              (mtime_t)(.02*CLOCK_FREQ)
152
153 /* Max acceptable resampling (in %) */
154 #define AOUT_MAX_RESAMPLING             10
155
156 /*****************************************************************************
157  * Video configuration
158  *****************************************************************************/
159
160 /* Maximum number of video output threads */
161 #define VOUT_MAX_THREADS                256
162
163 /*
164  * Default settings for video output threads
165  */
166
167 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
168 #define VOUT_ASPECT_FACTOR              432000
169
170 /* Maximum width of a scaled source picture - this should be relatively high,
171  * since higher stream values will result in no display at all. */
172 #define VOUT_MAX_WIDTH                  4096
173
174 /* Number of planes in a picture */
175 #define VOUT_MAX_PLANES                 5
176
177 /* Video heap size - remember that a decompressed picture is big
178  * (~1 Mbyte) before using huge values */
179 #define VOUT_MAX_PICTURES               8
180
181 /* Minimum number of direct pictures the video output will accept without
182  * creating additional pictures in system memory */
183 #define VOUT_MIN_DIRECT_PICTURES        6
184
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  * joined. */
193 #define VOUT_MAX_AREAS                  5
194
195 /* Default fonts */
196 #define VOUT_DEFAULT_FONT               "default8x9.psf"
197 #define VOUT_LARGE_FONT                 "default8x16.psf"
198
199 /* Statistics are displayed every n loops (=~ pictures) */
200 #define VOUT_STATS_NB_LOOPS             100
201
202 /*
203  * Time settings
204  */
205
206 /* Time during which the thread will sleep if it has nothing to
207  * display (in micro-seconds) */
208 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
209
210 /* Maximum lap of time allowed between the beginning of rendering and
211  * display. If, compared to the current date, the next image is too
212  * late, the thread will perform an idle loop. This time should be
213  * at least VOUT_IDLE_SLEEP plus the time required to render a few
214  * images, to avoid trashing of decoded images */
215 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
216
217 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
218  * a bogus PTS and won't be displayed */
219 #define VOUT_BOGUS_DELAY                ((int)(0.800*CLOCK_FREQ))
220
221 /* Delay (in microseconds) before an idle screen is displayed */
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
230 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
231  * It should be approximately the time needed to perform a complete picture
232  * loop. Since it only happens when the video heap is full, it does not need
233  * to be too low, even if it blocks the decoder. */
234 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
235
236 /* The default video output window title */
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 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
246  * that raising this level dramatically lengthens the compilation time. */
247 #if defined( HAVE_RELEASE )
248 #   define VPAR_OPTIM_LEVEL             2
249 #else
250 #   define VPAR_OPTIM_LEVEL             1
251 #endif
252
253 /* Maximum number of macroblocks in a picture. */
254 #define MAX_MB                          2048
255
256 /*****************************************************************************
257  * Video decoder configuration
258  *****************************************************************************/
259
260 #define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
261
262 /* Maximum range of values out of the IDCT + motion compensation. */
263 #define VDEC_CROPRANGE                  2048
264
265 /* No SMP by default, since it slows down things on non-smp machines. */
266 #define VDEC_SMP_DEFAULT                0
267
268 /* Nice increments for decoders -- necessary for x11 scheduling */
269 #define VDEC_NICE                       3
270
271 /*****************************************************************************
272  * Messages and console interfaces configuration
273  *****************************************************************************/
274
275 /* Maximal size of a message to be stored in the mesage queue,
276  * it is needed when vasprintf is not available */
277 #define INTF_MAX_MSG_SIZE               512
278
279 /* Maximal size of the message queue - in case of overflow, all messages in the
280  * queue are printed, but not sent to the threads */
281 #define VLC_MSG_QSIZE                   256
282
283 /* Maximal depth of the object tree output by vlc_dumpstructure */
284 #define MAX_DUMPSTRUCTURE_DEPTH         100