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