indeo3: ensure that decoded cell data is in 7-bit range as presumed by decoder
[ffmpeg.git] / libavcodec / wma.h
1 /*
2  * WMA compatible codec
3  * Copyright (c) 2002-2007 The Libav Project
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVCODEC_WMA_H
23 #define AVCODEC_WMA_H
24
25 #include "get_bits.h"
26 #include "put_bits.h"
27 #include "dsputil.h"
28 #include "fft.h"
29 #include "fmtconvert.h"
30
31 /* size of blocks */
32 #define BLOCK_MIN_BITS 7
33 #define BLOCK_MAX_BITS 11
34 #define BLOCK_MAX_SIZE (1 << BLOCK_MAX_BITS)
35
36 #define BLOCK_NB_SIZES (BLOCK_MAX_BITS - BLOCK_MIN_BITS + 1)
37
38 /* XXX: find exact max size */
39 #define HIGH_BAND_MAX_SIZE 16
40
41 #define NB_LSP_COEFS 10
42
43 /* XXX: is it a suitable value ? */
44 #define MAX_CODED_SUPERFRAME_SIZE 16384
45
46 #define MAX_CHANNELS 2
47
48 #define NOISE_TAB_SIZE 8192
49
50 #define LSP_POW_BITS 7
51
52 //FIXME should be in wmadec
53 #define VLCBITS 9
54 #define VLCMAX ((22+VLCBITS-1)/VLCBITS)
55
56 typedef float WMACoef;          ///< type for decoded coefficients, int16_t would be enough for wma 1/2
57
58 typedef struct CoefVLCTable {
59     int n;                      ///< total number of codes
60     int max_level;
61     const uint32_t *huffcodes;  ///< VLC bit values
62     const uint8_t *huffbits;    ///< VLC bit size
63     const uint16_t *levels;     ///< table to build run/level tables
64 } CoefVLCTable;
65
66 typedef struct WMACodecContext {
67     AVCodecContext* avctx;
68     AVFrame frame;
69     GetBitContext gb;
70     PutBitContext pb;
71     int sample_rate;
72     int nb_channels;
73     int bit_rate;
74     int version;                            ///< 1 = 0x160 (WMAV1), 2 = 0x161 (WMAV2)
75     int block_align;
76     int use_bit_reservoir;
77     int use_variable_block_len;
78     int use_exp_vlc;                        ///< exponent coding: 0 = lsp, 1 = vlc + delta
79     int use_noise_coding;                   ///< true if perceptual noise is added
80     int byte_offset_bits;
81     VLC exp_vlc;
82     int exponent_sizes[BLOCK_NB_SIZES];
83     uint16_t exponent_bands[BLOCK_NB_SIZES][25];
84     int high_band_start[BLOCK_NB_SIZES];    ///< index of first coef in high band
85     int coefs_start;                        ///< first coded coef
86     int coefs_end[BLOCK_NB_SIZES];          ///< max number of coded coefficients
87     int exponent_high_sizes[BLOCK_NB_SIZES];
88     int exponent_high_bands[BLOCK_NB_SIZES][HIGH_BAND_MAX_SIZE];
89     VLC hgain_vlc;
90
91     /* coded values in high bands */
92     int high_band_coded[MAX_CHANNELS][HIGH_BAND_MAX_SIZE];
93     int high_band_values[MAX_CHANNELS][HIGH_BAND_MAX_SIZE];
94
95     /* there are two possible tables for spectral coefficients */
96 //FIXME the following 3 tables should be shared between decoders
97     VLC coef_vlc[2];
98     uint16_t *run_table[2];
99     float *level_table[2];
100     uint16_t *int_table[2];
101     const CoefVLCTable *coef_vlcs[2];
102     /* frame info */
103     int frame_len;                          ///< frame length in samples
104     int frame_len_bits;                     ///< frame_len = 1 << frame_len_bits
105     int nb_block_sizes;                     ///< number of block sizes
106     /* block info */
107     int reset_block_lengths;
108     int block_len_bits;                     ///< log2 of current block length
109     int next_block_len_bits;                ///< log2 of next block length
110     int prev_block_len_bits;                ///< log2 of prev block length
111     int block_len;                          ///< block length in samples
112     int block_num;                          ///< block number in current frame
113     int block_pos;                          ///< current position in frame
114     uint8_t ms_stereo;                      ///< true if mid/side stereo mode
115     uint8_t channel_coded[MAX_CHANNELS];    ///< true if channel is coded
116     int exponents_bsize[MAX_CHANNELS];      ///< log2 ratio frame/exp. length
117     DECLARE_ALIGNED(32, float, exponents)[MAX_CHANNELS][BLOCK_MAX_SIZE];
118     float max_exponent[MAX_CHANNELS];
119     WMACoef coefs1[MAX_CHANNELS][BLOCK_MAX_SIZE];
120     DECLARE_ALIGNED(32, float, coefs)[MAX_CHANNELS][BLOCK_MAX_SIZE];
121     DECLARE_ALIGNED(32, FFTSample, output)[BLOCK_MAX_SIZE * 2];
122     FFTContext mdct_ctx[BLOCK_NB_SIZES];
123     float *windows[BLOCK_NB_SIZES];
124     /* output buffer for one frame and the last for IMDCT windowing */
125     DECLARE_ALIGNED(32, float, frame_out)[MAX_CHANNELS][BLOCK_MAX_SIZE * 2];
126     /* last frame info */
127     uint8_t last_superframe[MAX_CODED_SUPERFRAME_SIZE + FF_INPUT_BUFFER_PADDING_SIZE]; /* padding added */
128     int last_bitoffset;
129     int last_superframe_len;
130     float noise_table[NOISE_TAB_SIZE];
131     int noise_index;
132     float noise_mult; /* XXX: suppress that and integrate it in the noise array */
133     /* lsp_to_curve tables */
134     float lsp_cos_table[BLOCK_MAX_SIZE];
135     float lsp_pow_e_table[256];
136     float lsp_pow_m_table1[(1 << LSP_POW_BITS)];
137     float lsp_pow_m_table2[(1 << LSP_POW_BITS)];
138     DSPContext dsp;
139     FmtConvertContext fmt_conv;
140
141 #ifdef TRACE
142     int frame_count;
143 #endif
144 } WMACodecContext;
145
146 extern const uint16_t ff_wma_critical_freqs[25];
147 extern const uint16_t ff_wma_hgain_huffcodes[37];
148 extern const uint8_t ff_wma_hgain_huffbits[37];
149 extern const float ff_wma_lsp_codebook[NB_LSP_COEFS][16];
150 extern const uint32_t ff_aac_scalefactor_code[121];
151 extern const uint8_t  ff_aac_scalefactor_bits[121];
152
153 int ff_wma_init(AVCodecContext * avctx, int flags2);
154 int ff_wma_total_gain_to_bits(int total_gain);
155 int ff_wma_end(AVCodecContext *avctx);
156 unsigned int ff_wma_get_large_val(GetBitContext* gb);
157 int ff_wma_run_level_decode(AVCodecContext* avctx, GetBitContext* gb,
158                             VLC *vlc,
159                             const float *level_table, const uint16_t *run_table,
160                             int version, WMACoef *ptr, int offset,
161                             int num_coefs, int block_len, int frame_len_bits,
162                             int coef_nb_bits);
163
164 #endif /* AVCODEC_WMA_H */