]> git.sesse.net Git - vlc/blobdiff - include/audio_output.h
include/vlc_es.h: defines es_format_t, audio_format_t, video_format_t.
[vlc] / include / audio_output.h
index 5ec00f15d2e51630fd410167af558b4205533f51..8464511d646f8c7075c417178bb2d60e0dcbbc3f 100644 (file)
-/******************************************************************************
- * audio_output.h : audio output thread interface
- * (c)1999 VideoLAN
- ******************************************************************************
- * Required headers:
- * - <pthread.h>                                                  ( pthread_t )
- * - <sys/soundcard.h>                                       ( audio_buf_info )
- * - "common.h"                                                   ( boolean_t )
- * - "mtime.h"                                                      ( mtime_t )
- ******************************************************************************/
-
-/* TODO :
+/*****************************************************************************
+ * audio_output.h : audio output interface
+ *****************************************************************************
+ * Copyright (C) 2002 VideoLAN
+ * $Id: audio_output.h,v 1.86 2003/11/20 22:10:55 fenrir Exp $
  *
- * - Créer un flag destroy dans les fifos audio pour indiquer au thread audio
- *   qu'il peut libérer la mémoire occupée par le buffer de la fifo lorsqu'il
- *   le désire (fin du son ou fin du thread)
- * - Redéplacer les #define dans config.h
+ * Authors: Christophe Massiot <massiot@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.
+ *
+ * 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.
+ *****************************************************************************/
+#ifndef _VLC_AUDIO_OUTPUT_H
+#define _VLC_AUDIO_OUTPUT_H 1
+
+#include "vlc_es.h"
+
+#define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
+    ((p_first)->i_format == (p_second)->i_format)                           \
+      && ((p_first)->i_rate == (p_second)->i_rate)                          \
+      && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
+      && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
+
+/* Check if i_rate == i_rate and i_channels == i_channels */
+#define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            \
+    ((p_first)->i_rate == (p_second)->i_rate)                               \
+      && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
+      && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
+
+#ifdef WORDS_BIGENDIAN
+#   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','b')
+#   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','b')
+#else
+#   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','l')
+#   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','l')
+#endif
+
+#define AOUT_FMT_NON_LINEAR( p_format )                                    \
+    ( ((p_format)->i_format == VLC_FOURCC('s','p','d','i'))                \
+       || ((p_format)->i_format == VLC_FOURCC('a','5','2',' '))            \
+       || ((p_format)->i_format == VLC_FOURCC('d','t','s',' ')) )
+
+/* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
 /*
- * Defines => "config.h"
+ * Fixed-point format: 0xABBBBBBB
+ * A == whole part      (sign + 3 bits)
+ * B == fractional part (28 bits)
+ *
+ * Values are signed two's complement, so the effective range is:
+ * 0x80000000 to 0x7fffffff
+ *       -8.0 to +7.9999999962747097015380859375
+ *
+ * The smallest representable value is:
+ * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
+ *
+ * 28 bits of fractional accuracy represent about
+ * 8.6 digits of decimal accuracy.
+ *
+ * Fixed-point numbers can be added or subtracted as normal
+ * integers, but multiplication requires shifting the 64-bit result
+ * from 56 fractional bits back to 28 (and rounding.)
  */
+typedef int32_t vlc_fixed_t;
+#define FIXED32_FRACBITS 28
+#define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
+#define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
+#define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
 
-/* Default output device. You probably should not change this. */
-#define AOUT_DEFAULT_DEVICE     "/dev/dsp"
-
-/* Default audio output format (AFMT_S16_NE = Native Endianess) */
-#define AOUT_DEFAULT_FORMAT     AFMT_S16_NE
-
-/* Default stereo mode (0 stands for mono, 1 for stereo) */
-#define AOUT_DEFAULT_STEREO     1
-
-/* Audio output rate, in Hz */
-#define AOUT_MIN_RATE           22050 /* ?? */
-#define AOUT_DEFAULT_RATE       44100
-#define AOUT_MAX_RATE           48000
-
-/* Number of audio samples (s16 integers) contained in an audio output frame...
- * - Layer I        : a decoded frame contains 384 samples
- * - Layer II & III : a decoded frame contains 1152 = 3*384 samples */
-#define AOUT_FRAME_SIZE         384
-
-/* 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          4
-
-/* 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
 
 /*
- * Macros
+ * Channels descriptions
  */
-#define AOUT_FIFO_ISEMPTY( fifo )       ( (fifo).l_end_frame == (fifo).i_start_frame )
-#define AOUT_FIFO_ISFULL( fifo )        ( ((((fifo).l_end_frame + 1) - (fifo).l_start_frame) & AOUT_FIFO_SIZE) == 0 )
 
