vlc_aout.h 11 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_aout.h : audio output interface
3
 *****************************************************************************
4
 * Copyright (C) 2002-2011 the VideoLAN team
5
 *
6
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
7 8 9 10 11
 *
 * 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.
12
 *
13 14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
17
 *
18 19
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21
 *****************************************************************************/
zorglub's avatar
zorglub committed
22

23 24
#ifndef VLC_AOUT_H
#define VLC_AOUT_H 1
zorglub's avatar
zorglub committed
25

26 27 28 29 30
/**
 * \file
 * This file defines functions, structures and macros for audio output object
 */

31 32 33 34 35
/* Max number of pre-filters per input, and max number of post-filters */
#define AOUT_MAX_FILTERS                10

/* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
 * will be considered as bogus and be trashed */
36
#define AOUT_MAX_ADVANCE_TIME           (AOUT_MAX_PREPARE_TIME + CLOCK_FREQ)
37 38 39

/* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
 * will cause the calling thread to sleep */
40
#define AOUT_MAX_PREPARE_TIME           (2 * CLOCK_FREQ)
41 42 43

/* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
 * to avoid too heavy resampling */
44
#define AOUT_MIN_PREPARE_TIME           AOUT_MAX_PTS_ADVANCE
45

46 47 48 49 50 51 52 53
/* Tolerance values from EBU Recommendation 37 */
/** Maximum advance of actual audio playback time to coded PTS,
 * above which downsampling will be performed */
#define AOUT_MAX_PTS_ADVANCE            (CLOCK_FREQ / 25)

/** Maximum delay of actual audio playback time from coded PTS,
 * above which upsampling will be performed */
#define AOUT_MAX_PTS_DELAY              (3 * CLOCK_FREQ / 50)
54 55 56

/* Max acceptable resampling (in %) */
#define AOUT_MAX_RESAMPLING             10
57

58
#include "vlc_es.h"
Michel Kaempf's avatar
Michel Kaempf committed
59

60
#define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
61
    ((p_first)->i_format == (p_second)->i_format)                           \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
62
      && AOUT_FMTS_SIMILAR(p_first, p_second) )
63

64 65 66
/* 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)                               \
67 68
      && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
      && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
69

70 71
#define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
#define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
72

73 74 75 76 77
#define AOUT_FMT_NON_LINEAR( p_format )                 \
    ( ((p_format)->i_format == VLC_CODEC_SPDIFL)       \
       || ((p_format)->i_format == VLC_CODEC_SPDIFB)   \
       || ((p_format)->i_format == VLC_CODEC_A52)       \
       || ((p_format)->i_format == VLC_CODEC_DTS) )
78

79 80 81 82
/* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
/*
 * Fixed-point format: 0xABBBBBBB
 * A == whole part      (sign + 3 bits)
83
 * B == fractional part (28 bits)
84 85 86 87 88 89 90 91 92 93
 *
 * 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.
94
 *
95 96 97 98
 * 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.)
 */
99
typedef int32_t vlc_fixed_t;
100 101 102 103 104
#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)

105 106 107 108 109 110 111 112 113 114 115
/*
 * Channels descriptions
 */

/* 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
116 117 118
#define AOUT_CHAN_MIDDLELEFT        0x100
#define AOUT_CHAN_MIDDLERIGHT       0x200
#define AOUT_CHAN_LFE               0x1000
119 120 121 122

/* Values available for original channels only */
#define AOUT_CHAN_DOLBYSTEREO       0x10000
#define AOUT_CHAN_DUALMONO          0x20000
Christophe Massiot's avatar
Christophe Massiot committed
123
#define AOUT_CHAN_REVERSESTEREO     0x40000
124 125

#define AOUT_CHAN_PHYSMASK          0xFFFF
126
#define AOUT_CHAN_MAX               9
127

gbazin's avatar
 
gbazin committed
128 129 130
/* Values used for the audio-device and audio-channels object variables */
#define AOUT_VAR_MONO               1
#define AOUT_VAR_STEREO             2
131 132 133 134 135 136
#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
gbazin's avatar
 
gbazin committed
137 138 139 140 141 142

#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
143

144
/*****************************************************************************
zorglub's avatar
zorglub committed
145
 * Main audio output structures
146
 *****************************************************************************/
zorglub's avatar
zorglub committed
147

148
#define aout_BufferFree( buffer ) block_Release( buffer )
zorglub's avatar
zorglub committed
149

Christophe Massiot's avatar
Christophe Massiot committed
150 151
/* Size of a frame for S/PDIF output. */
#define AOUT_SPDIF_SIZE 6144
152

153
/* Number of samples in an A/52 frame. */
154
#define A52_FRAME_NB 1536
155

zorglub's avatar
zorglub committed
156 157 158 159 160
/** audio output buffer FIFO */
struct aout_fifo_t
{
    aout_buffer_t *         p_first;
    aout_buffer_t **        pp_last;
161
    date_t                  end_date;
zorglub's avatar
zorglub committed
162 163
};

164
/* FIXME to remove once aout.h is cleaned a bit more */
165
#include <vlc_block.h>
166

167 168
struct aout_mixer_t;

169 170
typedef int (*aout_volume_cb) (audio_output_t *, float, bool);

