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
35 #include "libavutil/audioconvert.h"
37 #define ALT_BITSTREAM_READER_LE
39 #include "bytestream.h"
41 #define SMKTREE_BITS 9
42 #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(!get_bits1(gb)){ //Leaf
131 int val, i1, i2, b1, b2;
132 if(hc->current >= hc->length){
133 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
136 b1 = get_bits_count(gb);
137 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
138 b1 = get_bits_count(gb) - b1;
139 b2 = get_bits_count(gb);
140 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
141 b2 = get_bits_count(gb) - b2;
142 if (i1 < 0 || i2 < 0)
144 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
145 if(val == ctx->escapes[0]) {
146 ctx->last[0] = hc->current;
148 } else if(val == ctx->escapes[1]) {
149 ctx->last[1] = hc->current;
151 } else if(val == ctx->escapes[2]) {
152 ctx->last[2] = hc->current;
156 hc->values[hc->current++] = val;
162 r = smacker_decode_bigtree(gb, hc, ctx);
165 hc->values[t] = SMK_NODE | r;
167 r += smacker_decode_bigtree(gb, hc, ctx);
173 * Store large tree as FFmpeg's vlc codes
175 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
179 HuffContext tmp1, tmp2;
184 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
185 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
192 tmp1.bits = av_mallocz(256 * 4);
193 tmp1.lengths = av_mallocz(256 * sizeof(int));
194 tmp1.values = av_mallocz(256 * sizeof(int));
199 tmp2.bits = av_mallocz(256 * 4);
200 tmp2.lengths = av_mallocz(256 * sizeof(int));
201 tmp2.values = av_mallocz(256 * sizeof(int));
203 memset(&vlc[0], 0, sizeof(VLC));
204 memset(&vlc[1], 0, sizeof(VLC));
207 smacker_decode_tree(gb, &tmp1, 0, 0);
209 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
210 tmp1.lengths, sizeof(int), sizeof(int),
211 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
213 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
217 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
220 smacker_decode_tree(gb, &tmp2, 0, 0);
222 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
223 tmp2.lengths, sizeof(int), sizeof(int),
224 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
226 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
230 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
233 escapes[0] = get_bits(gb, 8);
234 escapes[0] |= get_bits(gb, 8) << 8;
235 escapes[1] = get_bits(gb, 8);
236 escapes[1] |= get_bits(gb, 8) << 8;
237 escapes[2] = get_bits(gb, 8);
238 escapes[2] |= get_bits(gb, 8) << 8;
240 last[0] = last[1] = last[2] = -1;
242 ctx.escapes[0] = escapes[0];
243 ctx.escapes[1] = escapes[1];
244 ctx.escapes[2] = escapes[2];
247 ctx.recode1 = tmp1.values;
248 ctx.recode2 = tmp2.values;
251 huff.length = ((size + 3) >> 2) + 3;
254 huff.values = av_mallocz(huff.length * sizeof(int));
256 smacker_decode_bigtree(gb, &huff, &ctx);
258 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
259 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
260 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
262 *recodes = huff.values;
269 av_free(tmp1.lengths);
270 av_free(tmp1.values);
272 av_free(tmp2.lengths);
273 av_free(tmp2.values);
278 static int decode_header_trees(SmackVContext *smk) {
280 int mmap_size, mclr_size, full_size, type_size;
282 mmap_size = AV_RL32(smk->avctx->extradata);
283 mclr_size = AV_RL32(smk->avctx->extradata + 4);
284 full_size = AV_RL32(smk->avctx->extradata + 8);
285 type_size = AV_RL32(smk->avctx->extradata + 12);
287 init_get_bits(&gb, smk->avctx->extradata + 16, (smk->avctx->extradata_size - 16) * 8);
289 if(!get_bits1(&gb)) {
290 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
291 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
292 smk->mmap_tbl[0] = 0;
293 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
295 if (smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size))
298 if(!get_bits1(&gb)) {
299 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
300 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
301 smk->mclr_tbl[0] = 0;
302 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
304 if (smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size))
307 if(!get_bits1(&gb)) {
308 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
309 smk->full_tbl = av_malloc(sizeof(int) * 2);
310 smk->full_tbl[0] = 0;
311 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
313 if (smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size))
316 if(!get_bits1(&gb)) {
317 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
318 smk->type_tbl = av_malloc(sizeof(int) * 2);
319 smk->type_tbl[0] = 0;
320 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
322 if (smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size))
329 static av_always_inline void last_reset(int *recode, int *last) {
330 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
333 /* get code and update history */
334 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
335 register int *table = recode;
338 b = get_bits_count(gb);
339 while(*table & SMK_NODE) {
341 table += (*table) & (~SMK_NODE);
345 b = get_bits_count(gb) - b;
347 if(v != recode[last[0]]) {
348 recode[last[2]] = recode[last[1]];
349 recode[last[1]] = recode[last[0]];
355 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
357 const uint8_t *buf = avpkt->data;
358 int buf_size = avpkt->size;
359 SmackVContext * const smk = avctx->priv_data;
363 int blocks, blk, bw, bh;
370 smk->pic.reference = 1;
371 smk->pic.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
372 if(avctx->reget_buffer(avctx, &smk->pic) < 0){
373 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
377 /* make the palette available on the way out */
378 pal = (uint32_t*)smk->pic.data[1];
379 smk->pic.palette_has_changed = buf[0] & 1;
380 smk->pic.key_frame = !!(buf[0] & 2);
381 if(smk->pic.key_frame)
382 smk->pic.pict_type = AV_PICTURE_TYPE_I;
384 smk->pic.pict_type = AV_PICTURE_TYPE_P;
387 for(i = 0; i < 256; i++)
388 *pal++ = bytestream_get_be24(&buf);
391 last_reset(smk->mmap_tbl, smk->mmap_last);
392 last_reset(smk->mclr_tbl, smk->mclr_last);
393 last_reset(smk->full_tbl, smk->full_last);
394 last_reset(smk->type_tbl, smk->type_last);
395 init_get_bits(&gb, buf, buf_size * 8);
398 bw = avctx->width >> 2;
399 bh = avctx->height >> 2;
401 out = smk->pic.data[0];
402 stride = smk->pic.linesize[0];
403 while(blk < blocks) {
407 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
408 run = block_runs[(type >> 2) & 0x3F];
411 while(run-- && blk < blocks){
414 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
415 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
416 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
419 for(i = 0; i < 4; i++) {
420 if(map & 1) out[0] = hi; else out[0] = lo;
421 if(map & 2) out[1] = hi; else out[1] = lo;
422 if(map & 4) out[2] = hi; else out[2] = lo;
423 if(map & 8) out[3] = hi; else out[3] = lo;
432 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
433 if(get_bits1(&gb)) mode = 1;
434 else if(get_bits1(&gb)) mode = 2;
436 while(run-- && blk < blocks){
437 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
440 for(i = 0; i < 4; i++) {
441 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
443 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
449 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
450 out[0] = out[1] = pix & 0xFF;
451 out[2] = out[3] = pix >> 8;
453 out[0] = out[1] = pix & 0xFF;
454 out[2] = out[3] = pix >> 8;
456 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
457 out[0] = out[1] = pix & 0xFF;
458 out[2] = out[3] = pix >> 8;
460 out[0] = out[1] = pix & 0xFF;
461 out[2] = out[3] = pix >> 8;
465 for(i = 0; i < 2; i++) {
467 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
468 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
482 while(run-- && blk < blocks)
487 while(run-- && blk < blocks){
489 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
490 col = mode * 0x01010101;
491 for(i = 0; i < 4; i++) {
492 *((uint32_t*)out) = col;
502 *data_size = sizeof(AVFrame);
503 *(AVFrame*)data = smk->pic;
505 /* always report that the buffer was completely consumed */
513 * Init smacker decoder
516 static av_cold int decode_init(AVCodecContext *avctx)
518 SmackVContext * const c = avctx->priv_data;
522 avctx->pix_fmt = PIX_FMT_PAL8;
524 avcodec_get_frame_defaults(&c->pic);
526 /* decode huffman trees from extradata */
527 if(avctx->extradata_size < 16){
528 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
532 if (decode_header_trees(c))
542 * Uninit smacker decoder
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 if (smk->pic.data[0])
555 avctx->release_buffer(avctx, &smk->pic);
561 static av_cold int smka_decode_init(AVCodecContext *avctx)
563 if (avctx->channels < 1 || avctx->channels > 2) {
564 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
565 return AVERROR(EINVAL);
567 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
568 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
573 * Decode Smacker audio data
575 static int smka_decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
577 const uint8_t *buf = avpkt->data;
578 int buf_size = avpkt->size;
582 int16_t *samples = data;
583 int8_t *samples8 = data;
588 int pred[2] = {0, 0};
591 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
592 return AVERROR(EINVAL);
595 unp_size = AV_RL32(buf);
597 init_get_bits(&gb, buf + 4, (buf_size - 4) * 8);
600 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
604 stereo = get_bits1(&gb);
605 bits = get_bits1(&gb);
606 if (unp_size & 0xC0000000 || unp_size > *data_size) {
607 av_log(avctx, AV_LOG_ERROR, "Frame is too large to fit in buffer\n");
610 if (stereo ^ (avctx->channels != 1)) {
611 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
612 return AVERROR(EINVAL);
614 if (bits && avctx->sample_fmt == AV_SAMPLE_FMT_U8) {
615 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
616 return AVERROR(EINVAL);
619 memset(vlc, 0, sizeof(VLC) * 4);
620 memset(h, 0, sizeof(HuffContext) * 4);
622 for(i = 0; i < (1 << (bits + stereo)); i++) {
626 h[i].bits = av_mallocz(256 * 4);
627 h[i].lengths = av_mallocz(256 * sizeof(int));
628 h[i].values = av_mallocz(256 * sizeof(int));
630 smacker_decode_tree(&gb, &h[i], 0, 0);
632 if(h[i].current > 1) {
633 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
634 h[i].lengths, sizeof(int), sizeof(int),
635 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
637 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
642 if(bits) { //decode 16-bit data
643 for(i = stereo; i >= 0; i--)
644 pred[i] = av_bswap16(get_bits(&gb, 16));
645 for(i = 0; i <= stereo; i++)
646 *samples++ = pred[i];
647 for(; i < unp_size / 2; i++) {
650 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
653 val = h[2].values[res];
655 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
658 val |= h[3].values[res] << 8;
659 pred[1] += (int16_t)val;
660 *samples++ = pred[1];
663 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
666 val = h[0].values[res];
668 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
671 val |= h[1].values[res] << 8;
673 *samples++ = pred[0];
676 } else { //8-bit data
677 for(i = stereo; i >= 0; i--)
678 pred[i] = get_bits(&gb, 8);
679 for(i = 0; i <= stereo; i++)
680 *samples8++ = pred[i];
681 for(; i < unp_size; i++) {
684 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
687 pred[1] += (int8_t)h[1].values[res];
688 *samples8++ = pred[1];
691 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
694 pred[0] += (int8_t)h[0].values[res];
695 *samples8++ = pred[0];
700 for(i = 0; i < 4; i++) {
704 av_free(h[i].lengths);
705 av_free(h[i].values);
708 *data_size = unp_size;
712 AVCodec ff_smacker_decoder = {
714 .type = AVMEDIA_TYPE_VIDEO,
715 .id = CODEC_ID_SMACKVIDEO,
716 .priv_data_size = sizeof(SmackVContext),
719 .decode = decode_frame,
720 .capabilities = CODEC_CAP_DR1,
721 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
724 AVCodec ff_smackaud_decoder = {
726 .type = AVMEDIA_TYPE_AUDIO,
727 .id = CODEC_ID_SMACKAUDIO,
728 .init = smka_decode_init,
729 .decode = smka_decode_frame,
730 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),