-/******************************************************************************
- * aout_dsp_t
- ******************************************************************************/
-typedef struct
+/* Values available for physical and original channels */
+#define AOUT_CHAN_CENTER            0x1
+#define AOUT_CHAN_LEFT              0x2
+#define AOUT_CHAN_RIGHT             0x4
+#define AOUT_CHAN_REARCENTER        0x10
+#define AOUT_CHAN_REARLEFT          0x20
+#define AOUT_CHAN_REARRIGHT         0x40
+#define AOUT_CHAN_MIDDLELEFT        0x100
+#define AOUT_CHAN_MIDDLERIGHT       0x200
+#define AOUT_CHAN_LFE               0x1000
+
+/* Values available for original channels only */
+#define AOUT_CHAN_DOLBYSTEREO       0x10000
+#define AOUT_CHAN_DUALMONO          0x20000
+#define AOUT_CHAN_REVERSESTEREO     0x40000
+
+#define AOUT_CHAN_PHYSMASK          0xFFFF
+
+/* Values used for the audio-device and audio-channels object variables */
+#define AOUT_VAR_MONO               1
+#define AOUT_VAR_STEREO             2
+#define AOUT_VAR_2F2R               4
+#define AOUT_VAR_3F2R               5
+#define AOUT_VAR_5_1                6
+#define AOUT_VAR_6_1                7
+#define AOUT_VAR_7_1                8
+#define AOUT_VAR_SPDIF              10
+
+#define AOUT_VAR_CHAN_STEREO        1
+#define AOUT_VAR_CHAN_RSTEREO       2
+#define AOUT_VAR_CHAN_LEFT          3
+#define AOUT_VAR_CHAN_RIGHT         4
+#define AOUT_VAR_CHAN_DOLBYS        5
+
+/*****************************************************************************
+ * aout_buffer_t : audio output buffer
+ *****************************************************************************/
+struct aout_buffer_t
 {
-    /* Path to the audio output device (default is set to "/dev/dsp") */
-    char *              psz_device;
-    int                 i_fd;
-
-    /* Format of the audio output samples (see <sys/soundcard.h>) */
-    int                 i_format;
-    /* Following boolean is set to 0 if output sound is mono, 1 if stereo */
-    boolean_t           b_stereo;
-    /* Rate of the audio output sound (in Hz) */
-    long                l_rate;
-
-    /* Buffer information structure, used by aout_dspGetBufInfo() to store the
-     * current state of the internal sound card buffer */
-    audio_buf_info      buf_info;
-
-} aout_dsp_t;
-
-/******************************************************************************
- * aout_increment_t
- ******************************************************************************
- * This structure is used to keep the progression of an index up-to-date, in
- * order to avoid rounding problems and heavy computations, as the function
- * that handles this structure only uses additions.
- ******************************************************************************/
-typedef struct
+    byte_t *                p_buffer;
+    int                     i_alloc_type;
+    /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
+     * is the number of significative bytes in it. */
+    size_t                  i_size, i_nb_bytes;
+    unsigned int            i_nb_samples;
+    mtime_t                 start_date, end_date;
+
+    struct aout_buffer_t *  p_next;
+};
+
+/* Size of a frame for S/PDIF output. */
+#define AOUT_SPDIF_SIZE 6144
+
+/* Number of samples in an A/52 frame. */
+#define A52_FRAME_NB 1536
+
+/*****************************************************************************
+ * audio_date_t : date incrementation without long-term rounding errors
+ *****************************************************************************/
+struct audio_date_t
 {
-    /* The remainder is used to keep track of the fractional part of the
-     * index. */
-    long                l_remainder;
-
-    /*
-     * The increment structure is initialized with the result of an euclidean
-     * division :
-     *
-     *  l_euclidean_numerator                           l_euclidean_remainder
-     * ----------------------- = l_euclidean_integer + -----------------------
-     * l_euclidean_denominator                         l_euclidean_denominator
-     *
-     */
-    long                l_euclidean_integer;
-    long                l_euclidean_remainder;
-    long                l_euclidean_denominator;
-
-} aout_increment_t;
-
-/******************************************************************************
- * aout_frame_t
- ******************************************************************************/
-typedef s16 aout_frame_t[ AOUT_FRAME_SIZE ];
-
-/******************************************************************************
- * aout_fifo_t
- ******************************************************************************/
-typedef struct
-{
-    /* See the fifo types below */
-    int                 i_type;
-    boolean_t           b_die;
-
-    boolean_t           b_stereo;
-    long                l_rate;
-
-    pthread_mutex_t     data_lock;
-    pthread_cond_t      data_wait;
-
-    void *              buffer;
-    mtime_t *           date;
-    /* The start frame is the first frame in the buffer that contains decoded
-     * audio data. It it also the first frame in the current timestamped frame
-     * area, ie the first dated frame in the decoded part of the buffer. :-p */
-    long                l_start_frame;
-    boolean_t           b_start_frame;
-    /* The next frame is the end frame of the current timestamped frame area,
-     * ie the first dated frame after the start frame. */
-    long                l_next_frame;
-    boolean_t           b_next_frame;
-    /* The end frame is the first frame, after the start frame, that doesn't
-     * contain decoded audio data. That's why the end frame is the first frame
-     * where the audio decoder can store its decoded audio frames. */
-    long                l_end_frame;
-
-    long                l_unit;
-    aout_increment_t    unit_increment;
-    /* The following variable is used to store the number of remaining audio
-     * units in the current timestamped frame area. */
-    long                l_units;
-
-} aout_fifo_t;
-
-#define AOUT_EMPTY_FIFO         0
-#define AOUT_INTF_MONO_FIFO     1
-#define AOUT_INTF_STEREO_FIFO   2
-#define AOUT_ADEC_MONO_FIFO     3
-#define AOUT_ADEC_STEREO_FIFO   4
-
-/******************************************************************************
- * aout_thread_t
- ******************************************************************************/
-typedef struct aout_thread_s
-{
-    pthread_t           thread_id;
-    boolean_t           b_die;
-
-    aout_dsp_t          dsp;
-
-    pthread_mutex_t     fifos_lock;
-    aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];
-
-    void *              buffer;
-    /* The s32 buffer is used to mix all the audio fifos together before
-     * converting them and storing them in the audio output buffer */
-    s32 *               s32_buffer;
-
-    /* The size of the audio output buffer is kept in audio units, as this is
-     * the only unit that is common with every audio decoder and audio fifo */
-    long                l_units;
-
-    mtime_t             date;
-    /* date is the moment where the first audio unit of the output buffer
-     * should be played and is kept up-to-date with the following incremental
-     * structure */
-    aout_increment_t    date_increment;
-
-} aout_thread_t;
+    mtime_t  date;
+    uint32_t i_divider;
+    uint32_t i_remainder;
+};
 
