]> git.sesse.net Git - vlc/blobdiff - include/config.h.in
* Mandatory step for video output IV and the audio output quality
[vlc] / include / config.h.in
index 8779a34fcf11ed78079de978b4dec24c78c99855..f61f7bd6486554c29d68a58c652c210f41c399a6 100644 (file)
@@ -2,24 +2,24 @@
  * config.h: limits and configuration
  * Defines all compilation-time configuration constants and size limits
  *****************************************************************************
- * Copyright (C) 1999, 2000 VideoLAN
+ * Copyright (C) 1999, 2000, 2001 VideoLAN
  *
- * Authors:
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
+ *          Samuel Hocevar <sam@via.ecp.fr>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- *
+ * 
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public
- * License along with this program; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
 /* Conventions regarding names of symbols and variables
@@ -28,8 +28,8 @@
  * - Symbols should begin with a prefix indicating in which module they are
  *   used, such as INTF_, VOUT_ or ADEC_.
  *
- * - Regarding environment variables, which are used as initialization parameters
- *   for threads :
+ * - Regarding environment variables, which are used as initialization
+ *  parameters for threads :
  *   + variable names should end with '_VAR'
  *   + environment variable default value should end with '_DEFAULT'
  *   + values having a special meaning with '_VAL'
  *****************************************************************************/
 
 /* Program version and copyright message */
-#define VERSION_MESSAGE     "vlc @VLC_VERSION@ @VLC_CODENAME@" \
-                            /* " (" PROGRAM_BUILD ") (" PROGRAM_OPTIONS ")\n" */ \
-                            "Copyright 1996-2000 VideoLAN\n"
+#define VERSION_MESSAGE     "vlc @VLC_VERSION@ @VLC_CODENAME@ " \
+                          /* "(" PROGRAM_BUILD ") (" PROGRAM_OPTIONS ")\n" */ \
+                            "Copyright 1996-2001 VideoLAN\n"
 #define COPYRIGHT_MESSAGE   "VideoLAN Client - version @VLC_VERSION@" \
-                            " @VLC_CODENAME@ - (c)1996-2000 VideoLAN"
+                            " @VLC_CODENAME@ - (C)1996-2001 VideoLAN\n"
+
+#define VERSION             "@VLC_VERSION@"
 
 /*****************************************************************************
  * General compilation options
  * and might cause problems with some very weird streams. */
 //#define MPEG2_COMPLIANT
 
-/* Define for profiling and statistics support - such informations, like FPS
- * or pictures count won't be available if it not set */
-#define STATS
-
-/* Define for unthreaded version of the program FIXME: not yet implemented ??*/
-//#define NO_THREAD
-
 /*****************************************************************************
  * Debugging options - define or undefine symbols
  *****************************************************************************/
-#if DEBUG == 1
-/* General debugging support, which depends of the DEBUG define, is determined
+#ifdef TRACE
+/* General trace support, which depends of the TRACE define, is determined
  * in the Makefile */
 
 /* Modules specific debugging - this will produce a lot of output, but can be
- * usefull to track a bug */
-#define DEBUG_INTF
-#define DEBUG_INPUT
-#define DEBUG_AUDIO
-//#define DEBUG_VIDEO
-
-/* Debugging log file - if defined, a file can be used to store all messages. If
- * DEBUG_LOG_ONLY is defined, debug messages will only be printed to the log and
+ * useful to track a bug */
+//#define TRACE_INTF
+//#define TRACE_INPUT
+//#define TRACE_AUDIO
+#define TRACE_VOUT
+#define TRACE_VPAR
+
+/* Trace log file - if defined, a file can be used to store all messages. If
+ * TRACE_LOG_ONLY is defined, debug messages will only be printed to the log and
  * will not appear on the screen */
-#define DEBUG_LOG                       "vlc-debug.log"
-#define DEBUG_LOG_ONLY
+#define TRACE_LOG                       "vlc-trace.log"
+#define TRACE_LOG_ONLY
 
 #endif
 
 /* Size of the FIFO. FIFO_SIZE+1 must be a power of 2 */
 #define FIFO_SIZE                       1023
 
+/*
+ * Paths
+ */
+
+#define DATA_PATH                       "@prefix@/share/videolan"
+#define PLUGIN_PATH                     "@prefix@/lib/videolan/vlc"
+
+#define MAX_PLUGIN_COUNT                32
 
 /*****************************************************************************
  * Interface configuration
  *****************************************************************************/
 
+/* Environment variable containing the display method */
+#define INTF_METHOD_VAR                 "vlc_intf"
+
 /* Environment variable used to store startup script name and default value */
