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 {
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)
161 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3)
163 val = i1 | (i2 << 8);
164 if(val == ctx->escapes[0]) {
165 ctx->last[0] = ctx->current;
167 } else if(val == ctx->escapes[1]) {
168 ctx->last[1] = ctx->current;
170 } else if(val == ctx->escapes[2]) {
171 ctx->last[2] = ctx->current;
175 ctx->values[ctx->current++] = val;
181 r = smacker_decode_bigtree(gb, ctx, length + 1);
184 ctx->values[t] = SMK_NODE | r;
186 r_new = smacker_decode_bigtree(gb, ctx, length + 1);
194 * Store large tree as FFmpeg's vlc codes
196 * Can read FFMAX(1 + SMKTREE_DECODE_MAX_RECURSION, 2 + 3 * 16) bits
197 * before the first check; can overread by 6 * SMKTREE_BITS + 1 on success.
199 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
201 HuffContext h[2] = { 0 };
202 VLC vlc[2] = { { 0 } };
207 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
208 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
209 return AVERROR_INVALIDDATA;
212 for (int i = 0; i < 2; i++) {
215 h[i].bits = av_malloc(256 * sizeof(h[i].bits[0]));
216 h[i].lengths = av_malloc(256 * sizeof(h[i].lengths[0]));
217 h[i].values = av_malloc(256 * sizeof(h[i].values[0]));
218 if (!h[i].bits || !h[i].lengths || !h[i].values) {
219 err = AVERROR(ENOMEM);
222 if (!get_bits1(gb)) {
224 av_log(smk->avctx, AV_LOG_ERROR, "Skipping %s bytes tree\n",
228 err = smacker_decode_tree(gb, &h[i], 0, 0);
232 if (h[i].current > 1) {
233 err = ff_init_vlc_sparse(&vlc[i], SMKTREE_BITS, h[i].current,
234 INIT_VLC_DEFAULT_SIZES(h[i].lengths),
235 INIT_VLC_DEFAULT_SIZES(h[i].bits),
236 INIT_VLC_DEFAULT_SIZES(h[i].values),
239 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
243 ctx.vals[i] = h[i].values[0];
246 escapes[0] = get_bits(gb, 16);
247 escapes[1] = get_bits(gb, 16);
248 escapes[2] = get_bits(gb, 16);
250 last[0] = last[1] = last[2] = -1;
252 ctx.escapes[0] = escapes[0];
253 ctx.escapes[1] = escapes[1];
254 ctx.escapes[2] = escapes[2];
258 ctx.length = (size + 3) >> 2;
260 ctx.values = av_malloc_array(ctx.length + 3, sizeof(ctx.values[0]));
262 err = AVERROR(ENOMEM);
265 *recodes = ctx.values;
267 err = smacker_decode_bigtree(gb, &ctx, 0);
271 if (ctx.last[0] == -1) ctx.last[0] = ctx.current++;
272 if (ctx.last[1] == -1) ctx.last[1] = ctx.current++;
273 if (ctx.last[2] == -1) ctx.last[2] = ctx.current++;
277 for (int i = 0; i < 2; i++) {
278 ff_free_vlc(&vlc[i]);
280 av_free(h[i].lengths);
281 av_free(h[i].values);
287 static int decode_header_trees(SmackVContext *smk) {
289 int mmap_size, mclr_size, full_size, type_size, ret;
292 mmap_size = AV_RL32(smk->avctx->extradata);
293 mclr_size = AV_RL32(smk->avctx->extradata + 4);
294 full_size = AV_RL32(smk->avctx->extradata + 8);
295 type_size = AV_RL32(smk->avctx->extradata + 12);
297 ret = init_get_bits8(&gb, smk->avctx->extradata + 16, smk->avctx->extradata_size - 16);
301 if(!get_bits1(&gb)) {
303 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
304 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
306 return AVERROR(ENOMEM);
307 smk->mmap_tbl[0] = 0;
308 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
310 ret = smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
314 if(!get_bits1(&gb)) {
316 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
317 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
319 return AVERROR(ENOMEM);
320 smk->mclr_tbl[0] = 0;
321 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
323 ret = smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
327 if(!get_bits1(&gb)) {
329 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
330 smk->full_tbl = av_malloc(sizeof(int) * 2);
332 return AVERROR(ENOMEM);
333 smk->full_tbl[0] = 0;
334 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
336 ret = smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
340 if(!get_bits1(&gb)) {
342 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
343 smk->type_tbl = av_malloc(sizeof(int) * 2);
345 return AVERROR(ENOMEM);
346 smk->type_tbl[0] = 0;
347 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
349 ret = smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
353 if (skip == 4 || get_bits_left(&gb) < 0)
354 return AVERROR_INVALIDDATA;
359 static av_always_inline void last_reset(int *recode, int *last) {
360 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
363 /* Get code and update history.
364 * Checks before reading, does not overread. */
365 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
366 register int *table = recode;
369 while(*table & SMK_NODE) {
370 if (get_bits_left(gb) < 1)
371 return AVERROR_INVALIDDATA;
373 table += (*table) & (~SMK_NODE);
378 if(v != recode[last[0]]) {
379 recode[last[2]] = recode[last[1]];
380 recode[last[1]] = recode[last[0]];
386 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
389 SmackVContext * const smk = avctx->priv_data;
394 int blocks, blk, bw, bh;
399 if (avpkt->size <= 769)
400 return AVERROR_INVALIDDATA;
402 if ((ret = ff_reget_buffer(avctx, smk->pic, 0)) < 0)
405 /* make the palette available on the way out */
406 pal = (uint32_t*)smk->pic->data[1];
407 bytestream2_init(&gb2, avpkt->data, avpkt->size);
408 flags = bytestream2_get_byteu(&gb2);
409 smk->pic->palette_has_changed = flags & 1;
410 smk->pic->key_frame = !!(flags & 2);
411 if (smk->pic->key_frame)
412 smk->pic->pict_type = AV_PICTURE_TYPE_I;
414 smk->pic->pict_type = AV_PICTURE_TYPE_P;
416 for(i = 0; i < 256; i++)
417 *pal++ = 0xFFU << 24 | bytestream2_get_be24u(&gb2);
419 last_reset(smk->mmap_tbl, smk->mmap_last);
420 last_reset(smk->mclr_tbl, smk->mclr_last);
421 last_reset(smk->full_tbl, smk->full_last);
422 last_reset(smk->type_tbl, smk->type_last);
423 if ((ret = init_get_bits8(&gb, avpkt->data + 769, avpkt->size - 769)) < 0)
427 bw = avctx->width >> 2;
428 bh = avctx->height >> 2;
430 stride = smk->pic->linesize[0];
431 while(blk < blocks) {
435 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
438 run = block_runs[(type >> 2) & 0x3F];
441 while(run-- && blk < blocks){
444 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
445 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
446 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
449 for(i = 0; i < 4; i++) {
450 if(map & 1) out[0] = hi; else out[0] = lo;
451 if(map & 2) out[1] = hi; else out[1] = lo;
452 if(map & 4) out[2] = hi; else out[2] = lo;
453 if(map & 8) out[3] = hi; else out[3] = lo;
462 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
463 if(get_bits1(&gb)) mode = 1;
464 else if(get_bits1(&gb)) mode = 2;
466 while(run-- && blk < blocks){
467 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
470 for(i = 0; i < 4; i++) {
471 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
473 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
479 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
480 out[0] = out[1] = pix & 0xFF;
481 out[2] = out[3] = pix >> 8;
483 out[0] = out[1] = pix & 0xFF;
484 out[2] = out[3] = pix >> 8;
486 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
487 out[0] = out[1] = pix & 0xFF;
488 out[2] = out[3] = pix >> 8;
490 out[0] = out[1] = pix & 0xFF;
491 out[2] = out[3] = pix >> 8;
494 for(i = 0; i < 2; i++) {
496 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
497 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
511 while(run-- && blk < blocks)
516 while(run-- && blk < blocks){
518 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
519 col = mode * 0x01010101U;
520 for(i = 0; i < 4; i++) {
521 *((uint32_t*)out) = col;
531 if ((ret = av_frame_ref(data, smk->pic)) < 0)
536 /* always report that the buffer was completely consumed */
541 static av_cold int decode_end(AVCodecContext *avctx)
543 SmackVContext * const smk = avctx->priv_data;
545 av_freep(&smk->mmap_tbl);
546 av_freep(&smk->mclr_tbl);
547 av_freep(&smk->full_tbl);
548 av_freep(&smk->type_tbl);
550 av_frame_free(&smk->pic);
556 static av_cold int decode_init(AVCodecContext *avctx)
558 SmackVContext * const c = avctx->priv_data;
563 avctx->pix_fmt = AV_PIX_FMT_PAL8;
565 c->pic = av_frame_alloc();
567 return AVERROR(ENOMEM);
569 /* decode huffman trees from extradata */
570 if (avctx->extradata_size <= 16){
571 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
572 return AVERROR(EINVAL);
575 ret = decode_header_trees(c);
584 static av_cold int smka_decode_init(AVCodecContext *avctx)
586 if (avctx->channels < 1 || avctx->channels > 2) {
587 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
588 return AVERROR_INVALIDDATA;
590 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
591 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
597 * Decode Smacker audio data
599 static int smka_decode_frame(AVCodecContext *avctx, void *data,
600 int *got_frame_ptr, AVPacket *avpkt)
602 AVFrame *frame = data;
603 const uint8_t *buf = avpkt->data;
604 int buf_size = avpkt->size;
606 HuffContext h[4] = { { 0 } };
607 VLC vlc[4] = { { 0 } };
615 int pred[2] = {0, 0};
618 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
619 return AVERROR_INVALIDDATA;
622 unp_size = AV_RL32(buf);
624 if (unp_size > (1U<<24)) {
625 av_log(avctx, AV_LOG_ERROR, "packet is too big\n");
626 return AVERROR_INVALIDDATA;
629 if ((ret = init_get_bits8(&gb, buf + 4, buf_size - 4)) < 0)
633 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
637 stereo = get_bits1(&gb);
638 bits = get_bits1(&gb);
639 if (stereo ^ (avctx->channels != 1)) {
640 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
641 return AVERROR_INVALIDDATA;
643 if (bits == (avctx->sample_fmt == AV_SAMPLE_FMT_U8)) {
644 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
645 return AVERROR_INVALIDDATA;
648 /* get output buffer */
649 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
650 if (unp_size % (avctx->channels * (bits + 1))) {
651 av_log(avctx, AV_LOG_ERROR,
652 "The buffer does not contain an integer number of samples\n");
653 return AVERROR_INVALIDDATA;
655 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
657 samples = (int16_t *)frame->data[0];
658 samples8 = frame->data[0];
661 for(i = 0; i < (1 << (bits + stereo)); i++) {
664 h[i].bits = av_malloc(256 * sizeof(h[i].bits));
665 h[i].lengths = av_malloc(256 * sizeof(h[i].lengths));
666 h[i].values = av_malloc(256 * sizeof(h[i].values));
667 if (!h[i].bits || !h[i].lengths || !h[i].values) {
668 ret = AVERROR(ENOMEM);
672 if ((ret = smacker_decode_tree(&gb, &h[i], 0, 0)) < 0)
675 if(h[i].current > 1) {
676 ret = ff_init_vlc_sparse(&vlc[i], SMKTREE_BITS, h[i].current,
677 INIT_VLC_DEFAULT_SIZES(h[i].lengths),
678 INIT_VLC_DEFAULT_SIZES(h[i].bits),
679 INIT_VLC_DEFAULT_SIZES(h[i].values),
682 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
686 values[i] = h[i].values[0];
688 /* this codec relies on wraparound instead of clipping audio */
689 if(bits) { //decode 16-bit data
690 for(i = stereo; i >= 0; i--)
691 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
692 for(i = 0; i <= stereo; i++)
693 *samples++ = pred[i];
694 for(; i < unp_size / 2; i++) {
695 if (get_bits_left(&gb) < 0) {
696 ret = AVERROR_INVALIDDATA;
701 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
706 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
710 pred[1] += (unsigned)sign_extend(val, 16);
711 *samples++ = pred[1];
714 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
719 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
723 pred[0] += (unsigned)sign_extend(val, 16);
724 *samples++ = pred[0];
727 } else { //8-bit data
728 for(i = stereo; i >= 0; i--)
729 pred[i] = get_bits(&gb, 8);
730 for(i = 0; i <= stereo; i++)
731 *samples8++ = pred[i];
732 for(; i < unp_size; i++) {
733 if (get_bits_left(&gb) < 0) {
734 ret = AVERROR_INVALIDDATA;
739 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
742 pred[1] += sign_extend(res, 8);
743 *samples8++ = pred[1];
746 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
749 pred[0] += sign_extend(res, 8);
750 *samples8++ = pred[0];
759 for(i = 0; i < 4; i++) {
760 ff_free_vlc(&vlc[i]);
762 av_free(h[i].lengths);
763 av_free(h[i].values);
769 AVCodec ff_smacker_decoder = {
771 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
772 .type = AVMEDIA_TYPE_VIDEO,
773 .id = AV_CODEC_ID_SMACKVIDEO,
774 .priv_data_size = sizeof(SmackVContext),
777 .decode = decode_frame,
778 .capabilities = AV_CODEC_CAP_DR1,
779 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
782 AVCodec ff_smackaud_decoder = {
784 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
785 .type = AVMEDIA_TYPE_AUDIO,
786 .id = AV_CODEC_ID_SMACKAUDIO,
787 .init = smka_decode_init,
788 .decode = smka_decode_frame,
789 .capabilities = AV_CODEC_CAP_DR1,