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