-#define INTF_INIT_SCRIPT_VAR            "vlc_init"
-#define INTF_INIT_SCRIPT_DEFAULT        "vlc.init"
+#define INTF_INIT_SCRIPT_VAR            "vlcrc"
+#define INTF_INIT_SCRIPT_DEFAULT        ".vlcrc"
 
 /* Environment variable used to store channels file and default value */
 #define INTF_CHANNELS_VAR               "vlc_channels"
 #define INTF_CHANNELS_DEFAULT           "vlc.channels"
 
 /* Base delay in micro second for interface sleeps */
-#define INTF_IDLE_SLEEP                 ((int)(0.100*CLOCK_FREQ))
+#define INTF_IDLE_SLEEP                 ((int)(0.050*CLOCK_FREQ))
 
 /* Step for changing gamma, and minimum and maximum values */
 #define INTF_GAMMA_STEP                 .1
 #define INTF_GAMMA_LIMIT                3
 
-/*
- * X11 settings
- */
-
-/* Title of the X11 window */
-#define VOUT_TITLE                      "VideoLAN Client"
+/* Maximum number of channels */
+#define INTF_MAX_CHANNELS               10
 
 /*****************************************************************************
  * Input thread configuration
  *****************************************************************************/
 
+/* Environment variable containing the display method */
+#define INPUT_METHOD_VAR                "vlc_input"
+
 /* XXX?? */
 #define INPUT_IDLE_SLEEP                ((int)(0.100*CLOCK_FREQ))
 
  * General limitations
  */
 
-/* Broadcast address, in case of a broadcasted stream */
-#define INPUT_BCAST_ADDR                "138.195.143.255"
-
 /* Maximum number of input threads - this value is used exclusively by
  * interface, and is in fact an interface limitation */
 #define INPUT_MAX_THREADS               10
 
-/* Maximum number of programs definitions in a TS stream */
-#define INPUT_MAX_PGRM                  10
-
-/* Maximum number of ES definitions in a TS stream */
-#define INPUT_MAX_ES                    10
-
-/* Maximum number of ES in a single program */
-#define INPUT_MAX_PROGRAM_ES            10
+/* Maximum size of a data packet (128 kB) */
+#define INPUT_MAX_PACKET_SIZE           131072
 
-/* Maximum number of selected ES in an input thread */
-#define INPUT_MAX_SELECTED_ES           10
-
-/* Maximum number of TS packets in the client at any time
- * INPUT_MAX_TS + 1 must be a power of 2, to optimize the %(INPUT_MAX_TS+1)
- * operation with a &INPUT_MAX_TS in the case of a fifo netlist.
- * It should be > number of fifos * FIFO_SIZE to avoid input deadlock. */
-#define INPUT_MAX_TS                    32767     /* INPUT_MAX_TS + 1 = 2^15 */
-
-/* Same thing with PES packets */
-#define INPUT_MAX_PES                   16383
-
-/* Maximum number of TS packets we read from the socket in one readv().
- * Since you can't put more than 7 TS packets in an Ethernet frame,
- * the maximum value is 7. This number should also limit the stream server,
- * otherwise any supplementary packet is lost. */
-#define INPUT_TS_READ_ONCE              7
-
-/* Use a LIFO or FIFO for TS netlist ? */
-#undef INPUT_LIFO_TS_NETLIST
-
-/* Use a LIFO or FIFO for PES netlist ? */
-#undef INPUT_LIFO_PES_NETLIST
+/* Maximum length of a pre-parsed chunk (4 MB) */
+#define INPUT_PREPARSE_LENGTH           4194304
 
 /* Maximum length of a hostname or source name */
 #define INPUT_MAX_SOURCE_LENGTH         100
 /* Default remote server */
 #define INPUT_SERVER_VAR                "vlc_server"
 #define INPUT_SERVER_DEFAULT            "138.195.143.220"
+#define INPUT_BCAST_ADDR                "138.195.143.255"
 
 /* Default input port */
 #define INPUT_PORT_VAR                  "vlc_server_port"
 #define INPUT_PORT_DEFAULT              1234
 
+/* Broadcast mode */
+#define INPUT_BROADCAST_VAR             "vlc_broadcast"
+#define INPUT_BROADCAST_DEFAULT         0
+
 /*
- * Vlan method
+ * Channel method
  */
 
 /* Default network interface and environment variable */
 #define INPUT_IFACE_DEFAULT             "eth0"
 
 /* Default server and port */
-#define INPUT_VLAN_SERVER_VAR           "vlc_vlan_server"
-#define INPUT_VLAN_SERVER_DEFAULT       "138.195.140.31"
-#define INPUT_VLAN_PORT_VAR             "vlc_vlan_port"
-#define INPUT_VLAN_PORT_DEFAULT         6010
+#define INPUT_CHANNEL_SERVER_VAR           "vlc_channel_server"
+#define INPUT_CHANNEL_SERVER_DEFAULT       "138.195.139.95"
+#define INPUT_CHANNEL_PORT_VAR             "vlc_channel_port"
+#define INPUT_CHANNEL_PORT_DEFAULT         6010
 
