7a9d6e8ea3aa4faa80bc6b8acebb271acbc5ee91
[vlc.git] / include / vlc_aout.h
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  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 #ifndef VLC_AOUT_H
24 #define VLC_AOUT_H 1
25
26 /**
27  * \file
28  * This file defines functions, structures and macros for audio output object
29  */
30
31 /* Max number of pre-filters per input, and max number of post-filters */
32 #define AOUT_MAX_FILTERS                10
33
34 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
35  * will be considered as bogus and be trashed */
36 #define AOUT_MAX_ADVANCE_TIME           (AOUT_MAX_PREPARE_TIME + CLOCK_FREQ)
37
38 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
39  * will cause the calling thread to sleep */
40 #define AOUT_MAX_PREPARE_TIME           (2 * CLOCK_FREQ)
41
42 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
43  * to avoid too heavy resampling */
44 #define AOUT_MIN_PREPARE_TIME           AOUT_MAX_PTS_ADVANCE
45
46 /* Tolerance values from EBU Recommendation 37 */
47 /** Maximum advance of actual audio playback time to coded PTS,
48  * above which downsampling will be performed */
49 #define AOUT_MAX_PTS_ADVANCE            (CLOCK_FREQ / 25)
50
51 /** Maximum delay of actual audio playback time from coded PTS,
52  * above which upsampling will be performed */
53 #define AOUT_MAX_PTS_DELAY              (3 * CLOCK_FREQ / 50)
54
55 /* Max acceptable resampling (in %) */
56 #define AOUT_MAX_RESAMPLING             10
57
58 #include "vlc_es.h"
59
60 #define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
61     ((p_first)->i_format == (p_second)->i_format)                           \
62       && AOUT_FMTS_SIMILAR(p_first, p_second) )
63
64 /* Check if i_rate == i_rate and i_channels == i_channels */
65 #define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            \
66     ((p_first)->i_rate == (p_second)->i_rate)                               \
67       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
68       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
69
70 #define AOUT_FMT_LINEAR( p_format ) \
71     (aout_BitsPerSample((p_format)->i_format) != 0)
72
73 #define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
74 #define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
75
76 #define AOUT_FMT_SPDIF( p_format ) \
77     ( ((p_format)->i_format == VLC_CODEC_SPDIFL)       \
78        || ((p_format)->i_format == VLC_CODEC_SPDIFB)   \
79        || ((p_format)->i_format == VLC_CODEC_A52)       \
80        || ((p_format)->i_format == VLC_CODEC_DTS) )
81
82 /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
83 /*
84  * Fixed-point format: 0xABBBBBBB
85  * A == whole part      (sign + 3 bits)
86  * B == fractional part (28 bits)
87  *
88  * Values are signed two's complement, so the effective range is:
89  * 0x80000000 to 0x7fffffff
90  *       -8.0 to +7.9999999962747097015380859375
91  *
92  * The smallest representable value is:
93  * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
94  *
95  * 28 bits of fractional accuracy represent about
96  * 8.6 digits of decimal accuracy.
97  *
98  * Fixed-point numbers can be added or subtracted as normal
99  * integers, but multiplication requires shifting the 64-bit result
100  * from 56 fractional bits back to 28 (and rounding.)
101  */
102 typedef int32_t vlc_fixed_t;
103 #define FIXED32_FRACBITS 28
104 #define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
105 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
106 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
107
108 /*
109  * Channels descriptions
110  */
111
112 /* Values available for physical and original channels */
113 #define AOUT_CHAN_CENTER            0x1
114 #define AOUT_CHAN_LEFT              0x2
115 #define AOUT_CHAN_RIGHT             0x4
116 #define AOUT_CHAN_REARCENTER        0x10
117 #define AOUT_CHAN_REARLEFT          0x20
118 #define AOUT_CHAN_REARRIGHT         0x40
119 #define AOUT_CHAN_MIDDLELEFT        0x100
120 #define AOUT_CHAN_MIDDLERIGHT       0x200
121 #define AOUT_CHAN_LFE               0x1000
122
123 /* Values available for original channels only */
124 #define AOUT_CHAN_DOLBYSTEREO       0x10000
125 #define AOUT_CHAN_DUALMONO          0x20000
126 #define AOUT_CHAN_REVERSESTEREO     0x40000
127
128 #define AOUT_CHAN_PHYSMASK          0xFFFF
129 #define AOUT_CHAN_MAX               9
130
131 /* Values used for the audio-device and audio-channels object variables */
132 #define AOUT_VAR_MONO               1
133 #define AOUT_VAR_STEREO             2
134 #define AOUT_VAR_2F2R               4
135 #define AOUT_VAR_3F2R               5
136 #define AOUT_VAR_5_1                6
137 #define AOUT_VAR_6_1                7
138 #define AOUT_VAR_7_1                8
139 #define AOUT_VAR_SPDIF              10
140
141 #define AOUT_VAR_CHAN_STEREO        1
142 #define AOUT_VAR_CHAN_RSTEREO       2
143 #define AOUT_VAR_CHAN_LEFT          3
144 #define AOUT_VAR_CHAN_RIGHT         4
145 #define AOUT_VAR_CHAN_DOLBYS        5
146
147 /*****************************************************************************
148  * Main audio output structures
149  *****************************************************************************/
150
151 #define aout_BufferFree( buffer ) block_Release( buffer )
152
153 /* Size of a frame for S/PDIF output. */
154 #define AOUT_SPDIF_SIZE 6144
155
156 /* Number of samples in an A/52 frame. */
157 #define A52_FRAME_NB 1536
158
159 /* FIXME to remove once aout.h is cleaned a bit more */
160 #include <vlc_block.h>
161
162 typedef int (*aout_volume_cb) (audio_output_t *, float, bool);
163
164 /** Audio output object */
165 struct audio_output
166 {
167     VLC_COMMON_MEMBERS
168
169     audio_sample_format_t format; /**< Output format (plugin can modify it
170         only when succesfully probed and not afterward) */
171
172     struct aout_sys_t *sys; /**< Output plugin private data */
173     void (*pf_play)(audio_output_t *, block_t *); /**< Audio buffer callback */
174     void (* pf_pause)( audio_output_t *, bool, mtime_t ); /**< Pause/resume
175         callback (optional, may be NULL) */
176     void (* pf_flush)( audio_output_t *, bool ); /**< Flush/drain callback
177         (optional, may be NULL) */
178     aout_volume_cb          pf_volume_set; /**< Volume setter (or NULL) */
179 };
180
181 /**
182  * It describes the audio channel order VLC expect.
183  */
184 static const uint32_t pi_vlc_chan_order_wg4[] =
185 {
186     AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
187     AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
188     AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
189     AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
190 };
191
192 /*****************************************************************************
193  * Prototypes
194  *****************************************************************************/
195
196 /**
197  * This function computes the reordering needed to go from pi_chan_order_in to
198  * pi_chan_order_out.
199  * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
200  * internal (WG4) order is requested.
201  */
202 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 );
203 VLC_API void aout_ChannelReorder( uint8_t *, int, int, const int *, int );
204
205 /**
206  * This fonction will compute the extraction parameter into pi_selection to go
207  * from i_channels with their type given by pi_order_src[] into the order
208  * describe by pi_order_dst.
209  * It will also set :
210  * - *pi_channels as the number of channels that will be extracted which is
211  * lower (in case of non understood channels type) or equal to i_channels.
212  * - the layout of the channels (*pi_layout).
213  *
214  * It will return true if channel extraction is really needed, in which case
215  * aout_ChannelExtract must be used
216  *
217  * XXX It must be used when the source may have channel type not understood
218  * by VLC. In this case the channel type pi_order_src[] must be set to 0.
219  * XXX It must also be used if multiple channels have the same type.
220  */
221 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 );
222
223 /**
224  * Do the actual channels extraction using the parameters created by
225  * aout_CheckChannelExtraction.
226  *
227  * XXX this function does not work in place (p_dst and p_src must not overlap).
228  * XXX Only 8, 16, 24, 32, 64 bits per sample are supported.
229  */
230 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 );
231
232 /* */
233 static inline unsigned aout_FormatNbChannels(const audio_sample_format_t *fmt)
234 {
235     return popcount(fmt->i_physical_channels & AOUT_CHAN_PHYSMASK);
236 }
237
238 VLC_API unsigned int aout_BitsPerSample( vlc_fourcc_t i_format ) VLC_USED;
239 VLC_API void aout_FormatPrepare( audio_sample_format_t * p_format );
240 VLC_API void aout_FormatPrint(vlc_object_t *, const char *,
241                               const audio_sample_format_t *);
242 #define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f)
243 VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED;
244
245 VLC_API void aout_VolumeNoneInit( audio_output_t * );
246 VLC_API void aout_VolumeSoftInit( audio_output_t * );
247 VLC_API void aout_VolumeHardInit( audio_output_t *, aout_volume_cb );
248 VLC_API void aout_VolumeHardSet( audio_output_t *, float, bool );
249
250 VLC_API void aout_TimeReport(audio_output_t *, mtime_t);
251
252 VLC_API int aout_ChannelsRestart( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * );
253
254 /* */
255 VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ) VLC_USED;
256
257 /** Audio output buffer FIFO */
258 struct aout_fifo_t
259 {
260     aout_buffer_t *         p_first;
261     aout_buffer_t **        pp_last;
262     date_t                  end_date;
263 };
264
265 /* Legacy packet-oriented audio output helpers */
266 typedef struct
267 {
268     vlc_mutex_t lock;
269     aout_fifo_t partial; /**< Audio blocks before packetization */
270     aout_fifo_t fifo; /**< Packetized audio blocks */
271     mtime_t pause_date; /**< Date when paused or VLC_TS_INVALID */
272     mtime_t time_report; /**< Desynchronization estimate or VLC_TS_INVALID */
273     unsigned samples; /**< Samples per packet */
274     bool starving; /**< Whether currently starving (to limit error messages) */
275 } aout_packet_t;
276
277 VLC_API void aout_PacketInit(audio_output_t *, aout_packet_t *, unsigned);
278 VLC_API void aout_PacketDestroy(audio_output_t *);
279
280 VLC_API void aout_PacketPlay(audio_output_t *, block_t *);
281 VLC_API void aout_PacketPause(audio_output_t *, bool, mtime_t);
282 VLC_API void aout_PacketFlush(audio_output_t *, bool);
283
284 VLC_API block_t *aout_PacketNext(audio_output_t *, mtime_t) VLC_USED;
285
286
287 #endif /* VLC_AOUT_H */