3 * Copyright (c) 2006 Konstantin Shishkov
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; 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 "bitstream.h"
39 #include "bytestream.h"
44 #define SMKTREE_BITS 9
45 #define SMK_NODE 0x80000000
46 #define SMKTREE_DECODE_MAX_RECURSION 32
48 typedef struct SmackVContext {
49 AVCodecContext *avctx;
52 int *mmap_tbl, *mclr_tbl, *full_tbl, *type_tbl;
53 int mmap_last[3], mclr_last[3], full_last[3], type_last[3];
57 * Context used for code reconstructing
59 typedef struct HuffContext {
68 /* common parameters used for decode_bigtree */
69 typedef struct DBCtx {
71 int *recode1, *recode2;
77 /* possible runs of blocks */
78 static const int block_runs[64] = {
79 1, 2, 3, 4, 5, 6, 7, 8,
80 9, 10, 11, 12, 13, 14, 15, 16,
81 17, 18, 19, 20, 21, 22, 23, 24,
82 25, 26, 27, 28, 29, 30, 31, 32,
83 33, 34, 35, 36, 37, 38, 39, 40,
84 41, 42, 43, 44, 45, 46, 47, 48,
85 49, 50, 51, 52, 53, 54, 55, 56,
86 57, 58, 59, 128, 256, 512, 1024, 2048 };
95 * Decode local frame tree
97 static int smacker_decode_tree(BitstreamContext *bc, HuffContext *hc,
98 uint32_t prefix, int length)
100 if (length > SMKTREE_DECODE_MAX_RECURSION) {
101 av_log(NULL, AV_LOG_ERROR, "Maximum tree recursion level exceeded.\n");
102 return AVERROR_INVALIDDATA;
105 if (!bitstream_read_bit(bc)) { // Leaf
106 if(hc->current >= 256){
107 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
108 return AVERROR_INVALIDDATA;
111 hc->bits[hc->current] = prefix;
112 hc->lengths[hc->current] = length;
114 hc->bits[hc->current] = 0;
115 hc->lengths[hc->current] = 0;
117 hc->values[hc->current] = bitstream_read(bc, 8);
119 if(hc->maxlength < length)
120 hc->maxlength = length;
125 r = smacker_decode_tree(bc, hc, prefix, length);
128 return smacker_decode_tree(bc, hc, prefix | (1 << (length - 1)), length);
135 static int smacker_decode_bigtree(BitstreamContext *bc, HuffContext *hc,
138 if (hc->current + 1 >= hc->length) {
139 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
140 return AVERROR_INVALIDDATA;
142 if (!bitstream_read_bit(bc)) { // Leaf
144 i1 = ctx->v1->table ? bitstream_read_vlc(bc, ctx->v1->table, SMKTREE_BITS, 3) : 0;
145 i2 = ctx->v2->table ? bitstream_read_vlc(bc, ctx->v2->table, SMKTREE_BITS, 3) : 0;
146 if (i1 < 0 || i2 < 0)
147 return AVERROR_INVALIDDATA;
148 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
149 if(val == ctx->escapes[0]) {
150 ctx->last[0] = hc->current;
152 } else if(val == ctx->escapes[1]) {
153 ctx->last[1] = hc->current;
155 } else if(val == ctx->escapes[2]) {
156 ctx->last[2] = hc->current;
160 hc->values[hc->current++] = val;
166 r = smacker_decode_bigtree(bc, hc, ctx);
169 hc->values[t] = SMK_NODE | r;
171 r_new = smacker_decode_bigtree(bc, hc, ctx);
179 * Store large tree as Libav's vlc codes
181 static int smacker_decode_header_tree(SmackVContext *smk, BitstreamContext *bc,
182 int **recodes, int *last, int size)
186 HuffContext tmp1, tmp2;
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;
200 tmp1.bits = av_mallocz(256 * 4);
201 tmp1.lengths = av_mallocz(256 * sizeof(int));
202 tmp1.values = av_mallocz(256 * sizeof(int));
207 tmp2.bits = av_mallocz(256 * 4);
208 tmp2.lengths = av_mallocz(256 * sizeof(int));
209 tmp2.values = av_mallocz(256 * sizeof(int));
210 if (!tmp1.bits || !tmp1.lengths || !tmp1.values ||
211 !tmp2.bits || !tmp2.lengths || !tmp2.values) {
212 err = AVERROR(ENOMEM);
216 if (bitstream_read_bit(bc)) {
217 smacker_decode_tree(bc, &tmp1, 0, 0);
218 bitstream_skip(bc, 1);
219 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
220 tmp1.lengths, sizeof(int), sizeof(int),
221 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
223 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
228 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
230 if (bitstream_read_bit(bc)) {
231 smacker_decode_tree(bc, &tmp2, 0, 0);
232 bitstream_skip(bc, 1);
233 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
234 tmp2.lengths, sizeof(int), sizeof(int),
235 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
237 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
242 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
245 escapes[0] = bitstream_read(bc, 8);
246 escapes[0] |= bitstream_read(bc, 8) << 8;
247 escapes[1] = bitstream_read(bc, 8);
248 escapes[1] |= bitstream_read(bc, 8) << 8;
249 escapes[2] = bitstream_read(bc, 8);
250 escapes[2] |= bitstream_read(bc, 8) << 8;
252 last[0] = last[1] = last[2] = -1;
254 ctx.escapes[0] = escapes[0];
255 ctx.escapes[1] = escapes[1];
256 ctx.escapes[2] = escapes[2];
259 ctx.recode1 = tmp1.values;
260 ctx.recode2 = tmp2.values;
263 huff.length = ((size + 3) >> 2) + 4;
266 huff.values = av_mallocz(huff.length * sizeof(int));
268 err = AVERROR(ENOMEM);
272 if ((res = smacker_decode_bigtree(bc, &huff, &ctx)) < 0)
274 bitstream_skip(bc, 1);
275 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
276 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
277 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
278 if (ctx.last[0] >= huff.length ||
279 ctx.last[1] >= huff.length ||
280 ctx.last[2] >= huff.length) {
281 av_log(smk->avctx, AV_LOG_ERROR, "Huffman codes out of range\n");
282 err = AVERROR_INVALIDDATA;
285 *recodes = huff.values;
289 ff_free_vlc(&vlc[0]);
291 ff_free_vlc(&vlc[1]);
293 av_free(tmp1.lengths);
294 av_free(tmp1.values);
296 av_free(tmp2.lengths);
297 av_free(tmp2.values);
302 static int decode_header_trees(SmackVContext *smk) {
304 int mmap_size, mclr_size, full_size, type_size, ret;
306 mmap_size = AV_RL32(smk->avctx->extradata);
307 mclr_size = AV_RL32(smk->avctx->extradata + 4);
308 full_size = AV_RL32(smk->avctx->extradata + 8);
309 type_size = AV_RL32(smk->avctx->extradata + 12);
311 bitstream_init8(&bc, smk->avctx->extradata + 16, smk->avctx->extradata_size - 16);
313 if (!bitstream_read_bit(&bc)) {
314 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
315 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
317 return AVERROR(ENOMEM);
318 smk->mmap_tbl[0] = 0;
319 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
321 if ((ret = smacker_decode_header_tree(smk, &bc, &smk->mmap_tbl, smk->mmap_last, mmap_size)) < 0)
324 if (!bitstream_read_bit(&bc)) {
325 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
326 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
328 return AVERROR(ENOMEM);
329 smk->mclr_tbl[0] = 0;
330 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
332 if ((ret = smacker_decode_header_tree(smk, &bc, &smk->mclr_tbl, smk->mclr_last, mclr_size)) < 0)
335 if (!bitstream_read_bit(&bc)) {
336 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
337 smk->full_tbl = av_malloc(sizeof(int) * 2);
339 return AVERROR(ENOMEM);
340 smk->full_tbl[0] = 0;
341 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
343 if ((ret = smacker_decode_header_tree(smk, &bc, &smk->full_tbl, smk->full_last, full_size)) < 0)
346 if (!bitstream_read_bit(&bc)) {
347 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
348 smk->type_tbl = av_malloc(sizeof(int) * 2);
350 return AVERROR(ENOMEM);
351 smk->type_tbl[0] = 0;
352 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
354 if ((ret = smacker_decode_header_tree(smk, &bc, &smk->type_tbl, smk->type_last, type_size)) < 0)
361 static av_always_inline void last_reset(int *recode, int *last) {
362 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
365 /* get code and update history */
366 static av_always_inline int smk_get_code(BitstreamContext *bc, int *recode,
369 register int *table = recode;
372 while(*table & SMK_NODE) {
373 if (bitstream_read_bit(bc))
374 table += (*table) & (~SMK_NODE);
379 if(v != recode[last[0]]) {
380 recode[last[2]] = recode[last[1]];
381 recode[last[1]] = recode[last[0]];
387 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
390 SmackVContext * const smk = avctx->priv_data;
395 int blocks, blk, bw, bh;
400 if (avpkt->size <= 769)
403 if ((ret = ff_reget_buffer(avctx, smk->pic)) < 0) {
404 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
408 /* make the palette available on the way out */
409 pal = (uint32_t*)smk->pic->data[1];
410 bytestream2_init(&gb2, avpkt->data, avpkt->size);
411 flags = bytestream2_get_byteu(&gb2);
412 smk->pic->palette_has_changed = flags & 1;
413 smk->pic->key_frame = !!(flags & 2);
414 if(smk->pic->key_frame)
415 smk->pic->pict_type = AV_PICTURE_TYPE_I;
417 smk->pic->pict_type = AV_PICTURE_TYPE_P;
419 for(i = 0; i < 256; i++)
420 *pal++ = bytestream2_get_be24u(&gb2);
422 last_reset(smk->mmap_tbl, smk->mmap_last);
423 last_reset(smk->mclr_tbl, smk->mclr_last);
424 last_reset(smk->full_tbl, smk->full_last);
425 last_reset(smk->type_tbl, smk->type_last);
426 bitstream_init8(&bc, avpkt->data + 769, avpkt->size - 769);
429 bw = avctx->width >> 2;
430 bh = avctx->height >> 2;
432 out = smk->pic->data[0];
433 stride = smk->pic->linesize[0];
434 while(blk < blocks) {
438 type = smk_get_code(&bc, smk->type_tbl, smk->type_last);
439 run = block_runs[(type >> 2) & 0x3F];
442 while(run-- && blk < blocks){
445 clr = smk_get_code(&bc, smk->mclr_tbl, smk->mclr_last);
446 map = smk_get_code(&bc, smk->mmap_tbl, smk->mmap_last);
447 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
450 for(i = 0; i < 4; i++) {
451 if(map & 1) out[0] = hi; else out[0] = lo;
452 if(map & 2) out[1] = hi; else out[1] = lo;
453 if(map & 4) out[2] = hi; else out[2] = lo;
454 if(map & 8) out[3] = hi; else out[3] = lo;
463 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
464 if (bitstream_read_bit(&bc))
466 else if (bitstream_read_bit(&bc))
469 while(run-- && blk < blocks){
470 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
473 for(i = 0; i < 4; i++) {
474 pix = smk_get_code(&bc, smk->full_tbl, smk->full_last);
476 pix = smk_get_code(&bc, smk->full_tbl, smk->full_last);
482 pix = smk_get_code(&bc, smk->full_tbl, smk->full_last);
483 out[0] = out[1] = pix & 0xFF;
484 out[2] = out[3] = pix >> 8;
486 out[0] = out[1] = pix & 0xFF;
487 out[2] = out[3] = pix >> 8;
489 pix = smk_get_code(&bc, smk->full_tbl, smk->full_last);
490 out[0] = out[1] = pix & 0xFF;
491 out[2] = out[3] = pix >> 8;
493 out[0] = out[1] = pix & 0xFF;
494 out[2] = out[3] = pix >> 8;
498 for(i = 0; i < 2; i++) {
500 pix2 = smk_get_code(&bc, smk->full_tbl, smk->full_last);
501 pix1 = smk_get_code(&bc, smk->full_tbl, smk->full_last);
515 while(run-- && blk < blocks)
520 while(run-- && blk < blocks){
522 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
523 col = mode * 0x01010101;
524 for(i = 0; i < 4; i++) {
525 *((uint32_t*)out) = col;
535 if ((ret = av_frame_ref(data, smk->pic)) < 0)
540 /* always report that the buffer was completely consumed */
545 static av_cold int decode_end(AVCodecContext *avctx)
547 SmackVContext * const smk = avctx->priv_data;
549 av_freep(&smk->mmap_tbl);
550 av_freep(&smk->mclr_tbl);
551 av_freep(&smk->full_tbl);
552 av_freep(&smk->type_tbl);
554 av_frame_free(&smk->pic);
560 static av_cold int decode_init(AVCodecContext *avctx)
562 SmackVContext * const c = avctx->priv_data;
567 avctx->pix_fmt = AV_PIX_FMT_PAL8;
569 c->pic = av_frame_alloc();
571 return AVERROR(ENOMEM);
573 /* decode huffman trees from extradata */
574 if(avctx->extradata_size < 16){
575 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
576 return AVERROR_INVALIDDATA;
579 if ((ret = decode_header_trees(c))) {
589 static av_cold int smka_decode_init(AVCodecContext *avctx)
591 if (avctx->channels < 1 || avctx->channels > 2) {
592 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
593 return AVERROR_INVALIDDATA;
595 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
596 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
602 * Decode Smacker audio data
604 static int smka_decode_frame(AVCodecContext *avctx, void *data,
605 int *got_frame_ptr, AVPacket *avpkt)
607 AVFrame *frame = data;
608 const uint8_t *buf = avpkt->data;
609 int buf_size = avpkt->size;
611 HuffContext h[4] = { { 0 } };
612 VLC vlc[4] = { { 0 } };
619 int pred[2] = {0, 0};
622 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
623 return AVERROR_INVALIDDATA;
626 unp_size = AV_RL32(buf);
628 bitstream_init8(&bc, buf + 4, buf_size - 4);
630 if (!bitstream_read_bit(&bc)) {
631 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
635 stereo = bitstream_read_bit(&bc);
636 bits = bitstream_read_bit(&bc);
637 if (stereo ^ (avctx->channels != 1)) {
638 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
639 return AVERROR_INVALIDDATA;
641 if (bits && avctx->sample_fmt == AV_SAMPLE_FMT_U8) {
642 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
643 return AVERROR_INVALIDDATA;
645 if (unp_size % (avctx->channels * (bits + 1))) {
646 av_log(avctx, AV_LOG_ERROR,
647 "The buffer does not contain an integer number of samples\n");
648 return AVERROR_INVALIDDATA;
651 /* get output buffer */
652 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
653 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0) {
654 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
657 samples = (int16_t *)frame->data[0];
658 samples8 = frame->data[0];
661 for(i = 0; i < (1 << (bits + stereo)); i++) {
665 h[i].bits = av_mallocz(256 * 4);
666 h[i].lengths = av_mallocz(256 * sizeof(int));
667 h[i].values = av_mallocz(256 * sizeof(int));
668 if (!h[i].bits || !h[i].lengths || !h[i].values) {
669 ret = AVERROR(ENOMEM);
672 bitstream_skip(&bc, 1);
673 if (smacker_decode_tree(&bc, &h[i], 0, 0) < 0) {
674 ret = AVERROR_INVALIDDATA;
677 bitstream_skip(&bc, 1);
678 if(h[i].current > 1) {
679 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
680 h[i].lengths, sizeof(int), sizeof(int),
681 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
683 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
684 ret = AVERROR_INVALIDDATA;
689 /* this codec relies on wraparound instead of clipping audio */
690 if(bits) { //decode 16-bit data
691 for(i = stereo; i >= 0; i--)
692 pred[i] = sign_extend(av_bswap16(bitstream_read(&bc, 16)), 16);
693 for(i = 0; i <= stereo; i++)
694 *samples++ = pred[i];
695 for(; i < unp_size / 2; i++) {
698 res = bitstream_read_vlc(&bc, vlc[2].table, SMKTREE_BITS, 3);
701 val = h[2].values[res];
703 res = bitstream_read_vlc(&bc, vlc[3].table, SMKTREE_BITS, 3);
706 val |= h[3].values[res] << 8;
707 pred[1] += sign_extend(val, 16);
708 *samples++ = pred[1];
711 res = bitstream_read_vlc(&bc, vlc[0].table, SMKTREE_BITS, 3);
714 val = h[0].values[res];
716 res = bitstream_read_vlc(&bc, vlc[1].table, SMKTREE_BITS, 3);
719 val |= h[1].values[res] << 8;
720 pred[0] += sign_extend(val, 16);
721 *samples++ = pred[0];
724 } else { //8-bit data
725 for(i = stereo; i >= 0; i--)
726 pred[i] = bitstream_read(&bc, 8);
727 for(i = 0; i <= stereo; i++)
728 *samples8++ = pred[i];
729 for(; i < unp_size; i++) {
732 res = bitstream_read_vlc(&bc, vlc[1].table, SMKTREE_BITS, 3);
735 pred[1] += sign_extend(h[1].values[res], 8);
736 *samples8++ = pred[1];
739 res = bitstream_read_vlc(&bc, vlc[0].table, SMKTREE_BITS, 3);
742 pred[0] += sign_extend(h[0].values[res], 8);
743 *samples8++ = pred[0];
752 for(i = 0; i < 4; i++) {
754 ff_free_vlc(&vlc[i]);
756 av_free(h[i].lengths);
757 av_free(h[i].values);
763 AVCodec ff_smacker_decoder = {
765 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
766 .type = AVMEDIA_TYPE_VIDEO,
767 .id = AV_CODEC_ID_SMACKVIDEO,
768 .priv_data_size = sizeof(SmackVContext),
771 .decode = decode_frame,
772 .capabilities = AV_CODEC_CAP_DR1,
775 AVCodec ff_smackaud_decoder = {
777 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
778 .type = AVMEDIA_TYPE_AUDIO,
779 .id = AV_CODEC_ID_SMACKAUDIO,
780 .init = smka_decode_init,
781 .decode = smka_decode_frame,
782 .capabilities = AV_CODEC_CAP_DR1,