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
46 #define SMKTREE_DECODE_MAX_RECURSION 32
47 #define SMKTREE_DECODE_BIG_MAX_RECURSION 500
49 typedef struct SmackVContext {
50 AVCodecContext *avctx;
53 int *mmap_tbl, *mclr_tbl, *full_tbl, *type_tbl;
54 int mmap_last[3], mclr_last[3], full_last[3], type_last[3];
58 * Context used for code reconstructing
60 typedef struct HuffContext {
69 /* common parameters used for decode_bigtree */
70 typedef struct DBCtx {
72 int *recode1, *recode2;
78 /* possible runs of blocks */
79 static const int block_runs[64] = {
80 1, 2, 3, 4, 5, 6, 7, 8,
81 9, 10, 11, 12, 13, 14, 15, 16,
82 17, 18, 19, 20, 21, 22, 23, 24,
83 25, 26, 27, 28, 29, 30, 31, 32,
84 33, 34, 35, 36, 37, 38, 39, 40,
85 41, 42, 43, 44, 45, 46, 47, 48,
86 49, 50, 51, 52, 53, 54, 55, 56,
87 57, 58, 59, 128, 256, 512, 1024, 2048 };
96 * Decode local frame tree
98 static int smacker_decode_tree(GetBitContext *gb, HuffContext *hc, uint32_t prefix, int length)
100 if (length > SMKTREE_DECODE_MAX_RECURSION || length > 3 * SMKTREE_BITS) {
101 av_log(NULL, AV_LOG_ERROR, "Maximum tree recursion level exceeded.\n");
102 return AVERROR_INVALIDDATA;
105 if(!get_bits1(gb)){ //Leaf
106 if(hc->current >= hc->length){
107 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
108 return AVERROR_INVALIDDATA;
111 hc->bits[hc->current] = prefix;
112 hc->lengths[hc->current] = length;
114 hc->bits[hc->current] = 0;
115 hc->lengths[hc->current] = 0;
117 hc->values[hc->current] = get_bits(gb, 8);
119 if(hc->maxlength < length)
120 hc->maxlength = length;
125 r = smacker_decode_tree(gb, hc, prefix, length);
128 return smacker_decode_tree(gb, hc, prefix | (1 << (length - 1)), length);
135 static int smacker_decode_bigtree(GetBitContext *gb, HuffContext *hc,
136 DBCtx *ctx, int length)
138 // Larger length can cause segmentation faults due to too deep recursion.
139 if (length > SMKTREE_DECODE_BIG_MAX_RECURSION) {
140 av_log(NULL, AV_LOG_ERROR, "Maximum bigtree recursion level exceeded.\n");
141 return AVERROR_INVALIDDATA;
144 if (hc->current + 1 >= hc->length) {
145 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
146 return AVERROR_INVALIDDATA;
148 if(!get_bits1(gb)){ //Leaf
150 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
151 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
152 if (i1 < 0 || i2 < 0)
153 return AVERROR_INVALIDDATA;
154 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
155 if(val == ctx->escapes[0]) {
156 ctx->last[0] = hc->current;
158 } else if(val == ctx->escapes[1]) {
159 ctx->last[1] = hc->current;
161 } else if(val == ctx->escapes[2]) {
162 ctx->last[2] = hc->current;
166 hc->values[hc->current++] = val;
172 r = smacker_decode_bigtree(gb, hc, ctx, length + 1);
175 hc->values[t] = SMK_NODE | r;
177 r_new = smacker_decode_bigtree(gb, hc, ctx, length + 1);
185 * Store large tree as FFmpeg's vlc codes
187 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
191 HuffContext tmp1, tmp2;
192 VLC vlc[2] = { { 0 } };
197 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
198 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
199 return AVERROR_INVALIDDATA;
205 tmp1.bits = av_mallocz(256 * 4);
206 tmp1.lengths = av_mallocz(256 * sizeof(int));
207 tmp1.values = av_mallocz(256 * sizeof(int));
212 tmp2.bits = av_mallocz(256 * 4);
213 tmp2.lengths = av_mallocz(256 * sizeof(int));
214 tmp2.values = av_mallocz(256 * sizeof(int));
215 if (!tmp1.bits || !tmp1.lengths || !tmp1.values ||
216 !tmp2.bits || !tmp2.lengths || !tmp2.values) {
217 err = AVERROR(ENOMEM);
222 res = smacker_decode_tree(gb, &tmp1, 0, 0);
228 if(tmp1.current > 1) {
229 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
230 tmp1.lengths, sizeof(int), sizeof(int),
231 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
233 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
240 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
243 res = smacker_decode_tree(gb, &tmp2, 0, 0);
249 if(tmp2.current > 1) {
250 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
251 tmp2.lengths, sizeof(int), sizeof(int),
252 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
254 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
261 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
264 escapes[0] = get_bits(gb, 16);
265 escapes[1] = get_bits(gb, 16);
266 escapes[2] = get_bits(gb, 16);
268 last[0] = last[1] = last[2] = -1;
270 ctx.escapes[0] = escapes[0];
271 ctx.escapes[1] = escapes[1];
272 ctx.escapes[2] = escapes[2];
275 ctx.recode1 = tmp1.values;
276 ctx.recode2 = tmp2.values;
279 huff.length = ((size + 3) >> 2) + 4;
282 huff.values = av_mallocz_array(huff.length, sizeof(int));
284 err = AVERROR(ENOMEM);
288 res = smacker_decode_bigtree(gb, &huff, &ctx, 0);
292 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
293 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
294 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
295 if (ctx.last[0] >= huff.length ||
296 ctx.last[1] >= huff.length ||
297 ctx.last[2] >= huff.length) {
298 av_log(smk->avctx, AV_LOG_ERROR, "Huffman codes out of range\n");
299 err = AVERROR_INVALIDDATA;
302 *recodes = huff.values;
306 ff_free_vlc(&vlc[0]);
308 ff_free_vlc(&vlc[1]);
310 av_free(tmp1.lengths);
311 av_free(tmp1.values);
313 av_free(tmp2.lengths);
314 av_free(tmp2.values);
319 static int decode_header_trees(SmackVContext *smk) {
321 int mmap_size, mclr_size, full_size, type_size, ret;
324 mmap_size = AV_RL32(smk->avctx->extradata);
325 mclr_size = AV_RL32(smk->avctx->extradata + 4);
326 full_size = AV_RL32(smk->avctx->extradata + 8);
327 type_size = AV_RL32(smk->avctx->extradata + 12);
329 ret = init_get_bits8(&gb, smk->avctx->extradata + 16, smk->avctx->extradata_size - 16);
333 if(!get_bits1(&gb)) {
335 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
336 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
338 return AVERROR(ENOMEM);
339 smk->mmap_tbl[0] = 0;
340 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
342 ret = smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
346 if(!get_bits1(&gb)) {
348 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
349 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
351 return AVERROR(ENOMEM);
352 smk->mclr_tbl[0] = 0;
353 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
355 ret = smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
359 if(!get_bits1(&gb)) {
361 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
362 smk->full_tbl = av_malloc(sizeof(int) * 2);
364 return AVERROR(ENOMEM);
365 smk->full_tbl[0] = 0;
366 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
368 ret = smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
372 if(!get_bits1(&gb)) {
374 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
375 smk->type_tbl = av_malloc(sizeof(int) * 2);
377 return AVERROR(ENOMEM);
378 smk->type_tbl[0] = 0;
379 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
381 ret = smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
386 return AVERROR_INVALIDDATA;
391 static av_always_inline void last_reset(int *recode, int *last) {
392 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
395 /* get code and update history */
396 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
397 register int *table = recode;
400 while(*table & SMK_NODE) {
401 if (get_bits_left(gb) < 1)
402 return AVERROR_INVALIDDATA;
404 table += (*table) & (~SMK_NODE);
409 if(v != recode[last[0]]) {
410 recode[last[2]] = recode[last[1]];
411 recode[last[1]] = recode[last[0]];
417 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
420 SmackVContext * const smk = avctx->priv_data;
425 int blocks, blk, bw, bh;
430 if (avpkt->size <= 769)
431 return AVERROR_INVALIDDATA;
433 if ((ret = ff_reget_buffer(avctx, smk->pic, 0)) < 0)
436 /* make the palette available on the way out */
437 pal = (uint32_t*)smk->pic->data[1];
438 bytestream2_init(&gb2, avpkt->data, avpkt->size);
439 flags = bytestream2_get_byteu(&gb2);
440 smk->pic->palette_has_changed = flags & 1;
441 smk->pic->key_frame = !!(flags & 2);
442 if (smk->pic->key_frame)
443 smk->pic->pict_type = AV_PICTURE_TYPE_I;
445 smk->pic->pict_type = AV_PICTURE_TYPE_P;
447 for(i = 0; i < 256; i++)
448 *pal++ = 0xFFU << 24 | bytestream2_get_be24u(&gb2);
450 last_reset(smk->mmap_tbl, smk->mmap_last);
451 last_reset(smk->mclr_tbl, smk->mclr_last);
452 last_reset(smk->full_tbl, smk->full_last);
453 last_reset(smk->type_tbl, smk->type_last);
454 if ((ret = init_get_bits8(&gb, avpkt->data + 769, avpkt->size - 769)) < 0)
458 bw = avctx->width >> 2;
459 bh = avctx->height >> 2;
461 stride = smk->pic->linesize[0];
462 while(blk < blocks) {
466 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
469 run = block_runs[(type >> 2) & 0x3F];
472 while(run-- && blk < blocks){
475 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
476 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
477 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
480 for(i = 0; i < 4; i++) {
481 if(map & 1) out[0] = hi; else out[0] = lo;
482 if(map & 2) out[1] = hi; else out[1] = lo;
483 if(map & 4) out[2] = hi; else out[2] = lo;
484 if(map & 8) out[3] = hi; else out[3] = lo;
493 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
494 if(get_bits1(&gb)) mode = 1;
495 else if(get_bits1(&gb)) mode = 2;
497 while(run-- && blk < blocks){
498 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
501 for(i = 0; i < 4; i++) {
502 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
504 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
510 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
511 out[0] = out[1] = pix & 0xFF;
512 out[2] = out[3] = pix >> 8;
514 out[0] = out[1] = pix & 0xFF;
515 out[2] = out[3] = pix >> 8;
517 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
518 out[0] = out[1] = pix & 0xFF;
519 out[2] = out[3] = pix >> 8;
521 out[0] = out[1] = pix & 0xFF;
522 out[2] = out[3] = pix >> 8;
525 for(i = 0; i < 2; i++) {
527 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
528 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
542 while(run-- && blk < blocks)
547 while(run-- && blk < blocks){
549 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
550 col = mode * 0x01010101U;
551 for(i = 0; i < 4; i++) {
552 *((uint32_t*)out) = col;
562 if ((ret = av_frame_ref(data, smk->pic)) < 0)
567 /* always report that the buffer was completely consumed */
572 static av_cold int decode_end(AVCodecContext *avctx)
574 SmackVContext * const smk = avctx->priv_data;
576 av_freep(&smk->mmap_tbl);
577 av_freep(&smk->mclr_tbl);
578 av_freep(&smk->full_tbl);
579 av_freep(&smk->type_tbl);
581 av_frame_free(&smk->pic);
587 static av_cold int decode_init(AVCodecContext *avctx)
589 SmackVContext * const c = avctx->priv_data;
594 avctx->pix_fmt = AV_PIX_FMT_PAL8;
596 c->pic = av_frame_alloc();
598 return AVERROR(ENOMEM);
600 /* decode huffman trees from extradata */
601 if(avctx->extradata_size < 16){
602 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
603 return AVERROR(EINVAL);
606 ret = decode_header_trees(c);
615 static av_cold int smka_decode_init(AVCodecContext *avctx)
617 if (avctx->channels < 1 || avctx->channels > 2) {
618 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
619 return AVERROR_INVALIDDATA;
621 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
622 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
628 * Decode Smacker audio data
630 static int smka_decode_frame(AVCodecContext *avctx, void *data,
631 int *got_frame_ptr, AVPacket *avpkt)
633 AVFrame *frame = data;
634 const uint8_t *buf = avpkt->data;
635 int buf_size = avpkt->size;
637 HuffContext h[4] = { { 0 } };
638 VLC vlc[4] = { { 0 } };
645 int pred[2] = {0, 0};
648 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
649 return AVERROR_INVALIDDATA;
652 unp_size = AV_RL32(buf);
654 if (unp_size > (1U<<24)) {
655 av_log(avctx, AV_LOG_ERROR, "packet is too big\n");
656 return AVERROR_INVALIDDATA;
659 if ((ret = init_get_bits8(&gb, buf + 4, buf_size - 4)) < 0)
663 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
667 stereo = get_bits1(&gb);
668 bits = get_bits1(&gb);
669 if (stereo ^ (avctx->channels != 1)) {
670 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
671 return AVERROR_INVALIDDATA;
673 if (bits == (avctx->sample_fmt == AV_SAMPLE_FMT_U8)) {
674 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
675 return AVERROR_INVALIDDATA;
678 /* get output buffer */
679 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
680 if (unp_size % (avctx->channels * (bits + 1))) {
681 av_log(avctx, AV_LOG_ERROR,
682 "The buffer does not contain an integer number of samples\n");
683 return AVERROR_INVALIDDATA;
685 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
687 samples = (int16_t *)frame->data[0];
688 samples8 = frame->data[0];
691 for(i = 0; i < (1 << (bits + stereo)); i++) {
695 h[i].bits = av_mallocz(256 * 4);
696 h[i].lengths = av_mallocz(256 * sizeof(int));
697 h[i].values = av_mallocz(256 * sizeof(int));
698 if (!h[i].bits || !h[i].lengths || !h[i].values) {
699 ret = AVERROR(ENOMEM);
703 if (smacker_decode_tree(&gb, &h[i], 0, 0) < 0) {
704 ret = AVERROR_INVALIDDATA;
708 if(h[i].current > 1) {
709 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
710 h[i].lengths, sizeof(int), sizeof(int),
711 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
713 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
714 ret = AVERROR_INVALIDDATA;
719 /* this codec relies on wraparound instead of clipping audio */
720 if(bits) { //decode 16-bit data
721 for(i = stereo; i >= 0; i--)
722 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
723 for(i = 0; i <= stereo; i++)
724 *samples++ = pred[i];
725 for(; i < unp_size / 2; i++) {
726 if (get_bits_left(&gb) < 0) {
727 ret = AVERROR_INVALIDDATA;
732 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
736 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
737 ret = AVERROR_INVALIDDATA;
740 val = h[2].values[res];
742 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
746 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
747 ret = AVERROR_INVALIDDATA;
750 val |= h[3].values[res] << 8;
751 pred[1] += (unsigned)sign_extend(val, 16);
752 *samples++ = pred[1];
755 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
759 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
760 ret = AVERROR_INVALIDDATA;
763 val = h[0].values[res];
765 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
769 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
770 ret = AVERROR_INVALIDDATA;
773 val |= h[1].values[res] << 8;
774 pred[0] += (unsigned)sign_extend(val, 16);
775 *samples++ = pred[0];
778 } else { //8-bit data
779 for(i = stereo; i >= 0; i--)
780 pred[i] = get_bits(&gb, 8);
781 for(i = 0; i <= stereo; i++)
782 *samples8++ = pred[i];
783 for(; i < unp_size; i++) {
784 if (get_bits_left(&gb) < 0) {
785 ret = AVERROR_INVALIDDATA;
790 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
794 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
795 ret = AVERROR_INVALIDDATA;
798 pred[1] += sign_extend(h[1].values[res], 8);
799 *samples8++ = pred[1];
802 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
806 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
807 ret = AVERROR_INVALIDDATA;
810 pred[0] += sign_extend(h[0].values[res], 8);
811 *samples8++ = pred[0];
820 for(i = 0; i < 4; i++) {
822 ff_free_vlc(&vlc[i]);
824 av_free(h[i].lengths);
825 av_free(h[i].values);
831 AVCodec ff_smacker_decoder = {
833 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
834 .type = AVMEDIA_TYPE_VIDEO,
835 .id = AV_CODEC_ID_SMACKVIDEO,
836 .priv_data_size = sizeof(SmackVContext),
839 .decode = decode_frame,
840 .capabilities = AV_CODEC_CAP_DR1,
841 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
844 AVCodec ff_smackaud_decoder = {
846 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
847 .type = AVMEDIA_TYPE_AUDIO,
848 .id = AV_CODEC_ID_SMACKAUDIO,
849 .init = smka_decode_init,
850 .decode = smka_decode_frame,
851 .capabilities = AV_CODEC_CAP_DR1,