* Desperate attempt to improve audio output ;
[vlc.git] / include / config.h
1 /*****************************************************************************
2  * config.h: limits and configuration
3  * Defines all compilation-time configuration constants and size limits
4  *****************************************************************************
5  * Copyright (C) 1999, 2000, 2001 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 )
54 #  define CONFIG_DIR                    "videolan"
55 #else
56 #  define CONFIG_DIR                    ".videolan"
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 /* XXX?? */
76 #define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
77
78 /*
79  * General limitations
80  */
81
82 /* Maximum number of input threads - this value is used exclusively by
83  * interface, and is in fact an interface limitation */
84 #define INPUT_MAX_THREADS               10
85
86 /* Maximum size of a data packet (128 kB) */
87 #define INPUT_MAX_PACKET_SIZE           131072
88
89 /* Maximum length of a pre-parsed chunk (4 MB) */
90 #define INPUT_PREPARSE_LENGTH           4194304
91
92 /* Maximum length of a hostname or source name */
93 #define INPUT_MAX_SOURCE_LENGTH         100
94
95 /* Maximum memory the input is allowed to use (20 MB) */
96 #define INPUT_MAX_ALLOCATION            20971520
97
98 /*
99  * Channel method
100  */
101
102 /* Delay between channel changes - this is required to avoid flooding the 
103  * channel server */
104 #define INPUT_CHANNEL_CHANGE_DELAY         (mtime_t)(5*CLOCK_FREQ)
105
106 /* Duration between the time we receive the data packet, and the time we will
107  * mark it to be presented */
108 #define DEFAULT_PTS_DELAY               (mtime_t)(.45*CLOCK_FREQ)
109
110 /*****************************************************************************
111  * Audio configuration
112  *****************************************************************************/
113
114 /* Maximum number of audio output threads */
115 #define AOUT_MAX_THREADS                10
116
117 /* Volume */
118 #define VOLUME_DEFAULT                  256
119 #define VOLUME_STEP                     128
120 #define VOLUME_MAX                      1024
121
122 /* Number of audio output frames contained in an audio output fifo.
123  * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
124  * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
125  * With 255 we have at least 255*384/2/48000=1 second of sound */
126 #define AOUT_FIFO_SIZE                  255
127
128 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
129  * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
130  * operations with '>>' and '<<' (gcc changes this at compilation-time) */
131 #define AOUT_MAX_FIFOS                  2
132
133 /* Duration (in microseconds) of an audio output buffer should be :
134  * - short, in order to be able to play a new song very quickly (especially a
135  *   song from the interface)
136  * - long, in order to perform the buffer calculations as few as possible */
137 #define AOUT_BUFFER_DURATION            90000
138
139 /*****************************************************************************
140  * Video configuration
141  *****************************************************************************/
142
143 /* Maximum number of video output threads */
144 #define VOUT_MAX_THREADS                256
145
146 /*
147  * Default settings for video output threads
148  */
149
150 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
151 #define VOUT_ASPECT_FACTOR              432000
152
153 /* Maximum width of a scaled source picture - this should be relatively high,
154  * since higher stream values will result in no display at all. */
155 #define VOUT_MAX_WIDTH                  4096
156
157 /* Number of planes in a picture */
158 #define VOUT_MAX_PLANES                 5
159
160 /* Video heap size - remember that a decompressed picture is big
161  * (~1 Mbyte) before using huge values */
162 #define VOUT_MAX_PICTURES               8
163
164 /* Number of simultaneous subpictures */
165 #define VOUT_MAX_SUBPICTURES            8
166
167 /* Maximum number of active areas in a rendering buffer. Active areas are areas
168  * of the picture which need to be cleared before re-using the buffer. If a
169  * picture, including its many additions such as subtitles, additionnal user
170  * informations and interface, has too many active areas, some of them are
171  * joined. */
172 #define VOUT_MAX_AREAS                  5
173
174 /* Default fonts */
175 #define VOUT_DEFAULT_FONT               "default8x9.psf"
176 #define VOUT_LARGE_FONT                 "default8x16.psf"
177
178 /* Statistics are displayed every n loops (=~ pictures) */
179 #define VOUT_STATS_NB_LOOPS             100
180
181 /*
182  * Time settings
183  */
184
185 /* Time during which the thread will sleep if it has nothing to
186  * display (in micro-seconds) */
187 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
188
189 /* Maximum lap of time allowed between the beginning of rendering and
190  * display. If, compared to the current date, the next image is too
191  * late, the thread will perform an idle loop. This time should be
192  * at least VOUT_IDLE_SLEEP plus the time required to render a few
193  * images, to avoid trashing of decoded images */
194 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
195
196 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
197  * a bogus PTS and won't be displayed */
198 #define VOUT_BOGUS_DELAY                ((int)(0.800*CLOCK_FREQ))
199
200 /* Delay (in microseconds) before an idle screen is displayed */
201 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
202
203 /* Number of pictures required to computes the FPS rate */
204 #define VOUT_FPS_SAMPLES                20
205
206 /* Better be in advance when awakening than late... */
207 #define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
208
209 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
210  * It should be approximately the time needed to perform a complete picture
211  * loop. Since it only happens when the video heap is full, it does not need
212  * to be too low, even if it blocks the decoder. */
213 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
214
215 /* The default video output window title */
216 #define VOUT_TITLE                      "VideoLAN Client " VERSION
217
218 /*****************************************************************************
219  * Video parser configuration
220  *****************************************************************************/
221
222 #define VPAR_IDLE_SLEEP                 ((mtime_t)(0.010*CLOCK_FREQ))
223
224 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
225  * that raising this level dramatically lengthens the compilation time. */
226 #if defined( HAVE_RELEASE ) || defined( __pentiumpro__ )
227 #   define VPAR_OPTIM_LEVEL             2
228 #else
229 #   define VPAR_OPTIM_LEVEL             1
230 #endif
231
232 /* Maximum number of macroblocks in a picture. */
233 #define MAX_MB                          2048
234
235 /*****************************************************************************
236  * Video decoder configuration
237  *****************************************************************************/
238
239 #define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
240
241 /* Maximum range of values out of the IDCT + motion compensation. */
242 #define VDEC_CROPRANGE                  2048
243
244 /* No SMP by default, since it slows down things on non-smp machines. */
245 #define VDEC_SMP_DEFAULT                0
246
247 /* Nice increments for decoders -- necessary for x11 scheduling */
248 #define VDEC_NICE                       3
249
250 /*****************************************************************************
251  * Messages and console interfaces configuration
252  *****************************************************************************/
253
254 /* Maximal size of a message to be stored in the mesage queue,
255  * it is needed when vasprintf is not avalaible */
256 #define INTF_MAX_MSG_SIZE               512
257
258 /* Maximal size of the message queue - in case of overflow, all messages in the
259  * queue are printed, but not sent to the threads */
260 #define INTF_MSG_QSIZE                  256