-/* Delay between vlan changes - this is required to avoid flooding the VLAN
- * server */
-#define INPUT_VLAN_CHANGE_DELAY         (5*CLOCK_FREQ)
+/* Delay between channel changes - this is required to avoid flooding the 
+ * channel server */
+#define INPUT_CHANNEL_CHANGE_DELAY         (mtime_t)(5*CLOCK_FREQ)
 
-/* Duration between the time we receive the TS packet, and the time we will
+/* Duration between the time we receive the data packet, and the time we will
  * mark it to be presented */
-#define INPUT_PTS_DELAY                 (2*CLOCK_FREQ)
+#define DEFAULT_PTS_DELAY               (mtime_t)(.2*CLOCK_FREQ)
+
+#define INPUT_DVD_DEVICE_VAR            "vlc_dvd_device"
+#define INPUT_DVD_DEVICE_DEFAULT        "/dev/dvd"
+
+#define INPUT_TITLE_VAR                 "vlc_input_title"
+#define INPUT_CHAPTER_VAR               "vlc_input_chapter"
+#define INPUT_ANGLE_VAR                 "vlc_input_angle"
+#define INPUT_AUDIO_VAR                 "vlc_input_audio"
+#define INPUT_CHANNEL_VAR               "vlc_input_channel"
+#define INPUT_SUBTITLE_VAR              "vlc_input_subtitle"
 
 /*****************************************************************************
  * Audio configuration
 /* Environment variable containing the audio output method */
 #define AOUT_METHOD_VAR                 "vlc_aout"
 
-/* The fallback method */
-#define AOUT_DEFAULT_METHOD "dsp"
-
 /* Environment variable used to store dsp device name, and default value */
 #define AOUT_DSP_VAR                    "vlc_dsp"
 #define AOUT_DSP_DEFAULT                "/dev/dsp"
 
+/* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
+#define AOUT_FORMAT_DEFAULT             AOUT_FMT_S16_NE
+/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S8 */
+/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U8 */
+/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_BE */
+/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_S16_LE */
+/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_BE */
+/* #define AOUT_FORMAT_DEFAULT          AOUT_FMT_U16_LE */
+
 /* Environment variable for stereo, and default value */
 #define AOUT_STEREO_VAR                 "vlc_stereo"
 #define AOUT_STEREO_DEFAULT             1
 
+/* Environment variable for spdif mode */
+#define AOUT_SPDIF_VAR                  "vlc_spdif"
+#define AOUT_SPDIF_DEFAULT              0
+
+/* Volume */
+#define VOLUME_DEFAULT                  512
+#define VOLUME_STEP                     128
+#define VOLUME_MAX                      1024
+
 /* Environment variable for output rate, and default value */
 #define AOUT_RATE_VAR                   "vlc_audio_rate"
 #define AOUT_RATE_DEFAULT               44100
 
+/* Number of audio output frames contained in an audio output fifo.
+ * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
+ * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
+ * With 511 we have at least 511*384/2/48000=2 seconds of sound */
+#define AOUT_FIFO_SIZE                  511
+
+/* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
+ * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
+ * operations with '>>' and '<<' (gcc changes this at compilation-time) */
+#define AOUT_MAX_FIFOS                  2
+
+/* Duration (in microseconds) of an audio output buffer should be :
+ * - short, in order to be able to play a new song very quickly (especially a
+ *   song from the interface)
+ * - long, in order to perform the buffer calculations as few as possible */
+#define AOUT_BUFFER_DURATION            100000
+
 /*****************************************************************************
  * Video configuration
  *****************************************************************************/
 /* Environment variable containing the display method */
 #define VOUT_METHOD_VAR                 "vlc_vout"
 
-/* The fallback method */
-#define VOUT_DEFAULT_METHOD             "x11"
+/* Environment variable containing the motion compensation method */
+#define MOTION_METHOD_VAR               "vlc_motion"
+
+/* Environment variable containing the IDCT method */
+#define IDCT_METHOD_VAR                 "vlc_idct"
+
+/* Environment variable containing the YUV method */
+#define YUV_METHOD_VAR                  "vlc_yuv"
 
 /* Environment variable used in place of DISPLAY if available */
 #define VOUT_DISPLAY_VAR                "vlc_display"
 
 /* Default dimensions for display window - these dimensions are enough for the
- * standard width and height broadcasted MPEG-2 streams */
+ * standard width and height broadcasted MPEG-2 streams or DVDs */
 #define VOUT_WIDTH_VAR                  "vlc_width"
 #define VOUT_HEIGHT_VAR                 "vlc_height"
 #define VOUT_WIDTH_DEFAULT              720
 
 /* Video heap size - remember that a decompressed picture is big
  * (~1 Mbyte) before using huge values */
