git.sesse.net Git - vlc/blob - include/audio_output.h

   1 /*****************************************************************************
   2  * audio_output.h : audio output interface
   3  *****************************************************************************
   4  * Copyright (C) 2002 VideoLAN
   5  * $Id: audio_output.h,v 1.85 2003/11/16 22:54:11 gbazin Exp $
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23 #ifndef _VLC_AUDIO_OUTPUT_H
  24 #define _VLC_AUDIO_OUTPUT_H 1
  25
  26 /*****************************************************************************
  27  * audio_sample_format_t
  28  *****************************************************************************
  29  * This structure defines a format for audio samples.
  30  *****************************************************************************/
  31 struct audio_format_t
  32 {
  33     vlc_fourcc_t        i_format;
  34
  35     unsigned int        i_rate;
  36
  37     /* Describes the channels configuration of the samples (ie. number of
  38      * channels which are available in the buffer, and positions). */
  39     uint32_t            i_physical_channels;
  40
  41     /* Describes from which original channels, before downmixing, the
  42      * buffer is derived. */
  43     uint32_t            i_original_channels;
  44
  45     /* Optional - for A/52, SPDIF and DTS types : */
  46     /* Bytes used by one compressed frame, depends on bitrate. */
  47     unsigned int        i_bytes_per_frame;
  48
  49     /* Number of sampleframes contained in one compressed frame. */
  50     unsigned int        i_frame_length;
  51     /* Please note that it may be completely arbitrary - buffers are not
  52      * obliged to contain a integral number of so-called "frames". It's
  53      * just here for the division :
  54      * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
  55      */
  56
  57     /* FIXME ? (used by the codecs) */
  58     int i_channels;
  59     int i_blockalign;
  60     int i_bitspersample;
  61 };
  62
  63 #define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
  64     ((p_first)->i_format == (p_second)->i_format)                           \
  65       && ((p_first)->i_rate == (p_second)->i_rate)                          \
  66       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
  67       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
  68
  69 /* Check if i_rate == i_rate and i_channels == i_channels */
  70 #define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            \
  71     ((p_first)->i_rate == (p_second)->i_rate)                               \
  72       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
  73       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
  74
  75 #ifdef WORDS_BIGENDIAN
  76 #   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','b')
  77 #   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','b')
  78 #else
  79 #   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','l')
  80 #   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','l')
  81 #endif
  82
  83 #define AOUT_FMT_NON_LINEAR( p_format )                                    \
  84     ( ((p_format)->i_format == VLC_FOURCC('s','p','d','i'))                \
  85        || ((p_format)->i_format == VLC_FOURCC('a','5','2',' '))            \
  86        || ((p_format)->i_format == VLC_FOURCC('d','t','s',' ')) )
  87
  88 /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
  89 /*
  90  * Fixed-point format: 0xABBBBBBB
  91  * A == whole part      (sign + 3 bits)
  92  * B == fractional part (28 bits)
  93  *
  94  * Values are signed two's complement, so the effective range is:
  95  * 0x80000000 to 0x7fffffff
  96  *       -8.0 to +7.9999999962747097015380859375
  97  *
  98  * The smallest representable value is:
  99  * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
 100  *
 101  * 28 bits of fractional accuracy represent about
 102  * 8.6 digits of decimal accuracy.
 103  *
 104  * Fixed-point numbers can be added or subtracted as normal
 105  * integers, but multiplication requires shifting the 64-bit result
 106  * from 56 fractional bits back to 28 (and rounding.)
 107  */
 108 typedef int32_t vlc_fixed_t;
 109 #define FIXED32_FRACBITS 28
 110 #define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
 111 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
 112 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
 113
 114
 115 /*
 116  * Channels descriptions
 117  */
 118
 119 /* Values available for physical and original channels */
 120 #define AOUT_CHAN_CENTER            0x1
 121 #define AOUT_CHAN_LEFT              0x2
 122 #define AOUT_CHAN_RIGHT             0x4
 123 #define AOUT_CHAN_REARCENTER        0x10
 124 #define AOUT_CHAN_REARLEFT          0x20
 125 #define AOUT_CHAN_REARRIGHT         0x40
 126 #define AOUT_CHAN_MIDDLELEFT        0x100
 127 #define AOUT_CHAN_MIDDLERIGHT       0x200
 128 #define AOUT_CHAN_LFE               0x1000
 129
 130 /* Values available for original channels only */
 131 #define AOUT_CHAN_DOLBYSTEREO       0x10000
 132 #define AOUT_CHAN_DUALMONO          0x20000
 133 #define AOUT_CHAN_REVERSESTEREO     0x40000
 134
 135 #define AOUT_CHAN_PHYSMASK          0xFFFF
 136
 137 /* Values used for the audio-device and audio-channels object variables */
 138 #define AOUT_VAR_MONO               1
 139 #define AOUT_VAR_STEREO             2
 140 #define AOUT_VAR_2F2R               4
 141 #define AOUT_VAR_3F2R               5
 142 #define AOUT_VAR_5_1                6
 143 #define AOUT_VAR_6_1                7
 144 #define AOUT_VAR_7_1                8
 145 #define AOUT_VAR_SPDIF              10
 146
 147 #define AOUT_VAR_CHAN_STEREO        1
 148 #define AOUT_VAR_CHAN_RSTEREO       2
 149 #define AOUT_VAR_CHAN_LEFT          3
 150 #define AOUT_VAR_CHAN_RIGHT         4
 151 #define AOUT_VAR_CHAN_DOLBYS        5
 152
 153 /*****************************************************************************
 154  * aout_buffer_t : audio output buffer
 155  *****************************************************************************/
 156 struct aout_buffer_t
 157 {
 158     byte_t *                p_buffer;
 159     int                     i_alloc_type;
 160     /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
 161      * is the number of significative bytes in it. */
 162     size_t                  i_size, i_nb_bytes;
 163     unsigned int            i_nb_samples;
 164     mtime_t                 start_date, end_date;
 165
 166     struct aout_buffer_t *  p_next;
 167 };
 168
 169 /* Size of a frame for S/PDIF output. */
 170 #define AOUT_SPDIF_SIZE 6144
 171
 172 /* Number of samples in an A/52 frame. */
 173 #define A52_FRAME_NB 1536
 174
 175 /*****************************************************************************
 176  * audio_date_t : date incrementation without long-term rounding errors
 177  *****************************************************************************/
 178 struct audio_date_t
 179 {
 180     mtime_t  date;
 181     uint32_t i_divider;
 182     uint32_t i_remainder;
 183 };
 184
 185 /*****************************************************************************
 186  * Prototypes
 187  *****************************************************************************/
 188 /* From common.c : */
 189 #define aout_New(a) __aout_New(VLC_OBJECT(a))
 190 VLC_EXPORT( aout_instance_t *, __aout_New, ( vlc_object_t * ) );
 191 VLC_EXPORT( void, aout_Delete, ( aout_instance_t * ) );
 192 VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, uint32_t ) );
 193 VLC_EXPORT( void, aout_DateSet, ( audio_date_t *, mtime_t ) );
 194 VLC_EXPORT( void, aout_DateMove, ( audio_date_t *, mtime_t ) );
 195 VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) );
 196 VLC_EXPORT( mtime_t, aout_DateIncrement, ( audio_date_t *, uint32_t ) );
 197
 198 /* From dec.c : */
 199 #define aout_DecNew(a, b, c) __aout_DecNew(VLC_OBJECT(a), b, c)
 200 VLC_EXPORT( aout_input_t *, __aout_DecNew, ( vlc_object_t *, aout_instance_t **, audio_sample_format_t * ) );
 201 VLC_EXPORT( int, aout_DecDelete, ( aout_instance_t *, aout_input_t * ) );
 202 VLC_EXPORT( aout_buffer_t *, aout_DecNewBuffer, ( aout_instance_t *, aout_input_t *, size_t ) );
 203 VLC_EXPORT( void, aout_DecDeleteBuffer, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
 204 VLC_EXPORT( int, aout_DecPlay, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
 205
 206 /* From intf.c : */
 207 #define aout_VolumeGet(a, b) __aout_VolumeGet(VLC_OBJECT(a), b)
 208 VLC_EXPORT( int, __aout_VolumeGet, ( vlc_object_t *, audio_volume_t * ) );
 209 #define aout_VolumeSet(a, b) __aout_VolumeSet(VLC_OBJECT(a), b)
 210 VLC_EXPORT( int, __aout_VolumeSet, ( vlc_object_t *, audio_volume_t ) );
 211 #define aout_VolumeInfos(a, b) __aout_VolumeInfos(VLC_OBJECT(a), b)
 212 VLC_EXPORT( int, __aout_VolumeInfos, ( vlc_object_t *, audio_volume_t * ) );
 213 #define aout_VolumeUp(a, b, c) __aout_VolumeUp(VLC_OBJECT(a), b, c)
 214 VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
 215 #define aout_VolumeDown(a, b, c) __aout_VolumeDown(VLC_OBJECT(a), b, c)
 216 VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
 217 #define aout_VolumeMute(a, b) __aout_VolumeMute(VLC_OBJECT(a), b)
 218 VLC_EXPORT( int, __aout_VolumeMute, ( vlc_object_t *, audio_volume_t * ) );
 219 VLC_EXPORT( int, aout_Restart, ( aout_instance_t * p_aout ) );
 220 VLC_EXPORT( int, aout_FindAndRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 221 VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 222
 223 #endif /* _VLC_AUDIO_OUTPUT_H */