1 /*****************************************************************************
2 * vlc_aout.h : audio output interface
3 *****************************************************************************
4 * Copyright (C) 2002-2011 VLC authors and VideoLAN
6 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License as published by
10 * the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
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 Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
29 * \defgroup audio_output Audio output
33 * Audio output modules interface
36 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
37 * will be considered as bogus and be trashed */
38 #define AOUT_MAX_ADVANCE_TIME (AOUT_MAX_PREPARE_TIME + CLOCK_FREQ)
40 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
41 * will cause the calling thread to sleep */
42 #define AOUT_MAX_PREPARE_TIME (2 * CLOCK_FREQ)
44 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
45 * to avoid too heavy resampling */
46 #define AOUT_MIN_PREPARE_TIME AOUT_MAX_PTS_ADVANCE
48 /* Tolerance values from EBU Recommendation 37 */
49 /** Maximum advance of actual audio playback time to coded PTS,
50 * above which downsampling will be performed */
51 #define AOUT_MAX_PTS_ADVANCE (CLOCK_FREQ / 25)
53 /** Maximum delay of actual audio playback time from coded PTS,
54 * above which upsampling will be performed */
55 #define AOUT_MAX_PTS_DELAY (3 * CLOCK_FREQ / 50)
57 /* Max acceptable resampling (in %) */
58 #define AOUT_MAX_RESAMPLING 10
62 #define AOUT_FMTS_IDENTICAL( p_first, p_second ) ( \
63 ((p_first)->i_format == (p_second)->i_format) \
64 && AOUT_FMTS_SIMILAR(p_first, p_second) )
66 /* Check if i_rate == i_rate and i_channels == i_channels */
67 #define AOUT_FMTS_SIMILAR( p_first, p_second ) ( \
68 ((p_first)->i_rate == (p_second)->i_rate) \
69 && ((p_first)->channel_type == (p_second)->channel_type) \
70 && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
71 && ((p_first)->i_chan_mode == (p_second)->i_chan_mode) )
73 #define AOUT_FMT_LINEAR( p_format ) \
74 (aout_BitsPerSample((p_format)->i_format) != 0)
76 #define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
77 #define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
79 #define AOUT_FMT_SPDIF( p_format ) \
80 ( ((p_format)->i_format == VLC_CODEC_SPDIFL) \
81 || ((p_format)->i_format == VLC_CODEC_SPDIFB) \
82 || ((p_format)->i_format == VLC_CODEC_A52) \
83 || ((p_format)->i_format == VLC_CODEC_DTS) )
85 #define AOUT_FMT_HDMI( p_format ) \
86 ( (p_format)->i_format == VLC_CODEC_EAC3 \
87 ||(p_format)->i_format == VLC_CODEC_TRUEHD \
88 ||(p_format)->i_format == VLC_CODEC_MLP \
91 /* Values used for the audio-channels object variable */
92 #define AOUT_VAR_CHAN_UNSET 0 /* must be zero */
93 #define AOUT_VAR_CHAN_STEREO 1
94 #define AOUT_VAR_CHAN_RSTEREO 2
95 #define AOUT_VAR_CHAN_LEFT 3
96 #define AOUT_VAR_CHAN_RIGHT 4
97 #define AOUT_VAR_CHAN_DOLBYS 5
98 #define AOUT_VAR_CHAN_HEADPHONES 6
100 /*****************************************************************************
101 * Main audio output structures
102 *****************************************************************************/
104 /* Size of a frame for S/PDIF output. */
105 #define AOUT_SPDIF_SIZE 6144
107 /* Number of samples in an A/52 frame. */
108 #define A52_FRAME_NB 1536
110 /* FIXME to remove once aout.h is cleaned a bit more */
111 #include <vlc_block.h>
113 /** Audio output object */
118 struct aout_sys_t
*sys
; /**< Private data for callbacks */
120 int (*start
)(audio_output_t
*, audio_sample_format_t
*fmt
);
121 /**< Starts a new stream (mandatory, cannot be NULL).
122 * \param fmt input stream sample format upon entry,
123 * output stream sample format upon return [IN/OUT]
124 * \return VLC_SUCCESS on success, non-zero on failure
125 * \note No other stream may be already started when called.
127 void (*stop
)(audio_output_t
*);
128 /**< Stops the existing stream (optional, may be NULL).
129 * \note A stream must have been started when called.
131 int (*time_get
)(audio_output_t
*, mtime_t
*delay
);
132 /**< Estimates playback buffer latency (optional, may be NULL).
133 * \param delay pointer to the delay until the next sample to be written
134 * to the playback buffer is rendered [OUT]
135 * \return 0 on success, non-zero on failure or lack of data
136 * \note A stream must have been started when called.
138 void (*play
)(audio_output_t
*, block_t
*);
139 /**< Queues a block of samples for playback (mandatory, cannot be NULL).
140 * \note A stream must have been started when called.
142 void (*pause
)( audio_output_t
*, bool pause
, mtime_t date
);
143 /**< Pauses or resumes playback (optional, may be NULL).
144 * \param pause pause if true, resume from pause if false
145 * \param date timestamp when the pause or resume was requested
146 * \note A stream must have been started when called.
148 void (*flush
)( audio_output_t
*, bool wait
);
149 /**< Flushes or drains the playback buffers (mandatory, cannot be NULL).
150 * \param wait true to wait for playback of pending buffers (drain),
151 * false to discard pending buffers (flush)
152 * \note A stream must have been started when called.
154 int (*volume_set
)(audio_output_t
*, float volume
);
155 /**< Changes playback volume (optional, may be NULL).
156 * \param volume requested volume (0. = mute, 1. = nominal)
157 * \note The volume is always a positive number.
158 * \warning A stream may or may not have been started when called.
160 int (*mute_set
)(audio_output_t
*, bool mute
);
161 /**< Changes muting (optinal, may be NULL).
162 * \param mute true to mute, false to unmute
163 * \warning A stream may or may not have been started when called.
165 int (*device_select
)(audio_output_t
*, const char *id
);
166 /**< Selects an audio output device (optional, may be NULL).
167 * \param id nul-terminated device unique identifier.
168 * \return 0 on success, non-zero on failure.
169 * \warning A stream may or may not have been started when called.
173 bool headphones
; /**< Default to false, set it to true if the current
174 sink is using headphones */
176 /**< Current sink informations set by the module from the start() function */
179 void (*volume_report
)(audio_output_t
*, float);
180 void (*mute_report
)(audio_output_t
*, bool);
181 void (*policy_report
)(audio_output_t
*, bool);
182 void (*device_report
)(audio_output_t
*, const char *);
183 void (*hotplug_report
)(audio_output_t
*, const char *, const char *);
184 int (*gain_request
)(audio_output_t
*, float);
185 void (*restart_request
)(audio_output_t
*, unsigned);
191 AOUT_CHANIDX_DISABLE
= -1,
194 AOUT_CHANIDX_MIDDLELEFT
,
195 AOUT_CHANIDX_MIDDLERIGHT
,
196 AOUT_CHANIDX_REARLEFT
,
197 AOUT_CHANIDX_REARRIGHT
,
198 AOUT_CHANIDX_REARCENTER
,
202 } vlc_chan_order_idx_t
;
204 static_assert(AOUT_CHANIDX_MAX
== AOUT_CHAN_MAX
, "channel count mismatch");
206 #define AOUT_CHAN_REMAP_INIT { \
208 AOUT_CHANIDX_RIGHT, \
209 AOUT_CHANIDX_MIDDLELEFT, \
210 AOUT_CHANIDX_MIDDLERIGHT, \
211 AOUT_CHANIDX_REARLEFT, \
212 AOUT_CHANIDX_REARRIGHT, \
213 AOUT_CHANIDX_REARCENTER, \
214 AOUT_CHANIDX_CENTER, \
219 * It describes the audio channel order VLC expect.
221 static const uint32_t pi_vlc_chan_order_wg4
[] =
223 AOUT_CHAN_LEFT
, AOUT_CHAN_RIGHT
,
224 AOUT_CHAN_MIDDLELEFT
, AOUT_CHAN_MIDDLERIGHT
,
225 AOUT_CHAN_REARLEFT
, AOUT_CHAN_REARRIGHT
, AOUT_CHAN_REARCENTER
,
226 AOUT_CHAN_CENTER
, AOUT_CHAN_LFE
, 0
229 #define AOUT_RESTART_FILTERS 0x1
230 #define AOUT_RESTART_OUTPUT (AOUT_RESTART_FILTERS|0x2)
231 #define AOUT_RESTART_STEREOMODE (AOUT_RESTART_OUTPUT|0x4)
233 /*****************************************************************************
235 *****************************************************************************/
238 * This function computes the reordering needed to go from pi_chan_order_in to
240 * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
241 * internal (WG4) order is requested.
243 VLC_API
unsigned aout_CheckChannelReorder( const uint32_t *, const uint32_t *,
244 uint32_t mask
, uint8_t *table
);
245 VLC_API
void aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t
);
247 VLC_API
void aout_Interleave(void *dst
, const void *const *planes
,
248 unsigned samples
, unsigned channels
,
249 vlc_fourcc_t fourcc
);
250 VLC_API
void aout_Deinterleave(void *dst
, const void *src
, unsigned samples
,
251 unsigned channels
, vlc_fourcc_t fourcc
);
254 * This function will compute the extraction parameter into pi_selection to go
255 * from i_channels with their type given by pi_order_src[] into the order
256 * describe by pi_order_dst.
258 * - *pi_channels as the number of channels that will be extracted which is
259 * lower (in case of non understood channels type) or equal to i_channels.
260 * - the layout of the channels (*pi_layout).
262 * It will return true if channel extraction is really needed, in which case
263 * aout_ChannelExtract must be used
265 * XXX It must be used when the source may have channel type not understood
266 * by VLC. In this case the channel type pi_order_src[] must be set to 0.
267 * XXX It must also be used if multiple channels have the same type.
269 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
);
272 * Do the actual channels extraction using the parameters created by
273 * aout_CheckChannelExtraction.
275 * XXX this function does not work in place (p_dst and p_src must not overlap).
276 * XXX Only 8, 16, 32, 64 bits per sample are supported.
278 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
);
281 static inline unsigned aout_FormatNbChannels(const audio_sample_format_t
*fmt
)
283 return popcount(fmt
->i_physical_channels
);
286 VLC_API
unsigned int aout_BitsPerSample( vlc_fourcc_t i_format
) VLC_USED
;
287 VLC_API
void aout_FormatPrepare( audio_sample_format_t
* p_format
);
288 VLC_API
void aout_FormatPrint(vlc_object_t
*, const char *,
289 const audio_sample_format_t
*);
290 #define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f)
291 VLC_API
const char * aout_FormatPrintChannels( const audio_sample_format_t
* ) VLC_USED
;
293 #define AOUT_VOLUME_DEFAULT 256
294 #define AOUT_VOLUME_MAX 512
296 VLC_API
float aout_VolumeGet (audio_output_t
*);
297 VLC_API
int aout_VolumeSet (audio_output_t
*, float);
298 VLC_API
int aout_VolumeUpdate (audio_output_t
*, int, float *);
299 VLC_API
int aout_MuteGet (audio_output_t
*);
300 VLC_API
int aout_MuteSet (audio_output_t
*, bool);
301 VLC_API
char *aout_DeviceGet (audio_output_t
*);
302 VLC_API
int aout_DeviceSet (audio_output_t
*, const char *);
303 VLC_API
int aout_DevicesList (audio_output_t
*, char ***, char ***);
306 * Report change of configured audio volume to the core and UI.
308 static inline void aout_VolumeReport(audio_output_t
*aout
, float volume
)
310 aout
->event
.volume_report(aout
, volume
);
314 * Report change of muted flag to the core and UI.
316 static inline void aout_MuteReport(audio_output_t
*aout
, bool mute
)
318 aout
->event
.mute_report(aout
, mute
);
322 * Report audio policy status.
323 * \param cork true to request a cork, false to undo any pending cork.
325 static inline void aout_PolicyReport(audio_output_t
*aout
, bool cork
)
327 aout
->event
.policy_report(aout
, cork
);
331 * Report change of output device.
333 static inline void aout_DeviceReport(audio_output_t
*aout
, const char *id
)
335 aout
->event
.device_report(aout
, id
);
339 * Report a device hot-plug event.
340 * @param id device ID
341 * @param name human-readable device name (NULL for hot unplug)
343 static inline void aout_HotplugReport(audio_output_t
*aout
,
344 const char *id
, const char *name
)
346 aout
->event
.hotplug_report(aout
, id
, name
);
350 * Request a change of software audio amplification.
351 * \param gain linear amplitude gain (must be positive)
352 * \warning Values in excess 1.0 may cause overflow and distorsion.
354 static inline int aout_GainRequest(audio_output_t
*aout
, float gain
)
356 return aout
->event
.gain_request(aout
, gain
);
359 static inline void aout_RestartRequest(audio_output_t
*aout
, unsigned mode
)
361 aout
->event
.restart_request(aout
, mode
);
364 /* Audio output filters */
369 * If the remap order differs from the WG4 order, a remap audio filter will
370 * be inserted to remap channels according to this array.
372 int remap
[AOUT_CHANIDX_MAX
];
374 * If true, a filter will be inserted to add a headphones effect (like a
375 * binauralizer audio filter).
378 } aout_filters_cfg_t
;
380 #define AOUT_FILTERS_CFG_INIT (aout_filters_cfg_t) \
381 { .remap = AOUT_CHAN_REMAP_INIT, \
382 .headphones = false, \
385 typedef struct aout_filters aout_filters_t
;
386 typedef struct aout_request_vout aout_request_vout_t
;
388 VLC_API aout_filters_t
*aout_FiltersNew(vlc_object_t
*,
389 const audio_sample_format_t
*,
390 const audio_sample_format_t
*,
391 const aout_request_vout_t
*,
392 const aout_filters_cfg_t
*cfg
) VLC_USED
;
393 #define aout_FiltersNew(o,inf,outf,rv,remap) \
394 aout_FiltersNew(VLC_OBJECT(o),inf,outf,rv,remap)
395 VLC_API
void aout_FiltersDelete(vlc_object_t
*, aout_filters_t
*);
396 #define aout_FiltersDelete(o,f) \
397 aout_FiltersDelete(VLC_OBJECT(o),f)
398 VLC_API
bool aout_FiltersAdjustResampling(aout_filters_t
*, int);
399 VLC_API block_t
*aout_FiltersPlay(aout_filters_t
*, block_t
*, int rate
);
400 VLC_API block_t
*aout_FiltersDrain(aout_filters_t
*);
401 VLC_API
void aout_FiltersFlush(aout_filters_t
*);
402 VLC_API
void aout_FiltersChangeViewpoint(aout_filters_t
*, const vlc_viewpoint_t
*vp
);
404 VLC_API vout_thread_t
* aout_filter_RequestVout( filter_t
*, vout_thread_t
*p_vout
, const video_format_t
*p_fmt
);
408 #endif /* VLC_AOUT_H */