5e20a08660f4f6f5c6aaf8042171814ea483bfba
[vlc.git] / include / audio_output.h
1 /*****************************************************************************
2  * audio_output.h : audio output interface
3  *****************************************************************************
4  * Copyright (C) 2002 VideoLAN
5  * $Id: audio_output.h,v 1.76 2003/02/02 00:57:20 jobi Exp $
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * audio_sample_format_t
26  *****************************************************************************
27  * This structure defines a format for audio samples.
28  *****************************************************************************/
29 struct audio_sample_format_t
30 {
31     vlc_fourcc_t        i_format;
32     unsigned int        i_rate;
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
48      */
49 };
50
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) )
56
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) )
62
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')
66 #else
67 #   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','l')
68 #   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','l')
69 #endif
70
71 #define AFMT_S16_NE AOUT_FMT_S16_NE
72 #define AFMT_U16_NE AOUT_FMT_U16_NE
73
74 #define AOUT_FMT_NON_LINEAR( p_format )                                    \
75     ( ((p_format)->i_format == VLC_FOURCC('s','p','d','i'))                \
76        || ((p_format)->i_format == VLC_FOURCC('a','5','2',' '))            \
77        || ((p_format)->i_format == VLC_FOURCC('d','t','s',' ')) )
78
79 /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
80 /*
81  * Fixed-point format: 0xABBBBBBB
82  * A == whole part      (sign + 3 bits)
83  * B == fractional part (28 bits)
84  *
85  * Values are signed two's complement, so the effective range is:
86  * 0x80000000 to 0x7fffffff
87  *       -8.0 to +7.9999999962747097015380859375
88  *
89  * The smallest representable value is:
90  * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
91  *
92  * 28 bits of fractional accuracy represent about
93  * 8.6 digits of decimal accuracy.
94  *
95  * Fixed-point numbers can be added or subtracted as normal
96  * integers, but multiplication requires shifting the 64-bit result
97  * from 56 fractional bits back to 28 (and rounding.)
98  */
99 typedef int32_t vlc_fixed_t;
100 #define FIXED32_FRACBITS 28
101 #define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
102 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
103 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
104
105
106 /*
107  * Channels descriptions
108  */
109
110 /* Values available for physical and original channels */
111 #define AOUT_CHAN_CENTER            0x1
112 #define AOUT_CHAN_LEFT              0x2
113 #define AOUT_CHAN_RIGHT             0x4
114 #define AOUT_CHAN_REARCENTER        0x10
115 #define AOUT_CHAN_REARLEFT          0x20
116 #define AOUT_CHAN_REARRIGHT         0x40
117 #define AOUT_CHAN_LFE               0x100
118
119 /* Values available for original channels only */
120 #define AOUT_CHAN_DOLBYSTEREO       0x10000
121 #define AOUT_CHAN_DUALMONO          0x20000
122 #define AOUT_CHAN_REVERSESTEREO     0x40000
123
124 #define AOUT_CHAN_PHYSMASK          0xFFFF
125
126
127 /*****************************************************************************
128  * aout_buffer_t : audio output buffer
129  *****************************************************************************/
130 struct aout_buffer_t
131 {
132     byte_t *                p_buffer;
133     int                     i_alloc_type;
134     /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
135      * is the number of significative bytes in it. */
136     size_t                  i_size, i_nb_bytes;
137     unsigned int            i_nb_samples;
138     mtime_t                 start_date, end_date;
139
140     struct aout_buffer_t *  p_next;
141 };
142
143 /* Size of a frame for S/PDIF output. */
144 #define AOUT_SPDIF_SIZE 6144
145
146 /* Number of samples in an A/52 frame. */
147 #define A52_FRAME_NB 1536
148
149 /*****************************************************************************
150  * audio_date_t : date incrementation without long-term rounding errors
151  *****************************************************************************/
152 struct audio_date_t
153 {
154     mtime_t  date;
155     uint32_t i_divider;
156     uint32_t i_remainder;
157 };
158
159 /*****************************************************************************
160  * Prototypes
161  *****************************************************************************/
162 /* From common.c : */
163 #define aout_New(a) __aout_New(VLC_OBJECT(a))
164 VLC_EXPORT( aout_instance_t *, __aout_New, ( vlc_object_t * ) );
165 VLC_EXPORT( void, aout_Delete, ( aout_instance_t * ) );
166 VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, uint32_t ) );
167 VLC_EXPORT( void, aout_DateSet, ( audio_date_t *, mtime_t ) );
168 VLC_EXPORT( void, aout_DateMove, ( audio_date_t *, mtime_t ) );
169 VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) );
170 VLC_EXPORT( mtime_t, aout_DateIncrement, ( audio_date_t *, uint32_t ) );
171
172 /* From dec.c : */
173 #define aout_DecNew(a, b, c) __aout_DecNew(VLC_OBJECT(a), b, c)
174 VLC_EXPORT( aout_input_t *, __aout_DecNew, ( vlc_object_t *, aout_instance_t **, audio_sample_format_t * ) );
175 VLC_EXPORT( int, aout_DecDelete, ( aout_instance_t *, aout_input_t * ) );
176 VLC_EXPORT( aout_buffer_t *, aout_DecNewBuffer, ( aout_instance_t *, aout_input_t *, size_t ) );
177 VLC_EXPORT( void, aout_DecDeleteBuffer, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
178 VLC_EXPORT( int, aout_DecPlay, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
179
180 /* From intf.c : */
181 VLC_EXPORT( int, aout_VolumeGet, ( aout_instance_t *, audio_volume_t * ) );
182 VLC_EXPORT( int, aout_VolumeSet, ( aout_instance_t *, audio_volume_t ) );
183 VLC_EXPORT( int, aout_VolumeInfos, ( aout_instance_t *, audio_volume_t * ) );
184 VLC_EXPORT( int, aout_VolumeUp, ( aout_instance_t *, int, audio_volume_t * ) );
185 VLC_EXPORT( int, aout_VolumeDown, ( aout_instance_t *, int, audio_volume_t * ) );
186 VLC_EXPORT( int, aout_VolumeMute, ( aout_instance_t *, audio_volume_t * ) );
187 VLC_EXPORT( int, aout_Restart, ( aout_instance_t * p_aout ) );
188 VLC_EXPORT( void, aout_FindAndRestart, ( vlc_object_t * p_this ) );
189 VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
190