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 /*****************************************************************************
  49  * Interface configuration
  50  *****************************************************************************/
  51
  52 /* Base delay in micro second for interface sleeps */
  53 #define INTF_IDLE_SLEEP                 (CLOCK_FREQ/20)
  54
  55 /* Step for changing gamma, and minimum and maximum values */
  56 #define INTF_GAMMA_STEP                 .1
  57 #define INTF_GAMMA_LIMIT                3
  58
  59 /*****************************************************************************
  60  * Input thread configuration
  61  *****************************************************************************/
  62
  63 #define DEFAULT_INPUT_ACTIVITY 1
  64 #define TRANSCODE_ACTIVITY 10
  65
  66 /* Used in ErrorThread */
  67 #define INPUT_IDLE_SLEEP                (CLOCK_FREQ/10)
  68
  69 /* Number of read() calls needed until we check the file size through
  70  * fstat() */
  71 #define INPUT_FSTAT_NB_READS            16
  72
  73 /*
  74  * General limitations
  75  */
  76
  77 /* Duration between the time we receive the data packet, and the time we will
  78  * mark it to be presented */
  79 #define DEFAULT_PTS_DELAY               (3*CLOCK_FREQ/10)
  80
  81 /*****************************************************************************
  82  * Audio configuration
  83  *****************************************************************************/
  84
  85 /* Volume */
  86 /* If you are coding an interface, please see src/audio_output/intf.c */
  87 #define AOUT_VOLUME_DEFAULT             256
  88 #define AOUT_VOLUME_STEP                32
  89 #define AOUT_VOLUME_MAX                 1024
  90 #define AOUT_VOLUME_MIN                 0
  91
  92 /* Max number of pre-filters per input, and max number of post-filters */
  93 #define AOUT_MAX_FILTERS                10
  94
  95 /* Max number of inputs */
  96 #define AOUT_MAX_INPUTS                 5
  97
  98 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
  99  * will be considered as bogus and be trashed */
 100 #define AOUT_MAX_ADVANCE_TIME           (DEFAULT_PTS_DELAY * 5)
 101
 102 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 103  * will cause the calling thread to sleep */
 104 #define AOUT_MAX_PREPARE_TIME           (CLOCK_FREQ/2)
 105
 106 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 107  * to avoid too heavy resampling */
 108 #define AOUT_MIN_PREPARE_TIME           (CLOCK_FREQ/25)
 109
 110 /* Max acceptable delay between the coded PTS and the actual presentation
 111  * time, without resampling */
 112 #define AOUT_PTS_TOLERANCE              (CLOCK_FREQ/25)
 113
 114 /* Max acceptable resampling (in %) */
 115 #define AOUT_MAX_RESAMPLING             10
 116
 117 /*****************************************************************************
 118  * SPU configuration
 119  *****************************************************************************/
 120
 121 /* Buffer must avoid arriving more than SPU_MAX_PREPARE_TIME in advanced to
 122  * the SPU */
 123 #define SPU_MAX_PREPARE_TIME            (CLOCK_FREQ/2)
 124
 125 /*****************************************************************************
 126  * Video configuration
 127  *****************************************************************************/
 128
 129 /*
 130  * Default settings for video output threads
 131  */
 132
 133 /* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
 134 #define VOUT_ASPECT_FACTOR              432000
 135
 136 /* Maximum width of a scaled source picture - this should be relatively high,
 137  * since higher stream values will result in no display at all. */
 138 #define VOUT_MAX_WIDTH                  4096
 139
 140 /* Number of planes in a picture */
 141 #define VOUT_MAX_PLANES                 5
 142
 143 /*
 144  * Time settings
 145  */
 146
 147 /* Time to sleep when waiting for a buffer (from vout or the video fifo).
 148  * It should be approximately the time needed to perform a complete picture
 149  * loop. Since it only happens when the video heap is full, it does not need
 150  * to be too low, even if it blocks the decoder. */
 151 #define VOUT_OUTMEM_SLEEP               (CLOCK_FREQ/50)
 152
 153 /* The default video output window title */
 154 #define VOUT_TITLE                      "VLC"
 155
 156 /*****************************************************************************
 157  * Messages and console interfaces configuration
 158  *****************************************************************************/
 159
 160 /* Maximal size of a message to be stored in the mesage queue,
 161  * it is needed when vasprintf is not available */
 162 #define INTF_MAX_MSG_SIZE               512
 163
 164 /* Maximal size of the message queue - in case of overflow, all messages in the
 165  * queue are printed, but not sent to the threads */
 166 #define VLC_MSG_QSIZE                   256
 167
 168 /* Maximal depth of the object tree output by vlc_dumpstructure */
 169 #define MAX_DUMPSTRUCTURE_DEPTH         100