Remove a tab, somehow it sneaked past the hooks in the merge war.
[ffmpeg.git] / libavcodec / mpegaudio.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * mpeg audio declarations for both encoder and decoder.
24  */
25
26 #ifndef AVCODEC_MPEGAUDIO_H
27 #define AVCODEC_MPEGAUDIO_H
28
29 #ifndef CONFIG_FLOAT
30 #   define CONFIG_FLOAT 0
31 #endif
32
33 #include "avcodec.h"
34 #include "get_bits.h"
35 #include "dsputil.h"
36 #include "dct.h"
37
38 #define CONFIG_AUDIO_NONSHORT 0
39
40 /* max frame size, in samples */
41 #define MPA_FRAME_SIZE 1152
42
43 /* max compressed frame size */
44 #define MPA_MAX_CODED_FRAME_SIZE 1792
45
46 #define MPA_MAX_CHANNELS 2
47
48 #define SBLIMIT 32 /* number of subbands */
49
50 #define MPA_STEREO  0
51 #define MPA_JSTEREO 1
52 #define MPA_DUAL    2
53 #define MPA_MONO    3
54
55 /* header + layer + bitrate + freq + lsf/mpeg25 */
56 #define SAME_HEADER_MASK \
57    (0xffe00000 | (3 << 17) | (0xf << 12) | (3 << 10) | (3 << 19))
58
59 #define MP3_MASK 0xFFFE0CCF
60
61 #if CONFIG_MPEGAUDIO_HP
62 #define FRAC_BITS   23   /* fractional bits for sb_samples and dct */
63 #define WFRAC_BITS  16   /* fractional bits for window */
64 #else
65 #define FRAC_BITS   15   /* fractional bits for sb_samples and dct */
66 #define WFRAC_BITS  14   /* fractional bits for window */
67 #endif
68
69 #define FRAC_ONE    (1 << FRAC_BITS)
70
71 #define FIX(a)   ((int)((a) * FRAC_ONE))
72
73 #if CONFIG_FLOAT
74 typedef float OUT_INT;
75 #define OUT_FMT AV_SAMPLE_FMT_FLT
76 #elif CONFIG_MPEGAUDIO_HP && CONFIG_AUDIO_NONSHORT
77 typedef int32_t OUT_INT;
78 #define OUT_MAX INT32_MAX
79 #define OUT_MIN INT32_MIN
80 #define OUT_SHIFT (WFRAC_BITS + FRAC_BITS - 31)
81 #define OUT_FMT AV_SAMPLE_FMT_S32
82 #else
83 typedef int16_t OUT_INT;
84 #define OUT_MAX INT16_MAX
85 #define OUT_MIN INT16_MIN
86 #define OUT_SHIFT (WFRAC_BITS + FRAC_BITS - 15)
87 #define OUT_FMT AV_SAMPLE_FMT_S16
88 #endif
89
90 #if CONFIG_FLOAT
91 #   define INTFLOAT float
92 typedef float MPA_INT;
93 #elif FRAC_BITS <= 15
94 #   define INTFLOAT int
95 typedef int16_t MPA_INT;
96 #else
97 #   define INTFLOAT int
98 typedef int32_t MPA_INT;
99 #endif
100
101 #define BACKSTEP_SIZE 512
102 #define EXTRABYTES 24
103
104 /* layer 3 "granule" */
105 typedef struct GranuleDef {
106     uint8_t scfsi;
107     int part2_3_length;
108     int big_values;
109     int global_gain;
110     int scalefac_compress;
111     uint8_t block_type;
112     uint8_t switch_point;
113     int table_select[3];
114     int subblock_gain[3];
115     uint8_t scalefac_scale;
116     uint8_t count1table_select;
117     int region_size[3]; /* number of huffman codes in each region */
118     int preflag;
119     int short_start, long_end; /* long/short band indexes */
120     uint8_t scale_factors[40];
121     INTFLOAT sb_hybrid[SBLIMIT * 18]; /* 576 samples */
122 } GranuleDef;
123
124 #define MPA_DECODE_HEADER \
125     int frame_size; \
126     int error_protection; \
127     int layer; \
128     int sample_rate; \
129     int sample_rate_index; /* between 0 and 8 */ \
130     int bit_rate; \
131     int nb_channels; \
132     int mode; \
133     int mode_ext; \
134     int lsf;
135
136 typedef struct MPADecodeHeader {
137   MPA_DECODE_HEADER
138 } MPADecodeHeader;
139
140 typedef struct MPADecodeContext {
141     MPA_DECODE_HEADER
142     uint8_t last_buf[2*BACKSTEP_SIZE + EXTRABYTES];
143     int last_buf_size;
144     /* next header (used in free format parsing) */
145     uint32_t free_format_next_header;
146     GetBitContext gb;
147     GetBitContext in_gb;
148     DECLARE_ALIGNED(16, MPA_INT, synth_buf)[MPA_MAX_CHANNELS][512 * 2];
149     int synth_buf_offset[MPA_MAX_CHANNELS];
150     DECLARE_ALIGNED(16, INTFLOAT, sb_samples)[MPA_MAX_CHANNELS][36][SBLIMIT];
151     INTFLOAT mdct_buf[MPA_MAX_CHANNELS][SBLIMIT * 18]; /* previous samples, for layer 3 MDCT */
152     GranuleDef granules[2][2]; /* Used in Layer 3 */
153 #ifdef DEBUG
154     int frame_count;
155 #endif
156     int adu_mode; ///< 0 for standard mp3, 1 for adu formatted mp3
157     int dither_state;
158     int error_recognition;
159     AVCodecContext* avctx;
160 #if CONFIG_FLOAT
161     DCTContext dct;
162 #endif
163     void (*apply_window_mp3)(MPA_INT *synth_buf, MPA_INT *window,
164                              int *dither_state, OUT_INT *samples, int incr);
165 } MPADecodeContext;
166
167 /* layer 3 huffman tables */
168 typedef struct HuffTable {
169     int xsize;
170     const uint8_t *bits;
171     const uint16_t *codes;
172 } HuffTable;
173
174 int ff_mpa_l2_select_table(int bitrate, int nb_channels, int freq, int lsf);
175 int ff_mpa_decode_header(AVCodecContext *avctx, uint32_t head, int *sample_rate, int *channels, int *frame_size, int *bitrate);
176 extern MPA_INT ff_mpa_synth_window[];
177 void ff_mpa_synth_init(MPA_INT *window);
178 void ff_mpa_synth_filter(MPA_INT *synth_buf_ptr, int *synth_buf_offset,
179                          MPA_INT *window, int *dither_state,
180                          OUT_INT *samples, int incr,
181                          INTFLOAT sb_samples[SBLIMIT]);
182
183 void ff_mpa_synth_init_float(MPA_INT *window);
184 void ff_mpa_synth_filter_float(MPADecodeContext *s,
185                          MPA_INT *synth_buf_ptr, int *synth_buf_offset,
186                          MPA_INT *window, int *dither_state,
187                          OUT_INT *samples, int incr,
188                          INTFLOAT sb_samples[SBLIMIT]);
189
190 void ff_mpegaudiodec_init_mmx(MPADecodeContext *s);
191 void ff_mpegaudiodec_init_altivec(MPADecodeContext *s);
192
193 /* fast header check for resync */
194 static inline int ff_mpa_check_header(uint32_t header){
195     /* header */
196     if ((header & 0xffe00000) != 0xffe00000)
197         return -1;
198     /* layer check */
199     if ((header & (3<<17)) == 0)
200         return -1;
201     /* bit rate */
202     if ((header & (0xf<<12)) == 0xf<<12)
203         return -1;
204     /* frequency */
205     if ((header & (3<<10)) == 3<<10)
206         return -1;
207     return 0;
208 }
209
210 #endif /* AVCODEC_MPEGAUDIO_H */