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_DIR                "cache"
  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 size of a data packet (128 kB) */
  93 #define INPUT_MAX_PACKET_SIZE           131072
  94
  95 /* Maximum length of a pre-parsed chunk (4 MB) */
  96 #define INPUT_PREPARSE_LENGTH           4194304
  97
  98 /* Maximum length of a hostname or source name */
  99 #define INPUT_MAX_SOURCE_LENGTH         100
 100
 101 /* Maximum memory the input is allowed to use (20 MB) */
 102 #define INPUT_MAX_ALLOCATION            20971520
 103
 104 /* Duration between the time we receive the data packet, and the time we will
 105  * mark it to be presented */
 106 #define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
 107
 108 /* DVD and VCD devices */
 109 #if !defined( WIN32 ) && !defined( UNDER_CE )
 110 #   define DVD_DEVICE "/dev/dvd"
 111 #   define VCD_DEVICE "/dev/cdrom"
 112 #   define CDAUDIO_DEVICE "/dev/cdrom"
 113 #else
 114 #   define DVD_DEVICE "D:"
 115 #   define VCD_DEVICE "D:"
 116 #   define CDAUDIO_DEVICE "D:"
 117 #endif
 118
 119 /*****************************************************************************
 120  * Audio configuration
 121  *****************************************************************************/
 122
 123 /* Volume */
 124 #define AOUT_VOLUME_DEFAULT             256
 125 #define AOUT_VOLUME_STEP                32
 126 #define AOUT_VOLUME_MAX                 1024
 127 #define AOUT_VOLUME_MIN                 0
 128
 129 /* Max number of pre-filters per input, and max number of post-filters */
 130 #define AOUT_MAX_FILTERS                10
 131
 132 /* Max number of inputs */
 133 #define AOUT_MAX_INPUTS                 5
 134
 135 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
 136  * will be considered as bogus and be trashed */
 137 #define AOUT_MAX_ADVANCE_TIME           (mtime_t)(DEFAULT_PTS_DELAY * 3)
 138
 139 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 140  * will cause the calling thread to sleep */
 141 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
 142
 143 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 144  * to avoid too heavy resampling */
 145 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
 146
 147 /* Max acceptable delay between the coded PTS and the actual presentation
 148  * time, without resampling */
 149 #define AOUT_PTS_TOLERANCE              (mtime_t)(.04*CLOCK_FREQ)
 150
 151 /* Max acceptable resampling (in %) */
 152 #define AOUT_MAX_RESAMPLING             10
 153
 154 /*****************************************************************************
 155  * Video configuration
 156  *****************************************************************************/
 157
 158 /*
 159  * Default settings for video output threads
 160  */
 161
 162 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
 163 #define VOUT_ASPECT_FACTOR              432000
 164
 165 /* Maximum width of a scaled source picture - this should be relatively high,
 166  * since higher stream values will result in no display at all. */
 167 #define VOUT_MAX_WIDTH                  4096
 168
 169 /* Number of planes in a picture */
 170 #define VOUT_MAX_PLANES                 5
 171
 172 /* Video heap size - remember that a decompressed picture is big
 173  * (~1 Mbyte) before using huge values */
 174 #ifdef UNDER_CE
 175 #   define VOUT_MAX_PICTURES               5
 176 #else
 177 #   define VOUT_MAX_PICTURES               8
 178 #endif
 179
 180 /* Minimum number of direct pictures the video output will accept without
 181  * creating additional pictures in system memory */
 182 #define VOUT_MIN_DIRECT_PICTURES        6
 183
 184 /* Number of simultaneous subpictures */
 185 #define VOUT_MAX_SUBPICTURES            8
 186
 187 /* Maximum number of active areas in a rendering buffer. Active areas are areas
 188  * of the picture which need to be cleared before re-using the buffer. If a
 189  * picture, including its many additions such as subtitles, additionnal user
 190  * information and interface, has too many active areas, some of them are
 191  * joined. */
 192 #define VOUT_MAX_AREAS                  5
 193
 194 /* Statistics are displayed every n loops (=~ pictures) */
 195 #define VOUT_STATS_NB_LOOPS             100
 196
 197 /*
 198  * Time settings
 199  */
 200
 201 /* Time during which the thread will sleep if it has nothing to
 202  * display (in micro-seconds) */
 203 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 204
 205 /* Maximum lap of time allowed between the beginning of rendering and
 206  * display. If, compared to the current date, the next image is too
 207  * late, the thread will perform an idle loop. This time should be
 208  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 209  * images, to avoid trashing of decoded images */
 210 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
 211
 212 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
 213  * a bogus PTS and won't be displayed */
 214 #define VOUT_BOGUS_DELAY                ((mtime_t)(DEFAULT_PTS_DELAY * 3))
 215
 216 /* Delay (in microseconds) before an idle screen is displayed */
 217 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 218
 219 /* Number of pictures required to computes the FPS rate */
 220 #define VOUT_FPS_SAMPLES                20
 221
 222 /* Better be in advance when awakening than late... */
 223 #define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
 224
 225 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 226  * It should be approximately the time needed to perform a complete picture
 227  * loop. Since it only happens when the video heap is full, it does not need
 228  * to be too low, even if it blocks the decoder. */
 229 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
 230
 231 /* The default video output window title */
 232 #define VOUT_TITLE                      "VLC"
 233
 234 /*****************************************************************************
 235  * Messages and console interfaces configuration
 236  *****************************************************************************/
 237
 238 /* Maximal size of a message to be stored in the mesage queue,
 239  * it is needed when vasprintf is not available */
 240 #define INTF_MAX_MSG_SIZE               512
 241
 242 /* Maximal size of the message queue - in case of overflow, all messages in the
 243  * queue are printed, but not sent to the threads */
 244 #define VLC_MSG_QSIZE                   256
 245
 246 /* Maximal depth of the object tree output by vlc_dumpstructure */
 247 #define MAX_DUMPSTRUCTURE_DEPTH         100