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