3 * Copyright (c) 2009 Konstantin Shishkov
4 * Copyright (C) 2011 Peter Ross <pross@xvid.org>
6 * This file is part of FFmpeg.
8 * FFmpeg 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 * FFmpeg 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 FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include "libavutil/attributes.h"
24 #include "libavutil/imgutils.h"
25 #include "libavutil/internal.h"
27 #define BITSTREAM_READER_LE
37 #define BINK_FLAG_ALPHA 0x00100000
38 #define BINK_FLAG_GRAY 0x00020000
40 static VLC bink_trees[16];
43 * IDs for different data types used in old version of Bink video codec
46 BINKB_SRC_BLOCK_TYPES = 0, ///< 8x8 block types
47 BINKB_SRC_COLORS, ///< pixel values used for different block types
48 BINKB_SRC_PATTERN, ///< 8-bit values for 2-colour pattern fill
49 BINKB_SRC_X_OFF, ///< X components of motion value
50 BINKB_SRC_Y_OFF, ///< Y components of motion value
51 BINKB_SRC_INTRA_DC, ///< DC values for intrablocks with DCT
52 BINKB_SRC_INTER_DC, ///< DC values for interblocks with DCT
53 BINKB_SRC_INTRA_Q, ///< quantizer values for intrablocks with DCT
54 BINKB_SRC_INTER_Q, ///< quantizer values for interblocks with DCT
55 BINKB_SRC_INTER_COEFS, ///< number of coefficients for residue blocks
60 static const int binkb_bundle_sizes[BINKB_NB_SRC] = {
61 4, 8, 8, 5, 5, 11, 11, 4, 4, 7
64 static const int binkb_bundle_signed[BINKB_NB_SRC] = {
65 0, 0, 0, 1, 1, 0, 1, 0, 0, 0
68 static int32_t binkb_intra_quant[16][64];
69 static int32_t binkb_inter_quant[16][64];
72 * IDs for different data types used in Bink video codec
75 BINK_SRC_BLOCK_TYPES = 0, ///< 8x8 block types
76 BINK_SRC_SUB_BLOCK_TYPES, ///< 16x16 block types (a subset of 8x8 block types)
77 BINK_SRC_COLORS, ///< pixel values used for different block types
78 BINK_SRC_PATTERN, ///< 8-bit values for 2-colour pattern fill
79 BINK_SRC_X_OFF, ///< X components of motion value
80 BINK_SRC_Y_OFF, ///< Y components of motion value
81 BINK_SRC_INTRA_DC, ///< DC values for intrablocks with DCT
82 BINK_SRC_INTER_DC, ///< DC values for interblocks with DCT
83 BINK_SRC_RUN, ///< run lengths for special fill block
89 * data needed to decode 4-bit Huffman-coded value
92 int vlc_num; ///< tree number (in bink_trees[])
93 uint8_t syms[16]; ///< leaf value to symbol mapping
96 #define GET_HUFF(gb, tree) (tree).syms[get_vlc2(gb, bink_trees[(tree).vlc_num].table,\
97 bink_trees[(tree).vlc_num].bits, 1)]
100 * data structure used for decoding single Bink data type
102 typedef struct Bundle {
103 int len; ///< length of number of entries to decode (in bits)
104 Tree tree; ///< Huffman tree-related data
105 uint8_t *data; ///< buffer for decoded symbols
106 uint8_t *data_end; ///< buffer end
107 uint8_t *cur_dec; ///< pointer to the not yet decoded part of the buffer
108 uint8_t *cur_ptr; ///< pointer to the data that is not read from buffer yet
114 typedef struct BinkContext {
115 AVCodecContext *avctx;
116 BlockDSPContext bdsp;
117 op_pixels_func put_pixels_tab;
118 BinkDSPContext binkdsp;
120 int version; ///< internal Bink file version
125 Bundle bundle[BINKB_NB_SRC]; ///< bundles for decoding all data types
126 Tree col_high[16]; ///< trees for decoding high nibble in "colours" data type
127 int col_lastval; ///< value of last decoded high nibble in "colours" data type
131 * Bink video block types
134 SKIP_BLOCK = 0, ///< skipped block
135 SCALED_BLOCK, ///< block has size 16x16
136 MOTION_BLOCK, ///< block is copied from previous frame with some offset
137 RUN_BLOCK, ///< block is composed from runs of colours with custom scan order
138 RESIDUE_BLOCK, ///< motion block with some difference added
139 INTRA_BLOCK, ///< intra DCT block
140 FILL_BLOCK, ///< block is filled with single colour
141 INTER_BLOCK, ///< motion block with DCT applied to the difference
142 PATTERN_BLOCK, ///< block is filled with two colours following custom pattern
143 RAW_BLOCK, ///< uncoded 8x8 block
147 * Initialize length in all bundles.
149 * @param c decoder context
150 * @param width plane width
151 * @param bw plane width in 8x8 blocks
153 static void init_lengths(BinkContext *c, int width, int bw)
155 width = FFALIGN(width, 8);
157 c->bundle[BINK_SRC_BLOCK_TYPES].len = av_log2((width >> 3) + 511) + 1;
159 c->bundle[BINK_SRC_SUB_BLOCK_TYPES].len = av_log2((width >> 4) + 511) + 1;
161 c->bundle[BINK_SRC_COLORS].len = av_log2(bw*64 + 511) + 1;
163 c->bundle[BINK_SRC_INTRA_DC].len =
164 c->bundle[BINK_SRC_INTER_DC].len =
165 c->bundle[BINK_SRC_X_OFF].len =
166 c->bundle[BINK_SRC_Y_OFF].len = av_log2((width >> 3) + 511) + 1;
168 c->bundle[BINK_SRC_PATTERN].len = av_log2((bw << 3) + 511) + 1;
170 c->bundle[BINK_SRC_RUN].len = av_log2(bw*48 + 511) + 1;
174 * Allocate memory for bundles.
176 * @param c decoder context
178 static av_cold int init_bundles(BinkContext *c)
184 bw = (c->avctx->width + 7) >> 3;
185 bh = (c->avctx->height + 7) >> 3;
188 tmp = av_calloc(blocks, 64 * BINKB_NB_SRC);
190 return AVERROR(ENOMEM);
191 for (i = 0; i < BINKB_NB_SRC; i++) {
192 c->bundle[i].data = tmp;
194 c->bundle[i].data_end = tmp;
201 * Free memory used by bundles.
203 * @param c decoder context
205 static av_cold void free_bundles(BinkContext *c)
207 av_freep(&c->bundle[0].data);
211 * Merge two consequent lists of equal size depending on bits read.
213 * @param gb context for reading bits
214 * @param dst buffer where merged list will be written to
215 * @param src pointer to the head of the first list (the second lists starts at src+size)
216 * @param size input lists size
218 static void merge(GetBitContext *gb, uint8_t *dst, uint8_t *src, int size)
220 uint8_t *src2 = src + size;
224 if (!get_bits1(gb)) {
231 } while (size && size2);
240 * Read information about Huffman tree used to decode data.
242 * @param gb context for reading bits
243 * @param tree pointer for storing tree data
245 static int read_tree(GetBitContext *gb, Tree *tree)
247 uint8_t tmp1[16] = { 0 }, tmp2[16], *in = tmp1, *out = tmp2;
250 if (get_bits_left(gb) < 4)
251 return AVERROR_INVALIDDATA;
253 tree->vlc_num = get_bits(gb, 4);
254 if (!tree->vlc_num) {
255 for (i = 0; i < 16; i++)
260 len = get_bits(gb, 3);
261 for (i = 0; i <= len; i++) {
262 tree->syms[i] = get_bits(gb, 4);
263 tmp1[tree->syms[i]] = 1;
265 for (i = 0; i < 16 && len < 16 - 1; i++)
267 tree->syms[++len] = i;
269 len = get_bits(gb, 2);
270 for (i = 0; i < 16; i++)
272 for (i = 0; i <= len; i++) {
274 for (t = 0; t < 16; t += size << 1)
275 merge(gb, out + t, in + t, size);
276 FFSWAP(uint8_t*, in, out);
278 memcpy(tree->syms, in, 16);
284 * Prepare bundle for decoding data.
286 * @param gb context for reading bits
287 * @param c decoder context
288 * @param bundle_num number of the bundle to initialize
290 static int read_bundle(GetBitContext *gb, BinkContext *c, int bundle_num)
294 if (bundle_num == BINK_SRC_COLORS) {
295 for (i = 0; i < 16; i++) {
296 int ret = read_tree(gb, &c->col_high[i]);
302 if (bundle_num != BINK_SRC_INTRA_DC && bundle_num != BINK_SRC_INTER_DC) {
303 int ret = read_tree(gb, &c->bundle[bundle_num].tree);
307 c->bundle[bundle_num].cur_dec =
308 c->bundle[bundle_num].cur_ptr = c->bundle[bundle_num].data;
314 * common check before starting decoding bundle data
316 * @param gb context for reading bits
318 * @param t variable where number of elements to decode will be stored
320 #define CHECK_READ_VAL(gb, b, t) \
321 if (!b->cur_dec || (b->cur_dec > b->cur_ptr)) \
323 t = get_bits(gb, b->len); \
329 static int read_runs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
332 const uint8_t *dec_end;
334 CHECK_READ_VAL(gb, b, t);
335 dec_end = b->cur_dec + t;
336 if (dec_end > b->data_end) {
337 av_log(avctx, AV_LOG_ERROR, "Run value went out of bounds\n");
338 return AVERROR_INVALIDDATA;
340 if (get_bits_left(gb) < 1)
341 return AVERROR_INVALIDDATA;
344 memset(b->cur_dec, v, t);
347 while (b->cur_dec < dec_end)
348 *b->cur_dec++ = GET_HUFF(gb, b->tree);
353 static int read_motion_values(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
356 const uint8_t *dec_end;
358 CHECK_READ_VAL(gb, b, t);
359 dec_end = b->cur_dec + t;
360 if (dec_end > b->data_end) {
361 av_log(avctx, AV_LOG_ERROR, "Too many motion values\n");
362 return AVERROR_INVALIDDATA;
364 if (get_bits_left(gb) < 1)
365 return AVERROR_INVALIDDATA;
369 sign = -get_bits1(gb);
370 v = (v ^ sign) - sign;
372 memset(b->cur_dec, v, t);
375 while (b->cur_dec < dec_end) {
376 v = GET_HUFF(gb, b->tree);
378 sign = -get_bits1(gb);
379 v = (v ^ sign) - sign;
387 static const uint8_t bink_rlelens[4] = { 4, 8, 12, 32 };
389 static int read_block_types(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
391 BinkContext * const c = avctx->priv_data;
394 const uint8_t *dec_end;
396 CHECK_READ_VAL(gb, b, t);
397 if (c->version == 'k') {
404 dec_end = b->cur_dec + t;
405 if (dec_end > b->data_end) {
406 av_log(avctx, AV_LOG_ERROR, "Too many block type values\n");
407 return AVERROR_INVALIDDATA;
409 if (get_bits_left(gb) < 1)
410 return AVERROR_INVALIDDATA;
413 memset(b->cur_dec, v, t);
416 while (b->cur_dec < dec_end) {
417 v = GET_HUFF(gb, b->tree);
422 int run = bink_rlelens[v - 12];
424 if (dec_end - b->cur_dec < run)
425 return AVERROR_INVALIDDATA;
426 memset(b->cur_dec, last, run);
434 static int read_patterns(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
437 const uint8_t *dec_end;
439 CHECK_READ_VAL(gb, b, t);
440 dec_end = b->cur_dec + t;
441 if (dec_end > b->data_end) {
442 av_log(avctx, AV_LOG_ERROR, "Too many pattern values\n");
443 return AVERROR_INVALIDDATA;
445 while (b->cur_dec < dec_end) {
446 if (get_bits_left(gb) < 2)
447 return AVERROR_INVALIDDATA;
448 v = GET_HUFF(gb, b->tree);
449 v |= GET_HUFF(gb, b->tree) << 4;
456 static int read_colors(GetBitContext *gb, Bundle *b, BinkContext *c)
459 const uint8_t *dec_end;
461 CHECK_READ_VAL(gb, b, t);
462 dec_end = b->cur_dec + t;
463 if (dec_end > b->data_end) {
464 av_log(c->avctx, AV_LOG_ERROR, "Too many color values\n");
465 return AVERROR_INVALIDDATA;
467 if (get_bits_left(gb) < 1)
468 return AVERROR_INVALIDDATA;
470 c->col_lastval = GET_HUFF(gb, c->col_high[c->col_lastval]);
471 v = GET_HUFF(gb, b->tree);
472 v = (c->col_lastval << 4) | v;
473 if (c->version < 'i') {
474 sign = ((int8_t) v) >> 7;
475 v = ((v & 0x7F) ^ sign) - sign;
478 memset(b->cur_dec, v, t);
481 while (b->cur_dec < dec_end) {
482 if (get_bits_left(gb) < 2)
483 return AVERROR_INVALIDDATA;
484 c->col_lastval = GET_HUFF(gb, c->col_high[c->col_lastval]);
485 v = GET_HUFF(gb, b->tree);
486 v = (c->col_lastval << 4) | v;
487 if (c->version < 'i') {
488 sign = ((int8_t) v) >> 7;
489 v = ((v & 0x7F) ^ sign) - sign;
498 /** number of bits used to store first DC value in bundle */
499 #define DC_START_BITS 11
501 static int read_dcs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b,
502 int start_bits, int has_sign)
504 int i, j, len, len2, bsize, sign, v, v2;
505 int16_t *dst = (int16_t*)b->cur_dec;
506 int16_t *dst_end = (int16_t*)b->data_end;
508 CHECK_READ_VAL(gb, b, len);
509 if (get_bits_left(gb) < start_bits - has_sign)
510 return AVERROR_INVALIDDATA;
511 v = get_bits(gb, start_bits - has_sign);
513 sign = -get_bits1(gb);
514 v = (v ^ sign) - sign;
516 if (dst_end - dst < 1)
517 return AVERROR_INVALIDDATA;
520 for (i = 0; i < len; i += 8) {
521 len2 = FFMIN(len - i, 8);
522 if (dst_end - dst < len2)
523 return AVERROR_INVALIDDATA;
524 bsize = get_bits(gb, 4);
526 for (j = 0; j < len2; j++) {
527 v2 = get_bits(gb, bsize);
529 sign = -get_bits1(gb);
530 v2 = (v2 ^ sign) - sign;
534 if (v < -32768 || v > 32767) {
535 av_log(avctx, AV_LOG_ERROR, "DC value went out of bounds: %d\n", v);
536 return AVERROR_INVALIDDATA;
540 for (j = 0; j < len2; j++)
545 b->cur_dec = (uint8_t*)dst;
550 * Retrieve next value from bundle.
552 * @param c decoder context
553 * @param bundle bundle number
555 static inline int get_value(BinkContext *c, int bundle)
559 if (bundle < BINK_SRC_X_OFF || bundle == BINK_SRC_RUN)
560 return *c->bundle[bundle].cur_ptr++;
561 if (bundle == BINK_SRC_X_OFF || bundle == BINK_SRC_Y_OFF)
562 return (int8_t)*c->bundle[bundle].cur_ptr++;
563 ret = *(int16_t*)c->bundle[bundle].cur_ptr;
564 c->bundle[bundle].cur_ptr += 2;
568 static av_cold void binkb_init_bundle(BinkContext *c, int bundle_num)
570 c->bundle[bundle_num].cur_dec =
571 c->bundle[bundle_num].cur_ptr = c->bundle[bundle_num].data;
572 c->bundle[bundle_num].len = 13;
575 static av_cold void binkb_init_bundles(BinkContext *c)
578 for (i = 0; i < BINKB_NB_SRC; i++)
579 binkb_init_bundle(c, i);
582 static int binkb_read_bundle(BinkContext *c, GetBitContext *gb, int bundle_num)
584 const int bits = binkb_bundle_sizes[bundle_num];
585 const int mask = 1 << (bits - 1);
586 const int issigned = binkb_bundle_signed[bundle_num];
587 Bundle *b = &c->bundle[bundle_num];
590 CHECK_READ_VAL(gb, b, len);
591 if (b->data_end - b->cur_dec < len * (1 + (bits > 8)))
592 return AVERROR_INVALIDDATA;
595 for (i = 0; i < len; i++)
596 *b->cur_dec++ = get_bits(gb, bits);
598 for (i = 0; i < len; i++)
599 *b->cur_dec++ = get_bits(gb, bits) - mask;
602 int16_t *dst = (int16_t*)b->cur_dec;
605 for (i = 0; i < len; i++)
606 *dst++ = get_bits(gb, bits);
608 for (i = 0; i < len; i++)
609 *dst++ = get_bits(gb, bits) - mask;
611 b->cur_dec = (uint8_t*)dst;
616 static inline int binkb_get_value(BinkContext *c, int bundle_num)
619 const int bits = binkb_bundle_sizes[bundle_num];
622 int val = *c->bundle[bundle_num].cur_ptr++;
623 return binkb_bundle_signed[bundle_num] ? (int8_t)val : val;
625 ret = *(int16_t*)c->bundle[bundle_num].cur_ptr;
626 c->bundle[bundle_num].cur_ptr += 2;
631 * Read 8x8 block of DCT coefficients.
633 * @param gb context for reading bits
634 * @param block place for storing coefficients
635 * @param scan scan order table
636 * @param quant_matrices quantization matrices
637 * @return 0 for success, negative value in other cases
639 static int read_dct_coeffs(BinkContext *c, GetBitContext *gb, int32_t block[64],
640 const uint8_t *scan, int *coef_count_,
641 int coef_idx[64], int q)
645 int i, t, bits, ccoef, mode, sign;
646 int list_start = 64, list_end = 64, list_pos;
650 if (get_bits_left(gb) < 4)
651 return AVERROR_INVALIDDATA;
653 coef_list[list_end] = 4; mode_list[list_end++] = 0;
654 coef_list[list_end] = 24; mode_list[list_end++] = 0;
655 coef_list[list_end] = 44; mode_list[list_end++] = 0;
656 coef_list[list_end] = 1; mode_list[list_end++] = 3;
657 coef_list[list_end] = 2; mode_list[list_end++] = 3;
658 coef_list[list_end] = 3; mode_list[list_end++] = 3;
660 for (bits = get_bits(gb, 4) - 1; bits >= 0; bits--) {
661 list_pos = list_start;
662 while (list_pos < list_end) {
663 if (!(mode_list[list_pos] | coef_list[list_pos]) || !get_bits1(gb)) {
667 ccoef = coef_list[list_pos];
668 mode = mode_list[list_pos];
671 coef_list[list_pos] = ccoef + 4;
672 mode_list[list_pos] = 1;
675 coef_list[list_pos] = 0;
676 mode_list[list_pos++] = 0;
678 for (i = 0; i < 4; i++, ccoef++) {
680 coef_list[--list_start] = ccoef;
681 mode_list[ list_start] = 3;
684 t = 1 - (get_bits1(gb) << 1);
686 t = get_bits(gb, bits) | 1 << bits;
687 sign = -get_bits1(gb);
688 t = (t ^ sign) - sign;
690 block[scan[ccoef]] = t;
691 coef_idx[coef_count++] = ccoef;
696 mode_list[list_pos] = 2;
697 for (i = 0; i < 3; i++) {
699 coef_list[list_end] = ccoef;
700 mode_list[list_end++] = 2;
705 t = 1 - (get_bits1(gb) << 1);
707 t = get_bits(gb, bits) | 1 << bits;
708 sign = -get_bits1(gb);
709 t = (t ^ sign) - sign;
711 block[scan[ccoef]] = t;
712 coef_idx[coef_count++] = ccoef;
713 coef_list[list_pos] = 0;
714 mode_list[list_pos++] = 0;
721 quant_idx = get_bits(gb, 4);
724 if (quant_idx > 15U) {
725 av_log(c->avctx, AV_LOG_ERROR, "quant_index %d out of range\n", quant_idx);
726 return AVERROR_INVALIDDATA;
730 *coef_count_ = coef_count;
735 static void unquantize_dct_coeffs(int32_t block[64], const uint32_t quant[64],
736 int coef_count, int coef_idx[64],
740 block[0] = (int)(block[0] * quant[0]) >> 11;
741 for (i = 0; i < coef_count; i++) {
742 int idx = coef_idx[i];
743 block[scan[idx]] = (int)(block[scan[idx]] * quant[idx]) >> 11;
748 * Read 8x8 block with residue after motion compensation.
750 * @param gb context for reading bits
751 * @param block place to store read data
752 * @param masks_count number of masks to decode
753 * @return 0 on success, negative value in other cases
755 static int read_residue(GetBitContext *gb, int16_t block[64], int masks_count)
759 int i, sign, mask, ccoef, mode;
760 int list_start = 64, list_end = 64, list_pos;
762 int nz_coeff_count = 0;
764 coef_list[list_end] = 4; mode_list[list_end++] = 0;
765 coef_list[list_end] = 24; mode_list[list_end++] = 0;
766 coef_list[list_end] = 44; mode_list[list_end++] = 0;
767 coef_list[list_end] = 0; mode_list[list_end++] = 2;
769 for (mask = 1 << get_bits(gb, 3); mask; mask >>= 1) {
770 for (i = 0; i < nz_coeff_count; i++) {
773 if (block[nz_coeff[i]] < 0)
774 block[nz_coeff[i]] -= mask;
776 block[nz_coeff[i]] += mask;
781 list_pos = list_start;
782 while (list_pos < list_end) {
783 if (!(coef_list[list_pos] | mode_list[list_pos]) || !get_bits1(gb)) {
787 ccoef = coef_list[list_pos];
788 mode = mode_list[list_pos];
791 coef_list[list_pos] = ccoef + 4;
792 mode_list[list_pos] = 1;
795 coef_list[list_pos] = 0;
796 mode_list[list_pos++] = 0;
798 for (i = 0; i < 4; i++, ccoef++) {
800 coef_list[--list_start] = ccoef;
801 mode_list[ list_start] = 3;
803 nz_coeff[nz_coeff_count++] = bink_scan[ccoef];
804 sign = -get_bits1(gb);
805 block[bink_scan[ccoef]] = (mask ^ sign) - sign;
813 mode_list[list_pos] = 2;
814 for (i = 0; i < 3; i++) {
816 coef_list[list_end] = ccoef;
817 mode_list[list_end++] = 2;
821 nz_coeff[nz_coeff_count++] = bink_scan[ccoef];
822 sign = -get_bits1(gb);
823 block[bink_scan[ccoef]] = (mask ^ sign) - sign;
824 coef_list[list_pos] = 0;
825 mode_list[list_pos++] = 0;
838 * Copy 8x8 block from source to destination, where src and dst may be overlapped
840 static inline void put_pixels8x8_overlapped(uint8_t *dst, uint8_t *src, int stride)
844 for (i = 0; i < 8; i++)
845 memcpy(tmp + i*8, src + i*stride, 8);
846 for (i = 0; i < 8; i++)
847 memcpy(dst + i*stride, tmp + i*8, 8);
850 static int binkb_decode_plane(BinkContext *c, AVFrame *frame, GetBitContext *gb,
851 int plane_idx, int is_key, int is_chroma)
855 uint8_t *dst, *ref, *ref_start, *ref_end;
859 LOCAL_ALIGNED_32(int16_t, block, [64]);
860 LOCAL_ALIGNED_16(int32_t, dctblock, [64]);
862 int ybias = is_key ? -15 : 0;
863 int qp, quant_idx, coef_count, coef_idx[64];
865 const int stride = frame->linesize[plane_idx];
866 int bw = is_chroma ? (c->avctx->width + 15) >> 4 : (c->avctx->width + 7) >> 3;
867 int bh = is_chroma ? (c->avctx->height + 15) >> 4 : (c->avctx->height + 7) >> 3;
869 binkb_init_bundles(c);
870 ref_start = frame->data[plane_idx];
871 ref_end = frame->data[plane_idx] + (bh * frame->linesize[plane_idx] + bw) * 8;
873 for (i = 0; i < 64; i++)
874 coordmap[i] = (i & 7) + (i >> 3) * stride;
876 for (by = 0; by < bh; by++) {
877 for (i = 0; i < BINKB_NB_SRC; i++) {
878 if ((ret = binkb_read_bundle(c, gb, i)) < 0)
882 dst = frame->data[plane_idx] + 8*by*stride;
883 for (bx = 0; bx < bw; bx++, dst += 8) {
884 blk = binkb_get_value(c, BINKB_SRC_BLOCK_TYPES);
889 scan = bink_patterns[get_bits(gb, 4)];
894 mode = get_bits1(gb);
895 run = get_bits(gb, binkb_runbits[i]) + 1;
899 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
900 return AVERROR_INVALIDDATA;
903 v = binkb_get_value(c, BINKB_SRC_COLORS);
904 for (j = 0; j < run; j++)
905 dst[coordmap[*scan++]] = v;
907 for (j = 0; j < run; j++)
908 dst[coordmap[*scan++]] = binkb_get_value(c, BINKB_SRC_COLORS);
912 dst[coordmap[*scan++]] = binkb_get_value(c, BINKB_SRC_COLORS);
915 memset(dctblock, 0, sizeof(*dctblock) * 64);
916 dctblock[0] = binkb_get_value(c, BINKB_SRC_INTRA_DC);
917 qp = binkb_get_value(c, BINKB_SRC_INTRA_Q);
918 if ((quant_idx = read_dct_coeffs(c, gb, dctblock, bink_scan, &coef_count, coef_idx, qp)) < 0)
920 unquantize_dct_coeffs(dctblock, binkb_intra_quant[quant_idx], coef_count, coef_idx, bink_scan);
921 c->binkdsp.idct_put(dst, stride, dctblock);
924 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
925 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
926 ref = dst + xoff + yoff * stride;
927 if (ref < ref_start || ref + 8*stride > ref_end) {
928 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
929 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
930 c->put_pixels_tab(dst, ref, stride, 8);
932 put_pixels8x8_overlapped(dst, ref, stride);
934 c->bdsp.clear_block(block);
935 v = binkb_get_value(c, BINKB_SRC_INTER_COEFS);
936 read_residue(gb, block, v);
937 c->binkdsp.add_pixels8(dst, block, stride);
940 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
941 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
942 ref = dst + xoff + yoff * stride;
943 if (ref < ref_start || ref + 8 * stride > ref_end) {
944 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
945 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
946 c->put_pixels_tab(dst, ref, stride, 8);
948 put_pixels8x8_overlapped(dst, ref, stride);
950 memset(dctblock, 0, sizeof(*dctblock) * 64);
951 dctblock[0] = binkb_get_value(c, BINKB_SRC_INTER_DC);
952 qp = binkb_get_value(c, BINKB_SRC_INTER_Q);
953 if ((quant_idx = read_dct_coeffs(c, gb, dctblock, bink_scan, &coef_count, coef_idx, qp)) < 0)
955 unquantize_dct_coeffs(dctblock, binkb_inter_quant[quant_idx], coef_count, coef_idx, bink_scan);
956 c->binkdsp.idct_add(dst, stride, dctblock);
959 v = binkb_get_value(c, BINKB_SRC_COLORS);
960 c->bdsp.fill_block_tab[1](dst, v, stride, 8);
963 for (i = 0; i < 2; i++)
964 col[i] = binkb_get_value(c, BINKB_SRC_COLORS);
965 for (i = 0; i < 8; i++) {
966 v = binkb_get_value(c, BINKB_SRC_PATTERN);
967 for (j = 0; j < 8; j++, v >>= 1)
968 dst[i*stride + j] = col[v & 1];
972 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
973 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
974 ref = dst + xoff + yoff * stride;
975 if (ref < ref_start || ref + 8 * stride > ref_end) {
976 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
977 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
978 c->put_pixels_tab(dst, ref, stride, 8);
980 put_pixels8x8_overlapped(dst, ref, stride);
984 for (i = 0; i < 8; i++)
985 memcpy(dst + i*stride, c->bundle[BINKB_SRC_COLORS].cur_ptr + i*8, 8);
986 c->bundle[BINKB_SRC_COLORS].cur_ptr += 64;
989 av_log(c->avctx, AV_LOG_ERROR, "Unknown block type %d\n", blk);
990 return AVERROR_INVALIDDATA;
994 if (get_bits_count(gb) & 0x1F) //next plane data starts at 32-bit boundary
995 skip_bits_long(gb, 32 - (get_bits_count(gb) & 0x1F));
1000 static int bink_put_pixels(BinkContext *c,
1001 uint8_t *dst, uint8_t *prev, int stride,
1005 int xoff = get_value(c, BINK_SRC_X_OFF);
1006 int yoff = get_value(c, BINK_SRC_Y_OFF);
1007 uint8_t *ref = prev + xoff + yoff * stride;
1008 if (ref < ref_start || ref > ref_end) {
1009 av_log(c->avctx, AV_LOG_ERROR, "Copy out of bounds @%d, %d\n",
1011 return AVERROR_INVALIDDATA;
1013 c->put_pixels_tab(dst, ref, stride, 8);
1018 static int bink_decode_plane(BinkContext *c, AVFrame *frame, GetBitContext *gb,
1019 int plane_idx, int is_chroma)
1023 uint8_t *dst, *prev, *ref_start, *ref_end;
1025 const uint8_t *scan;
1026 LOCAL_ALIGNED_32(int16_t, block, [64]);
1027 LOCAL_ALIGNED_16(uint8_t, ublock, [64]);
1028 LOCAL_ALIGNED_16(int32_t, dctblock, [64]);
1029 int coordmap[64], quant_idx, coef_count, coef_idx[64];
1031 const int stride = frame->linesize[plane_idx];
1032 int bw = is_chroma ? (c->avctx->width + 15) >> 4 : (c->avctx->width + 7) >> 3;
1033 int bh = is_chroma ? (c->avctx->height + 15) >> 4 : (c->avctx->height + 7) >> 3;
1034 int width = c->avctx->width >> is_chroma;
1035 int height = c->avctx->height >> is_chroma;
1037 if (c->version == 'k' && get_bits1(gb)) {
1038 int fill = get_bits(gb, 8);
1040 dst = frame->data[plane_idx];
1042 for (i = 0; i < height; i++)
1043 memset(dst + i * stride, fill, width);
1047 init_lengths(c, FFMAX(width, 8), bw);
1048 for (i = 0; i < BINK_NB_SRC; i++) {
1049 ret = read_bundle(gb, c, i);
1054 ref_start = c->last->data[plane_idx] ? c->last->data[plane_idx]
1055 : frame->data[plane_idx];
1057 + (bw - 1 + c->last->linesize[plane_idx] * (bh - 1)) * 8;
1059 for (i = 0; i < 64; i++)
1060 coordmap[i] = (i & 7) + (i >> 3) * stride;
1062 for (by = 0; by < bh; by++) {
1063 if ((ret = read_block_types(c->avctx, gb, &c->bundle[BINK_SRC_BLOCK_TYPES])) < 0)
1065 if ((ret = read_block_types(c->avctx, gb, &c->bundle[BINK_SRC_SUB_BLOCK_TYPES])) < 0)
1067 if ((ret = read_colors(gb, &c->bundle[BINK_SRC_COLORS], c)) < 0)
1069 if ((ret = read_patterns(c->avctx, gb, &c->bundle[BINK_SRC_PATTERN])) < 0)
1071 if ((ret = read_motion_values(c->avctx, gb, &c->bundle[BINK_SRC_X_OFF])) < 0)
1073 if ((ret = read_motion_values(c->avctx, gb, &c->bundle[BINK_SRC_Y_OFF])) < 0)
1075 if ((ret = read_dcs(c->avctx, gb, &c->bundle[BINK_SRC_INTRA_DC], DC_START_BITS, 0)) < 0)
1077 if ((ret = read_dcs(c->avctx, gb, &c->bundle[BINK_SRC_INTER_DC], DC_START_BITS, 1)) < 0)
1079 if ((ret = read_runs(c->avctx, gb, &c->bundle[BINK_SRC_RUN])) < 0)
1082 dst = frame->data[plane_idx] + 8*by*stride;
1083 prev = (c->last->data[plane_idx] ? c->last->data[plane_idx]
1084 : frame->data[plane_idx]) + 8*by*stride;
1085 for (bx = 0; bx < bw; bx++, dst += 8, prev += 8) {
1086 blk = get_value(c, BINK_SRC_BLOCK_TYPES);
1087 // 16x16 block type on odd line means part of the already decoded block, so skip it
1088 if ((by & 1) && blk == SCALED_BLOCK) {
1096 c->put_pixels_tab(dst, prev, stride, 8);
1099 blk = get_value(c, BINK_SRC_SUB_BLOCK_TYPES);
1102 if (get_bits_left(gb) < 4)
1103 return AVERROR_INVALIDDATA;
1104 scan = bink_patterns[get_bits(gb, 4)];
1107 int run = get_value(c, BINK_SRC_RUN) + 1;
1111 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
1112 return AVERROR_INVALIDDATA;
1114 if (get_bits1(gb)) {
1115 v = get_value(c, BINK_SRC_COLORS);
1116 for (j = 0; j < run; j++)
1117 ublock[*scan++] = v;
1119 for (j = 0; j < run; j++)
1120 ublock[*scan++] = get_value(c, BINK_SRC_COLORS);
1124 ublock[*scan++] = get_value(c, BINK_SRC_COLORS);
1127 memset(dctblock, 0, sizeof(*dctblock) * 64);
1128 dctblock[0] = get_value(c, BINK_SRC_INTRA_DC);
1129 if ((quant_idx = read_dct_coeffs(c, gb, dctblock, bink_scan, &coef_count, coef_idx, -1)) < 0)
1131 unquantize_dct_coeffs(dctblock, bink_intra_quant[quant_idx], coef_count, coef_idx, bink_scan);
1132 c->binkdsp.idct_put(ublock, 8, dctblock);
1135 v = get_value(c, BINK_SRC_COLORS);
1136 c->bdsp.fill_block_tab[0](dst, v, stride, 16);
1139 for (i = 0; i < 2; i++)
1140 col[i] = get_value(c, BINK_SRC_COLORS);
1141 for (j = 0; j < 8; j++) {
1142 v = get_value(c, BINK_SRC_PATTERN);
1143 for (i = 0; i < 8; i++, v >>= 1)
1144 ublock[i + j*8] = col[v & 1];
1148 for (j = 0; j < 8; j++)
1149 for (i = 0; i < 8; i++)
1150 ublock[i + j*8] = get_value(c, BINK_SRC_COLORS);
1153 av_log(c->avctx, AV_LOG_ERROR, "Incorrect 16x16 block type %d\n", blk);
1154 return AVERROR_INVALIDDATA;
1156 if (blk != FILL_BLOCK)
1157 c->binkdsp.scale_block(ublock, dst, stride);
1163 ret = bink_put_pixels(c, dst, prev, stride,
1164 ref_start, ref_end);
1169 scan = bink_patterns[get_bits(gb, 4)];
1172 int run = get_value(c, BINK_SRC_RUN) + 1;
1176 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
1177 return AVERROR_INVALIDDATA;
1179 if (get_bits1(gb)) {
1180 v = get_value(c, BINK_SRC_COLORS);
1181 for (j = 0; j < run; j++)
1182 dst[coordmap[*scan++]] = v;
1184 for (j = 0; j < run; j++)
1185 dst[coordmap[*scan++]] = get_value(c, BINK_SRC_COLORS);
1189 dst[coordmap[*scan++]] = get_value(c, BINK_SRC_COLORS);
1192 ret = bink_put_pixels(c, dst, prev, stride,
1193 ref_start, ref_end);
1196 c->bdsp.clear_block(block);
1197 v = get_bits(gb, 7);
1198 read_residue(gb, block, v);
1199 c->binkdsp.add_pixels8(dst, block, stride);
1202 memset(dctblock, 0, sizeof(*dctblock) * 64);
1203 dctblock[0] = get_value(c, BINK_SRC_INTRA_DC);
1204 if ((quant_idx = read_dct_coeffs(c, gb, dctblock, bink_scan, &coef_count, coef_idx, -1)) < 0)
1206 unquantize_dct_coeffs(dctblock, bink_intra_quant[quant_idx], coef_count, coef_idx, bink_scan);
1207 c->binkdsp.idct_put(dst, stride, dctblock);
1210 v = get_value(c, BINK_SRC_COLORS);
1211 c->bdsp.fill_block_tab[1](dst, v, stride, 8);
1214 ret = bink_put_pixels(c, dst, prev, stride,
1215 ref_start, ref_end);
1218 memset(dctblock, 0, sizeof(*dctblock) * 64);
1219 dctblock[0] = get_value(c, BINK_SRC_INTER_DC);
1220 if ((quant_idx = read_dct_coeffs(c, gb, dctblock, bink_scan, &coef_count, coef_idx, -1)) < 0)
1222 unquantize_dct_coeffs(dctblock, bink_inter_quant[quant_idx], coef_count, coef_idx, bink_scan);
1223 c->binkdsp.idct_add(dst, stride, dctblock);
1226 for (i = 0; i < 2; i++)
1227 col[i] = get_value(c, BINK_SRC_COLORS);
1228 for (i = 0; i < 8; i++) {
1229 v = get_value(c, BINK_SRC_PATTERN);
1230 for (j = 0; j < 8; j++, v >>= 1)
1231 dst[i*stride + j] = col[v & 1];
1235 for (i = 0; i < 8; i++)
1236 memcpy(dst + i*stride, c->bundle[BINK_SRC_COLORS].cur_ptr + i*8, 8);
1237 c->bundle[BINK_SRC_COLORS].cur_ptr += 64;
1240 av_log(c->avctx, AV_LOG_ERROR, "Unknown block type %d\n", blk);
1241 return AVERROR_INVALIDDATA;
1247 if (get_bits_count(gb) & 0x1F) //next plane data starts at 32-bit boundary
1248 skip_bits_long(gb, 32 - (get_bits_count(gb) & 0x1F));
1253 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *pkt)
1255 BinkContext * const c = avctx->priv_data;
1256 AVFrame *frame = data;
1258 int plane, plane_idx, ret;
1259 int bits_count = pkt->size << 3;
1261 if (c->version > 'b') {
1262 if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
1265 if ((ret = ff_reget_buffer(avctx, c->last, 0)) < 0)
1267 if ((ret = av_frame_ref(frame, c->last)) < 0)
1271 init_get_bits(&gb, pkt->data, bits_count);
1273 if (c->version >= 'i')
1274 skip_bits_long(&gb, 32);
1275 if ((ret = bink_decode_plane(c, frame, &gb, 3, 0)) < 0)
1278 if (c->version >= 'i')
1279 skip_bits_long(&gb, 32);
1283 for (plane = 0; plane < 3; plane++) {
1284 plane_idx = (!plane || !c->swap_planes) ? plane : (plane ^ 3);
1286 if (c->version > 'b') {
1287 if ((ret = bink_decode_plane(c, frame, &gb, plane_idx, !!plane)) < 0)
1290 if ((ret = binkb_decode_plane(c, frame, &gb, plane_idx,
1291 c->frame_num == 1, !!plane)) < 0)
1294 if (get_bits_count(&gb) >= bits_count)
1299 if (c->version > 'b') {
1300 av_frame_unref(c->last);
1301 if ((ret = av_frame_ref(c->last, frame)) < 0)
1307 /* always report that the buffer was completely consumed */
1312 * Calculate quantization tables for version b
1314 static av_cold void binkb_calc_quant(void)
1316 uint8_t inv_bink_scan[64];
1317 static const int s[64]={
1318 1073741824,1489322693,1402911301,1262586814,1073741824, 843633538, 581104888, 296244703,
1319 1489322693,2065749918,1945893874,1751258219,1489322693,1170153332, 806015634, 410903207,
1320 1402911301,1945893874,1832991949,1649649171,1402911301,1102260336, 759250125, 387062357,
1321 1262586814,1751258219,1649649171,1484645031,1262586814, 992008094, 683307060, 348346918,
1322 1073741824,1489322693,1402911301,1262586814,1073741824, 843633538, 581104888, 296244703,
1323 843633538,1170153332,1102260336, 992008094, 843633538, 662838617, 456571181, 232757969,
1324 581104888, 806015634, 759250125, 683307060, 581104888, 456571181, 314491699, 160326478,
1325 296244703, 410903207, 387062357, 348346918, 296244703, 232757969, 160326478, 81733730,
1329 for (i = 0; i < 64; i++)
1330 inv_bink_scan[bink_scan[i]] = i;
1332 for (j = 0; j < 16; j++) {
1333 for (i = 0; i < 64; i++) {
1334 int k = inv_bink_scan[i];
1335 binkb_intra_quant[j][k] = binkb_intra_seed[i] * (int64_t)s[i] *
1336 binkb_num[j]/(binkb_den[j] * (C>>12));
1337 binkb_inter_quant[j][k] = binkb_inter_seed[i] * (int64_t)s[i] *
1338 binkb_num[j]/(binkb_den[j] * (C>>12));
1343 static av_cold int decode_init(AVCodecContext *avctx)
1345 BinkContext * const c = avctx->priv_data;
1346 static VLC_TYPE table[16 * 128][2];
1347 static int binkb_initialised = 0;
1348 HpelDSPContext hdsp;
1352 c->version = avctx->codec_tag >> 24;
1353 if (avctx->extradata_size < 4) {
1354 av_log(avctx, AV_LOG_ERROR, "Extradata missing or too short\n");
1355 return AVERROR_INVALIDDATA;
1357 flags = AV_RL32(avctx->extradata);
1358 c->has_alpha = flags & BINK_FLAG_ALPHA;
1359 c->swap_planes = c->version >= 'h';
1360 if (!bink_trees[15].table) {
1361 for (i = 0; i < 16; i++) {
1362 const int maxbits = bink_tree_lens[i][15];
1363 bink_trees[i].table = table + i*128;
1364 bink_trees[i].table_allocated = 1 << maxbits;
1365 init_vlc(&bink_trees[i], maxbits, 16,
1366 bink_tree_lens[i], 1, 1,
1367 bink_tree_bits[i], 1, 1, INIT_VLC_USE_NEW_STATIC | INIT_VLC_LE);
1372 if ((ret = av_image_check_size(avctx->width, avctx->height, 0, avctx)) < 0)
1375 c->last = av_frame_alloc();
1377 return AVERROR(ENOMEM);
1379 avctx->pix_fmt = c->has_alpha ? AV_PIX_FMT_YUVA420P : AV_PIX_FMT_YUV420P;
1380 avctx->color_range = c->version == 'k' ? AVCOL_RANGE_JPEG : AVCOL_RANGE_MPEG;
1382 ff_blockdsp_init(&c->bdsp, avctx);
1383 ff_hpeldsp_init(&hdsp, avctx->flags);
1384 c->put_pixels_tab = hdsp.put_pixels_tab[1][0];
1385 ff_binkdsp_init(&c->binkdsp);
1387 if ((ret = init_bundles(c)) < 0)
1390 if (c->version == 'b') {
1391 if (!binkb_initialised) {
1393 binkb_initialised = 1;
1400 static av_cold int decode_end(AVCodecContext *avctx)
1402 BinkContext * const c = avctx->priv_data;
1404 av_frame_free(&c->last);
1410 static void flush(AVCodecContext *avctx)
1412 BinkContext * const c = avctx->priv_data;
1417 AVCodec ff_bink_decoder = {
1418 .name = "binkvideo",
1419 .long_name = NULL_IF_CONFIG_SMALL("Bink video"),
1420 .type = AVMEDIA_TYPE_VIDEO,
1421 .id = AV_CODEC_ID_BINKVIDEO,
1422 .priv_data_size = sizeof(BinkContext),
1423 .init = decode_init,
1424 .close = decode_end,
1425 .decode = decode_frame,
1427 .capabilities = AV_CODEC_CAP_DR1,
1428 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,