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