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"
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(!get_bits1(gb)){ //Leaf
101 if(hc->current >= 256){
102 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
106 hc->bits[hc->current] = prefix;
107 hc->lengths[hc->current] = length;
109 hc->bits[hc->current] = 0;
110 hc->lengths[hc->current] = 0;
112 hc->values[hc->current] = get_bits(gb, 8);
114 if(hc->maxlength < length)
115 hc->maxlength = length;
120 r = smacker_decode_tree(gb, hc, prefix, length);
123 return smacker_decode_tree(gb, hc, prefix | (1 << (length - 1)), length);
130 static int smacker_decode_bigtree(GetBitContext *gb, HuffContext *hc, DBCtx *ctx)
132 if (hc->current + 1 >= hc->length) {
133 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
136 if(!get_bits1(gb)){ //Leaf
138 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
139 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
140 if (i1 < 0 || i2 < 0)
142 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
143 if(val == ctx->escapes[0]) {
144 ctx->last[0] = hc->current;
146 } else if(val == ctx->escapes[1]) {
147 ctx->last[1] = hc->current;
149 } else if(val == ctx->escapes[2]) {
150 ctx->last[2] = hc->current;
154 hc->values[hc->current++] = val;
160 r = smacker_decode_bigtree(gb, hc, ctx);
163 hc->values[t] = SMK_NODE | r;
165 r_new = smacker_decode_bigtree(gb, hc, ctx);
173 * Store large tree as Libav's vlc codes
175 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
179 HuffContext tmp1, tmp2;
180 VLC vlc[2] = { { 0 } };
185 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
186 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
193 tmp1.bits = av_mallocz(256 * 4);
194 tmp1.lengths = av_mallocz(256 * sizeof(int));
195 tmp1.values = av_mallocz(256 * sizeof(int));
200 tmp2.bits = av_mallocz(256 * 4);
201 tmp2.lengths = av_mallocz(256 * sizeof(int));
202 tmp2.values = av_mallocz(256 * sizeof(int));
203 if (!tmp1.bits || !tmp1.lengths || !tmp1.values ||
204 !tmp2.bits || !tmp2.lengths || !tmp2.values) {
205 err = AVERROR(ENOMEM);
210 smacker_decode_tree(gb, &tmp1, 0, 0);
212 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
213 tmp1.lengths, sizeof(int), sizeof(int),
214 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
216 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
221 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
224 smacker_decode_tree(gb, &tmp2, 0, 0);
226 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
227 tmp2.lengths, sizeof(int), sizeof(int),
228 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
230 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
235 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
238 escapes[0] = get_bits(gb, 8);
239 escapes[0] |= get_bits(gb, 8) << 8;
240 escapes[1] = get_bits(gb, 8);
241 escapes[1] |= get_bits(gb, 8) << 8;
242 escapes[2] = get_bits(gb, 8);
243 escapes[2] |= get_bits(gb, 8) << 8;
245 last[0] = last[1] = last[2] = -1;
247 ctx.escapes[0] = escapes[0];
248 ctx.escapes[1] = escapes[1];
249 ctx.escapes[2] = escapes[2];
252 ctx.recode1 = tmp1.values;
253 ctx.recode2 = tmp2.values;
256 huff.length = ((size + 3) >> 2) + 4;
259 huff.values = av_mallocz(huff.length * sizeof(int));
261 err = AVERROR(ENOMEM);
265 if (smacker_decode_bigtree(gb, &huff, &ctx) < 0)
268 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
269 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
270 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
271 if (ctx.last[0] >= huff.length ||
272 ctx.last[1] >= huff.length ||
273 ctx.last[2] >= huff.length) {
274 av_log(smk->avctx, AV_LOG_ERROR, "Huffman codes out of range\n");
275 err = AVERROR_INVALIDDATA;
278 *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;
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);
310 return AVERROR(ENOMEM);
311 smk->mmap_tbl[0] = 0;
312 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
314 if (smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size))
317 if(!get_bits1(&gb)) {
318 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
319 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
321 return AVERROR(ENOMEM);
322 smk->mclr_tbl[0] = 0;
323 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
325 if (smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size))
328 if(!get_bits1(&gb)) {
329 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
330 smk->full_tbl = av_malloc(sizeof(int) * 2);
332 return AVERROR(ENOMEM);
333 smk->full_tbl[0] = 0;
334 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
336 if (smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size))
339 if(!get_bits1(&gb)) {
340 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
341 smk->type_tbl = av_malloc(sizeof(int) * 2);
343 return AVERROR(ENOMEM);
344 smk->type_tbl[0] = 0;
345 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
347 if (smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size))
354 static av_always_inline void last_reset(int *recode, int *last) {
355 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
358 /* get code and update history */
359 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
360 register int *table = recode;
363 while(*table & SMK_NODE) {
365 table += (*table) & (~SMK_NODE);
370 if(v != recode[last[0]]) {
371 recode[last[2]] = recode[last[1]];
372 recode[last[1]] = recode[last[0]];
378 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
381 SmackVContext * const smk = avctx->priv_data;
386 int blocks, blk, bw, bh;
391 if (avpkt->size <= 769)
394 if ((ret = ff_reget_buffer(avctx, &smk->pic)) < 0) {
395 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
399 /* make the palette available on the way out */
400 pal = (uint32_t*)smk->pic.data[1];
401 bytestream2_init(&gb2, avpkt->data, avpkt->size);
402 flags = bytestream2_get_byteu(&gb2);
403 smk->pic.palette_has_changed = flags & 1;
404 smk->pic.key_frame = !!(flags & 2);
405 if(smk->pic.key_frame)
406 smk->pic.pict_type = AV_PICTURE_TYPE_I;
408 smk->pic.pict_type = AV_PICTURE_TYPE_P;
410 for(i = 0; i < 256; i++)
411 *pal++ = bytestream2_get_be24u(&gb2);
413 last_reset(smk->mmap_tbl, smk->mmap_last);
414 last_reset(smk->mclr_tbl, smk->mclr_last);
415 last_reset(smk->full_tbl, smk->full_last);
416 last_reset(smk->type_tbl, smk->type_last);
417 init_get_bits(&gb, avpkt->data + 769, (avpkt->size - 769) * 8);
420 bw = avctx->width >> 2;
421 bh = avctx->height >> 2;
423 out = smk->pic.data[0];
424 stride = smk->pic.linesize[0];
425 while(blk < blocks) {
429 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
430 run = block_runs[(type >> 2) & 0x3F];
433 while(run-- && blk < blocks){
436 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
437 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
438 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
441 for(i = 0; i < 4; i++) {
442 if(map & 1) out[0] = hi; else out[0] = lo;
443 if(map & 2) out[1] = hi; else out[1] = lo;
444 if(map & 4) out[2] = hi; else out[2] = lo;
445 if(map & 8) out[3] = hi; else out[3] = lo;
454 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
455 if(get_bits1(&gb)) mode = 1;
456 else if(get_bits1(&gb)) mode = 2;
458 while(run-- && blk < blocks){
459 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
462 for(i = 0; i < 4; i++) {
463 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
465 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
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;
478 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
479 out[0] = out[1] = pix & 0xFF;
480 out[2] = out[3] = pix >> 8;
482 out[0] = out[1] = pix & 0xFF;
483 out[2] = out[3] = pix >> 8;
487 for(i = 0; i < 2; i++) {
489 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
490 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
504 while(run-- && blk < blocks)
509 while(run-- && blk < blocks){
511 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
512 col = mode * 0x01010101;
513 for(i = 0; i < 4; i++) {
514 *((uint32_t*)out) = col;
524 if ((ret = av_frame_ref(data, &smk->pic)) < 0)
529 /* always report that the buffer was completely consumed */
537 * Init smacker decoder
540 static av_cold int decode_init(AVCodecContext *avctx)
542 SmackVContext * const c = avctx->priv_data;
546 avctx->pix_fmt = AV_PIX_FMT_PAL8;
547 avcodec_get_frame_defaults(&c->pic);
549 /* decode huffman trees from extradata */
550 if(avctx->extradata_size < 16){
551 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
555 if (decode_header_trees(c))
565 * Uninit smacker decoder
568 static av_cold int decode_end(AVCodecContext *avctx)
570 SmackVContext * const smk = avctx->priv_data;
572 av_freep(&smk->mmap_tbl);
573 av_freep(&smk->mclr_tbl);
574 av_freep(&smk->full_tbl);
575 av_freep(&smk->type_tbl);
577 av_frame_unref(&smk->pic);
583 static av_cold int smka_decode_init(AVCodecContext *avctx)
585 if (avctx->channels < 1 || avctx->channels > 2) {
586 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
587 return AVERROR(EINVAL);
589 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
590 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
596 * Decode Smacker audio data
598 static int smka_decode_frame(AVCodecContext *avctx, void *data,
599 int *got_frame_ptr, AVPacket *avpkt)
601 AVFrame *frame = data;
602 const uint8_t *buf = avpkt->data;
603 int buf_size = avpkt->size;
605 HuffContext h[4] = { { 0 } };
606 VLC vlc[4] = { { 0 } };
613 int pred[2] = {0, 0};
616 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
617 return AVERROR(EINVAL);
620 unp_size = AV_RL32(buf);
622 init_get_bits(&gb, buf + 4, (buf_size - 4) * 8);
625 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
629 stereo = get_bits1(&gb);
630 bits = get_bits1(&gb);
631 if (stereo ^ (avctx->channels != 1)) {
632 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
633 return AVERROR(EINVAL);
635 if (bits && avctx->sample_fmt == AV_SAMPLE_FMT_U8) {
636 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
637 return AVERROR(EINVAL);
640 /* get output buffer */
641 frame->nb_samples = unp_size / (avctx->channels * (bits + 1));
642 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0) {
643 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
646 samples = (int16_t *)frame->data[0];
647 samples8 = frame->data[0];
650 for(i = 0; i < (1 << (bits + stereo)); i++) {
654 h[i].bits = av_mallocz(256 * 4);
655 h[i].lengths = av_mallocz(256 * sizeof(int));
656 h[i].values = av_mallocz(256 * sizeof(int));
657 if (!h[i].bits || !h[i].lengths || !h[i].values) {
658 ret = AVERROR(ENOMEM);
662 if (smacker_decode_tree(&gb, &h[i], 0, 0) < 0) {
663 ret = AVERROR_INVALIDDATA;
667 if(h[i].current > 1) {
668 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
669 h[i].lengths, sizeof(int), sizeof(int),
670 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
672 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
673 ret = AVERROR_INVALIDDATA;
678 /* this codec relies on wraparound instead of clipping audio */
679 if(bits) { //decode 16-bit data
680 for(i = stereo; i >= 0; i--)
681 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
682 for(i = 0; i <= stereo; i++)
683 *samples++ = pred[i];
684 for(; i < unp_size / 2; i++) {
687 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
690 val = h[2].values[res];
692 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
695 val |= h[3].values[res] << 8;
696 pred[1] += sign_extend(val, 16);
697 *samples++ = pred[1];
700 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
703 val = h[0].values[res];
705 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
708 val |= h[1].values[res] << 8;
709 pred[0] += sign_extend(val, 16);
710 *samples++ = pred[0];
713 } else { //8-bit data
714 for(i = stereo; i >= 0; i--)
715 pred[i] = get_bits(&gb, 8);
716 for(i = 0; i <= stereo; i++)
717 *samples8++ = pred[i];
718 for(; i < unp_size; i++) {
721 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
724 pred[1] += sign_extend(h[1].values[res], 8);
725 *samples8++ = pred[1];
728 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
731 pred[0] += sign_extend(h[0].values[res], 8);
732 *samples8++ = pred[0];
741 for(i = 0; i < 4; i++) {
743 ff_free_vlc(&vlc[i]);
745 av_free(h[i].lengths);
746 av_free(h[i].values);
752 AVCodec ff_smacker_decoder = {
754 .type = AVMEDIA_TYPE_VIDEO,
755 .id = AV_CODEC_ID_SMACKVIDEO,
756 .priv_data_size = sizeof(SmackVContext),
759 .decode = decode_frame,
760 .capabilities = CODEC_CAP_DR1,
761 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
764 AVCodec ff_smackaud_decoder = {
766 .type = AVMEDIA_TYPE_AUDIO,
767 .id = AV_CODEC_ID_SMACKAUDIO,
768 .init = smka_decode_init,
769 .decode = smka_decode_frame,
770 .capabilities = CODEC_CAP_DR1,
771 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),