aout: always provide time_get
[vlc.git] / include / vlc_aout.h
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 struct vlc_audio_output_events {
115     void (*volume_report)(audio_output_t *, float);
116     void (*mute_report)(audio_output_t *, bool);
117     void (*policy_report)(audio_output_t *, bool);
118     void (*device_report)(audio_output_t *, const char *);
119     void (*hotplug_report)(audio_output_t *, const char *, const char *);
120     void (*restart_request)(audio_output_t *, unsigned);
121     int (*gain_request)(audio_output_t *, float);
122 };
123
124 /** Audio output object
125  *
126  * The audio output object is the abstraction for rendering decoded
127  * (or pass-through) audio samples. In addition to playing samples,
128  * the abstraction exposes controls for pause/resume, flush/drain,
129  * changing the volume or mut flag, and listing and changing output device.
130  *
131  * An audio output can be in one of three different states:
132  * stopped, playing or paused.
133  * The audio output is always created in stopped state and is always destroyed
134  * in that state also. It is moved from stopped to playing state by start(),
135  * and from playing or paused states back to stopped state by stop().
136  **/
137 struct audio_output
138 {
139     struct vlc_common_members obj;
140
141     void *sys; /**< Private data for callbacks */
142
143     int (*start)(audio_output_t *, audio_sample_format_t *fmt);
144     /**< Starts a new stream (mandatory, cannot be NULL).
145       *
146       * This callback changes the audio output from stopped to playing state
147       * (if succesful). After the callback returns, time_get(), play(),
148       * pause(), flush() and eventually stop() callbacks may be called.
149       *
150       * \param fmt input stream sample format upon entry,
151       *            output stream sample format upon return [IN/OUT]
152       * \return VLC_SUCCESS on success, non-zero on failure
153       *
154       * \note This callback can only be called while the audio output is in
155       * stopped state. There can be only one stream per audio output at a time.
156       *
157       * \note This callbacks needs not be reentrant.
158       */
159
160     void (*stop)(audio_output_t *);
161     /**< Stops the existing stream (optional, may be NULL).
162       *
163       * This callback terminates the current audio stream,
164       * and returns the audio output to stopped state.
165       *
166       * \note This callback needs not be reentrant.
167       */
168
169     int (*time_get)(audio_output_t *, mtime_t *delay);
170     /**< Estimates playback buffer latency (optional, may be NULL).
171       *
172       * \param delay pointer to the delay until the next sample to be written
173       *              to the playback buffer is rendered [OUT]
174       * \return 0 on success, non-zero on failure or lack of data
175       *
176       * \note This callback cannot be called in stopped state.
177       */
178
179     void (*play)(audio_output_t *, block_t *block, mtime_t date);
180     /**< Queues a block of samples for playback (mandatory, cannot be NULL).
181       *
182       * \param block block of audio samples
183       * \param date intended system time to render the first sample
184       *
185       * \note This callback cannot be called in stopped state.
186       */
187
188     void (*pause)( audio_output_t *, bool pause, mtime_t date);
189     /**< Pauses or resumes playback (optional, may be NULL).
190       *
191       * \param pause pause if true, resume from pause if false
192       * \param date timestamp when the pause or resume was requested
193       *
194       * \note This callback cannot be called in stopped state.
195       */
196
197     void (*flush)( audio_output_t *, bool wait);
198     /**< Flushes or drains the playback buffers (mandatory, cannot be NULL).
199       *
200       * \param wait true to wait for playback of pending buffers (drain),
201       *             false to discard pending buffers (flush)
202       *
203       * \note This callback cannot be called in stopped state.
204       */
205
206     int (*volume_set)(audio_output_t *, float volume);
207     /**< Changes playback volume (optional, may be NULL).
208       *
209       * \param volume requested volume (0. = mute, 1. = nominal)
210       *
211       * \note The volume is always a positive number.
212       *
213       * \warning A stream may or may not have been started when called.
214       * \warning This callback may be called concurrently with
215       * time_get(), play(), pause() or flush().
216       * It will however be protected against concurrent calls to
217       * start(), stop(), volume_set(), mute_set() or device_select().
218       */
219
220     int (*mute_set)(audio_output_t *, bool mute);
221     /**< Changes muting (optinal, may be NULL).
222       *
223       * \param mute true to mute, false to unmute
224       * \warning The same constraints apply as with volume_set().
225       */
226
227     int (*device_select)(audio_output_t *, const char *id);
228     /**< Selects an audio output device (optional, may be NULL).
229       *
230       * \param id nul-terminated device unique identifier.
231       * \return 0 on success, non-zero on failure.
232       *
233       * \warning The same constraints apply as with volume_set().
234       */
235
236     struct {
237         bool headphones; /**< Default to false, set it to true if the current
238                               sink is using headphones */
239     } current_sink_info;
240     /**< Current sink informations set by the module from the start() function */
241
242     const struct vlc_audio_output_events *events;
243 };
244
245 typedef enum
246 {
247     AOUT_CHANIDX_DISABLE = -1,
248     AOUT_CHANIDX_LEFT,
249     AOUT_CHANIDX_RIGHT,
250     AOUT_CHANIDX_MIDDLELEFT,
251     AOUT_CHANIDX_MIDDLERIGHT,
252     AOUT_CHANIDX_REARLEFT,
253     AOUT_CHANIDX_REARRIGHT,
254     AOUT_CHANIDX_REARCENTER,
255     AOUT_CHANIDX_CENTER,
256     AOUT_CHANIDX_LFE,
257     AOUT_CHANIDX_MAX
258 } vlc_chan_order_idx_t;
259
260 static_assert(AOUT_CHANIDX_MAX == AOUT_CHAN_MAX, "channel count mismatch");
261
262 #define AOUT_CHAN_REMAP_INIT { \
263     AOUT_CHANIDX_LEFT,  \
264     AOUT_CHANIDX_RIGHT, \
265     AOUT_CHANIDX_MIDDLELEFT, \
266     AOUT_CHANIDX_MIDDLERIGHT, \
267     AOUT_CHANIDX_REARLEFT, \
268     AOUT_CHANIDX_REARRIGHT, \
269     AOUT_CHANIDX_REARCENTER, \
270     AOUT_CHANIDX_CENTER, \
271     AOUT_CHANIDX_LFE, \
272 }
273
274 /**
275  * It describes the audio channel order VLC expect.
276  */
277 static const uint32_t pi_vlc_chan_order_wg4[] =
278 {
279     AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
280     AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
281     AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
282     AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
283 };
284
285 #define AOUT_RESTART_FILTERS        0x1
286 #define AOUT_RESTART_OUTPUT         (AOUT_RESTART_FILTERS|0x2)
287 #define AOUT_RESTART_STEREOMODE     (AOUT_RESTART_OUTPUT|0x4)
288
289 /*****************************************************************************
290  * Prototypes
291  *****************************************************************************/
292
293 /**
294  * This function computes the reordering needed to go from pi_chan_order_in to
295  * pi_chan_order_out.
296  * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
297  * internal (WG4) order is requested.
298  */
299 VLC_API unsigned aout_CheckChannelReorder( const uint32_t *, const uint32_t *,
300                                            uint32_t mask, uint8_t *table );
301 VLC_API void aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t);
302
303 VLC_API void aout_Interleave(void *dst, const void *const *planes,
304                              unsigned samples, unsigned channels,
305                              vlc_fourcc_t fourcc);
306 VLC_API void aout_Deinterleave(void *dst, const void *src, unsigned samples,
307                              unsigned channels, vlc_fourcc_t fourcc);
308
309 /**
310  * This function will compute the extraction parameter into pi_selection to go
311  * from i_channels with their type given by pi_order_src[] into the order
312  * describe by pi_order_dst.
313  * It will also set :
314  * - *pi_channels as the number of channels that will be extracted which is
315  * lower (in case of non understood channels type) or equal to i_channels.
316  * - the layout of the channels (*pi_layout).
317  *
318  * It will return true if channel extraction is really needed, in which case
319  * aout_ChannelExtract must be used
320  *
321  * XXX It must be used when the source may have channel type not understood
322  * by VLC. In this case the channel type pi_order_src[] must be set to 0.
323  * XXX It must also be used if multiple channels have the same type.
324  */
325 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 );
326
327 /**
328  * Do the actual channels extraction using the parameters created by
329  * aout_CheckChannelExtraction.
330  *
331  * XXX this function does not work in place (p_dst and p_src must not overlap).
332  * XXX Only 8, 16, 32, 64 bits per sample are supported.
333  */
334 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 );
335
336 /* */
337 static inline unsigned aout_FormatNbChannels(const audio_sample_format_t *fmt)
338 {
339     return vlc_popcount(fmt->i_physical_channels);
340 }
341
342 VLC_API unsigned int aout_BitsPerSample( vlc_fourcc_t i_format ) VLC_USED;
343 VLC_API void aout_FormatPrepare( audio_sample_format_t * p_format );
344 VLC_API void aout_FormatPrint(vlc_object_t *, const char *,
345                               const audio_sample_format_t *);
346 #define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f)
347 VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED;
348
349 #define AOUT_VOLUME_DEFAULT             256
350 #define AOUT_VOLUME_MAX                 512
351
352 VLC_API float aout_VolumeGet (audio_output_t *);
353 VLC_API int aout_VolumeSet (audio_output_t *, float);
354 VLC_API int aout_VolumeUpdate (audio_output_t *, int, float *);
355 VLC_API int aout_MuteGet (audio_output_t *);
356 VLC_API int aout_MuteSet (audio_output_t *, bool);
357 VLC_API char *aout_DeviceGet (audio_output_t *);
358 VLC_API int aout_DeviceSet (audio_output_t *, const char *);
359 VLC_API int aout_DevicesList (audio_output_t *, char ***, char ***);
360
361 /**
362  * Report change of configured audio volume to the core and UI.
363  */
364 static inline void aout_VolumeReport(audio_output_t *aout, float volume)
365 {
366     aout->events->volume_report(aout, volume);
367 }
368
369 /**
370  * Report change of muted flag to the core and UI.
371  */
372 static inline void aout_MuteReport(audio_output_t *aout, bool mute)
373 {
374     aout->events->mute_report(aout, mute);
375 }
376
377 /**
378  * Report audio policy status.
379  * \param cork true to request a cork, false to undo any pending cork.
380  */
381 static inline void aout_PolicyReport(audio_output_t *aout, bool cork)
382 {
383     aout->events->policy_report(aout, cork);
384 }
385
386 /**
387  * Report change of output device.
388  */
389 static inline void aout_DeviceReport(audio_output_t *aout, const char *id)
390 {
391     aout->events->device_report(aout, id);
392 }
393
394 /**
395  * Report a device hot-plug event.
396  * @param id device ID
397  * @param name human-readable device name (NULL for hot unplug)
398  */
399 static inline void aout_HotplugReport(audio_output_t *aout,
400                                       const char *id, const char *name)
401 {
402     aout->events->hotplug_report(aout, id, name);
403 }
404
405 /**
406  * Request a change of software audio amplification.
407  * \param gain linear amplitude gain (must be positive)
408  * \warning Values in excess 1.0 may cause overflow and distorsion.
409  */
410 static inline int aout_GainRequest(audio_output_t *aout, float gain)
411 {
412     return aout->events->gain_request(aout, gain);
413 }
414
415 static inline void aout_RestartRequest(audio_output_t *aout, unsigned mode)
416 {
417     aout->events->restart_request(aout, mode);
418 }
419
420 /**
421  * Default implementation for audio_output_t.time_get
422  */
423 static inline int aout_TimeGetDefault(audio_output_t *aout,
424                                       mtime_t *restrict delay)
425 {
426     (void) aout; (void) delay;
427     return -1;
428 }
429
430 /* Audio output filters */
431
432 typedef struct
433 {
434     /**
435      * If the remap order differs from the WG4 order, a remap audio filter will
436      * be inserted to remap channels according to this array.
437      */
438     int remap[AOUT_CHANIDX_MAX];
439     /**
440      * If true, a filter will be inserted to add a headphones effect (like a
441      * binauralizer audio filter).
442      */
443     bool headphones;
444 } aout_filters_cfg_t;
445
446 #define AOUT_FILTERS_CFG_INIT (aout_filters_cfg_t) \
447     { .remap = AOUT_CHAN_REMAP_INIT, \
448       .headphones = false, \
449     };
450
451 typedef struct aout_filters aout_filters_t;
452 typedef struct aout_request_vout aout_request_vout_t;
453
454 VLC_API aout_filters_t *aout_FiltersNew(vlc_object_t *,
455                                         const audio_sample_format_t *,
456                                         const audio_sample_format_t *,
457                                         const aout_request_vout_t *,
458                                         const aout_filters_cfg_t *cfg) VLC_USED;
459 #define aout_FiltersNew(o,inf,outf,rv,remap) \
460         aout_FiltersNew(VLC_OBJECT(o),inf,outf,rv,remap)
461 VLC_API void aout_FiltersDelete(vlc_object_t *, aout_filters_t *);
462 #define aout_FiltersDelete(o,f) \
463         aout_FiltersDelete(VLC_OBJECT(o),f)
464 VLC_API bool aout_FiltersAdjustResampling(aout_filters_t *, int);
465 VLC_API block_t *aout_FiltersPlay(aout_filters_t *, block_t *, float rate);
466 VLC_API block_t *aout_FiltersDrain(aout_filters_t *);
467 VLC_API void     aout_FiltersFlush(aout_filters_t *);
468 VLC_API void     aout_FiltersChangeViewpoint(aout_filters_t *, const vlc_viewpoint_t *vp);
469
470 VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, const video_format_t *p_fmt );
471
472 /** @} */
473
474 #endif /* VLC_AOUT_H */