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 | (1 << (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 + 1 >= 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)
187 HuffContext tmp1, tmp2;
188 VLC vlc[2] = { { 0 } };
193 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
194 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
195 return AVERROR_INVALIDDATA;
200 tmp1.bits = av_mallocz(256 * 4);
201 tmp1.lengths = av_mallocz(256 * sizeof(int));
202 tmp1.values = av_mallocz(256 * sizeof(int));
206 tmp2.bits = av_mallocz(256 * 4);
207 tmp2.lengths = av_mallocz(256 * sizeof(int));
208 tmp2.values = av_mallocz(256 * sizeof(int));
209 if (!tmp1.bits || !tmp1.lengths || !tmp1.values ||
210 !tmp2.bits || !tmp2.lengths || !tmp2.values) {
211 err = AVERROR(ENOMEM);
216 res = smacker_decode_tree(gb, &tmp1, 0, 0);
222 if(tmp1.current > 1) {
223 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
224 tmp1.lengths, sizeof(int), sizeof(int),
225 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
227 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
234 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
237 res = smacker_decode_tree(gb, &tmp2, 0, 0);
243 if(tmp2.current > 1) {
244 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
245 tmp2.lengths, sizeof(int), sizeof(int),
246 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
248 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
255 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
258 escapes[0] = get_bits(gb, 16);
259 escapes[1] = get_bits(gb, 16);
260 escapes[2] = get_bits(gb, 16);
262 last[0] = last[1] = last[2] = -1;
264 ctx.escapes[0] = escapes[0];
265 ctx.escapes[1] = escapes[1];
266 ctx.escapes[2] = escapes[2];
269 ctx.recode1 = tmp1.values;
270 ctx.recode2 = tmp2.values;
273 huff.length = ((size + 3) >> 2) + 4;
275 huff.values = av_mallocz_array(huff.length, sizeof(int));
277 err = AVERROR(ENOMEM);
281 res = smacker_decode_bigtree(gb, &huff, &ctx, 0);
285 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
286 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
287 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
288 if (ctx.last[0] >= huff.length ||
289 ctx.last[1] >= huff.length ||
290 ctx.last[2] >= huff.length) {
291 av_log(smk->avctx, AV_LOG_ERROR, "Huffman codes out of range\n");
292 err = AVERROR_INVALIDDATA;
295 *recodes = huff.values;
299 ff_free_vlc(&vlc[0]);
301 ff_free_vlc(&vlc[1]);
303 av_free(tmp1.lengths);
304 av_free(tmp1.values);
306 av_free(tmp2.lengths);
307 av_free(tmp2.values);
312 static int decode_header_trees(SmackVContext *smk) {
314 int mmap_size, mclr_size, full_size, type_size, ret;
317 mmap_size = AV_RL32(smk->avctx->extradata);
318 mclr_size = AV_RL32(smk->avctx->extradata + 4);
319 full_size = AV_RL32(smk->avctx->extradata + 8);
320 type_size = AV_RL32(smk->avctx->extradata + 12);
322 ret = init_get_bits8(&gb, smk->avctx->extradata + 16, smk->avctx->extradata_size - 16);
326 if(!get_bits1(&gb)) {
328 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
329 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
331 return AVERROR(ENOMEM);
332 smk->mmap_tbl[0] = 0;
333 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
335 ret = smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
339 if(!get_bits1(&gb)) {
341 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
342 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
344 return AVERROR(ENOMEM);
345 smk->mclr_tbl[0] = 0;
346 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
348 ret = smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
352 if(!get_bits1(&gb)) {
354 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
355 smk->full_tbl = av_malloc(sizeof(int) * 2);
357 return AVERROR(ENOMEM);
358 smk->full_tbl[0] = 0;
359 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
361 ret = smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
365 if(!get_bits1(&gb)) {
367 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
368 smk->type_tbl = av_malloc(sizeof(int) * 2);
370 return AVERROR(ENOMEM);
371 smk->type_tbl[0] = 0;
372 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
374 ret = smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
379 return AVERROR_INVALIDDATA;
384 static av_always_inline void last_reset(int *recode, int *last) {
385 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
388 /* get code and update history */
389 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
390 register int *table = recode;
393 while(*table & SMK_NODE) {
394 if (get_bits_left(gb) < 1)
395 return AVERROR_INVALIDDATA;
397 table += (*table) & (~SMK_NODE);
402 if(v != recode[last[0]]) {
403 recode[last[2]] = recode[last[1]];
404 recode[last[1]] = recode[last[0]];
410 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
413 SmackVContext * const smk = avctx->priv_data;
418 int blocks, blk, bw, bh;
423 if (avpkt->size <= 769)
424 return AVERROR_INVALIDDATA;
426 if ((ret = ff_reget_buffer(avctx, smk->pic, 0)) < 0)
429 /* make the palette available on the way out */
430 pal = (uint32_t*)smk->pic->data[1];
431 bytestream2_init(&gb2, avpkt->data, avpkt->size);
432 flags = bytestream2_get_byteu(&gb2);
433 smk->pic->palette_has_changed = flags & 1;
434 smk->pic->key_frame = !!(flags & 2);
435 if (smk->pic->key_frame)
436 smk->pic->pict_type = AV_PICTURE_TYPE_I;
438 smk->pic->pict_type = AV_PICTURE_TYPE_P;
440 for(i = 0; i < 256; i++)
441 *pal++ = 0xFFU << 24 | bytestream2_get_be24u(&gb2);
443 last_reset(smk->mmap_tbl, smk->mmap_last);
444 last_reset(smk->mclr_tbl, smk->mclr_last);
445 last_reset(smk->full_tbl, smk->full_last);
446 last_reset(smk->type_tbl, smk->type_last);
447 if ((ret = init_get_bits8(&gb, avpkt->data + 769, avpkt->size - 769)) < 0)
451 bw = avctx->width >> 2;
452 bh = avctx->height >> 2;
454 stride = smk->pic->linesize[0];
455 while(blk < blocks) {
459 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
462 run = block_runs[(type >> 2) & 0x3F];
465 while(run-- && blk < blocks){
468 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
469 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
470 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
473 for(i = 0; i < 4; i++) {
474 if(map & 1) out[0] = hi; else out[0] = lo;
475 if(map & 2) out[1] = hi; else out[1] = lo;
476 if(map & 4) out[2] = hi; else out[2] = lo;
477 if(map & 8) out[3] = hi; else out[3] = lo;
486 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
487 if(get_bits1(&gb)) mode = 1;
488 else if(get_bits1(&gb)) mode = 2;
490 while(run-- && blk < blocks){
491 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
494 for(i = 0; i < 4; i++) {
495 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
497 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
503 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
504 out[0] = out[1] = pix & 0xFF;
505 out[2] = out[3] = pix >> 8;
507 out[0] = out[1] = pix & 0xFF;
508 out[2] = out[3] = pix >> 8;
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;
518 for(i = 0; i < 2; i++) {
520 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
521 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
535 while(run-- && blk < blocks)
540 while(run-- && blk < blocks){
542 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
543 col = mode * 0x01010101U;
544 for(i = 0; i < 4; i++) {
545 *((uint32_t*)out) = col;
555 if ((ret = av_frame_ref(data, smk->pic)) < 0)
560 /* always report that the buffer was completely consumed */
565 static av_cold int decode_end(AVCodecContext *avctx)
567 SmackVContext * const smk = avctx->priv_data;
569 av_freep(&smk->mmap_tbl);
570 av_freep(&smk->mclr_tbl);
571 av_freep(&smk->full_tbl);
572 av_freep(&smk->type_tbl);
574 av_frame_free(&smk->pic);
580 static av_cold int decode_init(AVCodecContext *avctx)
582 SmackVContext * const c = avctx->priv_data;
587 avctx->pix_fmt = AV_PIX_FMT_PAL8;
589 c->pic = av_frame_alloc();
591 return AVERROR(ENOMEM);
593 /* decode huffman trees from extradata */
594 if(avctx->extradata_size < 16){
595 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
596 return AVERROR(EINVAL);
599 ret = decode_header_trees(c);
608 static av_cold int smka_decode_init(AVCodecContext *avctx)
610 if (avctx->channels < 1 || avctx->channels > 2) {
611 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
612 return AVERROR_INVALIDDATA;
614 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
615 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
621 * Decode Smacker audio data
623 static int smka_decode_frame(AVCodecContext *avctx, void *data,
624 int *got_frame_ptr, AVPacket *avpkt)
626 AVFrame *frame = data;
627 const uint8_t *buf = avpkt->data;
628 int buf_size = avpkt->size;
630 HuffContext h[4] = { { 0 } };
631 VLC vlc[4] = { { 0 } };
638 int pred[2] = {0, 0};
641 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
642 return AVERROR_INVALIDDATA;
645 unp_size = AV_RL32(buf);
647 if (unp_size > (1U<<24)) {
648 av_log(avctx, AV_LOG_ERROR, "packet is too big\n");
649 return AVERROR_INVALIDDATA;
652 if ((ret = init_get_bits8(&gb, buf + 4, buf_size - 4)) < 0)
656 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
660 stereo = get_bits1(&gb);
661 bits = get_bits1(&gb);
662 if (stereo ^ (avctx->channels != 1)) {
663 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
664 return AVERROR_INVALIDDATA;
666 if (bits == (avctx->sample_fmt == AV_SAMPLE_FMT_U8)) {
667 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
668 return AVERROR_INVALIDDATA;
671 /* get output buffer */
672 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
673 if (unp_size % (avctx->channels * (bits + 1))) {
674 av_log(avctx, AV_LOG_ERROR,
675 "The buffer does not contain an integer number of samples\n");
676 return AVERROR_INVALIDDATA;
678 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
680 samples = (int16_t *)frame->data[0];
681 samples8 = frame->data[0];
684 for(i = 0; i < (1 << (bits + stereo)); i++) {
687 h[i].bits = av_mallocz(256 * 4);
688 h[i].lengths = av_mallocz(256 * sizeof(int));
689 h[i].values = av_mallocz(256 * sizeof(int));
690 if (!h[i].bits || !h[i].lengths || !h[i].values) {
691 ret = AVERROR(ENOMEM);
695 if (smacker_decode_tree(&gb, &h[i], 0, 0) < 0) {
696 ret = AVERROR_INVALIDDATA;
700 if(h[i].current > 1) {
701 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
702 h[i].lengths, sizeof(int), sizeof(int),
703 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
705 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
706 ret = AVERROR_INVALIDDATA;
711 /* this codec relies on wraparound instead of clipping audio */
712 if(bits) { //decode 16-bit data
713 for(i = stereo; i >= 0; i--)
714 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
715 for(i = 0; i <= stereo; i++)
716 *samples++ = pred[i];
717 for(; i < unp_size / 2; i++) {
718 if (get_bits_left(&gb) < 0) {
719 ret = AVERROR_INVALIDDATA;
724 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
728 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
729 ret = AVERROR_INVALIDDATA;
732 val = h[2].values[res];
734 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
738 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
739 ret = AVERROR_INVALIDDATA;
742 val |= h[3].values[res] << 8;
743 pred[1] += (unsigned)sign_extend(val, 16);
744 *samples++ = pred[1];
747 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
751 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
752 ret = AVERROR_INVALIDDATA;
755 val = h[0].values[res];
757 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
761 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
762 ret = AVERROR_INVALIDDATA;
765 val |= h[1].values[res] << 8;
766 pred[0] += (unsigned)sign_extend(val, 16);
767 *samples++ = pred[0];
770 } else { //8-bit data
771 for(i = stereo; i >= 0; i--)
772 pred[i] = get_bits(&gb, 8);
773 for(i = 0; i <= stereo; i++)
774 *samples8++ = pred[i];
775 for(; i < unp_size; i++) {
776 if (get_bits_left(&gb) < 0) {
777 ret = AVERROR_INVALIDDATA;
782 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
786 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
787 ret = AVERROR_INVALIDDATA;
790 pred[1] += sign_extend(h[1].values[res], 8);
791 *samples8++ = pred[1];
794 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
798 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
799 ret = AVERROR_INVALIDDATA;
802 pred[0] += sign_extend(h[0].values[res], 8);
803 *samples8++ = pred[0];
812 for(i = 0; i < 4; i++) {
814 ff_free_vlc(&vlc[i]);
816 av_free(h[i].lengths);
817 av_free(h[i].values);
823 AVCodec ff_smacker_decoder = {
825 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
826 .type = AVMEDIA_TYPE_VIDEO,
827 .id = AV_CODEC_ID_SMACKVIDEO,
828 .priv_data_size = sizeof(SmackVContext),
831 .decode = decode_frame,
832 .capabilities = AV_CODEC_CAP_DR1,
833 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
836 AVCodec ff_smackaud_decoder = {
838 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
839 .type = AVMEDIA_TYPE_AUDIO,
840 .id = AV_CODEC_ID_SMACKAUDIO,
841 .init = smka_decode_init,
842 .decode = smka_decode_frame,
843 .capabilities = AV_CODEC_CAP_DR1,