lavc: fix decode_frame() third parameter semantics for video decoders
[ffmpeg.git] / libavcodec / indeo3.c
1 /*
2  * Indeo Video v3 compatible decoder
3  * Copyright (c) 2009 - 2011 Maxim Poliakovski
4  *
5  * This file is part of Libav.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
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'
28  *
29  * @see http://wiki.multimedia.cx/index.php?title=Indeo_3
30  */
31
32 #include "libavutil/imgutils.h"
33 #include "libavutil/intreadwrite.h"
34 #include "avcodec.h"
35 #include "dsputil.h"
36 #include "bytestream.h"
37 #include "get_bits.h"
38 #include "internal.h"
39
40 #include "indeo3data.h"
41
42 /* RLE opcodes. */
43 enum {
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
51 };
52
53
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
61
62
63 typedef struct Plane {
64     uint8_t         *buffers[2];
65     uint8_t         *pixels[2]; ///< pointer to the actual pixel data of the buffers above
66     uint32_t        width;
67     uint32_t        height;
68     uint32_t        pitch;
69 } Plane;
70
71 #define CELL_STACK_MAX  20
72
73 typedef struct Cell {
74     int16_t         xpos;       ///< cell coordinates in 4x4 blocks
75     int16_t         ypos;
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
80 } Cell;
81
82 typedef struct Indeo3DecodeContext {
83     AVCodecContext *avctx;
84     AVFrame         frame;
85     DSPContext      dsp;
86
87     GetBitContext   gb;
88     int             need_resync;
89     int             skip_bits;
90     const uint8_t   *next_cell_data;
91     const uint8_t   *last_byte;
92     const int8_t    *mc_vectors;
93     unsigned        num_vectors;    ///< number of motion vectors in mc_vectors
94
95     int16_t         width, height;
96     uint32_t        frame_num;      ///< current frame number (zero-based)
97     uint32_t        data_size;      ///< size of the frame data in bytes
98     uint16_t        frame_flags;    ///< frame properties
99     uint8_t         cb_offset;      ///< needed for selecting VQ tables
100     uint8_t         buf_sel;        ///< active frame buffer: 0 - primary, 1 -secondary
101     const uint8_t   *y_data_ptr;
102     const uint8_t   *v_data_ptr;
103     const uint8_t   *u_data_ptr;
104     int32_t         y_data_size;
105     int32_t         v_data_size;
106     int32_t         u_data_size;
107     const uint8_t   *alt_quant;     ///< secondary VQ table set for the modes 1 and 4
108     Plane           planes[3];
109 } Indeo3DecodeContext;
110
111
112 static uint8_t requant_tab[8][128];
113
114 /*
115  *  Build the static requantization table.
116  *  This table is used to remap pixel values according to a specific
117  *  quant index and thus avoid overflows while adding deltas.
118  */
119 static av_cold void build_requant_tab(void)
120 {
121     static int8_t offsets[8] = { 1, 1, 2, -3, -3, 3, 4, 4 };
122     static int8_t deltas [8] = { 0, 1, 0,  4,  4, 1, 0, 1 };
123
124     int i, j, step;
125
126     for (i = 0; i < 8; i++) {
127         step = i + 2;
128         for (j = 0; j < 128; j++)
129                 requant_tab[i][j] = (j + offsets[i]) / step * step + deltas[i];
130     }
131
132     /* some last elements calculated above will have values >= 128 */
133     /* pixel values shall never exceed 127 so set them to non-overflowing values */
134     /* according with the quantization step of the respective section */
135     requant_tab[0][127] = 126;
136     requant_tab[1][119] = 118;
137     requant_tab[1][120] = 118;
138     requant_tab[2][126] = 124;
139     requant_tab[2][127] = 124;
140     requant_tab[6][124] = 120;
141     requant_tab[6][125] = 120;
142     requant_tab[6][126] = 120;
143     requant_tab[6][127] = 120;
144
145     /* Patch for compatibility with the Intel's binary decoders */
146     requant_tab[1][7] = 10;
147     requant_tab[4][8] = 10;
148 }
149
150
151 static av_cold int allocate_frame_buffers(Indeo3DecodeContext *ctx,
152                                           AVCodecContext *avctx)
153 {
154     int p, luma_width, luma_height, chroma_width, chroma_height;
155     int luma_pitch, chroma_pitch, luma_size, chroma_size;
156
157     luma_width  = ctx->width;
158     luma_height = ctx->height;
159
160     if (luma_width  < 16 || luma_width  > 640 ||
161         luma_height < 16 || luma_height > 480 ||
162         luma_width  &  3 || luma_height &   3) {
163         av_log(avctx, AV_LOG_ERROR, "Invalid picture dimensions: %d x %d!\n",
164                luma_width, luma_height);
165         return AVERROR_INVALIDDATA;
166     }
167
168     chroma_width  = FFALIGN(luma_width  >> 2, 4);
169     chroma_height = FFALIGN(luma_height >> 2, 4);
170
171     luma_pitch   = FFALIGN(luma_width,   16);
172     chroma_pitch = FFALIGN(chroma_width, 16);
173
174     /* Calculate size of the luminance plane.  */
175     /* Add one line more for INTRA prediction. */
176     luma_size = luma_pitch * (luma_height + 1);
177
178     /* Calculate size of a chrominance planes. */
179     /* Add one line more for INTRA prediction. */
180     chroma_size = chroma_pitch * (chroma_height + 1);
181
182     /* allocate frame buffers */
183     for (p = 0; p < 3; p++) {
184         ctx->planes[p].pitch  = !p ? luma_pitch  : chroma_pitch;
185         ctx->planes[p].width  = !p ? luma_width  : chroma_width;
186         ctx->planes[p].height = !p ? luma_height : chroma_height;
187
188         ctx->planes[p].buffers[0] = av_malloc(!p ? luma_size : chroma_size);
189         ctx->planes[p].buffers[1] = av_malloc(!p ? luma_size : chroma_size);
190
191         /* fill the INTRA prediction lines with the middle pixel value = 64 */
192         memset(ctx->planes[p].buffers[0], 0x40, ctx->planes[p].pitch);
193         memset(ctx->planes[p].buffers[1], 0x40, ctx->planes[p].pitch);
194
195         /* set buffer pointers = buf_ptr + pitch and thus skip the INTRA prediction line */
196         ctx->planes[p].pixels[0] = ctx->planes[p].buffers[0] + ctx->planes[p].pitch;
197         ctx->planes[p].pixels[1] = ctx->planes[p].buffers[1] + ctx->planes[p].pitch;
198         memset(ctx->planes[p].pixels[0], 0, ctx->planes[p].pitch * ctx->planes[p].height);
199         memset(ctx->planes[p].pixels[1], 0, ctx->planes[p].pitch * ctx->planes[p].height);
200     }
201
202     return 0;
203 }
204
205
206 static av_cold void free_frame_buffers(Indeo3DecodeContext *ctx)
207 {
208     int p;
209
210     for (p = 0; p < 3; p++) {
211         av_freep(&ctx->planes[p].buffers[0]);
212         av_freep(&ctx->planes[p].buffers[1]);
213         ctx->planes[p].pixels[0] = ctx->planes[p].pixels[1] = 0;
214     }
215 }
216
217
218 /**
219  *  Copy pixels of the cell(x + mv_x, y + mv_y) from the previous frame into
220  *  the cell(x, y) in the current frame.
221  *
222  *  @param ctx      pointer to the decoder context
223  *  @param plane    pointer to the plane descriptor
224  *  @param cell     pointer to the cell  descriptor
225  */
226 static void copy_cell(Indeo3DecodeContext *ctx, Plane *plane, Cell *cell)
227 {
228     int     h, w, mv_x, mv_y, offset, offset_dst;
229     uint8_t *src, *dst;
230
231     /* setup output and reference pointers */
232     offset_dst  = (cell->ypos << 2) * plane->pitch + (cell->xpos << 2);
233     dst         = plane->pixels[ctx->buf_sel] + offset_dst;
234     mv_y        = cell->mv_ptr[0];
235     mv_x        = cell->mv_ptr[1];
236     offset      = offset_dst + mv_y * plane->pitch + mv_x;
237     src         = plane->pixels[ctx->buf_sel ^ 1] + offset;
238
239     h = cell->height << 2;
240
241     for (w = cell->width; w > 0;) {
242         /* copy using 16xH blocks */
243         if (!((cell->xpos << 2) & 15) && w >= 4) {
244             for (; w >= 4; src += 16, dst += 16, w -= 4)
245                 ctx->dsp.put_no_rnd_pixels_tab[0][0](dst, src, plane->pitch, h);
246         }
247
248         /* copy using 8xH blocks */
249         if (!((cell->xpos << 2) & 7) && w >= 2) {
250             ctx->dsp.put_no_rnd_pixels_tab[1][0](dst, src, plane->pitch, h);
251             w -= 2;
252             src += 8;
253             dst += 8;
254         }
255
256         if (w >= 1) {
257             copy_block4(dst, src, plane->pitch, plane->pitch, h);
258             w--;
259             src += 4;
260             dst += 4;
261         }
262     }
263 }
264
265
266 /* Average 4/8 pixels at once without rounding using SWAR */
267 #define AVG_32(dst, src, ref) \
268     AV_WN32A(dst, ((AV_RN32A(src) + AV_RN32A(ref)) >> 1) & 0x7F7F7F7FUL)
269
270 #define AVG_64(dst, src, ref) \
271     AV_WN64A(dst, ((AV_RN64A(src) + AV_RN64A(ref)) >> 1) & 0x7F7F7F7F7F7F7F7FULL)
272
273
274 /*
275  *  Replicate each even pixel as follows:
276  *  ABCDEFGH -> AACCEEGG
277  */
278 static inline uint64_t replicate64(uint64_t a) {
279 #if HAVE_BIGENDIAN
280     a &= 0xFF00FF00FF00FF00ULL;
281     a |= a >> 8;
282 #else
283     a &= 0x00FF00FF00FF00FFULL;
284     a |= a << 8;
285 #endif
286     return a;
287 }
288
289 static inline uint32_t replicate32(uint32_t a) {
290 #if HAVE_BIGENDIAN
291     a &= 0xFF00FF00UL;
292     a |= a >> 8;
293 #else
294     a &= 0x00FF00FFUL;
295     a |= a << 8;
296 #endif
297     return a;
298 }
299
300
301 /* Fill n lines with 64bit pixel value pix */
302 static inline void fill_64(uint8_t *dst, const uint64_t pix, int32_t n,
303                            int32_t row_offset)
304 {
305     for (; n > 0; dst += row_offset, n--)
306         AV_WN64A(dst, pix);
307 }
308
309
310 /* Error codes for cell decoding. */
311 enum {
312     IV3_NOERR       = 0,
313     IV3_BAD_RLE     = 1,
314     IV3_BAD_DATA    = 2,
315     IV3_BAD_COUNTER = 3,
316     IV3_UNSUPPORTED = 4,
317     IV3_OUT_OF_DATA = 5
318 };
319
320
321 #define BUFFER_PRECHECK \
322 if (*data_ptr >= last_ptr) \
323     return IV3_OUT_OF_DATA; \
324
325 #define RLE_BLOCK_COPY \
326     if (cell->mv_ptr || !skip_flag) \
327         copy_block4(dst, ref, row_offset, row_offset, 4 << v_zoom)
328
329 #define RLE_BLOCK_COPY_8 \
330     pix64 = AV_RN64A(ref);\
331     if (is_first_row) {/* special prediction case: top line of a cell */\
332         pix64 = replicate64(pix64);\
333         fill_64(dst + row_offset, pix64, 7, row_offset);\
334         AVG_64(dst, ref, dst + row_offset);\
335     } else \
336         fill_64(dst, pix64, 8, row_offset)
337
338 #define RLE_LINES_COPY \
339     copy_block4(dst, ref, row_offset, row_offset, num_lines << v_zoom)
340
341 #define RLE_LINES_COPY_M10 \
342     pix64 = AV_RN64A(ref);\
343     if (is_top_of_cell) {\
344         pix64 = replicate64(pix64);\
345         fill_64(dst + row_offset, pix64, (num_lines << 1) - 1, row_offset);\
346         AVG_64(dst, ref, dst + row_offset);\
347     } else \
348         fill_64(dst, pix64, num_lines << 1, row_offset)
349
350 #define APPLY_DELTA_4 \
351     AV_WN16A(dst + line_offset    ,\
352              (AV_RN16A(ref    ) + delta_tab->deltas[dyad1]) & 0x7F7F);\
353     AV_WN16A(dst + line_offset + 2,\
354              (AV_RN16A(ref + 2) + delta_tab->deltas[dyad2]) & 0x7F7F);\
355     if (mode >= 3) {\
356         if (is_top_of_cell && !cell->ypos) {\
357             AV_COPY32(dst, dst + row_offset);\
358         } else {\
359             AVG_32(dst, ref, dst + row_offset);\
360         }\
361     }
362
363 #define APPLY_DELTA_8 \
364     /* apply two 32-bit VQ deltas to next even line */\
365     if (is_top_of_cell) { \
366         AV_WN32A(dst + row_offset    , \
367                  (replicate32(AV_RN32A(ref    )) + delta_tab->deltas_m10[dyad1]) & 0x7F7F7F7F);\
368         AV_WN32A(dst + row_offset + 4, \
369                  (replicate32(AV_RN32A(ref + 4)) + delta_tab->deltas_m10[dyad2]) & 0x7F7F7F7F);\
370     } else { \
371         AV_WN32A(dst + row_offset    , \
372                  (AV_RN32A(ref    ) + delta_tab->deltas_m10[dyad1]) & 0x7F7F7F7F);\
373         AV_WN32A(dst + row_offset + 4, \
374                  (AV_RN32A(ref + 4) + delta_tab->deltas_m10[dyad2]) & 0x7F7F7F7F);\
375     } \
376     /* odd lines are not coded but rather interpolated/replicated */\
377     /* first line of the cell on the top of image? - replicate */\
378     /* otherwise - interpolate */\
379     if (is_top_of_cell && !cell->ypos) {\
380         AV_COPY64(dst, dst + row_offset);\
381     } else \
382         AVG_64(dst, ref, dst + row_offset);
383
384
385 #define APPLY_DELTA_1011_INTER \
386     if (mode == 10) { \
387         AV_WN32A(dst                 , \
388                  (AV_RN32A(dst                 ) + delta_tab->deltas_m10[dyad1]) & 0x7F7F7F7F);\
389         AV_WN32A(dst + 4             , \
390                  (AV_RN32A(dst + 4             ) + delta_tab->deltas_m10[dyad2]) & 0x7F7F7F7F);\
391         AV_WN32A(dst + row_offset    , \
392                  (AV_RN32A(dst + row_offset    ) + delta_tab->deltas_m10[dyad1]) & 0x7F7F7F7F);\
393         AV_WN32A(dst + row_offset + 4, \
394                  (AV_RN32A(dst + row_offset + 4) + delta_tab->deltas_m10[dyad2]) & 0x7F7F7F7F);\
395     } else { \
396         AV_WN16A(dst                 , \
397                  (AV_RN16A(dst                 ) + delta_tab->deltas[dyad1]) & 0x7F7F);\
398         AV_WN16A(dst + 2             , \
399                  (AV_RN16A(dst + 2             ) + delta_tab->deltas[dyad2]) & 0x7F7F);\
400         AV_WN16A(dst + row_offset    , \
401                  (AV_RN16A(dst + row_offset    ) + delta_tab->deltas[dyad1]) & 0x7F7F);\
402         AV_WN16A(dst + row_offset + 2, \
403                  (AV_RN16A(dst + row_offset + 2) + delta_tab->deltas[dyad2]) & 0x7F7F);\
404     }
405
406
407 static int decode_cell_data(Cell *cell, uint8_t *block, uint8_t *ref_block,
408                             int pitch, int h_zoom, int v_zoom, int mode,
409                             const vqEntry *delta[2], int swap_quads[2],
410                             const uint8_t **data_ptr, const uint8_t *last_ptr)
411 {
412     int           x, y, line, num_lines;
413     int           rle_blocks = 0;
414     uint8_t       code, *dst, *ref;
415     const vqEntry *delta_tab;
416     unsigned int  dyad1, dyad2;
417     uint64_t      pix64;
418     int           skip_flag = 0, is_top_of_cell, is_first_row = 1;
419     int           row_offset, blk_row_offset, line_offset;
420
421     row_offset     =  pitch;
422     blk_row_offset = (row_offset << (2 + v_zoom)) - (cell->width << 2);
423     line_offset    = v_zoom ? row_offset : 0;
424
425     if (cell->height & v_zoom || cell->width & h_zoom)
426         return IV3_BAD_DATA;
427
428     for (y = 0; y < cell->height; is_first_row = 0, y += 1 + v_zoom) {
429         for (x = 0; x < cell->width; x += 1 + h_zoom) {
430             ref = ref_block;
431             dst = block;
432
433             if (rle_blocks > 0) {
434                 if (mode <= 4) {
435                     RLE_BLOCK_COPY;
436                 } else if (mode == 10 && !cell->mv_ptr) {
437                     RLE_BLOCK_COPY_8;
438                 }
439                 rle_blocks--;
440             } else {
441                 for (line = 0; line < 4;) {
442                     num_lines = 1;
443                     is_top_of_cell = is_first_row && !line;
444
445                     /* select primary VQ table for odd, secondary for even lines */
446                     if (mode <= 4)
447                         delta_tab = delta[line & 1];
448                     else
449                         delta_tab = delta[1];
450                     BUFFER_PRECHECK;
451                     code = bytestream_get_byte(data_ptr);
452                     if (code < 248) {
453                         if (code < delta_tab->num_dyads) {
454                             BUFFER_PRECHECK;
455                             dyad1 = bytestream_get_byte(data_ptr);
456                             dyad2 = code;
457                             if (dyad1 >= delta_tab->num_dyads || dyad1 >= 248)
458                                 return IV3_BAD_DATA;
459                         } else {
460                             /* process QUADS */
461                             code -= delta_tab->num_dyads;
462                             dyad1 = code / delta_tab->quad_exp;
463                             dyad2 = code % delta_tab->quad_exp;
464                             if (swap_quads[line & 1])
465                                 FFSWAP(unsigned int, dyad1, dyad2);
466                         }
467                         if (mode <= 4) {
468                             APPLY_DELTA_4;
469                         } else if (mode == 10 && !cell->mv_ptr) {
470                             APPLY_DELTA_8;
471                         } else {
472                             APPLY_DELTA_1011_INTER;
473                         }
474                     } else {
475                         /* process RLE codes */
476                         switch (code) {
477                         case RLE_ESC_FC:
478                             skip_flag  = 0;
479                             rle_blocks = 1;
480                             code       = 253;
481                             /* FALLTHROUGH */
482                         case RLE_ESC_FF:
483                         case RLE_ESC_FE:
484                         case RLE_ESC_FD:
485                             num_lines = 257 - code - line;
486                             if (num_lines <= 0)
487                                 return IV3_BAD_RLE;
488                             if (mode <= 4) {
489                                 RLE_LINES_COPY;
490                             } else if (mode == 10 && !cell->mv_ptr) {
491                                 RLE_LINES_COPY_M10;
492                             }
493                             break;
494                         case RLE_ESC_FB:
495                             BUFFER_PRECHECK;
496                             code = bytestream_get_byte(data_ptr);
497                             rle_blocks = (code & 0x1F) - 1; /* set block counter */
498                             if (code >= 64 || rle_blocks < 0)
499                                 return IV3_BAD_COUNTER;
500                             skip_flag = code & 0x20;
501                             num_lines = 4 - line; /* enforce next block processing */
502                             if (mode >= 10 || (cell->mv_ptr || !skip_flag)) {
503                                 if (mode <= 4) {
504                                     RLE_LINES_COPY;
505                                 } else if (mode == 10 && !cell->mv_ptr) {
506                                     RLE_LINES_COPY_M10;
507                                 }
508                             }
509                             break;
510                         case RLE_ESC_F9:
511                             skip_flag  = 1;
512                             rle_blocks = 1;
513                             /* FALLTHROUGH */
514                         case RLE_ESC_FA:
515                             if (line)
516                                 return IV3_BAD_RLE;
517                             num_lines = 4; /* enforce next block processing */
518                             if (cell->mv_ptr) {
519                                 if (mode <= 4) {
520                                     RLE_LINES_COPY;
521                                 } else if (mode == 10 && !cell->mv_ptr) {
522                                     RLE_LINES_COPY_M10;
523                                 }
524                             }
525                             break;
526                         default:
527                             return IV3_UNSUPPORTED;
528                         }
529                     }
530
531                     line += num_lines;
532                     ref  += row_offset * (num_lines << v_zoom);
533                     dst  += row_offset * (num_lines << v_zoom);
534                 }
535             }
536
537             /* move to next horizontal block */
538             block     += 4 << h_zoom;
539             ref_block += 4 << h_zoom;
540         }
541
542         /* move to next line of blocks */
543         ref_block += blk_row_offset;
544         block     += blk_row_offset;
545     }
546     return IV3_NOERR;
547 }
548
549
550 /**
551  *  Decode a vector-quantized cell.
552  *  It consists of several routines, each of which handles one or more "modes"
553  *  with which a cell can be encoded.
554  *
555  *  @param ctx      pointer to the decoder context
556  *  @param avctx    ptr to the AVCodecContext
557  *  @param plane    pointer to the plane descriptor
558  *  @param cell     pointer to the cell  descriptor
559  *  @param data_ptr pointer to the compressed data
560  *  @param last_ptr pointer to the last byte to catch reads past end of buffer
561  *  @return         number of consumed bytes or negative number in case of error
562  */
563 static int decode_cell(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
564                        Plane *plane, Cell *cell, const uint8_t *data_ptr,
565                        const uint8_t *last_ptr)
566 {
567     int           x, mv_x, mv_y, mode, vq_index, prim_indx, second_indx;
568     int           zoom_fac;
569     int           offset, error = 0, swap_quads[2];
570     uint8_t       code, *block, *ref_block = 0;
571     const vqEntry *delta[2];
572     const uint8_t *data_start = data_ptr;
573
574     /* get coding mode and VQ table index from the VQ descriptor byte */
575     code     = *data_ptr++;
576     mode     = code >> 4;
577     vq_index = code & 0xF;
578
579     /* setup output and reference pointers */
580     offset = (cell->ypos << 2) * plane->pitch + (cell->xpos << 2);
581     block  =  plane->pixels[ctx->buf_sel] + offset;
582     if (!cell->mv_ptr) {
583         /* use previous line as reference for INTRA cells */
584         ref_block = block - plane->pitch;
585     } else if (mode >= 10) {
586         /* for mode 10 and 11 INTER first copy the predicted cell into the current one */
587         /* so we don't need to do data copying for each RLE code later */
588         copy_cell(ctx, plane, cell);
589     } else {
590         /* set the pointer to the reference pixels for modes 0-4 INTER */
591         mv_y      = cell->mv_ptr[0];
592         mv_x      = cell->mv_ptr[1];
593         offset   += mv_y * plane->pitch + mv_x;
594         ref_block = plane->pixels[ctx->buf_sel ^ 1] + offset;
595     }
596
597     /* select VQ tables as follows: */
598     /* modes 0 and 3 use only the primary table for all lines in a block */
599     /* while modes 1 and 4 switch between primary and secondary tables on alternate lines */
600     if (mode == 1 || mode == 4) {
601         code        = ctx->alt_quant[vq_index];
602         prim_indx   = (code >> 4)  + ctx->cb_offset;
603         second_indx = (code & 0xF) + ctx->cb_offset;
604     } else {
605         vq_index += ctx->cb_offset;
606         prim_indx = second_indx = vq_index;
607     }
608
609     if (prim_indx >= 24 || second_indx >= 24) {
610         av_log(avctx, AV_LOG_ERROR, "Invalid VQ table indexes! Primary: %d, secondary: %d!\n",
611                prim_indx, second_indx);
612         return AVERROR_INVALIDDATA;
613     }
614
615     delta[0] = &vq_tab[second_indx];
616     delta[1] = &vq_tab[prim_indx];
617     swap_quads[0] = second_indx >= 16;
618     swap_quads[1] = prim_indx   >= 16;
619
620     /* requantize the prediction if VQ index of this cell differs from VQ index */
621     /* of the predicted cell in order to avoid overflows. */
622     if (vq_index >= 8 && ref_block) {
623         for (x = 0; x < cell->width << 2; x++)
624             ref_block[x] = requant_tab[vq_index & 7][ref_block[x]];
625     }
626
627     error = IV3_NOERR;
628
629     switch (mode) {
630     case 0: /*------------------ MODES 0 & 1 (4x4 block processing) --------------------*/
631     case 1:
632     case 3: /*------------------ MODES 3 & 4 (4x8 block processing) --------------------*/
633     case 4:
634         if (mode >= 3 && cell->mv_ptr) {
635             av_log(avctx, AV_LOG_ERROR, "Attempt to apply Mode 3/4 to an INTER cell!\n");
636             return AVERROR_INVALIDDATA;
637         }
638
639         zoom_fac = mode >= 3;
640         error = decode_cell_data(cell, block, ref_block, plane->pitch, 0, zoom_fac,
641                                  mode, delta, swap_quads, &data_ptr, last_ptr);
642         break;
643     case 10: /*-------------------- MODE 10 (8x8 block processing) ---------------------*/
644     case 11: /*----------------- MODE 11 (4x8 INTER block processing) ------------------*/
645         if (mode == 10 && !cell->mv_ptr) { /* MODE 10 INTRA processing */
646             error = decode_cell_data(cell, block, ref_block, plane->pitch, 1, 1,
647                                      mode, delta, swap_quads, &data_ptr, last_ptr);
648         } else { /* mode 10 and 11 INTER processing */
649             if (mode == 11 && !cell->mv_ptr) {
650                av_log(avctx, AV_LOG_ERROR, "Attempt to use Mode 11 for an INTRA cell!\n");
651                return AVERROR_INVALIDDATA;
652             }
653
654             zoom_fac = mode == 10;
655             error = decode_cell_data(cell, block, ref_block, plane->pitch,
656                                      zoom_fac, 1, mode, delta, swap_quads,
657                                      &data_ptr, last_ptr);
658         }
659         break;
660     default:
661         av_log(avctx, AV_LOG_ERROR, "Unsupported coding mode: %d\n", mode);
662         return AVERROR_INVALIDDATA;
663     }//switch mode
664
665     switch (error) {
666     case IV3_BAD_RLE:
667         av_log(avctx, AV_LOG_ERROR, "Mode %d: RLE code %X is not allowed at the current line\n",
668                mode, data_ptr[-1]);
669         return AVERROR_INVALIDDATA;
670     case IV3_BAD_DATA:
671         av_log(avctx, AV_LOG_ERROR, "Mode %d: invalid VQ data\n", mode);
672         return AVERROR_INVALIDDATA;
673     case IV3_BAD_COUNTER:
674         av_log(avctx, AV_LOG_ERROR, "Mode %d: RLE-FB invalid counter: %d\n", mode, code);
675         return AVERROR_INVALIDDATA;
676     case IV3_UNSUPPORTED:
677         av_log(avctx, AV_LOG_ERROR, "Mode %d: unsupported RLE code: %X\n", mode, data_ptr[-1]);
678         return AVERROR_INVALIDDATA;
679     case IV3_OUT_OF_DATA:
680         av_log(avctx, AV_LOG_ERROR, "Mode %d: attempt to read past end of buffer\n", mode);
681         return AVERROR_INVALIDDATA;
682     }
683
684     return data_ptr - data_start; /* report number of bytes consumed from the input buffer */
685 }
686
687
688 /* Binary tree codes. */
689 enum {
690     H_SPLIT    = 0,
691     V_SPLIT    = 1,
692     INTRA_NULL = 2,
693     INTER_DATA = 3
694 };
695
696
697 #define SPLIT_CELL(size, new_size) (new_size) = ((size) > 2) ? ((((size) + 2) >> 2) << 1) : 1
698
699 #define UPDATE_BITPOS(n) \
700     ctx->skip_bits  += (n); \
701     ctx->need_resync = 1
702
703 #define RESYNC_BITSTREAM \
704     if (ctx->need_resync && !(get_bits_count(&ctx->gb) & 7)) { \
705         skip_bits_long(&ctx->gb, ctx->skip_bits);              \
706         ctx->skip_bits   = 0;                                  \
707         ctx->need_resync = 0;                                  \
708     }
709
710 #define CHECK_CELL \
711     if (curr_cell.xpos + curr_cell.width > (plane->width >> 2) ||               \
712         curr_cell.ypos + curr_cell.height > (plane->height >> 2)) {             \
713         av_log(avctx, AV_LOG_ERROR, "Invalid cell: x=%d, y=%d, w=%d, h=%d\n",   \
714                curr_cell.xpos, curr_cell.ypos, curr_cell.width, curr_cell.height); \
715         return AVERROR_INVALIDDATA;                                                              \
716     }
717
718
719 static int parse_bintree(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
720                          Plane *plane, int code, Cell *ref_cell,
721                          const int depth, const int strip_width)
722 {
723     Cell    curr_cell;
724     int     bytes_used;
725
726     if (depth <= 0) {
727         av_log(avctx, AV_LOG_ERROR, "Stack overflow (corrupted binary tree)!\n");
728         return AVERROR_INVALIDDATA; // unwind recursion
729     }
730
731     curr_cell = *ref_cell; // clone parent cell
732     if (code == H_SPLIT) {
733         SPLIT_CELL(ref_cell->height, curr_cell.height);
734         ref_cell->ypos   += curr_cell.height;
735         ref_cell->height -= curr_cell.height;
736         if (ref_cell->height <= 0 || curr_cell.height <= 0)
737             return AVERROR_INVALIDDATA;
738     } else if (code == V_SPLIT) {
739         if (curr_cell.width > strip_width) {
740             /* split strip */
741             curr_cell.width = (curr_cell.width <= (strip_width << 1) ? 1 : 2) * strip_width;
742         } else
743             SPLIT_CELL(ref_cell->width, curr_cell.width);
744         ref_cell->xpos  += curr_cell.width;
745         ref_cell->width -= curr_cell.width;
746         if (ref_cell->width <= 0 || curr_cell.width <= 0)
747             return AVERROR_INVALIDDATA;
748     }
749
750     while (1) { /* loop until return */
751         RESYNC_BITSTREAM;
752         switch (code = get_bits(&ctx->gb, 2)) {
753         case H_SPLIT:
754         case V_SPLIT:
755             if (parse_bintree(ctx, avctx, plane, code, &curr_cell, depth - 1, strip_width))
756                 return AVERROR_INVALIDDATA;
757             break;
758         case INTRA_NULL:
759             if (!curr_cell.tree) { /* MC tree INTRA code */
760                 curr_cell.mv_ptr = 0; /* mark the current strip as INTRA */
761                 curr_cell.tree   = 1; /* enter the VQ tree */
762             } else { /* VQ tree NULL code */
763                 RESYNC_BITSTREAM;
764                 code = get_bits(&ctx->gb, 2);
765                 if (code >= 2) {
766                     av_log(avctx, AV_LOG_ERROR, "Invalid VQ_NULL code: %d\n", code);
767                     return AVERROR_INVALIDDATA;
768                 }
769                 if (code == 1)
770                     av_log(avctx, AV_LOG_ERROR, "SkipCell procedure not implemented yet!\n");
771
772                 CHECK_CELL
773                 if (!curr_cell.mv_ptr)
774                     return AVERROR_INVALIDDATA;
775                 copy_cell(ctx, plane, &curr_cell);
776                 return 0;
777             }
778             break;
779         case INTER_DATA:
780             if (!curr_cell.tree) { /* MC tree INTER code */
781                 unsigned mv_idx;
782                 /* get motion vector index and setup the pointer to the mv set */
783                 if (!ctx->need_resync)
784                     ctx->next_cell_data = &ctx->gb.buffer[(get_bits_count(&ctx->gb) + 7) >> 3];
785                 mv_idx = *(ctx->next_cell_data++);
786                 if (mv_idx >= ctx->num_vectors) {
787                     av_log(avctx, AV_LOG_ERROR, "motion vector index out of range\n");
788                     return AVERROR_INVALIDDATA;
789                 }
790                 curr_cell.mv_ptr = &ctx->mc_vectors[mv_idx << 1];
791                 curr_cell.tree   = 1; /* enter the VQ tree */
792                 UPDATE_BITPOS(8);
793             } else { /* VQ tree DATA code */
794                 if (!ctx->need_resync)
795                     ctx->next_cell_data = &ctx->gb.buffer[(get_bits_count(&ctx->gb) + 7) >> 3];
796
797                 CHECK_CELL
798                 bytes_used = decode_cell(ctx, avctx, plane, &curr_cell,
799                                          ctx->next_cell_data, ctx->last_byte);
800                 if (bytes_used < 0)
801                     return AVERROR_INVALIDDATA;
802
803                 UPDATE_BITPOS(bytes_used << 3);
804                 ctx->next_cell_data += bytes_used;
805                 return 0;
806             }
807             break;
808         }
809     }//while
810
811     return 0;
812 }
813
814
815 static int decode_plane(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
816                         Plane *plane, const uint8_t *data, int32_t data_size,
817                         int32_t strip_width)
818 {
819     Cell            curr_cell;
820     unsigned        num_vectors;
821
822     /* each plane data starts with mc_vector_count field, */
823     /* an optional array of motion vectors followed by the vq data */
824     num_vectors = bytestream_get_le32(&data);
825     if (num_vectors > 256) {
826         av_log(ctx->avctx, AV_LOG_ERROR,
827                "Read invalid number of motion vectors %d\n", num_vectors);
828         return AVERROR_INVALIDDATA;
829     }
830     if (num_vectors * 2 >= data_size)
831         return AVERROR_INVALIDDATA;
832
833     ctx->num_vectors = num_vectors;
834     ctx->mc_vectors  = num_vectors ? data : 0;
835
836     /* init the bitreader */
837     init_get_bits(&ctx->gb, &data[num_vectors * 2], (data_size - num_vectors * 2) << 3);
838     ctx->skip_bits   = 0;
839     ctx->need_resync = 0;
840
841     ctx->last_byte = data + data_size - 1;
842
843     /* initialize the 1st cell and set its dimensions to whole plane */
844     curr_cell.xpos   = curr_cell.ypos = 0;
845     curr_cell.width  = plane->width  >> 2;
846     curr_cell.height = plane->height >> 2;
847     curr_cell.tree   = 0; // we are in the MC tree now
848     curr_cell.mv_ptr = 0; // no motion vector = INTRA cell
849
850     return parse_bintree(ctx, avctx, plane, INTRA_NULL, &curr_cell, CELL_STACK_MAX, strip_width);
851 }
852
853
854 #define OS_HDR_ID   MKBETAG('F', 'R', 'M', 'H')
855
856 static int decode_frame_headers(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
857                                 const uint8_t *buf, int buf_size)
858 {
859     const uint8_t   *buf_ptr = buf, *bs_hdr;
860     uint32_t        frame_num, word2, check_sum, data_size;
861     uint32_t        y_offset, u_offset, v_offset, starts[3], ends[3];
862     uint16_t        height, width;
863     int             i, j;
864
865     /* parse and check the OS header */
866     frame_num = bytestream_get_le32(&buf_ptr);
867     word2     = bytestream_get_le32(&buf_ptr);
868     check_sum = bytestream_get_le32(&buf_ptr);
869     data_size = bytestream_get_le32(&buf_ptr);
870
871     if ((frame_num ^ word2 ^ data_size ^ OS_HDR_ID) != check_sum) {
872         av_log(avctx, AV_LOG_ERROR, "OS header checksum mismatch!\n");
873         return AVERROR_INVALIDDATA;
874     }
875
876     /* parse the bitstream header */
877     bs_hdr = buf_ptr;
878
879     if (bytestream_get_le16(&buf_ptr) != 32) {
880         av_log(avctx, AV_LOG_ERROR, "Unsupported codec version!\n");
881         return AVERROR_INVALIDDATA;
882     }
883
884     ctx->frame_num   =  frame_num;
885     ctx->frame_flags =  bytestream_get_le16(&buf_ptr);
886     ctx->data_size   = (bytestream_get_le32(&buf_ptr) + 7) >> 3;
887     ctx->cb_offset   = *buf_ptr++;
888
889     if (ctx->data_size == 16)
890         return 4;
891     if (ctx->data_size > buf_size)
892         ctx->data_size = buf_size;
893
894     buf_ptr += 3; // skip reserved byte and checksum
895
896     /* check frame dimensions */
897     height = bytestream_get_le16(&buf_ptr);
898     width  = bytestream_get_le16(&buf_ptr);
899     if (av_image_check_size(width, height, 0, avctx))
900         return AVERROR_INVALIDDATA;
901
902     if (width != ctx->width || height != ctx->height) {
903         int res;
904
905         av_dlog(avctx, "Frame dimensions changed!\n");
906
907         if (width  < 16 || width  > 640 ||
908             height < 16 || height > 480 ||
909             width  &  3 || height &   3) {
910             av_log(avctx, AV_LOG_ERROR,
911                    "Invalid picture dimensions: %d x %d!\n", width, height);
912             return AVERROR_INVALIDDATA;
913         }
914
915         ctx->width  = width;
916         ctx->height = height;
917
918         free_frame_buffers(ctx);
919         if ((res = allocate_frame_buffers(ctx, avctx)) < 0)
920              return res;
921         avcodec_set_dimensions(avctx, width, height);
922     }
923
924     y_offset = bytestream_get_le32(&buf_ptr);
925     v_offset = bytestream_get_le32(&buf_ptr);
926     u_offset = bytestream_get_le32(&buf_ptr);
927
928     /* unfortunately there is no common order of planes in the buffer */
929     /* so we use that sorting algo for determining planes data sizes  */
930     starts[0] = y_offset;
931     starts[1] = v_offset;
932     starts[2] = u_offset;
933
934     for (j = 0; j < 3; j++) {
935         ends[j] = ctx->data_size;
936         for (i = 2; i >= 0; i--)
937             if (starts[i] < ends[j] && starts[i] > starts[j])
938                 ends[j] = starts[i];
939     }
940
941     ctx->y_data_size = ends[0] - starts[0];
942     ctx->v_data_size = ends[1] - starts[1];
943     ctx->u_data_size = ends[2] - starts[2];
944     if (FFMAX3(y_offset, v_offset, u_offset) >= ctx->data_size - 16 ||
945         FFMIN3(ctx->y_data_size, ctx->v_data_size, ctx->u_data_size) <= 0) {
946         av_log(avctx, AV_LOG_ERROR, "One of the y/u/v offsets is invalid\n");
947         return AVERROR_INVALIDDATA;
948     }
949
950     ctx->y_data_ptr = bs_hdr + y_offset;
951     ctx->v_data_ptr = bs_hdr + v_offset;
952     ctx->u_data_ptr = bs_hdr + u_offset;
953     ctx->alt_quant  = buf_ptr + sizeof(uint32_t);
954
955     if (ctx->data_size == 16) {
956         av_log(avctx, AV_LOG_DEBUG, "Sync frame encountered!\n");
957         return 16;
958     }
959
960     if (ctx->frame_flags & BS_8BIT_PEL) {
961         av_log_ask_for_sample(avctx, "8-bit pixel format\n");
962         return AVERROR_PATCHWELCOME;
963     }
964
965     if (ctx->frame_flags & BS_MV_X_HALF || ctx->frame_flags & BS_MV_Y_HALF) {
966         av_log_ask_for_sample(avctx, "halfpel motion vectors\n");
967         return AVERROR_PATCHWELCOME;
968     }
969
970     return 0;
971 }
972
973
974 /**
975  *  Convert and output the current plane.
976  *  All pixel values will be upsampled by shifting right by one bit.
977  *
978  *  @param[in]  plane        pointer to the descriptor of the plane being processed
979  *  @param[in]  buf_sel      indicates which frame buffer the input data stored in
980  *  @param[out] dst          pointer to the buffer receiving converted pixels
981  *  @param[in]  dst_pitch    pitch for moving to the next y line
982  *  @param[in]  dst_height   output plane height
983  */
984 static void output_plane(const Plane *plane, int buf_sel, uint8_t *dst,
985                          int dst_pitch, int dst_height)
986 {
987     int             x,y;
988     const uint8_t   *src  = plane->pixels[buf_sel];
989     uint32_t        pitch = plane->pitch;
990
991     dst_height = FFMIN(dst_height, plane->height);
992     for (y = 0; y < dst_height; y++) {
993         /* convert four pixels at once using SWAR */
994         for (x = 0; x < plane->width >> 2; x++) {
995             AV_WN32A(dst, (AV_RN32A(src) & 0x7F7F7F7F) << 1);
996             src += 4;
997             dst += 4;
998         }
999
1000         for (x <<= 2; x < plane->width; x++)
1001             *dst++ = *src++ << 1;
1002
1003         src += pitch     - plane->width;
1004         dst += dst_pitch - plane->width;
1005     }
1006 }
1007
1008
1009 static av_cold int decode_init(AVCodecContext *avctx)
1010 {
1011     Indeo3DecodeContext *ctx = avctx->priv_data;
1012
1013     ctx->avctx     = avctx;
1014     ctx->width     = avctx->width;
1015     ctx->height    = avctx->height;
1016     avctx->pix_fmt = AV_PIX_FMT_YUV410P;
1017
1018     build_requant_tab();
1019
1020     ff_dsputil_init(&ctx->dsp, avctx);
1021
1022     allocate_frame_buffers(ctx, avctx);
1023
1024     return 0;
1025 }
1026
1027
1028 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
1029                         AVPacket *avpkt)
1030 {
1031     Indeo3DecodeContext *ctx = avctx->priv_data;
1032     const uint8_t *buf = avpkt->data;
1033     int buf_size       = avpkt->size;
1034     int res;
1035
1036     res = decode_frame_headers(ctx, avctx, buf, buf_size);
1037     if (res < 0)
1038         return res;
1039
1040     /* skip sync(null) frames */
1041     if (res) {
1042         // we have processed 16 bytes but no data was decoded
1043         *got_frame = 0;
1044         return buf_size;
1045     }
1046
1047     /* skip droppable INTER frames if requested */
1048     if (ctx->frame_flags & BS_NONREF &&
1049        (avctx->skip_frame >= AVDISCARD_NONREF))
1050         return 0;
1051
1052     /* skip INTER frames if requested */
1053     if (!(ctx->frame_flags & BS_KEYFRAME) && avctx->skip_frame >= AVDISCARD_NONKEY)
1054         return 0;
1055
1056     /* use BS_BUFFER flag for buffer switching */
1057     ctx->buf_sel = (ctx->frame_flags >> BS_BUFFER) & 1;
1058
1059     /* decode luma plane */
1060     if ((res = decode_plane(ctx, avctx, ctx->planes, ctx->y_data_ptr, ctx->y_data_size, 40)))
1061         return res;
1062
1063     /* decode chroma planes */
1064     if ((res = decode_plane(ctx, avctx, &ctx->planes[1], ctx->u_data_ptr, ctx->u_data_size, 10)))
1065         return res;
1066
1067     if ((res = decode_plane(ctx, avctx, &ctx->planes[2], ctx->v_data_ptr, ctx->v_data_size, 10)))
1068         return res;
1069
1070     if (ctx->frame.data[0])
1071         avctx->release_buffer(avctx, &ctx->frame);
1072
1073     ctx->frame.reference = 0;
1074     if ((res = ff_get_buffer(avctx, &ctx->frame)) < 0) {
1075         av_log(ctx->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
1076         return res;
1077     }
1078
1079     output_plane(&ctx->planes[0], ctx->buf_sel,
1080                  ctx->frame.data[0], ctx->frame.linesize[0],
1081                  avctx->height);
1082     output_plane(&ctx->planes[1], ctx->buf_sel,
1083                  ctx->frame.data[1], ctx->frame.linesize[1],
1084                  (avctx->height + 3) >> 2);
1085     output_plane(&ctx->planes[2], ctx->buf_sel,
1086                  ctx->frame.data[2], ctx->frame.linesize[2],
1087                  (avctx->height + 3) >> 2);
1088
1089     *got_frame = 1;
1090     *(AVFrame*)data = ctx->frame;
1091
1092     return buf_size;
1093 }
1094
1095
1096 static av_cold int decode_close(AVCodecContext *avctx)
1097 {
1098     Indeo3DecodeContext *ctx = avctx->priv_data;
1099
1100     free_frame_buffers(avctx->priv_data);
1101
1102     if (ctx->frame.data[0])
1103         avctx->release_buffer(avctx, &ctx->frame);
1104
1105     return 0;
1106 }
1107
1108 AVCodec ff_indeo3_decoder = {
1109     .name           = "indeo3",
1110     .type           = AVMEDIA_TYPE_VIDEO,
1111     .id             = AV_CODEC_ID_INDEO3,
1112     .priv_data_size = sizeof(Indeo3DecodeContext),
1113     .init           = decode_init,
1114     .close          = decode_close,
1115     .decode         = decode_frame,
1116     .capabilities   = CODEC_CAP_DR1,
1117     .long_name      = NULL_IF_CONFIG_SMALL("Intel Indeo 3"),
1118 };