vlc_config.h 7.97 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 the VideoLAN team
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
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
24

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

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 40
/* When creating or destroying threads in blocking mode, delay to poll thread
 * status */
41
#define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
42

43
/*****************************************************************************
44
 * Interface configuration
45
 *****************************************************************************/
46 47

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

Vincent Seguin's avatar
Vincent Seguin committed
50 51
/* Step for changing gamma, and minimum and maximum values */
#define INTF_GAMMA_STEP                 .1
52
#define INTF_GAMMA_LIMIT                3
53

54
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
55
 * Input thread configuration
56
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
57

58 59 60
#define DEFAULT_INPUT_ACTIVITY 1
#define TRANSCODE_ACTIVITY 10

61
/* Used in ErrorThread */
62
#define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
63

64 65 66
/* Time to wait in case of read error */
#define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))

67 68 69 70
/* 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
71 72 73 74
/*
 * General limitations
 */

75
/* Duration between the time we receive the data packet, and the time we will
76
 * mark it to be presented */
77
#define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
78

Gildas Bazin's avatar
 
Gildas Bazin committed
79
/* DVD and VCD devices */
80
#if !defined( WIN32 ) && !defined( UNDER_CE )
Rémi Denis-Courmont's avatar
Typo  
Rémi Denis-Courmont committed
81
#   define CD_DEVICE      "/dev/cdrom"
82
#   define DVD_DEVICE     "/dev/dvd"
Gildas Bazin's avatar
 
Gildas Bazin committed
83
#else
84
#   define CD_DEVICE      "D:"
85
#   define DVD_DEVICE     NULL
Gildas Bazin's avatar
 
Gildas Bazin committed
86
#endif
87 88
#define VCD_DEVICE        CD_DEVICE
#define CDAUDIO_DEVICE    CD_DEVICE
Gildas Bazin's avatar
 
Gildas Bazin committed
89

90
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
91
 * Audio configuration
92
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
93

94
/* Volume */
95
/* If you are coding an interface, please see src/audio_output/intf.c */
96 97 98 99
#define AOUT_VOLUME_DEFAULT             256
#define AOUT_VOLUME_STEP                32
#define AOUT_VOLUME_MAX                 1024
#define AOUT_VOLUME_MIN                 0
100

Christophe Massiot's avatar
Christophe Massiot committed
101
/* Max number of pre-filters per input, and max number of post-filters */
102 103 104 105
#define AOUT_MAX_FILTERS                10

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

107 108
/* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
 * will be considered as bogus and be trashed */
109
#define AOUT_MAX_ADVANCE_TIME           (mtime_t)(DEFAULT_PTS_DELAY * 5)
110

Christophe Massiot's avatar
Christophe Massiot committed
111 112 113 114
/* 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)

115 116 117 118
/* 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)

119 120
/* Max acceptable delay between the coded PTS and the actual presentation
 * time, without resampling */
121
#define AOUT_PTS_TOLERANCE              (mtime_t)(.04*CLOCK_FREQ)
122

123 124 125
/* Max acceptable resampling (in %) */
#define AOUT_MAX_RESAMPLING             10

126
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
127
 * Video configuration
128
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
129 130 131 132 133

/*
 * Default settings for video output threads
 */

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

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

Sam Hocevar's avatar
 
Sam Hocevar committed
141 142 143
/* Number of planes in a picture */
#define VOUT_MAX_PLANES                 5

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

Gildas Bazin's avatar
 
Gildas Bazin committed
148 149 150 151
/* Minimum number of direct pictures the video output will accept without
 * creating additional pictures in system memory */
#define VOUT_MIN_DIRECT_PICTURES        6

152
/* Number of simultaneous subpictures */
153
#define VOUT_MAX_SUBPICTURES            8
154

Christophe Massiot's avatar
Christophe Massiot committed
155 156 157
/* Statistics are displayed every n loops (=~ pictures) */
#define VOUT_STATS_NB_LOOPS             100

Michel Kaempf's avatar
Michel Kaempf committed
158
/*
Vincent Seguin's avatar
Vincent Seguin committed
159
 * Time settings
Michel Kaempf's avatar
Michel Kaempf committed
160 161
 */

162
/* Time during which the thread will sleep if it has nothing to
Michel Kaempf's avatar
Michel Kaempf committed
163
 * display (in micro-seconds) */
Michel Lespinasse's avatar
 
Michel Lespinasse committed
164
#define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
Michel Kaempf's avatar
Michel Kaempf committed
165 166 167 168 169 170

/* 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 */
171 172 173 174
#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 */
175
#define VOUT_BOGUS_DELAY                ((mtime_t)(DEFAULT_PTS_DELAY * 30))
Michel Kaempf's avatar
Michel Kaempf committed
176

177
/* Delay (in microseconds) before an idle screen is displayed */
Michel Lespinasse's avatar
 
Michel Lespinasse committed
178
#define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
179 180

/* Number of pictures required to computes the FPS rate */
181
#define VOUT_FPS_SAMPLES                20
182

183
/* Better be in advance when awakening than late... */
184
#define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
185

Sam Hocevar's avatar
 
Sam Hocevar committed
186 187 188 189
/* 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. */
190
#define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
Sam Hocevar's avatar
 
Sam Hocevar committed
191

Sam Hocevar's avatar
 
Sam Hocevar committed
192
/* The default video output window title */
193
#define VOUT_TITLE                      "VLC"
194

195
/*****************************************************************************
196
 * Messages and console interfaces configuration
197
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
198

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

Vincent Seguin's avatar
Vincent Seguin committed
203
/* Maximal size of the message queue - in case of overflow, all messages in the
Sam Hocevar's avatar
 
Sam Hocevar committed
204
 * queue are printed, but not sent to the threads */
205
#define VLC_MSG_QSIZE                   256
206 207 208

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