2 * Indeo Video v3 compatible decoder
3 * Copyright (c) 2009 - 2011 Maxim Poliakovski
5 * This file is part of Libav.
7 * Libav is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * Libav is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * This is a decoder for Intel Indeo Video v3.
25 * It is based on vector quantization, run-length coding and motion compensation.
26 * Known container formats: .avi and .mov
27 * Known FOURCCs: 'IV31', 'IV32'
29 * @see http://wiki.multimedia.cx/index.php?title=Indeo_3
32 #include "libavutil/imgutils.h"
33 #include "libavutil/intreadwrite.h"
35 #include "bytestream.h"
40 #include "indeo3data.h"
44 RLE_ESC_F9 = 249, ///< same as RLE_ESC_FA + do the same with next block
45 RLE_ESC_FA = 250, ///< INTRA: skip block, INTER: copy data from reference
46 RLE_ESC_FB = 251, ///< apply null delta to N blocks / skip N blocks
47 RLE_ESC_FC = 252, ///< same as RLE_ESC_FD + do the same with next block
48 RLE_ESC_FD = 253, ///< apply null delta to all remaining lines of this block
49 RLE_ESC_FE = 254, ///< apply null delta to all lines up to the 3rd line
50 RLE_ESC_FF = 255 ///< apply null delta to all lines up to the 2nd line
54 /* Some constants for parsing frame bitstream flags. */
55 #define BS_8BIT_PEL (1 << 1) ///< 8bit pixel bitdepth indicator
56 #define BS_KEYFRAME (1 << 2) ///< intra frame indicator
57 #define BS_MV_Y_HALF (1 << 4) ///< vertical mv halfpel resolution indicator
58 #define BS_MV_X_HALF (1 << 5) ///< horizontal mv halfpel resolution indicator
59 #define BS_NONREF (1 << 8) ///< nonref (discardable) frame indicator
60 #define BS_BUFFER 9 ///< indicates which of two frame buffers should be used
63 typedef struct Plane {
65 uint8_t *pixels[2]; ///< pointer to the actual pixel data of the buffers above
71 #define CELL_STACK_MAX 20
74 int16_t xpos; ///< cell coordinates in 4x4 blocks
76 int16_t width; ///< cell width in 4x4 blocks
77 int16_t height; ///< cell height in 4x4 blocks
78 uint8_t tree; ///< tree id: 0- MC tree, 1 - VQ tree
79 const int8_t *mv_ptr; ///< ptr to the motion vector if any
82 typedef struct Indeo3DecodeContext {
83 AVCodecContext *avctx;
89 const uint8_t *next_cell_data;
90 const uint8_t *last_byte;
91 const int8_t *mc_vectors;
92 unsigned num_vectors; ///< number of motion vectors in mc_vectors
94 int16_t width, height;
95 uint32_t frame_num; ///< current frame number (zero-based)
96 uint32_t data_size; ///< size of the frame data in bytes
97 uint16_t frame_flags; ///< frame properties
98 uint8_t cb_offset; ///< needed for selecting VQ tables
99 uint8_t buf_sel; ///< active frame buffer: 0 - primary, 1 -secondary
100 const uint8_t *y_data_ptr;
101 const uint8_t *v_data_ptr;
102 const uint8_t *u_data_ptr;
106 const uint8_t *alt_quant; ///< secondary VQ table set for the modes 1 and 4
108 } Indeo3DecodeContext;
111 static uint8_t requant_tab[8][128];
114 * Build the static requantization table.
115 * This table is used to remap pixel values according to a specific
116 * quant index and thus avoid overflows while adding deltas.
118 static av_cold void build_requant_tab(void)
120 static int8_t offsets[8] = { 1, 1, 2, -3, -3, 3, 4, 4 };
121 static int8_t deltas [8] = { 0, 1, 0, 4, 4, 1, 0, 1 };
125 for (i = 0; i < 8; i++) {
127 for (j = 0; j < 128; j++)
128 requant_tab[i][j] = (j + offsets[i]) / step * step + deltas[i];
131 /* some last elements calculated above will have values >= 128 */
132 /* pixel values shall never exceed 127 so set them to non-overflowing values */
133 /* according with the quantization step of the respective section */
134 requant_tab[0][127] = 126;
135 requant_tab[1][119] = 118;
136 requant_tab[1][120] = 118;
137 requant_tab[2][126] = 124;
138 requant_tab[2][127] = 124;
139 requant_tab[6][124] = 120;
140 requant_tab[6][125] = 120;
141 requant_tab[6][126] = 120;
142 requant_tab[6][127] = 120;
144 /* Patch for compatibility with the Intel's binary decoders */
145 requant_tab[1][7] = 10;
146 requant_tab[4][8] = 10;
150 static av_cold int allocate_frame_buffers(Indeo3DecodeContext *ctx,
151 AVCodecContext *avctx)
153 int p, luma_width, luma_height, chroma_width, chroma_height;
154 int luma_pitch, chroma_pitch, luma_size, chroma_size;
156 luma_width = ctx->width;
157 luma_height = ctx->height;
159 if (luma_width < 16 || luma_width > 640 ||
160 luma_height < 16 || luma_height > 480 ||
161 luma_width & 3 || luma_height & 3) {
162 av_log(avctx, AV_LOG_ERROR, "Invalid picture dimensions: %d x %d!\n",
163 luma_width, luma_height);
164 return AVERROR_INVALIDDATA;
167 chroma_width = FFALIGN(luma_width >> 2, 4);
168 chroma_height = FFALIGN(luma_height >> 2, 4);
170 luma_pitch = FFALIGN(luma_width, 16);
171 chroma_pitch = FFALIGN(chroma_width, 16);
173 /* Calculate size of the luminance plane. */
174 /* Add one line more for INTRA prediction. */
175 luma_size = luma_pitch * (luma_height + 1);
177 /* Calculate size of a chrominance planes. */
178 /* Add one line more for INTRA prediction. */
179 chroma_size = chroma_pitch * (chroma_height + 1);
181 /* allocate frame buffers */
182 for (p = 0; p < 3; p++) {
183 ctx->planes[p].pitch = !p ? luma_pitch : chroma_pitch;
184 ctx->planes[p].width = !p ? luma_width : chroma_width;
185 ctx->planes[p].height = !p ? luma_height : chroma_height;
187 ctx->planes[p].buffers[0] = av_malloc(!p ? luma_size : chroma_size);
188 ctx->planes[p].buffers[1] = av_malloc(!p ? luma_size : chroma_size);
190 /* fill the INTRA prediction lines with the middle pixel value = 64 */
191 memset(ctx->planes[p].buffers[0], 0x40, ctx->planes[p].pitch);
192 memset(ctx->planes[p].buffers[1], 0x40, ctx->planes[p].pitch);
194 /* set buffer pointers = buf_ptr + pitch and thus skip the INTRA prediction line */
195 ctx->planes[p].pixels[0] = ctx->planes[p].buffers[0] + ctx->planes[p].pitch;
196 ctx->planes[p].pixels[1] = ctx->planes[p].buffers[1] + ctx->planes[p].pitch;
197 memset(ctx->planes[p].pixels[0], 0, ctx->planes[p].pitch * ctx->planes[p].height);
198 memset(ctx->planes[p].pixels[1], 0, ctx->planes[p].pitch * ctx->planes[p].height);
205 static av_cold void free_frame_buffers(Indeo3DecodeContext *ctx)
209 for (p = 0; p < 3; p++) {
210 av_freep(&ctx->planes[p].buffers[0]);
211 av_freep(&ctx->planes[p].buffers[1]);
212 ctx->planes[p].pixels[0] = ctx->planes[p].pixels[1] = 0;
218 * Copy pixels of the cell(x + mv_x, y + mv_y) from the previous frame into
219 * the cell(x, y) in the current frame.
221 * @param ctx pointer to the decoder context
222 * @param plane pointer to the plane descriptor
223 * @param cell pointer to the cell descriptor
225 static int copy_cell(Indeo3DecodeContext *ctx, Plane *plane, Cell *cell)
227 int h, w, mv_x, mv_y, offset, offset_dst;
230 /* setup output and reference pointers */
231 offset_dst = (cell->ypos << 2) * plane->pitch + (cell->xpos << 2);
232 dst = plane->pixels[ctx->buf_sel] + offset_dst;
233 mv_y = cell->mv_ptr[0];
234 mv_x = cell->mv_ptr[1];
236 /* -1 because there is an extra line on top for prediction */
237 if ((cell->ypos << 2) + mv_y < -1 || (cell->xpos << 2) + mv_x < 0 ||
238 ((cell->ypos + cell->height) << 2) + mv_y >= plane->height ||
239 ((cell->xpos + cell->width) << 2) + mv_x >= plane->width) {
240 av_log(ctx->avctx, AV_LOG_ERROR,
241 "Motion vectors point out of the frame.\n");
242 return AVERROR_INVALIDDATA;
245 offset = offset_dst + mv_y * plane->pitch + mv_x;
246 src = plane->pixels[ctx->buf_sel ^ 1] + offset;
248 h = cell->height << 2;
250 for (w = cell->width; w > 0;) {
251 /* copy using 16xH blocks */
252 if (!((cell->xpos << 2) & 15) && w >= 4) {
253 for (; w >= 4; src += 16, dst += 16, w -= 4)
254 ctx->hdsp.put_no_rnd_pixels_tab[0][0](dst, src, plane->pitch, h);
257 /* copy using 8xH blocks */
258 if (!((cell->xpos << 2) & 7) && w >= 2) {
259 ctx->hdsp.put_no_rnd_pixels_tab[1][0](dst, src, plane->pitch, h);
266 ctx->hdsp.put_no_rnd_pixels_tab[2][0](dst, src, plane->pitch, h);
277 /* Average 4/8 pixels at once without rounding using SWAR */
278 #define AVG_32(dst, src, ref) \
279 AV_WN32A(dst, ((AV_RN32A(src) + AV_RN32A(ref)) >> 1) & 0x7F7F7F7FUL)
281 #define AVG_64(dst, src, ref) \
282 AV_WN64A(dst, ((AV_RN64A(src) + AV_RN64A(ref)) >> 1) & 0x7F7F7F7F7F7F7F7FULL)
286 * Replicate each even pixel as follows:
287 * ABCDEFGH -> AACCEEGG
289 static inline uint64_t replicate64(uint64_t a) {
291 a &= 0xFF00FF00FF00FF00ULL;
294 a &= 0x00FF00FF00FF00FFULL;
300 static inline uint32_t replicate32(uint32_t a) {
312 /* Fill n lines with 64bit pixel value pix */
313 static inline void fill_64(uint8_t *dst, const uint64_t pix, int32_t n,
316 for (; n > 0; dst += row_offset, n--)
321 /* Error codes for cell decoding. */
332 #define BUFFER_PRECHECK \
333 if (*data_ptr >= last_ptr) \
334 return IV3_OUT_OF_DATA; \
336 #define RLE_BLOCK_COPY \
337 if (cell->mv_ptr || !skip_flag) \
338 ctx->hdsp.put_pixels_tab[2][0](dst, ref, row_offset, 4 << v_zoom)
340 #define RLE_BLOCK_COPY_8 \
341 pix64 = AV_RN64A(ref);\
342 if (is_first_row) {/* special prediction case: top line of a cell */\
343 pix64 = replicate64(pix64);\
344 fill_64(dst + row_offset, pix64, 7, row_offset);\
345 AVG_64(dst, ref, dst + row_offset);\
347 fill_64(dst, pix64, 8, row_offset)
349 #define RLE_LINES_COPY \
350 ctx->hdsp.put_pixels_tab[2][0](dst, ref, row_offset, num_lines << v_zoom)
352 #define RLE_LINES_COPY_M10 \
353 pix64 = AV_RN64A(ref);\
354 if (is_top_of_cell) {\
355 pix64 = replicate64(pix64);\
356 fill_64(dst + row_offset, pix64, (num_lines << 1) - 1, row_offset);\
357 AVG_64(dst, ref, dst + row_offset);\
359 fill_64(dst, pix64, num_lines << 1, row_offset)
361 #define APPLY_DELTA_4 \
362 AV_WN16A(dst + line_offset ,\
363 (AV_RN16A(ref ) + delta_tab->deltas[dyad1]) & 0x7F7F);\
364 AV_WN16A(dst + line_offset + 2,\
365 (AV_RN16A(ref + 2) + delta_tab->deltas[dyad2]) & 0x7F7F);\
367 if (is_top_of_cell && !cell->ypos) {\
368 AV_COPY32(dst, dst + row_offset);\
370 AVG_32(dst, ref, dst + row_offset);\
374 #define APPLY_DELTA_8 \
375 /* apply two 32-bit VQ deltas to next even line */\
376 if (is_top_of_cell) { \
377 AV_WN32A(dst + row_offset , \
378 (replicate32(AV_RN32A(ref )) + delta_tab->deltas_m10[dyad1]) & 0x7F7F7F7F);\
379 AV_WN32A(dst + row_offset + 4, \
380 (replicate32(AV_RN32A(ref + 4)) + delta_tab->deltas_m10[dyad2]) & 0x7F7F7F7F);\
382 AV_WN32A(dst + row_offset , \
383 (AV_RN32A(ref ) + delta_tab->deltas_m10[dyad1]) & 0x7F7F7F7F);\
384 AV_WN32A(dst + row_offset + 4, \
385 (AV_RN32A(ref + 4) + delta_tab->deltas_m10[dyad2]) & 0x7F7F7F7F);\
387 /* odd lines are not coded but rather interpolated/replicated */\
388 /* first line of the cell on the top of image? - replicate */\
389 /* otherwise - interpolate */\
390 if (is_top_of_cell && !cell->ypos) {\
391 AV_COPY64(dst, dst + row_offset);\
393 AVG_64(dst, ref, dst + row_offset);
396 #define APPLY_DELTA_1011_INTER \
399 (AV_RN32A(dst ) + delta_tab->deltas_m10[dyad1]) & 0x7F7F7F7F);\
401 (AV_RN32A(dst + 4 ) + delta_tab->deltas_m10[dyad2]) & 0x7F7F7F7F);\
402 AV_WN32A(dst + row_offset , \
403 (AV_RN32A(dst + row_offset ) + delta_tab->deltas_m10[dyad1]) & 0x7F7F7F7F);\
404 AV_WN32A(dst + row_offset + 4, \
405 (AV_RN32A(dst + row_offset + 4) + delta_tab->deltas_m10[dyad2]) & 0x7F7F7F7F);\
408 (AV_RN16A(dst ) + delta_tab->deltas[dyad1]) & 0x7F7F);\
410 (AV_RN16A(dst + 2 ) + delta_tab->deltas[dyad2]) & 0x7F7F);\
411 AV_WN16A(dst + row_offset , \
412 (AV_RN16A(dst + row_offset ) + delta_tab->deltas[dyad1]) & 0x7F7F);\
413 AV_WN16A(dst + row_offset + 2, \
414 (AV_RN16A(dst + row_offset + 2) + delta_tab->deltas[dyad2]) & 0x7F7F);\
418 static int decode_cell_data(Indeo3DecodeContext *ctx, Cell *cell,
419 uint8_t *block, uint8_t *ref_block,
420 int pitch, int h_zoom, int v_zoom, int mode,
421 const vqEntry *delta[2], int swap_quads[2],
422 const uint8_t **data_ptr, const uint8_t *last_ptr)
424 int x, y, line, num_lines;
426 uint8_t code, *dst, *ref;
427 const vqEntry *delta_tab;
428 unsigned int dyad1, dyad2;
430 int skip_flag = 0, is_top_of_cell, is_first_row = 1;
431 int row_offset, blk_row_offset, line_offset;
434 blk_row_offset = (row_offset << (2 + v_zoom)) - (cell->width << 2);
435 line_offset = v_zoom ? row_offset : 0;
437 if (cell->height & v_zoom || cell->width & h_zoom)
440 for (y = 0; y < cell->height; is_first_row = 0, y += 1 + v_zoom) {
441 for (x = 0; x < cell->width; x += 1 + h_zoom) {
445 if (rle_blocks > 0) {
448 } else if (mode == 10 && !cell->mv_ptr) {
453 for (line = 0; line < 4;) {
455 is_top_of_cell = is_first_row && !line;
457 /* select primary VQ table for odd, secondary for even lines */
459 delta_tab = delta[line & 1];
461 delta_tab = delta[1];
463 code = bytestream_get_byte(data_ptr);
465 if (code < delta_tab->num_dyads) {
467 dyad1 = bytestream_get_byte(data_ptr);
469 if (dyad1 >= delta_tab->num_dyads || dyad1 >= 248)
473 code -= delta_tab->num_dyads;
474 dyad1 = code / delta_tab->quad_exp;
475 dyad2 = code % delta_tab->quad_exp;
476 if (swap_quads[line & 1])
477 FFSWAP(unsigned int, dyad1, dyad2);
481 } else if (mode == 10 && !cell->mv_ptr) {
484 APPLY_DELTA_1011_INTER;
487 /* process RLE codes */
497 num_lines = 257 - code - line;
502 } else if (mode == 10 && !cell->mv_ptr) {
508 code = bytestream_get_byte(data_ptr);
509 rle_blocks = (code & 0x1F) - 1; /* set block counter */
510 if (code >= 64 || rle_blocks < 0)
511 return IV3_BAD_COUNTER;
512 skip_flag = code & 0x20;
513 num_lines = 4 - line; /* enforce next block processing */
514 if (mode >= 10 || (cell->mv_ptr || !skip_flag)) {
517 } else if (mode == 10 && !cell->mv_ptr) {
529 num_lines = 4; /* enforce next block processing */
533 } else if (mode == 10 && !cell->mv_ptr) {
539 return IV3_UNSUPPORTED;
544 ref += row_offset * (num_lines << v_zoom);
545 dst += row_offset * (num_lines << v_zoom);
549 /* move to next horizontal block */
550 block += 4 << h_zoom;
551 ref_block += 4 << h_zoom;
554 /* move to next line of blocks */
555 ref_block += blk_row_offset;
556 block += blk_row_offset;
563 * Decode a vector-quantized cell.
564 * It consists of several routines, each of which handles one or more "modes"
565 * with which a cell can be encoded.
567 * @param ctx pointer to the decoder context
568 * @param avctx ptr to the AVCodecContext
569 * @param plane pointer to the plane descriptor
570 * @param cell pointer to the cell descriptor
571 * @param data_ptr pointer to the compressed data
572 * @param last_ptr pointer to the last byte to catch reads past end of buffer
573 * @return number of consumed bytes or negative number in case of error
575 static int decode_cell(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
576 Plane *plane, Cell *cell, const uint8_t *data_ptr,
577 const uint8_t *last_ptr)
579 int x, mv_x, mv_y, mode, vq_index, prim_indx, second_indx;
581 int offset, error = 0, swap_quads[2];
582 uint8_t code, *block, *ref_block = 0;
583 const vqEntry *delta[2];
584 const uint8_t *data_start = data_ptr;
586 /* get coding mode and VQ table index from the VQ descriptor byte */
589 vq_index = code & 0xF;
591 /* setup output and reference pointers */
592 offset = (cell->ypos << 2) * plane->pitch + (cell->xpos << 2);
593 block = plane->pixels[ctx->buf_sel] + offset;
595 /* use previous line as reference for INTRA cells */
596 ref_block = block - plane->pitch;
597 } else if (mode >= 10) {
598 /* for mode 10 and 11 INTER first copy the predicted cell into the current one */
599 /* so we don't need to do data copying for each RLE code later */
600 int ret = copy_cell(ctx, plane, cell);
604 /* set the pointer to the reference pixels for modes 0-4 INTER */
605 mv_y = cell->mv_ptr[0];
606 mv_x = cell->mv_ptr[1];
608 /* -1 because there is an extra line on top for prediction */
609 if ((cell->ypos << 2) + mv_y < -1 || (cell->xpos << 2) + mv_x < 0 ||
610 ((cell->ypos + cell->height) << 2) + mv_y >= plane->height ||
611 ((cell->xpos + cell->width) << 2) + mv_x >= plane->width) {
612 av_log(ctx->avctx, AV_LOG_ERROR,
613 "Motion vectors point out of the frame.\n");
614 return AVERROR_INVALIDDATA;
617 offset += mv_y * plane->pitch + mv_x;
618 ref_block = plane->pixels[ctx->buf_sel ^ 1] + offset;
621 /* select VQ tables as follows: */
622 /* modes 0 and 3 use only the primary table for all lines in a block */
623 /* while modes 1 and 4 switch between primary and secondary tables on alternate lines */
624 if (mode == 1 || mode == 4) {
625 code = ctx->alt_quant[vq_index];
626 prim_indx = (code >> 4) + ctx->cb_offset;
627 second_indx = (code & 0xF) + ctx->cb_offset;
629 vq_index += ctx->cb_offset;
630 prim_indx = second_indx = vq_index;
633 if (prim_indx >= 24 || second_indx >= 24) {
634 av_log(avctx, AV_LOG_ERROR, "Invalid VQ table indexes! Primary: %d, secondary: %d!\n",
635 prim_indx, second_indx);
636 return AVERROR_INVALIDDATA;
639 delta[0] = &vq_tab[second_indx];
640 delta[1] = &vq_tab[prim_indx];
641 swap_quads[0] = second_indx >= 16;
642 swap_quads[1] = prim_indx >= 16;
644 /* requantize the prediction if VQ index of this cell differs from VQ index */
645 /* of the predicted cell in order to avoid overflows. */
646 if (vq_index >= 8 && ref_block) {
647 for (x = 0; x < cell->width << 2; x++)
648 ref_block[x] = requant_tab[vq_index & 7][ref_block[x]];
654 case 0: /*------------------ MODES 0 & 1 (4x4 block processing) --------------------*/
656 case 3: /*------------------ MODES 3 & 4 (4x8 block processing) --------------------*/
658 if (mode >= 3 && cell->mv_ptr) {
659 av_log(avctx, AV_LOG_ERROR, "Attempt to apply Mode 3/4 to an INTER cell!\n");
660 return AVERROR_INVALIDDATA;
663 zoom_fac = mode >= 3;
664 error = decode_cell_data(ctx, cell, block, ref_block, plane->pitch,
665 0, zoom_fac, mode, delta, swap_quads,
666 &data_ptr, last_ptr);
668 case 10: /*-------------------- MODE 10 (8x8 block processing) ---------------------*/
669 case 11: /*----------------- MODE 11 (4x8 INTER block processing) ------------------*/
670 if (mode == 10 && !cell->mv_ptr) { /* MODE 10 INTRA processing */
671 error = decode_cell_data(ctx, cell, block, ref_block, plane->pitch,
672 1, 1, mode, delta, swap_quads,
673 &data_ptr, last_ptr);
674 } else { /* mode 10 and 11 INTER processing */
675 if (mode == 11 && !cell->mv_ptr) {
676 av_log(avctx, AV_LOG_ERROR, "Attempt to use Mode 11 for an INTRA cell!\n");
677 return AVERROR_INVALIDDATA;
680 zoom_fac = mode == 10;
681 error = decode_cell_data(ctx, cell, block, ref_block, plane->pitch,
682 zoom_fac, 1, mode, delta, swap_quads,
683 &data_ptr, last_ptr);
687 av_log(avctx, AV_LOG_ERROR, "Unsupported coding mode: %d\n", mode);
688 return AVERROR_INVALIDDATA;
693 av_log(avctx, AV_LOG_ERROR, "Mode %d: RLE code %X is not allowed at the current line\n",
695 return AVERROR_INVALIDDATA;
697 av_log(avctx, AV_LOG_ERROR, "Mode %d: invalid VQ data\n", mode);
698 return AVERROR_INVALIDDATA;
699 case IV3_BAD_COUNTER:
700 av_log(avctx, AV_LOG_ERROR, "Mode %d: RLE-FB invalid counter: %d\n", mode, code);
701 return AVERROR_INVALIDDATA;
702 case IV3_UNSUPPORTED:
703 av_log(avctx, AV_LOG_ERROR, "Mode %d: unsupported RLE code: %X\n", mode, data_ptr[-1]);
704 return AVERROR_INVALIDDATA;
705 case IV3_OUT_OF_DATA:
706 av_log(avctx, AV_LOG_ERROR, "Mode %d: attempt to read past end of buffer\n", mode);
707 return AVERROR_INVALIDDATA;
710 return data_ptr - data_start; /* report number of bytes consumed from the input buffer */
714 /* Binary tree codes. */
723 #define SPLIT_CELL(size, new_size) (new_size) = ((size) > 2) ? ((((size) + 2) >> 2) << 1) : 1
725 #define UPDATE_BITPOS(n) \
726 ctx->skip_bits += (n); \
729 #define RESYNC_BITSTREAM \
730 if (ctx->need_resync && !(get_bits_count(&ctx->gb) & 7)) { \
731 skip_bits_long(&ctx->gb, ctx->skip_bits); \
732 ctx->skip_bits = 0; \
733 ctx->need_resync = 0; \
737 if (curr_cell.xpos + curr_cell.width > (plane->width >> 2) || \
738 curr_cell.ypos + curr_cell.height > (plane->height >> 2)) { \
739 av_log(avctx, AV_LOG_ERROR, "Invalid cell: x=%d, y=%d, w=%d, h=%d\n", \
740 curr_cell.xpos, curr_cell.ypos, curr_cell.width, curr_cell.height); \
741 return AVERROR_INVALIDDATA; \
745 static int parse_bintree(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
746 Plane *plane, int code, Cell *ref_cell,
747 const int depth, const int strip_width)
753 av_log(avctx, AV_LOG_ERROR, "Stack overflow (corrupted binary tree)!\n");
754 return AVERROR_INVALIDDATA; // unwind recursion
757 curr_cell = *ref_cell; // clone parent cell
758 if (code == H_SPLIT) {
759 SPLIT_CELL(ref_cell->height, curr_cell.height);
760 ref_cell->ypos += curr_cell.height;
761 ref_cell->height -= curr_cell.height;
762 if (ref_cell->height <= 0 || curr_cell.height <= 0)
763 return AVERROR_INVALIDDATA;
764 } else if (code == V_SPLIT) {
765 if (curr_cell.width > strip_width) {
767 curr_cell.width = (curr_cell.width <= (strip_width << 1) ? 1 : 2) * strip_width;
769 SPLIT_CELL(ref_cell->width, curr_cell.width);
770 ref_cell->xpos += curr_cell.width;
771 ref_cell->width -= curr_cell.width;
772 if (ref_cell->width <= 0 || curr_cell.width <= 0)
773 return AVERROR_INVALIDDATA;
776 while (1) { /* loop until return */
778 switch (code = get_bits(&ctx->gb, 2)) {
781 if (parse_bintree(ctx, avctx, plane, code, &curr_cell, depth - 1, strip_width))
782 return AVERROR_INVALIDDATA;
785 if (!curr_cell.tree) { /* MC tree INTRA code */
786 curr_cell.mv_ptr = 0; /* mark the current strip as INTRA */
787 curr_cell.tree = 1; /* enter the VQ tree */
788 } else { /* VQ tree NULL code */
790 code = get_bits(&ctx->gb, 2);
792 av_log(avctx, AV_LOG_ERROR, "Invalid VQ_NULL code: %d\n", code);
793 return AVERROR_INVALIDDATA;
796 av_log(avctx, AV_LOG_ERROR, "SkipCell procedure not implemented yet!\n");
799 if (!curr_cell.mv_ptr)
800 return AVERROR_INVALIDDATA;
801 ret = copy_cell(ctx, plane, &curr_cell);
806 if (!curr_cell.tree) { /* MC tree INTER code */
808 /* get motion vector index and setup the pointer to the mv set */
809 if (!ctx->need_resync)
810 ctx->next_cell_data = &ctx->gb.buffer[(get_bits_count(&ctx->gb) + 7) >> 3];
811 mv_idx = *(ctx->next_cell_data++);
812 if (mv_idx >= ctx->num_vectors) {
813 av_log(avctx, AV_LOG_ERROR, "motion vector index out of range\n");
814 return AVERROR_INVALIDDATA;
816 curr_cell.mv_ptr = &ctx->mc_vectors[mv_idx << 1];
817 curr_cell.tree = 1; /* enter the VQ tree */
819 } else { /* VQ tree DATA code */
820 if (!ctx->need_resync)
821 ctx->next_cell_data = &ctx->gb.buffer[(get_bits_count(&ctx->gb) + 7) >> 3];
824 bytes_used = decode_cell(ctx, avctx, plane, &curr_cell,
825 ctx->next_cell_data, ctx->last_byte);
827 return AVERROR_INVALIDDATA;
829 UPDATE_BITPOS(bytes_used << 3);
830 ctx->next_cell_data += bytes_used;
841 static int decode_plane(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
842 Plane *plane, const uint8_t *data, int32_t data_size,
846 unsigned num_vectors;
848 /* each plane data starts with mc_vector_count field, */
849 /* an optional array of motion vectors followed by the vq data */
850 num_vectors = bytestream_get_le32(&data);
851 if (num_vectors > 256) {
852 av_log(ctx->avctx, AV_LOG_ERROR,
853 "Read invalid number of motion vectors %d\n", num_vectors);
854 return AVERROR_INVALIDDATA;
856 if (num_vectors * 2 >= data_size)
857 return AVERROR_INVALIDDATA;
859 ctx->num_vectors = num_vectors;
860 ctx->mc_vectors = num_vectors ? data : 0;
862 /* init the bitreader */
863 init_get_bits(&ctx->gb, &data[num_vectors * 2], (data_size - num_vectors * 2) << 3);
865 ctx->need_resync = 0;
867 ctx->last_byte = data + data_size - 1;
869 /* initialize the 1st cell and set its dimensions to whole plane */
870 curr_cell.xpos = curr_cell.ypos = 0;
871 curr_cell.width = plane->width >> 2;
872 curr_cell.height = plane->height >> 2;
873 curr_cell.tree = 0; // we are in the MC tree now
874 curr_cell.mv_ptr = 0; // no motion vector = INTRA cell
876 return parse_bintree(ctx, avctx, plane, INTRA_NULL, &curr_cell, CELL_STACK_MAX, strip_width);
880 #define OS_HDR_ID MKBETAG('F', 'R', 'M', 'H')
882 static int decode_frame_headers(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
883 const uint8_t *buf, int buf_size)
886 const uint8_t *bs_hdr;
887 uint32_t frame_num, word2, check_sum, data_size;
888 uint32_t y_offset, u_offset, v_offset, starts[3], ends[3];
889 uint16_t height, width;
892 bytestream2_init(&gb, buf, buf_size);
894 /* parse and check the OS header */
895 frame_num = bytestream2_get_le32(&gb);
896 word2 = bytestream2_get_le32(&gb);
897 check_sum = bytestream2_get_le32(&gb);
898 data_size = bytestream2_get_le32(&gb);
900 if ((frame_num ^ word2 ^ data_size ^ OS_HDR_ID) != check_sum) {
901 av_log(avctx, AV_LOG_ERROR, "OS header checksum mismatch!\n");
902 return AVERROR_INVALIDDATA;
905 /* parse the bitstream header */
908 if (bytestream2_get_le16(&gb) != 32) {
909 av_log(avctx, AV_LOG_ERROR, "Unsupported codec version!\n");
910 return AVERROR_INVALIDDATA;
913 ctx->frame_num = frame_num;
914 ctx->frame_flags = bytestream2_get_le16(&gb);
915 ctx->data_size = (bytestream2_get_le32(&gb) + 7) >> 3;
916 ctx->cb_offset = bytestream2_get_byte(&gb);
918 if (ctx->data_size == 16)
920 ctx->data_size = FFMIN(ctx->data_size, buf_size - 16);
922 bytestream2_skip(&gb, 3); // skip reserved byte and checksum
924 /* check frame dimensions */
925 height = bytestream2_get_le16(&gb);
926 width = bytestream2_get_le16(&gb);
927 if (av_image_check_size(width, height, 0, avctx))
928 return AVERROR_INVALIDDATA;
930 if (width != ctx->width || height != ctx->height) {
933 av_dlog(avctx, "Frame dimensions changed!\n");
935 if (width < 16 || width > 640 ||
936 height < 16 || height > 480 ||
937 width & 3 || height & 3) {
938 av_log(avctx, AV_LOG_ERROR,
939 "Invalid picture dimensions: %d x %d!\n", width, height);
940 return AVERROR_INVALIDDATA;
944 ctx->height = height;
946 free_frame_buffers(ctx);
947 if ((res = allocate_frame_buffers(ctx, avctx)) < 0)
949 avcodec_set_dimensions(avctx, width, height);
952 y_offset = bytestream2_get_le32(&gb);
953 v_offset = bytestream2_get_le32(&gb);
954 u_offset = bytestream2_get_le32(&gb);
955 bytestream2_skip(&gb, 4);
957 /* unfortunately there is no common order of planes in the buffer */
958 /* so we use that sorting algo for determining planes data sizes */
959 starts[0] = y_offset;
960 starts[1] = v_offset;
961 starts[2] = u_offset;
963 for (j = 0; j < 3; j++) {
964 ends[j] = ctx->data_size;
965 for (i = 2; i >= 0; i--)
966 if (starts[i] < ends[j] && starts[i] > starts[j])
970 ctx->y_data_size = ends[0] - starts[0];
971 ctx->v_data_size = ends[1] - starts[1];
972 ctx->u_data_size = ends[2] - starts[2];
973 if (FFMAX3(y_offset, v_offset, u_offset) >= ctx->data_size - 16 ||
974 FFMIN3(y_offset, v_offset, u_offset) < gb.buffer - bs_hdr + 16 ||
975 FFMIN3(ctx->y_data_size, ctx->v_data_size, ctx->u_data_size) <= 0) {
976 av_log(avctx, AV_LOG_ERROR, "One of the y/u/v offsets is invalid\n");
977 return AVERROR_INVALIDDATA;
980 ctx->y_data_ptr = bs_hdr + y_offset;
981 ctx->v_data_ptr = bs_hdr + v_offset;
982 ctx->u_data_ptr = bs_hdr + u_offset;
983 ctx->alt_quant = gb.buffer;
985 if (ctx->data_size == 16) {
986 av_log(avctx, AV_LOG_DEBUG, "Sync frame encountered!\n");
990 if (ctx->frame_flags & BS_8BIT_PEL) {
991 avpriv_request_sample(avctx, "8-bit pixel format");
992 return AVERROR_PATCHWELCOME;
995 if (ctx->frame_flags & BS_MV_X_HALF || ctx->frame_flags & BS_MV_Y_HALF) {
996 avpriv_request_sample(avctx, "Halfpel motion vectors");
997 return AVERROR_PATCHWELCOME;
1005 * Convert and output the current plane.
1006 * All pixel values will be upsampled by shifting right by one bit.
1008 * @param[in] plane pointer to the descriptor of the plane being processed
1009 * @param[in] buf_sel indicates which frame buffer the input data stored in
1010 * @param[out] dst pointer to the buffer receiving converted pixels
1011 * @param[in] dst_pitch pitch for moving to the next y line
1012 * @param[in] dst_height output plane height
1014 static void output_plane(const Plane *plane, int buf_sel, uint8_t *dst,
1015 int dst_pitch, int dst_height)
1018 const uint8_t *src = plane->pixels[buf_sel];
1019 uint32_t pitch = plane->pitch;
1021 dst_height = FFMIN(dst_height, plane->height);
1022 for (y = 0; y < dst_height; y++) {
1023 /* convert four pixels at once using SWAR */
1024 for (x = 0; x < plane->width >> 2; x++) {
1025 AV_WN32A(dst, (AV_RN32A(src) & 0x7F7F7F7F) << 1);
1030 for (x <<= 2; x < plane->width; x++)
1031 *dst++ = *src++ << 1;
1033 src += pitch - plane->width;
1034 dst += dst_pitch - plane->width;
1039 static av_cold int decode_init(AVCodecContext *avctx)
1041 Indeo3DecodeContext *ctx = avctx->priv_data;
1044 ctx->width = avctx->width;
1045 ctx->height = avctx->height;
1046 avctx->pix_fmt = AV_PIX_FMT_YUV410P;
1048 build_requant_tab();
1050 ff_hpeldsp_init(&ctx->hdsp, avctx->flags);
1052 allocate_frame_buffers(ctx, avctx);
1058 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
1061 Indeo3DecodeContext *ctx = avctx->priv_data;
1062 const uint8_t *buf = avpkt->data;
1063 int buf_size = avpkt->size;
1064 AVFrame *frame = data;
1067 res = decode_frame_headers(ctx, avctx, buf, buf_size);
1071 /* skip sync(null) frames */
1073 // we have processed 16 bytes but no data was decoded
1078 /* skip droppable INTER frames if requested */
1079 if (ctx->frame_flags & BS_NONREF &&
1080 (avctx->skip_frame >= AVDISCARD_NONREF))
1083 /* skip INTER frames if requested */
1084 if (!(ctx->frame_flags & BS_KEYFRAME) && avctx->skip_frame >= AVDISCARD_NONKEY)
1087 /* use BS_BUFFER flag for buffer switching */
1088 ctx->buf_sel = (ctx->frame_flags >> BS_BUFFER) & 1;
1090 /* decode luma plane */
1091 if ((res = decode_plane(ctx, avctx, ctx->planes, ctx->y_data_ptr, ctx->y_data_size, 40)))
1094 /* decode chroma planes */
1095 if ((res = decode_plane(ctx, avctx, &ctx->planes[1], ctx->u_data_ptr, ctx->u_data_size, 10)))
1098 if ((res = decode_plane(ctx, avctx, &ctx->planes[2], ctx->v_data_ptr, ctx->v_data_size, 10)))
1101 if ((res = ff_get_buffer(avctx, frame, 0)) < 0) {
1102 av_log(ctx->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
1106 output_plane(&ctx->planes[0], ctx->buf_sel,
1107 frame->data[0], frame->linesize[0],
1109 output_plane(&ctx->planes[1], ctx->buf_sel,
1110 frame->data[1], frame->linesize[1],
1111 (avctx->height + 3) >> 2);
1112 output_plane(&ctx->planes[2], ctx->buf_sel,
1113 frame->data[2], frame->linesize[2],
1114 (avctx->height + 3) >> 2);
1122 static av_cold int decode_close(AVCodecContext *avctx)
1124 free_frame_buffers(avctx->priv_data);
1129 AVCodec ff_indeo3_decoder = {
1131 .type = AVMEDIA_TYPE_VIDEO,
1132 .id = AV_CODEC_ID_INDEO3,
1133 .priv_data_size = sizeof(Indeo3DecodeContext),
1134 .init = decode_init,
1135 .close = decode_close,
1136 .decode = decode_frame,
1137 .capabilities = CODEC_CAP_DR1,
1138 .long_name = NULL_IF_CONFIG_SMALL("Intel Indeo 3"),