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/imgutils.h"
29 #define ALT_BITSTREAM_READER_LE
32 #define BINK_FLAG_ALPHA 0x00100000
33 #define BINK_FLAG_GRAY 0x00020000
35 static VLC bink_trees[16];
38 * IDs for different data types used in old version of Bink video codec
41 BINKB_SRC_BLOCK_TYPES = 0, ///< 8x8 block types
42 BINKB_SRC_COLORS, ///< pixel values used for different block types
43 BINKB_SRC_PATTERN, ///< 8-bit values for 2-colour pattern fill
44 BINKB_SRC_X_OFF, ///< X components of motion value
45 BINKB_SRC_Y_OFF, ///< Y components of motion value
46 BINKB_SRC_INTRA_DC, ///< DC values for intrablocks with DCT
47 BINKB_SRC_INTER_DC, ///< DC values for interblocks with DCT
48 BINKB_SRC_INTRA_Q, ///< quantizer values for intrablocks with DCT
49 BINKB_SRC_INTER_Q, ///< quantizer values for interblocks with DCT
50 BINKB_SRC_INTER_COEFS, ///< number of coefficients for residue blocks
55 static const int binkb_bundle_sizes[BINKB_NB_SRC] = {
56 4, 8, 8, 5, 5, 11, 11, 4, 4, 7
59 static const int binkb_bundle_signed[BINKB_NB_SRC] = {
60 0, 0, 0, 1, 1, 0, 1, 0, 0, 0
63 static uint32_t binkb_intra_quant[16][64];
64 static uint32_t binkb_inter_quant[16][64];
67 * IDs for different data types used in Bink video codec
70 BINK_SRC_BLOCK_TYPES = 0, ///< 8x8 block types
71 BINK_SRC_SUB_BLOCK_TYPES, ///< 16x16 block types (a subset of 8x8 block types)
72 BINK_SRC_COLORS, ///< pixel values used for different block types
73 BINK_SRC_PATTERN, ///< 8-bit values for 2-colour pattern fill
74 BINK_SRC_X_OFF, ///< X components of motion value
75 BINK_SRC_Y_OFF, ///< Y components of motion value
76 BINK_SRC_INTRA_DC, ///< DC values for intrablocks with DCT
77 BINK_SRC_INTER_DC, ///< DC values for interblocks with DCT
78 BINK_SRC_RUN, ///< run lengths for special fill block
84 * data needed to decode 4-bit Huffman-coded value
87 int vlc_num; ///< tree number (in bink_trees[])
88 uint8_t syms[16]; ///< leaf value to symbol mapping
91 #define GET_HUFF(gb, tree) (tree).syms[get_vlc2(gb, bink_trees[(tree).vlc_num].table,\
92 bink_trees[(tree).vlc_num].bits, 1)]
95 * data structure used for decoding single Bink data type
97 typedef struct Bundle {
98 int len; ///< length of number of entries to decode (in bits)
99 Tree tree; ///< Huffman tree-related data
100 uint8_t *data; ///< buffer for decoded symbols
101 uint8_t *data_end; ///< buffer end
102 uint8_t *cur_dec; ///< pointer to the not yet decoded part of the buffer
103 uint8_t *cur_ptr; ///< pointer to the data that is not read from buffer yet
109 typedef struct BinkContext {
110 AVCodecContext *avctx;
113 int version; ///< internal Bink file version
116 ScanTable scantable; ///< permutated scantable for DCT coeffs decoding
118 Bundle bundle[BINKB_NB_SRC]; ///< bundles for decoding all data types
119 Tree col_high[16]; ///< trees for decoding high nibble in "colours" data type
120 int col_lastval; ///< value of last decoded high nibble in "colours" data type
124 * Bink video block types
127 SKIP_BLOCK = 0, ///< skipped block
128 SCALED_BLOCK, ///< block has size 16x16
129 MOTION_BLOCK, ///< block is copied from previous frame with some offset
130 RUN_BLOCK, ///< block is composed from runs of colours with custom scan order
131 RESIDUE_BLOCK, ///< motion block with some difference added
132 INTRA_BLOCK, ///< intra DCT block
133 FILL_BLOCK, ///< block is filled with single colour
134 INTER_BLOCK, ///< motion block with DCT applied to the difference
135 PATTERN_BLOCK, ///< block is filled with two colours following custom pattern
136 RAW_BLOCK, ///< uncoded 8x8 block
140 * Initialize length length in all bundles.
142 * @param c decoder context
143 * @param width plane width
144 * @param bw plane width in 8x8 blocks
146 static void init_lengths(BinkContext *c, int width, int bw)
148 c->bundle[BINK_SRC_BLOCK_TYPES].len = av_log2((width >> 3) + 511) + 1;
150 c->bundle[BINK_SRC_SUB_BLOCK_TYPES].len = av_log2((width >> 4) + 511) + 1;
152 c->bundle[BINK_SRC_COLORS].len = av_log2(bw*64 + 511) + 1;
154 c->bundle[BINK_SRC_INTRA_DC].len =
155 c->bundle[BINK_SRC_INTER_DC].len =
156 c->bundle[BINK_SRC_X_OFF].len =
157 c->bundle[BINK_SRC_Y_OFF].len = av_log2((width >> 3) + 511) + 1;
159 c->bundle[BINK_SRC_PATTERN].len = av_log2((bw << 3) + 511) + 1;
161 c->bundle[BINK_SRC_RUN].len = av_log2(bw*48 + 511) + 1;
165 * Allocate memory for bundles.
167 * @param c decoder context
169 static av_cold void init_bundles(BinkContext *c)
174 bw = (c->avctx->width + 7) >> 3;
175 bh = (c->avctx->height + 7) >> 3;
178 for (i = 0; i < BINKB_NB_SRC; i++) {
179 c->bundle[i].data = av_malloc(blocks * 64);
180 c->bundle[i].data_end = c->bundle[i].data + blocks * 64;
185 * Free memory used by bundles.
187 * @param c decoder context
189 static av_cold void free_bundles(BinkContext *c)
192 for (i = 0; i < BINKB_NB_SRC; i++)
193 av_freep(&c->bundle[i].data);
197 * Merge two consequent lists of equal size depending on bits read.
199 * @param gb context for reading bits
200 * @param dst buffer where merged list will be written to
201 * @param src pointer to the head of the first list (the second lists starts at src+size)
202 * @param size input lists size
204 static void merge(GetBitContext *gb, uint8_t *dst, uint8_t *src, int size)
206 uint8_t *src2 = src + size;
210 if (!get_bits1(gb)) {
217 } while (size && size2);
226 * Read information about Huffman tree used to decode data.
228 * @param gb context for reading bits
229 * @param tree pointer for storing tree data
231 static void read_tree(GetBitContext *gb, Tree *tree)
233 uint8_t tmp1[16], tmp2[16], *in = tmp1, *out = tmp2;
236 tree->vlc_num = get_bits(gb, 4);
237 if (!tree->vlc_num) {
238 for (i = 0; i < 16; i++)
243 len = get_bits(gb, 3);
244 memset(tmp1, 0, sizeof(tmp1));
245 for (i = 0; i <= len; i++) {
246 tree->syms[i] = get_bits(gb, 4);
247 tmp1[tree->syms[i]] = 1;
249 for (i = 0; i < 16; i++)
251 tree->syms[++len] = i;
253 len = get_bits(gb, 2);
254 for (i = 0; i < 16; i++)
256 for (i = 0; i <= len; i++) {
258 for (t = 0; t < 16; t += size << 1)
259 merge(gb, out + t, in + t, size);
260 FFSWAP(uint8_t*, in, out);
262 memcpy(tree->syms, in, 16);
267 * Prepare bundle for decoding data.
269 * @param gb context for reading bits
270 * @param c decoder context
271 * @param bundle_num number of the bundle to initialize
273 static void read_bundle(GetBitContext *gb, BinkContext *c, int bundle_num)
277 if (bundle_num == BINK_SRC_COLORS) {
278 for (i = 0; i < 16; i++)
279 read_tree(gb, &c->col_high[i]);
282 if (bundle_num != BINK_SRC_INTRA_DC && bundle_num != BINK_SRC_INTER_DC)
283 read_tree(gb, &c->bundle[bundle_num].tree);
284 c->bundle[bundle_num].cur_dec =
285 c->bundle[bundle_num].cur_ptr = c->bundle[bundle_num].data;
289 * common check before starting decoding bundle data
291 * @param gb context for reading bits
293 * @param t variable where number of elements to decode will be stored
295 #define CHECK_READ_VAL(gb, b, t) \
296 if (!b->cur_dec || (b->cur_dec > b->cur_ptr)) \
298 t = get_bits(gb, b->len); \
304 static int read_runs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
307 const uint8_t *dec_end;
309 CHECK_READ_VAL(gb, b, t);
310 dec_end = b->cur_dec + t;
311 if (dec_end > b->data_end) {
312 av_log(avctx, AV_LOG_ERROR, "Run value went out of bounds\n");
317 memset(b->cur_dec, v, t);
320 while (b->cur_dec < dec_end)
321 *b->cur_dec++ = GET_HUFF(gb, b->tree);
326 static int read_motion_values(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
329 const uint8_t *dec_end;
331 CHECK_READ_VAL(gb, b, t);
332 dec_end = b->cur_dec + t;
333 if (dec_end > b->data_end) {
334 av_log(avctx, AV_LOG_ERROR, "Too many motion values\n");
340 sign = -get_bits1(gb);
341 v = (v ^ sign) - sign;
343 memset(b->cur_dec, v, t);
347 v = GET_HUFF(gb, b->tree);
349 sign = -get_bits1(gb);
350 v = (v ^ sign) - sign;
353 } while (b->cur_dec < dec_end);
358 static const uint8_t bink_rlelens[4] = { 4, 8, 12, 32 };
360 static int read_block_types(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
364 const uint8_t *dec_end;
366 CHECK_READ_VAL(gb, b, t);
367 dec_end = b->cur_dec + t;
368 if (dec_end > b->data_end) {
369 av_log(avctx, AV_LOG_ERROR, "Too many block type values\n");
374 memset(b->cur_dec, v, t);
378 v = GET_HUFF(gb, b->tree);
383 int run = bink_rlelens[v - 12];
385 memset(b->cur_dec, last, run);
388 } while (b->cur_dec < dec_end);
393 static int read_patterns(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
396 const uint8_t *dec_end;
398 CHECK_READ_VAL(gb, b, t);
399 dec_end = b->cur_dec + t;
400 if (dec_end > b->data_end) {
401 av_log(avctx, AV_LOG_ERROR, "Too many pattern values\n");
404 while (b->cur_dec < dec_end) {
405 v = GET_HUFF(gb, b->tree);
406 v |= GET_HUFF(gb, b->tree) << 4;
413 static int read_colors(GetBitContext *gb, Bundle *b, BinkContext *c)
416 const uint8_t *dec_end;
418 CHECK_READ_VAL(gb, b, t);
419 dec_end = b->cur_dec + t;
420 if (dec_end > b->data_end) {
421 av_log(c->avctx, AV_LOG_ERROR, "Too many color values\n");
425 c->col_lastval = GET_HUFF(gb, c->col_high[c->col_lastval]);
426 v = GET_HUFF(gb, b->tree);
427 v = (c->col_lastval << 4) | v;
428 if (c->version < 'i') {
429 sign = ((int8_t) v) >> 7;
430 v = ((v & 0x7F) ^ sign) - sign;
433 memset(b->cur_dec, v, t);
436 while (b->cur_dec < dec_end) {
437 c->col_lastval = GET_HUFF(gb, c->col_high[c->col_lastval]);
438 v = GET_HUFF(gb, b->tree);
439 v = (c->col_lastval << 4) | v;
440 if (c->version < 'i') {
441 sign = ((int8_t) v) >> 7;
442 v = ((v & 0x7F) ^ sign) - sign;
451 /** number of bits used to store first DC value in bundle */
452 #define DC_START_BITS 11
454 static int read_dcs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b,
455 int start_bits, int has_sign)
457 int i, j, len, len2, bsize, sign, v, v2;
458 int16_t *dst = (int16_t*)b->cur_dec;
460 CHECK_READ_VAL(gb, b, len);
461 v = get_bits(gb, start_bits - has_sign);
463 sign = -get_bits1(gb);
464 v = (v ^ sign) - sign;
468 for (i = 0; i < len; i += 8) {
469 len2 = FFMIN(len - i, 8);
470 bsize = get_bits(gb, 4);
472 for (j = 0; j < len2; j++) {
473 v2 = get_bits(gb, bsize);
475 sign = -get_bits1(gb);
476 v2 = (v2 ^ sign) - sign;
480 if (v < -32768 || v > 32767) {
481 av_log(avctx, AV_LOG_ERROR, "DC value went out of bounds: %d\n", v);
486 for (j = 0; j < len2; j++)
491 b->cur_dec = (uint8_t*)dst;
496 * Retrieve next value from bundle.
498 * @param c decoder context
499 * @param bundle bundle number
501 static inline int get_value(BinkContext *c, int bundle)
505 if (bundle < BINK_SRC_X_OFF || bundle == BINK_SRC_RUN)
506 return *c->bundle[bundle].cur_ptr++;
507 if (bundle == BINK_SRC_X_OFF || bundle == BINK_SRC_Y_OFF)
508 return (int8_t)*c->bundle[bundle].cur_ptr++;
509 ret = *(int16_t*)c->bundle[bundle].cur_ptr;
510 c->bundle[bundle].cur_ptr += 2;
514 static void binkb_init_bundle(BinkContext *c, int bundle_num)
516 c->bundle[bundle_num].cur_dec =
517 c->bundle[bundle_num].cur_ptr = c->bundle[bundle_num].data;
518 c->bundle[bundle_num].len = 13;
521 static void binkb_init_bundles(BinkContext *c)
524 for (i = 0; i < BINKB_NB_SRC; i++)
525 binkb_init_bundle(c, i);
528 static int binkb_read_bundle(BinkContext *c, GetBitContext *gb, int bundle_num)
530 const int bits = binkb_bundle_sizes[bundle_num];
531 const int mask = 1 << (bits - 1);
532 const int issigned = binkb_bundle_signed[bundle_num];
533 Bundle *b = &c->bundle[bundle_num];
536 CHECK_READ_VAL(gb, b, len);
539 for (i = 0; i < len; i++)
540 *b->cur_dec++ = get_bits(gb, bits);
542 for (i = 0; i < len; i++)
543 *b->cur_dec++ = get_bits(gb, bits) - mask;
546 int16_t *dst = (int16_t*)b->cur_dec;
549 for (i = 0; i < len; i++)
550 *dst++ = get_bits(gb, bits);
552 for (i = 0; i < len; i++)
553 *dst++ = get_bits(gb, bits) - mask;
555 b->cur_dec = (uint8_t*)dst;
560 static inline int binkb_get_value(BinkContext *c, int bundle_num)
563 const int bits = binkb_bundle_sizes[bundle_num];
566 int val = *c->bundle[bundle_num].cur_ptr++;
567 return binkb_bundle_signed[bundle_num] ? (int8_t)val : val;
569 ret = *(int16_t*)c->bundle[bundle_num].cur_ptr;
570 c->bundle[bundle_num].cur_ptr += 2;
574 static inline DCTELEM dequant(DCTELEM in, uint32_t quant, int dc)
576 /* Note: multiplication is unsigned but we want signed shift
577 * otherwise clipping breaks.
578 * TODO: The official decoder does not use clipping at all
579 * but instead uses the full 32-bit result.
580 * However clipping at least gets rid of the case that a
581 * half-black half-white intra block gets black and white swapped
582 * and should cause at most minor differences (except for DC). */
583 int32_t res = in * quant;
586 res = av_clip_int16(res);
591 * Read 8x8 block of DCT coefficients.
593 * @param gb context for reading bits
594 * @param block place for storing coefficients
595 * @param scan scan order table
596 * @param quant_matrices quantization matrices
597 * @return 0 for success, negative value in other cases
599 static int read_dct_coeffs(GetBitContext *gb, DCTELEM block[64], const uint8_t *scan,
600 const uint32_t quant_matrices[16][64], int q)
604 int i, t, mask, bits, ccoef, mode, sign;
605 int list_start = 64, list_end = 64, list_pos;
609 const uint32_t *quant;
611 coef_list[list_end] = 4; mode_list[list_end++] = 0;
612 coef_list[list_end] = 24; mode_list[list_end++] = 0;
613 coef_list[list_end] = 44; mode_list[list_end++] = 0;
614 coef_list[list_end] = 1; mode_list[list_end++] = 3;
615 coef_list[list_end] = 2; mode_list[list_end++] = 3;
616 coef_list[list_end] = 3; mode_list[list_end++] = 3;
618 bits = get_bits(gb, 4) - 1;
619 for (mask = 1 << bits; bits >= 0; mask >>= 1, bits--) {
620 list_pos = list_start;
621 while (list_pos < list_end) {
622 if (!(mode_list[list_pos] | coef_list[list_pos]) || !get_bits1(gb)) {
626 ccoef = coef_list[list_pos];
627 mode = mode_list[list_pos];
630 coef_list[list_pos] = ccoef + 4;
631 mode_list[list_pos] = 1;
634 coef_list[list_pos] = 0;
635 mode_list[list_pos++] = 0;
637 for (i = 0; i < 4; i++, ccoef++) {
639 coef_list[--list_start] = ccoef;
640 mode_list[ list_start] = 3;
644 t = 1 - (get_bits1(gb) << 1);
646 t = get_bits(gb, bits) | mask;
647 sign = -get_bits1(gb);
648 t = (t ^ sign) - sign;
650 block[scan[ccoef]] = t;
651 coef_idx[coef_count++] = ccoef;
656 mode_list[list_pos] = 2;
657 for (i = 0; i < 3; i++) {
659 coef_list[list_end] = ccoef;
660 mode_list[list_end++] = 2;
665 t = 1 - (get_bits1(gb) << 1);
667 t = get_bits(gb, bits) | mask;
668 sign = -get_bits1(gb);
669 t = (t ^ sign) - sign;
671 block[scan[ccoef]] = t;
672 coef_idx[coef_count++] = ccoef;
673 coef_list[list_pos] = 0;
674 mode_list[list_pos++] = 0;
681 quant_idx = get_bits(gb, 4);
686 quant = quant_matrices[quant_idx];
688 block[0] = dequant(block[0], quant[0], 1);
689 for (i = 0; i < coef_count; i++) {
690 int idx = coef_idx[i];
691 block[scan[idx]] = dequant(block[scan[idx]], quant[idx], 0);
698 * Read 8x8 block with residue after motion compensation.
700 * @param gb context for reading bits
701 * @param block place to store read data
702 * @param masks_count number of masks to decode
703 * @return 0 on success, negative value in other cases
705 static int read_residue(GetBitContext *gb, DCTELEM block[64], int masks_count)
709 int i, sign, mask, ccoef, mode;
710 int list_start = 64, list_end = 64, list_pos;
712 int nz_coeff_count = 0;
714 coef_list[list_end] = 4; mode_list[list_end++] = 0;
715 coef_list[list_end] = 24; mode_list[list_end++] = 0;
716 coef_list[list_end] = 44; mode_list[list_end++] = 0;
717 coef_list[list_end] = 0; mode_list[list_end++] = 2;
719 for (mask = 1 << get_bits(gb, 3); mask; mask >>= 1) {
720 for (i = 0; i < nz_coeff_count; i++) {
723 if (block[nz_coeff[i]] < 0)
724 block[nz_coeff[i]] -= mask;
726 block[nz_coeff[i]] += mask;
731 list_pos = list_start;
732 while (list_pos < list_end) {
733 if (!(coef_list[list_pos] | mode_list[list_pos]) || !get_bits1(gb)) {
737 ccoef = coef_list[list_pos];
738 mode = mode_list[list_pos];
741 coef_list[list_pos] = ccoef + 4;
742 mode_list[list_pos] = 1;
745 coef_list[list_pos] = 0;
746 mode_list[list_pos++] = 0;
748 for (i = 0; i < 4; i++, ccoef++) {
750 coef_list[--list_start] = ccoef;
751 mode_list[ list_start] = 3;
753 nz_coeff[nz_coeff_count++] = bink_scan[ccoef];
754 sign = -get_bits1(gb);
755 block[bink_scan[ccoef]] = (mask ^ sign) - sign;
763 mode_list[list_pos] = 2;
764 for (i = 0; i < 3; i++) {
766 coef_list[list_end] = ccoef;
767 mode_list[list_end++] = 2;
771 nz_coeff[nz_coeff_count++] = bink_scan[ccoef];
772 sign = -get_bits1(gb);
773 block[bink_scan[ccoef]] = (mask ^ sign) - sign;
774 coef_list[list_pos] = 0;
775 mode_list[list_pos++] = 0;
788 * Copy 8x8 block from source to destination, where src and dst may be overlapped
790 static inline void put_pixels8x8_overlapped(uint8_t *dst, uint8_t *src, int stride)
794 for (i = 0; i < 8; i++)
795 memcpy(tmp + i*8, src + i*stride, 8);
796 for (i = 0; i < 8; i++)
797 memcpy(dst + i*stride, tmp + i*8, 8);
800 static int binkb_decode_plane(BinkContext *c, GetBitContext *gb, int plane_idx,
801 int is_key, int is_chroma)
805 uint8_t *dst, *ref, *ref_start, *ref_end;
809 LOCAL_ALIGNED_16(DCTELEM, block, [64]);
811 int ybias = is_key ? -15 : 0;
814 const int stride = c->pic.linesize[plane_idx];
815 int bw = is_chroma ? (c->avctx->width + 15) >> 4 : (c->avctx->width + 7) >> 3;
816 int bh = is_chroma ? (c->avctx->height + 15) >> 4 : (c->avctx->height + 7) >> 3;
818 binkb_init_bundles(c);
819 ref_start = c->pic.data[plane_idx];
820 ref_end = c->pic.data[plane_idx] + (bh * c->pic.linesize[plane_idx] + bw) * 8;
822 for (i = 0; i < 64; i++)
823 coordmap[i] = (i & 7) + (i >> 3) * stride;
825 for (by = 0; by < bh; by++) {
826 for (i = 0; i < BINKB_NB_SRC; i++) {
827 if (binkb_read_bundle(c, gb, i) < 0)
831 dst = c->pic.data[plane_idx] + 8*by*stride;
832 for (bx = 0; bx < bw; bx++, dst += 8) {
833 blk = binkb_get_value(c, BINKB_SRC_BLOCK_TYPES);
838 scan = bink_patterns[get_bits(gb, 4)];
843 mode = get_bits1(gb);
844 run = get_bits(gb, binkb_runbits[i]) + 1;
848 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
852 v = binkb_get_value(c, BINKB_SRC_COLORS);
853 for (j = 0; j < run; j++)
854 dst[coordmap[*scan++]] = v;
856 for (j = 0; j < run; j++)
857 dst[coordmap[*scan++]] = binkb_get_value(c, BINKB_SRC_COLORS);
861 dst[coordmap[*scan++]] = binkb_get_value(c, BINKB_SRC_COLORS);
864 c->dsp.clear_block(block);
865 block[0] = binkb_get_value(c, BINKB_SRC_INTRA_DC);
866 qp = binkb_get_value(c, BINKB_SRC_INTRA_Q);
867 read_dct_coeffs(gb, block, c->scantable.permutated, binkb_intra_quant, qp);
868 c->dsp.idct_put(dst, stride, block);
871 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
872 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
873 ref = dst + xoff + yoff * stride;
874 if (ref < ref_start || ref + 8*stride > ref_end) {
875 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
876 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
877 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
879 put_pixels8x8_overlapped(dst, ref, stride);
881 c->dsp.clear_block(block);
882 v = binkb_get_value(c, BINKB_SRC_INTER_COEFS);
883 read_residue(gb, block, v);
884 c->dsp.add_pixels8(dst, block, stride);
887 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
888 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
889 ref = dst + xoff + yoff * stride;
890 if (ref < ref_start || ref + 8 * stride > ref_end) {
891 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
892 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
893 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
895 put_pixels8x8_overlapped(dst, ref, stride);
897 c->dsp.clear_block(block);
898 block[0] = binkb_get_value(c, BINKB_SRC_INTER_DC);
899 qp = binkb_get_value(c, BINKB_SRC_INTER_Q);
900 read_dct_coeffs(gb, block, c->scantable.permutated, binkb_inter_quant, qp);
901 c->dsp.idct_add(dst, stride, block);
904 v = binkb_get_value(c, BINKB_SRC_COLORS);
905 c->dsp.fill_block_tab[1](dst, v, stride, 8);
908 for (i = 0; i < 2; i++)
909 col[i] = binkb_get_value(c, BINKB_SRC_COLORS);
910 for (i = 0; i < 8; i++) {
911 v = binkb_get_value(c, BINKB_SRC_PATTERN);
912 for (j = 0; j < 8; j++, v >>= 1)
913 dst[i*stride + j] = col[v & 1];
917 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
918 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
919 ref = dst + xoff + yoff * stride;
920 if (ref < ref_start || ref + 8 * stride > ref_end) {
921 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
922 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
923 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
925 put_pixels8x8_overlapped(dst, ref, stride);
929 for (i = 0; i < 8; i++)
930 memcpy(dst + i*stride, c->bundle[BINKB_SRC_COLORS].cur_ptr + i*8, 8);
931 c->bundle[BINKB_SRC_COLORS].cur_ptr += 64;
934 av_log(c->avctx, AV_LOG_ERROR, "Unknown block type %d\n", blk);
939 if (get_bits_count(gb) & 0x1F) //next plane data starts at 32-bit boundary
940 skip_bits_long(gb, 32 - (get_bits_count(gb) & 0x1F));
945 static int bink_decode_plane(BinkContext *c, GetBitContext *gb, int plane_idx,
950 uint8_t *dst, *prev, *ref, *ref_start, *ref_end;
954 LOCAL_ALIGNED_16(DCTELEM, block, [64]);
955 LOCAL_ALIGNED_16(uint8_t, ublock, [64]);
958 const int stride = c->pic.linesize[plane_idx];
959 int bw = is_chroma ? (c->avctx->width + 15) >> 4 : (c->avctx->width + 7) >> 3;
960 int bh = is_chroma ? (c->avctx->height + 15) >> 4 : (c->avctx->height + 7) >> 3;
961 int width = c->avctx->width >> is_chroma;
963 init_lengths(c, FFMAX(width, 8), bw);
964 for (i = 0; i < BINK_NB_SRC; i++)
965 read_bundle(gb, c, i);
967 ref_start = c->last.data[plane_idx];
968 ref_end = c->last.data[plane_idx]
969 + (bw - 1 + c->last.linesize[plane_idx] * (bh - 1)) * 8;
971 for (i = 0; i < 64; i++)
972 coordmap[i] = (i & 7) + (i >> 3) * stride;
974 for (by = 0; by < bh; by++) {
975 if (read_block_types(c->avctx, gb, &c->bundle[BINK_SRC_BLOCK_TYPES]) < 0)
977 if (read_block_types(c->avctx, gb, &c->bundle[BINK_SRC_SUB_BLOCK_TYPES]) < 0)
979 if (read_colors(gb, &c->bundle[BINK_SRC_COLORS], c) < 0)
981 if (read_patterns(c->avctx, gb, &c->bundle[BINK_SRC_PATTERN]) < 0)
983 if (read_motion_values(c->avctx, gb, &c->bundle[BINK_SRC_X_OFF]) < 0)
985 if (read_motion_values(c->avctx, gb, &c->bundle[BINK_SRC_Y_OFF]) < 0)
987 if (read_dcs(c->avctx, gb, &c->bundle[BINK_SRC_INTRA_DC], DC_START_BITS, 0) < 0)
989 if (read_dcs(c->avctx, gb, &c->bundle[BINK_SRC_INTER_DC], DC_START_BITS, 1) < 0)
991 if (read_runs(c->avctx, gb, &c->bundle[BINK_SRC_RUN]) < 0)
996 dst = c->pic.data[plane_idx] + 8*by*stride;
997 prev = c->last.data[plane_idx] + 8*by*stride;
998 for (bx = 0; bx < bw; bx++, dst += 8, prev += 8) {
999 blk = get_value(c, BINK_SRC_BLOCK_TYPES);
1000 // 16x16 block type on odd line means part of the already decoded block, so skip it
1001 if ((by & 1) && blk == SCALED_BLOCK) {
1009 c->dsp.put_pixels_tab[1][0](dst, prev, stride, 8);
1012 blk = get_value(c, BINK_SRC_SUB_BLOCK_TYPES);
1015 scan = bink_patterns[get_bits(gb, 4)];
1018 int run = get_value(c, BINK_SRC_RUN) + 1;
1022 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
1025 if (get_bits1(gb)) {
1026 v = get_value(c, BINK_SRC_COLORS);
1027 for (j = 0; j < run; j++)
1028 ublock[*scan++] = v;
1030 for (j = 0; j < run; j++)
1031 ublock[*scan++] = get_value(c, BINK_SRC_COLORS);
1035 ublock[*scan++] = get_value(c, BINK_SRC_COLORS);
1038 c->dsp.clear_block(block);
1039 block[0] = get_value(c, BINK_SRC_INTRA_DC);
1040 read_dct_coeffs(gb, block, c->scantable.permutated, bink_intra_quant, -1);
1042 c->dsp.put_pixels_nonclamped(block, ublock, 8);
1045 v = get_value(c, BINK_SRC_COLORS);
1046 c->dsp.fill_block_tab[0](dst, v, stride, 16);
1049 for (i = 0; i < 2; i++)
1050 col[i] = get_value(c, BINK_SRC_COLORS);
1051 for (j = 0; j < 8; j++) {
1052 v = get_value(c, BINK_SRC_PATTERN);
1053 for (i = 0; i < 8; i++, v >>= 1)
1054 ublock[i + j*8] = col[v & 1];
1058 for (j = 0; j < 8; j++)
1059 for (i = 0; i < 8; i++)
1060 ublock[i + j*8] = get_value(c, BINK_SRC_COLORS);
1063 av_log(c->avctx, AV_LOG_ERROR, "Incorrect 16x16 block type %d\n", blk);
1066 if (blk != FILL_BLOCK)
1067 c->dsp.scale_block(ublock, dst, stride);
1073 xoff = get_value(c, BINK_SRC_X_OFF);
1074 yoff = get_value(c, BINK_SRC_Y_OFF);
1075 ref = prev + xoff + yoff * stride;
1076 if (ref < ref_start || ref > ref_end) {
1077 av_log(c->avctx, AV_LOG_ERROR, "Copy out of bounds @%d, %d\n",
1078 bx*8 + xoff, by*8 + yoff);
1081 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
1084 scan = bink_patterns[get_bits(gb, 4)];
1087 int run = get_value(c, BINK_SRC_RUN) + 1;
1091 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
1094 if (get_bits1(gb)) {
1095 v = get_value(c, BINK_SRC_COLORS);
1096 for (j = 0; j < run; j++)
1097 dst[coordmap[*scan++]] = v;
1099 for (j = 0; j < run; j++)
1100 dst[coordmap[*scan++]] = get_value(c, BINK_SRC_COLORS);
1104 dst[coordmap[*scan++]] = get_value(c, BINK_SRC_COLORS);
1107 xoff = get_value(c, BINK_SRC_X_OFF);
1108 yoff = get_value(c, BINK_SRC_Y_OFF);
1109 ref = prev + xoff + yoff * stride;
1110 if (ref < ref_start || ref > ref_end) {
1111 av_log(c->avctx, AV_LOG_ERROR, "Copy out of bounds @%d, %d\n",
1112 bx*8 + xoff, by*8 + yoff);
1115 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
1116 c->dsp.clear_block(block);
1117 v = get_bits(gb, 7);
1118 read_residue(gb, block, v);
1119 c->dsp.add_pixels8(dst, block, stride);
1122 c->dsp.clear_block(block);
1123 block[0] = get_value(c, BINK_SRC_INTRA_DC);
1124 read_dct_coeffs(gb, block, c->scantable.permutated, bink_intra_quant, -1);
1125 c->dsp.idct_put(dst, stride, block);
1128 v = get_value(c, BINK_SRC_COLORS);
1129 c->dsp.fill_block_tab[1](dst, v, stride, 8);
1132 xoff = get_value(c, BINK_SRC_X_OFF);
1133 yoff = get_value(c, BINK_SRC_Y_OFF);
1134 ref = prev + xoff + yoff * stride;
1135 c->dsp.put_pixels_tab[1][0](dst, ref, stride, 8);
1136 c->dsp.clear_block(block);
1137 block[0] = get_value(c, BINK_SRC_INTER_DC);
1138 read_dct_coeffs(gb, block, c->scantable.permutated, bink_inter_quant, -1);
1139 c->dsp.idct_add(dst, stride, block);
1142 for (i = 0; i < 2; i++)
1143 col[i] = get_value(c, BINK_SRC_COLORS);
1144 for (i = 0; i < 8; i++) {
1145 v = get_value(c, BINK_SRC_PATTERN);
1146 for (j = 0; j < 8; j++, v >>= 1)
1147 dst[i*stride + j] = col[v & 1];
1151 for (i = 0; i < 8; i++)
1152 memcpy(dst + i*stride, c->bundle[BINK_SRC_COLORS].cur_ptr + i*8, 8);
1153 c->bundle[BINK_SRC_COLORS].cur_ptr += 64;
1156 av_log(c->avctx, AV_LOG_ERROR, "Unknown block type %d\n", blk);
1161 if (get_bits_count(gb) & 0x1F) //next plane data starts at 32-bit boundary
1162 skip_bits_long(gb, 32 - (get_bits_count(gb) & 0x1F));
1167 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *pkt)
1169 BinkContext * const c = avctx->priv_data;
1171 int plane, plane_idx;
1172 int bits_count = pkt->size << 3;
1174 if (c->version > 'b') {
1176 avctx->release_buffer(avctx, &c->pic);
1178 if(avctx->get_buffer(avctx, &c->pic) < 0){
1179 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
1183 if(avctx->reget_buffer(avctx, &c->pic) < 0){
1184 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
1189 init_get_bits(&gb, pkt->data, bits_count);
1191 if (c->version >= 'i')
1192 skip_bits_long(&gb, 32);
1193 if (bink_decode_plane(c, &gb, 3, 0) < 0)
1196 if (c->version >= 'i')
1197 skip_bits_long(&gb, 32);
1199 for (plane = 0; plane < 3; plane++) {
1200 plane_idx = (!plane || !c->swap_planes) ? plane : (plane ^ 3);
1202 if (c->version > 'b') {
1203 if (bink_decode_plane(c, &gb, plane_idx, !!plane) < 0)
1206 if (binkb_decode_plane(c, &gb, plane_idx, !pkt->pts, !!plane) < 0)
1209 if (get_bits_count(&gb) >= bits_count)
1214 *data_size = sizeof(AVFrame);
1215 *(AVFrame*)data = c->pic;
1217 if (c->version > 'b')
1218 FFSWAP(AVFrame, c->pic, c->last);
1220 /* always report that the buffer was completely consumed */
1225 * Caclulate quantization tables for version b
1227 static av_cold void binkb_calc_quant(void)
1229 uint8_t inv_bink_scan[64];
1233 for (j = 0; j < 8; j++) {
1234 for (i = 0; i < 8; i++) {
1237 s[j*8 + i] = cos(j * M_PI/16.0) * cos(i * M_PI/16.0) * 2.0;
1239 s[j*8 + i] = cos(j * M_PI/16.0) * sqrt(2.0);
1242 s[j*8 + i] = cos(i * M_PI/16.0) * sqrt(2.0);
1248 for (i = 0; i < 64; i++)
1249 inv_bink_scan[bink_scan[i]] = i;
1251 for (j = 0; j < 16; j++) {
1252 for (i = 0; i < 64; i++) {
1253 int k = inv_bink_scan[i];
1255 binkb_intra_quant[j][k] = (1L << 12) * binkb_intra_seed[i] *
1256 binkb_num[j]/binkb_den[j];
1257 binkb_inter_quant[j][k] = (1L << 12) * binkb_inter_seed[i] *
1258 binkb_num[j]/binkb_den[j];
1260 binkb_intra_quant[j][k] = (1L << 12) * binkb_intra_seed[i] * s[i] *
1261 binkb_num[j]/(double)binkb_den[j];
1262 binkb_inter_quant[j][k] = (1L << 12) * binkb_inter_seed[i] * s[i] *
1263 binkb_num[j]/(double)binkb_den[j];
1269 static av_cold int decode_init(AVCodecContext *avctx)
1271 BinkContext * const c = avctx->priv_data;
1272 static VLC_TYPE table[16 * 128][2];
1273 static int binkb_initialised = 0;
1277 c->version = avctx->codec_tag >> 24;
1278 if (avctx->extradata_size < 4) {
1279 av_log(avctx, AV_LOG_ERROR, "Extradata missing or too short\n");
1282 flags = AV_RL32(avctx->extradata);
1283 c->has_alpha = flags & BINK_FLAG_ALPHA;
1284 c->swap_planes = c->version >= 'h';
1285 if (!bink_trees[15].table) {
1286 for (i = 0; i < 16; i++) {
1287 const int maxbits = bink_tree_lens[i][15];
1288 bink_trees[i].table = table + i*128;
1289 bink_trees[i].table_allocated = 1 << maxbits;
1290 init_vlc(&bink_trees[i], maxbits, 16,
1291 bink_tree_lens[i], 1, 1,
1292 bink_tree_bits[i], 1, 1, INIT_VLC_USE_NEW_STATIC | INIT_VLC_LE);
1297 c->pic.data[0] = NULL;
1299 if (av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
1303 avctx->pix_fmt = c->has_alpha ? PIX_FMT_YUVA420P : PIX_FMT_YUV420P;
1305 avctx->idct_algo = FF_IDCT_BINK;
1306 dsputil_init(&c->dsp, avctx);
1307 ff_init_scantable(c->dsp.idct_permutation, &c->scantable, bink_scan);
1311 if (c->version == 'b') {
1312 if (!binkb_initialised) {
1314 binkb_initialised = 1;
1321 static av_cold int decode_end(AVCodecContext *avctx)
1323 BinkContext * const c = avctx->priv_data;
1326 avctx->release_buffer(avctx, &c->pic);
1327 if (c->last.data[0])
1328 avctx->release_buffer(avctx, &c->last);
1334 AVCodec ff_bink_decoder = {
1338 sizeof(BinkContext),
1343 .long_name = NULL_IF_CONFIG_SMALL("Bink video"),