c61b52f850adafe2e43373a137d3e2c6482ccbad
[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 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /**
26  * \file
27  * This file defines of values used in interface, vout, aout and vlc core functions.
28  */
29
30 /* Conventions regarding names of symbols and variables
31  * ----------------------------------------------------
32  *
33  * - Symbols should begin with a prefix indicating in which module they are
34  *   used, such as INTF_, VOUT_ or AOUT_.
35  */
36
37 /*****************************************************************************
38  * General configuration
39  *****************************************************************************/
40
41 #define CLOCK_FREQ 1000000
42
43
44 /* When creating or destroying threads in blocking mode, delay to poll thread
45  * status */
46 #define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
47
48 /*****************************************************************************
49  * Interface configuration
50  *****************************************************************************/
51
52 /* Base delay in micro second for interface sleeps */
53 #define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
54
55 /* Step for changing gamma, and minimum and maximum values */
56 #define INTF_GAMMA_STEP                 .1
57 #define INTF_GAMMA_LIMIT                3
58
59 /*****************************************************************************
60  * Input thread configuration
61  *****************************************************************************/
62
63 #define DEFAULT_INPUT_ACTIVITY 1
64 #define TRANSCODE_ACTIVITY 10
65
66 /* Used in ErrorThread */
67 #define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
68
69 /* Time to wait in case of read error */
70 #define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))
71
72 /* Number of read() calls needed until we check the file size through
73  * fstat() */
74 #define INPUT_FSTAT_NB_READS            10
75
76 /*
77  * General limitations
78  */
79
80 /* Duration between the time we receive the data packet, and the time we will
81  * mark it to be presented */
82 #define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
83
84 /* DVD and VCD devices */
85 #if !defined( WIN32 ) && !defined( UNDER_CE )
86 #   define CD_DEVICE      "/dev/cdrom"
87 #   define DVD_DEVICE     "/dev/dvd"
88 #else
89 #   define CD_DEVICE      "D:"
90 #   define DVD_DEVICE     NULL
91 #endif
92 #define VCD_DEVICE        CD_DEVICE
93 #define CDAUDIO_DEVICE    CD_DEVICE
94
95 /*****************************************************************************
96  * Audio configuration
97  *****************************************************************************/
98
99 /* Volume */
100 /* If you are coding an interface, please see src/audio_output/intf.c */
101 #define AOUT_VOLUME_DEFAULT             256
102 #define AOUT_VOLUME_STEP                32
103 #define AOUT_VOLUME_MAX                 1024
104 #define AOUT_VOLUME_MIN                 0
105
106 /* Max number of pre-filters per input, and max number of post-filters */
107 #define AOUT_MAX_FILTERS                10
108
109 /* Max number of inputs */
110 #define AOUT_MAX_INPUTS                 5
111
112 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
113  * will be considered as bogus and be trashed */
114 #define AOUT_MAX_ADVANCE_TIME           (mtime_t)(DEFAULT_PTS_DELAY * 5)
115
116 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
117  * will cause the calling thread to sleep */
118 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
119
120 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
121  * to avoid too heavy resampling */
122 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
123
124 /* Max acceptable delay between the coded PTS and the actual presentation
125  * time, without resampling */
126 #define AOUT_PTS_TOLERANCE              (mtime_t)(.04*CLOCK_FREQ)
127
128 /* Max acceptable resampling (in %) */
129 #define AOUT_MAX_RESAMPLING             10
130
131 /*****************************************************************************
132  * Video configuration
133  *****************************************************************************/
134
135 /*
136  * Default settings for video output threads
137  */
138
139 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
140 #define VOUT_ASPECT_FACTOR              432000
141
142 /* Maximum width of a scaled source picture - this should be relatively high,
143  * since higher stream values will result in no display at all. */
144 #define VOUT_MAX_WIDTH                  4096
145
146 /* Number of planes in a picture */
147 #define VOUT_MAX_PLANES                 5
148
149 /* Video heap size - remember that a decompressed picture is big
150  * (~1 Mbyte) before using huge values */
151 #define VOUT_MAX_PICTURES              16
152
153 /* Minimum number of direct pictures the video output will accept without
154  * creating additional pictures in system memory */
155 #define VOUT_MIN_DIRECT_PICTURES        12
156
157 /* Statistics are displayed every n loops (=~ pictures) */
158 #define VOUT_STATS_NB_LOOPS             100
159
160 /*
161  * Time settings
162  */
163
164 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
165  * It should be approximately the time needed to perform a complete picture
166  * loop. Since it only happens when the video heap is full, it does not need
167  * to be too low, even if it blocks the decoder. */
168 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
169
170 /* The default video output window title */
171 #define VOUT_TITLE                      "VLC"
172
173 /*****************************************************************************
174  * Messages and console interfaces configuration
175  *****************************************************************************/
176
177 /* Maximal size of a message to be stored in the mesage queue,
178  * it is needed when vasprintf is not available */
179 #define INTF_MAX_MSG_SIZE               512
180
181 /* Maximal size of the message queue - in case of overflow, all messages in the
182  * queue are printed, but not sent to the threads */
183 #define VLC_MSG_QSIZE                   256
184
185 /* Maximal depth of the object tree output by vlc_dumpstructure */
186 #define MAX_DUMPSTRUCTURE_DEPTH         100