fourcc: add entry for Android opaque buffer type.
[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 /**
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-channels object variable */
80 #define AOUT_VAR_CHAN_UNSET         0 /* must be zero */
81 #define AOUT_VAR_CHAN_STEREO        1
82 #define AOUT_VAR_CHAN_RSTEREO       2
83 #define AOUT_VAR_CHAN_LEFT          3
84 #define AOUT_VAR_CHAN_RIGHT         4
85 #define AOUT_VAR_CHAN_DOLBYS        5
86
87 /*****************************************************************************
88  * Main audio output structures
89  *****************************************************************************/
90
91 /* Size of a frame for S/PDIF output. */
92 #define AOUT_SPDIF_SIZE 6144
93
94 /* Number of samples in an A/52 frame. */
95 #define A52_FRAME_NB 1536
96
97 /* FIXME to remove once aout.h is cleaned a bit more */
98 #include <vlc_block.h>
99
100 /** Audio output object */
101 struct audio_output
102 {
103     VLC_COMMON_MEMBERS
104
105     struct aout_sys_t *sys; /**< Private data for callbacks */
106
107     int (*start)(audio_output_t *, audio_sample_format_t *fmt);
108     /**< Starts a new stream (mandatory, cannot be NULL).
109       * \param fmt input stream sample format upon entry,
110       *            output stream sample format upon return [IN/OUT]
111       * \return VLC_SUCCESS on success, non-zero on failure
112       * \note No other stream may be already started when called.
113       */
114     void (*stop)(audio_output_t *);
115     /**< Stops the existing stream (optional, may be NULL).
116       * \note A stream must have been started when called.
117       */
118     int (*time_get)(audio_output_t *, mtime_t *delay);
119     /**< Estimates playback buffer latency (optional, may be NULL).
120       * \param delay pointer to the delay until the next sample to be written
121       *              to the playback buffer is rendered [OUT]
122       * \return 0 on success, non-zero on failure or lack of data
123       * \note A stream must have been started when called.
124       */
125     void (*play)(audio_output_t *, block_t *);
126     /**< Queues a block of samples for playback (mandatory, cannot be NULL).
127       * \note A stream must have been started when called.
128       */
129     void (*pause)( audio_output_t *, bool pause, mtime_t date);
130     /**< Pauses or resumes playback (optional, may be NULL).
131       * \param pause pause if true, resume from pause if false
132       * \param date timestamp when the pause or resume was requested
133       * \note A stream must have been started when called.
134       */
135     void (*flush)( audio_output_t *, bool wait);
136     /**< Flushes or drains the playback buffers (mandatory, cannot be NULL).
137       * \param wait true to wait for playback of pending buffers (drain),
138       *             false to discard pending buffers (flush)
139       * \note A stream must have been started when called.
140       */
141     int (*volume_set)(audio_output_t *, float volume);
142     /**< Changes playback volume (optional, may be NULL).
143       * \param volume requested volume (0. = mute, 1. = nominal)
144       * \note The volume is always a positive number.
145       * \warning A stream may or may not have been started when called.
146       */
147     int (*mute_set)(audio_output_t *, bool mute);
148     /**< Changes muting (optinal, may be NULL).
149       * \param mute true to mute, false to unmute
150       * \warning A stream may or may not have been started when called.
151       */
152     int (*device_select)(audio_output_t *, const char *id);
153     /**< Selects an audio output device (optional, may be NULL).
154       * \param id nul-terminated device unique identifier.
155       * \return 0 on success, non-zero on failure.
156       * \warning A stream may or may not have been started when called.
157       */
158     struct {
159         void (*volume_report)(audio_output_t *, float);
160         void (*mute_report)(audio_output_t *, bool);
161         void (*policy_report)(audio_output_t *, bool);
162         void (*device_report)(audio_output_t *, const char *);
163         void (*hotplug_report)(audio_output_t *, const char *, const char *);
164         int (*gain_request)(audio_output_t *, float);
165         void (*restart_request)(audio_output_t *, unsigned);
166     } event;
167 };
168
169 /**
170  * It describes the audio channel order VLC expect.
171  */
172 static const uint32_t pi_vlc_chan_order_wg4[] =
173 {
174     AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
175     AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
176     AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
177     AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
178 };
179
180 #define AOUT_RESTART_FILTERS 1
181 #define AOUT_RESTART_OUTPUT  2
182 #define AOUT_RESTART_DECODER 4
183
184 /*****************************************************************************
185  * Prototypes
186  *****************************************************************************/
187
188 /**
189  * This function computes the reordering needed to go from pi_chan_order_in to
190  * pi_chan_order_out.
191  * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
192  * internal (WG4) order is requested.
193  */
194 VLC_API unsigned aout_CheckChannelReorder( const uint32_t *, const uint32_t *,
195                                            uint32_t mask, uint8_t *table );
196 VLC_API void aout_ChannelReorder(void *, size_t, unsigned, const uint8_t *, vlc_fourcc_t);
197
198 VLC_API void aout_Interleave(void *dst, const void *const *planes,
199                              unsigned samples, unsigned channels,
200                              vlc_fourcc_t fourcc);
201 VLC_API void aout_Deinterleave(void *dst, const void *src, unsigned samples,
202                              unsigned channels, vlc_fourcc_t fourcc);
203
204 /**
205  * This function will compute the extraction parameter into pi_selection to go
206  * from i_channels with their type given by pi_order_src[] into the order
207  * describe by pi_order_dst.
208  * It will also set :
209  * - *pi_channels as the number of channels that will be extracted which is
210  * lower (in case of non understood channels type) or equal to i_channels.
211  * - the layout of the channels (*pi_layout).
212  *
213  * It will return true if channel extraction is really needed, in which case
214  * aout_ChannelExtract must be used
215  *
216  * XXX It must be used when the source may have channel type not understood
217  * by VLC. In this case the channel type pi_order_src[] must be set to 0.
218  * XXX It must also be used if multiple channels have the same type.
219  */
220 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 );
221
222 /**
223  * Do the actual channels extraction using the parameters created by
224  * aout_CheckChannelExtraction.
225  *
226  * XXX this function does not work in place (p_dst and p_src must not overlap).
227  * XXX Only 8, 16, 24, 32, 64 bits per sample are supported.
228  */
229 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 );
230
231 /* */
232 static inline unsigned aout_FormatNbChannels(const audio_sample_format_t *fmt)
233 {
234     return popcount(fmt->i_physical_channels);
235 }
236
237 VLC_API unsigned int aout_BitsPerSample( vlc_fourcc_t i_format ) VLC_USED;
238 VLC_API void aout_FormatPrepare( audio_sample_format_t * p_format );
239 VLC_API void aout_FormatPrint(vlc_object_t *, const char *,
240                               const audio_sample_format_t *);
241 #define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f)
242 VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED;
243
244 VLC_API float aout_VolumeGet (audio_output_t *);
245 VLC_API int aout_VolumeSet (audio_output_t *, float);
246 VLC_API int aout_MuteGet (audio_output_t *);
247 VLC_API int aout_MuteSet (audio_output_t *, bool);
248 VLC_API char *aout_DeviceGet (audio_output_t *);
249 VLC_API int aout_DeviceSet (audio_output_t *, const char *);
250 VLC_API int aout_DevicesList (audio_output_t *, char ***, char ***);
251
252 /**
253  * Report change of configured audio volume to the core and UI.
254  */
255 static inline void aout_VolumeReport(audio_output_t *aout, float volume)
256 {
257     aout->event.volume_report(aout, volume);
258 }
259
260 /**
261  * Report change of muted flag to the core and UI.
262  */
263 static inline void aout_MuteReport(audio_output_t *aout, bool mute)
264 {
265     aout->event.mute_report(aout, mute);
266 }
267
268 /**
269  * Report audio policy status.
270  * \parm cork true to request a cork, false to undo any pending cork.
271  */
272 static inline void aout_PolicyReport(audio_output_t *aout, bool cork)
273 {
274     aout->event.policy_report(aout, cork);
275 }
276
277 /**
278  * Report change of output device.
279  */
280 static inline void aout_DeviceReport(audio_output_t *aout, const char *id)
281 {
282     aout->event.device_report(aout, id);
283 }
284
285 /**
286  * Report a device hot-plug event.
287  * @param id device ID
288  * @param name human-readable device name (NULL for hot unplug)
289  */
290 static inline void aout_HotplugReport(audio_output_t *aout,
291                                       const char *id, const char *name)
292 {
293     aout->event.hotplug_report(aout, id, name);
294 }
295
296 /**
297  * Request a change of software audio amplification.
298  * \param gain linear amplitude gain (must be positive)
299  * \warning Values in excess 1.0 may cause overflow and distorsion.
300  */
301 static inline int aout_GainRequest(audio_output_t *aout, float gain)
302 {
303     return aout->event.gain_request(aout, gain);
304 }
305
306 static inline void aout_RestartRequest(audio_output_t *aout, unsigned mode)
307 {
308     aout->event.restart_request(aout, mode);
309 }
310
311 static inline int aout_ChannelsRestart (vlc_object_t *obj, const char *varname,
312                             vlc_value_t oldval, vlc_value_t newval, void *data)
313 {
314     audio_output_t *aout = (audio_output_t *)obj;
315     (void)varname; (void)oldval; (void)newval; (void)data;
316
317     aout_RestartRequest (aout, AOUT_RESTART_OUTPUT);
318     return 0;
319 }
320
321 /* Audio output filters */
322 typedef struct aout_filters aout_filters_t;
323 typedef struct aout_request_vout aout_request_vout_t;
324
325 VLC_API aout_filters_t *aout_FiltersNew(vlc_object_t *,
326                                         const audio_sample_format_t *,
327                                         const audio_sample_format_t *,
328                                         const aout_request_vout_t *) VLC_USED;
329 #define aout_FiltersNew(o,inf,outf,rv) \
330         aout_FiltersNew(VLC_OBJECT(o),inf,outf,rv)
331 VLC_API void aout_FiltersDelete(vlc_object_t *, aout_filters_t *);
332 #define aout_FiltersDelete(o,f) \
333         aout_FiltersDelete(VLC_OBJECT(o),f)
334 VLC_API bool aout_FiltersAdjustResampling(aout_filters_t *, int);
335 VLC_API block_t *aout_FiltersPlay(aout_filters_t *, block_t *, int rate);
336
337 VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt );
338
339 #endif /* VLC_AOUT_H */