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 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 /**
  26  * \file
  27  * This file defines of values used in interface, vout, aout and vlc core functions.
  28  */
  29
  30 /* Conventions regarding names of symbols and variables
  31  * ----------------------------------------------------
  32  *
  33  * - Symbols should begin with a prefix indicating in which module they are
  34  *   used, such as INTF_, VOUT_ or AOUT_.
  35  */
  36
  37 /*****************************************************************************
  38  * General configuration
  39  *****************************************************************************/
  40
  41 /* All timestamp below or equal to this define are invalid/unset
  42  * XXX the numerical value is 0 because of historical reason and will change.*/
  43 #define VLC_TS_INVALID (0)
  44 #define VLC_TS_0 (1)
  45
  46 #define CLOCK_FREQ INT64_C(1000000)
  47
  48 /* When creating or destroying threads in blocking mode, delay to poll thread
  49  * status */
  50 #define THREAD_SLEEP                    ((mtime_t)(0.010*CLOCK_FREQ))
  51
  52 /*****************************************************************************
  53  * Interface configuration
  54  *****************************************************************************/
  55
  56 /* Base delay in micro second for interface sleeps */
  57 #define INTF_IDLE_SLEEP                 ((mtime_t)(0.050*CLOCK_FREQ))
  58
  59 /* Step for changing gamma, and minimum and maximum values */
  60 #define INTF_GAMMA_STEP                 .1
  61 #define INTF_GAMMA_LIMIT                3
  62
  63 /*****************************************************************************
  64  * Input thread configuration
  65  *****************************************************************************/
  66
  67 #define DEFAULT_INPUT_ACTIVITY 1
  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            16
  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 * 5)
 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  * SPU configuration
 137  *****************************************************************************/
 138
 139 /* Buffer must avoid arriving more than SPU_MAX_PREPARE_TIME in advanced to
 140  * the SPU */
 141 #define SPU_MAX_PREPARE_TIME ((mtime_t)(0.5*CLOCK_FREQ))
 142
 143 /*****************************************************************************
 144  * Video configuration
 145  *****************************************************************************/
 146
 147 /*
 148  * Default settings for video output threads
 149  */
 150
 151 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
 152 #define VOUT_ASPECT_FACTOR              432000
 153
 154 /* Maximum width of a scaled source picture - this should be relatively high,
 155  * since higher stream values will result in no display at all. */
 156 #define VOUT_MAX_WIDTH                  4096
 157
 158 /* Number of planes in a picture */
 159 #define VOUT_MAX_PLANES                 5
 160
 161 /* Video heap size - remember that a decompressed picture is big
 162  * (~1 Mbyte) before using huge values */
 163 #define VOUT_MAX_PICTURES              16
 164
 165 /*
 166  * Time settings
 167  */
 168
 169 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 170  * It should be approximately the time needed to perform a complete picture
 171  * loop. Since it only happens when the video heap is full, it does not need
 172  * to be too low, even if it blocks the decoder. */
 173 #define VOUT_OUTMEM_SLEEP               ((mtime_t)(0.020*CLOCK_FREQ))
 174
 175 /* The default video output window title */
 176 #define VOUT_TITLE                      "VLC"
 177
 178 /*****************************************************************************
 179  * Messages and console interfaces configuration
 180  *****************************************************************************/
 181
 182 /* Maximal size of a message to be stored in the mesage queue,
 183  * it is needed when vasprintf is not available */
 184 #define INTF_MAX_MSG_SIZE               512
 185
 186 /* Maximal size of the message queue - in case of overflow, all messages in the
 187  * queue are printed, but not sent to the threads */
 188 #define VLC_MSG_QSIZE                   256
 189
 190 /* Maximal depth of the object tree output by vlc_dumpstructure */
 191 #define MAX_DUMPSTRUCTURE_DEPTH         100