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 #if !defined( __LIBVLC__ )
  26   #error You are not libvlc or one of its plugins. You cannot include this file
  27 #endif
  28
  29 /* Conventions regarding names of symbols and variables
  30  * ----------------------------------------------------
  31  *
  32  * - Symbols should begin with a prefix indicating in which module they are
  33  *   used, such as INTF_, VOUT_ or AOUT_.
  34  */
  35
  36 /*****************************************************************************
  37  * General configuration
  38  *****************************************************************************/
  39
  40 #define CLOCK_FREQ 1000000
  41
  42
  43 /* When creating or destroying threads in blocking mode, delay to poll thread
  44  * status */
  45 #define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
  46
  47 /* When a thread waits on a condition in debug mode, delay to wait before
  48  * outputting an error message (in second) */
  49 #define THREAD_COND_TIMEOUT             3
  50
  51 /*****************************************************************************
  52  * Interface configuration
  53  *****************************************************************************/
  54
  55 /* Base delay in micro second for interface sleeps */
  56 #define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
  57
  58 /* Step for changing gamma, and minimum and maximum values */
  59 #define INTF_GAMMA_STEP                 .1
  60 #define INTF_GAMMA_LIMIT                3
  61
  62 /*****************************************************************************
  63  * Input thread configuration
  64  *****************************************************************************/
  65
  66 #define DEFAULT_INPUT_ACTIVITY 1
  67 #define DIRECTORY_ACTIVITY 100
  68 #define TRANSCODE_ACTIVITY 10
  69
  70 /* Used in ErrorThread */
  71 #define INPUT_IDLE_SLEEP                ((mtime_t)(0.100*CLOCK_FREQ))
  72
  73 /* Time to wait in case of read error */
  74 #define INPUT_ERROR_SLEEP               ((mtime_t)(0.10*CLOCK_FREQ))
  75
  76 /* Number of read() calls needed until we check the file size through
  77  * fstat() */
  78 #define INPUT_FSTAT_NB_READS            10
  79
  80 /*
  81  * General limitations
  82  */
  83
  84 /* Duration between the time we receive the data packet, and the time we will
  85  * mark it to be presented */
  86 #define DEFAULT_PTS_DELAY               (mtime_t)(.3*CLOCK_FREQ)
  87
  88 /* DVD and VCD devices */
  89 #if !defined( WIN32 ) && !defined( UNDER_CE )
  90 #   define CD_DEVICE      "/dev/cdrom"
  91 #   define DVD_DEVICE     "/dev/dvd"
  92 #else
  93 #   define CD_DEVICE      "D:"
  94 #   define DVD_DEVICE     NULL
  95 #endif
  96 #define VCD_DEVICE        CD_DEVICE
  97 #define CDAUDIO_DEVICE    CD_DEVICE
  98
  99 /*****************************************************************************
 100  * Audio configuration
 101  *****************************************************************************/
 102
 103 /* Volume */
 104 /* If you are coding an interface, please see src/audio_output/intf.c */
 105 #define AOUT_VOLUME_DEFAULT             256
 106 #define AOUT_VOLUME_STEP                32
 107 #define AOUT_VOLUME_MAX                 1024
 108 #define AOUT_VOLUME_MIN                 0
 109
 110 /* Max number of pre-filters per input, and max number of post-filters */
 111 #define AOUT_MAX_FILTERS                10
 112
 113 /* Max number of inputs */
 114 #define AOUT_MAX_INPUTS                 5
 115
 116 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
 117  * will be considered as bogus and be trashed */
 118 #define AOUT_MAX_ADVANCE_TIME           (mtime_t)(DEFAULT_PTS_DELAY * 3)
 119
 120 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 121  * will cause the calling thread to sleep */
 122 #define AOUT_MAX_PREPARE_TIME           (mtime_t)(.5*CLOCK_FREQ)
 123
 124 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 125  * to avoid too heavy resampling */
 126 #define AOUT_MIN_PREPARE_TIME           (mtime_t)(.04*CLOCK_FREQ)
 127
 128 /* Max acceptable delay between the coded PTS and the actual presentation
 129  * time, without resampling */
 130 #define AOUT_PTS_TOLERANCE              (mtime_t)(.04*CLOCK_FREQ)
 131
 132 /* Max acceptable resampling (in %) */
 133 #define AOUT_MAX_RESAMPLING             10
 134
 135 /*****************************************************************************
 136  * Video configuration
 137  *****************************************************************************/
 138
 139 /*
 140  * Default settings for video output threads
 141  */
 142
 143 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
 144 #define VOUT_ASPECT_FACTOR              432000
 145
 146 /* Maximum width of a scaled source picture - this should be relatively high,
 147  * since higher stream values will result in no display at all. */
 148 #define VOUT_MAX_WIDTH                  4096
 149
 150 /* Number of planes in a picture */
 151 #define VOUT_MAX_PLANES                 5
 152
 153 /* Video heap size - remember that a decompressed picture is big
 154  * (~1 Mbyte) before using huge values */
 155 #ifdef OPTIMIZE_MEMORY
 156 #   define VOUT_MAX_PICTURES               5
 157 #else
 158 #   define VOUT_MAX_PICTURES               8
 159 #endif
 160
 161 /* Minimum number of direct pictures the video output will accept without
 162  * creating additional pictures in system memory */
 163 #define VOUT_MIN_DIRECT_PICTURES        6
 164
 165 /* Number of simultaneous subpictures */
 166 #define VOUT_MAX_SUBPICTURES            8
 167
 168 /* Statistics are displayed every n loops (=~ pictures) */
 169 #define VOUT_STATS_NB_LOOPS             100
 170
 171 /*
 172  * Time settings
 173  */
 174
 175 /* Time during which the thread will sleep if it has nothing to
 176  * display (in micro-seconds) */
 177 #define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
 178
 179 /* Maximum lap of time allowed between the beginning of rendering and
 180  * display. If, compared to the current date, the next image is too
 181  * late, the thread will perform an idle loop. This time should be
 182  * at least VOUT_IDLE_SLEEP plus the time required to render a few
 183  * images, to avoid trashing of decoded images */
 184 #define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))
 185
 186 /* Pictures which are VOUT_BOGUS_DELAY or more in advance probably have
 187  * a bogus PTS and won't be displayed */
 188 #define VOUT_BOGUS_DELAY                ((mtime_t)(DEFAULT_PTS_DELAY * 30))
 189
 190 /* Delay (in microseconds) before an idle screen is displayed */
 191 #define VOUT_IDLE_DELAY                 (5*CLOCK_FREQ)
 192
 193 /* Number of pictures required to computes the FPS rate */
 194 #define VOUT_FPS_SAMPLES                20
 195
 196 /* Better be in advance when awakening than late... */
 197 #define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))
 198
 199 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 200  * It should be approximately the time needed to perform a complete picture
 201  * loop. Since it only happens when the video heap is full, it does not need
 202  * to be too low, even if it blocks the decoder. */
 203 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
 204
 205 /* The default video output window title */
 206 #define VOUT_TITLE                      "VLC"
 207
 208 /*****************************************************************************
 209  * Messages and console interfaces configuration
 210  *****************************************************************************/
 211
 212 /* Maximal size of a message to be stored in the mesage queue,
 213  * it is needed when vasprintf is not available */
 214 #define INTF_MAX_MSG_SIZE               512
 215
 216 /* Maximal size of the message queue - in case of overflow, all messages in the
 217  * queue are printed, but not sent to the threads */
 218 #define VLC_MSG_QSIZE                   256
 219
 220 /* Maximal depth of the object tree output by vlc_dumpstructure */
 221 #define MAX_DUMPSTRUCTURE_DEPTH         100