1 /*****************************************************************************
2 * audio_output.h : audio output interface
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: audio_output.h,v 1.80 2003/05/04 22:42:14 gbazin Exp $
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
25 * audio_sample_format_t
26 *****************************************************************************
27 * This structure defines a format for audio samples.
28 *****************************************************************************/
29 struct audio_sample_format_t
31 vlc_fourcc_t i_format;
33 /* Describes the channels configuration of the samples (ie. number of
34 * channels which are available in the buffer, and positions). */
35 uint32_t i_physical_channels;
36 /* Describes from which original channels, before downmixing, the
37 * buffer is derived. */
38 uint32_t i_original_channels;
39 /* Optional - for A/52, SPDIF and DTS types : */
40 /* Bytes used by one compressed frame, depends on bitrate. */
41 unsigned int i_bytes_per_frame;
42 /* Number of sampleframes contained in one compressed frame. */
43 unsigned int i_frame_length;
44 /* Please note that it may be completely arbitrary - buffers are not
45 * obliged to contain a integral number of so-called "frames". It's
46 * just here for the division :
47 * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
51 #define AOUT_FMTS_IDENTICAL( p_first, p_second ) ( \
52 ((p_first)->i_format == (p_second)->i_format) \
53 && ((p_first)->i_rate == (p_second)->i_rate) \
54 && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
55 && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
57 /* Check if i_rate == i_rate and i_channels == i_channels */
58 #define AOUT_FMTS_SIMILAR( p_first, p_second ) ( \
59 ((p_first)->i_rate == (p_second)->i_rate) \
60 && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
61 && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
63 #ifdef WORDS_BIGENDIAN
64 # define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','b')
65 # define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','b')
67 # define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','l')
68 # define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','l')
71 #define AOUT_FMT_NON_LINEAR( p_format ) \
72 ( ((p_format)->i_format == VLC_FOURCC('s','p','d','i')) \
73 || ((p_format)->i_format == VLC_FOURCC('a','5','2',' ')) \
74 || ((p_format)->i_format == VLC_FOURCC('d','t','s',' ')) )
76 /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
78 * Fixed-point format: 0xABBBBBBB
79 * A == whole part (sign + 3 bits)
80 * B == fractional part (28 bits)
82 * Values are signed two's complement, so the effective range is:
83 * 0x80000000 to 0x7fffffff
84 * -8.0 to +7.9999999962747097015380859375
86 * The smallest representable value is:
87 * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
89 * 28 bits of fractional accuracy represent about
90 * 8.6 digits of decimal accuracy.
92 * Fixed-point numbers can be added or subtracted as normal
93 * integers, but multiplication requires shifting the 64-bit result
94 * from 56 fractional bits back to 28 (and rounding.)
96 typedef int32_t vlc_fixed_t;
97 #define FIXED32_FRACBITS 28
98 #define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
99 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
100 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
104 * Channels descriptions
107 /* Values available for physical and original channels */
108 #define AOUT_CHAN_CENTER 0x1
109 #define AOUT_CHAN_LEFT 0x2
110 #define AOUT_CHAN_RIGHT 0x4
111 #define AOUT_CHAN_REARCENTER 0x10
112 #define AOUT_CHAN_REARLEFT 0x20
113 #define AOUT_CHAN_REARRIGHT 0x40
114 #define AOUT_CHAN_MIDDLELEFT 0x100
115 #define AOUT_CHAN_MIDDLERIGHT 0x200
116 #define AOUT_CHAN_LFE 0x1000
118 /* Values available for original channels only */
119 #define AOUT_CHAN_DOLBYSTEREO 0x10000
120 #define AOUT_CHAN_DUALMONO 0x20000
121 #define AOUT_CHAN_REVERSESTEREO 0x40000
123 #define AOUT_CHAN_PHYSMASK 0xFFFF
125 /* Values used for the audio-device and audio-channels object variables */
126 #define AOUT_VAR_MONO 1
127 #define AOUT_VAR_STEREO 2
128 #define AOUT_VAR_2F2R 3
129 #define AOUT_VAR_5_1 4
130 #define AOUT_VAR_6_1 5
131 #define AOUT_VAR_7_1 6
132 #define AOUT_VAR_SPDIF 7
134 #define AOUT_VAR_CHAN_STEREO 1
135 #define AOUT_VAR_CHAN_RSTEREO 2
136 #define AOUT_VAR_CHAN_LEFT 3
137 #define AOUT_VAR_CHAN_RIGHT 4
138 #define AOUT_VAR_CHAN_DOLBYS 5
140 /*****************************************************************************
141 * aout_buffer_t : audio output buffer
142 *****************************************************************************/
147 /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
148 * is the number of significative bytes in it. */
149 size_t i_size, i_nb_bytes;
150 unsigned int i_nb_samples;
151 mtime_t start_date, end_date;
153 struct aout_buffer_t * p_next;
156 /* Size of a frame for S/PDIF output. */
157 #define AOUT_SPDIF_SIZE 6144
159 /* Number of samples in an A/52 frame. */
160 #define A52_FRAME_NB 1536
162 /*****************************************************************************
163 * audio_date_t : date incrementation without long-term rounding errors
164 *****************************************************************************/
169 uint32_t i_remainder;
172 /*****************************************************************************
174 *****************************************************************************/
175 /* From common.c : */
176 #define aout_New(a) __aout_New(VLC_OBJECT(a))
177 VLC_EXPORT( aout_instance_t *, __aout_New, ( vlc_object_t * ) );
178 VLC_EXPORT( void, aout_Delete, ( aout_instance_t * ) );
179 VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, uint32_t ) );
180 VLC_EXPORT( void, aout_DateSet, ( audio_date_t *, mtime_t ) );
181 VLC_EXPORT( void, aout_DateMove, ( audio_date_t *, mtime_t ) );
182 VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) );
183 VLC_EXPORT( mtime_t, aout_DateIncrement, ( audio_date_t *, uint32_t ) );
186 #define aout_DecNew(a, b, c) __aout_DecNew(VLC_OBJECT(a), b, c)
187 VLC_EXPORT( aout_input_t *, __aout_DecNew, ( vlc_object_t *, aout_instance_t **, audio_sample_format_t * ) );
188 VLC_EXPORT( int, aout_DecDelete, ( aout_instance_t *, aout_input_t * ) );
189 VLC_EXPORT( aout_buffer_t *, aout_DecNewBuffer, ( aout_instance_t *, aout_input_t *, size_t ) );
190 VLC_EXPORT( void, aout_DecDeleteBuffer, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
191 VLC_EXPORT( int, aout_DecPlay, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
194 #define aout_VolumeGet(a, b) __aout_VolumeGet(VLC_OBJECT(a), b)
195 VLC_EXPORT( int, __aout_VolumeGet, ( vlc_object_t *, audio_volume_t * ) );
196 #define aout_VolumeSet(a, b) __aout_VolumeSet(VLC_OBJECT(a), b)
197 VLC_EXPORT( int, __aout_VolumeSet, ( vlc_object_t *, audio_volume_t ) );
198 #define aout_VolumeInfos(a, b) __aout_VolumeInfos(VLC_OBJECT(a), b)
199 VLC_EXPORT( int, __aout_VolumeInfos, ( vlc_object_t *, audio_volume_t * ) );
200 #define aout_VolumeUp(a, b, c) __aout_VolumeUp(VLC_OBJECT(a), b, c)
201 VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
202 #define aout_VolumeDown(a, b, c) __aout_VolumeDown(VLC_OBJECT(a), b, c)
203 VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
204 #define aout_VolumeMute(a, b) __aout_VolumeMute(VLC_OBJECT(a), b)
205 VLC_EXPORT( int, __aout_VolumeMute, ( vlc_object_t *, audio_volume_t * ) );
206 VLC_EXPORT( int, aout_Restart, ( aout_instance_t * p_aout ) );
207 VLC_EXPORT( void, aout_FindAndRestart, ( vlc_object_t * p_this ) );
208 VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );