]> git.sesse.net Git - vlc/blob - include/vlc_aout.h
aout: fix typo in comment
[vlc] / 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 /**
27  * \file
28  * This file defines functions, structures and macros for audio output object
29  */
30
31 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
32  * will be considered as bogus and be trashed */
33 #define AOUT_MAX_ADVANCE_TIME           (AOUT_MAX_PREPARE_TIME + CLOCK_FREQ)
34
35 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
36  * will cause the calling thread to sleep */
37 #define AOUT_MAX_PREPARE_TIME           (2 * CLOCK_FREQ)
38
39 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
40  * to avoid too heavy resampling */
41 #define AOUT_MIN_PREPARE_TIME           AOUT_MAX_PTS_ADVANCE
42
43 /* Tolerance values from EBU Recommendation 37 */
44 /** Maximum advance of actual audio playback time to coded PTS,
45  * above which downsampling will be performed */
46 #define AOUT_MAX_PTS_ADVANCE            (CLOCK_FREQ / 25)
47
48 /** Maximum delay of actual audio playback time from coded PTS,
49  * above which upsampling will be performed */
50 #define AOUT_MAX_PTS_DELAY              (3 * CLOCK_FREQ / 50)
51
52 /* Max acceptable resampling (in %) */
53 #define AOUT_MAX_RESAMPLING             10
54
55 #include "vlc_es.h"
56
57 #define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
58     ((p_first)->i_format == (p_second)->i_format)                           \
59       && AOUT_FMTS_SIMILAR(p_first, p_second) )
60
61 /* Check if i_rate == i_rate and i_channels == i_channels */
62 #define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            \
63     ((p_first)->i_rate == (p_second)->i_rate)                               \
64       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
65       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
66
67 #define AOUT_FMT_LINEAR( p_format ) \
68     (aout_BitsPerSample((p_format)->i_format) != 0)
69
70 #define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
71 #define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
72
73 #define AOUT_FMT_SPDIF( p_format ) \
74     ( ((p_format)->i_format == VLC_CODEC_SPDIFL)       \
75        || ((p_format)->i_format == VLC_CODEC_SPDIFB)   \
76        || ((p_format)->i_format == VLC_CODEC_A52)       \
77        || ((p_format)->i_format == VLC_CODEC_DTS) )
78
79 /* Values used for the audio-device and audio-channels object variables */
80 #define AOUT_VAR_MONO               1
81 #define AOUT_VAR_STEREO             2
82 #define AOUT_VAR_2F2R               4
83 #define AOUT_VAR_3F2R               5
84 #define AOUT_VAR_5_1                6
85 #define AOUT_VAR_6_1                7
86 #define AOUT_VAR_7_1                8
87 #define AOUT_VAR_SPDIF              10
88
89 #define AOUT_VAR_CHAN_UNSET         0 /* must be zero */
90 #define AOUT_VAR_CHAN_STEREO        1
91 #define AOUT_VAR_CHAN_RSTEREO       2
92 #define AOUT_VAR_CHAN_LEFT          3
93 #define AOUT_VAR_CHAN_RIGHT         4
94 #define AOUT_VAR_CHAN_DOLBYS        5
95
96 /*****************************************************************************
97  * Main audio output structures
98  *****************************************************************************/
99
100 /* Size of a frame for S/PDIF output. */
101 #define AOUT_SPDIF_SIZE 6144
102
103 /* Number of samples in an A/52 frame. */
104 #define A52_FRAME_NB 1536
105
106 /* FIXME to remove once aout.h is cleaned a bit more */
107 #include <vlc_block.h>
108
109 /** Audio output object */
110 struct audio_output
111 {
112     VLC_COMMON_MEMBERS
113
114     struct aout_sys_t *sys; /**< Private data for callbacks */
115
116     int (*start)(audio_output_t *, audio_sample_format_t *fmt);
117     /**< Starts a new stream (mandatory, cannot be NULL).
118       * \param fmt input stream sample format upon entry,
119       *            output stream sample format upon return [IN/OUT]
120       * \return VLC_SUCCESS on success, non-zero on failure
121       * \note No other stream may be already started when called.
122       */
123     void (*stop)(audio_output_t *);
124     /**< Stops the existing stream (optional, may be NULL).
125       * \note A stream must have been started when called.
126       */
127     int (*time_get)(audio_output_t *, mtime_t *delay);
128     /**< Estimates playback buffer latency (optional, may be NULL).
129       * \param delay pointer to the delay until the next sample to be written
130       *              to the playback buffer is rendered [OUT]
131       * \return 0 on success, non-zero on failure or lack of data
132       * \note A stream must have been started when called.
133       */
134     void (*play)(audio_output_t *, block_t *);
135     /**< Queues a block of samples for playback (mandatory, cannot be NULL).
136       * \note A stream must have been started when called.
137       */
138     void (*pause)( audio_output_t *, bool pause, mtime_t date);
139     /**< Pauses or resumes playback (optional, may be NULL).
140       * \param pause pause if true, resume from pause if false
141       * \param date timestamp when the pause or resume was requested
142       * \note A stream must have been started when called.
143       */
144     void (*flush)( audio_output_t *, bool wait);
145     /**< Flushes or drains the playback buffers (mandatory, cannot be NULL).
146       * \param wait true to wait for playback of pending buffers (drain),
147       *             false to discard pending buffers (flush)
148       * \note A stream must have been started when called.
149       */
150     int (*volume_set)(audio_output_t *, float volume);
151     /**< Changes playback volume (optional, may be NULL).
152       * \param volume requested volume (0. = mute, 1. = nominal)
153       * \note The volume is always a positive number.
154       * \warning A stream may or may not have been started when called.
155       */
156     int (*mute_set)(audio_output_t *, bool mute);
157     /**< Changes muting (optinal, may be NULL).
158       * \param mute true to mute, false to unmute
159       * \warning A stream may or may not have been started when called.
160       */
161     int (*device_enum)(audio_output_t *, char ***ids, char ***names);
162     /**< Enumerates available audio output devices (optional, may be NULL).
163       * \param ids pointer to a heap-allocated table of heap-allocated
164       *            nul-terminated device unique identifiers [OUT]
165       * \param names pointer to a heap-allocated table of heap-allocated
166       *              nul-terminated device human-readable names [OUT]
167       * \return The number of entries, or -1 on error.
168       * \warning A stream may or may not have been started when called.
169       */
170     int (*device_select)(audio_output_t *, const char *id);
171     /**< Selects an audio output device (optional, may be NULL).
172       * \param id nul-terminated device unique identifier.
173       * \return 0 on success, non-zero on failure.
174       * \warning A stream may or may not have been started when called.
175       */
176     struct {
177         void (*volume_report)(audio_output_t *, float);
178         void (*mute_report)(audio_output_t *, bool);
179         void (*policy_report)(audio_output_t *, bool);
180         void (*device_report)(audio_output_t *, const char *);
181         int (*gain_request)(audio_output_t *, float);
182         void (*restart_request)(audio_output_t *, unsigned);
183     } event;
184 };
185
186 /**
187  * It describes the audio channel order VLC expect.
188  */
189 static const uint32_t pi_vlc_chan_order_wg4[] =
190 {
191     AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
192     AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
193     AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
194     AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
195 };
196
197 #define AOUT_RESTART_FILTERS 1
198 #define AOUT_RESTART_OUTPUT  2
199 #define AOUT_RESTART_DECODER 4
200
201 /*****************************************************************************
202  * Prototypes
203  *****************************************************************************/
204
205 /**
206  * This function computes the reordering needed to go from pi_chan_order_in to
207  * pi_chan_order_out.
208  * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
209  * internal (WG4) order is requested.
210  */
211 VLC_API unsigned aout_CheckChannelReorder( const uint32_t *, const uint32_t *,
212                                            uint32_t mask, uint8_t *table );
213 VLC_API void aout_ChannelReorder(void *, size_t, unsigned, const uint8_t *, vlc_fourcc_t);
214
215 VLC_API void aout_Interleave(void *dst, const void *src, unsigned samples,
216                              unsigned channels, vlc_fourcc_t fourcc);
217 VLC_API void aout_Deinterleave(void *dst, const void *src, unsigned samples,
218                              unsigned channels, vlc_fourcc_t fourcc);
219
220 /**
221  * This fonction will compute the extraction parameter into pi_selection to go
222  * from i_channels with their type given by pi_order_src[] into the order
223  * describe by pi_order_dst.
224  * It will also set :
225  * - *pi_channels as the number of channels that will be extracted which is
226  * lower (in case of non understood channels type) or equal to i_channels.
227  * - the layout of the channels (*pi_layout).
228  *
229  * It will return true if channel extraction is really needed, in which case
230  * aout_ChannelExtract must be used
231  *
232  * XXX It must be used when the source may have channel type not understood
233  * by VLC. In this case the channel type pi_order_src[] must be set to 0.
234  * XXX It must also be used if multiple channels have the same type.
235  */
236 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 );
237
238 /**
239  * Do the actual channels extraction using the parameters created by
240  * aout_CheckChannelExtraction.
241  *
242  * XXX this function does not work in place (p_dst and p_src must not overlap).
243  * XXX Only 8, 16, 24, 32, 64 bits per sample are supported.
244  */
245 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 );
246
247 /* */
248 static inline unsigned aout_FormatNbChannels(const audio_sample_format_t *fmt)
249 {
250     return popcount(fmt->i_physical_channels);
251 }
252
253 VLC_API unsigned int aout_BitsPerSample( vlc_fourcc_t i_format ) VLC_USED;
254 VLC_API void aout_FormatPrepare( audio_sample_format_t * p_format );
255 VLC_API void aout_FormatPrint(vlc_object_t *, const char *,
256                               const audio_sample_format_t *);
257 #define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f)
258 VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED;
259
260 VLC_API float aout_VolumeGet (audio_output_t *);
261 VLC_API int aout_VolumeSet (audio_output_t *, float);
262 VLC_API int aout_MuteGet (audio_output_t *);
263 VLC_API int aout_MuteSet (audio_output_t *, bool);
264 VLC_API char *aout_DeviceGet (audio_output_t *);
265 VLC_API int aout_DeviceSet (audio_output_t *, const char *);
266 VLC_API int aout_DevicesList (audio_output_t *, char ***, char ***);
267
268 /**
269  * Report change of configured audio volume to the core and UI.
270  */
271 static inline void aout_VolumeReport(audio_output_t *aout, float volume)
272 {
273     aout->event.volume_report(aout, volume);
274 }
275
276 /**
277  * Report change of muted flag to the core and UI.
278  */
279 static inline void aout_MuteReport(audio_output_t *aout, bool mute)
280 {
281     aout->event.mute_report(aout, mute);
282 }
283
284 /**
285  * Report audio policy status.
286  * \parm cork true to request a cork, false to undo any pending cork.
287  */
288 static inline void aout_PolicyReport(audio_output_t *aout, bool cork)
289 {
290     aout->event.policy_report(aout, cork);
291 }
292
293 /**
294  * Report change of output device.
295  */
296 static inline void aout_DeviceReport(audio_output_t *aout, const char *id)
297 {
298     aout->event.device_report(aout, id);
299 }
300
301 /**
302  * Request a change of software audio amplification.
303  * \param gain linear amplitude gain (must be positive)
304  * \warning Values in excess 1.0 may cause overflow and distorsion.
305  */
306 static inline int aout_GainRequest(audio_output_t *aout, float gain)
307 {
308     return aout->event.gain_request(aout, gain);
309 }
310
311 static inline void aout_RestartRequest(audio_output_t *aout, unsigned mode)
312 {
313     aout->event.restart_request(aout, mode);
314 }
315
316 static inline int aout_ChannelsRestart (vlc_object_t *obj, const char *varname,
317                             vlc_value_t oldval, vlc_value_t newval, void *data)
318 {
319     audio_output_t *aout = (audio_output_t *)obj;
320     (void)varname; (void)oldval; (void)newval; (void)data;
321
322     aout_RestartRequest (aout, AOUT_RESTART_OUTPUT);
323     return 0;
324 }
325
326
327 /* */
328 VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ) VLC_USED;
329
330 /** Audio output buffer FIFO */
331 struct aout_fifo_t
332 {
333     block_t  *p_first;
334     block_t **pp_last;
335     date_t    end_date;
336 };
337
338 /* Legacy packet-oriented audio output helpers */
339 typedef struct
340 {
341     vlc_mutex_t lock;
342     audio_sample_format_t format;
343     aout_fifo_t partial; /**< Audio blocks before packetization */
344     aout_fifo_t fifo; /**< Packetized audio blocks */
345     mtime_t pause_date; /**< Date when paused or VLC_TS_INVALID */
346     unsigned samples; /**< Samples per packet */
347     bool starving; /**< Whether currently starving (to limit error messages) */
348 } aout_packet_t;
349
350 VLC_DEPRECATED void aout_PacketInit(audio_output_t *, aout_packet_t *, unsigned, const audio_sample_format_t *);
351 VLC_DEPRECATED void aout_PacketDestroy(audio_output_t *);
352
353 VLC_DEPRECATED int aout_PacketTimeGet(audio_output_t *, mtime_t *);
354 VLC_DEPRECATED void aout_PacketPlay(audio_output_t *, block_t *);
355 VLC_DEPRECATED void aout_PacketFlush(audio_output_t *, bool);
356
357 VLC_DEPRECATED block_t *aout_PacketNext(audio_output_t *, mtime_t) VLC_USED;
358
359
360 #endif /* VLC_AOUT_H */