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