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"
38 #define BITSTREAM_READER_LE
40 #include "bytestream.h"
42 #define SMKTREE_BITS 9
43 #define SMK_NODE 0x80000000
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(GetBitContext *gb, HuffContext *hc, uint32_t prefix, int length)
100 av_log(NULL, AV_LOG_ERROR, "length too long\n");
101 return AVERROR_INVALIDDATA;
103 if(!get_bits1(gb)){ //Leaf
104 if(hc->current >= 256){
105 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
106 return AVERROR_INVALIDDATA;
109 hc->bits[hc->current] = prefix;
110 hc->lengths[hc->current] = length;
112 hc->bits[hc->current] = 0;
113 hc->lengths[hc->current] = 0;
115 hc->values[hc->current] = get_bits(gb, 8);
117 if(hc->maxlength < length)
118 hc->maxlength = length;
123 r = smacker_decode_tree(gb, hc, prefix, length);
126 return smacker_decode_tree(gb, hc, prefix | (1 << (length - 1)), length);
133 static int smacker_decode_bigtree(GetBitContext *gb, HuffContext *hc, DBCtx *ctx)
135 if (hc->current + 1 >= hc->length) {
136 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
137 return AVERROR_INVALIDDATA;
139 if(!get_bits1(gb)){ //Leaf
141 i1 = ctx->v1->table ? get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3) : 0;
142 i2 = ctx->v2->table ? get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3) : 0;
143 if (i1 < 0 || i2 < 0)
144 return AVERROR_INVALIDDATA;
145 val = ctx->recode1[i1] | (ctx->recode2[i2] << 8);
146 if(val == ctx->escapes[0]) {
147 ctx->last[0] = hc->current;
149 } else if(val == ctx->escapes[1]) {
150 ctx->last[1] = hc->current;
152 } else if(val == ctx->escapes[2]) {
153 ctx->last[2] = hc->current;
157 hc->values[hc->current++] = val;
163 r = smacker_decode_bigtree(gb, hc, ctx);
166 hc->values[t] = SMK_NODE | r;
168 r_new = smacker_decode_bigtree(gb, hc, ctx);
176 * Store large tree as FFmpeg's vlc codes
178 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
182 HuffContext tmp1, tmp2;
183 VLC vlc[2] = { { 0 } };
188 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
189 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
190 return AVERROR_INVALIDDATA;
196 tmp1.bits = av_mallocz(256 * 4);
197 tmp1.lengths = av_mallocz(256 * sizeof(int));
198 tmp1.values = av_mallocz(256 * sizeof(int));
203 tmp2.bits = av_mallocz(256 * 4);
204 tmp2.lengths = av_mallocz(256 * sizeof(int));
205 tmp2.values = av_mallocz(256 * sizeof(int));
208 smacker_decode_tree(gb, &tmp1, 0, 0);
210 if(tmp1.current > 1) {
211 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
212 tmp1.lengths, sizeof(int), sizeof(int),
213 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
215 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
216 return AVERROR_INVALIDDATA;
221 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
224 smacker_decode_tree(gb, &tmp2, 0, 0);
226 if(tmp2.current > 1) {
227 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
228 tmp2.lengths, sizeof(int), sizeof(int),
229 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
231 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
232 return AVERROR_INVALIDDATA;
237 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
240 escapes[0] = get_bits(gb, 16);
241 escapes[1] = get_bits(gb, 16);
242 escapes[2] = get_bits(gb, 16);
244 last[0] = last[1] = last[2] = -1;
246 ctx.escapes[0] = escapes[0];
247 ctx.escapes[1] = escapes[1];
248 ctx.escapes[2] = escapes[2];
251 ctx.recode1 = tmp1.values;
252 ctx.recode2 = tmp2.values;
255 huff.length = ((size + 3) >> 2) + 3;
258 huff.values = av_mallocz(huff.length * sizeof(int));
260 if (smacker_decode_bigtree(gb, &huff, &ctx) < 0)
263 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
264 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
265 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
266 if(huff.current > huff.length){
267 ctx.last[0] = ctx.last[1] = ctx.last[2] = 1;
268 av_log(smk->avctx, AV_LOG_ERROR, "bigtree damaged\n");
269 return AVERROR_INVALIDDATA;
272 *recodes = huff.values;
275 ff_free_vlc(&vlc[0]);
277 ff_free_vlc(&vlc[1]);
279 av_free(tmp1.lengths);
280 av_free(tmp1.values);
282 av_free(tmp2.lengths);
283 av_free(tmp2.values);
288 static int decode_header_trees(SmackVContext *smk) {
290 int mmap_size, mclr_size, full_size, type_size;
292 mmap_size = AV_RL32(smk->avctx->extradata);
293 mclr_size = AV_RL32(smk->avctx->extradata + 4);
294 full_size = AV_RL32(smk->avctx->extradata + 8);
295 type_size = AV_RL32(smk->avctx->extradata + 12);
297 init_get_bits(&gb, smk->avctx->extradata + 16, (smk->avctx->extradata_size - 16) * 8);
299 if(!get_bits1(&gb)) {
300 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
301 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
302 smk->mmap_tbl[0] = 0;
303 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
305 if (smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size))
306 return AVERROR_INVALIDDATA;
308 if(!get_bits1(&gb)) {
309 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
310 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
311 smk->mclr_tbl[0] = 0;
312 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
314 if (smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size))
315 return AVERROR_INVALIDDATA;
317 if(!get_bits1(&gb)) {
318 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
319 smk->full_tbl = av_malloc(sizeof(int) * 2);
320 smk->full_tbl[0] = 0;
321 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
323 if (smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size))
324 return AVERROR_INVALIDDATA;
326 if(!get_bits1(&gb)) {
327 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
328 smk->type_tbl = av_malloc(sizeof(int) * 2);
329 smk->type_tbl[0] = 0;
330 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
332 if (smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size))
333 return AVERROR_INVALIDDATA;
339 static av_always_inline void last_reset(int *recode, int *last) {
340 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
343 /* get code and update history */
344 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
345 register int *table = recode;
348 while(*table & SMK_NODE) {
350 table += (*table) & (~SMK_NODE);
355 if(v != recode[last[0]]) {
356 recode[last[2]] = recode[last[1]];
357 recode[last[1]] = recode[last[0]];
363 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
365 SmackVContext * const smk = avctx->priv_data;
370 int blocks, blk, bw, bh;
375 if (avpkt->size <= 769)
376 return AVERROR_INVALIDDATA;
378 smk->pic.reference = 3;
379 smk->pic.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
380 if((ret = avctx->reget_buffer(avctx, &smk->pic)) < 0){
381 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
385 /* make the palette available on the way out */
386 pal = (uint32_t*)smk->pic.data[1];
387 bytestream2_init(&gb2, avpkt->data, avpkt->size);
388 flags = bytestream2_get_byteu(&gb2);
389 smk->pic.palette_has_changed = flags & 1;
390 smk->pic.key_frame = !!(flags & 2);
391 if(smk->pic.key_frame)
392 smk->pic.pict_type = AV_PICTURE_TYPE_I;
394 smk->pic.pict_type = AV_PICTURE_TYPE_P;
396 for(i = 0; i < 256; i++)
397 *pal++ = 0xFFU << 24 | bytestream2_get_be24u(&gb2);
399 last_reset(smk->mmap_tbl, smk->mmap_last);
400 last_reset(smk->mclr_tbl, smk->mclr_last);
401 last_reset(smk->full_tbl, smk->full_last);
402 last_reset(smk->type_tbl, smk->type_last);
403 init_get_bits(&gb, avpkt->data + 769, (avpkt->size - 769) * 8);
406 bw = avctx->width >> 2;
407 bh = avctx->height >> 2;
409 out = smk->pic.data[0];
410 stride = smk->pic.linesize[0];
411 while(blk < blocks) {
415 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
416 run = block_runs[(type >> 2) & 0x3F];
419 while(run-- && blk < blocks){
422 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
423 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
424 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
427 for(i = 0; i < 4; i++) {
428 if(map & 1) out[0] = hi; else out[0] = lo;
429 if(map & 2) out[1] = hi; else out[1] = lo;
430 if(map & 4) out[2] = hi; else out[2] = lo;
431 if(map & 8) out[3] = hi; else out[3] = lo;
440 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
441 if(get_bits1(&gb)) mode = 1;
442 else if(get_bits1(&gb)) mode = 2;
444 while(run-- && blk < blocks){
445 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
448 for(i = 0; i < 4; i++) {
449 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
451 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
457 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
458 out[0] = out[1] = pix & 0xFF;
459 out[2] = out[3] = pix >> 8;
461 out[0] = out[1] = pix & 0xFF;
462 out[2] = out[3] = pix >> 8;
464 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
465 out[0] = out[1] = pix & 0xFF;
466 out[2] = out[3] = pix >> 8;
468 out[0] = out[1] = pix & 0xFF;
469 out[2] = out[3] = pix >> 8;
473 for(i = 0; i < 2; i++) {
475 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
476 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
490 while(run-- && blk < blocks)
495 while(run-- && blk < blocks){
497 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
498 col = mode * 0x01010101;
499 for(i = 0; i < 4; i++) {
500 *((uint32_t*)out) = col;
510 *data_size = sizeof(AVFrame);
511 *(AVFrame*)data = smk->pic;
513 /* always report that the buffer was completely consumed */
521 * Init smacker decoder
524 static av_cold int decode_init(AVCodecContext *avctx)
526 SmackVContext * const c = avctx->priv_data;
530 avctx->pix_fmt = AV_PIX_FMT_PAL8;
532 avcodec_get_frame_defaults(&c->pic);
534 /* decode huffman trees from extradata */
535 if(avctx->extradata_size < 16){
536 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
537 return AVERROR(EINVAL);
540 if (decode_header_trees(c))
541 return AVERROR_INVALIDDATA;
550 * Uninit smacker decoder
553 static av_cold int decode_end(AVCodecContext *avctx)
555 SmackVContext * const smk = avctx->priv_data;
557 av_freep(&smk->mmap_tbl);
558 av_freep(&smk->mclr_tbl);
559 av_freep(&smk->full_tbl);
560 av_freep(&smk->type_tbl);
562 if (smk->pic.data[0])
563 avctx->release_buffer(avctx, &smk->pic);
569 typedef struct SmackerAudioContext {
571 } SmackerAudioContext;
573 static av_cold int smka_decode_init(AVCodecContext *avctx)
575 SmackerAudioContext *s = avctx->priv_data;
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;
584 avcodec_get_frame_defaults(&s->frame);
585 avctx->coded_frame = &s->frame;
591 * Decode Smacker audio data
593 static int smka_decode_frame(AVCodecContext *avctx, void *data,
594 int *got_frame_ptr, AVPacket *avpkt)
596 SmackerAudioContext *s = avctx->priv_data;
597 const uint8_t *buf = avpkt->data;
598 int buf_size = avpkt->size;
600 HuffContext h[4] = { { 0 } };
601 VLC vlc[4] = { { 0 } };
608 int pred[2] = {0, 0};
611 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
612 return AVERROR(EINVAL);
615 unp_size = AV_RL32(buf);
617 if (unp_size > (1U<<24)) {
618 av_log(avctx, AV_LOG_ERROR, "packet is too big\n");
619 return AVERROR_INVALIDDATA;
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 s->frame.nb_samples = unp_size / (avctx->channels * (bits + 1));
642 if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
643 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
646 samples = (int16_t *)s->frame.data[0];
647 samples8 = s->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));
658 smacker_decode_tree(&gb, &h[i], 0, 0);
660 if(h[i].current > 1) {
661 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
662 h[i].lengths, sizeof(int), sizeof(int),
663 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
665 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
666 return AVERROR_INVALIDDATA;
670 if(bits) { //decode 16-bit data
671 for(i = stereo; i >= 0; i--)
672 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
673 for(i = 0; i <= stereo; i++)
674 *samples++ = pred[i];
675 for(; i < unp_size / 2; i++) {
676 if(get_bits_left(&gb)<0)
677 return AVERROR_INVALIDDATA;
680 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
684 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
685 return AVERROR_INVALIDDATA;
687 val = h[2].values[res];
689 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
693 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
694 return AVERROR_INVALIDDATA;
696 val |= h[3].values[res] << 8;
697 pred[1] += sign_extend(val, 16);
698 *samples++ = av_clip_int16(pred[1]);
701 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
705 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
706 return AVERROR_INVALIDDATA;
708 val = h[0].values[res];
710 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
714 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
715 return AVERROR_INVALIDDATA;
717 val |= h[1].values[res] << 8;
718 pred[0] += sign_extend(val, 16);
719 *samples++ = av_clip_int16(pred[0]);
722 } else { //8-bit data
723 for(i = stereo; i >= 0; i--)
724 pred[i] = get_bits(&gb, 8);
725 for(i = 0; i <= stereo; i++)
726 *samples8++ = pred[i];
727 for(; i < unp_size; i++) {
728 if(get_bits_left(&gb)<0)
729 return AVERROR_INVALIDDATA;
732 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
736 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
737 return AVERROR_INVALIDDATA;
739 pred[1] += sign_extend(h[1].values[res], 8);
740 *samples8++ = av_clip_uint8(pred[1]);
743 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
747 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
748 return AVERROR_INVALIDDATA;
750 pred[0] += sign_extend(h[0].values[res], 8);
751 *samples8++ = av_clip_uint8(pred[0]);
756 for(i = 0; i < 4; i++) {
758 ff_free_vlc(&vlc[i]);
760 av_free(h[i].lengths);
761 av_free(h[i].values);
765 *(AVFrame *)data = s->frame;
770 AVCodec ff_smacker_decoder = {
772 .type = AVMEDIA_TYPE_VIDEO,
773 .id = AV_CODEC_ID_SMACKVIDEO,
774 .priv_data_size = sizeof(SmackVContext),
777 .decode = decode_frame,
778 .capabilities = CODEC_CAP_DR1,
779 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
782 AVCodec ff_smackaud_decoder = {
784 .type = AVMEDIA_TYPE_AUDIO,
785 .id = AV_CODEC_ID_SMACKAUDIO,
786 .priv_data_size = sizeof(SmackerAudioContext),
787 .init = smka_decode_init,
788 .decode = smka_decode_frame,
789 .capabilities = CODEC_CAP_DR1,
790 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),