662ef13fff1c0fece482e2eeb922432138e8aa0d
[ffmpeg.git] / libavcodec / ffv1dec.c
1 /*
2  * FFV1 decoder
3  *
4  * Copyright (c) 2003-2013 Michael Niedermayer <michaelni@gmx.at>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * FF Video Codec 1 (a lossless codec) decoder
26  */
27
28 #include "libavutil/avassert.h"
29 #include "libavutil/crc.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/pixdesc.h"
33 #include "libavutil/timer.h"
34 #include "avcodec.h"
35 #include "internal.h"
36 #include "get_bits.h"
37 #include "rangecoder.h"
38 #include "golomb.h"
39 #include "mathops.h"
40 #include "ffv1.h"
41
42 static inline av_flatten int get_symbol_inline(RangeCoder *c, uint8_t *state,
43                                                int is_signed)
44 {
45     if (get_rac(c, state + 0))
46         return 0;
47     else {
48         int i, e, a;
49         e = 0;
50         while (get_rac(c, state + 1 + FFMIN(e, 9))) { // 1..10
51             e++;
52             if (e > 31)
53                 return AVERROR_INVALIDDATA;
54         }
55
56         a = 1;
57         for (i = e - 1; i >= 0; i--)
58             a += a + get_rac(c, state + 22 + FFMIN(i, 9));  // 22..31
59
60         e = -(is_signed && get_rac(c, state + 11 + FFMIN(e, 10))); // 11..21
61         return (a ^ e) - e;
62     }
63 }
64
65 static av_noinline int get_symbol(RangeCoder *c, uint8_t *state, int is_signed)
66 {
67     return get_symbol_inline(c, state, is_signed);
68 }
69
70 static inline int get_vlc_symbol(GetBitContext *gb, VlcState *const state,
71                                  int bits)
72 {
73     int k, i, v, ret;
74
75     i = state->count;
76     k = 0;
77     while (i < state->error_sum) { // FIXME: optimize
78         k++;
79         i += i;
80     }
81
82     v = get_sr_golomb(gb, k, 12, bits);
83     ff_dlog(NULL, "v:%d bias:%d error:%d drift:%d count:%d k:%d",
84             v, state->bias, state->error_sum, state->drift, state->count, k);
85
86 #if 0 // JPEG LS
87     if (k == 0 && 2 * state->drift <= -state->count)
88         v ^= (-1);
89 #else
90     v ^= ((2 * state->drift + state->count) >> 31);
91 #endif
92
93     ret = fold(v + state->bias, bits);
94
95     update_vlc_state(state, v);
96
97     return ret;
98 }
99
100 static av_always_inline void decode_line(FFV1Context *s, int w,
101                                          int16_t *sample[2],
102                                          int plane_index, int bits)
103 {
104     PlaneContext *const p = &s->plane[plane_index];
105     RangeCoder *const c   = &s->c;
106     int x;
107     int run_count = 0;
108     int run_mode  = 0;
109     int run_index = s->run_index;
110
111     if (s->slice_coding_mode == 1) {
112         int i;
113         for (x = 0; x < w; x++) {
114             int v = 0;
115             for (i=0; i<bits; i++) {
116                 uint8_t state = 128;
117                 v += v + get_rac(c, &state);
118             }
119             sample[1][x] = v;
120         }
121         return;
122     }
123
124     for (x = 0; x < w; x++) {
125         int diff, context, sign;
126
127         context = get_context(p, sample[1] + x, sample[0] + x, sample[1] + x);
128         if (context < 0) {
129             context = -context;
130             sign    = 1;
131         } else
132             sign = 0;
133
134         av_assert2(context < p->context_count);
135
136         if (s->ac) {
137             diff = get_symbol_inline(c, p->state[context], 1);
138         } else {
139             if (context == 0 && run_mode == 0)
140                 run_mode = 1;
141
142             if (run_mode) {
143                 if (run_count == 0 && run_mode == 1) {
144                     if (get_bits1(&s->gb)) {
145                         run_count = 1 << ff_log2_run[run_index];
146                         if (x + run_count <= w)
147                             run_index++;
148                     } else {
149                         if (ff_log2_run[run_index])
150                             run_count = get_bits(&s->gb, ff_log2_run[run_index]);
151                         else
152                             run_count = 0;
153                         if (run_index)
154                             run_index--;
155                         run_mode = 2;
156                     }
157                 }
158                 run_count--;
159                 if (run_count < 0) {
160                     run_mode  = 0;
161                     run_count = 0;
162                     diff      = get_vlc_symbol(&s->gb, &p->vlc_state[context],
163                                                bits);
164                     if (diff >= 0)
165                         diff++;
166                 } else
167                     diff = 0;
168             } else
169                 diff = get_vlc_symbol(&s->gb, &p->vlc_state[context], bits);
170
171             ff_dlog(s->avctx, "count:%d index:%d, mode:%d, x:%d pos:%d\n",
172                     run_count, run_index, run_mode, x, get_bits_count(&s->gb));
173         }
174
175         if (sign)
176             diff = -diff;
177
178         sample[1][x] = av_mod_uintp2(predict(sample[1] + x, sample[0] + x) + diff, bits);
179     }
180     s->run_index = run_index;
181 }
182
183 static void decode_plane(FFV1Context *s, uint8_t *src,
184                          int w, int h, int stride, int plane_index)
185 {
186     int x, y;
187     int16_t *sample[2];
188     sample[0] = s->sample_buffer + 3;
189     sample[1] = s->sample_buffer + w + 6 + 3;
190
191     s->run_index = 0;
192
193     memset(s->sample_buffer, 0, 2 * (w + 6) * sizeof(*s->sample_buffer));
194
195     for (y = 0; y < h; y++) {
196         int16_t *temp = sample[0]; // FIXME: try a normal buffer
197
198         sample[0] = sample[1];
199         sample[1] = temp;
200
201         sample[1][-1] = sample[0][0];
202         sample[0][w]  = sample[0][w - 1];
203
204 // { START_TIMER
205         if (s->avctx->bits_per_raw_sample <= 8) {
206             decode_line(s, w, sample, plane_index, 8);
207             for (x = 0; x < w; x++)
208                 src[x + stride * y] = sample[1][x];
209         } else {
210             decode_line(s, w, sample, plane_index, s->avctx->bits_per_raw_sample);
211             if (s->packed_at_lsb) {
212                 for (x = 0; x < w; x++) {
213                     ((uint16_t*)(src + stride*y))[x] = sample[1][x];
214                 }
215             } else {
216                 for (x = 0; x < w; x++) {
217                     ((uint16_t*)(src + stride*y))[x] = sample[1][x] << (16 - s->avctx->bits_per_raw_sample);
218                 }
219             }
220         }
221 // STOP_TIMER("decode-line") }
222     }
223 }
224
225 static void decode_rgb_frame(FFV1Context *s, uint8_t *src[3], int w, int h, int stride[3])
226 {
227     int x, y, p;
228     int16_t *sample[4][2];
229     int lbd    = s->avctx->bits_per_raw_sample <= 8;
230     int bits   = s->avctx->bits_per_raw_sample > 0 ? s->avctx->bits_per_raw_sample : 8;
231     int offset = 1 << bits;
232
233     for (x = 0; x < 4; x++) {
234         sample[x][0] = s->sample_buffer +  x * 2      * (w + 6) + 3;
235         sample[x][1] = s->sample_buffer + (x * 2 + 1) * (w + 6) + 3;
236     }
237
238     s->run_index = 0;
239
240     memset(s->sample_buffer, 0, 8 * (w + 6) * sizeof(*s->sample_buffer));
241
242     for (y = 0; y < h; y++) {
243         for (p = 0; p < 3 + s->transparency; p++) {
244             int16_t *temp = sample[p][0]; // FIXME: try a normal buffer
245
246             sample[p][0] = sample[p][1];
247             sample[p][1] = temp;
248
249             sample[p][1][-1]= sample[p][0][0  ];
250             sample[p][0][ w]= sample[p][0][w-1];
251             if (lbd && s->slice_coding_mode == 0)
252                 decode_line(s, w, sample[p], (p + 1)/2, 9);
253             else
254                 decode_line(s, w, sample[p], (p + 1)/2, bits + (s->slice_coding_mode != 1));
255         }
256         for (x = 0; x < w; x++) {
257             int g = sample[0][1][x];
258             int b = sample[1][1][x];
259             int r = sample[2][1][x];
260             int a = sample[3][1][x];
261
262             if (s->slice_coding_mode != 1) {
263                 b -= offset;
264                 r -= offset;
265                 g -= (b * s->slice_rct_by_coef + r * s->slice_rct_ry_coef) >> 2;
266                 b += g;
267                 r += g;
268             }
269
270             if (lbd)
271                 *((uint32_t*)(src[0] + x*4 + stride[0]*y)) = b + (g<<8) + (r<<16) + (a<<24);
272             else {
273                 *((uint16_t*)(src[0] + x*2 + stride[0]*y)) = b;
274                 *((uint16_t*)(src[1] + x*2 + stride[1]*y)) = g;
275                 *((uint16_t*)(src[2] + x*2 + stride[2]*y)) = r;
276             }
277         }
278     }
279 }
280
281 static int decode_slice_header(FFV1Context *f, FFV1Context *fs)
282 {
283     RangeCoder *c = &fs->c;
284     uint8_t state[CONTEXT_SIZE];
285     unsigned ps, i, context_count;
286     memset(state, 128, sizeof(state));
287
288     av_assert0(f->version > 2);
289
290     fs->slice_x      =  get_symbol(c, state, 0)      * f->width ;
291     fs->slice_y      =  get_symbol(c, state, 0)      * f->height;
292     fs->slice_width  = (get_symbol(c, state, 0) + 1) * f->width  + fs->slice_x;
293     fs->slice_height = (get_symbol(c, state, 0) + 1) * f->height + fs->slice_y;
294
295     fs->slice_x /= f->num_h_slices;
296     fs->slice_y /= f->num_v_slices;
297     fs->slice_width  = fs->slice_width /f->num_h_slices - fs->slice_x;
298     fs->slice_height = fs->slice_height/f->num_v_slices - fs->slice_y;
299     if ((unsigned)fs->slice_width > f->width || (unsigned)fs->slice_height > f->height)
300         return -1;
301     if (    (unsigned)fs->slice_x + (uint64_t)fs->slice_width  > f->width
302          || (unsigned)fs->slice_y + (uint64_t)fs->slice_height > f->height)
303         return -1;
304
305     for (i = 0; i < f->plane_count; i++) {
306         PlaneContext * const p = &fs->plane[i];
307         int idx = get_symbol(c, state, 0);
308         if (idx >= (unsigned)f->quant_table_count) {
309             av_log(f->avctx, AV_LOG_ERROR, "quant_table_index out of range\n");
310             return -1;
311         }
312         p->quant_table_index = idx;
313         memcpy(p->quant_table, f->quant_tables[idx], sizeof(p->quant_table));
314         context_count = f->context_count[idx];
315
316         if (p->context_count < context_count) {
317             av_freep(&p->state);
318             av_freep(&p->vlc_state);
319         }
320         p->context_count = context_count;
321     }
322
323     ps = get_symbol(c, state, 0);
324     if (ps == 1) {
325         f->cur->interlaced_frame = 1;
326         f->cur->top_field_first  = 1;
327     } else if (ps == 2) {
328         f->cur->interlaced_frame = 1;
329         f->cur->top_field_first  = 0;
330     } else if (ps == 3) {
331         f->cur->interlaced_frame = 0;
332     }
333     f->cur->sample_aspect_ratio.num = get_symbol(c, state, 0);
334     f->cur->sample_aspect_ratio.den = get_symbol(c, state, 0);
335
336     if (av_image_check_sar(f->width, f->height,
337                            f->cur->sample_aspect_ratio) < 0) {
338         av_log(f->avctx, AV_LOG_WARNING, "ignoring invalid SAR: %u/%u\n",
339                f->cur->sample_aspect_ratio.num,
340                f->cur->sample_aspect_ratio.den);
341         f->cur->sample_aspect_ratio = (AVRational){ 0, 1 };
342     }
343
344     if (fs->version > 3) {
345         fs->slice_reset_contexts = get_rac(c, state);
346         fs->slice_coding_mode = get_symbol(c, state, 0);
347         if (fs->slice_coding_mode != 1) {
348             fs->slice_rct_by_coef = get_symbol(c, state, 0);
349             fs->slice_rct_ry_coef = get_symbol(c, state, 0);
350             if ((uint64_t)fs->slice_rct_by_coef + (uint64_t)fs->slice_rct_ry_coef > 4) {
351                 av_log(f->avctx, AV_LOG_ERROR, "slice_rct_y_coef out of range\n");
352                 return AVERROR_INVALIDDATA;
353             }
354         }
355     }
356
357     return 0;
358 }
359
360 static int decode_slice(AVCodecContext *c, void *arg)
361 {
362     FFV1Context *fs   = *(void **)arg;
363     FFV1Context *f    = fs->avctx->priv_data;
364     int width, height, x, y, ret;
365     const int ps      = av_pix_fmt_desc_get(c->pix_fmt)->comp[0].step;
366     AVFrame * const p = f->cur;
367     int i, si;
368
369     for( si=0; fs != f->slice_context[si]; si ++)
370         ;
371
372     if(f->fsrc && !p->key_frame)
373         ff_thread_await_progress(&f->last_picture, si, 0);
374
375     if(f->fsrc && !p->key_frame) {
376         FFV1Context *fssrc = f->fsrc->slice_context[si];
377         FFV1Context *fsdst = f->slice_context[si];
378         av_assert1(fsdst->plane_count == fssrc->plane_count);
379         av_assert1(fsdst == fs);
380
381         if (!p->key_frame)
382             fsdst->slice_damaged |= fssrc->slice_damaged;
383
384         for (i = 0; i < f->plane_count; i++) {
385             PlaneContext *psrc = &fssrc->plane[i];
386             PlaneContext *pdst = &fsdst->plane[i];
387
388             av_free(pdst->state);
389             av_free(pdst->vlc_state);
390             memcpy(pdst, psrc, sizeof(*pdst));
391             pdst->state = NULL;
392             pdst->vlc_state = NULL;
393
394             if (fssrc->ac) {
395                 pdst->state = av_malloc_array(CONTEXT_SIZE,  psrc->context_count);
396                 memcpy(pdst->state, psrc->state, CONTEXT_SIZE * psrc->context_count);
397             } else {
398                 pdst->vlc_state = av_malloc_array(sizeof(*pdst->vlc_state), psrc->context_count);
399                 memcpy(pdst->vlc_state, psrc->vlc_state, sizeof(*pdst->vlc_state) * psrc->context_count);
400             }
401         }
402     }
403
404     fs->slice_rct_by_coef = 1;
405     fs->slice_rct_ry_coef = 1;
406
407     if (f->version > 2) {
408         if (ff_ffv1_init_slice_state(f, fs) < 0)
409             return AVERROR(ENOMEM);
410         if (decode_slice_header(f, fs) < 0) {
411             fs->slice_damaged = 1;
412             return AVERROR_INVALIDDATA;
413         }
414     }
415     if ((ret = ff_ffv1_init_slice_state(f, fs)) < 0)
416         return ret;
417     if (f->cur->key_frame || fs->slice_reset_contexts)
418         ff_ffv1_clear_slice_state(f, fs);
419
420     width  = fs->slice_width;
421     height = fs->slice_height;
422     x      = fs->slice_x;
423     y      = fs->slice_y;
424
425     if (!fs->ac) {
426         if (f->version == 3 && f->micro_version > 1 || f->version > 3)
427             get_rac(&fs->c, (uint8_t[]) { 129 });
428         fs->ac_byte_count = f->version > 2 || (!x && !y) ? fs->c.bytestream - fs->c.bytestream_start - 1 : 0;
429         init_get_bits(&fs->gb,
430                       fs->c.bytestream_start + fs->ac_byte_count,
431                       (fs->c.bytestream_end - fs->c.bytestream_start - fs->ac_byte_count) * 8);
432     }
433
434     av_assert1(width && height);
435     if (f->colorspace == 0) {
436         const int chroma_width  = FF_CEIL_RSHIFT(width,  f->chroma_h_shift);
437         const int chroma_height = FF_CEIL_RSHIFT(height, f->chroma_v_shift);
438         const int cx            = x >> f->chroma_h_shift;
439         const int cy            = y >> f->chroma_v_shift;
440         decode_plane(fs, p->data[0] + ps*x + y*p->linesize[0], width, height, p->linesize[0], 0);
441
442         if (f->chroma_planes) {
443             decode_plane(fs, p->data[1] + ps*cx+cy*p->linesize[1], chroma_width, chroma_height, p->linesize[1], 1);
444             decode_plane(fs, p->data[2] + ps*cx+cy*p->linesize[2], chroma_width, chroma_height, p->linesize[2], 1);
445         }
446         if (fs->transparency)
447             decode_plane(fs, p->data[3] + ps*x + y*p->linesize[3], width, height, p->linesize[3], (f->version >= 4 && !f->chroma_planes) ? 1 : 2);
448     } else {
449         uint8_t *planes[3] = { p->data[0] + ps * x + y * p->linesize[0],
450                                p->data[1] + ps * x + y * p->linesize[1],
451                                p->data[2] + ps * x + y * p->linesize[2] };
452         decode_rgb_frame(fs, planes, width, height, p->linesize);
453     }
454     if (fs->ac && f->version > 2) {
455         int v;
456         get_rac(&fs->c, (uint8_t[]) { 129 });
457         v = fs->c.bytestream_end - fs->c.bytestream - 2 - 5*f->ec;
458         if (v) {
459             av_log(f->avctx, AV_LOG_ERROR, "bytestream end mismatching by %d\n", v);
460             fs->slice_damaged = 1;
461         }
462     }
463
464     emms_c();
465
466     ff_thread_report_progress(&f->picture, si, 0);
467
468     return 0;
469 }
470
471 static int read_quant_table(RangeCoder *c, int16_t *quant_table, int scale)
472 {
473     int v;
474     int i = 0;
475     uint8_t state[CONTEXT_SIZE];
476
477     memset(state, 128, sizeof(state));
478
479     for (v = 0; i < 128; v++) {
480         unsigned len = get_symbol(c, state, 0) + 1;
481
482         if (len > 128 - i || !len)
483             return AVERROR_INVALIDDATA;
484
485         while (len--) {
486             quant_table[i] = scale * v;
487             i++;
488         }
489     }
490
491     for (i = 1; i < 128; i++)
492         quant_table[256 - i] = -quant_table[i];
493     quant_table[128] = -quant_table[127];
494
495     return 2 * v - 1;
496 }
497
498 static int read_quant_tables(RangeCoder *c,
499                              int16_t quant_table[MAX_CONTEXT_INPUTS][256])
500 {
501     int i;
502     int context_count = 1;
503
504     for (i = 0; i < 5; i++) {
505         int ret = read_quant_table(c, quant_table[i], context_count);
506         if (ret < 0)
507             return ret;
508         context_count *= ret;
509         if (context_count > 32768U) {
510             return AVERROR_INVALIDDATA;
511         }
512     }
513     return (context_count + 1) / 2;
514 }
515
516 static int read_extra_header(FFV1Context *f)
517 {
518     RangeCoder *const c = &f->c;
519     uint8_t state[CONTEXT_SIZE];
520     int i, j, k, ret;
521     uint8_t state2[32][CONTEXT_SIZE];
522     unsigned crc = 0;
523
524     memset(state2, 128, sizeof(state2));
525     memset(state, 128, sizeof(state));
526
527     ff_init_range_decoder(c, f->avctx->extradata, f->avctx->extradata_size);
528     ff_build_rac_states(c, 0.05 * (1LL << 32), 256 - 8);
529
530     f->version = get_symbol(c, state, 0);
531     if (f->version < 2) {
532         av_log(f->avctx, AV_LOG_ERROR, "Invalid version in global header\n");
533         return AVERROR_INVALIDDATA;
534     }
535     if (f->version > 2) {
536         c->bytestream_end -= 4;
537         f->micro_version = get_symbol(c, state, 0);
538         if (f->micro_version < 0)
539             return AVERROR_INVALIDDATA;
540     }
541     f->ac = f->avctx->coder_type = get_symbol(c, state, 0);
542     if (f->ac > 1) {
543         for (i = 1; i < 256; i++)
544             f->state_transition[i] = get_symbol(c, state, 1) + c->one_state[i];
545     }
546
547     f->colorspace                 = get_symbol(c, state, 0); //YUV cs type
548     f->avctx->bits_per_raw_sample = get_symbol(c, state, 0);
549     f->chroma_planes              = get_rac(c, state);
550     f->chroma_h_shift             = get_symbol(c, state, 0);
551     f->chroma_v_shift             = get_symbol(c, state, 0);
552     f->transparency               = get_rac(c, state);
553     f->plane_count                = 1 + (f->chroma_planes || f->version<4) + f->transparency;
554     f->num_h_slices               = 1 + get_symbol(c, state, 0);
555     f->num_v_slices               = 1 + get_symbol(c, state, 0);
556
557     if (f->chroma_h_shift > 4U || f->chroma_v_shift > 4U) {
558         av_log(f->avctx, AV_LOG_ERROR, "chroma shift parameters %d %d are invalid\n",
559                f->chroma_h_shift, f->chroma_v_shift);
560         return AVERROR_INVALIDDATA;
561     }
562
563     if (f->num_h_slices > (unsigned)f->width  || !f->num_h_slices ||
564         f->num_v_slices > (unsigned)f->height || !f->num_v_slices
565        ) {
566         av_log(f->avctx, AV_LOG_ERROR, "slice count invalid\n");
567         return AVERROR_INVALIDDATA;
568     }
569
570     f->quant_table_count = get_symbol(c, state, 0);
571     if (f->quant_table_count > (unsigned)MAX_QUANT_TABLES)
572         return AVERROR_INVALIDDATA;
573
574     for (i = 0; i < f->quant_table_count; i++) {
575         f->context_count[i] = read_quant_tables(c, f->quant_tables[i]);
576         if (f->context_count[i] < 0) {
577             av_log(f->avctx, AV_LOG_ERROR, "read_quant_table error\n");
578             return AVERROR_INVALIDDATA;
579         }
580     }
581     if ((ret = ff_ffv1_allocate_initial_states(f)) < 0)
582         return ret;
583
584     for (i = 0; i < f->quant_table_count; i++)
585         if (get_rac(c, state)) {
586             for (j = 0; j < f->context_count[i]; j++)
587                 for (k = 0; k < CONTEXT_SIZE; k++) {
588                     int pred = j ? f->initial_states[i][j - 1][k] : 128;
589                     f->initial_states[i][j][k] =
590                         (pred + get_symbol(c, state2[k], 1)) & 0xFF;
591                 }
592         }
593
594     if (f->version > 2) {
595         f->ec = get_symbol(c, state, 0);
596         if (f->micro_version > 2)
597             f->intra = get_symbol(c, state, 0);
598     }
599
600     if (f->version > 2) {
601         unsigned v;
602         v = av_crc(av_crc_get_table(AV_CRC_32_IEEE), 0,
603                    f->avctx->extradata, f->avctx->extradata_size);
604         if (v || f->avctx->extradata_size < 4) {
605             av_log(f->avctx, AV_LOG_ERROR, "CRC mismatch %X!\n", v);
606             return AVERROR_INVALIDDATA;
607         }
608         crc = AV_RB32(f->avctx->extradata + f->avctx->extradata_size - 4);
609     }
610
611     if (f->avctx->debug & FF_DEBUG_PICT_INFO)
612         av_log(f->avctx, AV_LOG_DEBUG,
613                "global: ver:%d.%d, coder:%d, colorspace: %d bpr:%d chroma:%d(%d:%d), alpha:%d slices:%dx%d qtabs:%d ec:%d intra:%d CRC:0x%08X\n",
614                f->version, f->micro_version,
615                f->ac,
616                f->colorspace,
617                f->avctx->bits_per_raw_sample,
618                f->chroma_planes, f->chroma_h_shift, f->chroma_v_shift,
619                f->transparency,
620                f->num_h_slices, f->num_v_slices,
621                f->quant_table_count,
622                f->ec,
623                f->intra,
624                crc
625               );
626     return 0;
627 }
628
629 static int read_header(FFV1Context *f)
630 {
631     uint8_t state[CONTEXT_SIZE];
632     int i, j, context_count = -1; //-1 to avoid warning
633     RangeCoder *const c = &f->slice_context[0]->c;
634
635     memset(state, 128, sizeof(state));
636
637     if (f->version < 2) {
638         int chroma_planes, chroma_h_shift, chroma_v_shift, transparency, colorspace, bits_per_raw_sample;
639         unsigned v= get_symbol(c, state, 0);
640         if (v >= 2) {
641             av_log(f->avctx, AV_LOG_ERROR, "invalid version %d in ver01 header\n", v);
642             return AVERROR_INVALIDDATA;
643         }
644         f->version = v;
645         f->ac      = f->avctx->coder_type = get_symbol(c, state, 0);
646         if (f->ac > 1) {
647             for (i = 1; i < 256; i++)
648                 f->state_transition[i] = get_symbol(c, state, 1) + c->one_state[i];
649         }
650
651         colorspace          = get_symbol(c, state, 0); //YUV cs type
652         bits_per_raw_sample = f->version > 0 ? get_symbol(c, state, 0) : f->avctx->bits_per_raw_sample;
653         chroma_planes       = get_rac(c, state);
654         chroma_h_shift      = get_symbol(c, state, 0);
655         chroma_v_shift      = get_symbol(c, state, 0);
656         transparency        = get_rac(c, state);
657         if (colorspace == 0 && f->avctx->skip_alpha)
658             transparency = 0;
659
660         if (f->plane_count) {
661             if (colorspace          != f->colorspace                 ||
662                 bits_per_raw_sample != f->avctx->bits_per_raw_sample ||
663                 chroma_planes       != f->chroma_planes              ||
664                 chroma_h_shift      != f->chroma_h_shift             ||
665                 chroma_v_shift      != f->chroma_v_shift             ||
666                 transparency        != f->transparency) {
667                 av_log(f->avctx, AV_LOG_ERROR, "Invalid change of global parameters\n");
668                 return AVERROR_INVALIDDATA;
669             }
670         }
671
672         if (chroma_h_shift > 4U || chroma_v_shift > 4U) {
673             av_log(f->avctx, AV_LOG_ERROR, "chroma shift parameters %d %d are invalid\n",
674                    chroma_h_shift, chroma_v_shift);
675             return AVERROR_INVALIDDATA;
676         }
677
678         f->colorspace                 = colorspace;
679         f->avctx->bits_per_raw_sample = bits_per_raw_sample;
680         f->chroma_planes              = chroma_planes;
681         f->chroma_h_shift             = chroma_h_shift;
682         f->chroma_v_shift             = chroma_v_shift;
683         f->transparency               = transparency;
684
685         f->plane_count    = 2 + f->transparency;
686     }
687
688     if (f->colorspace == 0) {
689         if (!f->transparency && !f->chroma_planes) {
690             if (f->avctx->bits_per_raw_sample <= 8)
691                 f->avctx->pix_fmt = AV_PIX_FMT_GRAY8;
692             else
693                 f->avctx->pix_fmt = AV_PIX_FMT_GRAY16;
694         } else if (f->avctx->bits_per_raw_sample<=8 && !f->transparency) {
695             switch(16 * f->chroma_h_shift + f->chroma_v_shift) {
696             case 0x00: f->avctx->pix_fmt = AV_PIX_FMT_YUV444P; break;
697             case 0x01: f->avctx->pix_fmt = AV_PIX_FMT_YUV440P; break;
698             case 0x10: f->avctx->pix_fmt = AV_PIX_FMT_YUV422P; break;
699             case 0x11: f->avctx->pix_fmt = AV_PIX_FMT_YUV420P; break;
700             case 0x20: f->avctx->pix_fmt = AV_PIX_FMT_YUV411P; break;
701             case 0x22: f->avctx->pix_fmt = AV_PIX_FMT_YUV410P; break;
702             }
703         } else if (f->avctx->bits_per_raw_sample <= 8 && f->transparency) {
704             switch(16*f->chroma_h_shift + f->chroma_v_shift) {
705             case 0x00: f->avctx->pix_fmt = AV_PIX_FMT_YUVA444P; break;
706             case 0x10: f->avctx->pix_fmt = AV_PIX_FMT_YUVA422P; break;
707             case 0x11: f->avctx->pix_fmt = AV_PIX_FMT_YUVA420P; break;
708             }
709         } else if (f->avctx->bits_per_raw_sample == 9 && !f->transparency) {
710             f->packed_at_lsb = 1;
711             switch(16 * f->chroma_h_shift + f->chroma_v_shift) {
712             case 0x00: f->avctx->pix_fmt = AV_PIX_FMT_YUV444P9; break;
713             case 0x10: f->avctx->pix_fmt = AV_PIX_FMT_YUV422P9; break;
714             case 0x11: f->avctx->pix_fmt = AV_PIX_FMT_YUV420P9; break;
715             }
716         } else if (f->avctx->bits_per_raw_sample == 9 && f->transparency) {
717             f->packed_at_lsb = 1;
718             switch(16 * f->chroma_h_shift + f->chroma_v_shift) {
719             case 0x00: f->avctx->pix_fmt = AV_PIX_FMT_YUVA444P9; break;
720             case 0x10: f->avctx->pix_fmt = AV_PIX_FMT_YUVA422P9; break;
721             case 0x11: f->avctx->pix_fmt = AV_PIX_FMT_YUVA420P9; break;
722             }
723         } else if (f->avctx->bits_per_raw_sample == 10 && !f->transparency) {
724             f->packed_at_lsb = 1;
725             switch(16 * f->chroma_h_shift + f->chroma_v_shift) {
726             case 0x00: f->avctx->pix_fmt = AV_PIX_FMT_YUV444P10; break;
727             case 0x10: f->avctx->pix_fmt = AV_PIX_FMT_YUV422P10; break;
728             case 0x11: f->avctx->pix_fmt = AV_PIX_FMT_YUV420P10; break;
729             }
730         } else if (f->avctx->bits_per_raw_sample == 10 && f->transparency) {
731             f->packed_at_lsb = 1;
732             switch(16 * f->chroma_h_shift + f->chroma_v_shift) {
733             case 0x00: f->avctx->pix_fmt = AV_PIX_FMT_YUVA444P10; break;
734             case 0x10: f->avctx->pix_fmt = AV_PIX_FMT_YUVA422P10; break;
735             case 0x11: f->avctx->pix_fmt = AV_PIX_FMT_YUVA420P10; break;
736             }
737         } else if (f->avctx->bits_per_raw_sample == 16 && !f->transparency){
738             switch(16 * f->chroma_h_shift + f->chroma_v_shift) {
739             case 0x00: f->avctx->pix_fmt = AV_PIX_FMT_YUV444P16; break;
740             case 0x10: f->avctx->pix_fmt = AV_PIX_FMT_YUV422P16; break;
741             case 0x11: f->avctx->pix_fmt = AV_PIX_FMT_YUV420P16; break;
742             }
743         } else if (f->avctx->bits_per_raw_sample == 16 && f->transparency){
744             switch(16 * f->chroma_h_shift + f->chroma_v_shift) {
745             case 0x00: f->avctx->pix_fmt = AV_PIX_FMT_YUVA444P16; break;
746             case 0x10: f->avctx->pix_fmt = AV_PIX_FMT_YUVA422P16; break;
747             case 0x11: f->avctx->pix_fmt = AV_PIX_FMT_YUVA420P16; break;
748             }
749         }
750     } else if (f->colorspace == 1) {
751         if (f->chroma_h_shift || f->chroma_v_shift) {
752             av_log(f->avctx, AV_LOG_ERROR,
753                    "chroma subsampling not supported in this colorspace\n");
754             return AVERROR(ENOSYS);
755         }
756         if (     f->avctx->bits_per_raw_sample ==  9)
757             f->avctx->pix_fmt = AV_PIX_FMT_GBRP9;
758         else if (f->avctx->bits_per_raw_sample == 10)
759             f->avctx->pix_fmt = AV_PIX_FMT_GBRP10;
760         else if (f->avctx->bits_per_raw_sample == 12)
761             f->avctx->pix_fmt = AV_PIX_FMT_GBRP12;
762         else if (f->avctx->bits_per_raw_sample == 14)
763             f->avctx->pix_fmt = AV_PIX_FMT_GBRP14;
764         else
765         if (f->transparency) f->avctx->pix_fmt = AV_PIX_FMT_RGB32;
766         else                 f->avctx->pix_fmt = AV_PIX_FMT_0RGB32;
767     } else {
768         av_log(f->avctx, AV_LOG_ERROR, "colorspace not supported\n");
769         return AVERROR(ENOSYS);
770     }
771     if (f->avctx->pix_fmt == AV_PIX_FMT_NONE) {
772         av_log(f->avctx, AV_LOG_ERROR, "format not supported\n");
773         return AVERROR(ENOSYS);
774     }
775
776     ff_dlog(f->avctx, "%d %d %d\n",
777             f->chroma_h_shift, f->chroma_v_shift, f->avctx->pix_fmt);
778     if (f->version < 2) {
779         context_count = read_quant_tables(c, f->quant_table);
780         if (context_count < 0) {
781             av_log(f->avctx, AV_LOG_ERROR, "read_quant_table error\n");
782             return AVERROR_INVALIDDATA;
783         }
784         f->slice_count = f->max_slice_count;
785     } else if (f->version < 3) {
786         f->slice_count = get_symbol(c, state, 0);
787     } else {
788         const uint8_t *p = c->bytestream_end;
789         for (f->slice_count = 0;
790              f->slice_count < MAX_SLICES && 3 < p - c->bytestream_start;
791              f->slice_count++) {
792             int trailer = 3 + 5*!!f->ec;
793             int size = AV_RB24(p-trailer);
794             if (size + trailer > p - c->bytestream_start)
795                 break;
796             p -= size + trailer;
797         }
798     }
799     if (f->slice_count > (unsigned)MAX_SLICES || f->slice_count <= 0 || f->slice_count > f->max_slice_count) {
800         av_log(f->avctx, AV_LOG_ERROR, "slice count %d is invalid (max=%d)\n", f->slice_count, f->max_slice_count);
801         return AVERROR_INVALIDDATA;
802     }
803
804     for (j = 0; j < f->slice_count; j++) {
805         FFV1Context *fs = f->slice_context[j];
806         fs->ac            = f->ac;
807         fs->packed_at_lsb = f->packed_at_lsb;
808
809         fs->slice_damaged = 0;
810
811         if (f->version == 2) {
812             fs->slice_x      =  get_symbol(c, state, 0)      * f->width ;
813             fs->slice_y      =  get_symbol(c, state, 0)      * f->height;
814             fs->slice_width  = (get_symbol(c, state, 0) + 1) * f->width  + fs->slice_x;
815             fs->slice_height = (get_symbol(c, state, 0) + 1) * f->height + fs->slice_y;
816
817             fs->slice_x     /= f->num_h_slices;
818             fs->slice_y     /= f->num_v_slices;
819             fs->slice_width  = fs->slice_width  / f->num_h_slices - fs->slice_x;
820             fs->slice_height = fs->slice_height / f->num_v_slices - fs->slice_y;
821             if ((unsigned)fs->slice_width  > f->width ||
822                 (unsigned)fs->slice_height > f->height)
823                 return AVERROR_INVALIDDATA;
824             if (   (unsigned)fs->slice_x + (uint64_t)fs->slice_width  > f->width
825                 || (unsigned)fs->slice_y + (uint64_t)fs->slice_height > f->height)
826                 return AVERROR_INVALIDDATA;
827         }
828
829         for (i = 0; i < f->plane_count; i++) {
830             PlaneContext *const p = &fs->plane[i];
831
832             if (f->version == 2) {
833                 int idx = get_symbol(c, state, 0);
834                 if (idx > (unsigned)f->quant_table_count) {
835                     av_log(f->avctx, AV_LOG_ERROR,
836                            "quant_table_index out of range\n");
837                     return AVERROR_INVALIDDATA;
838                 }
839                 p->quant_table_index = idx;
840                 memcpy(p->quant_table, f->quant_tables[idx],
841                        sizeof(p->quant_table));
842                 context_count = f->context_count[idx];
843             } else {
844                 memcpy(p->quant_table, f->quant_table, sizeof(p->quant_table));
845             }
846
847             if (f->version <= 2) {
848                 av_assert0(context_count >= 0);
849                 if (p->context_count < context_count) {
850                     av_freep(&p->state);
851                     av_freep(&p->vlc_state);
852                 }
853                 p->context_count = context_count;
854             }
855         }
856     }
857     return 0;
858 }
859
860 static av_cold int decode_init(AVCodecContext *avctx)
861 {
862     FFV1Context *f = avctx->priv_data;
863     int ret;
864
865     if ((ret = ff_ffv1_common_init(avctx)) < 0)
866         return ret;
867
868     if (avctx->extradata && (ret = read_extra_header(f)) < 0)
869         return ret;
870
871     if ((ret = ff_ffv1_init_slice_contexts(f)) < 0)
872         return ret;
873
874     avctx->internal->allocate_progress = 1;
875
876     return 0;
877 }
878
879 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
880 {
881     uint8_t *buf        = avpkt->data;
882     int buf_size        = avpkt->size;
883     FFV1Context *f      = avctx->priv_data;
884     RangeCoder *const c = &f->slice_context[0]->c;
885     int i, ret;
886     uint8_t keystate = 128;
887     uint8_t *buf_p;
888     AVFrame *p;
889
890     if (f->last_picture.f)
891         ff_thread_release_buffer(avctx, &f->last_picture);
892     FFSWAP(ThreadFrame, f->picture, f->last_picture);
893
894     f->cur = p = f->picture.f;
895
896     if (f->version < 3 && avctx->field_order > AV_FIELD_PROGRESSIVE) {
897         /* we have interlaced material flagged in container */
898         p->interlaced_frame = 1;
899         if (avctx->field_order == AV_FIELD_TT || avctx->field_order == AV_FIELD_TB)
900             p->top_field_first = 1;
901     }
902
903     f->avctx = avctx;
904     ff_init_range_decoder(c, buf, buf_size);
905     ff_build_rac_states(c, 0.05 * (1LL << 32), 256 - 8);
906
907     p->pict_type = AV_PICTURE_TYPE_I; //FIXME I vs. P
908     if (get_rac(c, &keystate)) {
909         p->key_frame    = 1;
910         f->key_frame_ok = 0;
911         if ((ret = read_header(f)) < 0)
912             return ret;
913         f->key_frame_ok = 1;
914     } else {
915         if (!f->key_frame_ok) {
916             av_log(avctx, AV_LOG_ERROR,
917                    "Cannot decode non-keyframe without valid keyframe\n");
918             return AVERROR_INVALIDDATA;
919         }
920         p->key_frame = 0;
921     }
922
923     if ((ret = ff_thread_get_buffer(avctx, &f->picture, AV_GET_BUFFER_FLAG_REF)) < 0)
924         return ret;
925
926     if (avctx->debug & FF_DEBUG_PICT_INFO)
927         av_log(avctx, AV_LOG_DEBUG, "ver:%d keyframe:%d coder:%d ec:%d slices:%d bps:%d\n",
928                f->version, p->key_frame, f->ac, f->ec, f->slice_count, f->avctx->bits_per_raw_sample);
929
930     ff_thread_finish_setup(avctx);
931
932     buf_p = buf + buf_size;
933     for (i = f->slice_count - 1; i >= 0; i--) {
934         FFV1Context *fs = f->slice_context[i];
935         int trailer = 3 + 5*!!f->ec;
936         int v;
937
938         if (i || f->version > 2) v = AV_RB24(buf_p-trailer) + trailer;
939         else                     v = buf_p - c->bytestream_start;
940         if (buf_p - c->bytestream_start < v) {
941             av_log(avctx, AV_LOG_ERROR, "Slice pointer chain broken\n");
942             return AVERROR_INVALIDDATA;
943         }
944         buf_p -= v;
945
946         if (f->ec) {
947             unsigned crc = av_crc(av_crc_get_table(AV_CRC_32_IEEE), 0, buf_p, v);
948             if (crc) {
949                 int64_t ts = avpkt->pts != AV_NOPTS_VALUE ? avpkt->pts : avpkt->dts;
950                 av_log(f->avctx, AV_LOG_ERROR, "CRC mismatch %X!", crc);
951                 if (ts != AV_NOPTS_VALUE && avctx->pkt_timebase.num) {
952                     av_log(f->avctx, AV_LOG_ERROR, "at %f seconds\n", ts*av_q2d(avctx->pkt_timebase));
953                 } else if (ts != AV_NOPTS_VALUE) {
954                     av_log(f->avctx, AV_LOG_ERROR, "at %"PRId64"\n", ts);
955                 } else {
956                     av_log(f->avctx, AV_LOG_ERROR, "\n");
957                 }
958                 fs->slice_damaged = 1;
959             }
960             if (avctx->debug & FF_DEBUG_PICT_INFO) {
961                 av_log(avctx, AV_LOG_DEBUG, "slice %d, CRC: 0x%08X\n", i, AV_RB32(buf_p + v - 4));
962             }
963         }
964
965         if (i) {
966             ff_init_range_decoder(&fs->c, buf_p, v);
967         } else
968             fs->c.bytestream_end = buf_p + v;
969
970         fs->avctx = avctx;
971         fs->cur = p;
972     }
973
974     avctx->execute(avctx,
975                    decode_slice,
976                    &f->slice_context[0],
977                    NULL,
978                    f->slice_count,
979                    sizeof(void*));
980
981     for (i = f->slice_count - 1; i >= 0; i--) {
982         FFV1Context *fs = f->slice_context[i];
983         int j;
984         if (fs->slice_damaged && f->last_picture.f->data[0]) {
985             const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(avctx->pix_fmt);
986             const uint8_t *src[4];
987             uint8_t *dst[4];
988             ff_thread_await_progress(&f->last_picture, INT_MAX, 0);
989             for (j = 0; j < 4; j++) {
990                 int pixshift = desc->comp[j].depth > 8;
991                 int sh = (j == 1 || j == 2) ? f->chroma_h_shift : 0;
992                 int sv = (j == 1 || j == 2) ? f->chroma_v_shift : 0;
993                 dst[j] = p->data[j] + p->linesize[j] *
994                          (fs->slice_y >> sv) + ((fs->slice_x >> sh) << pixshift);
995                 src[j] = f->last_picture.f->data[j] + f->last_picture.f->linesize[j] *
996                          (fs->slice_y >> sv) + ((fs->slice_x >> sh) << pixshift);
997             }
998             av_image_copy(dst, p->linesize, src,
999                           f->last_picture.f->linesize,
1000                           avctx->pix_fmt,
1001                           fs->slice_width,
1002                           fs->slice_height);
1003         }
1004     }
1005     ff_thread_report_progress(&f->picture, INT_MAX, 0);
1006
1007     f->picture_number++;
1008
1009     if (f->last_picture.f)
1010         ff_thread_release_buffer(avctx, &f->last_picture);
1011     f->cur = NULL;
1012     if ((ret = av_frame_ref(data, f->picture.f)) < 0)
1013         return ret;
1014
1015     *got_frame = 1;
1016
1017     return buf_size;
1018 }
1019
1020 static int init_thread_copy(AVCodecContext *avctx)
1021 {
1022     FFV1Context *f = avctx->priv_data;
1023     int i, ret;
1024
1025     f->picture.f      = NULL;
1026     f->last_picture.f = NULL;
1027     f->sample_buffer  = NULL;
1028     f->max_slice_count = 0;
1029     f->slice_count = 0;
1030
1031     for (i = 0; i < f->quant_table_count; i++) {
1032         av_assert0(f->version > 1);
1033         f->initial_states[i] = av_memdup(f->initial_states[i],
1034                                          f->context_count[i] * sizeof(*f->initial_states[i]));
1035     }
1036
1037     f->picture.f      = av_frame_alloc();
1038     f->last_picture.f = av_frame_alloc();
1039
1040     if ((ret = ff_ffv1_init_slice_contexts(f)) < 0)
1041         return ret;
1042
1043     return 0;
1044 }
1045
1046 static void copy_fields(FFV1Context *fsdst, FFV1Context *fssrc, FFV1Context *fsrc)
1047 {
1048     fsdst->version             = fsrc->version;
1049     fsdst->micro_version       = fsrc->micro_version;
1050     fsdst->chroma_planes       = fsrc->chroma_planes;
1051     fsdst->chroma_h_shift      = fsrc->chroma_h_shift;
1052     fsdst->chroma_v_shift      = fsrc->chroma_v_shift;
1053     fsdst->transparency        = fsrc->transparency;
1054     fsdst->plane_count         = fsrc->plane_count;
1055     fsdst->ac                  = fsrc->ac;
1056     fsdst->colorspace          = fsrc->colorspace;
1057
1058     fsdst->ec                  = fsrc->ec;
1059     fsdst->intra               = fsrc->intra;
1060     fsdst->slice_damaged       = fssrc->slice_damaged;
1061     fsdst->key_frame_ok        = fsrc->key_frame_ok;
1062
1063     fsdst->bits_per_raw_sample = fsrc->bits_per_raw_sample;
1064     fsdst->packed_at_lsb       = fsrc->packed_at_lsb;
1065     fsdst->slice_count         = fsrc->slice_count;
1066     if (fsrc->version<3){
1067         fsdst->slice_x             = fssrc->slice_x;
1068         fsdst->slice_y             = fssrc->slice_y;
1069         fsdst->slice_width         = fssrc->slice_width;
1070         fsdst->slice_height        = fssrc->slice_height;
1071     }
1072 }
1073
1074 static int update_thread_context(AVCodecContext *dst, const AVCodecContext *src)
1075 {
1076     FFV1Context *fsrc = src->priv_data;
1077     FFV1Context *fdst = dst->priv_data;
1078     int i, ret;
1079
1080     if (dst == src)
1081         return 0;
1082
1083     {
1084         ThreadFrame picture = fdst->picture, last_picture = fdst->last_picture;
1085         uint8_t (*initial_states[MAX_QUANT_TABLES])[32];
1086         struct FFV1Context *slice_context[MAX_SLICES];
1087         memcpy(initial_states, fdst->initial_states, sizeof(fdst->initial_states));
1088         memcpy(slice_context,  fdst->slice_context , sizeof(fdst->slice_context));
1089
1090         memcpy(fdst, fsrc, sizeof(*fdst));
1091         memcpy(fdst->initial_states, initial_states, sizeof(fdst->initial_states));
1092         memcpy(fdst->slice_context,  slice_context , sizeof(fdst->slice_context));
1093         fdst->picture      = picture;
1094         fdst->last_picture = last_picture;
1095         for (i = 0; i<fdst->num_h_slices * fdst->num_v_slices; i++) {
1096             FFV1Context *fssrc = fsrc->slice_context[i];
1097             FFV1Context *fsdst = fdst->slice_context[i];
1098             copy_fields(fsdst, fssrc, fsrc);
1099         }
1100         av_assert0(!fdst->plane[0].state);
1101         av_assert0(!fdst->sample_buffer);
1102     }
1103
1104     av_assert1(fdst->max_slice_count == fsrc->max_slice_count);
1105
1106
1107     ff_thread_release_buffer(dst, &fdst->picture);
1108     if (fsrc->picture.f->data[0]) {
1109         if ((ret = ff_thread_ref_frame(&fdst->picture, &fsrc->picture)) < 0)
1110             return ret;
1111     }
1112
1113     fdst->fsrc = fsrc;
1114
1115     return 0;
1116 }
1117
1118 AVCodec ff_ffv1_decoder = {
1119     .name           = "ffv1",
1120     .long_name      = NULL_IF_CONFIG_SMALL("FFmpeg video codec #1"),
1121     .type           = AVMEDIA_TYPE_VIDEO,
1122     .id             = AV_CODEC_ID_FFV1,
1123     .priv_data_size = sizeof(FFV1Context),
1124     .init           = decode_init,
1125     .close          = ff_ffv1_close,
1126     .decode         = decode_frame,
1127     .init_thread_copy = ONLY_IF_THREADS_ENABLED(init_thread_copy),
1128     .update_thread_context = ONLY_IF_THREADS_ENABLED(update_thread_context),
1129     .capabilities   = AV_CODEC_CAP_DR1 /*| AV_CODEC_CAP_DRAW_HORIZ_BAND*/ |
1130                       AV_CODEC_CAP_FRAME_THREADS | AV_CODEC_CAP_SLICE_THREADS,
1131 };