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"
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");
103 if(!get_bits1(gb)){ //Leaf
104 if(hc->current >= 256){
105 av_log(NULL, AV_LOG_ERROR, "Tree size exceeded!\n");
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");
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)
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");
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 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");
218 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
221 smacker_decode_tree(gb, &tmp2, 0, 0);
223 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
224 tmp2.lengths, sizeof(int), sizeof(int),
225 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
227 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
231 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
234 escapes[0] = get_bits(gb, 16);
235 escapes[1] = get_bits(gb, 16);
236 escapes[2] = get_bits(gb, 16);
238 last[0] = last[1] = last[2] = -1;
240 ctx.escapes[0] = escapes[0];
241 ctx.escapes[1] = escapes[1];
242 ctx.escapes[2] = escapes[2];
245 ctx.recode1 = tmp1.values;
246 ctx.recode2 = tmp2.values;
249 huff.length = ((size + 3) >> 2) + 3;
252 huff.values = av_mallocz(huff.length * sizeof(int));
254 if (smacker_decode_bigtree(gb, &huff, &ctx) < 0)
257 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
258 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
259 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
260 if(huff.current > huff.length){
261 ctx.last[0] = ctx.last[1] = ctx.last[2] = 1;
262 av_log(smk->avctx, AV_LOG_ERROR, "bigtree damaged\n");
266 *recodes = huff.values;
269 ff_free_vlc(&vlc[0]);
271 ff_free_vlc(&vlc[1]);
273 av_free(tmp1.lengths);
274 av_free(tmp1.values);
276 av_free(tmp2.lengths);
277 av_free(tmp2.values);
282 static int decode_header_trees(SmackVContext *smk) {
284 int mmap_size, mclr_size, full_size, type_size;
286 mmap_size = AV_RL32(smk->avctx->extradata);
287 mclr_size = AV_RL32(smk->avctx->extradata + 4);
288 full_size = AV_RL32(smk->avctx->extradata + 8);
289 type_size = AV_RL32(smk->avctx->extradata + 12);
291 init_get_bits(&gb, smk->avctx->extradata + 16, (smk->avctx->extradata_size - 16) * 8);
293 if(!get_bits1(&gb)) {
294 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
295 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
296 smk->mmap_tbl[0] = 0;
297 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
299 if (smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size))
302 if(!get_bits1(&gb)) {
303 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
304 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
305 smk->mclr_tbl[0] = 0;
306 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
308 if (smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size))
311 if(!get_bits1(&gb)) {
312 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
313 smk->full_tbl = av_malloc(sizeof(int) * 2);
314 smk->full_tbl[0] = 0;
315 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
317 if (smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size))
320 if(!get_bits1(&gb)) {
321 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
322 smk->type_tbl = av_malloc(sizeof(int) * 2);
323 smk->type_tbl[0] = 0;
324 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
326 if (smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size))
333 static av_always_inline void last_reset(int *recode, int *last) {
334 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
337 /* get code and update history */
338 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
339 register int *table = recode;
342 while(*table & SMK_NODE) {
344 table += (*table) & (~SMK_NODE);
349 if(v != recode[last[0]]) {
350 recode[last[2]] = recode[last[1]];
351 recode[last[1]] = recode[last[0]];
357 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
359 SmackVContext * const smk = avctx->priv_data;
364 int blocks, blk, bw, bh;
369 if (avpkt->size <= 769)
372 smk->pic.reference = 3;
373 smk->pic.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
374 if(avctx->reget_buffer(avctx, &smk->pic) < 0){
375 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
379 /* make the palette available on the way out */
380 pal = (uint32_t*)smk->pic.data[1];
381 bytestream2_init(&gb2, avpkt->data, avpkt->size);
382 flags = bytestream2_get_byteu(&gb2);
383 smk->pic.palette_has_changed = flags & 1;
384 smk->pic.key_frame = !!(flags & 2);
385 if(smk->pic.key_frame)
386 smk->pic.pict_type = AV_PICTURE_TYPE_I;
388 smk->pic.pict_type = AV_PICTURE_TYPE_P;
390 for(i = 0; i < 256; i++)
391 *pal++ = 0xFF << 24 | bytestream2_get_be24u(&gb2);
393 last_reset(smk->mmap_tbl, smk->mmap_last);
394 last_reset(smk->mclr_tbl, smk->mclr_last);
395 last_reset(smk->full_tbl, smk->full_last);
396 last_reset(smk->type_tbl, smk->type_last);
397 init_get_bits(&gb, avpkt->data + 769, (avpkt->size - 769) * 8);
400 bw = avctx->width >> 2;
401 bh = avctx->height >> 2;
403 out = smk->pic.data[0];
404 stride = smk->pic.linesize[0];
405 while(blk < blocks) {
409 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
410 run = block_runs[(type >> 2) & 0x3F];
413 while(run-- && blk < blocks){
416 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
417 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
418 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
421 for(i = 0; i < 4; i++) {
422 if(map & 1) out[0] = hi; else out[0] = lo;
423 if(map & 2) out[1] = hi; else out[1] = lo;
424 if(map & 4) out[2] = hi; else out[2] = lo;
425 if(map & 8) out[3] = hi; else out[3] = lo;
434 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
435 if(get_bits1(&gb)) mode = 1;
436 else if(get_bits1(&gb)) mode = 2;
438 while(run-- && blk < blocks){
439 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
442 for(i = 0; i < 4; i++) {
443 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
445 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
451 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
452 out[0] = out[1] = pix & 0xFF;
453 out[2] = out[3] = pix >> 8;
455 out[0] = out[1] = pix & 0xFF;
456 out[2] = out[3] = pix >> 8;
458 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
459 out[0] = out[1] = pix & 0xFF;
460 out[2] = out[3] = pix >> 8;
462 out[0] = out[1] = pix & 0xFF;
463 out[2] = out[3] = pix >> 8;
467 for(i = 0; i < 2; i++) {
469 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
470 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
484 while(run-- && blk < blocks)
489 while(run-- && blk < blocks){
491 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
492 col = mode * 0x01010101;
493 for(i = 0; i < 4; i++) {
494 *((uint32_t*)out) = col;
504 *data_size = sizeof(AVFrame);
505 *(AVFrame*)data = smk->pic;
507 /* always report that the buffer was completely consumed */
515 * Init smacker decoder
518 static av_cold int decode_init(AVCodecContext *avctx)
520 SmackVContext * const c = avctx->priv_data;
524 avctx->pix_fmt = AV_PIX_FMT_PAL8;
526 avcodec_get_frame_defaults(&c->pic);
528 /* decode huffman trees from extradata */
529 if(avctx->extradata_size < 16){
530 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
534 if (decode_header_trees(c))
544 * Uninit smacker decoder
547 static av_cold int decode_end(AVCodecContext *avctx)
549 SmackVContext * const smk = avctx->priv_data;
551 av_freep(&smk->mmap_tbl);
552 av_freep(&smk->mclr_tbl);
553 av_freep(&smk->full_tbl);
554 av_freep(&smk->type_tbl);
556 if (smk->pic.data[0])
557 avctx->release_buffer(avctx, &smk->pic);
563 typedef struct SmackerAudioContext {
565 } SmackerAudioContext;
567 static av_cold int smka_decode_init(AVCodecContext *avctx)
569 SmackerAudioContext *s = avctx->priv_data;
571 if (avctx->channels < 1 || avctx->channels > 2) {
572 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
573 return AVERROR(EINVAL);
575 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
576 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
578 avcodec_get_frame_defaults(&s->frame);
579 avctx->coded_frame = &s->frame;
585 * Decode Smacker audio data
587 static int smka_decode_frame(AVCodecContext *avctx, void *data,
588 int *got_frame_ptr, AVPacket *avpkt)
590 SmackerAudioContext *s = avctx->priv_data;
591 const uint8_t *buf = avpkt->data;
592 int buf_size = avpkt->size;
594 HuffContext h[4] = { { 0 } };
595 VLC vlc[4] = { { 0 } };
602 int pred[2] = {0, 0};
605 av_log(avctx, AV_LOG_ERROR, "packet is too small\n");
606 return AVERROR(EINVAL);
609 unp_size = AV_RL32(buf);
611 init_get_bits(&gb, buf + 4, (buf_size - 4) * 8);
614 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
618 stereo = get_bits1(&gb);
619 bits = get_bits1(&gb);
620 if (stereo ^ (avctx->channels != 1)) {
621 av_log(avctx, AV_LOG_ERROR, "channels mismatch\n");
622 return AVERROR(EINVAL);
624 if (bits && avctx->sample_fmt == AV_SAMPLE_FMT_U8) {
625 av_log(avctx, AV_LOG_ERROR, "sample format mismatch\n");
626 return AVERROR(EINVAL);
629 /* get output buffer */
630 s->frame.nb_samples = unp_size / (avctx->channels * (bits + 1));
631 if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
632 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
635 samples = (int16_t *)s->frame.data[0];
636 samples8 = s->frame.data[0];
639 for(i = 0; i < (1 << (bits + stereo)); i++) {
643 h[i].bits = av_mallocz(256 * 4);
644 h[i].lengths = av_mallocz(256 * sizeof(int));
645 h[i].values = av_mallocz(256 * sizeof(int));
647 smacker_decode_tree(&gb, &h[i], 0, 0);
649 if(h[i].current > 1) {
650 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
651 h[i].lengths, sizeof(int), sizeof(int),
652 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
654 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
659 if(bits) { //decode 16-bit data
660 for(i = stereo; i >= 0; i--)
661 pred[i] = sign_extend(av_bswap16(get_bits(&gb, 16)), 16);
662 for(i = 0; i <= stereo; i++)
663 *samples++ = pred[i];
664 for(; i < unp_size / 2; i++) {
665 if(get_bits_left(&gb)<0)
669 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
673 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
674 return AVERROR_INVALIDDATA;
676 val = h[2].values[res];
678 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
682 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
683 return AVERROR_INVALIDDATA;
685 val |= h[3].values[res] << 8;
686 pred[1] += sign_extend(val, 16);
687 *samples++ = av_clip_int16(pred[1]);
690 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
694 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
695 return AVERROR_INVALIDDATA;
697 val = h[0].values[res];
699 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
703 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
704 return AVERROR_INVALIDDATA;
706 val |= h[1].values[res] << 8;
707 pred[0] += sign_extend(val, 16);
708 *samples++ = av_clip_int16(pred[0]);
711 } else { //8-bit data
712 for(i = stereo; i >= 0; i--)
713 pred[i] = get_bits(&gb, 8);
714 for(i = 0; i <= stereo; i++)
715 *samples8++ = pred[i];
716 for(; i < unp_size; i++) {
717 if(get_bits_left(&gb)<0)
721 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
725 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
726 return AVERROR_INVALIDDATA;
728 pred[1] += sign_extend(h[1].values[res], 8);
729 *samples8++ = av_clip_uint8(pred[1]);
732 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
736 av_log(avctx, AV_LOG_ERROR, "invalid vlc\n");
737 return AVERROR_INVALIDDATA;
739 pred[0] += sign_extend(h[0].values[res], 8);
740 *samples8++ = av_clip_uint8(pred[0]);
745 for(i = 0; i < 4; i++) {
747 ff_free_vlc(&vlc[i]);
749 av_free(h[i].lengths);
750 av_free(h[i].values);
754 *(AVFrame *)data = s->frame;
759 AVCodec ff_smacker_decoder = {
761 .type = AVMEDIA_TYPE_VIDEO,
762 .id = AV_CODEC_ID_SMACKVIDEO,
763 .priv_data_size = sizeof(SmackVContext),
766 .decode = decode_frame,
767 .capabilities = CODEC_CAP_DR1,
768 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
771 AVCodec ff_smackaud_decoder = {
773 .type = AVMEDIA_TYPE_AUDIO,
774 .id = AV_CODEC_ID_SMACKAUDIO,
775 .priv_data_size = sizeof(SmackerAudioContext),
776 .init = smka_decode_init,
777 .decode = smka_decode_frame,
778 .capabilities = CODEC_CAP_DR1,
779 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),