-#define VOUT_MAX_PICTURES               10
+#define VOUT_MAX_PICTURES               5
+
+/* Number of simultaneous subpictures */
+#define VOUT_MAX_SUBPICTURES            5
 
 /* Maximum number of active areas in a rendering buffer. Active areas are areas
  * of the picture which need to be cleared before re-using the buffer. If a
 #define VOUT_GRAYSCALE_VAR              "vlc_grayscale"
 #define VOUT_GRAYSCALE_DEFAULT          0
 
+/* Environment variable for fullscreen mode, and default value */
+#define VOUT_FULLSCREEN_VAR             "vlc_fullscreen"
+#define VOUT_FULLSCREEN_DEFAULT         0
+
+/* Environment variable for overlay mode, and default value */
+#define VOUT_OVERLAY_VAR                "vlc_overlay"
+#define VOUT_OVERLAY_DEFAULT            0
+
 /* Default gamma */
 #define VOUT_GAMMA                      0.
 
 #define VOUT_DEFAULT_FONT               "default8x9.psf"
 #define VOUT_LARGE_FONT                 "default8x16.psf"
 
+/* Statistics are displayed every n loops (=~ pictures) */
+#define VOUT_STATS_NB_LOOPS             100
+
 /*
  * Time settings
  */
 /* Number of pictures required to computes the FPS rate */
 #define VOUT_FPS_SAMPLES                20
 
+/* Better be in advance when awakening than late... */
+#define VOUT_MWAIT_TOLERANCE            ((int)(0.020*CLOCK_FREQ))
+
 /*
  * Framebuffer settings
  */
 #define VOUT_FB_DEV_VAR                 "vlc_fb_dev"
 #define VOUT_FB_DEV_DEFAULT             "/dev/fb0"
 
+/* The default video output window title */
+#define VOUT_TITLE                      "VideoLAN Client @VLC_VERSION@"
+
 /*****************************************************************************
  * Video parser configuration
  *****************************************************************************/
  * 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. */
-#define VPAR_OUTMEM_SLEEP               ((int)(0.050*CLOCK_FREQ))
+#define VPAR_OUTMEM_SLEEP               ((int)(0.020*CLOCK_FREQ))
 
 /* Optimization level, from 0 to 2 - 1 is generally a good compromise. Remember
  * that raising this level dramatically lengthens the compilation time. */
-#define VPAR_OPTIM_LEVEL                1
+#define VPAR_OPTIM_LEVEL                2
 
 /* The following directives only apply if you define VDEC_SMP below. */
 
 /* Maximum number of macroblocks in a picture. */
 #define MAX_MB                          2048
 
+/* The synchro variable name */
+#define VPAR_SYNCHRO_VAR                "vlc_synchro"
+
 /*****************************************************************************
  * Video decoder configuration
  *****************************************************************************/
 /* Maximum range of values out of the IDCT + motion compensation. */
 #define VDEC_CROPRANGE                  2048
 
+/* Nice increments for decoders -- necessary for x11 scheduling */
+#define VDEC_NICE                       3
+
 /*****************************************************************************
  * Generic decoder configuration
  *****************************************************************************/
  * queue are printed by the calling thread */
 #define INTF_MSG_QSIZE                  64
 
-/* Define to enable messages queues - disabling messages queue can be usefull
- * when debugging, since it allows messages which would not otherwise be printed,
- * due to a crash, to be printed anyway */
+/* Interface warnig message level */
+#define INTF_WARNING_VAR                "warning_level"
+#define INTF_WARNING_DEFAULT            12
+
+/* Define to enable messages queues - disabling messages queue can be useful
+ * when debugging, since it allows messages which would not be printed
+ * due to a crash to be printed anyway */
 #ifndef DEBUG
 #define INTF_MSG_QUEUE
 #endif
  * message function was called */
 #define INTF_MSG_DBG_FORMAT             "## %s:%s(),%i: "
 
-/* Maximal number of arguments on a command line, including the function name */
+/* Max number of arguments on a command line, including the function name */
 #define INTF_MAX_ARGS                   20
 
 /* Maximal size of a command line in a script */
 /* Maximal number of commands which can be saved in history list */
 #define INTF_CONSOLE_MAX_HISTORY        20
 
-/*****************************************************************************
- * Synchro configuration
- *****************************************************************************/
-
-#define VOUT_SYNCHRO_LEVEL_START        5
-#define VOUT_SYNCHRO_LEVEL_MAX          15
-#define VOUT_SYNCHRO_HEAP_IDEAL_SIZE    5