3 * Copyright (c) 2001 Fabrice Bellard.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * First version by Francois Revol revol@free.fr
24 * Features and limitations:
26 * Reference documents:
27 * http://www.pcisys.net/~melanson/codecs/adpcm.txt
28 * http://www.geocities.com/SiliconValley/8682/aud3.txt
29 * http://openquicktime.sourceforge.net/plugins.htm
30 * XAnim sources (xa_codec.c) http://www.rasnaimaging.com/people/lapus/download.html
31 * http://www.cs.ucla.edu/~leec/mediabench/applications.html
32 * SoX source code http://home.sprynet.com/~cbagwell/sox.html
37 #define CLAMP_TO_SHORT(value) \
40 else if (value < -32768) \
43 /* step_table[] and index_table[] are from the ADPCM reference source */
44 /* This is the index table: */
45 static int index_table
[16] = {
46 -1, -1, -1, -1, 2, 4, 6, 8,
47 -1, -1, -1, -1, 2, 4, 6, 8,
50 /* This is the step table. Note that many programs use slight deviations from
51 * this table, but such deviations are negligible:
53 static int step_table
[89] = {
54 7, 8, 9, 10, 11, 12, 13, 14, 16, 17,
55 19, 21, 23, 25, 28, 31, 34, 37, 41, 45,
56 50, 55, 60, 66, 73, 80, 88, 97, 107, 118,
57 130, 143, 157, 173, 190, 209, 230, 253, 279, 307,
58 337, 371, 408, 449, 494, 544, 598, 658, 724, 796,
59 876, 963, 1060, 1166, 1282, 1411, 1552, 1707, 1878, 2066,
60 2272, 2499, 2749, 3024, 3327, 3660, 4026, 4428, 4871, 5358,
61 5894, 6484, 7132, 7845, 8630, 9493, 10442, 11487, 12635, 13899,
62 15289, 16818, 18500, 20350, 22385, 24623, 27086, 29794, 32767
65 /* Those are for MS-ADPCM */
66 /* AdaptationTable[], AdaptCoeff1[], and AdaptCoeff2[] are from libsndfile */
67 static int AdaptationTable
[] = {
68 230, 230, 230, 230, 307, 409, 512, 614,
69 768, 614, 512, 409, 307, 230, 230, 230
72 static int AdaptCoeff1
[] = {
73 256, 512, 0, 192, 240, 460, 392
76 static int AdaptCoeff2
[] = {
77 0, -256, 0, 64, 0, -208, -232
82 typedef struct ADPCMChannelStatus
{
97 typedef struct ADPCMContext
{
98 int channel
; /* for stereo MOVs, decode left, then decode right, then tell it's decoded */
99 ADPCMChannelStatus status
[2];
100 short sample_buffer
[32]; /* hold left samples while waiting for right samples */
103 /* XXX: implement encoding */
105 static int adpcm_encode_init(AVCodecContext
*avctx
)
107 if (avctx
->channels
> 2)
108 return -1; /* only stereo or mono =) */
109 switch(avctx
->codec
->id
) {
110 case CODEC_ID_ADPCM_IMA_QT
:
111 fprintf(stderr
, "ADPCM: codec admcp_ima_qt unsupported for encoding !\n");
112 avctx
->frame_size
= 64; /* XXX: can multiple of avctx->channels * 64 (left and right blocks are interleaved) */
115 case CODEC_ID_ADPCM_IMA_WAV
:
116 avctx
->frame_size
= (BLKSIZE
- 4 * avctx
->channels
) * 8 / (4 * avctx
->channels
) + 1; /* each 16 bits sample gives one nibble */
117 /* and we have 4 bytes per channel overhead */
118 avctx
->block_align
= BLKSIZE
;
119 /* seems frame_size isn't taken into account... have to buffer the samples :-( */
121 case CODEC_ID_ADPCM_MS
:
122 fprintf(stderr
, "ADPCM: codec admcp_ms unsupported for encoding !\n");
130 avctx
->coded_frame
= avcodec_alloc_frame();
131 avctx
->coded_frame
->key_frame
= 1;
136 static int adpcm_encode_close(AVCodecContext
*avctx
)
138 av_freep(&avctx
->coded_frame
);
144 static inline unsigned char adpcm_ima_compress_sample(ADPCMChannelStatus
*c
, short sample
)
147 unsigned char nibble
;
149 int sign
= 0; /* sign bit of the nibble (MSB) */
150 int delta
, predicted_delta
;
152 delta
= sample
- c
->prev_sample
;
159 step_index
= c
->step_index
;
161 /* nibble = 4 * delta / step_table[step_index]; */
162 nibble
= (delta
<< 2) / step_table
[step_index
];
167 step_index
+= index_table
[nibble
];
173 /* what the decoder will find */
174 predicted_delta
= ((step_table
[step_index
] * nibble
) / 4) + (step_table
[step_index
] / 8);
177 c
->prev_sample
-= predicted_delta
;
179 c
->prev_sample
+= predicted_delta
;
181 CLAMP_TO_SHORT(c
->prev_sample
);
184 nibble
+= sign
<< 3; /* sign * 8 */
187 c
->step_index
= step_index
;
192 static int adpcm_encode_frame(AVCodecContext
*avctx
,
193 unsigned char *frame
, int buf_size
, void *data
)
198 ADPCMContext
*c
= avctx
->priv_data
;
201 samples
= (short *)data
;
202 /* n = (BLKSIZE - 4 * avctx->channels) / (2 * 8 * avctx->channels); */
204 switch(avctx
->codec
->id
) {
205 case CODEC_ID_ADPCM_IMA_QT
: /* XXX: can't test until we get .mov writer */
207 case CODEC_ID_ADPCM_IMA_WAV
:
208 n
= avctx
->frame_size
/ 8;
209 c
->status
[0].prev_sample
= (signed short)samples
[0]; /* XXX */
210 /* c->status[0].step_index = 0; *//* XXX: not sure how to init the state machine */
211 *dst
++ = (c
->status
[0].prev_sample
) & 0xFF; /* little endian */
212 *dst
++ = (c
->status
[0].prev_sample
>> 8) & 0xFF;
213 *dst
++ = (unsigned char)c
->status
[0].step_index
;
214 *dst
++ = 0; /* unknown */
216 if (avctx
->channels
== 2) {
217 c
->status
[1].prev_sample
= (signed short)samples
[0];
218 /* c->status[1].step_index = 0; */
219 *dst
++ = (c
->status
[1].prev_sample
) & 0xFF;
220 *dst
++ = (c
->status
[1].prev_sample
>> 8) & 0xFF;
221 *dst
++ = (unsigned char)c
->status
[1].step_index
;
226 /* stereo: 4 bytes (8 samples) for left, 4 bytes for right, 4 bytes left, ... */
228 *dst
= adpcm_ima_compress_sample(&c
->status
[0], samples
[0]) & 0x0F;
229 *dst
|= (adpcm_ima_compress_sample(&c
->status
[0], samples
[avctx
->channels
]) << 4) & 0xF0;
231 *dst
= adpcm_ima_compress_sample(&c
->status
[0], samples
[avctx
->channels
* 2]) & 0x0F;
232 *dst
|= (adpcm_ima_compress_sample(&c
->status
[0], samples
[avctx
->channels
* 3]) << 4) & 0xF0;
234 *dst
= adpcm_ima_compress_sample(&c
->status
[0], samples
[avctx
->channels
* 4]) & 0x0F;
235 *dst
|= (adpcm_ima_compress_sample(&c
->status
[0], samples
[avctx
->channels
* 5]) << 4) & 0xF0;
237 *dst
= adpcm_ima_compress_sample(&c
->status
[0], samples
[avctx
->channels
* 6]) & 0x0F;
238 *dst
|= (adpcm_ima_compress_sample(&c
->status
[0], samples
[avctx
->channels
* 7]) << 4) & 0xF0;
241 if (avctx
->channels
== 2) {
242 *dst
= adpcm_ima_compress_sample(&c
->status
[1], samples
[1]);
243 *dst
|= adpcm_ima_compress_sample(&c
->status
[1], samples
[3]) << 4;
245 *dst
= adpcm_ima_compress_sample(&c
->status
[1], samples
[5]);
246 *dst
|= adpcm_ima_compress_sample(&c
->status
[1], samples
[7]) << 4;
248 *dst
= adpcm_ima_compress_sample(&c
->status
[1], samples
[9]);
249 *dst
|= adpcm_ima_compress_sample(&c
->status
[1], samples
[11]) << 4;
251 *dst
= adpcm_ima_compress_sample(&c
->status
[1], samples
[13]);
252 *dst
|= adpcm_ima_compress_sample(&c
->status
[1], samples
[15]) << 4;
255 samples
+= 8 * avctx
->channels
;
264 static int adpcm_decode_init(AVCodecContext
* avctx
)
266 ADPCMContext
*c
= avctx
->priv_data
;
269 c
->status
[0].predictor
= c
->status
[1].predictor
= 0;
270 c
->status
[0].step_index
= c
->status
[1].step_index
= 0;
271 c
->status
[0].step
= c
->status
[1].step
= 0;
273 switch(avctx
->codec
->id
) {
280 static inline short adpcm_ima_expand_nibble(ADPCMChannelStatus
*c
, char nibble
)
284 int sign
, delta
, diff
, step
;
286 predictor
= c
->predictor
;
287 step_index
= c
->step_index
+ index_table
[(unsigned)nibble
];
288 if (step_index
< 0) step_index
= 0;
289 if (step_index
> 88) step_index
= 88;
294 diff = ((signed)((nibble & 0x08)?(nibble | 0xF0):(nibble)) + 0.5) * step / 4;
300 if (delta
& 4) diff
+= step
;
301 if (delta
& 2) diff
+= step
>> 1;
302 if (delta
& 1) diff
+= step
>> 2;
303 if (sign
) predictor
-= diff
;
304 else predictor
+= diff
;
306 CLAMP_TO_SHORT(predictor
);
307 c
->predictor
= predictor
;
308 c
->step_index
= step_index
;
309 c
->step
= step_table
[step_index
];
311 return (short)predictor
;
314 static inline short adpcm_ms_expand_nibble(ADPCMChannelStatus
*c
, char nibble
)
318 predictor
= (((c
->sample1
) * (c
->coeff1
)) + ((c
->sample2
) * (c
->coeff2
))) / 256;
319 predictor
+= (signed)((nibble
& 0x08)?(nibble
- 0x10):(nibble
)) * c
->idelta
;
320 CLAMP_TO_SHORT(predictor
);
322 c
->sample2
= c
->sample1
;
323 c
->sample1
= predictor
;
324 c
->idelta
= (AdaptationTable
[(int)nibble
] * c
->idelta
) / 256;
325 if (c
->idelta
< 16) c
->idelta
= 16;
327 return (short)predictor
;
330 static int adpcm_decode_frame(AVCodecContext
*avctx
,
331 void *data
, int *data_size
,
332 UINT8
*buf
, int buf_size
)
334 ADPCMContext
*c
= avctx
->priv_data
;
335 ADPCMChannelStatus
*cs
;
337 int block_predictor
[2];
345 st
= avctx
->channels
== 2;
347 switch(avctx
->codec
->id
) {
348 case CODEC_ID_ADPCM_IMA_QT
:
349 n
= (buf_size
- 2);/* >> 2*avctx->channels;*/
350 channel
= c
->channel
;
351 cs
= &(c
->status
[channel
]);
352 /* (pppppp) (piiiiiii) */
354 /* Bits 15-7 are the _top_ 9 bits of the 16-bit initial predictor value */
355 cs
->predictor
= (*src
++) << 8;
356 cs
->predictor
|= (*src
& 0x80);
357 cs
->predictor
&= 0xFF80;
360 if(cs
->predictor
& 0x8000)
361 cs
->predictor
-= 0x10000;
363 CLAMP_TO_SHORT(cs
->predictor
);
365 cs
->step_index
= (*src
++) & 0x7F;
367 if (cs
->step_index
> 88) fprintf(stderr
, "ERROR: step_index = %i\n", cs
->step_index
);
368 if (cs
->step_index
> 88) cs
->step_index
= 88;
370 cs
->step
= step_table
[cs
->step_index
];
375 *samples
++ = cs
->predictor
;
378 for(m
=32; n
>0 && m
>0; n
--, m
--) { /* in QuickTime, IMA is encoded by chuncks of 34 bytes (=64 samples) */
379 *samples
= adpcm_ima_expand_nibble(cs
, src
[0] & 0x0F);
380 samples
+= avctx
->channels
;
381 *samples
= adpcm_ima_expand_nibble(cs
, (src
[0] >> 4) & 0x0F);
382 samples
+= avctx
->channels
;
386 if(st
) { /* handle stereo interlacing */
387 c
->channel
= (channel
+ 1) % 2; /* we get one packet for left, then one for right data */
388 if(channel
== 0) { /* wait for the other packet before outputing anything */
394 case CODEC_ID_ADPCM_IMA_WAV
:
395 if (buf_size
> BLKSIZE
) {
396 if (avctx
->block_align
!= 0)
397 buf_size
= avctx
->block_align
;
401 n
= buf_size
- 4 * avctx
->channels
;
402 cs
= &(c
->status
[0]);
403 cs
->predictor
= (*src
++) & 0x0FF;
404 cs
->predictor
|= ((*src
++) << 8) & 0x0FF00;
405 if(cs
->predictor
& 0x8000)
406 cs
->predictor
-= 0x10000;
407 CLAMP_TO_SHORT(cs
->predictor
);
409 *samples
++ = cs
->predictor
;
411 cs
->step_index
= *src
++;
412 if (cs
->step_index
< 0) cs
->step_index
= 0;
413 if (cs
->step_index
> 88) cs
->step_index
= 88;
414 if (*src
++) fprintf(stderr
, "unused byte should be null !!\n"); /* unused */
417 cs
= &(c
->status
[1]);
418 cs
->predictor
= (*src
++) & 0x0FF;
419 cs
->predictor
|= ((*src
++) << 8) & 0x0FF00;
420 if(cs
->predictor
& 0x8000)
421 cs
->predictor
-= 0x10000;
422 CLAMP_TO_SHORT(cs
->predictor
);
424 *samples
++ = cs
->predictor
;
426 cs
->step_index
= *src
++;
427 if (cs
->step_index
< 0) cs
->step_index
= 0;
428 if (cs
->step_index
> 88) cs
->step_index
= 88;
431 cs
= &(c
->status
[0]);
434 for(m
=3; n
>0; n
--, m
--) {
435 *samples
++ = adpcm_ima_expand_nibble(&c
->status
[0], src
[0] & 0x0F);
437 *samples
++ = adpcm_ima_expand_nibble(&c
->status
[1], src
[4] & 0x0F);
438 *samples
++ = adpcm_ima_expand_nibble(&c
->status
[0], (src
[0] >> 4) & 0x0F);
440 *samples
++ = adpcm_ima_expand_nibble(&c
->status
[1], (src
[4] >> 4) & 0x0F);
448 case CODEC_ID_ADPCM_MS
:
450 if (buf_size
> BLKSIZE
) {
451 if (avctx
->block_align
!= 0)
452 buf_size
= avctx
->block_align
;
456 n
= buf_size
- 7 * avctx
->channels
;
459 block_predictor
[0] = (*src
++); /* should be bound */
460 block_predictor
[0] = (block_predictor
[0] < 0)?(0):((block_predictor
[0] > 7)?(7):(block_predictor
[0]));
461 block_predictor
[1] = 0;
463 block_predictor
[1] = (*src
++);
464 block_predictor
[1] = (block_predictor
[1] < 0)?(0):((block_predictor
[1] > 7)?(7):(block_predictor
[1]));
465 c
->status
[0].idelta
= ((*src
& 0xFF) | ((src
[1] << 8) & 0xFF00));
466 if (c
->status
[0].idelta
& 0x08000)
467 c
->status
[0].idelta
-= 0x10000;
470 c
->status
[1].idelta
= ((*src
& 0xFF) | ((src
[1] << 8) & 0xFF00));
471 if (st
&& c
->status
[1].idelta
& 0x08000)
472 c
->status
[1].idelta
|= 0xFFFF0000;
475 c
->status
[0].coeff1
= AdaptCoeff1
[block_predictor
[0]];
476 c
->status
[0].coeff2
= AdaptCoeff2
[block_predictor
[0]];
477 c
->status
[1].coeff1
= AdaptCoeff1
[block_predictor
[1]];
478 c
->status
[1].coeff2
= AdaptCoeff2
[block_predictor
[1]];
480 c
->status
[0].sample1
= ((*src
& 0xFF) | ((src
[1] << 8) & 0xFF00));
482 if (st
) c
->status
[1].sample1
= ((*src
& 0xFF) | ((src
[1] << 8) & 0xFF00));
484 c
->status
[0].sample2
= ((*src
& 0xFF) | ((src
[1] << 8) & 0xFF00));
486 if (st
) c
->status
[1].sample2
= ((*src
& 0xFF) | ((src
[1] << 8) & 0xFF00));
489 *samples
++ = c
->status
[0].sample1
;
490 if (st
) *samples
++ = c
->status
[1].sample1
;
491 *samples
++ = c
->status
[0].sample2
;
492 if (st
) *samples
++ = c
->status
[1].sample2
;
494 *samples
++ = adpcm_ms_expand_nibble(&c
->status
[0], (src
[0] >> 4) & 0x0F);
495 *samples
++ = adpcm_ms_expand_nibble(&c
->status
[st
], src
[0] & 0x0F);
503 *data_size
= (UINT8
*)samples
- (UINT8
*)data
;
507 #define ADPCM_CODEC(id, name) \
508 AVCodec name ## _encoder = { \
512 sizeof(ADPCMContext), \
514 adpcm_encode_frame, \
515 adpcm_encode_close, \
518 AVCodec name ## _decoder = { \
522 sizeof(ADPCMContext), \
526 adpcm_decode_frame, \
529 ADPCM_CODEC(CODEC_ID_ADPCM_IMA_QT
, adpcm_ima_qt
);
530 ADPCM_CODEC(CODEC_ID_ADPCM_IMA_WAV
, adpcm_ima_wav
);
531 ADPCM_CODEC(CODEC_ID_ADPCM_MS
, adpcm_ms
);