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 = get_vlc2(gb, ctx->v1->table, SMKTREE_BITS, 3);
138 b1 = get_bits_count(gb) - b1;
139 b2 = get_bits_count(gb);
140 i2 = get_vlc2(gb, ctx->v2->table, SMKTREE_BITS, 3);
141 b2 = get_bits_count(gb) - b2;
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 += smacker_decode_bigtree(gb, hc, ctx);
171 * Store large tree as FFmpeg's vlc codes
173 static int smacker_decode_header_tree(SmackVContext *smk, GetBitContext *gb, int **recodes, int *last, int size)
177 HuffContext tmp1, tmp2;
182 if(size >= UINT_MAX>>4){ // (((size + 3) >> 2) + 3) << 2 must not overflow
183 av_log(smk->avctx, AV_LOG_ERROR, "size too large\n");
190 tmp1.bits = av_mallocz(256 * 4);
191 tmp1.lengths = av_mallocz(256 * sizeof(int));
192 tmp1.values = av_mallocz(256 * sizeof(int));
197 tmp2.bits = av_mallocz(256 * 4);
198 tmp2.lengths = av_mallocz(256 * sizeof(int));
199 tmp2.values = av_mallocz(256 * sizeof(int));
201 memset(&vlc[0], 0, sizeof(VLC));
202 memset(&vlc[1], 0, sizeof(VLC));
205 smacker_decode_tree(gb, &tmp1, 0, 0);
207 res = init_vlc(&vlc[0], SMKTREE_BITS, tmp1.length,
208 tmp1.lengths, sizeof(int), sizeof(int),
209 tmp1.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
211 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
215 av_log(smk->avctx, AV_LOG_ERROR, "Skipping low bytes tree\n");
218 smacker_decode_tree(gb, &tmp2, 0, 0);
220 res = init_vlc(&vlc[1], SMKTREE_BITS, tmp2.length,
221 tmp2.lengths, sizeof(int), sizeof(int),
222 tmp2.bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
224 av_log(smk->avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
228 av_log(smk->avctx, AV_LOG_ERROR, "Skipping high bytes tree\n");
231 escapes[0] = get_bits(gb, 8);
232 escapes[0] |= get_bits(gb, 8) << 8;
233 escapes[1] = get_bits(gb, 8);
234 escapes[1] |= get_bits(gb, 8) << 8;
235 escapes[2] = get_bits(gb, 8);
236 escapes[2] |= get_bits(gb, 8) << 8;
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 smacker_decode_bigtree(gb, &huff, &ctx);
256 if(ctx.last[0] == -1) ctx.last[0] = huff.current++;
257 if(ctx.last[1] == -1) ctx.last[1] = huff.current++;
258 if(ctx.last[2] == -1) ctx.last[2] = huff.current++;
260 *recodes = huff.values;
267 av_free(tmp1.lengths);
268 av_free(tmp1.values);
270 av_free(tmp2.lengths);
271 av_free(tmp2.values);
276 static int decode_header_trees(SmackVContext *smk) {
278 int mmap_size, mclr_size, full_size, type_size;
280 mmap_size = AV_RL32(smk->avctx->extradata);
281 mclr_size = AV_RL32(smk->avctx->extradata + 4);
282 full_size = AV_RL32(smk->avctx->extradata + 8);
283 type_size = AV_RL32(smk->avctx->extradata + 12);
285 init_get_bits(&gb, smk->avctx->extradata + 16, (smk->avctx->extradata_size - 16) * 8);
287 if(!get_bits1(&gb)) {
288 av_log(smk->avctx, AV_LOG_INFO, "Skipping MMAP tree\n");
289 smk->mmap_tbl = av_malloc(sizeof(int) * 2);
290 smk->mmap_tbl[0] = 0;
291 smk->mmap_last[0] = smk->mmap_last[1] = smk->mmap_last[2] = 1;
293 smacker_decode_header_tree(smk, &gb, &smk->mmap_tbl, smk->mmap_last, mmap_size);
295 if(!get_bits1(&gb)) {
296 av_log(smk->avctx, AV_LOG_INFO, "Skipping MCLR tree\n");
297 smk->mclr_tbl = av_malloc(sizeof(int) * 2);
298 smk->mclr_tbl[0] = 0;
299 smk->mclr_last[0] = smk->mclr_last[1] = smk->mclr_last[2] = 1;
301 smacker_decode_header_tree(smk, &gb, &smk->mclr_tbl, smk->mclr_last, mclr_size);
303 if(!get_bits1(&gb)) {
304 av_log(smk->avctx, AV_LOG_INFO, "Skipping FULL tree\n");
305 smk->full_tbl = av_malloc(sizeof(int) * 2);
306 smk->full_tbl[0] = 0;
307 smk->full_last[0] = smk->full_last[1] = smk->full_last[2] = 1;
309 smacker_decode_header_tree(smk, &gb, &smk->full_tbl, smk->full_last, full_size);
311 if(!get_bits1(&gb)) {
312 av_log(smk->avctx, AV_LOG_INFO, "Skipping TYPE tree\n");
313 smk->type_tbl = av_malloc(sizeof(int) * 2);
314 smk->type_tbl[0] = 0;
315 smk->type_last[0] = smk->type_last[1] = smk->type_last[2] = 1;
317 smacker_decode_header_tree(smk, &gb, &smk->type_tbl, smk->type_last, type_size);
323 static av_always_inline void last_reset(int *recode, int *last) {
324 recode[last[0]] = recode[last[1]] = recode[last[2]] = 0;
327 /* get code and update history */
328 static av_always_inline int smk_get_code(GetBitContext *gb, int *recode, int *last) {
329 register int *table = recode;
332 b = get_bits_count(gb);
333 while(*table & SMK_NODE) {
335 table += (*table) & (~SMK_NODE);
339 b = get_bits_count(gb) - b;
341 if(v != recode[last[0]]) {
342 recode[last[2]] = recode[last[1]];
343 recode[last[1]] = recode[last[0]];
349 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
351 const uint8_t *buf = avpkt->data;
352 int buf_size = avpkt->size;
353 SmackVContext * const smk = avctx->priv_data;
357 int blocks, blk, bw, bh;
364 smk->pic.reference = 1;
365 smk->pic.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
366 if(avctx->reget_buffer(avctx, &smk->pic) < 0){
367 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
371 /* make the palette available on the way out */
372 pal = (uint32_t*)smk->pic.data[1];
373 smk->pic.palette_has_changed = buf[0] & 1;
374 smk->pic.key_frame = !!(buf[0] & 2);
375 if(smk->pic.key_frame)
376 smk->pic.pict_type = AV_PICTURE_TYPE_I;
378 smk->pic.pict_type = AV_PICTURE_TYPE_P;
381 for(i = 0; i < 256; i++)
382 *pal++ = bytestream_get_be24(&buf);
385 last_reset(smk->mmap_tbl, smk->mmap_last);
386 last_reset(smk->mclr_tbl, smk->mclr_last);
387 last_reset(smk->full_tbl, smk->full_last);
388 last_reset(smk->type_tbl, smk->type_last);
389 init_get_bits(&gb, buf, buf_size * 8);
392 bw = avctx->width >> 2;
393 bh = avctx->height >> 2;
395 out = smk->pic.data[0];
396 stride = smk->pic.linesize[0];
397 while(blk < blocks) {
401 type = smk_get_code(&gb, smk->type_tbl, smk->type_last);
402 run = block_runs[(type >> 2) & 0x3F];
405 while(run-- && blk < blocks){
408 clr = smk_get_code(&gb, smk->mclr_tbl, smk->mclr_last);
409 map = smk_get_code(&gb, smk->mmap_tbl, smk->mmap_last);
410 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
413 for(i = 0; i < 4; i++) {
414 if(map & 1) out[0] = hi; else out[0] = lo;
415 if(map & 2) out[1] = hi; else out[1] = lo;
416 if(map & 4) out[2] = hi; else out[2] = lo;
417 if(map & 8) out[3] = hi; else out[3] = lo;
426 if(avctx->codec_tag == MKTAG('S', 'M', 'K', '4')) { // In case of Smacker v4 we have three modes
427 if(get_bits1(&gb)) mode = 1;
428 else if(get_bits1(&gb)) mode = 2;
430 while(run-- && blk < blocks){
431 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
434 for(i = 0; i < 4; i++) {
435 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
437 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
443 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
444 out[0] = out[1] = pix & 0xFF;
445 out[2] = out[3] = pix >> 8;
447 out[0] = out[1] = pix & 0xFF;
448 out[2] = out[3] = pix >> 8;
450 pix = smk_get_code(&gb, smk->full_tbl, smk->full_last);
451 out[0] = out[1] = pix & 0xFF;
452 out[2] = out[3] = pix >> 8;
454 out[0] = out[1] = pix & 0xFF;
455 out[2] = out[3] = pix >> 8;
459 for(i = 0; i < 2; i++) {
461 pix2 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
462 pix1 = smk_get_code(&gb, smk->full_tbl, smk->full_last);
476 while(run-- && blk < blocks)
481 while(run-- && blk < blocks){
483 out = smk->pic.data[0] + (blk / bw) * (stride * 4) + (blk % bw) * 4;
484 col = mode * 0x01010101;
485 for(i = 0; i < 4; i++) {
486 *((uint32_t*)out) = col;
496 *data_size = sizeof(AVFrame);
497 *(AVFrame*)data = smk->pic;
499 /* always report that the buffer was completely consumed */
507 * Init smacker decoder
510 static av_cold int decode_init(AVCodecContext *avctx)
512 SmackVContext * const c = avctx->priv_data;
516 avctx->pix_fmt = PIX_FMT_PAL8;
518 avcodec_get_frame_defaults(&c->pic);
520 /* decode huffman trees from extradata */
521 if(avctx->extradata_size < 16){
522 av_log(avctx, AV_LOG_ERROR, "Extradata missing!\n");
526 decode_header_trees(c);
536 * Uninit smacker decoder
539 static av_cold int decode_end(AVCodecContext *avctx)
541 SmackVContext * const smk = avctx->priv_data;
543 av_freep(&smk->mmap_tbl);
544 av_freep(&smk->mclr_tbl);
545 av_freep(&smk->full_tbl);
546 av_freep(&smk->type_tbl);
548 if (smk->pic.data[0])
549 avctx->release_buffer(avctx, &smk->pic);
555 static av_cold int smka_decode_init(AVCodecContext *avctx)
557 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
558 avctx->sample_fmt = avctx->bits_per_coded_sample == 8 ? AV_SAMPLE_FMT_U8 : AV_SAMPLE_FMT_S16;
563 * Decode Smacker audio data
565 static int smka_decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
567 const uint8_t *buf = avpkt->data;
568 int buf_size = avpkt->size;
572 int16_t *samples = data;
573 int8_t *samples8 = data;
578 int pred[2] = {0, 0};
580 unp_size = AV_RL32(buf);
582 init_get_bits(&gb, buf + 4, (buf_size - 4) * 8);
585 av_log(avctx, AV_LOG_INFO, "Sound: no data\n");
589 stereo = get_bits1(&gb);
590 bits = get_bits1(&gb);
591 if (unp_size & 0xC0000000 || unp_size > *data_size) {
592 av_log(avctx, AV_LOG_ERROR, "Frame is too large to fit in buffer\n");
596 memset(vlc, 0, sizeof(VLC) * 4);
597 memset(h, 0, sizeof(HuffContext) * 4);
599 for(i = 0; i < (1 << (bits + stereo)); i++) {
603 h[i].bits = av_mallocz(256 * 4);
604 h[i].lengths = av_mallocz(256 * sizeof(int));
605 h[i].values = av_mallocz(256 * sizeof(int));
607 smacker_decode_tree(&gb, &h[i], 0, 0);
609 if(h[i].current > 1) {
610 res = init_vlc(&vlc[i], SMKTREE_BITS, h[i].length,
611 h[i].lengths, sizeof(int), sizeof(int),
612 h[i].bits, sizeof(uint32_t), sizeof(uint32_t), INIT_VLC_LE);
614 av_log(avctx, AV_LOG_ERROR, "Cannot build VLC table\n");
619 if(bits) { //decode 16-bit data
620 for(i = stereo; i >= 0; i--)
621 pred[i] = av_bswap16(get_bits(&gb, 16));
622 for(i = 0; i < stereo; i++)
623 *samples++ = pred[i];
624 for(i = 0; i < unp_size / 2; i++) {
627 res = get_vlc2(&gb, vlc[2].table, SMKTREE_BITS, 3);
630 val = h[2].values[res];
632 res = get_vlc2(&gb, vlc[3].table, SMKTREE_BITS, 3);
635 val |= h[3].values[res] << 8;
636 pred[1] += (int16_t)val;
637 *samples++ = pred[1];
640 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
643 val = h[0].values[res];
645 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
648 val |= h[1].values[res] << 8;
650 *samples++ = pred[0];
653 } else { //8-bit data
654 for(i = stereo; i >= 0; i--)
655 pred[i] = get_bits(&gb, 8);
656 for(i = 0; i < stereo; i++)
657 *samples8++ = pred[i];
658 for(i = 0; i < unp_size; i++) {
661 res = get_vlc2(&gb, vlc[1].table, SMKTREE_BITS, 3);
664 pred[1] += (int8_t)h[1].values[res];
665 *samples8++ = pred[1];
668 res = get_vlc2(&gb, vlc[0].table, SMKTREE_BITS, 3);
671 pred[0] += (int8_t)h[0].values[res];
672 *samples8++ = pred[0];
677 for(i = 0; i < 4; i++) {
681 av_free(h[i].lengths);
682 av_free(h[i].values);
685 *data_size = unp_size;
689 AVCodec ff_smacker_decoder = {
693 sizeof(SmackVContext),
699 .long_name = NULL_IF_CONFIG_SMALL("Smacker video"),
702 AVCodec ff_smackaud_decoder = {
711 .long_name = NULL_IF_CONFIG_SMALL("Smacker audio"),