-/******************************************************************************
+/*****************************************************************************
  * Prototypes
- ******************************************************************************/
-int             aout_Open               ( aout_thread_t *p_aout );
-int             aout_SpawnThread        ( aout_thread_t *p_aout );
-void            aout_CancelThread       ( aout_thread_t *p_aout );
-void            aout_Close              ( aout_thread_t *p_aout );
-
-aout_fifo_t *   aout_CreateFifo         ( aout_thread_t *p_aout, aout_fifo_t *p_fifo );
-void            aout_DestroyFifo        ( aout_fifo_t *p_fifo );
+ *****************************************************************************/
+/* From common.c : */
+#define aout_New(a) __aout_New(VLC_OBJECT(a))
+VLC_EXPORT( aout_instance_t *, __aout_New, ( vlc_object_t * ) );
+VLC_EXPORT( void, aout_Delete, ( aout_instance_t * ) );
+VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, uint32_t ) );
+VLC_EXPORT( void, aout_DateSet, ( audio_date_t *, mtime_t ) );
+VLC_EXPORT( void, aout_DateMove, ( audio_date_t *, mtime_t ) );
+VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) );
+VLC_EXPORT( mtime_t, aout_DateIncrement, ( audio_date_t *, uint32_t ) );
+
+/* From dec.c : */
+#define aout_DecNew(a, b, c) __aout_DecNew(VLC_OBJECT(a), b, c)
+VLC_EXPORT( aout_input_t *, __aout_DecNew, ( vlc_object_t *, aout_instance_t **, audio_sample_format_t * ) );
+VLC_EXPORT( int, aout_DecDelete, ( aout_instance_t *, aout_input_t * ) );
+VLC_EXPORT( aout_buffer_t *, aout_DecNewBuffer, ( aout_instance_t *, aout_input_t *, size_t ) );
+VLC_EXPORT( void, aout_DecDeleteBuffer, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
+VLC_EXPORT( int, aout_DecPlay, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
+
+/* From intf.c : */
+#define aout_VolumeGet(a, b) __aout_VolumeGet(VLC_OBJECT(a), b)
+VLC_EXPORT( int, __aout_VolumeGet, ( vlc_object_t *, audio_volume_t * ) );
+#define aout_VolumeSet(a, b) __aout_VolumeSet(VLC_OBJECT(a), b)
+VLC_EXPORT( int, __aout_VolumeSet, ( vlc_object_t *, audio_volume_t ) );
+#define aout_VolumeInfos(a, b) __aout_VolumeInfos(VLC_OBJECT(a), b)
+VLC_EXPORT( int, __aout_VolumeInfos, ( vlc_object_t *, audio_volume_t * ) );
+#define aout_VolumeUp(a, b, c) __aout_VolumeUp(VLC_OBJECT(a), b, c)
+VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
+#define aout_VolumeDown(a, b, c) __aout_VolumeDown(VLC_OBJECT(a), b, c)
+VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
+#define aout_VolumeMute(a, b) __aout_VolumeMute(VLC_OBJECT(a), b)
+VLC_EXPORT( int, __aout_VolumeMute, ( vlc_object_t *, audio_volume_t * ) );
+VLC_EXPORT( int, aout_Restart, ( aout_instance_t * p_aout ) );
+VLC_EXPORT( int, aout_FindAndRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
+VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
+
+#endif /* _VLC_AUDIO_OUTPUT_H */