Moved aout_input_t to aout_internal.h.
[vlc.git] / include / vlc_aout.h
1 /*****************************************************************************
2  * audio_output.h : audio output interface
3  *****************************************************************************
4  * Copyright (C) 2002-2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef VLC_AOUT_H
25 #define VLC_AOUT_H 1
26
27 /**
28  * \file
29  * This file defines functions, structures and macros for audio output object
30  */
31
32 # ifdef __cplusplus
33 extern "C" {
34 # endif
35
36 #include "vlc_es.h"
37
38 #define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
39     ((p_first)->i_format == (p_second)->i_format)                           \
40       && ((p_first)->i_rate == (p_second)->i_rate)                          \
41       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
42       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
43
44 /* Check if i_rate == i_rate and i_channels == i_channels */
45 #define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            \
46     ((p_first)->i_rate == (p_second)->i_rate)                               \
47       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
48       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
49
50 #define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
51 #define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
52
53 #define AOUT_FMT_NON_LINEAR( p_format )                 \
54     ( ((p_format)->i_format == VLC_CODEC_SPDIFL)       \
55        || ((p_format)->i_format == VLC_CODEC_SPDIFB)   \
56        || ((p_format)->i_format == VLC_CODEC_A52)       \
57        || ((p_format)->i_format == VLC_CODEC_DTS) )
58
59 /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
60 /*
61  * Fixed-point format: 0xABBBBBBB
62  * A == whole part      (sign + 3 bits)
63  * B == fractional part (28 bits)
64  *
65  * Values are signed two's complement, so the effective range is:
66  * 0x80000000 to 0x7fffffff
67  *       -8.0 to +7.9999999962747097015380859375
68  *
69  * The smallest representable value is:
70  * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
71  *
72  * 28 bits of fractional accuracy represent about
73  * 8.6 digits of decimal accuracy.
74  *
75  * Fixed-point numbers can be added or subtracted as normal
76  * integers, but multiplication requires shifting the 64-bit result
77  * from 56 fractional bits back to 28 (and rounding.)
78  */
79 typedef int32_t vlc_fixed_t;
80 #define FIXED32_FRACBITS 28
81 #define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
82 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
83 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
84
85 /*
86  * Channels descriptions
87  */
88
89 /* Values available for physical and original channels */
90 #define AOUT_CHAN_CENTER            0x1
91 #define AOUT_CHAN_LEFT              0x2
92 #define AOUT_CHAN_RIGHT             0x4
93 #define AOUT_CHAN_REARCENTER        0x10
94 #define AOUT_CHAN_REARLEFT          0x20
95 #define AOUT_CHAN_REARRIGHT         0x40
96 #define AOUT_CHAN_MIDDLELEFT        0x100
97 #define AOUT_CHAN_MIDDLERIGHT       0x200
98 #define AOUT_CHAN_LFE               0x1000
99
100 /* Values available for original channels only */
101 #define AOUT_CHAN_DOLBYSTEREO       0x10000
102 #define AOUT_CHAN_DUALMONO          0x20000
103 #define AOUT_CHAN_REVERSESTEREO     0x40000
104
105 #define AOUT_CHAN_PHYSMASK          0xFFFF
106 #define AOUT_CHAN_MAX               9
107
108 /* Values used for the audio-device and audio-channels object variables */
109 #define AOUT_VAR_MONO               1
110 #define AOUT_VAR_STEREO             2
111 #define AOUT_VAR_2F2R               4
112 #define AOUT_VAR_3F2R               5
113 #define AOUT_VAR_5_1                6
114 #define AOUT_VAR_6_1                7
115 #define AOUT_VAR_7_1                8
116 #define AOUT_VAR_SPDIF              10
117
118 #define AOUT_VAR_CHAN_STEREO        1
119 #define AOUT_VAR_CHAN_RSTEREO       2
120 #define AOUT_VAR_CHAN_LEFT          3
121 #define AOUT_VAR_CHAN_RIGHT         4
122 #define AOUT_VAR_CHAN_DOLBYS        5
123
124 /*****************************************************************************
125  * Main audio output structures
126  *****************************************************************************/
127
128 /** audio output buffer */
129 struct aout_buffer_t
130 {
131     uint8_t *               p_buffer;
132     int                     i_alloc_type;
133     /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
134      * is the number of significative bytes in it. */
135     size_t                  i_size, i_nb_bytes;
136     unsigned int            i_nb_samples;
137     mtime_t                 start_date, end_date;
138     bool                    b_discontinuity; /* Set on discontinuity (for non pcm stream) */
139
140     struct aout_buffer_t *  p_next;
141
142     /** Private data (aout_buffer_t will disappear soon so no need for an
143      * aout_buffer_sys_t type) */
144     void * p_sys;
145
146     /** This way the release can be overloaded */
147     void (*pf_release)( aout_buffer_t * );
148 };
149
150 #define aout_BufferFree( p_buffer ) do {                                    \
151     if( p_buffer != NULL && (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP )   \
152     {                                                                       \
153         free( p_buffer );                                                   \
154     }                                                                       \
155     p_buffer = NULL; } while(0)
156
157 /* Size of a frame for S/PDIF output. */
158 #define AOUT_SPDIF_SIZE 6144
159
160 /* Number of samples in an A/52 frame. */
161 #define A52_FRAME_NB 1536
162
163 /* Max input rate factor (1/4 -> 4) */
164 #define AOUT_MAX_INPUT_RATE (4)
165
166 /** allocation of memory in the audio output */
167 typedef struct aout_alloc_t
168 {
169     int                     i_alloc_type;
170     int                     i_bytes_per_sec;
171 } aout_alloc_t;
172
173 #define AOUT_ALLOC_NONE     0
174 #define AOUT_ALLOC_STACK    1
175 #define AOUT_ALLOC_HEAP     2
176
177 /** audio output buffer FIFO */
178 struct aout_fifo_t
179 {
180     aout_buffer_t *         p_first;
181     aout_buffer_t **        pp_last;
182     date_t                  end_date;
183 };
184
185 /* FIXME to remove once aout.h is cleaned a bit more */
186 #include <vlc_aout_mixer.h>
187
188 /* */
189 typedef struct
190 {
191     vout_thread_t  *(*pf_request_vout)( void *,
192                                         vout_thread_t *, video_format_t *, bool b_recycle );
193     void *p_private;
194 } aout_request_vout_t;
195
196 /** audio output filter */
197 typedef struct aout_filter_owner_sys_t aout_filter_owner_sys_t;
198 typedef struct aout_filter_sys_t aout_filter_sys_t;
199 struct aout_filter_t
200 {
201     VLC_COMMON_MEMBERS
202
203     audio_sample_format_t   input;
204     audio_sample_format_t   output;
205     aout_alloc_t            output_alloc;
206
207     module_t *              p_module;
208     aout_filter_sys_t       *p_sys;
209
210     bool                    b_in_place;
211     bool                    b_continuity;
212
213     void                    (*pf_do_work)( aout_instance_t *, aout_filter_t *,
214                                            aout_buffer_t *, aout_buffer_t * );
215
216     /* Owner fieldS
217      * XXX You MUST not use them directly */
218
219     /* Vout callback
220      * XXX use aout_filter_RequestVout */
221     aout_request_vout_t request_vout;
222
223     /* Private structure for the owner of the filter */
224     aout_filter_owner_sys_t *p_owner;
225 };
226
227 #define AOUT_RESAMPLING_NONE     0
228 #define AOUT_RESAMPLING_UP       1
229 #define AOUT_RESAMPLING_DOWN     2
230
231 /** an output stream for the audio output */
232 typedef struct aout_output_t
233 {
234     audio_sample_format_t   output;
235     /* Indicates whether the audio output is currently starving, to avoid
236      * printing a 1,000 "output is starving" messages. */
237     bool              b_starving;
238
239     /* post-filters */
240     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
241     int                     i_nb_filters;
242
243     aout_fifo_t             fifo;
244
245     struct module_t *       p_module;
246     struct aout_sys_t *     p_sys;
247     void                 (* pf_play)( aout_instance_t * );
248     int                  (* pf_volume_get )( aout_instance_t *, audio_volume_t * );
249     int                  (* pf_volume_set )( aout_instance_t *, audio_volume_t );
250     int                     i_nb_samples;
251
252     /* Current volume for the output - it's just a placeholder, the plug-in
253      * may or may not use it. */
254     audio_volume_t          i_volume;
255
256     /* If b_error == 1, there is no audio output pipeline. */
257     bool              b_error;
258 } aout_output_t;
259
260 /** audio output thread descriptor */
261 struct aout_instance_t
262 {
263     VLC_COMMON_MEMBERS
264
265     /* Locks : please note that if you need several of these locks, it is
266      * mandatory (to avoid deadlocks) to take them in the following order :
267      * mixer_lock, p_input->lock, output_fifo_lock, input_fifos_lock.
268      * --Meuuh */
269     /* When input_fifos_lock is taken, none of the p_input->fifo structures
270      * can be read or modified by a third-party thread. */
271     vlc_mutex_t             input_fifos_lock;
272     /* When mixer_lock is taken, all decoder threads willing to mix a
273      * buffer must wait until it is released. The output pipeline cannot
274      * be modified. No input stream can be added or removed. */
275     vlc_mutex_t             mixer_lock;
276     /* When output_fifo_lock is taken, the p_aout->output.fifo structure
277      * cannot be read or written  by a third-party thread. */
278     vlc_mutex_t             output_fifo_lock;
279
280     /* Input streams & pre-filters */
281     aout_input_t *          pp_inputs[AOUT_MAX_INPUTS];
282     int                     i_nb_inputs;
283
284     /* Mixer */
285     audio_sample_format_t   mixer_format;
286     aout_alloc_t            mixer_allocation;
287     float                   mixer_multiplier;
288     aout_mixer_t            *p_mixer;
289
290     /* Output plug-in */
291     aout_output_t           output;
292 };
293
294 /**
295  * It describes the audio channel order VLC except.
296  */
297 static const uint32_t pi_vlc_chan_order_wg4[] =
298 {
299     AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
300     AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
301     AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
302     AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
303 };
304
305 /*****************************************************************************
306  * Prototypes
307  *****************************************************************************/
308
309 VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, bool ) LIBVLC_USED );
310
311 /**
312  * This function computes the reordering needed to go from pi_chan_order_in to
313  * pi_chan_order_out.
314  * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
315  * internal (WG4) order is requested.
316  */
317 VLC_EXPORT( int, aout_CheckChannelReorder, ( const uint32_t *pi_chan_order_in, const uint32_t *pi_chan_order_out, uint32_t i_channel_mask, int i_channels, int *pi_chan_table ) );
318 VLC_EXPORT( void, aout_ChannelReorder, ( uint8_t *, int, int, const int *, int ) );
319
320 /**
321  * This fonction will compute the extraction parameter into pi_selection to go
322  * from i_channels with their type given by pi_order_src[] into the order
323  * describe by pi_order_dst.
324  * It will also set :
325  * - *pi_channels as the number of channels that will be extracted which is
326  * lower (in case of non understood channels type) or equal to i_channels.
327  * - the layout of the channels (*pi_layout).
328  *
329  * It will return true if channel extraction is really needed, in which case
330  * aout_ChannelExtract must be used
331  *
332  * XXX It must be used when the source may have channel type not understood
333  * by VLC. In this case the channel type pi_order_src[] must be set to 0.
334  * XXX It must also be used if multiple channels have the same type.
335  */
336 VLC_EXPORT( 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 ) );
337
338 /**
339  * Do the actual channels extraction using the parameters created by
340  * aout_CheckChannelExtraction.
341  *
342  * XXX this function does not work in place (p_dst and p_src must not overlap).
343  * XXX Only 8, 16, 24, 32, 64 bits per sample are supported.
344  */
345 VLC_EXPORT( 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 ) );
346
347 /* */
348 VLC_EXPORT( unsigned int, aout_FormatNbChannels, ( const audio_sample_format_t * p_format ) LIBVLC_USED );
349 VLC_EXPORT( unsigned int, aout_BitsPerSample, ( vlc_fourcc_t i_format ) LIBVLC_USED );
350 VLC_EXPORT( void, aout_FormatPrepare, ( audio_sample_format_t * p_format ) );
351 VLC_EXPORT( void, aout_FormatPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format ) );
352 VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) LIBVLC_USED );
353
354 VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) LIBVLC_USED );
355 VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) LIBVLC_USED );
356
357 /* From intf.c : */
358 VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
359 VLC_EXPORT( void, aout_VolumeNoneInit, ( aout_instance_t * ) );
360 #define aout_VolumeGet(a, b) __aout_VolumeGet(VLC_OBJECT(a), b)
361 VLC_EXPORT( int, __aout_VolumeGet, ( vlc_object_t *, audio_volume_t * ) );
362 #define aout_VolumeSet(a, b) __aout_VolumeSet(VLC_OBJECT(a), b)
363 VLC_EXPORT( int, __aout_VolumeSet, ( vlc_object_t *, audio_volume_t ) );
364 #define aout_VolumeUp(a, b, c) __aout_VolumeUp(VLC_OBJECT(a), b, c)
365 VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
366 #define aout_VolumeDown(a, b, c) __aout_VolumeDown(VLC_OBJECT(a), b, c)
367 VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
368 #define aout_ToggleMute(a, b) __aout_ToggleMute(VLC_OBJECT(a), b)
369 VLC_EXPORT( int, __aout_ToggleMute, ( vlc_object_t *, audio_volume_t * ) );
370 VLC_EXPORT( int, aout_FindAndRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
371 VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
372
373 VLC_EXPORT( void, aout_EnableFilter, (vlc_object_t *, const char *, bool ));
374 #define aout_EnableFilter( o, n, b ) \
375         aout_EnableFilter( VLC_OBJECT(o), n, b )
376
377 /* */
378 VLC_EXPORT( vout_thread_t *, aout_filter_RequestVout, ( aout_filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ) );
379
380 # ifdef __cplusplus
381 }
382 # endif
383
384 #endif /* _VLC_AOUT_H */