git.sesse.net Git - vlc/blob - 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/VideoLAN Client"
  53 #elif SYS_DARWIN
  54 #  define CONFIG_DIR                    "Library/Preferences/VLC"
  55 #elif defined( WIN32 ) || defined( UNDER_CE )
  56 #  define CONFIG_DIR                    "vlc"
  57 #else
  58 #  define CONFIG_DIR                    ".vlc"
  59 #endif
  60 #define CONFIG_FILE                     "vlcrc"
  61
  62 /*****************************************************************************
  63  * Interface configuration
  64  *****************************************************************************/
  65
  66 /* Base delay in micro second for interface sleeps */
  67 #define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
  68
  69 /* Step for changing gamma, and minimum and maximum values */
  70 #define INTF_GAMMA_STEP                 .1
  71 #define INTF_GAMMA_LIMIT                3
  72
  73 /*****************************************************************************
  74  * Input thread configuration
  75  *****************************************************************************/
  76
  77 /* Used in ErrorThread */
  78 #define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
  79
  80 /* Time to wait in case of read error */
  81 #define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))
  82
  83 /* Number of read() calls needed until we check the file size through
  84  * fstat() */
  85 #define INPUT_FSTAT_NB_READS            10
  86
  87 /*
  88  * General limitations
  89  */
  90
  91 /* Maximum number of input threads - this value is used exclusively by
  92  * interface, and is in fact an interface limitation */
  93 #define INPUT_MAX_THREADS               10
  94
  95 /* Maximum size of a data packet (128 kB) */
  96 #define INPUT_MAX_PACKET_SIZE           131072
  97
  98 /* Maximum length of a pre-parsed chunk (4 MB) */
  99 #define INPUT_PREPARSE_LENGTH           4194304
 100
 101 /* Maximum length of a hostname or source name */
 102 #define INPUT_MAX_SOURCE_LENGTH         100
 103
 104 /* Maximum memory the input is allowed to use (20 MB) */
 105 #define INPUT_MAX_ALLOCATION            20971520
 106
 107 /*
 108  * Channel method
 109  */
 110
 111 /* Delay between channel changes - this is required to avoid flooding the
 112  * channel server */
 113 #define INPUT_CHANNEL_CHANGE_DELAY      (mtime_t)(5*CLOCK_FREQ)
 114
 115 /* Duration between the time we receive the data packet, and the time we will
 116  * mark it to be presented */
 117 #define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
 118
 119 /* DVD and VCD devices */
 120 #if !defined( WIN32 ) && !defined( UNDER_CE )
 121 #   define DVD_DEVICE "/dev/dvd"
 122 #   define VCD_DEVICE "/dev/cdrom"
 123 #   define CDAUDIO_DEVICE "/dev/cdrom"
 124 #else
 125 #   define DVD_DEVICE "D:"
 126 #   define VCD_DEVICE "D:"
 127 #   define CDAUDIO_DEVICE "D:"
 128 #endif
 129
 130 /*****************************************************************************
 131  * Audio configuration
 132  *****************************************************************************/
 133
 134 /* Maximum number of audio output threads */
 135 #define AOUT_MAX_THREADS                10
 136
 137 /* Volume */
 138 #define AOUT_VOLUME_DEFAULT             256
 139 #define AOUT_VOLUME_STEP                32
 140 #define AOUT_VOLUME_MAX                 1024
 141 #define AOUT_VOLUME_MIN                 0
 142
 143 /* Max number of pre-filters per input, and max number of post-filters */
 144 #define AOUT_MAX_FILTERS                10
 145
 146 /* Max number of inputs */
 147 #define AOUT_MAX_INPUTS                 5
 148
 149 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
 150  * will be considered as bogus and be trashed */
 151 #define AOUT_MAX_ADVANCE_TIME           (mtime_t)(DEFAULT_PTS_DELAY * 3)
 152
 153 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 154  * will cause the calling thread to sleep */
 155 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
 156
 157 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 158  * to avoid too heavy resampling */
 159 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
 160
 161 /* Max acceptable delay between the coded PTS and the actual presentation
 162  * time, without resampling */
 163 #define AOUT_PTS_TOLERANCE              (mtime_t)(.04*CLOCK_FREQ)
 164
 165 /* Max acceptable resampling (in %) */
 166 #define AOUT_MAX_RESAMPLING             10
 167
 168 /*****************************************************************************
 169  * Video configuration
 170  *****************************************************************************/
 171
 172 /* Maximum number of video output threads */
 173 #define VOUT_MAX_THREADS                256
 174
 175 /*
 176  * Default settings for video output threads
 177  */
 178
 179 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
 180 #define VOUT_ASPECT_FACTOR              432000
 181
 182 /* Maximum width of a scaled source picture - this should be relatively high,
 183  * since higher stream values will result in no display at all. */
 184 #define VOUT_MAX_WIDTH                  4096
 185
 186 /* Number of planes in a picture */
 187 #define VOUT_MAX_PLANES                 5
 188
 189 /* Video heap size - remember that a decompressed picture is big
 190  * (~1 Mbyte) before using huge values */
 191 #define VOUT_MAX_PICTURES               8
 192
 193 /* Minimum number of direct pictures the video output will accept without
 194  * creating additional pictures in system memory */
 195 #define VOUT_MIN_DIRECT_PICTURES        6
 196
 197 /* Number of simultaneous subpictures */
 198 #define VOUT_MAX_SUBPICTURES            8
 199
 200 /* Maximum number of active areas in a rendering buffer. Active areas are areas
 201  * of the picture which need to be cleared before re-using the buffer. If a
 202  * picture, including its many additions such as subtitles, additionnal user
 203  * informations and interface, has too many active areas, some of them are
 204  * joined. */
 205 #define VOUT_MAX_AREAS                  5
 206
 207 /* Statistics are displayed every n loops (=~ pictures) */
 208 #define VOUT_STATS_NB_LOOPS             100
 209
 210 /*
 211  * Time settings
 212  */
 213
 214 /* Time during which the thread will sleep if it has nothing to
 215  * display (in micro-seconds) */
 216 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 217
 218 /* Maximum lap of time allowed between the beginning of rendering and
 219  * display. If, compared to the current date, the next image is too
 220  * late, the thread will perform an idle loop. This time should be
 221  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 222  * images, to avoid trashing of decoded images */
 223 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
 224
 225 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
 226  * a bogus PTS and won't be displayed */
 227 #define VOUT_BOGUS_DELAY                ((mtime_t)(DEFAULT_PTS_DELAY * 3))
 228
 229 /* Delay (in microseconds) before an idle screen is displayed */
 230 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 231
 232 /* Number of pictures required to computes the FPS rate */
 233 #define VOUT_FPS_SAMPLES                20
 234
 235 /* Better be in advance when awakening than late... */
 236 #define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
 237
 238 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 239  * It should be approximately the time needed to perform a complete picture
 240  * loop. Since it only happens when the video heap is full, it does not need
 241  * to be too low, even if it blocks the decoder. */
 242 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
 243
 244 /* The default video output window title */
 245 #define VOUT_TITLE                      "VLC"
 246
 247 /*****************************************************************************
 248  * Video parser configuration
 249  *****************************************************************************/
 250
 251 #define VPAR_IDLE_SLEEP                 ((mtime_t)(0.010*CLOCK_FREQ))
 252
 253 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
 254  * that raising this level dramatically lengthens the compilation time. */
 255 #if defined( HAVE_RELEASE )
 256 #   define VPAR_OPTIM_LEVEL             2
 257 #else
 258 #   define VPAR_OPTIM_LEVEL             1
 259 #endif
 260
 261 /* Maximum number of macroblocks in a picture. */
 262 #define MAX_MB                          2048
 263
 264 /*****************************************************************************
 265  * Video decoder configuration
 266  *****************************************************************************/
 267
 268 #define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
 269
 270 /* Maximum range of values out of the IDCT + motion compensation. */
 271 #define VDEC_CROPRANGE                  2048
 272
 273 /* No SMP by default, since it slows down things on non-smp machines. */
 274 #define VDEC_SMP_DEFAULT                0
 275
 276 /* Nice increments for decoders -- necessary for x11 scheduling */
 277 #define VDEC_NICE                       3
 278
 279 /*****************************************************************************
 280  * Messages and console interfaces configuration
 281  *****************************************************************************/
 282
 283 /* Maximal size of a message to be stored in the mesage queue,
 284  * it is needed when vasprintf is not available */
 285 #define INTF_MAX_MSG_SIZE               512
 286
 287 /* Maximal size of the message queue - in case of overflow, all messages in the
 288  * queue are printed, but not sent to the threads */
 289 #define VLC_MSG_QSIZE                   256
 290
 291 /* Maximal depth of the object tree output by vlc_dumpstructure */
 292 #define MAX_DUMPSTRUCTURE_DEPTH         100