indeo3: ensure that decoded cell data is in 7-bit range as presumed by decoder
[ffmpeg.git] / libavcodec / mpc7.c
1 /*
2  * Musepack SV7 decoder
3  * Copyright (c) 2006 Konstantin Shishkov
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 /**
23  * @file
24  * MPEG Audio Layer 1/2 -like codec with frames of 1152 samples
25  * divided into 32 subbands.
26  */
27
28 #include "libavutil/lfg.h"
29 #include "avcodec.h"
30 #include "get_bits.h"
31 #include "dsputil.h"
32 #include "mpegaudiodsp.h"
33 #include "libavutil/audioconvert.h"
34
35 #include "mpc.h"
36 #include "mpc7data.h"
37
38 #define BANDS            32
39 #define SAMPLES_PER_BAND 36
40 #define MPC_FRAME_SIZE   (BANDS * SAMPLES_PER_BAND)
41
42 static VLC scfi_vlc, dscf_vlc, hdr_vlc, quant_vlc[MPC7_QUANT_VLC_TABLES][2];
43
44 static const uint16_t quant_offsets[MPC7_QUANT_VLC_TABLES*2 + 1] =
45 {
46        0, 512, 1024, 1536, 2052, 2564, 3076, 3588, 4100, 4612, 5124,
47        5636, 6164, 6676, 7224
48 };
49
50
51 static av_cold int mpc7_decode_init(AVCodecContext * avctx)
52 {
53     int i, j;
54     MPCContext *c = avctx->priv_data;
55     GetBitContext gb;
56     LOCAL_ALIGNED_16(uint8_t, buf, [16]);
57     static int vlc_initialized = 0;
58
59     static VLC_TYPE scfi_table[1 << MPC7_SCFI_BITS][2];
60     static VLC_TYPE dscf_table[1 << MPC7_DSCF_BITS][2];
61     static VLC_TYPE hdr_table[1 << MPC7_HDR_BITS][2];
62     static VLC_TYPE quant_tables[7224][2];
63
64     /* Musepack SV7 is always stereo */
65     if (avctx->channels != 2) {
66         av_log_ask_for_sample(avctx, "Unsupported number of channels: %d\n",
67                               avctx->channels);
68         return AVERROR_PATCHWELCOME;
69     }
70
71     if(avctx->extradata_size < 16){
72         av_log(avctx, AV_LOG_ERROR, "Too small extradata size (%i)!\n", avctx->extradata_size);
73         return -1;
74     }
75     memset(c->oldDSCF, 0, sizeof(c->oldDSCF));
76     av_lfg_init(&c->rnd, 0xDEADBEEF);
77     ff_dsputil_init(&c->dsp, avctx);
78     ff_mpadsp_init(&c->mpadsp);
79     c->dsp.bswap_buf((uint32_t*)buf, (const uint32_t*)avctx->extradata, 4);
80     ff_mpc_init();
81     init_get_bits(&gb, buf, 128);
82
83     c->IS = get_bits1(&gb);
84     c->MSS = get_bits1(&gb);
85     c->maxbands = get_bits(&gb, 6);
86     if(c->maxbands >= BANDS){
87         av_log(avctx, AV_LOG_ERROR, "Too many bands: %i\n", c->maxbands);
88         return -1;
89     }
90     skip_bits_long(&gb, 88);
91     c->gapless = get_bits1(&gb);
92     c->lastframelen = get_bits(&gb, 11);
93     av_log(avctx, AV_LOG_DEBUG, "IS: %d, MSS: %d, TG: %d, LFL: %d, bands: %d\n",
94             c->IS, c->MSS, c->gapless, c->lastframelen, c->maxbands);
95     c->frames_to_skip = 0;
96
97     avctx->sample_fmt = AV_SAMPLE_FMT_S16;
98     avctx->channel_layout = AV_CH_LAYOUT_STEREO;
99
100     if(vlc_initialized) return 0;
101     av_log(avctx, AV_LOG_DEBUG, "Initing VLC\n");
102     scfi_vlc.table = scfi_table;
103     scfi_vlc.table_allocated = 1 << MPC7_SCFI_BITS;
104     if(init_vlc(&scfi_vlc, MPC7_SCFI_BITS, MPC7_SCFI_SIZE,
105                 &mpc7_scfi[1], 2, 1,
106                 &mpc7_scfi[0], 2, 1, INIT_VLC_USE_NEW_STATIC)){
107         av_log(avctx, AV_LOG_ERROR, "Cannot init SCFI VLC\n");
108         return -1;
109     }
110     dscf_vlc.table = dscf_table;
111     dscf_vlc.table_allocated = 1 << MPC7_DSCF_BITS;
112     if(init_vlc(&dscf_vlc, MPC7_DSCF_BITS, MPC7_DSCF_SIZE,
113                 &mpc7_dscf[1], 2, 1,
114                 &mpc7_dscf[0], 2, 1, INIT_VLC_USE_NEW_STATIC)){
115         av_log(avctx, AV_LOG_ERROR, "Cannot init DSCF VLC\n");
116         return -1;
117     }
118     hdr_vlc.table = hdr_table;
119     hdr_vlc.table_allocated = 1 << MPC7_HDR_BITS;
120     if(init_vlc(&hdr_vlc, MPC7_HDR_BITS, MPC7_HDR_SIZE,
121                 &mpc7_hdr[1], 2, 1,
122                 &mpc7_hdr[0], 2, 1, INIT_VLC_USE_NEW_STATIC)){
123         av_log(avctx, AV_LOG_ERROR, "Cannot init HDR VLC\n");
124         return -1;
125     }
126     for(i = 0; i < MPC7_QUANT_VLC_TABLES; i++){
127         for(j = 0; j < 2; j++){
128             quant_vlc[i][j].table = &quant_tables[quant_offsets[i*2 + j]];
129             quant_vlc[i][j].table_allocated = quant_offsets[i*2 + j + 1] - quant_offsets[i*2 + j];
130             if(init_vlc(&quant_vlc[i][j], 9, mpc7_quant_vlc_sizes[i],
131                         &mpc7_quant_vlc[i][j][1], 4, 2,
132                         &mpc7_quant_vlc[i][j][0], 4, 2, INIT_VLC_USE_NEW_STATIC)){
133                 av_log(avctx, AV_LOG_ERROR, "Cannot init QUANT VLC %i,%i\n",i,j);
134                 return -1;
135             }
136         }
137     }
138     vlc_initialized = 1;
139
140     avcodec_get_frame_defaults(&c->frame);
141     avctx->coded_frame = &c->frame;
142
143     return 0;
144 }
145
146 /**
147  * Fill samples for given subband
148  */
149 static inline void idx_to_quant(MPCContext *c, GetBitContext *gb, int idx, int *dst)
150 {
151     int i, i1, t;
152     switch(idx){
153     case -1:
154         for(i = 0; i < SAMPLES_PER_BAND; i++){
155             *dst++ = (av_lfg_get(&c->rnd) & 0x3FC) - 510;
156         }
157         break;
158     case 1:
159         i1 = get_bits1(gb);
160         for(i = 0; i < SAMPLES_PER_BAND/3; i++){
161             t = get_vlc2(gb, quant_vlc[0][i1].table, 9, 2);
162             *dst++ = mpc7_idx30[t];
163             *dst++ = mpc7_idx31[t];
164             *dst++ = mpc7_idx32[t];
165         }
166         break;
167     case 2:
168         i1 = get_bits1(gb);
169         for(i = 0; i < SAMPLES_PER_BAND/2; i++){
170             t = get_vlc2(gb, quant_vlc[1][i1].table, 9, 2);
171             *dst++ = mpc7_idx50[t];
172             *dst++ = mpc7_idx51[t];
173         }
174         break;
175     case  3: case  4: case  5: case  6: case  7:
176         i1 = get_bits1(gb);
177         for(i = 0; i < SAMPLES_PER_BAND; i++)
178             *dst++ = get_vlc2(gb, quant_vlc[idx-1][i1].table, 9, 2) - mpc7_quant_vlc_off[idx-1];
179         break;
180     case  8: case  9: case 10: case 11: case 12:
181     case 13: case 14: case 15: case 16: case 17:
182         t = (1 << (idx - 2)) - 1;
183         for(i = 0; i < SAMPLES_PER_BAND; i++)
184             *dst++ = get_bits(gb, idx - 1) - t;
185         break;
186     default: // case 0 and -2..-17
187         return;
188     }
189 }
190
191 static int get_scale_idx(GetBitContext *gb, int ref)
192 {
193     int t = get_vlc2(gb, dscf_vlc.table, MPC7_DSCF_BITS, 1) - 7;
194     if (t == 8)
195         return get_bits(gb, 6);
196     return av_clip_uintp2(ref + t, 7);
197 }
198
199 static int mpc7_decode_frame(AVCodecContext * avctx, void *data,
200                              int *got_frame_ptr, AVPacket *avpkt)
201 {
202     const uint8_t *buf = avpkt->data;
203     int buf_size;
204     MPCContext *c = avctx->priv_data;
205     GetBitContext gb;
206     int i, ch;
207     int mb = -1;
208     Band *bands = c->bands;
209     int off, ret, last_frame, skip;
210     int bits_used, bits_avail;
211
212     memset(bands, 0, sizeof(*bands) * (c->maxbands + 1));
213
214     buf_size = avpkt->size & ~3;
215     if (buf_size <= 0) {
216         av_log(avctx, AV_LOG_ERROR, "packet size is too small (%i bytes)\n",
217                avpkt->size);
218         return AVERROR_INVALIDDATA;
219     }
220     if (buf_size != avpkt->size) {
221         av_log(avctx, AV_LOG_WARNING, "packet size is not a multiple of 4. "
222                "extra bytes at the end will be skipped.\n");
223     }
224
225     skip       = buf[0];
226     last_frame = buf[1];
227     buf       += 4;
228     buf_size  -= 4;
229
230     /* get output buffer */
231     c->frame.nb_samples = last_frame ? c->lastframelen : MPC_FRAME_SIZE;
232     if ((ret = avctx->get_buffer(avctx, &c->frame)) < 0) {
233         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
234         return ret;
235     }
236
237     av_fast_padded_malloc(&c->bits, &c->buf_size, buf_size);
238     if (!c->bits)
239         return AVERROR(ENOMEM);
240     c->dsp.bswap_buf((uint32_t *)c->bits, (const uint32_t *)buf, buf_size >> 2);
241     init_get_bits(&gb, c->bits, buf_size * 8);
242     skip_bits_long(&gb, skip);
243
244     /* read subband indexes */
245     for(i = 0; i <= c->maxbands; i++){
246         for(ch = 0; ch < 2; ch++){
247             int t = 4;
248             if(i) t = get_vlc2(&gb, hdr_vlc.table, MPC7_HDR_BITS, 1) - 5;
249             if(t == 4) bands[i].res[ch] = get_bits(&gb, 4);
250             else bands[i].res[ch] = av_clip(bands[i-1].res[ch] + t, 0, 17);
251         }
252
253         if(bands[i].res[0] || bands[i].res[1]){
254             mb = i;
255             if(c->MSS) bands[i].msf = get_bits1(&gb);
256         }
257     }
258     /* get scale indexes coding method */
259     for(i = 0; i <= mb; i++)
260         for(ch = 0; ch < 2; ch++)
261             if(bands[i].res[ch]) bands[i].scfi[ch] = get_vlc2(&gb, scfi_vlc.table, MPC7_SCFI_BITS, 1);
262     /* get scale indexes */
263     for(i = 0; i <= mb; i++){
264         for(ch = 0; ch < 2; ch++){
265             if(bands[i].res[ch]){
266                 bands[i].scf_idx[ch][2] = c->oldDSCF[ch][i];
267                 bands[i].scf_idx[ch][0] = get_scale_idx(&gb, bands[i].scf_idx[ch][2]);
268                 switch(bands[i].scfi[ch]){
269                 case 0:
270                     bands[i].scf_idx[ch][1] = get_scale_idx(&gb, bands[i].scf_idx[ch][0]);
271                     bands[i].scf_idx[ch][2] = get_scale_idx(&gb, bands[i].scf_idx[ch][1]);
272                     break;
273                 case 1:
274                     bands[i].scf_idx[ch][1] = get_scale_idx(&gb, bands[i].scf_idx[ch][0]);
275                     bands[i].scf_idx[ch][2] = bands[i].scf_idx[ch][1];
276                     break;
277                 case 2:
278                     bands[i].scf_idx[ch][1] = bands[i].scf_idx[ch][0];
279                     bands[i].scf_idx[ch][2] = get_scale_idx(&gb, bands[i].scf_idx[ch][1]);
280                     break;
281                 case 3:
282                     bands[i].scf_idx[ch][2] = bands[i].scf_idx[ch][1] = bands[i].scf_idx[ch][0];
283                     break;
284                 }
285                 c->oldDSCF[ch][i] = bands[i].scf_idx[ch][2];
286             }
287         }
288     }
289     /* get quantizers */
290     memset(c->Q, 0, sizeof(c->Q));
291     off = 0;
292     for(i = 0; i < BANDS; i++, off += SAMPLES_PER_BAND)
293         for(ch = 0; ch < 2; ch++)
294             idx_to_quant(c, &gb, bands[i].res[ch], c->Q[ch] + off);
295
296     ff_mpc_dequantize_and_synth(c, mb, c->frame.data[0], 2);
297
298     bits_used = get_bits_count(&gb);
299     bits_avail = buf_size * 8;
300     if (!last_frame && ((bits_avail < bits_used) || (bits_used + 32 <= bits_avail))) {
301         av_log(avctx, AV_LOG_ERROR, "Error decoding frame: used %i of %i bits\n", bits_used, bits_avail);
302         return -1;
303     }
304     if(c->frames_to_skip){
305         c->frames_to_skip--;
306         *got_frame_ptr = 0;
307         return avpkt->size;
308     }
309
310     *got_frame_ptr   = 1;
311     *(AVFrame *)data = c->frame;
312
313     return avpkt->size;
314 }
315
316 static void mpc7_decode_flush(AVCodecContext *avctx)
317 {
318     MPCContext *c = avctx->priv_data;
319
320     memset(c->oldDSCF, 0, sizeof(c->oldDSCF));
321     c->frames_to_skip = 32;
322 }
323
324 static av_cold int mpc7_decode_close(AVCodecContext *avctx)
325 {
326     MPCContext *c = avctx->priv_data;
327     av_freep(&c->bits);
328     c->buf_size = 0;
329     return 0;
330 }
331
332 AVCodec ff_mpc7_decoder = {
333     .name           = "mpc7",
334     .type           = AVMEDIA_TYPE_AUDIO,
335     .id             = CODEC_ID_MUSEPACK7,
336     .priv_data_size = sizeof(MPCContext),
337     .init           = mpc7_decode_init,
338     .close          = mpc7_decode_close,
339     .decode         = mpc7_decode_frame,
340     .flush          = mpc7_decode_flush,
341     .capabilities   = CODEC_CAP_DR1,
342     .long_name      = NULL_IF_CONFIG_SMALL("Musepack SV7"),
343 };