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 {
68 /* common parameters used for decode_bigtree */
69 typedef struct DBCtx {
71 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 > SMKTREE_DECODE_MAX_RECURSION || length > 3 * SMKTREE_BITS) {
99 av_log(NULL, AV_LOG_ERROR, "Maximum tree recursion level exceeded.\n");
100 return AVERROR_INVALIDDATA;
103 if(!get_bits1(gb)){ //Leaf
104 if(hc->current >= hc->length){
105 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
106 return AVERROR_INVALIDDATA;
109 hc->bits[hc->current] = prefix;
110 hc->lengths[hc->current] = length;
112 hc->bits[hc->current] = 0;
113 hc->lengths[hc->current] = 0;
115 hc->values[hc->current] = get_bits(gb, 8);
121 r = smacker_decode_tree(gb, hc, prefix, length);
124 return smacker_decode_tree(gb, hc, prefix | (1U << (length - 1)), length);
131 static int smacker_decode_bigtree(GetBitContext *gb, HuffContext *hc,
132 DBCtx *ctx, int length)
134 // Larger length can cause segmentation faults due to too deep recursion.
135 if (length > SMKTREE_DECODE_BIG_MAX_RECURSION) {
136 av_log(NULL, AV_LOG_ERROR, "Maximum bigtree recursion level exceeded.\n");
137 return AVERROR_INVALIDDATA;
140 if (hc->current >= hc->length) {
141 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
142 return AVERROR_INVALIDDATA;
144 if(!get_bits1(gb)){ //Leaf
146 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
147 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
148 if (i1 < 0 || i2 < 0)
149 return AVERROR_INVALIDDATA;
150 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
151 if(val == ctx->escapes[0]) {
152 ctx->last[0] = hc->current;
154 } else if(val == ctx->escapes[1]) {
155 ctx->last[1] = hc->current;
157 } else if(val == ctx->escapes[2]) {
158 ctx->last[2] = hc->current;
162 hc->values[hc->current++] = val;
168 r = smacker_decode_bigtree(gb, hc, ctx, length + 1);
171 hc->values[t] = SMK_NODE | r;
173 r_new = smacker_decode_bigtree(gb, hc, ctx, length + 1);
181 * Store large tree as FFmpeg's vlc codes
183 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
186 HuffContext h[2] = { 0 };
187 VLC vlc[2] = { { 0 } };
192 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
193 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
194 return AVERROR_INVALIDDATA;
197 for (int i = 0; i < 2; i++) {
200 h[i].bits = av_mallocz(256 * sizeof(h[i].bits[0]));
201 h[i].lengths = av_mallocz(256 * sizeof(h[i].lengths[0]));
202 h[i].values = av_mallocz(256 * sizeof(h[i].values[0]));
203 if (!h[i].bits || !h[i].lengths || !h[i].values) {
204 err = AVERROR(ENOMEM);
207 if (!get_bits1(gb)) {
208 av_log(smk->avctx, AV_LOG_ERROR, "Skipping %s bytes tree\n",
212 err = smacker_decode_tree(gb, &h[i], 0, 0);
216 if (h[i].current > 1) {
217 err = init_vlc(&vlc[i], SMKTREE_BITS, h[i].current,
218 INIT_VLC_DEFAULT_SIZES(h[i].lengths),
219 INIT_VLC_DEFAULT_SIZES(h[i].bits),
222 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
228 escapes[0] = get_bits(gb, 16);
229 escapes[1] = get_bits(gb, 16);
230 escapes[2] = get_bits(gb, 16);
232 last[0] = last[1] = last[2] = -1;
234 ctx.escapes[0] = escapes[0];
235 ctx.escapes[1] = escapes[1];
236 ctx.escapes[2] = escapes[2];
239 ctx.recode1 = h[0].values;
240 ctx.recode2 = h[1].values;
243 huff.length = (size + 3) >> 2;
245 huff.values = av_mallocz_array(huff.length + 3, sizeof(huff.values[0]));
247 err = AVERROR(ENOMEM);
250 *recodes = huff.values;
252 err = smacker_decode_bigtree(gb, &huff, &ctx, 0);
256 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
257 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
258 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
262 for (int i = 0; i < 2; i++) {
264 ff_free_vlc(&vlc[i]);
266 av_free(h[i].lengths);
267 av_free(h[i].values);
273 static int decode_header_trees(SmackVContext *smk) {
275 int mmap_size, mclr_size, full_size, type_size, ret;
278 mmap_size = AV_RL32(smk->avctx->extradata);
279 mclr_size = AV_RL32(smk->avctx->extradata + 4);
280 full_size = AV_RL32(smk->avctx->extradata + 8);
281 type_size = AV_RL32(smk->avctx->extradata + 12);
283 ret = init_get_bits8(&gb, smk->avctx->extradata + 16, smk->avctx->extradata_size - 16);
287 if(!get_bits1(&gb)) {
289 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
290 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
292 return AVERROR(ENOMEM);
293 smk->mmap_tbl[0] = 0;
294 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
296 ret = smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
300 if(!get_bits1(&gb)) {
302 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
303 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
305 return AVERROR(ENOMEM);
306 smk->mclr_tbl[0] = 0;
307 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
309 ret = smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
313 if(!get_bits1(&gb)) {
315 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
316 smk->full_tbl = av_malloc(sizeof(int) * 2);
318 return AVERROR(ENOMEM);
319 smk->full_tbl[0] = 0;
320 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
322 ret = smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
326 if(!get_bits1(&gb)) {
328 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
329 smk->type_tbl = av_malloc(sizeof(int) * 2);
331 return AVERROR(ENOMEM);
332 smk->type_tbl[0] = 0;
333 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
335 ret = smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
340 return AVERROR_INVALIDDATA;
345 static av_always_inline void last_reset(int *recode, int *last) {
346 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
349 /* get code and update history */
350 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
351 register int *table = recode;
354 while(*table & SMK_NODE) {
355 if (get_bits_left(gb) < 1)
356 return AVERROR_INVALIDDATA;
358 table += (*table) & (~SMK_NODE);
363 if(v != recode[last[0]]) {
364 recode[last[2]] = recode[last[1]];
365 recode[last[1]] = recode[last[0]];
371 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
374 SmackVContext * const smk = avctx->priv_data;
379 int blocks, blk, bw, bh;
384 if (avpkt->size <= 769)
385 return AVERROR_INVALIDDATA;
387 if ((ret = ff_reget_buffer(avctx, smk->pic, 0)) < 0)
390 /* make the palette available on the way out */
391 pal = (uint32_t*)smk->pic->data[1];
392 bytestream2_init(&gb2, avpkt->data, avpkt->size);
393 flags = bytestream2_get_byteu(&gb2);
394 smk->pic->palette_has_changed = flags & 1;
395 smk->pic->key_frame = !!(flags & 2);
396 if (smk->pic->key_frame)
397 smk->pic->pict_type = AV_PICTURE_TYPE_I;
399 smk->pic->pict_type = AV_PICTURE_TYPE_P;
401 for(i = 0; i < 256; i++)
402 *pal++ = 0xFFU << 24 | bytestream2_get_be24u(&gb2);
404 last_reset(smk->mmap_tbl, smk->mmap_last);
405 last_reset(smk->mclr_tbl, smk->mclr_last);
406 last_reset(smk->full_tbl, smk->full_last);
407 last_reset(smk->type_tbl, smk->type_last);
408 if ((ret = init_get_bits8(&gb, avpkt->data + 769, avpkt->size - 769)) < 0)
412 bw = avctx->width >> 2;
413 bh = avctx->height >> 2;
415 stride = smk->pic->linesize[0];
416 while(blk < blocks) {
420 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
423 run = block_runs[(type >> 2) & 0x3F];
426 while(run-- && blk < blocks){
429 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
430 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
431 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
434 for(i = 0; i < 4; i++) {
435 if(map & 1) out[0] = hi; else out[0] = lo;
436 if(map & 2) out[1] = hi; else out[1] = lo;
437 if(map & 4) out[2] = hi; else out[2] = lo;
438 if(map & 8) out[3] = hi; else out[3] = lo;
447 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
448 if(get_bits1(&gb)) mode = 1;
449 else if(get_bits1(&gb)) mode = 2;
451 while(run-- && blk < blocks){
452 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
455 for(i = 0; i < 4; i++) {
456 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
458 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
464 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
465 out[0] = out[1] = pix & 0xFF;
466 out[2] = out[3] = pix >> 8;
468 out[0] = out[1] = pix & 0xFF;
469 out[2] = out[3] = pix >> 8;
471 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
472 out[0] = out[1] = pix & 0xFF;
473 out[2] = out[3] = pix >> 8;
475 out[0] = out[1] = pix & 0xFF;
476 out[2] = out[3] = pix >> 8;
479 for(i = 0; i < 2; i++) {
481 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
482 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
496 while(run-- && blk < blocks)
501 while(run-- && blk < blocks){
503 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
504 col = mode * 0x01010101U;
505 for(i = 0; i < 4; i++) {
506 *((uint32_t*)out) = col;
516 if ((ret = av_frame_ref(data, smk->pic)) < 0)
521 /* always report that the buffer was completely consumed */
526 static av_cold int decode_end(AVCodecContext *avctx)
528 SmackVContext * const smk = avctx->priv_data;
530 av_freep(&smk->mmap_tbl);
531 av_freep(&smk->mclr_tbl);
532 av_freep(&smk->full_tbl);
533 av_freep(&smk->type_tbl);
535 av_frame_free(&smk->pic);
541 static av_cold int decode_init(AVCodecContext *avctx)
543 SmackVContext * const c = avctx->priv_data;
548 avctx->pix_fmt = AV_PIX_FMT_PAL8;
550 c->pic = av_frame_alloc();
552 return AVERROR(ENOMEM);
554 /* decode huffman trees from extradata */
555 if(avctx->extradata_size < 16){
556 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
557 return AVERROR(EINVAL);
560 ret = decode_header_trees(c);
569 static av_cold int smka_decode_init(AVCodecContext *avctx)
571 if (avctx->channels < 1 || avctx->channels > 2) {
572 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
573 return AVERROR_INVALIDDATA;
575 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
576 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
582 * Decode Smacker audio data
584 static int smka_decode_frame(AVCodecContext *avctx, void *data,
585 int *got_frame_ptr, AVPacket *avpkt)
587 AVFrame *frame = data;
588 const uint8_t *buf = avpkt->data;
589 int buf_size = avpkt->size;
591 HuffContext h[4] = { { 0 } };
592 VLC vlc[4] = { { 0 } };
599 int pred[2] = {0, 0};
602 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
603 return AVERROR_INVALIDDATA;
606 unp_size = AV_RL32(buf);
608 if (unp_size > (1U<<24)) {
609 av_log(avctx, AV_LOG_ERROR, "packet is too big\n");
610 return AVERROR_INVALIDDATA;
613 if ((ret = init_get_bits8(&gb, buf + 4, buf_size - 4)) < 0)
617 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
621 stereo = get_bits1(&gb);
622 bits = get_bits1(&gb);
623 if (stereo ^ (avctx->channels != 1)) {
624 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
625 return AVERROR_INVALIDDATA;
627 if (bits == (avctx->sample_fmt == AV_SAMPLE_FMT_U8)) {
628 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
629 return AVERROR_INVALIDDATA;
632 /* get output buffer */
633 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
634 if (unp_size % (avctx->channels * (bits + 1))) {
635 av_log(avctx, AV_LOG_ERROR,
636 "The buffer does not contain an integer number of samples\n");
637 return AVERROR_INVALIDDATA;
639 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
641 samples = (int16_t *)frame->data[0];
642 samples8 = frame->data[0];
645 for(i = 0; i < (1 << (bits + stereo)); i++) {
648 h[i].bits = av_mallocz(256 * 4);
649 h[i].lengths = av_mallocz(256 * sizeof(int));
650 h[i].values = av_mallocz(256 * sizeof(int));
651 if (!h[i].bits || !h[i].lengths || !h[i].values) {
652 ret = AVERROR(ENOMEM);
656 if ((ret = smacker_decode_tree(&gb, &h[i], 0, 0)) < 0)
659 if(h[i].current > 1) {
660 ret = init_vlc(&vlc[i], SMKTREE_BITS, h[i].current,
661 h[i].lengths, sizeof(int), sizeof(int),
662 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
664 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
669 /* this codec relies on wraparound instead of clipping audio */
670 if(bits) { //decode 16-bit data
671 for(i = stereo; i >= 0; i--)
672 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
673 for(i = 0; i <= stereo; i++)
674 *samples++ = pred[i];
675 for(; i < unp_size / 2; i++) {
676 if (get_bits_left(&gb) < 0) {
677 ret = AVERROR_INVALIDDATA;
682 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
686 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
687 ret = AVERROR_INVALIDDATA;
690 val = h[2].values[res];
692 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
696 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
697 ret = AVERROR_INVALIDDATA;
700 val |= h[3].values[res] << 8;
701 pred[1] += (unsigned)sign_extend(val, 16);
702 *samples++ = pred[1];
705 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
709 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
710 ret = AVERROR_INVALIDDATA;
713 val = h[0].values[res];
715 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
719 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
720 ret = AVERROR_INVALIDDATA;
723 val |= h[1].values[res] << 8;
724 pred[0] += (unsigned)sign_extend(val, 16);
725 *samples++ = pred[0];
728 } else { //8-bit data
729 for(i = stereo; i >= 0; i--)
730 pred[i] = get_bits(&gb, 8);
731 for(i = 0; i <= stereo; i++)
732 *samples8++ = pred[i];
733 for(; i < unp_size; i++) {
734 if (get_bits_left(&gb) < 0) {
735 ret = AVERROR_INVALIDDATA;
740 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
744 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
745 ret = AVERROR_INVALIDDATA;
748 pred[1] += sign_extend(h[1].values[res], 8);
749 *samples8++ = pred[1];
752 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
756 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
757 ret = AVERROR_INVALIDDATA;
760 pred[0] += sign_extend(h[0].values[res], 8);
761 *samples8++ = pred[0];
770 for(i = 0; i < 4; i++) {
772 ff_free_vlc(&vlc[i]);
774 av_free(h[i].lengths);
775 av_free(h[i].values);
781 AVCodec ff_smacker_decoder = {
783 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
784 .type = AVMEDIA_TYPE_VIDEO,
785 .id = AV_CODEC_ID_SMACKVIDEO,
786 .priv_data_size = sizeof(SmackVContext),
789 .decode = decode_frame,
790 .capabilities = AV_CODEC_CAP_DR1,
791 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
794 AVCodec ff_smackaud_decoder = {
796 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
797 .type = AVMEDIA_TYPE_AUDIO,
798 .id = AV_CODEC_ID_SMACKAUDIO,
799 .init = smka_decode_init,
800 .decode = smka_decode_frame,
801 .capabilities = AV_CODEC_CAP_DR1,