1 /*****************************************************************************
2  * vlc_aout.h : audio output interface
3  *****************************************************************************
4  * Copyright (C) 2002-2011 VLC authors and VideoLAN
5  *
6  * Authors: Christophe Massiot <massiot@via.ecp.fr>
7  *
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.
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 Lesser General Public License for more details.
17  *
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  *****************************************************************************/
22 
23 #ifndef VLC_AOUT_H
24 #define VLC_AOUT_H 1
25 
26 #include <assert.h>
27 
28 /**
29  * \defgroup audio_output Audio output
30  * \ingroup output
31  * @{
32  * \file
33  * Audio output modules interface
34  */
35 
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)
39 
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)
43 
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
47 
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)
52 
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)
56 
57 /* Max acceptable resampling (in %) */
58 #define AOUT_MAX_RESAMPLING             10
59 
60 #include "vlc_es.h"
61 
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) )
65 
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) )
72 
73 #define AOUT_FMT_LINEAR( p_format ) \
74     (aout_BitsPerSample((p_format)->i_format) != 0)
75 
76 #define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
77 #define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
78 
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) )
84 
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         \
89     )
90 
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
99 #define AOUT_VAR_CHAN_MONO          7
100 
101 /*****************************************************************************
102  * Main audio output structures
103  *****************************************************************************/
104 
105 /* Size of a frame for S/PDIF output. */
106 #define AOUT_SPDIF_SIZE 6144
107 
108 /* Number of samples in an A/52 frame. */
109 #define A52_FRAME_NB 1536
110 
111 /* FIXME to remove once aout.h is cleaned a bit more */
112 #include <vlc_block.h>
113 
114 /** Audio output object */
115 struct audio_output
116 {
117     VLC_COMMON_MEMBERS
118 
119     struct aout_sys_t *sys; /**< Private data for callbacks */
120 
121     int (*start)(audio_output_t *, audio_sample_format_t *fmt);
122     /**< Starts a new stream (mandatory, cannot be NULL).
123       * \param fmt input stream sample format upon entry,
124       *            output stream sample format upon return [IN/OUT]
125       * \return VLC_SUCCESS on success, non-zero on failure
126       * \note No other stream may be already started when called.
127       */
128     void (*stop)(audio_output_t *);
129     /**< Stops the existing stream (optional, may be NULL).
130       * \note A stream must have been started when called.
131       */
132     int (*time_get)(audio_output_t *, mtime_t *delay);
133     /**< Estimates playback buffer latency (optional, may be NULL).
134       * \param delay pointer to the delay until the next sample to be written
135       *              to the playback buffer is rendered [OUT]
136       * \return 0 on success, non-zero on failure or lack of data
137       * \note A stream must have been started when called.
138       */
139     void (*play)(audio_output_t *, block_t *);
140     /**< Queues a block of samples for playback (mandatory, cannot be NULL).
141       * \note A stream must have been started when called.
142       */
143     void (*pause)( audio_output_t *, bool pause, mtime_t date);
144     /**< Pauses or resumes playback (optional, may be NULL).
145       * \param pause pause if true, resume from pause if false
146       * \param date timestamp when the pause or resume was requested
147       * \note A stream must have been started when called.
148       */
149     void (*flush)( audio_output_t *, bool wait);
150     /**< Flushes or drains the playback buffers (mandatory, cannot be NULL).
151       * \param wait true to wait for playback of pending buffers (drain),
152       *             false to discard pending buffers (flush)
153       * \note A stream must have been started when called.
154       */
155     int (*volume_set)(audio_output_t *, float volume);
156     /**< Changes playback volume (optional, may be NULL).
157       * \param volume requested volume (0. = mute, 1. = nominal)
158       * \note The volume is always a positive number.
159       * \warning A stream may or may not have been started when called.
160       */
161     int (*mute_set)(audio_output_t *, bool mute);
162     /**< Changes muting (optinal, may be NULL).
163       * \param mute true to mute, false to unmute
164       * \warning A stream may or may not have been started when called.
165       */
166     int (*device_select)(audio_output_t *, const char *id);
167     /**< Selects an audio output device (optional, may be NULL).
168       * \param id nul-terminated device unique identifier.
169       * \return 0 on success, non-zero on failure.
170       * \warning A stream may or may not have been started when called.
171       */
172 
173     struct {
174         bool headphones; /**< Default to false, set it to true if the current
175                               sink is using headphones */
176     } current_sink_info;
177     /**< Current sink informations set by the module from the start() function */
178 
179     struct {
180         void (*volume_report)(audio_output_t *, float);
181         void (*mute_report)(audio_output_t *, bool);
182         void (*policy_report)(audio_output_t *, bool);
183         void (*device_report)(audio_output_t *, const char *);
184         void (*hotplug_report)(audio_output_t *, const char *, const char *);
185         int (*gain_request)(audio_output_t *, float);
186         void (*restart_request)(audio_output_t *, unsigned);
187     } event;
188 };
189 
190 typedef enum
191 {
192     AOUT_CHANIDX_DISABLE = -1,
193     AOUT_CHANIDX_LEFT,
194     AOUT_CHANIDX_RIGHT,
195     AOUT_CHANIDX_MIDDLELEFT,
196     AOUT_CHANIDX_MIDDLERIGHT,
197     AOUT_CHANIDX_REARLEFT,
198     AOUT_CHANIDX_REARRIGHT,
199     AOUT_CHANIDX_REARCENTER,
200     AOUT_CHANIDX_CENTER,
201     AOUT_CHANIDX_LFE,
202     AOUT_CHANIDX_MAX
203 } vlc_chan_order_idx_t;
204 
205 static_assert(AOUT_CHANIDX_MAX == AOUT_CHAN_MAX, "channel count mismatch");
206 
207 #define AOUT_CHAN_REMAP_INIT { \
208     AOUT_CHANIDX_LEFT,  \
209     AOUT_CHANIDX_RIGHT, \
210     AOUT_CHANIDX_MIDDLELEFT, \
211     AOUT_CHANIDX_MIDDLERIGHT, \
212     AOUT_CHANIDX_REARLEFT, \
213     AOUT_CHANIDX_REARRIGHT, \
214     AOUT_CHANIDX_REARCENTER, \
215     AOUT_CHANIDX_CENTER, \
216     AOUT_CHANIDX_LFE, \
217 }
218 
219 /**
220  * It describes the audio channel order VLC expect.
221  */
222 static const uint32_t pi_vlc_chan_order_wg4[] =
223 {
224     AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
225     AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
226     AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
227     AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
228 };
229 
230 #define AOUT_RESTART_FILTERS        0x1
231 #define AOUT_RESTART_OUTPUT         (AOUT_RESTART_FILTERS|0x2)
232 #define AOUT_RESTART_STEREOMODE     (AOUT_RESTART_OUTPUT|0x4)
233 
234 /*****************************************************************************
235  * Prototypes
236  *****************************************************************************/
237 
238 /**
239  * This function computes the reordering needed to go from pi_chan_order_in to
240  * pi_chan_order_out.
241  * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
242  * internal (WG4) order is requested.
243  */
244 VLC_API unsigned aout_CheckChannelReorder( const uint32_t *, const uint32_t *,
245                                            uint32_t mask, uint8_t *table );
246 VLC_API void aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t);
247 
248 VLC_API void aout_Interleave(void *dst, const void *const *planes,
249                              unsigned samples, unsigned channels,
250                              vlc_fourcc_t fourcc);
251 VLC_API void aout_Deinterleave(void *dst, const void *src, unsigned samples,
252                              unsigned channels, vlc_fourcc_t fourcc);
253 
254 /**
255  * This function will compute the extraction parameter into pi_selection to go
256  * from i_channels with their type given by pi_order_src[] into the order
257  * describe by pi_order_dst.
258  * It will also set :
259  * - *pi_channels as the number of channels that will be extracted which is
260  * lower (in case of non understood channels type) or equal to i_channels.
261  * - the layout of the channels (*pi_layout).
262  *
263  * It will return true if channel extraction is really needed, in which case
264  * aout_ChannelExtract must be used
265  *
266  * XXX It must be used when the source may have channel type not understood
267  * by VLC. In this case the channel type pi_order_src[] must be set to 0.
268  * XXX It must also be used if multiple channels have the same type.
269  */
270 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 );
271 
272 /**
273  * Do the actual channels extraction using the parameters created by
274  * aout_CheckChannelExtraction.
275  *
276  * XXX this function does not work in place (p_dst and p_src must not overlap).
277  * XXX Only 8, 16, 32, 64 bits per sample are supported.
278  */
279 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 );
280 
281 /* */
aout_FormatNbChannels(const audio_sample_format_t * fmt)282 static inline unsigned aout_FormatNbChannels(const audio_sample_format_t *fmt)
283 {
284     return popcount(fmt->i_physical_channels);
285 }
286 
287 VLC_API unsigned int aout_BitsPerSample( vlc_fourcc_t i_format ) VLC_USED;
288 VLC_API void aout_FormatPrepare( audio_sample_format_t * p_format );
289 VLC_API void aout_FormatPrint(vlc_object_t *, const char *,
290                               const audio_sample_format_t *);
291 #define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f)
292 VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED;
293 
294 #define AOUT_VOLUME_DEFAULT             256
295 #define AOUT_VOLUME_MAX                 512
296 
297 VLC_API float aout_VolumeGet (audio_output_t *);
298 VLC_API int aout_VolumeSet (audio_output_t *, float);
299 VLC_API int aout_VolumeUpdate (audio_output_t *, int, float *);
300 VLC_API int aout_MuteGet (audio_output_t *);
301 VLC_API int aout_MuteSet (audio_output_t *, bool);
302 VLC_API char *aout_DeviceGet (audio_output_t *);
303 VLC_API int aout_DeviceSet (audio_output_t *, const char *);
304 VLC_API int aout_DevicesList (audio_output_t *, char ***, char ***);
305 
306 /**
307  * Report change of configured audio volume to the core and UI.
308  */
aout_VolumeReport(audio_output_t * aout,float volume)309 static inline void aout_VolumeReport(audio_output_t *aout, float volume)
310 {
311     aout->event.volume_report(aout, volume);
312 }
313 
314 /**
315  * Report change of muted flag to the core and UI.
316  */
aout_MuteReport(audio_output_t * aout,bool mute)317 static inline void aout_MuteReport(audio_output_t *aout, bool mute)
318 {
319     aout->event.mute_report(aout, mute);
320 }
321 
322 /**
323  * Report audio policy status.
324  * \param cork true to request a cork, false to undo any pending cork.
325  */
aout_PolicyReport(audio_output_t * aout,bool cork)326 static inline void aout_PolicyReport(audio_output_t *aout, bool cork)
327 {
328     aout->event.policy_report(aout, cork);
329 }
330 
331 /**
332  * Report change of output device.
333  */
aout_DeviceReport(audio_output_t * aout,const char * id)334 static inline void aout_DeviceReport(audio_output_t *aout, const char *id)
335 {
336     aout->event.device_report(aout, id);
337 }
338 
339 /**
340  * Report a device hot-plug event.
341  * @param id device ID
342  * @param name human-readable device name (NULL for hot unplug)
343  */
aout_HotplugReport(audio_output_t * aout,const char * id,const char * name)344 static inline void aout_HotplugReport(audio_output_t *aout,
345                                       const char *id, const char *name)
346 {
347     aout->event.hotplug_report(aout, id, name);
348 }
349 
350 /**
351  * Request a change of software audio amplification.
352  * \param gain linear amplitude gain (must be positive)
353  * \warning Values in excess 1.0 may cause overflow and distorsion.
354  */
aout_GainRequest(audio_output_t * aout,float gain)355 static inline int aout_GainRequest(audio_output_t *aout, float gain)
356 {
357     return aout->event.gain_request(aout, gain);
358 }
359 
aout_RestartRequest(audio_output_t * aout,unsigned mode)360 static inline void aout_RestartRequest(audio_output_t *aout, unsigned mode)
361 {
362     aout->event.restart_request(aout, mode);
363 }
364 
365 /* Audio output filters */
366 
367 typedef struct
368 {
369     /**
370      * If the remap order differs from the WG4 order, a remap audio filter will
371      * be inserted to remap channels according to this array.
372      */
373     int remap[AOUT_CHANIDX_MAX];
374     /**
375      * If true, a filter will be inserted to add a headphones effect (like a
376      * binauralizer audio filter).
377      */
378     bool headphones;
379 } aout_filters_cfg_t;
380 
381 #define AOUT_FILTERS_CFG_INIT (aout_filters_cfg_t) \
382     { .remap = AOUT_CHAN_REMAP_INIT, \
383       .headphones = false, \
384     };
385 
386 typedef struct aout_filters aout_filters_t;
387 typedef struct aout_request_vout aout_request_vout_t;
388 
389 VLC_API aout_filters_t *aout_FiltersNew(vlc_object_t *,
390                                         const audio_sample_format_t *,
391                                         const audio_sample_format_t *,
392                                         const aout_request_vout_t *,
393                                         const aout_filters_cfg_t *cfg) VLC_USED;
394 #define aout_FiltersNew(o,inf,outf,rv,remap) \
395         aout_FiltersNew(VLC_OBJECT(o),inf,outf,rv,remap)
396 VLC_API void aout_FiltersDelete(vlc_object_t *, aout_filters_t *);
397 #define aout_FiltersDelete(o,f) \
398         aout_FiltersDelete(VLC_OBJECT(o),f)
399 VLC_API bool aout_FiltersAdjustResampling(aout_filters_t *, int);
400 VLC_API block_t *aout_FiltersPlay(aout_filters_t *, block_t *, int rate);
401 VLC_API block_t *aout_FiltersDrain(aout_filters_t *);
402 VLC_API void     aout_FiltersFlush(aout_filters_t *);
403 VLC_API void     aout_FiltersChangeViewpoint(aout_filters_t *, const vlc_viewpoint_t *vp);
404 
405 VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, const video_format_t *p_fmt );
406 
407 /** @} */
408 
409 #endif /* VLC_AOUT_H */
410