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