3 * Copyright (c) 2006 Konstantin Shishkov
5 * This file is part of FFmpeg.
7 * FFmpeg 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.
12 * FFmpeg 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.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29 * Based on http://wiki.multimedia.cx/index.php?title=Smacker
38 #define ALT_BITSTREAM_READER_LE
39 #include "bitstream.h"
41 #define SMKTREE_BITS 9
42 #define SMK_NODE 0x80000000
47 typedef struct SmackVContext {
48 AVCodecContext *avctx;
51 int *mmap_tbl, *mclr_tbl, *full_tbl, *type_tbl;
52 int mmap_last[3], mclr_last[3], full_last[3], type_last[3];
56 * Context used for code reconstructing
58 typedef struct HuffContext {
67 /* common parameters used for decode_bigtree */
68 typedef struct DBCtx {
70 int *recode1, *recode2;
76 /* possible runs of blocks */
77 static const int block_runs[64] = {
78 1, 2, 3, 4, 5, 6, 7, 8,
79 9, 10, 11, 12, 13, 14, 15, 16,
80 17, 18, 19, 20, 21, 22, 23, 24,
81 25, 26, 27, 28, 29, 30, 31, 32,
82 33, 34, 35, 36, 37, 38, 39, 40,
83 41, 42, 43, 44, 45, 46, 47, 48,
84 49, 50, 51, 52, 53, 54, 55, 56,
85 57, 58, 59, 128, 256, 512, 1024, 2048 };
94 * Decode local frame tree
96 static int smacker_decode_tree(GetBitContext *gb, HuffContext *hc, uint32_t prefix, int length)
98 if(!get_bits1(gb)){ //Leaf
99 if(hc->current >= 256){
100 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
104 hc->bits[hc->current] = prefix;
105 hc->lengths[hc->current] = length;
107 hc->bits[hc->current] = 0;
108 hc->lengths[hc->current] = 0;
110 hc->values[hc->current] = get_bits(gb, 8);
112 if(hc->maxlength < length)
113 hc->maxlength = length;
118 r = smacker_decode_tree(gb, hc, prefix, length);
121 return smacker_decode_tree(gb, hc, prefix | (1 << (length - 1)), length);
128 static int smacker_decode_bigtree(GetBitContext *gb, HuffContext *hc, DBCtx *ctx)
130 if(!get_bits1(gb)){ //Leaf
131 int val, i1, i2, b1, b2;
132 if(hc->current >= hc->length){
133 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
136 b1 = get_bits_count(gb);
137 i1 = get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3);
138 b1 = get_bits_count(gb) - b1;
139 b2 = get_bits_count(gb);
140 i2 = get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3);
141 b2 = get_bits_count(gb) - b2;
142 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
143 if(val == ctx->escapes[0]) {
144 ctx->last[0] = hc->current;
146 } else if(val == ctx->escapes[1]) {
147 ctx->last[1] = hc->current;
149 } else if(val == ctx->escapes[2]) {
150 ctx->last[2] = hc->current;
154 hc->values[hc->current++] = val;
160 r = smacker_decode_bigtree(gb, hc, ctx);
163 hc->values[t] = SMK_NODE | r;
165 r += smacker_decode_bigtree(gb, hc, ctx);
171 * Store large tree as FFmpeg's vlc codes
173 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
177 HuffContext tmp1, tmp2;
182 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
183 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
190 tmp1.bits = av_mallocz(256 * 4);
191 tmp1.lengths = av_mallocz(256 * sizeof(int));
192 tmp1.values = av_mallocz(256 * sizeof(int));
197 tmp2.bits = av_mallocz(256 * 4);
198 tmp2.lengths = av_mallocz(256 * sizeof(int));
199 tmp2.values = av_mallocz(256 * sizeof(int));
201 memset(&vlc[0], 0, sizeof(VLC));
202 memset(&vlc[1], 0, sizeof(VLC));
205 smacker_decode_tree(gb, &tmp1, 0, 0);
207 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
208 tmp1.lengths, sizeof(int), sizeof(int),
209 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
211 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
215 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
218 smacker_decode_tree(gb, &tmp2, 0, 0);
220 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
221 tmp2.lengths, sizeof(int), sizeof(int),
222 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
224 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
228 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
231 escapes[0] = get_bits(gb, 8);
232 escapes[0] |= get_bits(gb, 8) << 8;
233 escapes[1] = get_bits(gb, 8);
234 escapes[1] |= get_bits(gb, 8) << 8;
235 escapes[2] = get_bits(gb, 8);
236 escapes[2] |= get_bits(gb, 8) << 8;
238 last[0] = last[1] = last[2] = -1;
240 ctx.escapes[0] = escapes[0];
241 ctx.escapes[1] = escapes[1];
242 ctx.escapes[2] = escapes[2];
245 ctx.recode1 = tmp1.values;
246 ctx.recode2 = tmp2.values;
249 huff.length = ((size + 3) >> 2) + 3;
252 huff.values = av_mallocz(huff.length * sizeof(int));
254 smacker_decode_bigtree(gb, &huff, &ctx);
256 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
257 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
258 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
260 *recodes = huff.values;
267 av_free(tmp1.lengths);
268 av_free(tmp1.values);
270 av_free(tmp2.lengths);
271 av_free(tmp2.values);
276 static int decode_header_trees(SmackVContext *smk) {
278 int mmap_size, mclr_size, full_size, type_size;
280 mmap_size = LE_32(smk->avctx->extradata);
281 mclr_size = LE_32(smk->avctx->extradata + 4);
282 full_size = LE_32(smk->avctx->extradata + 8);
283 type_size = LE_32(smk->avctx->extradata + 12);
285 init_get_bits(&gb, smk->avctx->extradata + 16, (smk->avctx->extradata_size - 16) * 8);
287 if(!get_bits1(&gb)) {
288 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
289 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
290 smk->mmap_tbl[0] = 0;
291 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
293 smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
295 if(!get_bits(&gb, 1)) {
296 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
297 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
298 smk->mclr_tbl[0] = 0;
299 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
301 smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
303 if(!get_bits(&gb, 1)) {
304 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
305 smk->full_tbl = av_malloc(sizeof(int) * 2);
306 smk->full_tbl[0] = 0;
307 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
309 smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
311 if(!get_bits(&gb, 1)) {
312 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
313 smk->type_tbl = av_malloc(sizeof(int) * 2);
314 smk->type_tbl[0] = 0;
315 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
317 smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
323 static av_always_inline void last_reset(int *recode, int *last) {
324 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
327 /* get code and update history */
328 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
329 register int *table = recode;
332 b = get_bits_count(gb);
333 while(*table & SMK_NODE) {
335 table += (*table) & (~SMK_NODE);
339 b = get_bits_count(gb) - b;
341 if(v != recode[last[0]]) {
342 recode[last[2]] = recode[last[1]];
343 recode[last[1]] = recode[last[0]];
349 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, uint8_t *buf, int buf_size)
351 SmackVContext * const smk = (SmackVContext *)avctx->priv_data;
355 int blocks, blk, bw, bh;
362 avctx->release_buffer(avctx, &smk->pic);
364 smk->pic.reference = 1;
365 smk->pic.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
366 if(avctx->reget_buffer(avctx, &smk->pic) < 0){
367 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
371 /* make the palette available on the way out */
373 pal = (uint32_t*)smk->pic.data[1];
374 smk->pic.palette_has_changed = buf[0] & 1;
375 smk->pic.key_frame = !!(buf[0] & 2);
376 if(smk->pic.key_frame)
377 smk->pic.pict_type = FF_I_TYPE;
379 smk->pic.pict_type = FF_P_TYPE;
381 for(i = 0; i < 256; i++) {
386 *pal++ = (r << 16) | (g << 8) | b;
389 last_reset(smk->mmap_tbl, smk->mmap_last);
390 last_reset(smk->mclr_tbl, smk->mclr_last);
391 last_reset(smk->full_tbl, smk->full_last);
392 last_reset(smk->type_tbl, smk->type_last);
393 init_get_bits(&gb, buf + 769, (buf_size - 769) * 8);
396 bw = avctx->width >> 2;
397 bh = avctx->height >> 2;
399 out = smk->pic.data[0];
400 stride = smk->pic.linesize[0];
401 while(blk < blocks) {
405 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
406 run = block_runs[(type >> 2) & 0x3F];
409 while(run-- && blk < blocks){
412 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
413 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
414 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
417 for(i = 0; i < 4; i++) {
418 if(map & 1) out[0] = hi; else out[0] = lo;
419 if(map & 2) out[1] = hi; else out[1] = lo;
420 if(map & 4) out[2] = hi; else out[2] = lo;
421 if(map & 8) out[3] = hi; else out[3] = lo;
430 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
431 if(get_bits1(&gb)) mode = 1;
432 else if(get_bits1(&gb)) mode = 2;
434 while(run-- && blk < blocks){
435 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
438 for(i = 0; i < 4; i++) {
439 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
442 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
449 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
450 out[0] = out[1] = pix & 0xFF;
451 out[2] = out[3] = pix >> 8;
453 out[0] = out[1] = pix & 0xFF;
454 out[2] = out[3] = pix >> 8;
456 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
457 out[0] = out[1] = pix & 0xFF;
458 out[2] = out[3] = pix >> 8;
460 out[0] = out[1] = pix & 0xFF;
461 out[2] = out[3] = pix >> 8;
465 for(i = 0; i < 2; i++) {
467 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
468 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
469 out[0] = pix1 & 0xFF; out[1] = pix1 >> 8;
470 out[2] = pix2 & 0xFF; out[3] = pix2 >> 8;
472 out[0] = pix1 & 0xFF; out[1] = pix1 >> 8;
473 out[2] = pix2 & 0xFF; out[3] = pix2 >> 8;
482 while(run-- && blk < blocks)
487 while(run-- && blk < blocks){
489 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
490 col = mode * 0x01010101;
491 for(i = 0; i < 4; i++) {
492 *((uint32_t*)out) = col;
502 *data_size = sizeof(AVFrame);
503 *(AVFrame*)data = smk->pic;
505 /* always report that the buffer was completely consumed */
513 * Init smacker decoder
516 static int decode_init(AVCodecContext *avctx)
518 SmackVContext * const c = (SmackVContext *)avctx->priv_data;
521 avctx->has_b_frames = 0;
523 c->pic.data[0] = NULL;
525 if (avcodec_check_dimensions(avctx, avctx->width, avctx->height) < 0) {
529 avctx->pix_fmt = PIX_FMT_PAL8;
532 /* decode huffman trees from extradata */
533 if(avctx->extradata_size < 16){
534 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
538 decode_header_trees(c);
548 * Uninit smacker decoder
551 static int decode_end(AVCodecContext *avctx)
553 SmackVContext * const smk = (SmackVContext *)avctx->priv_data;
555 av_freep(&smk->mmap_tbl);
556 av_freep(&smk->mclr_tbl);
557 av_freep(&smk->full_tbl);
558 av_freep(&smk->type_tbl);
560 if (smk->pic.data[0])
561 avctx->release_buffer(avctx, &smk->pic);
567 static int smka_decode_init(AVCodecContext *avctx)
573 * Decode Smacker audio data
575 static int smka_decode_frame(AVCodecContext *avctx, void *data, int *data_size, uint8_t *buf, int buf_size)
580 int16_t *samples = data;
585 int pred[2] = {0, 0};
587 unp_size = LE_32(buf);
589 init_get_bits(&gb, buf + 4, (buf_size - 4) * 8);
592 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
596 stereo = get_bits1(&gb);
597 bits = get_bits1(&gb);
599 memset(vlc, 0, sizeof(VLC) * 4);
600 memset(h, 0, sizeof(HuffContext) * 4);
602 for(i = 0; i < (1 << (bits + stereo)); i++) {
606 h[i].bits = av_mallocz(256 * 4);
607 h[i].lengths = av_mallocz(256 * sizeof(int));
608 h[i].values = av_mallocz(256 * sizeof(int));
610 smacker_decode_tree(&gb, &h[i], 0, 0);
612 if(h[i].current > 1) {
613 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
614 h[i].lengths, sizeof(int), sizeof(int),
615 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
617 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
622 if(bits) { //decode 16-bit data
623 pred[0] = get_bits(&gb, 8);
624 pred[0] |= get_bits(&gb, 8);
625 *samples++ = pred[0];
627 pred[1] = get_bits(&gb, 8);
628 pred[1] |= get_bits(&gb, 8);
629 *samples++ = pred[1];
631 for(i = 0; i < unp_size / 2; i++) {
634 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
637 val = h[2].values[res];
639 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
642 val |= h[3].values[res] << 8;
643 pred[1] += (int16_t)val;
644 *samples++ = pred[1];
647 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
650 val = h[0].values[res];
652 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
655 val |= h[1].values[res] << 8;
657 *samples++ = pred[0];
660 } else { //8-bit data
661 pred[0] = get_bits(&gb, 8);
662 *samples++ = (pred[0] - 0x80) << 8;
664 pred[1] = get_bits(&gb, 8);
665 *samples++ = (pred[1] - 0x80) << 8;
667 for(i = 0; i < unp_size; i++) {
670 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
673 pred[1] += (int8_t)h[1].values[res];
674 *samples++ = (pred[1] - 0x80) << 8;
677 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
680 pred[0] += (int8_t)h[0].values[res];
681 *samples++ = (pred[0] - 0x80) << 8;
687 for(i = 0; i < 4; i++) {
693 av_free(h[i].lengths);
695 av_free(h[i].values);
698 *data_size = unp_size;
702 AVCodec smacker_decoder = {
706 sizeof(SmackVContext),
713 AVCodec smackaud_decoder = {