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"
39 #define BITSTREAM_READER_LE
41 #include "bytestream.h"
43 #define SMKTREE_BITS 9
44 #define SMK_NODE 0x80000000
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 {
69 /* common parameters used for decode_bigtree */
70 typedef struct DBCtx {
72 int *recode1, *recode2;
78 /* possible runs of blocks */
79 static const int block_runs[64] = {
80 1, 2, 3, 4, 5, 6, 7, 8,
81 9, 10, 11, 12, 13, 14, 15, 16,
82 17, 18, 19, 20, 21, 22, 23, 24,
83 25, 26, 27, 28, 29, 30, 31, 32,
84 33, 34, 35, 36, 37, 38, 39, 40,
85 41, 42, 43, 44, 45, 46, 47, 48,
86 49, 50, 51, 52, 53, 54, 55, 56,
87 57, 58, 59, 128, 256, 512, 1024, 2048 };
96 * Decode local frame tree
98 static int smacker_decode_tree(GetBitContext *gb, HuffContext *hc, uint32_t prefix, int length)
100 if(length > 32 || length > 3*SMKTREE_BITS) {
101 av_log(NULL, AV_LOG_ERROR, "length too long\n");
102 return AVERROR_INVALIDDATA;
104 if(!get_bits1(gb)){ //Leaf
105 if(hc->current >= 256){
106 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
107 return AVERROR_INVALIDDATA;
110 hc->bits[hc->current] = prefix;
111 hc->lengths[hc->current] = length;
113 hc->bits[hc->current] = 0;
114 hc->lengths[hc->current] = 0;
116 hc->values[hc->current] = get_bits(gb, 8);
118 if(hc->maxlength < length)
119 hc->maxlength = length;
124 r = smacker_decode_tree(gb, hc, prefix, length);
127 return smacker_decode_tree(gb, hc, prefix | (1 << (length - 1)), length);
134 static int smacker_decode_bigtree(GetBitContext *gb, HuffContext *hc, DBCtx *ctx)
136 if (hc->current + 1 >= hc->length) {
137 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
138 return AVERROR_INVALIDDATA;
140 if(!get_bits1(gb)){ //Leaf
142 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
143 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
144 if (i1 < 0 || i2 < 0)
145 return AVERROR_INVALIDDATA;
146 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
147 if(val == ctx->escapes[0]) {
148 ctx->last[0] = hc->current;
150 } else if(val == ctx->escapes[1]) {
151 ctx->last[1] = hc->current;
153 } else if(val == ctx->escapes[2]) {
154 ctx->last[2] = hc->current;
158 hc->values[hc->current++] = val;
164 r = smacker_decode_bigtree(gb, hc, ctx);
167 hc->values[t] = SMK_NODE | r;
169 r_new = smacker_decode_bigtree(gb, hc, ctx);
177 * Store large tree as FFmpeg's vlc codes
179 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
183 HuffContext tmp1, tmp2;
184 VLC vlc[2] = { { 0 } };
189 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
190 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
191 return AVERROR_INVALIDDATA;
197 tmp1.bits = av_mallocz(256 * 4);
198 tmp1.lengths = av_mallocz(256 * sizeof(int));
199 tmp1.values = av_mallocz(256 * sizeof(int));
204 tmp2.bits = av_mallocz(256 * 4);
205 tmp2.lengths = av_mallocz(256 * sizeof(int));
206 tmp2.values = av_mallocz(256 * sizeof(int));
209 res = smacker_decode_tree(gb, &tmp1, 0, 0);
213 if(tmp1.current > 1) {
214 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
215 tmp1.lengths, sizeof(int), sizeof(int),
216 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
218 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
219 return AVERROR_INVALIDDATA;
224 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
227 res = smacker_decode_tree(gb, &tmp2, 0, 0);
231 if(tmp2.current > 1) {
232 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
233 tmp2.lengths, sizeof(int), sizeof(int),
234 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
236 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
237 return AVERROR_INVALIDDATA;
242 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
245 escapes[0] = get_bits(gb, 16);
246 escapes[1] = get_bits(gb, 16);
247 escapes[2] = get_bits(gb, 16);
249 last[0] = last[1] = last[2] = -1;
251 ctx.escapes[0] = escapes[0];
252 ctx.escapes[1] = escapes[1];
253 ctx.escapes[2] = escapes[2];
256 ctx.recode1 = tmp1.values;
257 ctx.recode2 = tmp2.values;
260 huff.length = ((size + 3) >> 2) + 4;
263 huff.values = av_mallocz(huff.length * sizeof(int));
265 return AVERROR(ENOMEM);
267 if (smacker_decode_bigtree(gb, &huff, &ctx) < 0)
270 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
271 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
272 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
273 if(huff.current > huff.length){
274 ctx.last[0] = ctx.last[1] = ctx.last[2] = 1;
275 av_log(smk->avctx, AV_LOG_ERROR, "bigtree damaged\n");
276 return AVERROR_INVALIDDATA;
279 *recodes = huff.values;
282 ff_free_vlc(&vlc[0]);
284 ff_free_vlc(&vlc[1]);
286 av_free(tmp1.lengths);
287 av_free(tmp1.values);
289 av_free(tmp2.lengths);
290 av_free(tmp2.values);
295 static int decode_header_trees(SmackVContext *smk) {
297 int mmap_size, mclr_size, full_size, type_size, ret;
299 mmap_size = AV_RL32(smk->avctx->extradata);
300 mclr_size = AV_RL32(smk->avctx->extradata + 4);
301 full_size = AV_RL32(smk->avctx->extradata + 8);
302 type_size = AV_RL32(smk->avctx->extradata + 12);
304 init_get_bits(&gb, smk->avctx->extradata + 16, (smk->avctx->extradata_size - 16) * 8);
306 if(!get_bits1(&gb)) {
307 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
308 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
309 smk->mmap_tbl[0] = 0;
310 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
312 ret = smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
316 if(!get_bits1(&gb)) {
317 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
318 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
319 smk->mclr_tbl[0] = 0;
320 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
322 ret = smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
326 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);
329 smk->full_tbl[0] = 0;
330 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
332 ret = smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
336 if(!get_bits1(&gb)) {
337 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
338 smk->type_tbl = av_malloc(sizeof(int) * 2);
339 smk->type_tbl[0] = 0;
340 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
342 ret = smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
350 static av_always_inline void last_reset(int *recode, int *last) {
351 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
354 /* get code and update history */
355 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
356 register int *table = recode;
359 while(*table & SMK_NODE) {
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)
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 init_get_bits(&gb, avpkt->data + 769, (avpkt->size - 769) * 8);
414 bw = avctx->width >> 2;
415 bh = avctx->height >> 2;
417 out = smk->pic->data[0];
418 stride = smk->pic->linesize[0];
419 while(blk < blocks) {
423 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
424 run = block_runs[(type >> 2) & 0x3F];
427 while(run-- && blk < blocks){
430 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
431 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
432 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
435 for(i = 0; i < 4; i++) {
436 if(map & 1) out[0] = hi; else out[0] = lo;
437 if(map & 2) out[1] = hi; else out[1] = lo;
438 if(map & 4) out[2] = hi; else out[2] = lo;
439 if(map & 8) out[3] = hi; else out[3] = lo;
448 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
449 if(get_bits1(&gb)) mode = 1;
450 else if(get_bits1(&gb)) mode = 2;
452 while(run-- && blk < blocks){
453 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
456 for(i = 0; i < 4; i++) {
457 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
459 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
465 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
466 out[0] = out[1] = pix & 0xFF;
467 out[2] = out[3] = pix >> 8;
469 out[0] = out[1] = pix & 0xFF;
470 out[2] = out[3] = pix >> 8;
472 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
473 out[0] = out[1] = pix & 0xFF;
474 out[2] = out[3] = pix >> 8;
476 out[0] = out[1] = pix & 0xFF;
477 out[2] = out[3] = pix >> 8;
481 for(i = 0; i < 2; i++) {
483 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
484 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
498 while(run-- && blk < blocks)
503 while(run-- && blk < blocks){
505 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
506 col = mode * 0x01010101;
507 for(i = 0; i < 4; i++) {
508 *((uint32_t*)out) = col;
518 if ((ret = av_frame_ref(data, smk->pic)) < 0)
523 /* always report that the buffer was completely consumed */
531 * Init smacker decoder
534 static av_cold int decode_init(AVCodecContext *avctx)
536 SmackVContext * const c = avctx->priv_data;
541 avctx->pix_fmt = AV_PIX_FMT_PAL8;
543 /* decode huffman trees from extradata */
544 if(avctx->extradata_size < 16){
545 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
546 return AVERROR(EINVAL);
549 ret = decode_header_trees(c);
553 c->pic = av_frame_alloc();
555 return AVERROR(ENOMEM);
564 * Uninit smacker decoder
567 static av_cold int decode_end(AVCodecContext *avctx)
569 SmackVContext * const smk = avctx->priv_data;
571 av_freep(&smk->mmap_tbl);
572 av_freep(&smk->mclr_tbl);
573 av_freep(&smk->full_tbl);
574 av_freep(&smk->type_tbl);
576 av_frame_free(&smk->pic);
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(EINVAL);
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(EINVAL);
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 init_get_bits(&gb, buf + 4, (buf_size - 4) * 8);
629 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
633 stereo = get_bits1(&gb);
634 bits = get_bits1(&gb);
635 if (stereo ^ (avctx->channels != 1)) {
636 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
637 return AVERROR(EINVAL);
639 if (bits && avctx->sample_fmt == AV_SAMPLE_FMT_U8) {
640 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
641 return AVERROR(EINVAL);
644 /* get output buffer */
645 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
646 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
648 samples = (int16_t *)frame->data[0];
649 samples8 = frame->data[0];
652 for(i = 0; i < (1 << (bits + stereo)); i++) {
656 h[i].bits = av_mallocz(256 * 4);
657 h[i].lengths = av_mallocz(256 * sizeof(int));
658 h[i].values = av_mallocz(256 * sizeof(int));
660 if (smacker_decode_tree(&gb, &h[i], 0, 0) < 0) {
661 for (; i >= 0; i--) {
663 ff_free_vlc(&vlc[i]);
665 av_free(h[i].lengths);
666 av_free(h[i].values);
668 return AVERROR_INVALIDDATA;
671 if(h[i].current > 1) {
672 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
673 h[i].lengths, sizeof(int), sizeof(int),
674 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
676 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
677 return AVERROR_INVALIDDATA;
681 /* this codec relies on wraparound instead of clipping audio */
682 if(bits) { //decode 16-bit data
683 for(i = stereo; i >= 0; i--)
684 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
685 for(i = 0; i <= stereo; i++)
686 *samples++ = pred[i];
687 for(; i < unp_size / 2; i++) {
688 if(get_bits_left(&gb)<0)
689 return AVERROR_INVALIDDATA;
692 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
696 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
697 return AVERROR_INVALIDDATA;
699 val = h[2].values[res];
701 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
705 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
706 return AVERROR_INVALIDDATA;
708 val |= h[3].values[res] << 8;
709 pred[1] += sign_extend(val, 16);
710 *samples++ = pred[1];
713 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
717 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
718 return AVERROR_INVALIDDATA;
720 val = h[0].values[res];
722 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
726 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
727 return AVERROR_INVALIDDATA;
729 val |= h[1].values[res] << 8;
730 pred[0] += sign_extend(val, 16);
731 *samples++ = pred[0];
734 } else { //8-bit data
735 for(i = stereo; i >= 0; i--)
736 pred[i] = get_bits(&gb, 8);
737 for(i = 0; i <= stereo; i++)
738 *samples8++ = pred[i];
739 for(; i < unp_size; i++) {
740 if(get_bits_left(&gb)<0)
741 return AVERROR_INVALIDDATA;
744 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
748 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
749 return AVERROR_INVALIDDATA;
751 pred[1] += sign_extend(h[1].values[res], 8);
752 *samples8++ = pred[1];
755 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
759 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
760 return AVERROR_INVALIDDATA;
762 pred[0] += sign_extend(h[0].values[res], 8);
763 *samples8++ = pred[0];
768 for(i = 0; i < 4; i++) {
770 ff_free_vlc(&vlc[i]);
772 av_free(h[i].lengths);
773 av_free(h[i].values);
781 AVCodec ff_smacker_decoder = {
783 .type = AVMEDIA_TYPE_VIDEO,
784 .id = AV_CODEC_ID_SMACKVIDEO,
785 .priv_data_size = sizeof(SmackVContext),
788 .decode = decode_frame,
789 .capabilities = CODEC_CAP_DR1,
790 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
793 AVCodec ff_smackaud_decoder = {
795 .type = AVMEDIA_TYPE_AUDIO,
796 .id = AV_CODEC_ID_SMACKAUDIO,
797 .init = smka_decode_init,
798 .decode = smka_decode_frame,
799 .capabilities = CODEC_CAP_DR1,
800 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),