434d561c0ea24f9c8b60be31237f8d0dcb612b26
[ffmpeg.git] / libavcodec / h264.c
1 /*
2  * H.26L/H.264/AVC/JVT/14496-10/... decoder
3  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
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  * H.264 / AVC / MPEG4 part10 codec.
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #include "libavutil/avassert.h"
29 #include "libavutil/display.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/stereo3d.h"
33 #include "libavutil/timer.h"
34 #include "internal.h"
35 #include "bytestream.h"
36 #include "cabac.h"
37 #include "cabac_functions.h"
38 #include "error_resilience.h"
39 #include "avcodec.h"
40 #include "h264.h"
41 #include "h2645_parse.h"
42 #include "h264data.h"
43 #include "h264chroma.h"
44 #include "h264_mvpred.h"
45 #include "golomb.h"
46 #include "mathops.h"
47 #include "me_cmp.h"
48 #include "mpegutils.h"
49 #include "profiles.h"
50 #include "rectangle.h"
51 #include "thread.h"
52
53 #include <assert.h>
54
55 const uint16_t ff_h264_mb_sizes[4] = { 256, 384, 512, 768 };
56
57 static void h264_er_decode_mb(void *opaque, int ref, int mv_dir, int mv_type,
58                               int (*mv)[2][4][2],
59                               int mb_x, int mb_y, int mb_intra, int mb_skipped)
60 {
61     H264Context *h = opaque;
62     H264SliceContext *sl = &h->slice_ctx[0];
63
64     sl->mb_x = mb_x;
65     sl->mb_y = mb_y;
66     sl->mb_xy = mb_x + mb_y * h->mb_stride;
67     memset(sl->non_zero_count_cache, 0, sizeof(sl->non_zero_count_cache));
68     assert(ref >= 0);
69     /* FIXME: It is possible albeit uncommon that slice references
70      * differ between slices. We take the easy approach and ignore
71      * it for now. If this turns out to have any relevance in
72      * practice then correct remapping should be added. */
73     if (ref >= sl->ref_count[0])
74         ref = 0;
75     fill_rectangle(&h->cur_pic.ref_index[0][4 * sl->mb_xy],
76                    2, 2, 2, ref, 1);
77     fill_rectangle(&sl->ref_cache[0][scan8[0]], 4, 4, 8, ref, 1);
78     fill_rectangle(sl->mv_cache[0][scan8[0]], 4, 4, 8,
79                    pack16to32((*mv)[0][0][0], (*mv)[0][0][1]), 4);
80     assert(!FRAME_MBAFF(h));
81     ff_h264_hl_decode_mb(h, &h->slice_ctx[0]);
82 }
83
84 void ff_h264_draw_horiz_band(const H264Context *h, H264SliceContext *sl,
85                              int y, int height)
86 {
87     AVCodecContext *avctx = h->avctx;
88     const AVFrame   *src  = h->cur_pic.f;
89     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(avctx->pix_fmt);
90     int vshift = desc->log2_chroma_h;
91     const int field_pic = h->picture_structure != PICT_FRAME;
92     if (field_pic) {
93         height <<= 1;
94         y      <<= 1;
95     }
96
97     height = FFMIN(height, avctx->height - y);
98
99     if (field_pic && h->first_field && !(avctx->slice_flags & SLICE_FLAG_ALLOW_FIELD))
100         return;
101
102     if (avctx->draw_horiz_band) {
103         int offset[AV_NUM_DATA_POINTERS];
104         int i;
105
106         offset[0] = y * src->linesize[0];
107         offset[1] =
108         offset[2] = (y >> vshift) * src->linesize[1];
109         for (i = 3; i < AV_NUM_DATA_POINTERS; i++)
110             offset[i] = 0;
111
112         emms_c();
113
114         avctx->draw_horiz_band(avctx, src, offset,
115                                y, h->picture_structure, height);
116     }
117 }
118
119 void ff_h264_free_tables(H264Context *h)
120 {
121     int i;
122
123     av_freep(&h->intra4x4_pred_mode);
124     av_freep(&h->chroma_pred_mode_table);
125     av_freep(&h->cbp_table);
126     av_freep(&h->mvd_table[0]);
127     av_freep(&h->mvd_table[1]);
128     av_freep(&h->direct_table);
129     av_freep(&h->non_zero_count);
130     av_freep(&h->slice_table_base);
131     h->slice_table = NULL;
132     av_freep(&h->list_counts);
133
134     av_freep(&h->mb2b_xy);
135     av_freep(&h->mb2br_xy);
136
137     av_buffer_pool_uninit(&h->qscale_table_pool);
138     av_buffer_pool_uninit(&h->mb_type_pool);
139     av_buffer_pool_uninit(&h->motion_val_pool);
140     av_buffer_pool_uninit(&h->ref_index_pool);
141
142     for (i = 0; i < h->nb_slice_ctx; i++) {
143         H264SliceContext *sl = &h->slice_ctx[i];
144
145         av_freep(&sl->dc_val_base);
146         av_freep(&sl->er.mb_index2xy);
147         av_freep(&sl->er.error_status_table);
148         av_freep(&sl->er.er_temp_buffer);
149
150         av_freep(&sl->bipred_scratchpad);
151         av_freep(&sl->edge_emu_buffer);
152         av_freep(&sl->top_borders[0]);
153         av_freep(&sl->top_borders[1]);
154
155         sl->bipred_scratchpad_allocated = 0;
156         sl->edge_emu_buffer_allocated   = 0;
157         sl->top_borders_allocated[0]    = 0;
158         sl->top_borders_allocated[1]    = 0;
159     }
160 }
161
162 int ff_h264_alloc_tables(H264Context *h)
163 {
164     const int big_mb_num = h->mb_stride * (h->mb_height + 1);
165     const int row_mb_num = h->mb_stride * 2 * h->avctx->thread_count;
166     int x, y;
167
168     FF_ALLOCZ_OR_GOTO(h->avctx, h->intra4x4_pred_mode,
169                       row_mb_num * 8 * sizeof(uint8_t), fail)
170     h->slice_ctx[0].intra4x4_pred_mode = h->intra4x4_pred_mode;
171
172     FF_ALLOCZ_OR_GOTO(h->avctx, h->non_zero_count,
173                       big_mb_num * 48 * sizeof(uint8_t), fail)
174     FF_ALLOCZ_OR_GOTO(h->avctx, h->slice_table_base,
175                       (big_mb_num + h->mb_stride) * sizeof(*h->slice_table_base), fail)
176     FF_ALLOCZ_OR_GOTO(h->avctx, h->cbp_table,
177                       big_mb_num * sizeof(uint16_t), fail)
178     FF_ALLOCZ_OR_GOTO(h->avctx, h->chroma_pred_mode_table,
179                       big_mb_num * sizeof(uint8_t), fail)
180     FF_ALLOCZ_OR_GOTO(h->avctx, h->mvd_table[0],
181                       16 * row_mb_num * sizeof(uint8_t), fail);
182     FF_ALLOCZ_OR_GOTO(h->avctx, h->mvd_table[1],
183                       16 * row_mb_num * sizeof(uint8_t), fail);
184     h->slice_ctx[0].mvd_table[0] = h->mvd_table[0];
185     h->slice_ctx[0].mvd_table[1] = h->mvd_table[1];
186
187     FF_ALLOCZ_OR_GOTO(h->avctx, h->direct_table,
188                       4 * big_mb_num * sizeof(uint8_t), fail);
189     FF_ALLOCZ_OR_GOTO(h->avctx, h->list_counts,
190                       big_mb_num * sizeof(uint8_t), fail)
191
192     memset(h->slice_table_base, -1,
193            (big_mb_num + h->mb_stride) * sizeof(*h->slice_table_base));
194     h->slice_table = h->slice_table_base + h->mb_stride * 2 + 1;
195
196     FF_ALLOCZ_OR_GOTO(h->avctx, h->mb2b_xy,
197                       big_mb_num * sizeof(uint32_t), fail);
198     FF_ALLOCZ_OR_GOTO(h->avctx, h->mb2br_xy,
199                       big_mb_num * sizeof(uint32_t), fail);
200     for (y = 0; y < h->mb_height; y++)
201         for (x = 0; x < h->mb_width; x++) {
202             const int mb_xy = x + y * h->mb_stride;
203             const int b_xy  = 4 * x + 4 * y * h->b_stride;
204
205             h->mb2b_xy[mb_xy]  = b_xy;
206             h->mb2br_xy[mb_xy] = 8 * (FMO ? mb_xy : (mb_xy % (2 * h->mb_stride)));
207         }
208
209     return 0;
210
211 fail:
212     ff_h264_free_tables(h);
213     return AVERROR(ENOMEM);
214 }
215
216 /**
217  * Init context
218  * Allocate buffers which are not shared amongst multiple threads.
219  */
220 int ff_h264_slice_context_init(H264Context *h, H264SliceContext *sl)
221 {
222     ERContext *er = &sl->er;
223     int mb_array_size = h->mb_height * h->mb_stride;
224     int y_size  = (2 * h->mb_width + 1) * (2 * h->mb_height + 1);
225     int c_size  = h->mb_stride * (h->mb_height + 1);
226     int yc_size = y_size + 2   * c_size;
227     int x, y, i;
228
229     sl->ref_cache[0][scan8[5]  + 1] =
230     sl->ref_cache[0][scan8[7]  + 1] =
231     sl->ref_cache[0][scan8[13] + 1] =
232     sl->ref_cache[1][scan8[5]  + 1] =
233     sl->ref_cache[1][scan8[7]  + 1] =
234     sl->ref_cache[1][scan8[13] + 1] = PART_NOT_AVAILABLE;
235
236     if (CONFIG_ERROR_RESILIENCE) {
237         /* init ER */
238         er->avctx          = h->avctx;
239         er->decode_mb      = h264_er_decode_mb;
240         er->opaque         = h;
241         er->quarter_sample = 1;
242
243         er->mb_num      = h->mb_num;
244         er->mb_width    = h->mb_width;
245         er->mb_height   = h->mb_height;
246         er->mb_stride   = h->mb_stride;
247         er->b8_stride   = h->mb_width * 2 + 1;
248
249         // error resilience code looks cleaner with this
250         FF_ALLOCZ_OR_GOTO(h->avctx, er->mb_index2xy,
251                           (h->mb_num + 1) * sizeof(int), fail);
252
253         for (y = 0; y < h->mb_height; y++)
254             for (x = 0; x < h->mb_width; x++)
255                 er->mb_index2xy[x + y * h->mb_width] = x + y * h->mb_stride;
256
257         er->mb_index2xy[h->mb_height * h->mb_width] = (h->mb_height - 1) *
258                                                       h->mb_stride + h->mb_width;
259
260         FF_ALLOCZ_OR_GOTO(h->avctx, er->error_status_table,
261                           mb_array_size * sizeof(uint8_t), fail);
262
263         FF_ALLOC_OR_GOTO(h->avctx, er->er_temp_buffer,
264                          h->mb_height * h->mb_stride, fail);
265
266         FF_ALLOCZ_OR_GOTO(h->avctx, sl->dc_val_base,
267                           yc_size * sizeof(int16_t), fail);
268         er->dc_val[0] = sl->dc_val_base + h->mb_width * 2 + 2;
269         er->dc_val[1] = sl->dc_val_base + y_size + h->mb_stride + 1;
270         er->dc_val[2] = er->dc_val[1] + c_size;
271         for (i = 0; i < yc_size; i++)
272             sl->dc_val_base[i] = 1024;
273     }
274
275     return 0;
276
277 fail:
278     return AVERROR(ENOMEM); // ff_h264_free_tables will clean up for us
279 }
280
281 static int h264_init_context(AVCodecContext *avctx, H264Context *h)
282 {
283     int i;
284
285     h->avctx                 = avctx;
286
287     h->picture_structure     = PICT_FRAME;
288     h->slice_context_count   = 1;
289     h->workaround_bugs       = avctx->workaround_bugs;
290     h->flags                 = avctx->flags;
291     h->poc.prev_poc_msb      = 1 << 16;
292     h->recovery_frame        = -1;
293     h->frame_recovered       = 0;
294
295     h->next_outputed_poc = INT_MIN;
296     for (i = 0; i < MAX_DELAYED_PIC_COUNT; i++)
297         h->last_pocs[i] = INT_MIN;
298
299     ff_h264_sei_uninit(&h->sei);
300
301     avctx->chroma_sample_location = AVCHROMA_LOC_LEFT;
302
303     h->nb_slice_ctx = (avctx->active_thread_type & FF_THREAD_SLICE) ?  H264_MAX_THREADS : 1;
304     h->slice_ctx = av_mallocz_array(h->nb_slice_ctx, sizeof(*h->slice_ctx));
305     if (!h->slice_ctx) {
306         h->nb_slice_ctx = 0;
307         return AVERROR(ENOMEM);
308     }
309
310     for (i = 0; i < H264_MAX_PICTURE_COUNT; i++) {
311         h->DPB[i].f = av_frame_alloc();
312         if (!h->DPB[i].f)
313             return AVERROR(ENOMEM);
314     }
315
316     h->cur_pic.f = av_frame_alloc();
317     if (!h->cur_pic.f)
318         return AVERROR(ENOMEM);
319
320     for (i = 0; i < h->nb_slice_ctx; i++)
321         h->slice_ctx[i].h264 = h;
322
323     return 0;
324 }
325
326 static AVOnce h264_vlc_init = AV_ONCE_INIT;
327
328 av_cold int ff_h264_decode_init(AVCodecContext *avctx)
329 {
330     H264Context *h = avctx->priv_data;
331     int ret;
332
333     ret = h264_init_context(avctx, h);
334     if (ret < 0)
335         return ret;
336
337     /* set defaults */
338     if (!avctx->has_b_frames)
339         h->low_delay = 1;
340
341     ret = ff_thread_once(&h264_vlc_init, ff_h264_decode_init_vlc);
342     if (ret != 0) {
343         av_log(avctx, AV_LOG_ERROR, "pthread_once has failed.");
344         return AVERROR_UNKNOWN;
345     }
346
347     if (avctx->codec_id == AV_CODEC_ID_H264) {
348         if (avctx->ticks_per_frame == 1)
349             h->avctx->framerate.num *= 2;
350         avctx->ticks_per_frame = 2;
351     }
352
353     if (avctx->extradata_size > 0 && avctx->extradata) {
354        ret = ff_h264_decode_extradata(avctx->extradata, avctx->extradata_size,
355                                       &h->ps, &h->is_avc, &h->nal_length_size,
356                                       avctx->err_recognition, avctx);
357        if (ret < 0) {
358            ff_h264_free_context(h);
359            return ret;
360        }
361     }
362
363     if (h->ps.sps && h->ps.sps->bitstream_restriction_flag &&
364         h->avctx->has_b_frames < h->ps.sps->num_reorder_frames) {
365         h->avctx->has_b_frames = h->ps.sps->num_reorder_frames;
366         h->low_delay           = 0;
367     }
368
369     avctx->internal->allocate_progress = 1;
370
371     if (h->enable_er) {
372         av_log(avctx, AV_LOG_WARNING,
373                "Error resilience is enabled. It is unsafe and unsupported and may crash. "
374                "Use it at your own risk\n");
375     }
376
377     return 0;
378 }
379
380 static int decode_init_thread_copy(AVCodecContext *avctx)
381 {
382     H264Context *h = avctx->priv_data;
383     int ret;
384
385     if (!avctx->internal->is_copy)
386         return 0;
387
388     memset(h, 0, sizeof(*h));
389
390     ret = h264_init_context(avctx, h);
391     if (ret < 0)
392         return ret;
393
394     h->context_initialized = 0;
395
396     return 0;
397 }
398
399 /**
400  * Run setup operations that must be run after slice header decoding.
401  * This includes finding the next displayed frame.
402  *
403  * @param h h264 master context
404  * @param setup_finished enough NALs have been read that we can call
405  * ff_thread_finish_setup()
406  */
407 static void decode_postinit(H264Context *h, int setup_finished)
408 {
409     const SPS *sps = h->ps.sps;
410     H264Picture *out = h->cur_pic_ptr;
411     H264Picture *cur = h->cur_pic_ptr;
412     int i, pics, out_of_order, out_idx;
413     int invalid = 0, cnt = 0;
414
415     h->cur_pic_ptr->f->pict_type = h->pict_type;
416
417     if (h->next_output_pic)
418         return;
419
420     if (cur->field_poc[0] == INT_MAX || cur->field_poc[1] == INT_MAX) {
421         /* FIXME: if we have two PAFF fields in one packet, we can't start
422          * the next thread here. If we have one field per packet, we can.
423          * The check in decode_nal_units() is not good enough to find this
424          * yet, so we assume the worst for now. */
425         // if (setup_finished)
426         //    ff_thread_finish_setup(h->avctx);
427         return;
428     }
429
430     cur->f->interlaced_frame = 0;
431     cur->f->repeat_pict      = 0;
432
433     /* Signal interlacing information externally. */
434     /* Prioritize picture timing SEI information over used
435      * decoding process if it exists. */
436
437     if (sps->pic_struct_present_flag) {
438         H264SEIPictureTiming *pt = &h->sei.picture_timing;
439         switch (pt->pic_struct) {
440         case SEI_PIC_STRUCT_FRAME:
441             break;
442         case SEI_PIC_STRUCT_TOP_FIELD:
443         case SEI_PIC_STRUCT_BOTTOM_FIELD:
444             cur->f->interlaced_frame = 1;
445             break;
446         case SEI_PIC_STRUCT_TOP_BOTTOM:
447         case SEI_PIC_STRUCT_BOTTOM_TOP:
448             if (FIELD_OR_MBAFF_PICTURE(h))
449                 cur->f->interlaced_frame = 1;
450             else
451                 // try to flag soft telecine progressive
452                 cur->f->interlaced_frame = h->prev_interlaced_frame;
453             break;
454         case SEI_PIC_STRUCT_TOP_BOTTOM_TOP:
455         case SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM:
456             /* Signal the possibility of telecined film externally
457              * (pic_struct 5,6). From these hints, let the applications
458              * decide if they apply deinterlacing. */
459             cur->f->repeat_pict = 1;
460             break;
461         case SEI_PIC_STRUCT_FRAME_DOUBLING:
462             cur->f->repeat_pict = 2;
463             break;
464         case SEI_PIC_STRUCT_FRAME_TRIPLING:
465             cur->f->repeat_pict = 4;
466             break;
467         }
468
469         if ((pt->ct_type & 3) &&
470             pt->pic_struct <= SEI_PIC_STRUCT_BOTTOM_TOP)
471             cur->f->interlaced_frame = (pt->ct_type & (1 << 1)) != 0;
472     } else {
473         /* Derive interlacing flag from used decoding process. */
474         cur->f->interlaced_frame = FIELD_OR_MBAFF_PICTURE(h);
475     }
476     h->prev_interlaced_frame = cur->f->interlaced_frame;
477
478     if (cur->field_poc[0] != cur->field_poc[1]) {
479         /* Derive top_field_first from field pocs. */
480         cur->f->top_field_first = cur->field_poc[0] < cur->field_poc[1];
481     } else {
482         if (cur->f->interlaced_frame || sps->pic_struct_present_flag) {
483             /* Use picture timing SEI information. Even if it is a
484              * information of a past frame, better than nothing. */
485             if (h->sei.picture_timing.pic_struct == SEI_PIC_STRUCT_TOP_BOTTOM ||
486                 h->sei.picture_timing.pic_struct == SEI_PIC_STRUCT_TOP_BOTTOM_TOP)
487                 cur->f->top_field_first = 1;
488             else
489                 cur->f->top_field_first = 0;
490         } else {
491             /* Most likely progressive */
492             cur->f->top_field_first = 0;
493         }
494     }
495
496     if (h->sei.frame_packing.present &&
497         h->sei.frame_packing.arrangement_type >= 0 &&
498         h->sei.frame_packing.arrangement_type <= 6 &&
499         h->sei.frame_packing.content_interpretation_type > 0 &&
500         h->sei.frame_packing.content_interpretation_type < 3) {
501         H264SEIFramePacking *fp = &h->sei.frame_packing;
502         AVStereo3D *stereo = av_stereo3d_create_side_data(cur->f);
503         if (!stereo)
504             return;
505
506         switch (fp->arrangement_type) {
507         case 0:
508             stereo->type = AV_STEREO3D_CHECKERBOARD;
509             break;
510         case 1:
511             stereo->type = AV_STEREO3D_COLUMNS;
512             break;
513         case 2:
514             stereo->type = AV_STEREO3D_LINES;
515             break;
516         case 3:
517             if (fp->quincunx_subsampling)
518                 stereo->type = AV_STEREO3D_SIDEBYSIDE_QUINCUNX;
519             else
520                 stereo->type = AV_STEREO3D_SIDEBYSIDE;
521             break;
522         case 4:
523             stereo->type = AV_STEREO3D_TOPBOTTOM;
524             break;
525         case 5:
526             stereo->type = AV_STEREO3D_FRAMESEQUENCE;
527             break;
528         case 6:
529             stereo->type = AV_STEREO3D_2D;
530             break;
531         }
532
533         if (fp->content_interpretation_type == 2)
534             stereo->flags = AV_STEREO3D_FLAG_INVERT;
535     }
536
537     if (h->sei.display_orientation.present &&
538         (h->sei.display_orientation.anticlockwise_rotation ||
539          h->sei.display_orientation.hflip ||
540          h->sei.display_orientation.vflip)) {
541         H264SEIDisplayOrientation *o = &h->sei.display_orientation;
542         double angle = o->anticlockwise_rotation * 360 / (double) (1 << 16);
543         AVFrameSideData *rotation = av_frame_new_side_data(cur->f,
544                                                            AV_FRAME_DATA_DISPLAYMATRIX,
545                                                            sizeof(int32_t) * 9);
546         if (!rotation)
547             return;
548
549         av_display_rotation_set((int32_t *)rotation->data, angle);
550         av_display_matrix_flip((int32_t *)rotation->data,
551                                o->hflip, o->vflip);
552     }
553
554     if (h->sei.afd.present) {
555         AVFrameSideData *sd = av_frame_new_side_data(cur->f, AV_FRAME_DATA_AFD,
556                                                      sizeof(uint8_t));
557         if (!sd)
558             return;
559
560         *sd->data = h->sei.afd.active_format_description;
561         h->sei.afd.present = 0;
562     }
563
564     if (h->sei.a53_caption.a53_caption) {
565         H264SEIA53Caption *a53 = &h->sei.a53_caption;
566         AVFrameSideData *sd = av_frame_new_side_data(cur->f,
567                                                      AV_FRAME_DATA_A53_CC,
568                                                      a53->a53_caption_size);
569         if (!sd)
570             return;
571
572         memcpy(sd->data, a53->a53_caption, a53->a53_caption_size);
573         av_freep(&a53->a53_caption);
574         a53->a53_caption_size = 0;
575     }
576
577     // FIXME do something with unavailable reference frames
578
579     /* Sort B-frames into display order */
580     if (sps->bitstream_restriction_flag ||
581         h->avctx->strict_std_compliance >= FF_COMPLIANCE_NORMAL) {
582         h->avctx->has_b_frames = FFMAX(h->avctx->has_b_frames, sps->num_reorder_frames);
583     }
584     h->low_delay = !h->avctx->has_b_frames;
585
586     pics = 0;
587     while (h->delayed_pic[pics])
588         pics++;
589
590     assert(pics <= MAX_DELAYED_PIC_COUNT);
591
592     h->delayed_pic[pics++] = cur;
593     if (cur->reference == 0)
594         cur->reference = DELAYED_PIC_REF;
595
596     /* Frame reordering. This code takes pictures from coding order and sorts
597      * them by their incremental POC value into display order. It supports POC
598      * gaps, MMCO reset codes and random resets.
599      * A "display group" can start either with a IDR frame (f.key_frame = 1),
600      * and/or can be closed down with a MMCO reset code. In sequences where
601      * there is no delay, we can't detect that (since the frame was already
602      * output to the user), so we also set h->mmco_reset to detect the MMCO
603      * reset code.
604      * FIXME: if we detect insufficient delays (as per h->avctx->has_b_frames),
605      * we increase the delay between input and output. All frames affected by
606      * the lag (e.g. those that should have been output before another frame
607      * that we already returned to the user) will be dropped. This is a bug
608      * that we will fix later. */
609     for (i = 0; i < MAX_DELAYED_PIC_COUNT; i++) {
610         cnt     += out->poc < h->last_pocs[i];
611         invalid += out->poc == INT_MIN;
612     }
613     if (!h->mmco_reset && !cur->f->key_frame &&
614         cnt + invalid == MAX_DELAYED_PIC_COUNT && cnt > 0) {
615         h->mmco_reset = 2;
616         if (pics > 1)
617             h->delayed_pic[pics - 2]->mmco_reset = 2;
618     }
619     if (h->mmco_reset || cur->f->key_frame) {
620         for (i = 0; i < MAX_DELAYED_PIC_COUNT; i++)
621             h->last_pocs[i] = INT_MIN;
622         cnt     = 0;
623         invalid = MAX_DELAYED_PIC_COUNT;
624     }
625     out     = h->delayed_pic[0];
626     out_idx = 0;
627     for (i = 1; i < MAX_DELAYED_PIC_COUNT &&
628                 h->delayed_pic[i] &&
629                 !h->delayed_pic[i - 1]->mmco_reset &&
630                 !h->delayed_pic[i]->f->key_frame;
631          i++)
632         if (h->delayed_pic[i]->poc < out->poc) {
633             out     = h->delayed_pic[i];
634             out_idx = i;
635         }
636     if (h->avctx->has_b_frames == 0 &&
637         (h->delayed_pic[0]->f->key_frame || h->mmco_reset))
638         h->next_outputed_poc = INT_MIN;
639     out_of_order = !out->f->key_frame && !h->mmco_reset &&
640                    (out->poc < h->next_outputed_poc);
641
642     if (sps->bitstream_restriction_flag &&
643         h->avctx->has_b_frames >= sps->num_reorder_frames) {
644     } else if (out_of_order && pics - 1 == h->avctx->has_b_frames &&
645                h->avctx->has_b_frames < MAX_DELAYED_PIC_COUNT) {
646         if (invalid + cnt < MAX_DELAYED_PIC_COUNT) {
647             h->avctx->has_b_frames = FFMAX(h->avctx->has_b_frames, cnt);
648         }
649         h->low_delay = 0;
650     } else if (h->low_delay &&
651                ((h->next_outputed_poc != INT_MIN &&
652                  out->poc > h->next_outputed_poc + 2) ||
653                 cur->f->pict_type == AV_PICTURE_TYPE_B)) {
654         h->low_delay = 0;
655         h->avctx->has_b_frames++;
656     }
657
658     if (pics > h->avctx->has_b_frames) {
659         out->reference &= ~DELAYED_PIC_REF;
660         for (i = out_idx; h->delayed_pic[i]; i++)
661             h->delayed_pic[i] = h->delayed_pic[i + 1];
662     }
663     memmove(h->last_pocs, &h->last_pocs[1],
664             sizeof(*h->last_pocs) * (MAX_DELAYED_PIC_COUNT - 1));
665     h->last_pocs[MAX_DELAYED_PIC_COUNT - 1] = cur->poc;
666     if (!out_of_order && pics > h->avctx->has_b_frames) {
667         h->next_output_pic = out;
668         if (out->mmco_reset) {
669             if (out_idx > 0) {
670                 h->next_outputed_poc                    = out->poc;
671                 h->delayed_pic[out_idx - 1]->mmco_reset = out->mmco_reset;
672             } else {
673                 h->next_outputed_poc = INT_MIN;
674             }
675         } else {
676             if (out_idx == 0 && pics > 1 && h->delayed_pic[0]->f->key_frame) {
677                 h->next_outputed_poc = INT_MIN;
678             } else {
679                 h->next_outputed_poc = out->poc;
680             }
681         }
682         h->mmco_reset = 0;
683     } else {
684         av_log(h->avctx, AV_LOG_DEBUG, "no picture\n");
685     }
686
687     if (h->next_output_pic) {
688         if (h->next_output_pic->recovered) {
689             // We have reached an recovery point and all frames after it in
690             // display order are "recovered".
691             h->frame_recovered |= FRAME_RECOVERED_SEI;
692         }
693         h->next_output_pic->recovered |= !!(h->frame_recovered & FRAME_RECOVERED_SEI);
694     }
695
696     if (setup_finished && !h->avctx->hwaccel) {
697         ff_thread_finish_setup(h->avctx);
698
699         if (h->avctx->active_thread_type & FF_THREAD_FRAME)
700             h->setup_finished = 1;
701     }
702 }
703
704 /**
705  * instantaneous decoder refresh.
706  */
707 static void idr(H264Context *h)
708 {
709     ff_h264_remove_all_refs(h);
710     h->poc.prev_frame_num        =
711     h->poc.prev_frame_num_offset =
712     h->poc.prev_poc_msb          =
713     h->poc.prev_poc_lsb          = 0;
714 }
715
716 /* forget old pics after a seek */
717 void ff_h264_flush_change(H264Context *h)
718 {
719     int i;
720     for (i = 0; i < MAX_DELAYED_PIC_COUNT; i++)
721         h->last_pocs[i] = INT_MIN;
722     h->next_outputed_poc = INT_MIN;
723     h->prev_interlaced_frame = 1;
724     idr(h);
725     if (h->cur_pic_ptr)
726         h->cur_pic_ptr->reference = 0;
727     h->first_field = 0;
728     ff_h264_sei_uninit(&h->sei);
729     h->recovery_frame = -1;
730     h->frame_recovered = 0;
731 }
732
733 /* forget old pics after a seek */
734 static void flush_dpb(AVCodecContext *avctx)
735 {
736     H264Context *h = avctx->priv_data;
737     int i;
738
739     memset(h->delayed_pic, 0, sizeof(h->delayed_pic));
740
741     ff_h264_flush_change(h);
742
743     for (i = 0; i < H264_MAX_PICTURE_COUNT; i++)
744         ff_h264_unref_picture(h, &h->DPB[i]);
745     h->cur_pic_ptr = NULL;
746     ff_h264_unref_picture(h, &h->cur_pic);
747
748     h->mb_y = 0;
749
750     ff_h264_free_tables(h);
751     h->context_initialized = 0;
752 }
753
754 static int get_last_needed_nal(H264Context *h)
755 {
756     int nals_needed = 0;
757     int i;
758
759     for (i = 0; i < h->pkt.nb_nals; i++) {
760         H2645NAL *nal = &h->pkt.nals[i];
761         GetBitContext gb;
762
763         /* packets can sometimes contain multiple PPS/SPS,
764          * e.g. two PAFF field pictures in one packet, or a demuxer
765          * which splits NALs strangely if so, when frame threading we
766          * can't start the next thread until we've read all of them */
767         switch (nal->type) {
768         case NAL_SPS:
769         case NAL_PPS:
770             nals_needed = i;
771             break;
772         case NAL_DPA:
773         case NAL_IDR_SLICE:
774         case NAL_SLICE:
775             init_get_bits(&gb, nal->data + 1, (nal->size - 1) * 8);
776             if (!get_ue_golomb(&gb))
777                 nals_needed = i;
778         }
779     }
780
781     return nals_needed;
782 }
783
784 static int decode_nal_units(H264Context *h, const uint8_t *buf, int buf_size)
785 {
786     AVCodecContext *const avctx = h->avctx;
787     unsigned context_count = 0;
788     int nals_needed = 0; ///< number of NALs that need decoding before the next frame thread starts
789     int i, ret = 0;
790
791     h->max_contexts = h->slice_context_count;
792     if (!(avctx->flags2 & AV_CODEC_FLAG2_CHUNKS)) {
793         h->current_slice = 0;
794         if (!h->first_field)
795             h->cur_pic_ptr = NULL;
796         ff_h264_sei_uninit(&h->sei);
797     }
798
799     ret = ff_h2645_packet_split(&h->pkt, buf, buf_size, avctx, h->is_avc,
800                                 h->nal_length_size, avctx->codec_id);
801     if (ret < 0) {
802         av_log(avctx, AV_LOG_ERROR,
803                "Error splitting the input into NAL units.\n");
804         return ret;
805     }
806
807     if (avctx->active_thread_type & FF_THREAD_FRAME)
808         nals_needed = get_last_needed_nal(h);
809
810     for (i = 0; i < h->pkt.nb_nals; i++) {
811         H2645NAL *nal = &h->pkt.nals[i];
812         H264SliceContext *sl = &h->slice_ctx[context_count];
813         int err;
814
815         if (avctx->skip_frame >= AVDISCARD_NONREF &&
816             nal->ref_idc == 0 && nal->type != NAL_SEI)
817             continue;
818
819 again:
820         // FIXME these should stop being context-global variables
821         h->nal_ref_idc   = nal->ref_idc;
822         h->nal_unit_type = nal->type;
823
824         err = 0;
825         switch (nal->type) {
826         case NAL_IDR_SLICE:
827             if (nal->type != NAL_IDR_SLICE) {
828                 av_log(h->avctx, AV_LOG_ERROR,
829                        "Invalid mix of idr and non-idr slices\n");
830                 ret = -1;
831                 goto end;
832             }
833             idr(h); // FIXME ensure we don't lose some frames if there is reordering
834         case NAL_SLICE:
835             sl->gb = nal->gb;
836
837             if ((err = ff_h264_decode_slice_header(h, sl)))
838                 break;
839
840             if (h->sei.recovery_point.recovery_frame_cnt >= 0 && h->recovery_frame < 0) {
841                 h->recovery_frame = (h->poc.frame_num + h->sei.recovery_point.recovery_frame_cnt) &
842                                     ((1 << h->ps.sps->log2_max_frame_num) - 1);
843             }
844
845             h->cur_pic_ptr->f->key_frame |=
846                 (nal->type == NAL_IDR_SLICE) || (h->sei.recovery_point.recovery_frame_cnt >= 0);
847
848             if (nal->type == NAL_IDR_SLICE || h->recovery_frame == h->poc.frame_num) {
849                 h->recovery_frame         = -1;
850                 h->cur_pic_ptr->recovered = 1;
851             }
852             // If we have an IDR, all frames after it in decoded order are
853             // "recovered".
854             if (nal->type == NAL_IDR_SLICE)
855                 h->frame_recovered |= FRAME_RECOVERED_IDR;
856             h->cur_pic_ptr->recovered |= !!(h->frame_recovered & FRAME_RECOVERED_IDR);
857
858             if (h->current_slice == 1) {
859                 if (!(avctx->flags2 & AV_CODEC_FLAG2_CHUNKS))
860                     decode_postinit(h, i >= nals_needed);
861
862                 if (h->avctx->hwaccel &&
863                     (ret = h->avctx->hwaccel->start_frame(h->avctx, NULL, 0)) < 0)
864                     return ret;
865             }
866
867             if (sl->redundant_pic_count == 0 &&
868                 (avctx->skip_frame < AVDISCARD_NONREF || nal->ref_idc) &&
869                 (avctx->skip_frame < AVDISCARD_BIDIR  ||
870                  sl->slice_type_nos != AV_PICTURE_TYPE_B) &&
871                 (avctx->skip_frame < AVDISCARD_NONKEY ||
872                  h->cur_pic_ptr->f->key_frame) &&
873                 avctx->skip_frame < AVDISCARD_ALL) {
874                 if (avctx->hwaccel) {
875                     ret = avctx->hwaccel->decode_slice(avctx, nal->raw_data, nal->raw_size);
876                     if (ret < 0)
877                         return ret;
878                 } else
879                     context_count++;
880             }
881             break;
882         case NAL_DPA:
883         case NAL_DPB:
884         case NAL_DPC:
885             avpriv_request_sample(avctx, "data partitioning");
886             ret = AVERROR(ENOSYS);
887             goto end;
888             break;
889         case NAL_SEI:
890             ret = ff_h264_sei_decode(&h->sei, &nal->gb, &h->ps, avctx);
891             if (ret < 0 && (h->avctx->err_recognition & AV_EF_EXPLODE))
892                 goto end;
893             break;
894         case NAL_SPS:
895             ret = ff_h264_decode_seq_parameter_set(&nal->gb, avctx, &h->ps);
896             if (ret < 0 && (h->avctx->err_recognition & AV_EF_EXPLODE))
897                 goto end;
898             break;
899         case NAL_PPS:
900             ret = ff_h264_decode_picture_parameter_set(&nal->gb, avctx, &h->ps,
901                                                        nal->size_bits);
902             if (ret < 0 && (h->avctx->err_recognition & AV_EF_EXPLODE))
903                 goto end;
904             break;
905         case NAL_AUD:
906         case NAL_END_SEQUENCE:
907         case NAL_END_STREAM:
908         case NAL_FILLER_DATA:
909         case NAL_SPS_EXT:
910         case NAL_AUXILIARY_SLICE:
911             break;
912         case NAL_FF_IGNORE:
913             break;
914         default:
915             av_log(avctx, AV_LOG_DEBUG, "Unknown NAL code: %d (%d bits)\n",
916                    nal->type, nal->size_bits);
917         }
918
919         if (context_count == h->max_contexts) {
920             ret = ff_h264_execute_decode_slices(h, context_count);
921             if (ret < 0 && (h->avctx->err_recognition & AV_EF_EXPLODE))
922                 goto end;
923             context_count = 0;
924         }
925
926         if (err < 0) {
927             av_log(h->avctx, AV_LOG_ERROR, "decode_slice_header error\n");
928             sl->ref_count[0] = sl->ref_count[1] = sl->list_count = 0;
929         } else if (err == 1) {
930             /* Slice could not be decoded in parallel mode, restart. Note
931              * that rbsp_buffer is not transferred, but since we no longer
932              * run in parallel mode this should not be an issue. */
933             sl               = &h->slice_ctx[0];
934             goto again;
935         }
936     }
937     if (context_count) {
938         ret = ff_h264_execute_decode_slices(h, context_count);
939         if (ret < 0 && (h->avctx->err_recognition & AV_EF_EXPLODE))
940             goto end;
941     }
942
943     ret = 0;
944 end:
945     /* clean up */
946     if (h->cur_pic_ptr && !h->droppable) {
947         ff_thread_report_progress(&h->cur_pic_ptr->tf, INT_MAX,
948                                   h->picture_structure == PICT_BOTTOM_FIELD);
949     }
950
951     return (ret < 0) ? ret : buf_size;
952 }
953
954 /**
955  * Return the number of bytes consumed for building the current frame.
956  */
957 static int get_consumed_bytes(int pos, int buf_size)
958 {
959     if (pos == 0)
960         pos = 1;        // avoid infinite loops (I doubt that is needed but...)
961     if (pos + 10 > buf_size)
962         pos = buf_size; // oops ;)
963
964     return pos;
965 }
966
967 static int output_frame(H264Context *h, AVFrame *dst, AVFrame *src)
968 {
969     int i;
970     int ret = av_frame_ref(dst, src);
971     if (ret < 0)
972         return ret;
973
974     if (!h->ps.sps || !h->ps.sps->crop)
975         return 0;
976
977     for (i = 0; i < 3; i++) {
978         int hshift = (i > 0) ? h->chroma_x_shift : 0;
979         int vshift = (i > 0) ? h->chroma_y_shift : 0;
980         int off    = ((h->ps.sps->crop_left >> hshift) << h->pixel_shift) +
981                      (h->ps.sps->crop_top >> vshift) * dst->linesize[i];
982         dst->data[i] += off;
983     }
984     return 0;
985 }
986
987 static int h264_decode_frame(AVCodecContext *avctx, void *data,
988                              int *got_frame, AVPacket *avpkt)
989 {
990     const uint8_t *buf = avpkt->data;
991     int buf_size       = avpkt->size;
992     H264Context *h     = avctx->priv_data;
993     AVFrame *pict      = data;
994     int buf_index      = 0;
995     int ret;
996
997     h->flags = avctx->flags;
998     h->setup_finished = 0;
999
1000     /* end of stream, output what is still in the buffers */
1001 out:
1002     if (buf_size == 0) {
1003         H264Picture *out;
1004         int i, out_idx;
1005
1006         h->cur_pic_ptr = NULL;
1007
1008         // FIXME factorize this with the output code below
1009         out     = h->delayed_pic[0];
1010         out_idx = 0;
1011         for (i = 1;
1012              h->delayed_pic[i] &&
1013              !h->delayed_pic[i]->f->key_frame &&
1014              !h->delayed_pic[i]->mmco_reset;
1015              i++)
1016             if (h->delayed_pic[i]->poc < out->poc) {
1017                 out     = h->delayed_pic[i];
1018                 out_idx = i;
1019             }
1020
1021         for (i = out_idx; h->delayed_pic[i]; i++)
1022             h->delayed_pic[i] = h->delayed_pic[i + 1];
1023
1024         if (out) {
1025             ret = output_frame(h, pict, out->f);
1026             if (ret < 0)
1027                 return ret;
1028             *got_frame = 1;
1029         }
1030
1031         return buf_index;
1032     }
1033
1034     buf_index = decode_nal_units(h, buf, buf_size);
1035     if (buf_index < 0)
1036         return AVERROR_INVALIDDATA;
1037
1038     if (!h->cur_pic_ptr && h->nal_unit_type == NAL_END_SEQUENCE) {
1039         buf_size = 0;
1040         goto out;
1041     }
1042
1043     if (!(avctx->flags2 & AV_CODEC_FLAG2_CHUNKS) && !h->cur_pic_ptr) {
1044         if (avctx->skip_frame >= AVDISCARD_NONREF)
1045             return 0;
1046         av_log(avctx, AV_LOG_ERROR, "no frame!\n");
1047         return AVERROR_INVALIDDATA;
1048     }
1049
1050     if (!(avctx->flags2 & AV_CODEC_FLAG2_CHUNKS) ||
1051         (h->mb_y >= h->mb_height && h->mb_height)) {
1052         if (avctx->flags2 & AV_CODEC_FLAG2_CHUNKS)
1053             decode_postinit(h, 1);
1054
1055         ff_h264_field_end(h, &h->slice_ctx[0], 0);
1056
1057         *got_frame = 0;
1058         if (h->next_output_pic && ((avctx->flags & AV_CODEC_FLAG_OUTPUT_CORRUPT) ||
1059                                    h->next_output_pic->recovered)) {
1060             if (!h->next_output_pic->recovered)
1061                 h->next_output_pic->f->flags |= AV_FRAME_FLAG_CORRUPT;
1062
1063             ret = output_frame(h, pict, h->next_output_pic->f);
1064             if (ret < 0)
1065                 return ret;
1066             *got_frame = 1;
1067         }
1068     }
1069
1070     assert(pict->buf[0] || !*got_frame);
1071
1072     return get_consumed_bytes(buf_index, buf_size);
1073 }
1074
1075 av_cold void ff_h264_free_context(H264Context *h)
1076 {
1077     int i;
1078
1079     ff_h264_free_tables(h);
1080
1081     for (i = 0; i < H264_MAX_PICTURE_COUNT; i++) {
1082         ff_h264_unref_picture(h, &h->DPB[i]);
1083         av_frame_free(&h->DPB[i].f);
1084     }
1085
1086     h->cur_pic_ptr = NULL;
1087
1088     for (i = 0; i < h->nb_slice_ctx; i++)
1089         av_freep(&h->slice_ctx[i].rbsp_buffer);
1090     av_freep(&h->slice_ctx);
1091     h->nb_slice_ctx = 0;
1092
1093     for (i = 0; i < MAX_SPS_COUNT; i++)
1094         av_buffer_unref(&h->ps.sps_list[i]);
1095
1096     for (i = 0; i < MAX_PPS_COUNT; i++)
1097         av_buffer_unref(&h->ps.pps_list[i]);
1098
1099     ff_h2645_packet_uninit(&h->pkt);
1100 }
1101
1102 static av_cold int h264_decode_end(AVCodecContext *avctx)
1103 {
1104     H264Context *h = avctx->priv_data;
1105
1106     ff_h264_free_context(h);
1107
1108     ff_h264_unref_picture(h, &h->cur_pic);
1109     av_frame_free(&h->cur_pic.f);
1110
1111     return 0;
1112 }
1113
1114 #define OFFSET(x) offsetof(H264Context, x)
1115 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
1116 static const AVOption h264_options[] = {
1117     { "enable_er", "Enable error resilience on damaged frames (unsafe)", OFFSET(enable_er), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VD },
1118     { NULL },
1119 };
1120
1121 static const AVClass h264_class = {
1122     .class_name = "h264",
1123     .item_name  = av_default_item_name,
1124     .option     = h264_options,
1125     .version    = LIBAVUTIL_VERSION_INT,
1126 };
1127
1128 AVCodec ff_h264_decoder = {
1129     .name                  = "h264",
1130     .long_name             = NULL_IF_CONFIG_SMALL("H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
1131     .type                  = AVMEDIA_TYPE_VIDEO,
1132     .id                    = AV_CODEC_ID_H264,
1133     .priv_data_size        = sizeof(H264Context),
1134     .init                  = ff_h264_decode_init,
1135     .close                 = h264_decode_end,
1136     .decode                = h264_decode_frame,
1137     .capabilities          = /*AV_CODEC_CAP_DRAW_HORIZ_BAND |*/ AV_CODEC_CAP_DR1 |
1138                              AV_CODEC_CAP_DELAY | AV_CODEC_CAP_SLICE_THREADS |
1139                              AV_CODEC_CAP_FRAME_THREADS,
1140     .caps_internal         = FF_CODEC_CAP_INIT_THREADSAFE,
1141     .flush                 = flush_dpb,
1142     .init_thread_copy      = ONLY_IF_THREADS_ENABLED(decode_init_thread_copy),
1143     .update_thread_context = ONLY_IF_THREADS_ENABLED(ff_h264_update_thread_context),
1144     .profiles              = NULL_IF_CONFIG_SMALL(ff_h264_profiles),
1145     .priv_class            = &h264_class,
1146 };