171
/** Audio output object */
172
struct audio_output
zorglub's avatar
zorglub committed
173 174 175
{
    VLC_COMMON_MEMBERS

176 177 178
    /* Lock for volume variables (FIXME: should be in input manager) */
    vlc_mutex_t             volume_lock;
    vlc_mutex_t             lock;
zorglub's avatar
zorglub committed
179 180

    /* Input streams & pre-filters */
181
    aout_input_t *          p_input;
zorglub's avatar
zorglub committed
182 183

    /* Mixer */
184 185
    audio_sample_format_t   mixer_format;
    float                   mixer_multiplier;
186
    struct aout_mixer_t    *p_mixer;
zorglub's avatar
zorglub committed
187

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    audio_sample_format_t format; /**< Output format (plugin can modify it
        only when succesfully probed and not afterward) */

    /* Indicates whether the audio output is currently starving, to avoid
     * printing a 1,000 "output is starving" messages. */
    bool              b_starving;

    /* post-filters */
    filter_t *              pp_filters[AOUT_MAX_FILTERS];
    int                     i_nb_filters;

    aout_fifo_t             fifo;

    struct module_t *module; /**< Output plugin */
    struct aout_sys_t *sys; /**< Output plugin private data */
203 204
    void (*pf_play)( audio_output_t * ); /**< Audio buffer callback */
    void (* pf_pause)( audio_output_t *, bool, mtime_t ); /**< Pause/resume
205
        callback (optional, may be NULL) */
206 207
    void (* pf_flush)( audio_output_t *, bool ); /**< Flush/drain callback
        (optional, may be NULL) */
208
    aout_volume_cb          pf_volume_set; /**< Volume setter (or NULL) */
209
    int                     i_nb_samples;
zorglub's avatar
zorglub committed
210 211
};

212
/**
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
213
 * It describes the audio channel order VLC expect.
214 215 216 217 218 219 220 221 222
 */
static const uint32_t pi_vlc_chan_order_wg4[] =
{
    AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
    AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
    AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
    AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
};

223
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
224
 * Prototypes
225
 *****************************************************************************/
zorglub's avatar
zorglub committed
226

227
VLC_API aout_buffer_t * aout_OutputNextBuffer( audio_output_t *, mtime_t, bool ) VLC_USED;
zorglub's avatar
zorglub committed
228

229 230 231 232 233 234
/**
 * This function computes the reordering needed to go from pi_chan_order_in to
 * pi_chan_order_out.
 * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
 * internal (WG4) order is requested.
 */
235 236
VLC_API int aout_CheckChannelReorder( const uint32_t *pi_chan_order_in, const uint32_t *pi_chan_order_out, uint32_t i_channel_mask, int i_channels, int *pi_chan_table );
VLC_API void aout_ChannelReorder( uint8_t *, int, int, const int *, int );
237

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
/**
 * This fonction will compute the extraction parameter into pi_selection to go
 * from i_channels with their type given by pi_order_src[] into the order
 * describe by pi_order_dst.
 * It will also set :
 * - *pi_channels as the number of channels that will be extracted which is
 * lower (in case of non understood channels type) or equal to i_channels.
 * - the layout of the channels (*pi_layout).
 *
 * It will return true if channel extraction is really needed, in which case
 * aout_ChannelExtract must be used
 *
 * XXX It must be used when the source may have channel type not understood
 * by VLC. In this case the channel type pi_order_src[] must be set to 0.
 * XXX It must also be used if multiple channels have the same type.
 */
254
VLC_API bool aout_CheckChannelExtraction( int *pi_selection, uint32_t *pi_layout, int *pi_channels, const uint32_t pi_order_dst[AOUT_CHAN_MAX], const uint32_t *pi_order_src, int i_channels );
255 256 257 258 259 260 261 262

/**
 * Do the actual channels extraction using the parameters created by
 * aout_CheckChannelExtraction.
 *
 * XXX this function does not work in place (p_dst and p_src must not overlap).
 * XXX Only 8, 16, 24, 32, 64 bits per sample are supported.
 */
263
VLC_API void aout_ChannelExtract( void *p_dst, int i_dst_channels, const void *p_src, int i_src_channels, int i_sample_count, const int *pi_selection, int i_bits_per_sample );
264 265

/* */
266 267 268 269 270
static inline unsigned aout_FormatNbChannels(const audio_sample_format_t *fmt)
{
    return popcount(fmt->i_physical_channels & AOUT_CHAN_PHYSMASK);
}

271
VLC_API unsigned int aout_BitsPerSample( vlc_fourcc_t i_format ) VLC_USED;
272
VLC_API void aout_FormatPrepare( audio_sample_format_t * p_format );
273
VLC_API void aout_FormatPrint( audio_output_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format );
274
VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED;
zorglub's avatar
zorglub committed
275

276 277
VLC_API mtime_t aout_FifoFirstDate( const aout_fifo_t * ) VLC_USED;
VLC_API aout_buffer_t *aout_FifoPop( aout_fifo_t * p_fifo ) VLC_USED;
278

279
VLC_API void aout_VolumeNoneInit( audio_output_t * );
280 281 282 283
VLC_API void aout_VolumeSoftInit( audio_output_t * );
VLC_API void aout_VolumeHardInit( audio_output_t *, aout_volume_cb );
VLC_API void aout_VolumeHardSet( audio_output_t *, float, bool );

284
VLC_API int aout_ChannelsRestart( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * );
zorglub's avatar
zorglub committed
285

286
/* */
287
VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ) VLC_USED;
288

289
#endif /* VLC_AOUT_H */