vlc_config.h 4.4 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_config.h: limits and configuration
Michel Kaempf's avatar
Michel Kaempf committed
3
 * Defines all compilation-time configuration constants and size limits
4
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
5
 * Copyright (C) 1999-2003 VLC authors and VideoLAN
6
 *
7 8
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@via.ecp.fr>
9
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13
 * (at your option) any later version.
14
 *
15 16
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
24

25 26 27 28 29
/**
 * \file
 * This file defines of values used in interface, vout, aout and vlc core functions.
 */

Vincent Seguin's avatar
Vincent Seguin committed
30 31 32 33
/* Conventions regarding names of symbols and variables
 * ----------------------------------------------------
 *
 * - Symbols should begin with a prefix indicating in which module they are
34
 *   used, such as INTF_, VOUT_ or AOUT_.
Vincent Seguin's avatar
Vincent Seguin committed
35 36
 */

37
/*****************************************************************************
38
 * General configuration
39
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
40

41 42
/* All timestamp below or equal to this define are invalid/unset
 * XXX the numerical value is 0 because of historical reason and will change.*/
43 44
#define VLC_TS_INVALID INT64_C(0)
#define VLC_TS_0 INT64_C(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)
Michel Kaempf's avatar
Michel Kaempf committed
54

55
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
56
 * Input thread configuration
57
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
58

59
/* Used in ErrorThread */
60
#define INPUT_IDLE_SLEEP                (CLOCK_FREQ/10)
Michel Kaempf's avatar
Michel Kaempf committed
61 62 63 64 65

/*
 * General limitations
 */

66
/* Duration between the time we receive the data packet, and the time we will
67
 * mark it to be presented */
68
#define DEFAULT_PTS_DELAY               (3*CLOCK_FREQ/10)
69

70 71 72 73 74 75
/*****************************************************************************
 * SPU configuration
 *****************************************************************************/

/* Buffer must avoid arriving more than SPU_MAX_PREPARE_TIME in advanced to
 * the SPU */
76
#define SPU_MAX_PREPARE_TIME            (CLOCK_FREQ/2)
77

78
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
79
 * Video configuration
80
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
81 82 83 84 85

/*
 * Default settings for video output threads
 */

Sam Hocevar's avatar
Sam Hocevar committed
86 87
/* Multiplier value for aspect ratio calculation (2^7 * 3^3 * 5^3) */
#define VOUT_ASPECT_FACTOR              432000
88

89
/* Maximum width of a scaled source picture - this should be relatively high,
90 91 92
 * since higher stream values will result in no display at all. */
#define VOUT_MAX_WIDTH                  4096

93 94 95
/* Number of planes in a picture */
#define VOUT_MAX_PLANES                 5

Michel Kaempf's avatar
Michel Kaempf committed
96
/*
Vincent Seguin's avatar
Vincent Seguin committed
97
 * Time settings
Michel Kaempf's avatar
Michel Kaempf committed
98 99
 */

100 101 102 103
/* Time to sleep when waiting for a buffer (from vout or the video fifo).
 * It should be approximately the time needed to perform a complete picture
 * loop. Since it only happens when the video heap is full, it does not need
 * to be too low, even if it blocks the decoder. */
104
#define VOUT_OUTMEM_SLEEP               (CLOCK_FREQ/50)
105

106
/* The default video output window title */
107
#define VOUT_TITLE                      "VLC"
108

109
/*****************************************************************************
110
 * Messages and console interfaces configuration
111
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
112

113 114
/* Maximal depth of the object tree output by vlc_dumpstructure */
#define MAX_DUMPSTRUCTURE_DEPTH         100