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-2002 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                    "vlc"
  55 #else
  56 #  define CONFIG_DIR                    ".vlc"
  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)(.3*CLOCK_FREQ)
 109
 110 /* DVD and VCD devices */
 111 #ifndef WIN32
 112 #   define DVD_DEVICE "/dev/dvd"
 113 #   define VCD_DEVICE "/dev/cdrom"
 114 #else
 115 #   define DVD_DEVICE "D"
 116 #   define VCD_DEVICE "D"
 117 #endif
 118
 119 /*****************************************************************************
 120  * Audio configuration
 121  *****************************************************************************/
 122
 123 /* Maximum number of audio output threads */
 124 #define AOUT_MAX_THREADS                10
 125
 126 /* Volume */
 127 #define AOUT_VOLUME_DEFAULT             256
 128 #define AOUT_VOLUME_STEP                32
 129 #define AOUT_VOLUME_MAX                 1024
 130 #define AOUT_VOLUME_MIN                 0
 131
 132 /* Max number of pre-filters per input, and max number of post-filters */
 133 #define AOUT_MAX_FILTERS                10
 134
 135 /* Max number of inputs */
 136 #define AOUT_MAX_INPUTS                 5
 137
 138 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 139  * will cause the calling thread to sleep */
 140 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
 141
 142 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 143  * to avoid too heavy resampling */
 144 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
 145
 146 /* Max acceptable delay between the coded PTS and the actual presentation
 147  * time, without resampling */
 148 #define AOUT_PTS_TOLERANCE              (mtime_t)(.02*CLOCK_FREQ)
 149
 150 /* Max acceptable resampling (in %) */
 151 #define AOUT_MAX_RESAMPLING             10
 152
 153 /*****************************************************************************
 154  * Video configuration
 155  *****************************************************************************/
 156
 157 /* Maximum number of video output threads */
 158 #define VOUT_MAX_THREADS                256
 159
 160 /*
 161  * Default settings for video output threads
 162  */
 163
 164 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
 165 #define VOUT_ASPECT_FACTOR              432000
 166
 167 /* Maximum width of a scaled source picture - this should be relatively high,
 168  * since higher stream values will result in no display at all. */
 169 #define VOUT_MAX_WIDTH                  4096
 170
 171 /* Number of planes in a picture */
 172 #define VOUT_MAX_PLANES                 5
 173
 174 /* Video heap size - remember that a decompressed picture is big
 175  * (~1 Mbyte) before using huge values */
 176 #define VOUT_MAX_PICTURES               8
 177
 178 /* Number of simultaneous subpictures */
 179 #define VOUT_MAX_SUBPICTURES            8
 180
 181 /* Maximum number of active areas in a rendering buffer. Active areas are areas
 182  * of the picture which need to be cleared before re-using the buffer. If a
 183  * picture, including its many additions such as subtitles, additionnal user
 184  * informations and interface, has too many active areas, some of them are
 185  * joined. */
 186 #define VOUT_MAX_AREAS                  5
 187
 188 /* Default fonts */
 189 #define VOUT_DEFAULT_FONT               "default8x9.psf"
 190 #define VOUT_LARGE_FONT                 "default8x16.psf"
 191
 192 /* Statistics are displayed every n loops (=~ pictures) */
 193 #define VOUT_STATS_NB_LOOPS             100
 194
 195 /*
 196  * Time settings
 197  */
 198
 199 /* Time during which the thread will sleep if it has nothing to
 200  * display (in micro-seconds) */
 201 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 202
 203 /* Maximum lap of time allowed between the beginning of rendering and
 204  * display. If, compared to the current date, the next image is too
 205  * late, the thread will perform an idle loop. This time should be
 206  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 207  * images, to avoid trashing of decoded images */
 208 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
 209
 210 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
 211  * a bogus PTS and won't be displayed */
 212 #define VOUT_BOGUS_DELAY                ((int)(0.800*CLOCK_FREQ))
 213
 214 /* Delay (in microseconds) before an idle screen is displayed */
 215 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 216
 217 /* Number of pictures required to computes the FPS rate */
 218 #define VOUT_FPS_SAMPLES                20
 219
 220 /* Better be in advance when awakening than late... */
 221 #define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
 222
 223 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 224  * It should be approximately the time needed to perform a complete picture
 225  * loop. Since it only happens when the video heap is full, it does not need
 226  * to be too low, even if it blocks the decoder. */
 227 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
 228
 229 /* The default video output window title */
 230 #define VOUT_TITLE                      "VideoLAN Client " VERSION
 231
 232 /*****************************************************************************
 233  * Video parser configuration
 234  *****************************************************************************/
 235
 236 #define VPAR_IDLE_SLEEP                 ((mtime_t)(0.010*CLOCK_FREQ))
 237
 238 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
 239  * that raising this level dramatically lengthens the compilation time. */
 240 #if defined( HAVE_RELEASE )
 241 #   define VPAR_OPTIM_LEVEL             2
 242 #else
 243 #   define VPAR_OPTIM_LEVEL             1
 244 #endif
 245
 246 /* Maximum number of macroblocks in a picture. */
 247 #define MAX_MB                          2048
 248
 249 /*****************************************************************************
 250  * Video decoder configuration
 251  *****************************************************************************/
 252
 253 #define VDEC_IDLE_SLEEP                 ((mtime_t)(0.100*CLOCK_FREQ))
 254
 255 /* Maximum range of values out of the IDCT + motion compensation. */
 256 #define VDEC_CROPRANGE                  2048
 257
 258 /* No SMP by default, since it slows down things on non-smp machines. */
 259 #define VDEC_SMP_DEFAULT                0
 260
 261 /* Nice increments for decoders -- necessary for x11 scheduling */
 262 #define VDEC_NICE                       3
 263
 264 /*****************************************************************************
 265  * Messages and console interfaces configuration
 266  *****************************************************************************/
 267
 268 /* Maximal size of a message to be stored in the mesage queue,
 269  * it is needed when vasprintf is not avalaible */
 270 #define INTF_MAX_MSG_SIZE               512
 271
 272 /* Maximal size of the message queue - in case of overflow, all messages in the
 273  * queue are printed, but not sent to the threads */
 274 #define VLC_MSG_QSIZE                   256
 275
 276 /* Maximal depth of the object tree output by vlc_dumpstructure */
 277 #define MAX_DUMPSTRUCTURE_DEPTH         100