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;
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)
183 bw = (c->avctx->width + 7) >> 3;
184 bh = (c->avctx->height + 7) >> 3;
187 for (i = 0; i < BINKB_NB_SRC; i++) {
188 c->bundle[i].data = av_mallocz(blocks * 64);
189 if (!c->bundle[i].data)
190 return AVERROR(ENOMEM);
191 c->bundle[i].data_end = c->bundle[i].data + blocks * 64;
198 * Free memory used by bundles.
200 * @param c decoder context
202 static av_cold void free_bundles(BinkContext *c)
205 for (i = 0; i < BINKB_NB_SRC; i++)
206 av_freep(&c->bundle[i].data);
210 * Merge two consequent lists of equal size depending on bits read.
212 * @param gb context for reading bits
213 * @param dst buffer where merged list will be written to
214 * @param src pointer to the head of the first list (the second lists starts at src+size)
215 * @param size input lists size
217 static void merge(GetBitContext *gb, uint8_t *dst, uint8_t *src, int size)
219 uint8_t *src2 = src + size;
223 if (!get_bits1(gb)) {
230 } while (size && size2);
239 * Read information about Huffman tree used to decode data.
241 * @param gb context for reading bits
242 * @param tree pointer for storing tree data
244 static void read_tree(GetBitContext *gb, Tree *tree)
246 uint8_t tmp1[16] = { 0 }, tmp2[16], *in = tmp1, *out = tmp2;
249 tree->vlc_num = get_bits(gb, 4);
250 if (!tree->vlc_num) {
251 for (i = 0; i < 16; i++)
256 len = get_bits(gb, 3);
257 for (i = 0; i <= len; i++) {
258 tree->syms[i] = get_bits(gb, 4);
259 tmp1[tree->syms[i]] = 1;
261 for (i = 0; i < 16 && len < 16 - 1; i++)
263 tree->syms[++len] = i;
265 len = get_bits(gb, 2);
266 for (i = 0; i < 16; i++)
268 for (i = 0; i <= len; i++) {
270 for (t = 0; t < 16; t += size << 1)
271 merge(gb, out + t, in + t, size);
272 FFSWAP(uint8_t*, in, out);
274 memcpy(tree->syms, in, 16);
279 * Prepare bundle for decoding data.
281 * @param gb context for reading bits
282 * @param c decoder context
283 * @param bundle_num number of the bundle to initialize
285 static void read_bundle(GetBitContext *gb, BinkContext *c, int bundle_num)
289 if (bundle_num == BINK_SRC_COLORS) {
290 for (i = 0; i < 16; i++)
291 read_tree(gb, &c->col_high[i]);
294 if (bundle_num != BINK_SRC_INTRA_DC && bundle_num != BINK_SRC_INTER_DC)
295 read_tree(gb, &c->bundle[bundle_num].tree);
296 c->bundle[bundle_num].cur_dec =
297 c->bundle[bundle_num].cur_ptr = c->bundle[bundle_num].data;
301 * common check before starting decoding bundle data
303 * @param gb context for reading bits
305 * @param t variable where number of elements to decode will be stored
307 #define CHECK_READ_VAL(gb, b, t) \
308 if (!b->cur_dec || (b->cur_dec > b->cur_ptr)) \
310 t = get_bits(gb, b->len); \
316 static int read_runs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
319 const uint8_t *dec_end;
321 CHECK_READ_VAL(gb, b, t);
322 dec_end = b->cur_dec + t;
323 if (dec_end > b->data_end) {
324 av_log(avctx, AV_LOG_ERROR, "Run value went out of bounds\n");
325 return AVERROR_INVALIDDATA;
329 memset(b->cur_dec, v, t);
332 while (b->cur_dec < dec_end)
333 *b->cur_dec++ = GET_HUFF(gb, b->tree);
338 static int read_motion_values(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
341 const uint8_t *dec_end;
343 CHECK_READ_VAL(gb, b, t);
344 dec_end = b->cur_dec + t;
345 if (dec_end > b->data_end) {
346 av_log(avctx, AV_LOG_ERROR, "Too many motion values\n");
347 return AVERROR_INVALIDDATA;
352 sign = -get_bits1(gb);
353 v = (v ^ sign) - sign;
355 memset(b->cur_dec, v, t);
358 while (b->cur_dec < dec_end) {
359 v = GET_HUFF(gb, b->tree);
361 sign = -get_bits1(gb);
362 v = (v ^ sign) - sign;
370 static const uint8_t bink_rlelens[4] = { 4, 8, 12, 32 };
372 static int read_block_types(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
374 BinkContext * const c = avctx->priv_data;
377 const uint8_t *dec_end;
379 CHECK_READ_VAL(gb, b, t);
380 if (c->version == 'k') {
387 dec_end = b->cur_dec + t;
388 if (dec_end > b->data_end) {
389 av_log(avctx, AV_LOG_ERROR, "Too many block type values\n");
390 return AVERROR_INVALIDDATA;
394 memset(b->cur_dec, v, t);
397 while (b->cur_dec < dec_end) {
398 v = GET_HUFF(gb, b->tree);
403 int run = bink_rlelens[v - 12];
405 if (dec_end - b->cur_dec < run)
406 return AVERROR_INVALIDDATA;
407 memset(b->cur_dec, last, run);
415 static int read_patterns(AVCodecContext *avctx, GetBitContext *gb, Bundle *b)
418 const uint8_t *dec_end;
420 CHECK_READ_VAL(gb, b, t);
421 dec_end = b->cur_dec + t;
422 if (dec_end > b->data_end) {
423 av_log(avctx, AV_LOG_ERROR, "Too many pattern values\n");
424 return AVERROR_INVALIDDATA;
426 while (b->cur_dec < dec_end) {
427 v = GET_HUFF(gb, b->tree);
428 v |= GET_HUFF(gb, b->tree) << 4;
435 static int read_colors(GetBitContext *gb, Bundle *b, BinkContext *c)
438 const uint8_t *dec_end;
440 CHECK_READ_VAL(gb, b, t);
441 dec_end = b->cur_dec + t;
442 if (dec_end > b->data_end) {
443 av_log(c->avctx, AV_LOG_ERROR, "Too many color values\n");
444 return AVERROR_INVALIDDATA;
447 c->col_lastval = GET_HUFF(gb, c->col_high[c->col_lastval]);
448 v = GET_HUFF(gb, b->tree);
449 v = (c->col_lastval << 4) | v;
450 if (c->version < 'i') {
451 sign = ((int8_t) v) >> 7;
452 v = ((v & 0x7F) ^ sign) - sign;
455 memset(b->cur_dec, v, t);
458 while (b->cur_dec < dec_end) {
459 c->col_lastval = GET_HUFF(gb, c->col_high[c->col_lastval]);
460 v = GET_HUFF(gb, b->tree);
461 v = (c->col_lastval << 4) | v;
462 if (c->version < 'i') {
463 sign = ((int8_t) v) >> 7;
464 v = ((v & 0x7F) ^ sign) - sign;
473 /** number of bits used to store first DC value in bundle */
474 #define DC_START_BITS 11
476 static int read_dcs(AVCodecContext *avctx, GetBitContext *gb, Bundle *b,
477 int start_bits, int has_sign)
479 int i, j, len, len2, bsize, sign, v, v2;
480 int16_t *dst = (int16_t*)b->cur_dec;
481 int16_t *dst_end = (int16_t*)b->data_end;
483 CHECK_READ_VAL(gb, b, len);
484 v = get_bits(gb, start_bits - has_sign);
486 sign = -get_bits1(gb);
487 v = (v ^ sign) - sign;
489 if (dst_end - dst < 1)
490 return AVERROR_INVALIDDATA;
493 for (i = 0; i < len; i += 8) {
494 len2 = FFMIN(len - i, 8);
495 if (dst_end - dst < len2)
496 return AVERROR_INVALIDDATA;
497 bsize = get_bits(gb, 4);
499 for (j = 0; j < len2; j++) {
500 v2 = get_bits(gb, bsize);
502 sign = -get_bits1(gb);
503 v2 = (v2 ^ sign) - sign;
507 if (v < -32768 || v > 32767) {
508 av_log(avctx, AV_LOG_ERROR, "DC value went out of bounds: %d\n", v);
509 return AVERROR_INVALIDDATA;
513 for (j = 0; j < len2; j++)
518 b->cur_dec = (uint8_t*)dst;
523 * Retrieve next value from bundle.
525 * @param c decoder context
526 * @param bundle bundle number
528 static inline int get_value(BinkContext *c, int bundle)
532 if (bundle < BINK_SRC_X_OFF || bundle == BINK_SRC_RUN)
533 return *c->bundle[bundle].cur_ptr++;
534 if (bundle == BINK_SRC_X_OFF || bundle == BINK_SRC_Y_OFF)
535 return (int8_t)*c->bundle[bundle].cur_ptr++;
536 ret = *(int16_t*)c->bundle[bundle].cur_ptr;
537 c->bundle[bundle].cur_ptr += 2;
541 static av_cold void binkb_init_bundle(BinkContext *c, int bundle_num)
543 c->bundle[bundle_num].cur_dec =
544 c->bundle[bundle_num].cur_ptr = c->bundle[bundle_num].data;
545 c->bundle[bundle_num].len = 13;
548 static av_cold void binkb_init_bundles(BinkContext *c)
551 for (i = 0; i < BINKB_NB_SRC; i++)
552 binkb_init_bundle(c, i);
555 static int binkb_read_bundle(BinkContext *c, GetBitContext *gb, int bundle_num)
557 const int bits = binkb_bundle_sizes[bundle_num];
558 const int mask = 1 << (bits - 1);
559 const int issigned = binkb_bundle_signed[bundle_num];
560 Bundle *b = &c->bundle[bundle_num];
563 CHECK_READ_VAL(gb, b, len);
564 if (b->data_end - b->cur_dec < len * (1 + (bits > 8)))
565 return AVERROR_INVALIDDATA;
568 for (i = 0; i < len; i++)
569 *b->cur_dec++ = get_bits(gb, bits);
571 for (i = 0; i < len; i++)
572 *b->cur_dec++ = get_bits(gb, bits) - mask;
575 int16_t *dst = (int16_t*)b->cur_dec;
578 for (i = 0; i < len; i++)
579 *dst++ = get_bits(gb, bits);
581 for (i = 0; i < len; i++)
582 *dst++ = get_bits(gb, bits) - mask;
584 b->cur_dec = (uint8_t*)dst;
589 static inline int binkb_get_value(BinkContext *c, int bundle_num)
592 const int bits = binkb_bundle_sizes[bundle_num];
595 int val = *c->bundle[bundle_num].cur_ptr++;
596 return binkb_bundle_signed[bundle_num] ? (int8_t)val : val;
598 ret = *(int16_t*)c->bundle[bundle_num].cur_ptr;
599 c->bundle[bundle_num].cur_ptr += 2;
604 * Read 8x8 block of DCT coefficients.
606 * @param gb context for reading bits
607 * @param block place for storing coefficients
608 * @param scan scan order table
609 * @param quant_matrices quantization matrices
610 * @return 0 for success, negative value in other cases
612 static int read_dct_coeffs(GetBitContext *gb, int32_t block[64],
613 const uint8_t *scan, int *coef_count_,
614 int coef_idx[64], int q)
618 int i, t, bits, ccoef, mode, sign;
619 int list_start = 64, list_end = 64, list_pos;
623 coef_list[list_end] = 4; mode_list[list_end++] = 0;
624 coef_list[list_end] = 24; mode_list[list_end++] = 0;
625 coef_list[list_end] = 44; mode_list[list_end++] = 0;
626 coef_list[list_end] = 1; mode_list[list_end++] = 3;
627 coef_list[list_end] = 2; mode_list[list_end++] = 3;
628 coef_list[list_end] = 3; mode_list[list_end++] = 3;
630 for (bits = get_bits(gb, 4) - 1; bits >= 0; bits--) {
631 list_pos = list_start;
632 while (list_pos < list_end) {
633 if (!(mode_list[list_pos] | coef_list[list_pos]) || !get_bits1(gb)) {
637 ccoef = coef_list[list_pos];
638 mode = mode_list[list_pos];
641 coef_list[list_pos] = ccoef + 4;
642 mode_list[list_pos] = 1;
645 coef_list[list_pos] = 0;
646 mode_list[list_pos++] = 0;
648 for (i = 0; i < 4; i++, ccoef++) {
650 coef_list[--list_start] = ccoef;
651 mode_list[ list_start] = 3;
654 t = 1 - (get_bits1(gb) << 1);
656 t = get_bits(gb, bits) | 1 << bits;
657 sign = -get_bits1(gb);
658 t = (t ^ sign) - sign;
660 block[scan[ccoef]] = t;
661 coef_idx[coef_count++] = ccoef;
666 mode_list[list_pos] = 2;
667 for (i = 0; i < 3; i++) {
669 coef_list[list_end] = ccoef;
670 mode_list[list_end++] = 2;
675 t = 1 - (get_bits1(gb) << 1);
677 t = get_bits(gb, bits) | 1 << bits;
678 sign = -get_bits1(gb);
679 t = (t ^ sign) - sign;
681 block[scan[ccoef]] = t;
682 coef_idx[coef_count++] = ccoef;
683 coef_list[list_pos] = 0;
684 mode_list[list_pos++] = 0;
691 quant_idx = get_bits(gb, 4);
694 if (quant_idx > 15U) {
695 av_log(NULL, AV_LOG_ERROR, "quant_index %d out of range\n", quant_idx);
696 return AVERROR_INVALIDDATA;
700 *coef_count_ = coef_count;
705 static void unquantize_dct_coeffs(int32_t block[64], const int32_t quant[64],
706 int coef_count, int coef_idx[64],
710 block[0] = (block[0] * quant[0]) >> 11;
711 for (i = 0; i < coef_count; i++) {
712 int idx = coef_idx[i];
713 block[scan[idx]] = (block[scan[idx]] * quant[idx]) >> 11;
718 * Read 8x8 block with residue after motion compensation.
720 * @param gb context for reading bits
721 * @param block place to store read data
722 * @param masks_count number of masks to decode
723 * @return 0 on success, negative value in other cases
725 static int read_residue(GetBitContext *gb, int16_t block[64], int masks_count)
729 int i, sign, mask, ccoef, mode;
730 int list_start = 64, list_end = 64, list_pos;
732 int nz_coeff_count = 0;
734 coef_list[list_end] = 4; mode_list[list_end++] = 0;
735 coef_list[list_end] = 24; mode_list[list_end++] = 0;
736 coef_list[list_end] = 44; mode_list[list_end++] = 0;
737 coef_list[list_end] = 0; mode_list[list_end++] = 2;
739 for (mask = 1 << get_bits(gb, 3); mask; mask >>= 1) {
740 for (i = 0; i < nz_coeff_count; i++) {
743 if (block[nz_coeff[i]] < 0)
744 block[nz_coeff[i]] -= mask;
746 block[nz_coeff[i]] += mask;
751 list_pos = list_start;
752 while (list_pos < list_end) {
753 if (!(coef_list[list_pos] | mode_list[list_pos]) || !get_bits1(gb)) {
757 ccoef = coef_list[list_pos];
758 mode = mode_list[list_pos];
761 coef_list[list_pos] = ccoef + 4;
762 mode_list[list_pos] = 1;
765 coef_list[list_pos] = 0;
766 mode_list[list_pos++] = 0;
768 for (i = 0; i < 4; i++, ccoef++) {
770 coef_list[--list_start] = ccoef;
771 mode_list[ list_start] = 3;
773 nz_coeff[nz_coeff_count++] = bink_scan[ccoef];
774 sign = -get_bits1(gb);
775 block[bink_scan[ccoef]] = (mask ^ sign) - sign;
783 mode_list[list_pos] = 2;
784 for (i = 0; i < 3; i++) {
786 coef_list[list_end] = ccoef;
787 mode_list[list_end++] = 2;
791 nz_coeff[nz_coeff_count++] = bink_scan[ccoef];
792 sign = -get_bits1(gb);
793 block[bink_scan[ccoef]] = (mask ^ sign) - sign;
794 coef_list[list_pos] = 0;
795 mode_list[list_pos++] = 0;
808 * Copy 8x8 block from source to destination, where src and dst may be overlapped
810 static inline void put_pixels8x8_overlapped(uint8_t *dst, uint8_t *src, int stride)
814 for (i = 0; i < 8; i++)
815 memcpy(tmp + i*8, src + i*stride, 8);
816 for (i = 0; i < 8; i++)
817 memcpy(dst + i*stride, tmp + i*8, 8);
820 static int binkb_decode_plane(BinkContext *c, AVFrame *frame, GetBitContext *gb,
821 int plane_idx, int is_key, int is_chroma)
825 uint8_t *dst, *ref, *ref_start, *ref_end;
829 LOCAL_ALIGNED_32(int16_t, block, [64]);
830 LOCAL_ALIGNED_16(int32_t, dctblock, [64]);
832 int ybias = is_key ? -15 : 0;
833 int qp, quant_idx, coef_count, coef_idx[64];
835 const int stride = frame->linesize[plane_idx];
836 int bw = is_chroma ? (c->avctx->width + 15) >> 4 : (c->avctx->width + 7) >> 3;
837 int bh = is_chroma ? (c->avctx->height + 15) >> 4 : (c->avctx->height + 7) >> 3;
839 binkb_init_bundles(c);
840 ref_start = frame->data[plane_idx];
841 ref_end = frame->data[plane_idx] + (bh * frame->linesize[plane_idx] + bw) * 8;
843 for (i = 0; i < 64; i++)
844 coordmap[i] = (i & 7) + (i >> 3) * stride;
846 for (by = 0; by < bh; by++) {
847 for (i = 0; i < BINKB_NB_SRC; i++) {
848 if ((ret = binkb_read_bundle(c, gb, i)) < 0)
852 dst = frame->data[plane_idx] + 8*by*stride;
853 for (bx = 0; bx < bw; bx++, dst += 8) {
854 blk = binkb_get_value(c, BINKB_SRC_BLOCK_TYPES);
859 scan = bink_patterns[get_bits(gb, 4)];
864 mode = get_bits1(gb);
865 run = get_bits(gb, binkb_runbits[i]) + 1;
869 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
870 return AVERROR_INVALIDDATA;
873 v = binkb_get_value(c, BINKB_SRC_COLORS);
874 for (j = 0; j < run; j++)
875 dst[coordmap[*scan++]] = v;
877 for (j = 0; j < run; j++)
878 dst[coordmap[*scan++]] = binkb_get_value(c, BINKB_SRC_COLORS);
882 dst[coordmap[*scan++]] = binkb_get_value(c, BINKB_SRC_COLORS);
885 memset(dctblock, 0, sizeof(*dctblock) * 64);
886 dctblock[0] = binkb_get_value(c, BINKB_SRC_INTRA_DC);
887 qp = binkb_get_value(c, BINKB_SRC_INTRA_Q);
888 if ((quant_idx = read_dct_coeffs(gb, dctblock, bink_scan, &coef_count, coef_idx, qp)) < 0)
890 unquantize_dct_coeffs(dctblock, binkb_intra_quant[quant_idx], coef_count, coef_idx, bink_scan);
891 c->binkdsp.idct_put(dst, stride, dctblock);
894 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
895 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
896 ref = dst + xoff + yoff * stride;
897 if (ref < ref_start || ref + 8*stride > ref_end) {
898 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
899 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
900 c->hdsp.put_pixels_tab[1][0](dst, ref, stride, 8);
902 put_pixels8x8_overlapped(dst, ref, stride);
904 c->bdsp.clear_block(block);
905 v = binkb_get_value(c, BINKB_SRC_INTER_COEFS);
906 read_residue(gb, block, v);
907 c->binkdsp.add_pixels8(dst, block, stride);
910 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
911 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
912 ref = dst + xoff + yoff * stride;
913 if (ref < ref_start || ref + 8 * stride > ref_end) {
914 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
915 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
916 c->hdsp.put_pixels_tab[1][0](dst, ref, stride, 8);
918 put_pixels8x8_overlapped(dst, ref, stride);
920 memset(dctblock, 0, sizeof(*dctblock) * 64);
921 dctblock[0] = binkb_get_value(c, BINKB_SRC_INTER_DC);
922 qp = binkb_get_value(c, BINKB_SRC_INTER_Q);
923 if ((quant_idx = read_dct_coeffs(gb, dctblock, bink_scan, &coef_count, coef_idx, qp)) < 0)
925 unquantize_dct_coeffs(dctblock, binkb_inter_quant[quant_idx], coef_count, coef_idx, bink_scan);
926 c->binkdsp.idct_add(dst, stride, dctblock);
929 v = binkb_get_value(c, BINKB_SRC_COLORS);
930 c->bdsp.fill_block_tab[1](dst, v, stride, 8);
933 for (i = 0; i < 2; i++)
934 col[i] = binkb_get_value(c, BINKB_SRC_COLORS);
935 for (i = 0; i < 8; i++) {
936 v = binkb_get_value(c, BINKB_SRC_PATTERN);
937 for (j = 0; j < 8; j++, v >>= 1)
938 dst[i*stride + j] = col[v & 1];
942 xoff = binkb_get_value(c, BINKB_SRC_X_OFF);
943 yoff = binkb_get_value(c, BINKB_SRC_Y_OFF) + ybias;
944 ref = dst + xoff + yoff * stride;
945 if (ref < ref_start || ref + 8 * stride > ref_end) {
946 av_log(c->avctx, AV_LOG_WARNING, "Reference block is out of bounds\n");
947 } else if (ref + 8*stride < dst || ref >= dst + 8*stride) {
948 c->hdsp.put_pixels_tab[1][0](dst, ref, stride, 8);
950 put_pixels8x8_overlapped(dst, ref, stride);
954 for (i = 0; i < 8; i++)
955 memcpy(dst + i*stride, c->bundle[BINKB_SRC_COLORS].cur_ptr + i*8, 8);
956 c->bundle[BINKB_SRC_COLORS].cur_ptr += 64;
959 av_log(c->avctx, AV_LOG_ERROR, "Unknown block type %d\n", blk);
960 return AVERROR_INVALIDDATA;
964 if (get_bits_count(gb) & 0x1F) //next plane data starts at 32-bit boundary
965 skip_bits_long(gb, 32 - (get_bits_count(gb) & 0x1F));
970 static int bink_put_pixels(BinkContext *c,
971 uint8_t *dst, uint8_t *prev, int stride,
975 int xoff = get_value(c, BINK_SRC_X_OFF);
976 int yoff = get_value(c, BINK_SRC_Y_OFF);
977 uint8_t *ref = prev + xoff + yoff * stride;
978 if (ref < ref_start || ref > ref_end) {
979 av_log(c->avctx, AV_LOG_ERROR, "Copy out of bounds @%d, %d\n",
981 return AVERROR_INVALIDDATA;
983 c->hdsp.put_pixels_tab[1][0](dst, ref, stride, 8);
988 static int bink_decode_plane(BinkContext *c, AVFrame *frame, GetBitContext *gb,
989 int plane_idx, int is_chroma)
993 uint8_t *dst, *prev, *ref_start, *ref_end;
996 LOCAL_ALIGNED_32(int16_t, block, [64]);
997 LOCAL_ALIGNED_16(uint8_t, ublock, [64]);
998 LOCAL_ALIGNED_16(int32_t, dctblock, [64]);
999 int coordmap[64], quant_idx, coef_count, coef_idx[64];
1001 const int stride = frame->linesize[plane_idx];
1002 int bw = is_chroma ? (c->avctx->width + 15) >> 4 : (c->avctx->width + 7) >> 3;
1003 int bh = is_chroma ? (c->avctx->height + 15) >> 4 : (c->avctx->height + 7) >> 3;
1004 int width = c->avctx->width >> is_chroma;
1005 int height = c->avctx->height >> is_chroma;
1007 if (c->version == 'k' && get_bits1(gb)) {
1008 int fill = get_bits(gb, 8);
1010 dst = frame->data[plane_idx];
1012 for (i = 0; i < height; i++)
1013 memset(dst + i * stride, fill, width);
1017 init_lengths(c, FFMAX(width, 8), bw);
1018 for (i = 0; i < BINK_NB_SRC; i++)
1019 read_bundle(gb, c, i);
1021 ref_start = c->last->data[plane_idx] ? c->last->data[plane_idx]
1022 : frame->data[plane_idx];
1024 + (bw - 1 + c->last->linesize[plane_idx] * (bh - 1)) * 8;
1026 for (i = 0; i < 64; i++)
1027 coordmap[i] = (i & 7) + (i >> 3) * stride;
1029 for (by = 0; by < bh; by++) {
1030 if ((ret = read_block_types(c->avctx, gb, &c->bundle[BINK_SRC_BLOCK_TYPES])) < 0)
1032 if ((ret = read_block_types(c->avctx, gb, &c->bundle[BINK_SRC_SUB_BLOCK_TYPES])) < 0)
1034 if ((ret = read_colors(gb, &c->bundle[BINK_SRC_COLORS], c)) < 0)
1036 if ((ret = read_patterns(c->avctx, gb, &c->bundle[BINK_SRC_PATTERN])) < 0)
1038 if ((ret = read_motion_values(c->avctx, gb, &c->bundle[BINK_SRC_X_OFF])) < 0)
1040 if ((ret = read_motion_values(c->avctx, gb, &c->bundle[BINK_SRC_Y_OFF])) < 0)
1042 if ((ret = read_dcs(c->avctx, gb, &c->bundle[BINK_SRC_INTRA_DC], DC_START_BITS, 0)) < 0)
1044 if ((ret = read_dcs(c->avctx, gb, &c->bundle[BINK_SRC_INTER_DC], DC_START_BITS, 1)) < 0)
1046 if ((ret = read_runs(c->avctx, gb, &c->bundle[BINK_SRC_RUN])) < 0)
1051 dst = frame->data[plane_idx] + 8*by*stride;
1052 prev = (c->last->data[plane_idx] ? c->last->data[plane_idx]
1053 : frame->data[plane_idx]) + 8*by*stride;
1054 for (bx = 0; bx < bw; bx++, dst += 8, prev += 8) {
1055 blk = get_value(c, BINK_SRC_BLOCK_TYPES);
1056 // 16x16 block type on odd line means part of the already decoded block, so skip it
1057 if ((by & 1) && blk == SCALED_BLOCK) {
1065 c->hdsp.put_pixels_tab[1][0](dst, prev, stride, 8);
1068 blk = get_value(c, BINK_SRC_SUB_BLOCK_TYPES);
1071 scan = bink_patterns[get_bits(gb, 4)];
1074 int run = get_value(c, BINK_SRC_RUN) + 1;
1078 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
1079 return AVERROR_INVALIDDATA;
1081 if (get_bits1(gb)) {
1082 v = get_value(c, BINK_SRC_COLORS);
1083 for (j = 0; j < run; j++)
1084 ublock[*scan++] = v;
1086 for (j = 0; j < run; j++)
1087 ublock[*scan++] = get_value(c, BINK_SRC_COLORS);
1091 ublock[*scan++] = get_value(c, BINK_SRC_COLORS);
1094 memset(dctblock, 0, sizeof(*dctblock) * 64);
1095 dctblock[0] = get_value(c, BINK_SRC_INTRA_DC);
1096 if ((quant_idx = read_dct_coeffs(gb, dctblock, bink_scan, &coef_count, coef_idx, -1)) < 0)
1098 unquantize_dct_coeffs(dctblock, bink_intra_quant[quant_idx], coef_count, coef_idx, bink_scan);
1099 c->binkdsp.idct_put(ublock, 8, dctblock);
1102 v = get_value(c, BINK_SRC_COLORS);
1103 c->bdsp.fill_block_tab[0](dst, v, stride, 16);
1106 for (i = 0; i < 2; i++)
1107 col[i] = get_value(c, BINK_SRC_COLORS);
1108 for (j = 0; j < 8; j++) {
1109 v = get_value(c, BINK_SRC_PATTERN);
1110 for (i = 0; i < 8; i++, v >>= 1)
1111 ublock[i + j*8] = col[v & 1];
1115 for (j = 0; j < 8; j++)
1116 for (i = 0; i < 8; i++)
1117 ublock[i + j*8] = get_value(c, BINK_SRC_COLORS);
1120 av_log(c->avctx, AV_LOG_ERROR, "Incorrect 16x16 block type %d\n", blk);
1121 return AVERROR_INVALIDDATA;
1123 if (blk != FILL_BLOCK)
1124 c->binkdsp.scale_block(ublock, dst, stride);
1130 ret = bink_put_pixels(c, dst, prev, stride,
1131 ref_start, ref_end);
1136 scan = bink_patterns[get_bits(gb, 4)];
1139 int run = get_value(c, BINK_SRC_RUN) + 1;
1143 av_log(c->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
1144 return AVERROR_INVALIDDATA;
1146 if (get_bits1(gb)) {
1147 v = get_value(c, BINK_SRC_COLORS);
1148 for (j = 0; j < run; j++)
1149 dst[coordmap[*scan++]] = v;
1151 for (j = 0; j < run; j++)
1152 dst[coordmap[*scan++]] = get_value(c, BINK_SRC_COLORS);
1156 dst[coordmap[*scan++]] = get_value(c, BINK_SRC_COLORS);
1159 ret = bink_put_pixels(c, dst, prev, stride,
1160 ref_start, ref_end);
1163 c->bdsp.clear_block(block);
1164 v = get_bits(gb, 7);
1165 read_residue(gb, block, v);
1166 c->binkdsp.add_pixels8(dst, block, stride);
1169 memset(dctblock, 0, sizeof(*dctblock) * 64);
1170 dctblock[0] = get_value(c, BINK_SRC_INTRA_DC);
1171 if ((quant_idx = read_dct_coeffs(gb, dctblock, bink_scan, &coef_count, coef_idx, -1)) < 0)
1173 unquantize_dct_coeffs(dctblock, bink_intra_quant[quant_idx], coef_count, coef_idx, bink_scan);
1174 c->binkdsp.idct_put(dst, stride, dctblock);
1177 v = get_value(c, BINK_SRC_COLORS);
1178 c->bdsp.fill_block_tab[1](dst, v, stride, 8);
1181 ret = bink_put_pixels(c, dst, prev, stride,
1182 ref_start, ref_end);
1185 memset(dctblock, 0, sizeof(*dctblock) * 64);
1186 dctblock[0] = get_value(c, BINK_SRC_INTER_DC);
1187 if ((quant_idx = read_dct_coeffs(gb, dctblock, bink_scan, &coef_count, coef_idx, -1)) < 0)
1189 unquantize_dct_coeffs(dctblock, bink_inter_quant[quant_idx], coef_count, coef_idx, bink_scan);
1190 c->binkdsp.idct_add(dst, stride, dctblock);
1193 for (i = 0; i < 2; i++)
1194 col[i] = get_value(c, BINK_SRC_COLORS);
1195 for (i = 0; i < 8; i++) {
1196 v = get_value(c, BINK_SRC_PATTERN);
1197 for (j = 0; j < 8; j++, v >>= 1)
1198 dst[i*stride + j] = col[v & 1];
1202 for (i = 0; i < 8; i++)
1203 memcpy(dst + i*stride, c->bundle[BINK_SRC_COLORS].cur_ptr + i*8, 8);
1204 c->bundle[BINK_SRC_COLORS].cur_ptr += 64;
1207 av_log(c->avctx, AV_LOG_ERROR, "Unknown block type %d\n", blk);
1208 return AVERROR_INVALIDDATA;
1214 if (get_bits_count(gb) & 0x1F) //next plane data starts at 32-bit boundary
1215 skip_bits_long(gb, 32 - (get_bits_count(gb) & 0x1F));
1220 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *pkt)
1222 BinkContext * const c = avctx->priv_data;
1223 AVFrame *frame = data;
1225 int plane, plane_idx, ret;
1226 int bits_count = pkt->size << 3;
1228 if (c->version > 'b') {
1229 if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
1232 if ((ret = ff_reget_buffer(avctx, c->last)) < 0)
1234 if ((ret = av_frame_ref(frame, c->last)) < 0)
1238 init_get_bits(&gb, pkt->data, bits_count);
1240 if (c->version >= 'i')
1241 skip_bits_long(&gb, 32);
1242 if ((ret = bink_decode_plane(c, frame, &gb, 3, 0)) < 0)
1245 if (c->version >= 'i')
1246 skip_bits_long(&gb, 32);
1250 for (plane = 0; plane < 3; plane++) {
1251 plane_idx = (!plane || !c->swap_planes) ? plane : (plane ^ 3);
1253 if (c->version > 'b') {
1254 if ((ret = bink_decode_plane(c, frame, &gb, plane_idx, !!plane)) < 0)
1257 if ((ret = binkb_decode_plane(c, frame, &gb, plane_idx,
1258 c->frame_num == 1, !!plane)) < 0)
1261 if (get_bits_count(&gb) >= bits_count)
1266 if (c->version > 'b') {
1267 av_frame_unref(c->last);
1268 if ((ret = av_frame_ref(c->last, frame)) < 0)
1274 /* always report that the buffer was completely consumed */
1279 * Calculate quantization tables for version b
1281 static av_cold void binkb_calc_quant(void)
1283 uint8_t inv_bink_scan[64];
1284 static const int s[64]={
1285 1073741824,1489322693,1402911301,1262586814,1073741824, 843633538, 581104888, 296244703,
1286 1489322693,2065749918,1945893874,1751258219,1489322693,1170153332, 806015634, 410903207,
1287 1402911301,1945893874,1832991949,1649649171,1402911301,1102260336, 759250125, 387062357,
1288 1262586814,1751258219,1649649171,1484645031,1262586814, 992008094, 683307060, 348346918,
1289 1073741824,1489322693,1402911301,1262586814,1073741824, 843633538, 581104888, 296244703,
1290 843633538,1170153332,1102260336, 992008094, 843633538, 662838617, 456571181, 232757969,
1291 581104888, 806015634, 759250125, 683307060, 581104888, 456571181, 314491699, 160326478,
1292 296244703, 410903207, 387062357, 348346918, 296244703, 232757969, 160326478, 81733730,
1296 for (i = 0; i < 64; i++)
1297 inv_bink_scan[bink_scan[i]] = i;
1299 for (j = 0; j < 16; j++) {
1300 for (i = 0; i < 64; i++) {
1301 int k = inv_bink_scan[i];
1302 binkb_intra_quant[j][k] = binkb_intra_seed[i] * (int64_t)s[i] *
1303 binkb_num[j]/(binkb_den[j] * (C>>12));
1304 binkb_inter_quant[j][k] = binkb_inter_seed[i] * (int64_t)s[i] *
1305 binkb_num[j]/(binkb_den[j] * (C>>12));
1310 static av_cold int decode_init(AVCodecContext *avctx)
1312 BinkContext * const c = avctx->priv_data;
1313 static VLC_TYPE table[16 * 128][2];
1314 static int binkb_initialised = 0;
1318 c->version = avctx->codec_tag >> 24;
1319 if (avctx->extradata_size < 4) {
1320 av_log(avctx, AV_LOG_ERROR, "Extradata missing or too short\n");
1321 return AVERROR_INVALIDDATA;
1323 flags = AV_RL32(avctx->extradata);
1324 c->has_alpha = flags & BINK_FLAG_ALPHA;
1325 c->swap_planes = c->version >= 'h';
1326 if (!bink_trees[15].table) {
1327 for (i = 0; i < 16; i++) {
1328 const int maxbits = bink_tree_lens[i][15];
1329 bink_trees[i].table = table + i*128;
1330 bink_trees[i].table_allocated = 1 << maxbits;
1331 init_vlc(&bink_trees[i], maxbits, 16,
1332 bink_tree_lens[i], 1, 1,
1333 bink_tree_bits[i], 1, 1, INIT_VLC_USE_NEW_STATIC | INIT_VLC_LE);
1338 c->last = av_frame_alloc();
1340 return AVERROR(ENOMEM);
1342 if ((ret = av_image_check_size(avctx->width, avctx->height, 0, avctx)) < 0)
1345 avctx->pix_fmt = c->has_alpha ? AV_PIX_FMT_YUVA420P : AV_PIX_FMT_YUV420P;
1346 avctx->color_range = c->version == 'k' ? AVCOL_RANGE_JPEG : AVCOL_RANGE_MPEG;
1348 ff_blockdsp_init(&c->bdsp, avctx);
1349 ff_hpeldsp_init(&c->hdsp, avctx->flags);
1350 ff_binkdsp_init(&c->binkdsp);
1352 if ((ret = init_bundles(c)) < 0) {
1357 if (c->version == 'b') {
1358 if (!binkb_initialised) {
1360 binkb_initialised = 1;
1367 static av_cold int decode_end(AVCodecContext *avctx)
1369 BinkContext * const c = avctx->priv_data;
1371 av_frame_free(&c->last);
1377 static void flush(AVCodecContext *avctx)
1379 BinkContext * const c = avctx->priv_data;
1384 AVCodec ff_bink_decoder = {
1385 .name = "binkvideo",
1386 .long_name = NULL_IF_CONFIG_SMALL("Bink video"),
1387 .type = AVMEDIA_TYPE_VIDEO,
1388 .id = AV_CODEC_ID_BINKVIDEO,
1389 .priv_data_size = sizeof(BinkContext),
1390 .init = decode_init,
1391 .close = decode_end,
1392 .decode = decode_frame,
1394 .capabilities = AV_CODEC_CAP_DR1,