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 "bytestream.h"
43 #define SMKTREE_BITS 9
44 #define SMK_NODE 0x80000000
47 typedef struct SmackVContext {
48 AVCodecContext *avctx;
51 int *mmap_tbl, *mclr_tbl, *full_tbl, *type_tbl;
52 int mmap_last[3], mclr_last[3], full_last[3], type_last[3];
56 * Context used for code reconstructing
58 typedef struct HuffContext {
67 /* common parameters used for decode_bigtree */
68 typedef struct DBCtx {
70 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(!get_bits1(gb)){ //Leaf
99 if(hc->current >= 256){
100 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
104 hc->bits[hc->current] = prefix;
105 hc->lengths[hc->current] = length;
107 hc->bits[hc->current] = 0;
108 hc->lengths[hc->current] = 0;
110 hc->values[hc->current] = get_bits(gb, 8);
112 if(hc->maxlength < length)
113 hc->maxlength = length;
118 r = smacker_decode_tree(gb, hc, prefix, length);
121 return smacker_decode_tree(gb, hc, prefix | (1 << (length - 1)), length);
128 static int smacker_decode_bigtree(GetBitContext *gb, HuffContext *hc, DBCtx *ctx)
130 if (hc->current + 1 >= hc->length) {
131 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
134 if(!get_bits1(gb)){ //Leaf
136 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
137 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
138 if (i1 < 0 || i2 < 0)
140 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
141 if(val == ctx->escapes[0]) {
142 ctx->last[0] = hc->current;
144 } else if(val == ctx->escapes[1]) {
145 ctx->last[1] = hc->current;
147 } else if(val == ctx->escapes[2]) {
148 ctx->last[2] = hc->current;
152 hc->values[hc->current++] = val;
158 r = smacker_decode_bigtree(gb, hc, ctx);
161 hc->values[t] = SMK_NODE | r;
163 r_new = smacker_decode_bigtree(gb, hc, ctx);
171 * Store large tree as Libav's vlc codes
173 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
177 HuffContext tmp1, tmp2;
178 VLC vlc[2] = { { 0 } };
183 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
184 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
191 tmp1.bits = av_mallocz(256 * 4);
192 tmp1.lengths = av_mallocz(256 * sizeof(int));
193 tmp1.values = av_mallocz(256 * sizeof(int));
198 tmp2.bits = av_mallocz(256 * 4);
199 tmp2.lengths = av_mallocz(256 * sizeof(int));
200 tmp2.values = av_mallocz(256 * sizeof(int));
201 if (!tmp1.bits || !tmp1.lengths || !tmp1.values ||
202 !tmp2.bits || !tmp2.lengths || !tmp2.values) {
203 err = AVERROR(ENOMEM);
208 smacker_decode_tree(gb, &tmp1, 0, 0);
210 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
211 tmp1.lengths, sizeof(int), sizeof(int),
212 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
214 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
219 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
222 smacker_decode_tree(gb, &tmp2, 0, 0);
224 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
225 tmp2.lengths, sizeof(int), sizeof(int),
226 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
228 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
233 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
236 escapes[0] = get_bits(gb, 8);
237 escapes[0] |= get_bits(gb, 8) << 8;
238 escapes[1] = get_bits(gb, 8);
239 escapes[1] |= get_bits(gb, 8) << 8;
240 escapes[2] = get_bits(gb, 8);
241 escapes[2] |= get_bits(gb, 8) << 8;
243 last[0] = last[1] = last[2] = -1;
245 ctx.escapes[0] = escapes[0];
246 ctx.escapes[1] = escapes[1];
247 ctx.escapes[2] = escapes[2];
250 ctx.recode1 = tmp1.values;
251 ctx.recode2 = tmp2.values;
254 huff.length = ((size + 3) >> 2) + 4;
257 huff.values = av_mallocz(huff.length * sizeof(int));
259 err = AVERROR(ENOMEM);
263 if (smacker_decode_bigtree(gb, &huff, &ctx) < 0)
266 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
267 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
268 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
269 if (ctx.last[0] >= huff.length ||
270 ctx.last[1] >= huff.length ||
271 ctx.last[2] >= huff.length) {
272 av_log(smk->avctx, AV_LOG_ERROR, "Huffman codes out of range\n");
273 err = AVERROR_INVALIDDATA;
276 *recodes = huff.values;
280 ff_free_vlc(&vlc[0]);
282 ff_free_vlc(&vlc[1]);
284 av_free(tmp1.lengths);
285 av_free(tmp1.values);
287 av_free(tmp2.lengths);
288 av_free(tmp2.values);
293 static int decode_header_trees(SmackVContext *smk) {
295 int mmap_size, mclr_size, full_size, type_size;
297 mmap_size = AV_RL32(smk->avctx->extradata);
298 mclr_size = AV_RL32(smk->avctx->extradata + 4);
299 full_size = AV_RL32(smk->avctx->extradata + 8);
300 type_size = AV_RL32(smk->avctx->extradata + 12);
302 init_get_bits(&gb, smk->avctx->extradata + 16, (smk->avctx->extradata_size - 16) * 8);
304 if(!get_bits1(&gb)) {
305 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
306 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
308 return AVERROR(ENOMEM);
309 smk->mmap_tbl[0] = 0;
310 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
312 if (smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size))
315 if(!get_bits1(&gb)) {
316 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
317 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
319 return AVERROR(ENOMEM);
320 smk->mclr_tbl[0] = 0;
321 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
323 if (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);
330 return AVERROR(ENOMEM);
331 smk->full_tbl[0] = 0;
332 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
334 if (smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size))
337 if(!get_bits1(&gb)) {
338 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
339 smk->type_tbl = av_malloc(sizeof(int) * 2);
341 return AVERROR(ENOMEM);
342 smk->type_tbl[0] = 0;
343 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
345 if (smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size))
352 static av_always_inline void last_reset(int *recode, int *last) {
353 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
356 /* get code and update history */
357 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
358 register int *table = recode;
361 while(*table & SMK_NODE) {
363 table += (*table) & (~SMK_NODE);
368 if(v != recode[last[0]]) {
369 recode[last[2]] = recode[last[1]];
370 recode[last[1]] = recode[last[0]];
376 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
379 SmackVContext * const smk = avctx->priv_data;
384 int blocks, blk, bw, bh;
389 if (avpkt->size <= 769)
392 if ((ret = ff_reget_buffer(avctx, smk->pic)) < 0) {
393 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
397 /* make the palette available on the way out */
398 pal = (uint32_t*)smk->pic->data[1];
399 bytestream2_init(&gb2, avpkt->data, avpkt->size);
400 flags = bytestream2_get_byteu(&gb2);
401 smk->pic->palette_has_changed = flags & 1;
402 smk->pic->key_frame = !!(flags & 2);
403 if(smk->pic->key_frame)
404 smk->pic->pict_type = AV_PICTURE_TYPE_I;
406 smk->pic->pict_type = AV_PICTURE_TYPE_P;
408 for(i = 0; i < 256; i++)
409 *pal++ = bytestream2_get_be24u(&gb2);
411 last_reset(smk->mmap_tbl, smk->mmap_last);
412 last_reset(smk->mclr_tbl, smk->mclr_last);
413 last_reset(smk->full_tbl, smk->full_last);
414 last_reset(smk->type_tbl, smk->type_last);
415 init_get_bits(&gb, avpkt->data + 769, (avpkt->size - 769) * 8);
418 bw = avctx->width >> 2;
419 bh = avctx->height >> 2;
421 out = smk->pic->data[0];
422 stride = smk->pic->linesize[0];
423 while(blk < blocks) {
427 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
428 run = block_runs[(type >> 2) & 0x3F];
431 while(run-- && blk < blocks){
434 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
435 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
436 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
439 for(i = 0; i < 4; i++) {
440 if(map & 1) out[0] = hi; else out[0] = lo;
441 if(map & 2) out[1] = hi; else out[1] = lo;
442 if(map & 4) out[2] = hi; else out[2] = lo;
443 if(map & 8) out[3] = hi; else out[3] = lo;
452 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
453 if(get_bits1(&gb)) mode = 1;
454 else if(get_bits1(&gb)) mode = 2;
456 while(run-- && blk < blocks){
457 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
460 for(i = 0; i < 4; i++) {
461 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
463 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
469 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
470 out[0] = out[1] = pix & 0xFF;
471 out[2] = out[3] = pix >> 8;
473 out[0] = out[1] = pix & 0xFF;
474 out[2] = out[3] = pix >> 8;
476 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
477 out[0] = out[1] = pix & 0xFF;
478 out[2] = out[3] = pix >> 8;
480 out[0] = out[1] = pix & 0xFF;
481 out[2] = out[3] = pix >> 8;
485 for(i = 0; i < 2; i++) {
487 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
488 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
502 while(run-- && blk < blocks)
507 while(run-- && blk < blocks){
509 out = smk->pic->data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
510 col = mode * 0x01010101;
511 for(i = 0; i < 4; i++) {
512 *((uint32_t*)out) = col;
522 if ((ret = av_frame_ref(data, smk->pic)) < 0)
527 /* always report that the buffer was completely consumed */
532 static av_cold int decode_end(AVCodecContext *avctx)
534 SmackVContext * const smk = avctx->priv_data;
536 av_freep(&smk->mmap_tbl);
537 av_freep(&smk->mclr_tbl);
538 av_freep(&smk->full_tbl);
539 av_freep(&smk->type_tbl);
541 av_frame_free(&smk->pic);
547 static av_cold int decode_init(AVCodecContext *avctx)
549 SmackVContext * const c = avctx->priv_data;
553 avctx->pix_fmt = AV_PIX_FMT_PAL8;
555 c->pic = av_frame_alloc();
557 return AVERROR(ENOMEM);
559 /* decode huffman trees from extradata */
560 if(avctx->extradata_size < 16){
561 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
565 if (decode_header_trees(c)) {
575 static av_cold int smka_decode_init(AVCodecContext *avctx)
577 if (avctx->channels < 1 || avctx->channels > 2) {
578 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
579 return AVERROR(EINVAL);
581 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
582 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
588 * Decode Smacker audio data
590 static int smka_decode_frame(AVCodecContext *avctx, void *data,
591 int *got_frame_ptr, AVPacket *avpkt)
593 AVFrame *frame = data;
594 const uint8_t *buf = avpkt->data;
595 int buf_size = avpkt->size;
597 HuffContext h[4] = { { 0 } };
598 VLC vlc[4] = { { 0 } };
605 int pred[2] = {0, 0};
608 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
609 return AVERROR(EINVAL);
612 unp_size = AV_RL32(buf);
614 init_get_bits(&gb, buf + 4, (buf_size - 4) * 8);
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(EINVAL);
627 if (bits && avctx->sample_fmt == AV_SAMPLE_FMT_U8) {
628 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
629 return AVERROR(EINVAL);
632 /* get output buffer */
633 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
634 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0) {
635 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
638 samples = (int16_t *)frame->data[0];
639 samples8 = frame->data[0];
642 for(i = 0; i < (1 << (bits + stereo)); i++) {
646 h[i].bits = av_mallocz(256 * 4);
647 h[i].lengths = av_mallocz(256 * sizeof(int));
648 h[i].values = av_mallocz(256 * sizeof(int));
649 if (!h[i].bits || !h[i].lengths || !h[i].values) {
650 ret = AVERROR(ENOMEM);
654 if (smacker_decode_tree(&gb, &h[i], 0, 0) < 0) {
655 ret = AVERROR_INVALIDDATA;
659 if(h[i].current > 1) {
660 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
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");
665 ret = AVERROR_INVALIDDATA;
670 /* this codec relies on wraparound instead of clipping audio */
671 if(bits) { //decode 16-bit data
672 for(i = stereo; i >= 0; i--)
673 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
674 for(i = 0; i <= stereo; i++)
675 *samples++ = pred[i];
676 for(; i < unp_size / 2; i++) {
679 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
682 val = h[2].values[res];
684 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
687 val |= h[3].values[res] << 8;
688 pred[1] += sign_extend(val, 16);
689 *samples++ = pred[1];
692 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
695 val = h[0].values[res];
697 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
700 val |= h[1].values[res] << 8;
701 pred[0] += sign_extend(val, 16);
702 *samples++ = pred[0];
705 } else { //8-bit data
706 for(i = stereo; i >= 0; i--)
707 pred[i] = get_bits(&gb, 8);
708 for(i = 0; i <= stereo; i++)
709 *samples8++ = pred[i];
710 for(; i < unp_size; i++) {
713 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
716 pred[1] += sign_extend(h[1].values[res], 8);
717 *samples8++ = pred[1];
720 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
723 pred[0] += sign_extend(h[0].values[res], 8);
724 *samples8++ = pred[0];
733 for(i = 0; i < 4; i++) {
735 ff_free_vlc(&vlc[i]);
737 av_free(h[i].lengths);
738 av_free(h[i].values);
744 AVCodec ff_smacker_decoder = {
746 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
747 .type = AVMEDIA_TYPE_VIDEO,
748 .id = AV_CODEC_ID_SMACKVIDEO,
749 .priv_data_size = sizeof(SmackVContext),
752 .decode = decode_frame,
753 .capabilities = AV_CODEC_CAP_DR1,
756 AVCodec ff_smackaud_decoder = {
758 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),
759 .type = AVMEDIA_TYPE_AUDIO,
760 .id = AV_CODEC_ID_SMACKAUDIO,
761 .init = smka_decode_init,
762 .decode = smka_decode_frame,
763 .capabilities = AV_CODEC_CAP_DR1,