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 {
75 /* common parameters used for decode_bigtree */
76 typedef struct DBCtx {
85 /* possible runs of blocks */
86 static const int block_runs[64] = {
87 1, 2, 3, 4, 5, 6, 7, 8,
88 9, 10, 11, 12, 13, 14, 15, 16,
89 17, 18, 19, 20, 21, 22, 23, 24,
90 25, 26, 27, 28, 29, 30, 31, 32,
91 33, 34, 35, 36, 37, 38, 39, 40,
92 41, 42, 43, 44, 45, 46, 47, 48,
93 49, 50, 51, 52, 53, 54, 55, 56,
94 57, 58, 59, 128, 256, 512, 1024, 2048 };
103 * Decode local frame tree
105 * Can read SMKTREE_DECODE_MAX_RECURSION before the first check;
106 * does not overread gb on success.
108 static int smacker_decode_tree(GetBitContext *gb, HuffContext *hc, uint32_t prefix, int length)
110 if (length > SMKTREE_DECODE_MAX_RECURSION || length > 3 * SMKTREE_BITS) {
111 av_log(NULL, AV_LOG_ERROR, "Maximum tree recursion level exceeded.\n");
112 return AVERROR_INVALIDDATA;
115 if(!get_bits1(gb)){ //Leaf
116 if (hc->current >= 256) {
117 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
118 return AVERROR_INVALIDDATA;
120 if (get_bits_left(gb) < 8)
121 return AVERROR_INVALIDDATA;
122 hc->bits[hc->current] = prefix;
123 hc->lengths[hc->current] = length;
124 hc->values[hc->current] = get_bits(gb, 8);
130 r = smacker_decode_tree(gb, hc, prefix, length);
133 return smacker_decode_tree(gb, hc, prefix | (1U << (length - 1)), length);
140 * Checks before the first read, can overread by 6 * SMKTREE_BITS on success.
142 static int smacker_decode_bigtree(GetBitContext *gb, DBCtx *ctx, int length)
144 // Larger length can cause segmentation faults due to too deep recursion.
145 if (length > SMKTREE_DECODE_BIG_MAX_RECURSION) {
146 av_log(NULL, AV_LOG_ERROR, "Maximum bigtree recursion level exceeded.\n");
147 return AVERROR_INVALIDDATA;
150 if (ctx->current >= ctx->length) {
151 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
152 return AVERROR_INVALIDDATA;
154 if (get_bits_left(gb) <= 0)
155 return AVERROR_INVALIDDATA;
156 if(!get_bits1(gb)){ //Leaf
158 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3)
160 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3)
162 val = i1 | (i2 << 8);
163 if(val == ctx->escapes[0]) {
164 ctx->last[0] = ctx->current;
166 } else if(val == ctx->escapes[1]) {
167 ctx->last[1] = ctx->current;
169 } else if(val == ctx->escapes[2]) {
170 ctx->last[2] = ctx->current;
174 ctx->values[ctx->current++] = val;
180 r = smacker_decode_bigtree(gb, ctx, length + 1);
183 ctx->values[t] = SMK_NODE | r;
185 r_new = smacker_decode_bigtree(gb, ctx, length + 1);
193 * Store large tree as FFmpeg's vlc codes
195 * Can read FFMAX(1 + SMKTREE_DECODE_MAX_RECURSION, 2 + 3 * 16) bits
196 * before the first check; can overread by 6 * SMKTREE_BITS + 1 on success.
198 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
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 if (!get_bits1(gb)) {
215 av_log(smk->avctx, AV_LOG_ERROR, "Skipping %s bytes tree\n",
219 err = smacker_decode_tree(gb, &h, 0, 0);
224 err = ff_init_vlc_sparse(&vlc[i], SMKTREE_BITS, h.current,
225 INIT_VLC_DEFAULT_SIZES(h.lengths),
226 INIT_VLC_DEFAULT_SIZES(h.bits),
227 INIT_VLC_DEFAULT_SIZES(h.values),
230 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
234 ctx.vals[i] = h.values[0];
237 escapes[0] = get_bits(gb, 16);
238 escapes[1] = get_bits(gb, 16);
239 escapes[2] = get_bits(gb, 16);
241 last[0] = last[1] = last[2] = -1;
243 ctx.escapes[0] = escapes[0];
244 ctx.escapes[1] = escapes[1];
245 ctx.escapes[2] = escapes[2];
249 ctx.length = (size + 3) >> 2;
251 ctx.values = av_malloc_array(ctx.length + 3, sizeof(ctx.values[0]));
253 err = AVERROR(ENOMEM);
256 *recodes = ctx.values;
258 err = smacker_decode_bigtree(gb, &ctx, 0);
262 if (ctx.last[0] == -1) ctx.last[0] = ctx.current++;
263 if (ctx.last[1] == -1) ctx.last[1] = ctx.current++;
264 if (ctx.last[2] == -1) ctx.last[2] = ctx.current++;
268 for (int i = 0; i < 2; i++) {
269 ff_free_vlc(&vlc[i]);
275 static int decode_header_trees(SmackVContext *smk) {
277 int mmap_size, mclr_size, full_size, type_size, ret;
280 mmap_size = AV_RL32(smk->avctx->extradata);
281 mclr_size = AV_RL32(smk->avctx->extradata + 4);
282 full_size = AV_RL32(smk->avctx->extradata + 8);
283 type_size = AV_RL32(smk->avctx->extradata + 12);
285 ret = init_get_bits8(&gb, smk->avctx->extradata + 16, smk->avctx->extradata_size - 16);
289 if(!get_bits1(&gb)) {
291 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
292 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
294 return AVERROR(ENOMEM);
295 smk->mmap_tbl[0] = 0;
296 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
298 ret = smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
302 if(!get_bits1(&gb)) {
304 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
305 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
307 return AVERROR(ENOMEM);
308 smk->mclr_tbl[0] = 0;
309 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
311 ret = smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
315 if(!get_bits1(&gb)) {
317 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
318 smk->full_tbl = av_malloc(sizeof(int) * 2);
320 return AVERROR(ENOMEM);
321 smk->full_tbl[0] = 0;
322 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
324 ret = smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
328 if(!get_bits1(&gb)) {
330 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
331 smk->type_tbl = av_malloc(sizeof(int) * 2);
333 return AVERROR(ENOMEM);
334 smk->type_tbl[0] = 0;
335 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
337 ret = smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
341 if (skip == 4 || get_bits_left(&gb) < 0)
342 return AVERROR_INVALIDDATA;
347 static av_always_inline void last_reset(int *recode, int *last) {
348 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
351 /* Get code and update history.
352 * Checks before reading, does not overread. */
353 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
354 register int *table = recode;
357 while(*table & SMK_NODE) {
358 if (get_bits_left(gb) < 1)
359 return AVERROR_INVALIDDATA;
361 table += (*table) & (~SMK_NODE);
366 if(v != recode[last[0]]) {
367 recode[last[2]] = recode[last[1]];
368 recode[last[1]] = recode[last[0]];
374 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
377 SmackVContext * const smk = avctx->priv_data;
382 int blocks, blk, bw, bh;
387 if (avpkt->size <= 769)
388 return AVERROR_INVALIDDATA;
390 if ((ret = ff_reget_buffer(avctx, smk->pic, 0)) < 0)
393 /* make the palette available on the way out */
394 pal = (uint32_t*)smk->pic->data[1];
395 bytestream2_init(&gb2, avpkt->data, avpkt->size);
396 flags = bytestream2_get_byteu(&gb2);
397 smk->pic->palette_has_changed = flags & 1;
398 smk->pic->key_frame = !!(flags & 2);
399 if (smk->pic->key_frame)
400 smk->pic->pict_type = AV_PICTURE_TYPE_I;
402 smk->pic->pict_type = AV_PICTURE_TYPE_P;
404 for(i = 0; i < 256; i++)
405 *pal++ = 0xFFU << 24 | bytestream2_get_be24u(&gb2);
407 last_reset(smk->mmap_tbl, smk->mmap_last);
408 last_reset(smk->mclr_tbl, smk->mclr_last);
409 last_reset(smk->full_tbl, smk->full_last);
410 last_reset(smk->type_tbl, smk->type_last);
411 if ((ret = init_get_bits8(&gb, avpkt->data + 769, avpkt->size - 769)) < 0)
415 bw = avctx->width >> 2;
416 bh = avctx->height >> 2;
418 stride = smk->pic->linesize[0];
419 while(blk < blocks) {
423 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
426 run = block_runs[(type >> 2) & 0x3F];
429 while(run-- && blk < blocks){
432 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
433 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
434 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
437 for(i = 0; i < 4; i++) {
438 if(map & 1) out[0] = hi; else out[0] = lo;
439 if(map & 2) out[1] = hi; else out[1] = lo;
440 if(map & 4) out[2] = hi; else out[2] = lo;
441 if(map & 8) out[3] = hi; else out[3] = lo;
450 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
451 if(get_bits1(&gb)) mode = 1;
452 else if(get_bits1(&gb)) mode = 2;
454 while(run-- && blk < blocks){
455 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
458 for(i = 0; i < 4; i++) {
459 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
461 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
467 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
468 out[0] = out[1] = pix & 0xFF;
469 out[2] = out[3] = pix >> 8;
471 out[0] = out[1] = pix & 0xFF;
472 out[2] = out[3] = pix >> 8;
474 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
475 out[0] = out[1] = pix & 0xFF;
476 out[2] = out[3] = pix >> 8;
478 out[0] = out[1] = pix & 0xFF;
479 out[2] = out[3] = pix >> 8;
482 for(i = 0; i < 2; i++) {
484 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
485 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
499 while(run-- && blk < blocks)
504 while(run-- && blk < blocks){
506 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
507 col = mode * 0x01010101U;
508 for(i = 0; i < 4; i++) {
509 *((uint32_t*)out) = col;
519 if ((ret = av_frame_ref(data, smk->pic)) < 0)
524 /* always report that the buffer was completely consumed */
529 static av_cold int decode_end(AVCodecContext *avctx)
531 SmackVContext * const smk = avctx->priv_data;
533 av_freep(&smk->mmap_tbl);
534 av_freep(&smk->mclr_tbl);
535 av_freep(&smk->full_tbl);
536 av_freep(&smk->type_tbl);
538 av_frame_free(&smk->pic);
544 static av_cold int decode_init(AVCodecContext *avctx)
546 SmackVContext * const c = avctx->priv_data;
551 avctx->pix_fmt = AV_PIX_FMT_PAL8;
553 c->pic = av_frame_alloc();
555 return AVERROR(ENOMEM);
557 /* decode huffman trees from extradata */
558 if (avctx->extradata_size <= 16){
559 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
560 return AVERROR(EINVAL);
563 ret = decode_header_trees(c);
572 static av_cold int smka_decode_init(AVCodecContext *avctx)
574 if (avctx->channels < 1 || avctx->channels > 2) {
575 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
576 return AVERROR_INVALIDDATA;
578 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
579 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
585 * Decode Smacker audio data
587 static int smka_decode_frame(AVCodecContext *avctx, void *data,
588 int *got_frame_ptr, AVPacket *avpkt)
590 AVFrame *frame = data;
591 const uint8_t *buf = avpkt->data;
592 int buf_size = avpkt->size;
594 VLC vlc[4] = { { 0 } };
601 unsigned pred[2], val;
604 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
605 return AVERROR_INVALIDDATA;
608 unp_size = AV_RL32(buf);
610 if (unp_size > (1U<<24)) {
611 av_log(avctx, AV_LOG_ERROR, "packet is too big\n");
612 return AVERROR_INVALIDDATA;
615 if ((ret = init_get_bits8(&gb, buf + 4, buf_size - 4)) < 0)
619 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
623 stereo = get_bits1(&gb);
624 bits = get_bits1(&gb);
625 if (stereo ^ (avctx->channels != 1)) {
626 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
627 return AVERROR_INVALIDDATA;
629 if (bits == (avctx->sample_fmt == AV_SAMPLE_FMT_U8)) {
630 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
631 return AVERROR_INVALIDDATA;
634 /* get output buffer */
635 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
636 if (unp_size % (avctx->channels * (bits + 1))) {
637 av_log(avctx, AV_LOG_ERROR,
638 "The buffer does not contain an integer number of samples\n");
639 return AVERROR_INVALIDDATA;
641 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
643 samples = (int16_t *)frame->data[0];
644 samples8 = frame->data[0];
647 for(i = 0; i < (1 << (bits + stereo)); i++) {
651 if ((ret = smacker_decode_tree(&gb, &h, 0, 0)) < 0)
655 ret = ff_init_vlc_sparse(&vlc[i], SMKTREE_BITS, h.current,
656 INIT_VLC_DEFAULT_SIZES(h.lengths),
657 INIT_VLC_DEFAULT_SIZES(h.bits),
658 INIT_VLC_DEFAULT_SIZES(h.values),
661 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
665 values[i] = h.values[0];
667 /* this codec relies on wraparound instead of clipping audio */
668 if(bits) { //decode 16-bit data
669 for(i = stereo; i >= 0; i--)
670 pred[i] = av_bswap16(get_bits(&gb, 16));
671 for(i = 0; i <= stereo; i++)
672 *samples++ = pred[i];
673 for(; i < unp_size / 2; i++) {
674 unsigned idx = 2 * (i & stereo);
675 if (get_bits_left(&gb) < 0) {
676 ret = AVERROR_INVALIDDATA;
680 res = get_vlc2(&gb, vlc[idx].table, SMKTREE_BITS, 3);
684 if (vlc[++idx].table)
685 res = get_vlc2(&gb, vlc[idx].table, SMKTREE_BITS, 3);
689 pred[idx / 2] += val;
690 *samples++ = pred[idx / 2];
692 } else { //8-bit data
693 for(i = stereo; i >= 0; i--)
694 pred[i] = get_bits(&gb, 8);
695 for(i = 0; i <= stereo; i++)
696 *samples8++ = pred[i];
697 for(; i < unp_size; i++) {
698 unsigned idx = i & stereo;
699 if (get_bits_left(&gb) < 0) {
700 ret = AVERROR_INVALIDDATA;
704 val = get_vlc2(&gb, vlc[idx].table, SMKTREE_BITS, 3);
708 *samples8++ = pred[idx];
716 for(i = 0; i < 4; i++) {
717 ff_free_vlc(&vlc[i]);
723 AVCodec ff_smacker_decoder = {
725 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
726 .type = AVMEDIA_TYPE_VIDEO,
727 .id = AV_CODEC_ID_SMACKVIDEO,
728 .priv_data_size = sizeof(SmackVContext),
731 .decode = decode_frame,
732 .capabilities = AV_CODEC_CAP_DR1,
733 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
736 AVCodec ff_smackaud_decoder = {
738 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
739 .type = AVMEDIA_TYPE_AUDIO,
740 .id = AV_CODEC_ID_SMACKAUDIO,
741 .init = smka_decode_init,
742 .decode = smka_decode_frame,
743 .capabilities = AV_CODEC_CAP_DR1,