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"
38 #define SMKTREE_BITS 9
39 #define SMK_NODE 0x80000000
41 #define SMKTREE_DECODE_MAX_RECURSION FFMIN(32, 3 * SMKTREE_BITS)
42 #define SMKTREE_DECODE_BIG_MAX_RECURSION 500
44 /* The maximum possible unchecked overread happens in decode_header_trees:
45 * Decoding the MMAP tree can overread by 6 * SMKTREE_BITS + 1, followed by
46 * three get_bits1, followed by at most 2 + 3 * 16 read bits when reading
47 * the TYPE tree before the next check. 64 is because of 64 bit reads. */
48 #if (6 * SMKTREE_BITS + 1 + 3 + (2 + 3 * 16) + 64) <= 8 * AV_INPUT_BUFFER_PADDING_SIZE
49 #define UNCHECKED_BITSTREAM_READER 1
51 #define BITSTREAM_READER_LE
52 #include "bytestream.h"
57 typedef struct SmackVContext {
58 AVCodecContext *avctx;
61 int *mmap_tbl, *mclr_tbl, *full_tbl, *type_tbl;
62 int mmap_last[3], mclr_last[3], full_last[3], type_last[3];
66 * Context used for code reconstructing
68 typedef struct HuffContext {
76 /* common parameters used for decode_bigtree */
77 typedef struct DBCtx {
81 const uint8_t *recode1, *recode2;
86 /* possible runs of blocks */
87 static const int block_runs[64] = {
88 1, 2, 3, 4, 5, 6, 7, 8,
89 9, 10, 11, 12, 13, 14, 15, 16,
90 17, 18, 19, 20, 21, 22, 23, 24,
91 25, 26, 27, 28, 29, 30, 31, 32,
92 33, 34, 35, 36, 37, 38, 39, 40,
93 41, 42, 43, 44, 45, 46, 47, 48,
94 49, 50, 51, 52, 53, 54, 55, 56,
95 57, 58, 59, 128, 256, 512, 1024, 2048 };
104 * Decode local frame tree
106 * Can read SMKTREE_DECODE_MAX_RECURSION before the first check;
107 * does not overread gb on success.
109 static int smacker_decode_tree(GetBitContext *gb, HuffContext *hc, uint32_t prefix, int length)
111 if (length > SMKTREE_DECODE_MAX_RECURSION || length > 3 * SMKTREE_BITS) {
112 av_log(NULL, AV_LOG_ERROR, "Maximum tree recursion level exceeded.\n");
113 return AVERROR_INVALIDDATA;
116 if(!get_bits1(gb)){ //Leaf
117 if(hc->current >= hc->length){
118 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
119 return AVERROR_INVALIDDATA;
121 if (get_bits_left(gb) < 8)
122 return AVERROR_INVALIDDATA;
123 hc->bits[hc->current] = prefix;
124 hc->lengths[hc->current] = length;
125 hc->values[hc->current] = get_bits(gb, 8);
131 r = smacker_decode_tree(gb, hc, prefix, length);
134 return smacker_decode_tree(gb, hc, prefix | (1U << (length - 1)), length);
141 * Checks before the first read, can overread by 6 * SMKTREE_BITS on success.
143 static int smacker_decode_bigtree(GetBitContext *gb, DBCtx *ctx, int length)
145 // Larger length can cause segmentation faults due to too deep recursion.
146 if (length > SMKTREE_DECODE_BIG_MAX_RECURSION) {
147 av_log(NULL, AV_LOG_ERROR, "Maximum bigtree recursion level exceeded.\n");
148 return AVERROR_INVALIDDATA;
151 if (ctx->current >= ctx->length) {
152 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
153 return AVERROR_INVALIDDATA;
155 if (get_bits_left(gb) <= 0)
156 return AVERROR_INVALIDDATA;
157 if(!get_bits1(gb)){ //Leaf
159 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
160 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
161 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
162 if(val == ctx->escapes[0]) {
163 ctx->last[0] = ctx->current;
165 } else if(val == ctx->escapes[1]) {
166 ctx->last[1] = ctx->current;
168 } else if(val == ctx->escapes[2]) {
169 ctx->last[2] = ctx->current;
173 ctx->values[ctx->current++] = val;
179 r = smacker_decode_bigtree(gb, ctx, length + 1);
182 ctx->values[t] = SMK_NODE | r;
184 r_new = smacker_decode_bigtree(gb, ctx, length + 1);
192 * Store large tree as FFmpeg's vlc codes
194 * Can read FFMAX(1 + SMKTREE_DECODE_MAX_RECURSION, 2 + 3 * 16) bits
195 * before the first check; can overread by 6 * SMKTREE_BITS + 1 on success.
197 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
199 HuffContext h[2] = { 0 };
200 VLC vlc[2] = { { 0 } };
205 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
206 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
207 return AVERROR_INVALIDDATA;
210 for (int i = 0; i < 2; i++) {
213 h[i].bits = av_malloc(256 * sizeof(h[i].bits[0]));
214 h[i].lengths = av_malloc(256 * sizeof(h[i].lengths[0]));
215 h[i].values = av_malloc(256 * sizeof(h[i].values[0]));
216 if (!h[i].bits || !h[i].lengths || !h[i].values) {
217 err = AVERROR(ENOMEM);
220 if (!get_bits1(gb)) {
222 av_log(smk->avctx, AV_LOG_ERROR, "Skipping %s bytes tree\n",
226 err = smacker_decode_tree(gb, &h[i], 0, 0);
230 if (h[i].current > 1) {
231 err = init_vlc(&vlc[i], SMKTREE_BITS, h[i].current,
232 INIT_VLC_DEFAULT_SIZES(h[i].lengths),
233 INIT_VLC_DEFAULT_SIZES(h[i].bits),
236 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
242 escapes[0] = get_bits(gb, 16);
243 escapes[1] = get_bits(gb, 16);
244 escapes[2] = get_bits(gb, 16);
246 last[0] = last[1] = last[2] = -1;
248 ctx.escapes[0] = escapes[0];
249 ctx.escapes[1] = escapes[1];
250 ctx.escapes[2] = escapes[2];
253 ctx.recode1 = h[0].values;
254 ctx.recode2 = h[1].values;
256 ctx.length = (size + 3) >> 2;
258 ctx.values = av_malloc_array(ctx.length + 3, sizeof(ctx.values[0]));
260 err = AVERROR(ENOMEM);
263 *recodes = ctx.values;
265 err = smacker_decode_bigtree(gb, &ctx, 0);
269 if (ctx.last[0] == -1) ctx.last[0] = ctx.current++;
270 if (ctx.last[1] == -1) ctx.last[1] = ctx.current++;
271 if (ctx.last[2] == -1) ctx.last[2] = ctx.current++;
275 for (int i = 0; i < 2; i++) {
276 ff_free_vlc(&vlc[i]);
278 av_free(h[i].lengths);
279 av_free(h[i].values);
285 static int decode_header_trees(SmackVContext *smk) {
287 int mmap_size, mclr_size, full_size, type_size, ret;
290 mmap_size = AV_RL32(smk->avctx->extradata);
291 mclr_size = AV_RL32(smk->avctx->extradata + 4);
292 full_size = AV_RL32(smk->avctx->extradata + 8);
293 type_size = AV_RL32(smk->avctx->extradata + 12);
295 ret = init_get_bits8(&gb, smk->avctx->extradata + 16, smk->avctx->extradata_size - 16);
299 if(!get_bits1(&gb)) {
301 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
302 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
304 return AVERROR(ENOMEM);
305 smk->mmap_tbl[0] = 0;
306 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
308 ret = smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
312 if(!get_bits1(&gb)) {
314 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
315 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
317 return AVERROR(ENOMEM);
318 smk->mclr_tbl[0] = 0;
319 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
321 ret = smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
325 if(!get_bits1(&gb)) {
327 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
328 smk->full_tbl = av_malloc(sizeof(int) * 2);
330 return AVERROR(ENOMEM);
331 smk->full_tbl[0] = 0;
332 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
334 ret = smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
338 if(!get_bits1(&gb)) {
340 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
341 smk->type_tbl = av_malloc(sizeof(int) * 2);
343 return AVERROR(ENOMEM);
344 smk->type_tbl[0] = 0;
345 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
347 ret = smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
351 if (skip == 4 || get_bits_left(&gb) < 0)
352 return AVERROR_INVALIDDATA;
357 static av_always_inline void last_reset(int *recode, int *last) {
358 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
361 /* Get code and update history.
362 * Checks before reading, does not overread. */
363 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
364 register int *table = recode;
367 while(*table & SMK_NODE) {
368 if (get_bits_left(gb) < 1)
369 return AVERROR_INVALIDDATA;
371 table += (*table) & (~SMK_NODE);
376 if(v != recode[last[0]]) {
377 recode[last[2]] = recode[last[1]];
378 recode[last[1]] = recode[last[0]];
384 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
387 SmackVContext * const smk = avctx->priv_data;
392 int blocks, blk, bw, bh;
397 if (avpkt->size <= 769)
398 return AVERROR_INVALIDDATA;
400 if ((ret = ff_reget_buffer(avctx, smk->pic, 0)) < 0)
403 /* make the palette available on the way out */
404 pal = (uint32_t*)smk->pic->data[1];
405 bytestream2_init(&gb2, avpkt->data, avpkt->size);
406 flags = bytestream2_get_byteu(&gb2);
407 smk->pic->palette_has_changed = flags & 1;
408 smk->pic->key_frame = !!(flags & 2);
409 if (smk->pic->key_frame)
410 smk->pic->pict_type = AV_PICTURE_TYPE_I;
412 smk->pic->pict_type = AV_PICTURE_TYPE_P;
414 for(i = 0; i < 256; i++)
415 *pal++ = 0xFFU << 24 | bytestream2_get_be24u(&gb2);
417 last_reset(smk->mmap_tbl, smk->mmap_last);
418 last_reset(smk->mclr_tbl, smk->mclr_last);
419 last_reset(smk->full_tbl, smk->full_last);
420 last_reset(smk->type_tbl, smk->type_last);
421 if ((ret = init_get_bits8(&gb, avpkt->data + 769, avpkt->size - 769)) < 0)
425 bw = avctx->width >> 2;
426 bh = avctx->height >> 2;
428 stride = smk->pic->linesize[0];
429 while(blk < blocks) {
433 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
436 run = block_runs[(type >> 2) & 0x3F];
439 while(run-- && blk < blocks){
442 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
443 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
444 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
447 for(i = 0; i < 4; i++) {
448 if(map & 1) out[0] = hi; else out[0] = lo;
449 if(map & 2) out[1] = hi; else out[1] = lo;
450 if(map & 4) out[2] = hi; else out[2] = lo;
451 if(map & 8) out[3] = hi; else out[3] = lo;
460 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
461 if(get_bits1(&gb)) mode = 1;
462 else if(get_bits1(&gb)) mode = 2;
464 while(run-- && blk < blocks){
465 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
468 for(i = 0; i < 4; i++) {
469 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
471 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
477 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
478 out[0] = out[1] = pix & 0xFF;
479 out[2] = out[3] = pix >> 8;
481 out[0] = out[1] = pix & 0xFF;
482 out[2] = out[3] = pix >> 8;
484 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
485 out[0] = out[1] = pix & 0xFF;
486 out[2] = out[3] = pix >> 8;
488 out[0] = out[1] = pix & 0xFF;
489 out[2] = out[3] = pix >> 8;
492 for(i = 0; i < 2; i++) {
494 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
495 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
509 while(run-- && blk < blocks)
514 while(run-- && blk < blocks){
516 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
517 col = mode * 0x01010101U;
518 for(i = 0; i < 4; i++) {
519 *((uint32_t*)out) = col;
529 if ((ret = av_frame_ref(data, smk->pic)) < 0)
534 /* always report that the buffer was completely consumed */
539 static av_cold int decode_end(AVCodecContext *avctx)
541 SmackVContext * const smk = avctx->priv_data;
543 av_freep(&smk->mmap_tbl);
544 av_freep(&smk->mclr_tbl);
545 av_freep(&smk->full_tbl);
546 av_freep(&smk->type_tbl);
548 av_frame_free(&smk->pic);
554 static av_cold int decode_init(AVCodecContext *avctx)
556 SmackVContext * const c = avctx->priv_data;
561 avctx->pix_fmt = AV_PIX_FMT_PAL8;
563 c->pic = av_frame_alloc();
565 return AVERROR(ENOMEM);
567 /* decode huffman trees from extradata */
568 if (avctx->extradata_size <= 16){
569 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
570 return AVERROR(EINVAL);
573 ret = decode_header_trees(c);
582 static av_cold int smka_decode_init(AVCodecContext *avctx)
584 if (avctx->channels < 1 || avctx->channels > 2) {
585 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
586 return AVERROR_INVALIDDATA;
588 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
589 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
595 * Decode Smacker audio data
597 static int smka_decode_frame(AVCodecContext *avctx, void *data,
598 int *got_frame_ptr, AVPacket *avpkt)
600 AVFrame *frame = data;
601 const uint8_t *buf = avpkt->data;
602 int buf_size = avpkt->size;
604 HuffContext h[4] = { { 0 } };
605 VLC vlc[4] = { { 0 } };
612 int pred[2] = {0, 0};
615 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
616 return AVERROR_INVALIDDATA;
619 unp_size = AV_RL32(buf);
621 if (unp_size > (1U<<24)) {
622 av_log(avctx, AV_LOG_ERROR, "packet is too big\n");
623 return AVERROR_INVALIDDATA;
626 if ((ret = init_get_bits8(&gb, buf + 4, buf_size - 4)) < 0)
630 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
634 stereo = get_bits1(&gb);
635 bits = get_bits1(&gb);
636 if (stereo ^ (avctx->channels != 1)) {
637 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
638 return AVERROR_INVALIDDATA;
640 if (bits == (avctx->sample_fmt == AV_SAMPLE_FMT_U8)) {
641 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
642 return AVERROR_INVALIDDATA;
645 /* get output buffer */
646 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
647 if (unp_size % (avctx->channels * (bits + 1))) {
648 av_log(avctx, AV_LOG_ERROR,
649 "The buffer does not contain an integer number of samples\n");
650 return AVERROR_INVALIDDATA;
652 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
654 samples = (int16_t *)frame->data[0];
655 samples8 = frame->data[0];
658 for(i = 0; i < (1 << (bits + stereo)); i++) {
661 h[i].bits = av_malloc(256 * sizeof(h[i].bits));
662 h[i].lengths = av_malloc(256 * sizeof(h[i].lengths));
663 h[i].values = av_malloc(256 * sizeof(h[i].values));
664 if (!h[i].bits || !h[i].lengths || !h[i].values) {
665 ret = AVERROR(ENOMEM);
669 if ((ret = smacker_decode_tree(&gb, &h[i], 0, 0)) < 0)
672 if(h[i].current > 1) {
673 ret = init_vlc(&vlc[i], SMKTREE_BITS, h[i].current,
674 INIT_VLC_DEFAULT_SIZES(h[i].lengths),
675 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
677 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
682 /* this codec relies on wraparound instead of clipping audio */
683 if(bits) { //decode 16-bit data
684 for(i = stereo; i >= 0; i--)
685 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
686 for(i = 0; i <= stereo; i++)
687 *samples++ = pred[i];
688 for(; i < unp_size / 2; i++) {
689 if (get_bits_left(&gb) < 0) {
690 ret = AVERROR_INVALIDDATA;
695 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
698 val = h[2].values[res];
700 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
703 val |= h[3].values[res] << 8;
704 pred[1] += (unsigned)sign_extend(val, 16);
705 *samples++ = pred[1];
708 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
711 val = h[0].values[res];
713 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
716 val |= h[1].values[res] << 8;
717 pred[0] += (unsigned)sign_extend(val, 16);
718 *samples++ = pred[0];
721 } else { //8-bit data
722 for(i = stereo; i >= 0; i--)
723 pred[i] = get_bits(&gb, 8);
724 for(i = 0; i <= stereo; i++)
725 *samples8++ = pred[i];
726 for(; i < unp_size; i++) {
727 if (get_bits_left(&gb) < 0) {
728 ret = AVERROR_INVALIDDATA;
733 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
736 pred[1] += sign_extend(h[1].values[res], 8);
737 *samples8++ = pred[1];
740 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
743 pred[0] += sign_extend(h[0].values[res], 8);
744 *samples8++ = pred[0];
753 for(i = 0; i < 4; i++) {
754 ff_free_vlc(&vlc[i]);
756 av_free(h[i].lengths);
757 av_free(h[i].values);
763 AVCodec ff_smacker_decoder = {
765 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
766 .type = AVMEDIA_TYPE_VIDEO,
767 .id = AV_CODEC_ID_SMACKVIDEO,
768 .priv_data_size = sizeof(SmackVContext),
771 .decode = decode_frame,
772 .capabilities = AV_CODEC_CAP_DR1,
773 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
776 AVCodec ff_smackaud_decoder = {
778 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
779 .type = AVMEDIA_TYPE_AUDIO,
780 .id = AV_CODEC_ID_SMACKAUDIO,
781 .init = smka_decode_init,
782 .decode = smka_decode_frame,
783 .capabilities = AV_CODEC_CAP_DR1,