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
28 * Based on http://wiki.multimedia.cx/index.php?title=Smacker
34 #include "libavutil/channel_layout.h"
36 #define BITSTREAM_READER_LE
38 #include "bytestream.h"
43 #define SMKTREE_BITS 9
44 #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(length > 32 || length > 3*SMKTREE_BITS) {
99 av_log(NULL, AV_LOG_ERROR, "length too long\n");
100 return AVERROR_INVALIDDATA;
102 if(!get_bits1(gb)){ //Leaf
103 if(hc->current >= hc->length){
104 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
105 return AVERROR_INVALIDDATA;
108 hc->bits[hc->current] = prefix;
109 hc->lengths[hc->current] = length;
111 hc->bits[hc->current] = 0;
112 hc->lengths[hc->current] = 0;
114 hc->values[hc->current] = get_bits(gb, 8);
116 if(hc->maxlength < length)
117 hc->maxlength = length;
122 r = smacker_decode_tree(gb, hc, prefix, length);
125 return smacker_decode_tree(gb, hc, prefix | (1 << (length - 1)), length);
132 static int smacker_decode_bigtree(GetBitContext *gb, HuffContext *hc, DBCtx *ctx, int length)
134 if(length > 500) { // Larger length can cause segmentation faults due to too deep recursion.
135 av_log(NULL, AV_LOG_ERROR, "length too long\n");
136 return AVERROR_INVALIDDATA;
138 if (hc->current + 1 >= hc->length) {
139 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
140 return AVERROR_INVALIDDATA;
142 if(!get_bits1(gb)){ //Leaf
144 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
145 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
146 if (i1 < 0 || i2 < 0)
147 return AVERROR_INVALIDDATA;
148 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
149 if(val == ctx->escapes[0]) {
150 ctx->last[0] = hc->current;
152 } else if(val == ctx->escapes[1]) {
153 ctx->last[1] = hc->current;
155 } else if(val == ctx->escapes[2]) {
156 ctx->last[2] = hc->current;
160 hc->values[hc->current++] = val;
166 r = smacker_decode_bigtree(gb, hc, ctx, length + 1);
169 hc->values[t] = SMK_NODE | r;
171 r_new = smacker_decode_bigtree(gb, hc, ctx, length + 1);
179 * Store large tree as FFmpeg's vlc codes
181 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
185 HuffContext tmp1, tmp2;
186 VLC vlc[2] = { { 0 } };
191 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
192 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
193 return AVERROR_INVALIDDATA;
199 tmp1.bits = av_mallocz(256 * 4);
200 tmp1.lengths = av_mallocz(256 * sizeof(int));
201 tmp1.values = av_mallocz(256 * sizeof(int));
206 tmp2.bits = av_mallocz(256 * 4);
207 tmp2.lengths = av_mallocz(256 * sizeof(int));
208 tmp2.values = av_mallocz(256 * sizeof(int));
209 if (!tmp1.bits || !tmp1.lengths || !tmp1.values ||
210 !tmp2.bits || !tmp2.lengths || !tmp2.values) {
211 err = AVERROR(ENOMEM);
216 res = smacker_decode_tree(gb, &tmp1, 0, 0);
222 if(tmp1.current > 1) {
223 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
224 tmp1.lengths, sizeof(int), sizeof(int),
225 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
227 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
234 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
237 res = smacker_decode_tree(gb, &tmp2, 0, 0);
243 if(tmp2.current > 1) {
244 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
245 tmp2.lengths, sizeof(int), sizeof(int),
246 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
248 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
255 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
258 escapes[0] = get_bits(gb, 16);
259 escapes[1] = get_bits(gb, 16);
260 escapes[2] = get_bits(gb, 16);
262 last[0] = last[1] = last[2] = -1;
264 ctx.escapes[0] = escapes[0];
265 ctx.escapes[1] = escapes[1];
266 ctx.escapes[2] = escapes[2];
269 ctx.recode1 = tmp1.values;
270 ctx.recode2 = tmp2.values;
273 huff.length = ((size + 3) >> 2) + 4;
276 huff.values = av_mallocz_array(huff.length, sizeof(int));
278 err = AVERROR(ENOMEM);
282 if (smacker_decode_bigtree(gb, &huff, &ctx, 0) < 0)
285 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
286 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
287 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
288 if (ctx.last[0] >= huff.length ||
289 ctx.last[1] >= huff.length ||
290 ctx.last[2] >= huff.length) {
291 av_log(smk->avctx, AV_LOG_ERROR, "Huffman codes out of range\n");
292 err = AVERROR_INVALIDDATA;
295 *recodes = huff.values;
299 ff_free_vlc(&vlc[0]);
301 ff_free_vlc(&vlc[1]);
303 av_free(tmp1.lengths);
304 av_free(tmp1.values);
306 av_free(tmp2.lengths);
307 av_free(tmp2.values);
312 static int decode_header_trees(SmackVContext *smk) {
314 int mmap_size, mclr_size, full_size, type_size, ret;
316 mmap_size = AV_RL32(smk->avctx->extradata);
317 mclr_size = AV_RL32(smk->avctx->extradata + 4);
318 full_size = AV_RL32(smk->avctx->extradata + 8);
319 type_size = AV_RL32(smk->avctx->extradata + 12);
321 ret = init_get_bits8(&gb, smk->avctx->extradata + 16, smk->avctx->extradata_size - 16);
325 if(!get_bits1(&gb)) {
326 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
327 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
329 return AVERROR(ENOMEM);
330 smk->mmap_tbl[0] = 0;
331 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
333 ret = smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
337 if(!get_bits1(&gb)) {
338 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
339 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
341 return AVERROR(ENOMEM);
342 smk->mclr_tbl[0] = 0;
343 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
345 ret = smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
349 if(!get_bits1(&gb)) {
350 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
351 smk->full_tbl = av_malloc(sizeof(int) * 2);
353 return AVERROR(ENOMEM);
354 smk->full_tbl[0] = 0;
355 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
357 ret = smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
361 if(!get_bits1(&gb)) {
362 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
363 smk->type_tbl = av_malloc(sizeof(int) * 2);
365 return AVERROR(ENOMEM);
366 smk->type_tbl[0] = 0;
367 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
369 ret = smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
377 static av_always_inline void last_reset(int *recode, int *last) {
378 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
381 /* get code and update history */
382 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
383 register int *table = recode;
386 while(*table & SMK_NODE) {
388 table += (*table) & (~SMK_NODE);
393 if(v != recode[last[0]]) {
394 recode[last[2]] = recode[last[1]];
395 recode[last[1]] = recode[last[0]];
401 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
404 SmackVContext * const smk = avctx->priv_data;
409 int blocks, blk, bw, bh;
414 if (avpkt->size <= 769)
415 return AVERROR_INVALIDDATA;
417 if ((ret = ff_reget_buffer(avctx, smk->pic)) < 0)
420 /* make the palette available on the way out */
421 pal = (uint32_t*)smk->pic->data[1];
422 bytestream2_init(&gb2, avpkt->data, avpkt->size);
423 flags = bytestream2_get_byteu(&gb2);
424 smk->pic->palette_has_changed = flags & 1;
425 smk->pic->key_frame = !!(flags & 2);
426 if (smk->pic->key_frame)
427 smk->pic->pict_type = AV_PICTURE_TYPE_I;
429 smk->pic->pict_type = AV_PICTURE_TYPE_P;
431 for(i = 0; i < 256; i++)
432 *pal++ = 0xFFU << 24 | bytestream2_get_be24u(&gb2);
434 last_reset(smk->mmap_tbl, smk->mmap_last);
435 last_reset(smk->mclr_tbl, smk->mclr_last);
436 last_reset(smk->full_tbl, smk->full_last);
437 last_reset(smk->type_tbl, smk->type_last);
438 if ((ret = init_get_bits8(&gb, avpkt->data + 769, avpkt->size - 769)) < 0)
442 bw = avctx->width >> 2;
443 bh = avctx->height >> 2;
445 stride = smk->pic->linesize[0];
446 while(blk < blocks) {
450 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
451 run = block_runs[(type >> 2) & 0x3F];
454 while(run-- && blk < blocks){
457 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
458 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
459 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
462 for(i = 0; i < 4; i++) {
463 if(map & 1) out[0] = hi; else out[0] = lo;
464 if(map & 2) out[1] = hi; else out[1] = lo;
465 if(map & 4) out[2] = hi; else out[2] = lo;
466 if(map & 8) out[3] = hi; else out[3] = lo;
475 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
476 if(get_bits1(&gb)) mode = 1;
477 else if(get_bits1(&gb)) mode = 2;
479 while(run-- && blk < blocks){
480 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
483 for(i = 0; i < 4; i++) {
484 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
486 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
492 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
493 out[0] = out[1] = pix & 0xFF;
494 out[2] = out[3] = pix >> 8;
496 out[0] = out[1] = pix & 0xFF;
497 out[2] = out[3] = pix >> 8;
499 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
500 out[0] = out[1] = pix & 0xFF;
501 out[2] = out[3] = pix >> 8;
503 out[0] = out[1] = pix & 0xFF;
504 out[2] = out[3] = pix >> 8;
507 for(i = 0; i < 2; i++) {
509 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
510 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
524 while(run-- && blk < blocks)
529 while(run-- && blk < blocks){
531 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
532 col = mode * 0x01010101;
533 for(i = 0; i < 4; i++) {
534 *((uint32_t*)out) = col;
544 if ((ret = av_frame_ref(data, smk->pic)) < 0)
549 /* always report that the buffer was completely consumed */
554 static av_cold int decode_end(AVCodecContext *avctx)
556 SmackVContext * const smk = avctx->priv_data;
558 av_freep(&smk->mmap_tbl);
559 av_freep(&smk->mclr_tbl);
560 av_freep(&smk->full_tbl);
561 av_freep(&smk->type_tbl);
563 av_frame_free(&smk->pic);
569 static av_cold int decode_init(AVCodecContext *avctx)
571 SmackVContext * const c = avctx->priv_data;
576 avctx->pix_fmt = AV_PIX_FMT_PAL8;
578 c->pic = av_frame_alloc();
580 return AVERROR(ENOMEM);
582 /* decode huffman trees from extradata */
583 if(avctx->extradata_size < 16){
584 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
586 return AVERROR(EINVAL);
589 ret = decode_header_trees(c);
599 static av_cold int smka_decode_init(AVCodecContext *avctx)
601 if (avctx->channels < 1 || avctx->channels > 2) {
602 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
603 return AVERROR(EINVAL);
605 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
606 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
612 * Decode Smacker audio data
614 static int smka_decode_frame(AVCodecContext *avctx, void *data,
615 int *got_frame_ptr, AVPacket *avpkt)
617 AVFrame *frame = data;
618 const uint8_t *buf = avpkt->data;
619 int buf_size = avpkt->size;
621 HuffContext h[4] = { { 0 } };
622 VLC vlc[4] = { { 0 } };
629 int pred[2] = {0, 0};
632 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
633 return AVERROR(EINVAL);
636 unp_size = AV_RL32(buf);
638 if (unp_size > (1U<<24)) {
639 av_log(avctx, AV_LOG_ERROR, "packet is too big\n");
640 return AVERROR_INVALIDDATA;
643 if ((ret = init_get_bits8(&gb, buf + 4, buf_size - 4)) < 0)
647 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
651 stereo = get_bits1(&gb);
652 bits = get_bits1(&gb);
653 if (stereo ^ (avctx->channels != 1)) {
654 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
655 return AVERROR(EINVAL);
657 if (bits == (avctx->sample_fmt == AV_SAMPLE_FMT_U8)) {
658 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
659 return AVERROR(EINVAL);
662 /* get output buffer */
663 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
664 if (unp_size % (avctx->channels * (bits + 1))) {
665 av_log(avctx, AV_LOG_ERROR, "unp_size %d is odd\n", unp_size);
666 return AVERROR(EINVAL);
668 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
670 samples = (int16_t *)frame->data[0];
671 samples8 = frame->data[0];
674 for(i = 0; i < (1 << (bits + stereo)); i++) {
678 h[i].bits = av_mallocz(256 * 4);
679 h[i].lengths = av_mallocz(256 * sizeof(int));
680 h[i].values = av_mallocz(256 * sizeof(int));
681 if (!h[i].bits || !h[i].lengths || !h[i].values) {
682 ret = AVERROR(ENOMEM);
686 if (smacker_decode_tree(&gb, &h[i], 0, 0) < 0) {
687 ret = AVERROR_INVALIDDATA;
691 if(h[i].current > 1) {
692 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
693 h[i].lengths, sizeof(int), sizeof(int),
694 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
696 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
697 ret = AVERROR_INVALIDDATA;
702 /* this codec relies on wraparound instead of clipping audio */
703 if(bits) { //decode 16-bit data
704 for(i = stereo; i >= 0; i--)
705 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
706 for(i = 0; i <= stereo; i++)
707 *samples++ = pred[i];
708 for(; i < unp_size / 2; i++) {
709 if(get_bits_left(&gb)<0)
710 return AVERROR_INVALIDDATA;
713 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
717 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
718 return AVERROR_INVALIDDATA;
720 val = h[2].values[res];
722 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
726 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
727 return AVERROR_INVALIDDATA;
729 val |= h[3].values[res] << 8;
730 pred[1] += sign_extend(val, 16);
731 *samples++ = pred[1];
734 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
738 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
739 return AVERROR_INVALIDDATA;
741 val = h[0].values[res];
743 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
747 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
748 return AVERROR_INVALIDDATA;
750 val |= h[1].values[res] << 8;
751 pred[0] += sign_extend(val, 16);
752 *samples++ = pred[0];
755 } else { //8-bit data
756 for(i = stereo; i >= 0; i--)
757 pred[i] = get_bits(&gb, 8);
758 for(i = 0; i <= stereo; i++)
759 *samples8++ = pred[i];
760 for(; i < unp_size; i++) {
761 if(get_bits_left(&gb)<0)
762 return AVERROR_INVALIDDATA;
765 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
769 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
770 return AVERROR_INVALIDDATA;
772 pred[1] += sign_extend(h[1].values[res], 8);
773 *samples8++ = pred[1];
776 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
780 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
781 return AVERROR_INVALIDDATA;
783 pred[0] += sign_extend(h[0].values[res], 8);
784 *samples8++ = pred[0];
793 for(i = 0; i < 4; i++) {
795 ff_free_vlc(&vlc[i]);
797 av_free(h[i].lengths);
798 av_free(h[i].values);
804 AVCodec ff_smacker_decoder = {
806 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
807 .type = AVMEDIA_TYPE_VIDEO,
808 .id = AV_CODEC_ID_SMACKVIDEO,
809 .priv_data_size = sizeof(SmackVContext),
812 .decode = decode_frame,
813 .capabilities = AV_CODEC_CAP_DR1,
816 AVCodec ff_smackaud_decoder = {
818 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
819 .type = AVMEDIA_TYPE_AUDIO,
820 .id = AV_CODEC_ID_SMACKAUDIO,
821 .init = smka_decode_init,
822 .decode = smka_decode_frame,
823 .capabilities = AV_CODEC_CAP_DR1,