3 * Copyright (c) 2009 Konstantin Shishkov
4 * Copyright (C) 2011 Peter Ross <pross@xvid.org>
6 * This file is part of Libav.
8 * Libav is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * Libav is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with Libav; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include "libavutil/imgutils.h"
24 #include "libavutil/internal.h"
32 #define BITSTREAM_READER_LE
35 #define BINK_FLAG_ALPHA 0x00100000
36 #define BINK_FLAG_GRAY 0x00020000
38 static VLC bink_trees[16];
41 * IDs for different data types used in old version of Bink video codec
44 BINKB_SRC_BLOCK_TYPES = 0, ///< 8x8 block types
45 BINKB_SRC_COLORS, ///< pixel values used for different block types
46 BINKB_SRC_PATTERN, ///< 8-bit values for 2-colour pattern fill
47 BINKB_SRC_X_OFF, ///< X components of motion value
48 BINKB_SRC_Y_OFF, ///< Y components of motion value
49 BINKB_SRC_INTRA_DC, ///< DC values for intrablocks with DCT
50 BINKB_SRC_INTER_DC, ///< DC values for interblocks with DCT
51 BINKB_SRC_INTRA_Q, ///< quantizer values for intrablocks with DCT
52 BINKB_SRC_INTER_Q, ///< quantizer values for interblocks with DCT
53 BINKB_SRC_INTER_COEFS, ///< number of coefficients for residue blocks
58 static const int binkb_bundle_sizes[BINKB_NB_SRC] = {
59 4, 8, 8, 5, 5, 11, 11, 4, 4, 7
62 static const int binkb_bundle_signed[BINKB_NB_SRC] = {
63 0, 0, 0, 1, 1, 0, 1, 0, 0, 0
66 static int32_t binkb_intra_quant[16][64];
67 static int32_t binkb_inter_quant[16][64];
70 * IDs for different data types used in Bink video codec
73 BINK_SRC_BLOCK_TYPES = 0, ///< 8x8 block types
74 BINK_SRC_SUB_BLOCK_TYPES, ///< 16x16 block types (a subset of 8x8 block types)
75 BINK_SRC_COLORS, ///< pixel values used for different block types
76 BINK_SRC_PATTERN, ///< 8-bit values for 2-colour pattern fill
77 BINK_SRC_X_OFF, ///< X components of motion value
78 BINK_SRC_Y_OFF, ///< Y components of motion value
79 BINK_SRC_INTRA_DC, ///< DC values for intrablocks with DCT
80 BINK_SRC_INTER_DC, ///< DC values for interblocks with DCT
81 BINK_SRC_RUN, ///< run lengths for special fill block
87 * data needed to decode 4-bit Huffman-coded value
90 int vlc_num; ///< tree number (in bink_trees[])
91 uint8_t syms[16]; ///< leaf value to symbol mapping
94 #define GET_HUFF(gb, tree) (tree).syms[get_vlc2(gb, bink_trees[(tree).vlc_num].table,\
95 bink_trees[(tree).vlc_num].bits, 1)]
98 * data structure used for decoding single Bink data type
100 typedef struct Bundle {
101 int len; ///< length of number of entries to decode (in bits)
102 Tree tree; ///< Huffman tree-related data
103 uint8_t *data; ///< buffer for decoded symbols
104 uint8_t *data_end; ///< buffer end
105 uint8_t *cur_dec; ///< pointer to the not yet decoded part of the buffer
106 uint8_t *cur_ptr; ///< pointer to the data that is not read from buffer yet
112 typedef struct BinkContext {
113 AVCodecContext *avctx;
117 int version; ///< internal Bink file version
121 Bundle bundle[BINKB_NB_SRC]; ///< bundles for decoding all data types
122 Tree col_high[16]; ///< trees for decoding high nibble in "colours" data type
123 int col_lastval; ///< value of last decoded high nibble in "colours" data type
127 * Bink video block types
130 SKIP_BLOCK = 0, ///< skipped block
131 SCALED_BLOCK, ///< block has size 16x16
132 MOTION_BLOCK, ///< block is copied from previous frame with some offset
133 RUN_BLOCK, ///< block is composed from runs of colours with custom scan order
134 RESIDUE_BLOCK, ///< motion block with some difference added
135 INTRA_BLOCK, ///< intra DCT block
136 FILL_BLOCK, ///< block is filled with single colour
137 INTER_BLOCK, ///< motion block with DCT applied to the difference
138 PATTERN_BLOCK, ///< block is filled with two colours following custom pattern
139 RAW_BLOCK, ///< uncoded 8x8 block
143 * Initialize length length in all bundles.
145 * @param c decoder context
146 * @param width plane width
147 * @param bw plane width in 8x8 blocks
149 static void init_lengths(BinkContext *c, int width, int bw)
151 width = FFALIGN(width, 8);
153 c->bundle[BINK_SRC_BLOCK_TYPES].len = av_log2((width >> 3) + 511) + 1;
155 c->bundle[BINK_SRC_SUB_BLOCK_TYPES].len = av_log2((width >> 4) + 511) + 1;
157 c->bundle[BINK_SRC_COLORS].len = av_log2(bw*64 + 511) + 1;
159 c->bundle[BINK_SRC_INTRA_DC].len =
160 c->bundle[BINK_SRC_INTER_DC].len =
161 c->bundle[BINK_SRC_X_OFF].len =
162 c->bundle[BINK_SRC_Y_OFF].len = av_log2((width >> 3) + 511) + 1;
164 c->bundle[BINK_SRC_PATTERN].len = av_log2((bw << 3) + 511) + 1;
166 c->bundle[BINK_SRC_RUN].len = av_log2(bw*48 + 511) + 1;
170 * Allocate memory for bundles.
172 * @param c decoder context
174 static av_cold void init_bundles(BinkContext *c)
179 bw = (c->avctx->width + 7) >> 3;
180 bh = (c->avctx->height + 7) >> 3;
183 for (i = 0; i < BINKB_NB_SRC; i++) {
184 c->bundle[i].data = av_malloc(blocks * 64);
185 c->bundle[i].data_end = c->bundle[i].data + blocks * 64;
190 * Free memory used by bundles.
192 * @param c decoder context
194 static av_cold void free_bundles(BinkContext *c)
197 for (i = 0; i < BINKB_NB_SRC; i++)
198 av_freep(&c->bundle[i].data);
202 * Merge two consequent lists of equal size depending on bits read.
204 * @param gb context for reading bits
205 * @param dst buffer where merged list will be written to
206 * @param src pointer to the head of the first list (the second lists starts at src+size)
207 * @param size input lists size
209 static void merge(GetBitContext *gb, uint8_t *dst, uint8_t *src, int size)
211 uint8_t *src2 = src + size;
215 if (!get_bits1(gb)) {
222 } while (size && size2);
231 * Read information about Huffman tree used to decode data.
233 * @param gb context for reading bits
234 * @param tree pointer for storing tree data
236 static void read_tree(GetBitContext *gb, Tree *tree)
238 uint8_t tmp1[16] = { 0 }, tmp2[16], *in = tmp1, *out = tmp2;
241 tree->vlc_num = get_bits(gb, 4);
242 if (!tree->vlc_num) {
243 for (i = 0; i < 16; i++)
248 len = get_bits(gb, 3);
249 for (i = 0; i <= len; i++) {
250 tree->syms[i] = get_bits(gb, 4);
251 tmp1[tree->syms[i]] = 1;
253 for (i = 0; i < 16 && len < 16 - 1; i++)
255 tree->syms[++len] = i;
257 len = get_bits(gb, 2);
258 for (i = 0; i < 16; i++)
260 for (i = 0; i <= len; i++) {
262 for (t = 0; t < 16; t += size << 1)
263 merge(gb, out + t, in + t, size);
264 FFSWAP(uint8_t*, in, out);
266 memcpy(tree->syms, in, 16);
271 * Prepare bundle for decoding data.
273 * @param gb context for reading bits
274 * @param c decoder context
275 * @param bundle_num number of the bundle to initialize
277 static void read_bundle(GetBitContext *gb, BinkContext *c, int bundle_num)
281 if (bundle_num == BINK_SRC_COLORS) {
282 for (i = 0; i < 16; i++)
283 read_tree(gb, &c->col_high[i]);
286 if (bundle_num != BINK_SRC_INTRA_DC && bundle_num != BINK_SRC_INTER_DC)
287 read_tree(gb, &c->bundle[bundle_num].tree);
288 c->bundle[bundle_num].cur_dec =
289 c->bundle[bundle_num].cur_ptr = c->bundle[bundle_num].data;
293 * common check before starting decoding bundle data
295 * @param gb context for reading bits
297 * @param t variable where number of elements to decode will be stored
299 #define CHECK_READ_VAL(gb, b, t) \
300 if (!b->cur_dec || (b->cur_dec > b->cur_ptr)) \
302 t = get_bits(gb, b->len); \
308 static int read_runs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
311 const uint8_t *dec_end;
313 CHECK_READ_VAL(gb, b, t);
314 dec_end = b->cur_dec + t;
315 if (dec_end > b->data_end) {
316 av_log(avctx, AV_LOG_ERROR, "Run value went out of bounds\n");
317 return AVERROR_INVALIDDATA;
321 memset(b->cur_dec, v, t);
324 while (b->cur_dec < dec_end)
325 *b->cur_dec++ = GET_HUFF(gb, b->tree);
330 static int read_motion_values(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
333 const uint8_t *dec_end;
335 CHECK_READ_VAL(gb, b, t);
336 dec_end = b->cur_dec + t;
337 if (dec_end > b->data_end) {
338 av_log(avctx, AV_LOG_ERROR, "Too many motion values\n");
339 return AVERROR_INVALIDDATA;
344 sign = -get_bits1(gb);
345 v = (v ^ sign) - sign;
347 memset(b->cur_dec, v, t);
350 while (b->cur_dec < dec_end) {
351 v = GET_HUFF(gb, b->tree);
353 sign = -get_bits1(gb);
354 v = (v ^ sign) - sign;
362 static const uint8_t bink_rlelens[4] = { 4, 8, 12, 32 };
364 static int read_block_types(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
368 const uint8_t *dec_end;
370 CHECK_READ_VAL(gb, b, t);
371 dec_end = b->cur_dec + t;
372 if (dec_end > b->data_end) {
373 av_log(avctx, AV_LOG_ERROR, "Too many block type values\n");
374 return AVERROR_INVALIDDATA;
378 memset(b->cur_dec, v, t);
381 while (b->cur_dec < dec_end) {
382 v = GET_HUFF(gb, b->tree);
387 int run = bink_rlelens[v - 12];
389 if (dec_end - b->cur_dec < run)
390 return AVERROR_INVALIDDATA;
391 memset(b->cur_dec, last, run);
399 static int read_patterns(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
402 const uint8_t *dec_end;
404 CHECK_READ_VAL(gb, b, t);
405 dec_end = b->cur_dec + t;
406 if (dec_end > b->data_end) {
407 av_log(avctx, AV_LOG_ERROR, "Too many pattern values\n");
408 return AVERROR_INVALIDDATA;
410 while (b->cur_dec < dec_end) {
411 v = GET_HUFF(gb, b->tree);
412 v |= GET_HUFF(gb, b->tree) << 4;
419 static int read_colors(GetBitContext *gb, Bundle *b, BinkContext *c)
422 const uint8_t *dec_end;
424 CHECK_READ_VAL(gb, b, t);
425 dec_end = b->cur_dec + t;
426 if (dec_end > b->data_end) {
427 av_log(c->avctx, AV_LOG_ERROR, "Too many color values\n");
428 return AVERROR_INVALIDDATA;
431 c->col_lastval = GET_HUFF(gb, c->col_high[c->col_lastval]);
432 v = GET_HUFF(gb, b->tree);
433 v = (c->col_lastval << 4) | v;
434 if (c->version < 'i') {
435 sign = ((int8_t) v) >> 7;
436 v = ((v & 0x7F) ^ sign) - sign;
439 memset(b->cur_dec, v, t);
442 while (b->cur_dec < dec_end) {
443 c->col_lastval = GET_HUFF(gb, c->col_high[c->col_lastval]);
444 v = GET_HUFF(gb, b->tree);
445 v = (c->col_lastval << 4) | v;
446 if (c->version < 'i') {
447 sign = ((int8_t) v) >> 7;
448 v = ((v & 0x7F) ^ sign) - sign;
457 /** number of bits used to store first DC value in bundle */
458 #define DC_START_BITS 11
460 static int read_dcs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b,
461 int start_bits, int has_sign)
463 int i, j, len, len2, bsize, sign, v, v2;
464 int16_t *dst = (int16_t*)b->cur_dec;
465 int16_t *dst_end = (int16_t*)b->data_end;
467 CHECK_READ_VAL(gb, b, len);
468 v = get_bits(gb, start_bits - has_sign);
470 sign = -get_bits1(gb);
471 v = (v ^ sign) - sign;
473 if (dst_end - dst < 1)
474 return AVERROR_INVALIDDATA;
477 for (i = 0; i < len; i += 8) {
478 len2 = FFMIN(len - i, 8);
479 if (dst_end - dst < len2)
480 return AVERROR_INVALIDDATA;
481 bsize = get_bits(gb, 4);
483 for (j = 0; j < len2; j++) {
484 v2 = get_bits(gb, bsize);
486 sign = -get_bits1(gb);
487 v2 = (v2 ^ sign) - sign;
491 if (v < -32768 || v > 32767) {
492 av_log(avctx, AV_LOG_ERROR, "DC value went out of bounds: %d\n", v);
493 return AVERROR_INVALIDDATA;
497 for (j = 0; j < len2; j++)
502 b->cur_dec = (uint8_t*)dst;
507 * Retrieve next value from bundle.
509 * @param c decoder context
510 * @param bundle bundle number
512 static inline int get_value(BinkContext *c, int bundle)
516 if (bundle < BINK_SRC_X_OFF || bundle == BINK_SRC_RUN)
517 return *c->bundle[bundle].cur_ptr++;
518 if (bundle == BINK_SRC_X_OFF || bundle == BINK_SRC_Y_OFF)
519 return (int8_t)*c->bundle[bundle].cur_ptr++;
520 ret = *(int16_t*)c->bundle[bundle].cur_ptr;
521 c->bundle[bundle].cur_ptr += 2;
525 static void binkb_init_bundle(BinkContext *c, int bundle_num)
527 c->bundle[bundle_num].cur_dec =
528 c->bundle[bundle_num].cur_ptr = c->bundle[bundle_num].data;
529 c->bundle[bundle_num].len = 13;
532 static void binkb_init_bundles(BinkContext *c)
535 for (i = 0; i < BINKB_NB_SRC; i++)
536 binkb_init_bundle(c, i);
539 static int binkb_read_bundle(BinkContext *c, GetBitContext *gb, int bundle_num)
541 const int bits = binkb_bundle_sizes[bundle_num];
542 const int mask = 1 << (bits - 1);
543 const int issigned = binkb_bundle_signed[bundle_num];
544 Bundle *b = &c->bundle[bundle_num];
547 CHECK_READ_VAL(gb, b, len);
548 if (b->data_end - b->cur_dec < len * (1 + (bits > 8)))
549 return AVERROR_INVALIDDATA;
552 for (i = 0; i < len; i++)
553 *b->cur_dec++ = get_bits(gb, bits);
555 for (i = 0; i < len; i++)
556 *b->cur_dec++ = get_bits(gb, bits) - mask;
559 int16_t *dst = (int16_t*)b->cur_dec;
562 for (i = 0; i < len; i++)
563 *dst++ = get_bits(gb, bits);
565 for (i = 0; i < len; i++)
566 *dst++ = get_bits(gb, bits) - mask;
568 b->cur_dec = (uint8_t*)dst;
573 static inline int binkb_get_value(BinkContext *c, int bundle_num)
576 const int bits = binkb_bundle_sizes[bundle_num];
579 int val = *c->bundle[bundle_num].cur_ptr++;
580 return binkb_bundle_signed[bundle_num] ? (int8_t)val : val;
582 ret = *(int16_t*)c->bundle[bundle_num].cur_ptr;
583 c->bundle[bundle_num].cur_ptr += 2;
588 * Read 8x8 block of DCT coefficients.
590 * @param gb context for reading bits
591 * @param block place for storing coefficients
592 * @param scan scan order table
593 * @param quant_matrices quantization matrices
594 * @return 0 for success, negative value in other cases
596 static int read_dct_coeffs(GetBitContext *gb, int32_t block[64], const uint8_t *scan,
597 const int32_t quant_matrices[16][64], int q)
601 int i, t, bits, ccoef, mode, sign;
602 int list_start = 64, list_end = 64, list_pos;
606 const int32_t *quant;
608 coef_list[list_end] = 4; mode_list[list_end++] = 0;
609 coef_list[list_end] = 24; mode_list[list_end++] = 0;
610 coef_list[list_end] = 44; mode_list[list_end++] = 0;
611 coef_list[list_end] = 1; mode_list[list_end++] = 3;
612 coef_list[list_end] = 2; mode_list[list_end++] = 3;
613 coef_list[list_end] = 3; mode_list[list_end++] = 3;
615 for (bits = get_bits(gb, 4) - 1; bits >= 0; bits--) {
616 list_pos = list_start;
617 while (list_pos < list_end) {
618 if (!(mode_list[list_pos] | coef_list[list_pos]) || !get_bits1(gb)) {
622 ccoef = coef_list[list_pos];
623 mode = mode_list[list_pos];
626 coef_list[list_pos] = ccoef + 4;
627 mode_list[list_pos] = 1;
630 coef_list[list_pos] = 0;
631 mode_list[list_pos++] = 0;
633 for (i = 0; i < 4; i++, ccoef++) {
635 coef_list[--list_start] = ccoef;
636 mode_list[ list_start] = 3;
639 t = 1 - (get_bits1(gb) << 1);
641 t = get_bits(gb, bits) | 1 << bits;
642 sign = -get_bits1(gb);
643 t = (t ^ sign) - sign;
645 block[scan[ccoef]] = t;
646 coef_idx[coef_count++] = ccoef;
651 mode_list[list_pos] = 2;
652 for (i = 0; i < 3; i++) {
654 coef_list[list_end] = ccoef;
655 mode_list[list_end++] = 2;
660 t = 1 - (get_bits1(gb) << 1);
662 t = get_bits(gb, bits) | 1 << bits;
663 sign = -get_bits1(gb);
664 t = (t ^ sign) - sign;
666 block[scan[ccoef]] = t;
667 coef_idx[coef_count++] = ccoef;
668 coef_list[list_pos] = 0;
669 mode_list[list_pos++] = 0;
676 quant_idx = get_bits(gb, 4);
681 quant = quant_matrices[quant_idx];
683 block[0] = (block[0] * quant[0]) >> 11;
684 for (i = 0; i < coef_count; i++) {
685 int idx = coef_idx[i];
686 block[scan[idx]] = (block[scan[idx]] * quant[idx]) >> 11;
693 * Read 8x8 block with residue after motion compensation.
695 * @param gb context for reading bits
696 * @param block place to store read data
697 * @param masks_count number of masks to decode
698 * @return 0 on success, negative value in other cases
700 static int read_residue(GetBitContext *gb, int16_t block[64], int masks_count)
704 int i, sign, mask, ccoef, mode;
705 int list_start = 64, list_end = 64, list_pos;
707 int nz_coeff_count = 0;
709 coef_list[list_end] = 4; mode_list[list_end++] = 0;
710 coef_list[list_end] = 24; mode_list[list_end++] = 0;
711 coef_list[list_end] = 44; mode_list[list_end++] = 0;
712 coef_list[list_end] = 0; mode_list[list_end++] = 2;
714 for (mask = 1 << get_bits(gb, 3); mask; mask >>= 1) {
715 for (i = 0; i < nz_coeff_count; i++) {
718 if (block[nz_coeff[i]] < 0)
719 block[nz_coeff[i]] -= mask;
721 block[nz_coeff[i]] += mask;
726 list_pos = list_start;
727 while (list_pos < list_end) {
728 if (!(coef_list[list_pos] | mode_list[list_pos]) || !get_bits1(gb)) {
732 ccoef = coef_list[list_pos];
733 mode = mode_list[list_pos];
736 coef_list[list_pos] = ccoef + 4;
737 mode_list[list_pos] = 1;
740 coef_list[list_pos] = 0;
741 mode_list[list_pos++] = 0;
743 for (i = 0; i < 4; i++, ccoef++) {
745 coef_list[--list_start] = ccoef;
746 mode_list[ list_start] = 3;
748 nz_coeff[nz_coeff_count++] = bink_scan[ccoef];
749 sign = -get_bits1(gb);
750 block[bink_scan[ccoef]] = (mask ^ sign) - sign;
758 mode_list[list_pos] = 2;
759 for (i = 0; i < 3; i++) {
761 coef_list[list_end] = ccoef;
762 mode_list[list_end++] = 2;
766 nz_coeff[nz_coeff_count++] = bink_scan[ccoef];
767 sign = -get_bits1(gb);
768 block[bink_scan[ccoef]] = (mask ^ sign) - sign;
769 coef_list[list_pos] = 0;
770 mode_list[list_pos++] = 0;
783 * Copy 8x8 block from source to destination, where src and dst may be overlapped
785 static inline void put_pixels8x8_overlapped(uint8_t *dst, uint8_t *src, int stride)
789 for (i = 0; i < 8; i++)
790 memcpy(tmp + i*8, src + i*stride, 8);
791 for (i = 0; i < 8; i++)
792 memcpy(dst + i*stride, tmp + i*8, 8);
795 static int binkb_decode_plane(BinkContext *c, AVFrame *frame, GetBitContext *gb,
796 int plane_idx, int is_key, int is_chroma)
800 uint8_t *dst, *ref, *ref_start, *ref_end;
804 LOCAL_ALIGNED_16(int16_t, block, [64]);
805 LOCAL_ALIGNED_16(int32_t, dctblock, [64]);
807 int ybias = is_key ? -15 : 0;
810 const int stride = frame->linesize[plane_idx];
811 int bw = is_chroma ? (c->avctx->width + 15) >> 4 : (c->avctx->width + 7) >> 3;
812 int bh = is_chroma ? (c->avctx->height + 15) >> 4 : (c->avctx->height + 7) >> 3;
814 binkb_init_bundles(c);
815 ref_start = frame->data[plane_idx];
816 ref_end = frame->data[plane_idx] + (bh * frame->linesize[plane_idx] + bw) * 8;
818 for (i = 0; i < 64; i++)
819 coordmap[i] = (i & 7) + (i >> 3) * stride;
821 for (by = 0; by < bh; by++) {
822 for (i = 0; i < BINKB_NB_SRC; i++) {
823 if ((ret = binkb_read_bundle(c, gb, i)) < 0)
827 dst = frame->data[plane_idx] + 8*by*stride;
828 for (bx = 0; bx < bw; bx++, dst += 8) {
829 blk = binkb_get_value(c, BINKB_SRC_BLOCK_TYPES);
834 scan = bink_patterns[get_bits(gb, 4)];
839 mode = get_bits1(gb);
840 run = get_bits(gb, binkb_runbits[i]) + 1;
844 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
845 return AVERROR_INVALIDDATA;
848 v = binkb_get_value(c, BINKB_SRC_COLORS);
849 for (j = 0; j < run; j++)
850 dst[coordmap[*scan++]] = v;
852 for (j = 0; j < run; j++)
853 dst[coordmap[*scan++]] = binkb_get_value(c, BINKB_SRC_COLORS);
857 dst[coordmap[*scan++]] = binkb_get_value(c, BINKB_SRC_COLORS);
860 memset(dctblock, 0, sizeof(*dctblock) * 64);
861 dctblock[0] = binkb_get_value(c, BINKB_SRC_INTRA_DC);
862 qp = binkb_get_value(c, BINKB_SRC_INTRA_Q);
863 read_dct_coeffs(gb, dctblock, bink_scan, binkb_intra_quant, qp);
864 c->bdsp.idct_put(dst, stride, dctblock);
867 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
868 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
869 ref = dst + xoff + yoff * stride;
870 if (ref < ref_start || ref + 8*stride > ref_end) {
871 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
872 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
873 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
875 put_pixels8x8_overlapped(dst, ref, stride);
877 c->dsp.clear_block(block);
878 v = binkb_get_value(c, BINKB_SRC_INTER_COEFS);
879 read_residue(gb, block, v);
880 c->dsp.add_pixels8(dst, block, stride);
883 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
884 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
885 ref = dst + xoff + yoff * stride;
886 if (ref < ref_start || ref + 8 * stride > ref_end) {
887 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
888 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
889 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
891 put_pixels8x8_overlapped(dst, ref, stride);
893 memset(dctblock, 0, sizeof(*dctblock) * 64);
894 dctblock[0] = binkb_get_value(c, BINKB_SRC_INTER_DC);
895 qp = binkb_get_value(c, BINKB_SRC_INTER_Q);
896 read_dct_coeffs(gb, dctblock, bink_scan, binkb_inter_quant, qp);
897 c->bdsp.idct_add(dst, stride, dctblock);
900 v = binkb_get_value(c, BINKB_SRC_COLORS);
901 c->dsp.fill_block_tab[1](dst, v, stride, 8);
904 for (i = 0; i < 2; i++)
905 col[i] = binkb_get_value(c, BINKB_SRC_COLORS);
906 for (i = 0; i < 8; i++) {
907 v = binkb_get_value(c, BINKB_SRC_PATTERN);
908 for (j = 0; j < 8; j++, v >>= 1)
909 dst[i*stride + j] = col[v & 1];
913 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
914 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
915 ref = dst + xoff + yoff * stride;
916 if (ref < ref_start || ref + 8 * stride > ref_end) {
917 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
918 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
919 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
921 put_pixels8x8_overlapped(dst, ref, stride);
925 for (i = 0; i < 8; i++)
926 memcpy(dst + i*stride, c->bundle[BINKB_SRC_COLORS].cur_ptr + i*8, 8);
927 c->bundle[BINKB_SRC_COLORS].cur_ptr += 64;
930 av_log(c->avctx, AV_LOG_ERROR, "Unknown block type %d\n", blk);
931 return AVERROR_INVALIDDATA;
935 if (get_bits_count(gb) & 0x1F) //next plane data starts at 32-bit boundary
936 skip_bits_long(gb, 32 - (get_bits_count(gb) & 0x1F));
941 static int bink_decode_plane(BinkContext *c, AVFrame *frame, GetBitContext *gb,
942 int plane_idx, int is_chroma)
946 uint8_t *dst, *prev, *ref, *ref_start, *ref_end;
950 LOCAL_ALIGNED_16(int16_t, block, [64]);
951 LOCAL_ALIGNED_16(uint8_t, ublock, [64]);
952 LOCAL_ALIGNED_16(int32_t, dctblock, [64]);
955 const int stride = frame->linesize[plane_idx];
956 int bw = is_chroma ? (c->avctx->width + 15) >> 4 : (c->avctx->width + 7) >> 3;
957 int bh = is_chroma ? (c->avctx->height + 15) >> 4 : (c->avctx->height + 7) >> 3;
958 int width = c->avctx->width >> is_chroma;
960 init_lengths(c, FFMAX(width, 8), bw);
961 for (i = 0; i < BINK_NB_SRC; i++)
962 read_bundle(gb, c, i);
964 ref_start = c->last->data[plane_idx] ? c->last->data[plane_idx]
965 : frame->data[plane_idx];
967 + (bw - 1 + c->last->linesize[plane_idx] * (bh - 1)) * 8;
969 for (i = 0; i < 64; i++)
970 coordmap[i] = (i & 7) + (i >> 3) * stride;
972 for (by = 0; by < bh; by++) {
973 if ((ret = read_block_types(c->avctx, gb, &c->bundle[BINK_SRC_BLOCK_TYPES])) < 0)
975 if ((ret = read_block_types(c->avctx, gb, &c->bundle[BINK_SRC_SUB_BLOCK_TYPES])) < 0)
977 if ((ret = read_colors(gb, &c->bundle[BINK_SRC_COLORS], c)) < 0)
979 if ((ret = read_patterns(c->avctx, gb, &c->bundle[BINK_SRC_PATTERN])) < 0)
981 if ((ret = read_motion_values(c->avctx, gb, &c->bundle[BINK_SRC_X_OFF])) < 0)
983 if ((ret = read_motion_values(c->avctx, gb, &c->bundle[BINK_SRC_Y_OFF])) < 0)
985 if ((ret = read_dcs(c->avctx, gb, &c->bundle[BINK_SRC_INTRA_DC], DC_START_BITS, 0)) < 0)
987 if ((ret = read_dcs(c->avctx, gb, &c->bundle[BINK_SRC_INTER_DC], DC_START_BITS, 1)) < 0)
989 if ((ret = read_runs(c->avctx, gb, &c->bundle[BINK_SRC_RUN])) < 0)
994 dst = frame->data[plane_idx] + 8*by*stride;
995 prev = (c->last->data[plane_idx] ? c->last->data[plane_idx]
996 : frame->data[plane_idx]) + 8*by*stride;
997 for (bx = 0; bx < bw; bx++, dst += 8, prev += 8) {
998 blk = get_value(c, BINK_SRC_BLOCK_TYPES);
999 // 16x16 block type on odd line means part of the already decoded block, so skip it
1000 if ((by & 1) && blk == SCALED_BLOCK) {
1008 c->dsp.put_pixels_tab[1][0](dst, prev, stride, 8);
1011 blk = get_value(c, BINK_SRC_SUB_BLOCK_TYPES);
1014 scan = bink_patterns[get_bits(gb, 4)];
1017 int run = get_value(c, BINK_SRC_RUN) + 1;
1021 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
1022 return AVERROR_INVALIDDATA;
1024 if (get_bits1(gb)) {
1025 v = get_value(c, BINK_SRC_COLORS);
1026 for (j = 0; j < run; j++)
1027 ublock[*scan++] = v;
1029 for (j = 0; j < run; j++)
1030 ublock[*scan++] = get_value(c, BINK_SRC_COLORS);
1034 ublock[*scan++] = get_value(c, BINK_SRC_COLORS);
1037 memset(dctblock, 0, sizeof(*dctblock) * 64);
1038 dctblock[0] = get_value(c, BINK_SRC_INTRA_DC);
1039 read_dct_coeffs(gb, dctblock, bink_scan, bink_intra_quant, -1);
1040 c->bdsp.idct_put(ublock, 8, dctblock);
1043 v = get_value(c, BINK_SRC_COLORS);
1044 c->dsp.fill_block_tab[0](dst, v, stride, 16);
1047 for (i = 0; i < 2; i++)
1048 col[i] = get_value(c, BINK_SRC_COLORS);
1049 for (j = 0; j < 8; j++) {
1050 v = get_value(c, BINK_SRC_PATTERN);
1051 for (i = 0; i < 8; i++, v >>= 1)
1052 ublock[i + j*8] = col[v & 1];
1056 for (j = 0; j < 8; j++)
1057 for (i = 0; i < 8; i++)
1058 ublock[i + j*8] = get_value(c, BINK_SRC_COLORS);
1061 av_log(c->avctx, AV_LOG_ERROR, "Incorrect 16x16 block type %d\n", blk);
1062 return AVERROR_INVALIDDATA;
1064 if (blk != FILL_BLOCK)
1065 c->bdsp.scale_block(ublock, dst, stride);
1071 xoff = get_value(c, BINK_SRC_X_OFF);
1072 yoff = get_value(c, BINK_SRC_Y_OFF);
1073 ref = prev + xoff + yoff * stride;
1074 if (ref < ref_start || ref > ref_end) {
1075 av_log(c->avctx, AV_LOG_ERROR, "Copy out of bounds @%d, %d\n",
1076 bx*8 + xoff, by*8 + yoff);
1077 return AVERROR_INVALIDDATA;
1079 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
1082 scan = bink_patterns[get_bits(gb, 4)];
1085 int run = get_value(c, BINK_SRC_RUN) + 1;
1089 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
1090 return AVERROR_INVALIDDATA;
1092 if (get_bits1(gb)) {
1093 v = get_value(c, BINK_SRC_COLORS);
1094 for (j = 0; j < run; j++)
1095 dst[coordmap[*scan++]] = v;
1097 for (j = 0; j < run; j++)
1098 dst[coordmap[*scan++]] = get_value(c, BINK_SRC_COLORS);
1102 dst[coordmap[*scan++]] = get_value(c, BINK_SRC_COLORS);
1105 xoff = get_value(c, BINK_SRC_X_OFF);
1106 yoff = get_value(c, BINK_SRC_Y_OFF);
1107 ref = prev + xoff + yoff * stride;
1108 if (ref < ref_start || ref > ref_end) {
1109 av_log(c->avctx, AV_LOG_ERROR, "Copy out of bounds @%d, %d\n",
1110 bx*8 + xoff, by*8 + yoff);
1111 return AVERROR_INVALIDDATA;
1113 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
1114 c->dsp.clear_block(block);
1115 v = get_bits(gb, 7);
1116 read_residue(gb, block, v);
1117 c->dsp.add_pixels8(dst, block, stride);
1120 memset(dctblock, 0, sizeof(*dctblock) * 64);
1121 dctblock[0] = get_value(c, BINK_SRC_INTRA_DC);
1122 read_dct_coeffs(gb, dctblock, bink_scan, bink_intra_quant, -1);
1123 c->bdsp.idct_put(dst, stride, dctblock);
1126 v = get_value(c, BINK_SRC_COLORS);
1127 c->dsp.fill_block_tab[1](dst, v, stride, 8);
1130 xoff = get_value(c, BINK_SRC_X_OFF);
1131 yoff = get_value(c, BINK_SRC_Y_OFF);
1132 ref = prev + xoff + yoff * stride;
1133 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
1134 memset(dctblock, 0, sizeof(*dctblock) * 64);
1135 dctblock[0] = get_value(c, BINK_SRC_INTER_DC);
1136 read_dct_coeffs(gb, dctblock, bink_scan, bink_inter_quant, -1);
1137 c->bdsp.idct_add(dst, stride, dctblock);
1140 for (i = 0; i < 2; i++)
1141 col[i] = get_value(c, BINK_SRC_COLORS);
1142 for (i = 0; i < 8; i++) {
1143 v = get_value(c, BINK_SRC_PATTERN);
1144 for (j = 0; j < 8; j++, v >>= 1)
1145 dst[i*stride + j] = col[v & 1];
1149 for (i = 0; i < 8; i++)
1150 memcpy(dst + i*stride, c->bundle[BINK_SRC_COLORS].cur_ptr + i*8, 8);
1151 c->bundle[BINK_SRC_COLORS].cur_ptr += 64;
1154 av_log(c->avctx, AV_LOG_ERROR, "Unknown block type %d\n", blk);
1155 return AVERROR_INVALIDDATA;
1159 if (get_bits_count(gb) & 0x1F) //next plane data starts at 32-bit boundary
1160 skip_bits_long(gb, 32 - (get_bits_count(gb) & 0x1F));
1165 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *pkt)
1167 BinkContext * const c = avctx->priv_data;
1168 AVFrame *frame = data;
1170 int plane, plane_idx, ret;
1171 int bits_count = pkt->size << 3;
1173 if (c->version > 'b') {
1174 if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0) {
1175 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
1179 if ((ret = ff_reget_buffer(avctx, c->last)) < 0) {
1180 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
1183 if ((ret = av_frame_ref(frame, c->last)) < 0)
1187 init_get_bits(&gb, pkt->data, bits_count);
1189 if (c->version >= 'i')
1190 skip_bits_long(&gb, 32);
1191 if ((ret = bink_decode_plane(c, frame, &gb, 3, 0)) < 0)
1194 if (c->version >= 'i')
1195 skip_bits_long(&gb, 32);
1197 for (plane = 0; plane < 3; plane++) {
1198 plane_idx = (!plane || !c->swap_planes) ? plane : (plane ^ 3);
1200 if (c->version > 'b') {
1201 if ((ret = bink_decode_plane(c, frame, &gb, plane_idx, !!plane)) < 0)
1204 if ((ret = binkb_decode_plane(c, frame, &gb, plane_idx,
1205 !avctx->frame_number, !!plane)) < 0)
1208 if (get_bits_count(&gb) >= bits_count)
1213 if (c->version > 'b') {
1214 av_frame_unref(c->last);
1215 if ((ret = av_frame_ref(c->last, frame)) < 0)
1221 /* always report that the buffer was completely consumed */
1226 * Caclulate quantization tables for version b
1228 static av_cold void binkb_calc_quant(void)
1230 uint8_t inv_bink_scan[64];
1234 for (j = 0; j < 8; j++) {
1235 for (i = 0; i < 8; i++) {
1238 s[j*8 + i] = cos(j * M_PI/16.0) * cos(i * M_PI/16.0) * 2.0;
1240 s[j*8 + i] = cos(j * M_PI/16.0) * sqrt(2.0);
1243 s[j*8 + i] = cos(i * M_PI/16.0) * sqrt(2.0);
1249 for (i = 0; i < 64; i++)
1250 inv_bink_scan[bink_scan[i]] = i;
1252 for (j = 0; j < 16; j++) {
1253 for (i = 0; i < 64; i++) {
1254 int k = inv_bink_scan[i];
1256 binkb_intra_quant[j][k] = (1L << 12) * binkb_intra_seed[i] *
1257 binkb_num[j]/binkb_den[j];
1258 binkb_inter_quant[j][k] = (1L << 12) * binkb_inter_seed[i] *
1259 binkb_num[j]/binkb_den[j];
1261 binkb_intra_quant[j][k] = (1L << 12) * binkb_intra_seed[i] * s[i] *
1262 binkb_num[j]/(double)binkb_den[j];
1263 binkb_inter_quant[j][k] = (1L << 12) * binkb_inter_seed[i] * s[i] *
1264 binkb_num[j]/(double)binkb_den[j];
1270 static av_cold int decode_init(AVCodecContext *avctx)
1272 BinkContext * const c = avctx->priv_data;
1273 static VLC_TYPE table[16 * 128][2];
1274 static int binkb_initialised = 0;
1278 c->version = avctx->codec_tag >> 24;
1279 if (avctx->extradata_size < 4) {
1280 av_log(avctx, AV_LOG_ERROR, "Extradata missing or too short\n");
1281 return AVERROR_INVALIDDATA;
1283 flags = AV_RL32(avctx->extradata);
1284 c->has_alpha = flags & BINK_FLAG_ALPHA;
1285 c->swap_planes = c->version >= 'h';
1286 if (!bink_trees[15].table) {
1287 for (i = 0; i < 16; i++) {
1288 const int maxbits = bink_tree_lens[i][15];
1289 bink_trees[i].table = table + i*128;
1290 bink_trees[i].table_allocated = 1 << maxbits;
1291 init_vlc(&bink_trees[i], maxbits, 16,
1292 bink_tree_lens[i], 1, 1,
1293 bink_tree_bits[i], 1, 1, INIT_VLC_USE_NEW_STATIC | INIT_VLC_LE);
1298 c->last = av_frame_alloc();
1300 return AVERROR(ENOMEM);
1302 if ((ret = av_image_check_size(avctx->width, avctx->height, 0, avctx)) < 0)
1305 avctx->pix_fmt = c->has_alpha ? AV_PIX_FMT_YUVA420P : AV_PIX_FMT_YUV420P;
1307 ff_dsputil_init(&c->dsp, avctx);
1308 ff_binkdsp_init(&c->bdsp);
1312 if (c->version == 'b') {
1313 if (!binkb_initialised) {
1315 binkb_initialised = 1;
1322 static av_cold int decode_end(AVCodecContext *avctx)
1324 BinkContext * const c = avctx->priv_data;
1326 av_frame_free(&c->last);
1332 AVCodec ff_bink_decoder = {
1333 .name = "binkvideo",
1334 .type = AVMEDIA_TYPE_VIDEO,
1335 .id = AV_CODEC_ID_BINKVIDEO,
1336 .priv_data_size = sizeof(BinkContext),
1337 .init = decode_init,
1338 .close = decode_end,
1339 .decode = decode_frame,
1340 .long_name = NULL_IF_CONFIG_SMALL("Bink video"),
1341 .capabilities = CODEC_CAP_DR1,