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