da81ac5cc31b4c2e3f6be3db6d70d0964832d2a4
[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
37 #define CONFIG_AUDIO_NONSHORT 0
38
39 /* max frame size, in samples */
40 #define MPA_FRAME_SIZE 1152
41
42 /* max compressed frame size */
43 #define MPA_MAX_CODED_FRAME_SIZE 1792
44
45 #define MPA_MAX_CHANNELS 2
46
47 #define SBLIMIT 32 /* number of subbands */
48
49 #define MPA_STEREO  0
50 #define MPA_JSTEREO 1
51 #define MPA_DUAL    2
52 #define MPA_MONO    3
53
54 /* header + layer + bitrate + freq + lsf/mpeg25 */
55 #define SAME_HEADER_MASK \
56    (0xffe00000 | (3 << 17) | (0xf << 12) | (3 << 10) | (3 << 19))
57
58 #define MP3_MASK 0xFFFE0CCF
59
60 #if CONFIG_MPEGAUDIO_HP
61 #define FRAC_BITS   23   /* fractional bits for sb_samples and dct */
62 #define WFRAC_BITS  16   /* fractional bits for window */
63 #else
64 #define FRAC_BITS   15   /* fractional bits for sb_samples and dct */
65 #define WFRAC_BITS  14   /* fractional bits for window */
66 #endif
67
68 #define FRAC_ONE    (1 << FRAC_BITS)
69
70 #define FIX(a)   ((int)((a) * FRAC_ONE))
71
72 #if CONFIG_FLOAT
73 typedef float OUT_INT;
74 #define OUT_FMT SAMPLE_FMT_FLT
75 #elif CONFIG_MPEGAUDIO_HP && CONFIG_AUDIO_NONSHORT
76 typedef int32_t OUT_INT;
77 #define OUT_MAX INT32_MAX
78 #define OUT_MIN INT32_MIN
79 #define OUT_SHIFT (WFRAC_BITS + FRAC_BITS - 31)
80 #define OUT_FMT SAMPLE_FMT_S32
81 #else
82 typedef int16_t OUT_INT;
83 #define OUT_MAX INT16_MAX
84 #define OUT_MIN INT16_MIN
85 #define OUT_SHIFT (WFRAC_BITS + FRAC_BITS - 15)
86 #define OUT_FMT SAMPLE_FMT_S16
87 #endif
88
89 #if CONFIG_FLOAT
90 #   define INTFLOAT float
91 typedef float MPA_INT;
92 #elif FRAC_BITS <= 15
93 #   define INTFLOAT int
94 typedef int16_t MPA_INT;
95 #else
96 #   define INTFLOAT int
97 typedef int32_t MPA_INT;
98 #endif
99
100 #define BACKSTEP_SIZE 512
101 #define EXTRABYTES 24
102
103 /* layer 3 "granule" */
104 typedef struct GranuleDef {
105     uint8_t scfsi;
106     int part2_3_length;
107     int big_values;
108     int global_gain;
109     int scalefac_compress;
110     uint8_t block_type;
111     uint8_t switch_point;
112     int table_select[3];
113     int subblock_gain[3];
114     uint8_t scalefac_scale;
115     uint8_t count1table_select;
116     int region_size[3]; /* number of huffman codes in each region */
117     int preflag;
118     int short_start, long_end; /* long/short band indexes */
119     uint8_t scale_factors[40];
120     INTFLOAT sb_hybrid[SBLIMIT * 18]; /* 576 samples */
121 } GranuleDef;
122
123 #define MPA_DECODE_HEADER \
124     int frame_size; \
125     int error_protection; \
126     int layer; \
127     int sample_rate; \
128     int sample_rate_index; /* between 0 and 8 */ \
129     int bit_rate; \
130     int nb_channels; \
131     int mode; \
132     int mode_ext; \
133     int lsf;
134
135 typedef struct MPADecodeHeader {
136   MPA_DECODE_HEADER
137 } MPADecodeHeader;
138
139 typedef struct MPADecodeContext {
140     MPA_DECODE_HEADER
141     uint8_t last_buf[2*BACKSTEP_SIZE + EXTRABYTES];
142     int last_buf_size;
143     /* next header (used in free format parsing) */
144     uint32_t free_format_next_header;
145     GetBitContext gb;
146     GetBitContext in_gb;
147     DECLARE_ALIGNED(16, MPA_INT, synth_buf)[MPA_MAX_CHANNELS][512 * 2];
148     int synth_buf_offset[MPA_MAX_CHANNELS];
149     DECLARE_ALIGNED(16, INTFLOAT, sb_samples)[MPA_MAX_CHANNELS][36][SBLIMIT];
150     INTFLOAT mdct_buf[MPA_MAX_CHANNELS][SBLIMIT * 18]; /* previous samples, for layer 3 MDCT */
151     GranuleDef granules[2][2]; /* Used in Layer 3 */
152 #ifdef DEBUG
153     int frame_count;
154 #endif
155     int adu_mode; ///< 0 for standard mp3, 1 for adu formatted mp3
156     int dither_state;
157     int error_recognition;
158     AVCodecContext* avctx;
159     void (*apply_window_mp3)(MPA_INT *synth_buf, MPA_INT *window,
160                              int *dither_state, OUT_INT *samples, int incr);
161 } MPADecodeContext;
162
163 /* layer 3 huffman tables */
164 typedef struct HuffTable {
165     int xsize;
166     const uint8_t *bits;
167     const uint16_t *codes;
168 } HuffTable;
169
170 int ff_mpa_l2_select_table(int bitrate, int nb_channels, int freq, int lsf);
171 int ff_mpa_decode_header(AVCodecContext *avctx, uint32_t head, int *sample_rate, int *channels, int *frame_size, int *bitrate);
172 extern MPA_INT ff_mpa_synth_window[];
173 void ff_mpa_synth_init(MPA_INT *window);
174 void ff_mpa_synth_filter(MPA_INT *synth_buf_ptr, int *synth_buf_offset,
175                          MPA_INT *window, int *dither_state,
176                          OUT_INT *samples, int incr,
177                          INTFLOAT sb_samples[SBLIMIT]);
178
179 void ff_mpa_synth_init_float(MPA_INT *window);
180 void ff_mpa_synth_filter_float(MPADecodeContext *s,
181                          MPA_INT *synth_buf_ptr, int *synth_buf_offset,
182                          MPA_INT *window, int *dither_state,
183                          OUT_INT *samples, int incr,
184                          INTFLOAT sb_samples[SBLIMIT]);
185
186 void ff_mpegaudiodec_init_mmx(MPADecodeContext *s);
187
188 /* fast header check for resync */
189 static inline int ff_mpa_check_header(uint32_t header){
190     /* header */
191     if ((header & 0xffe00000) != 0xffe00000)
192         return -1;
193     /* layer check */
194     if ((header & (3<<17)) == 0)
195         return -1;
196     /* bit rate */
197     if ((header & (0xf<<12)) == 0xf<<12)
198         return -1;
199     /* frequency */
200     if ((header & (3<<10)) == 3<<10)
201         return -1;
202     return 0;
203 }
204
205 #endif /* AVCODEC_MPEGAUDIO_H */