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