h264: decouple h264_ps from the h264 decoder
[ffmpeg.git] / libavcodec / h264_parser.c
1 /*
2  * H.26L/H.264/AVC/JVT/14496-10/... parser
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 parser.
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #include <assert.h>
29 #include <stdint.h>
30
31 #include "libavutil/avutil.h"
32 #include "libavutil/error.h"
33 #include "libavutil/log.h"
34 #include "libavutil/mem.h"
35 #include "libavutil/pixfmt.h"
36
37 #include "get_bits.h"
38 #include "golomb.h"
39 #include "h264.h"
40 #include "h264data.h"
41 #include "internal.h"
42 #include "mpegutils.h"
43 #include "parser.h"
44
45 typedef struct H264ParseContext {
46     H264Context h;
47     ParseContext pc;
48     H264ParamSets ps;
49     int got_first;
50 } H264ParseContext;
51
52
53 static int h264_find_frame_end(H264ParseContext *p, const uint8_t *buf,
54                                int buf_size)
55 {
56     H264Context *h = &p->h;
57     int i;
58     uint32_t state;
59     ParseContext *pc = &p->pc;
60 //    mb_addr= pc->mb_addr - 1;
61     state = pc->state;
62     if (state > 13)
63         state = 7;
64
65     for (i = 0; i < buf_size; i++) {
66         if (state == 7) {
67             i += h->h264dsp.startcode_find_candidate(buf + i, buf_size - i);
68             if (i < buf_size)
69                 state = 2;
70         } else if (state <= 2) {
71             if (buf[i] == 1)
72                 state ^= 5;            // 2->7, 1->4, 0->5
73             else if (buf[i])
74                 state = 7;
75             else
76                 state >>= 1;           // 2->1, 1->0, 0->0
77         } else if (state <= 5) {
78             int nalu_type = buf[i] & 0x1F;
79             if (nalu_type == NAL_SEI || nalu_type == NAL_SPS ||
80                 nalu_type == NAL_PPS || nalu_type == NAL_AUD) {
81                 if (pc->frame_start_found) {
82                     i++;
83                     goto found;
84                 }
85             } else if (nalu_type == NAL_SLICE || nalu_type == NAL_DPA ||
86                        nalu_type == NAL_IDR_SLICE) {
87                 if (pc->frame_start_found) {
88                     state += 8;
89                     continue;
90                 } else
91                     pc->frame_start_found = 1;
92             }
93             state = 7;
94         } else {
95             // first_mb_in_slice is 0, probably the first nal of a new slice
96             if (buf[i] & 0x80)
97                 goto found;
98             state = 7;
99         }
100     }
101     pc->state = state;
102     return END_NOT_FOUND;
103
104 found:
105     pc->state             = 7;
106     pc->frame_start_found = 0;
107     return i - (state & 5);
108 }
109
110 static int scan_mmco_reset(AVCodecParserContext *s, GetBitContext *gb)
111 {
112     H264PredWeightTable pwt;
113     int slice_type_nos = s->pict_type & 3;
114     H264ParseContext *p = s->priv_data;
115     H264Context      *h = &p->h;
116     int list_count, ref_count[2];
117
118
119     if (p->ps.pps->redundant_pic_cnt_present)
120         get_ue_golomb(gb); // redundant_pic_count
121
122     if (slice_type_nos == AV_PICTURE_TYPE_B)
123         get_bits1(gb); // direct_spatial_mv_pred
124
125     if (ff_h264_parse_ref_count(&list_count, ref_count, gb, p->ps.pps,
126                                 slice_type_nos, h->picture_structure) < 0)
127         return AVERROR_INVALIDDATA;
128
129     if (slice_type_nos != AV_PICTURE_TYPE_I) {
130         int list;
131         for (list = 0; list < list_count; list++) {
132             if (get_bits1(gb)) {
133                 int index;
134                 for (index = 0; ; index++) {
135                     unsigned int reordering_of_pic_nums_idc = get_ue_golomb_31(gb);
136
137                     if (reordering_of_pic_nums_idc < 3)
138                         get_ue_golomb(gb);
139                     else if (reordering_of_pic_nums_idc > 3) {
140                         av_log(h->avctx, AV_LOG_ERROR,
141                                "illegal reordering_of_pic_nums_idc %d\n",
142                                reordering_of_pic_nums_idc);
143                         return AVERROR_INVALIDDATA;
144                     } else
145                         break;
146
147                     if (index >= ref_count[list]) {
148                         av_log(h->avctx, AV_LOG_ERROR,
149                                "reference count %d overflow\n", index);
150                         return AVERROR_INVALIDDATA;
151                     }
152                 }
153             }
154         }
155     }
156
157     if ((p->ps.pps->weighted_pred && slice_type_nos == AV_PICTURE_TYPE_P) ||
158         (p->ps.pps->weighted_bipred_idc == 1 && slice_type_nos == AV_PICTURE_TYPE_B))
159         ff_h264_pred_weight_table(gb, p->ps.sps, ref_count, slice_type_nos,
160                                   &pwt);
161
162     if (get_bits1(gb)) { // adaptive_ref_pic_marking_mode_flag
163         int i;
164         for (i = 0; i < MAX_MMCO_COUNT; i++) {
165             MMCOOpcode opcode = get_ue_golomb_31(gb);
166             if (opcode > (unsigned) MMCO_LONG) {
167                 av_log(h->avctx, AV_LOG_ERROR,
168                        "illegal memory management control operation %d\n",
169                        opcode);
170                 return AVERROR_INVALIDDATA;
171             }
172             if (opcode == MMCO_END)
173                return 0;
174             else if (opcode == MMCO_RESET)
175                 return 1;
176
177             if (opcode == MMCO_SHORT2UNUSED || opcode == MMCO_SHORT2LONG)
178                 get_ue_golomb(gb);
179             if (opcode == MMCO_SHORT2LONG || opcode == MMCO_LONG2UNUSED ||
180                 opcode == MMCO_LONG || opcode == MMCO_SET_MAX_LONG)
181                 get_ue_golomb_31(gb);
182         }
183     }
184
185     return 0;
186 }
187
188 /**
189  * Parse NAL units of found picture and decode some basic information.
190  *
191  * @param s parser context.
192  * @param avctx codec context.
193  * @param buf buffer with field/frame data.
194  * @param buf_size size of the buffer.
195  */
196 static inline int parse_nal_units(AVCodecParserContext *s,
197                                   AVCodecContext *avctx,
198                                   const uint8_t *buf, int buf_size)
199 {
200     H264ParseContext *p = s->priv_data;
201     H264Context      *h = &p->h;
202     const uint8_t *buf_end = buf + buf_size;
203
204     H2645NAL nal = { NULL };
205
206     unsigned int pps_id;
207     unsigned int slice_type;
208     int state = -1, got_reset = 0;
209     int field_poc[2];
210     int ret;
211
212     /* set some sane default values */
213     s->pict_type         = AV_PICTURE_TYPE_I;
214     s->key_frame         = 0;
215     s->picture_structure = AV_PICTURE_STRUCTURE_UNKNOWN;
216
217     h->avctx = avctx;
218     ff_h264_reset_sei(h);
219
220     if (!buf_size)
221         return 0;
222
223     for (;;) {
224         const SPS *sps;
225         int src_length, consumed;
226         buf = avpriv_find_start_code(buf, buf_end, &state);
227         if (buf >= buf_end)
228             break;
229         --buf;
230         src_length = buf_end - buf;
231         switch (state & 0x1f) {
232         case NAL_SLICE:
233         case NAL_IDR_SLICE:
234             // Do not walk the whole buffer just to decode slice header
235             if ((state & 0x1f) == NAL_IDR_SLICE || ((state >> 5) & 0x3) == 0) {
236                 /* IDR or disposable slice
237                  * No need to decode many bytes because MMCOs shall not be present. */
238                 if (src_length > 60)
239                     src_length = 60;
240             } else {
241                 /* To decode up to MMCOs */
242                 if (src_length > 1000)
243                     src_length = 1000;
244             }
245             break;
246         }
247
248         consumed = ff_h2645_extract_rbsp(buf, src_length, &nal);
249         if (consumed < 0)
250             break;
251
252         ret = init_get_bits(&nal.gb, nal.data, nal.size * 8);
253         if (ret < 0)
254             goto fail;
255         get_bits1(&nal.gb);
256         nal.ref_idc = get_bits(&nal.gb, 2);
257         nal.type    = get_bits(&nal.gb, 5);
258
259         h->gb            = nal.gb;
260         h->nal_ref_idc   = nal.ref_idc;
261         h->nal_unit_type = nal.type;
262
263         switch (h->nal_unit_type) {
264         case NAL_SPS:
265             ff_h264_decode_seq_parameter_set(&nal.gb, avctx, &p->ps);
266             break;
267         case NAL_PPS:
268             ff_h264_decode_picture_parameter_set(&nal.gb, avctx, &p->ps,
269                                                  nal.size_bits);
270             break;
271         case NAL_SEI:
272             ff_h264_decode_sei(h);
273             break;
274         case NAL_IDR_SLICE:
275             s->key_frame = 1;
276
277             h->prev_frame_num        = 0;
278             h->prev_frame_num_offset = 0;
279             h->prev_poc_msb          =
280             h->prev_poc_lsb          = 0;
281         /* fall through */
282         case NAL_SLICE:
283             get_ue_golomb(&nal.gb);  // skip first_mb_in_slice
284             slice_type   = get_ue_golomb_31(&nal.gb);
285             s->pict_type = ff_h264_golomb_to_pict_type[slice_type % 5];
286             if (h->sei_recovery_frame_cnt >= 0) {
287                 /* key frame, since recovery_frame_cnt is set */
288                 s->key_frame = 1;
289             }
290             pps_id = get_ue_golomb(&nal.gb);
291             if (pps_id >= MAX_PPS_COUNT) {
292                 av_log(h->avctx, AV_LOG_ERROR,
293                        "pps_id %u out of range\n", pps_id);
294                 goto fail;
295             }
296             if (!p->ps.pps_list[pps_id]) {
297                 av_log(h->avctx, AV_LOG_ERROR,
298                        "non-existing PPS %u referenced\n", pps_id);
299                 goto fail;
300             }
301             p->ps.pps = (const PPS*)p->ps.pps_list[pps_id]->data;
302             if (!p->ps.sps_list[p->ps.pps->sps_id]) {
303                 av_log(h->avctx, AV_LOG_ERROR,
304                        "non-existing SPS %u referenced\n", p->ps.pps->sps_id);
305                 goto fail;
306             }
307             p->ps.sps = (SPS*)p->ps.sps_list[p->ps.pps->sps_id]->data;
308
309             h->ps.sps = p->ps.sps;
310             h->ps.pps = p->ps.pps;
311             sps = p->ps.sps;
312
313             h->frame_num = get_bits(&nal.gb, sps->log2_max_frame_num);
314
315             s->coded_width  = 16 * sps->mb_width;
316             s->coded_height = 16 * sps->mb_height;
317             s->width        = s->coded_width  - (sps->crop_right + sps->crop_left);
318             s->height       = s->coded_height - (sps->crop_top   + sps->crop_bottom);
319             if (s->width <= 0 || s->height <= 0) {
320                 s->width  = s->coded_width;
321                 s->height = s->coded_height;
322             }
323
324             switch (sps->bit_depth_luma) {
325             case 9:
326                 if (CHROMA444(h))      s->format = AV_PIX_FMT_YUV444P9;
327                 else if (CHROMA422(h)) s->format = AV_PIX_FMT_YUV422P9;
328                 else                   s->format = AV_PIX_FMT_YUV420P9;
329                 break;
330             case 10:
331                 if (CHROMA444(h))      s->format = AV_PIX_FMT_YUV444P10;
332                 else if (CHROMA422(h)) s->format = AV_PIX_FMT_YUV422P10;
333                 else                   s->format = AV_PIX_FMT_YUV420P10;
334                 break;
335             case 8:
336                 if (CHROMA444(h))      s->format = AV_PIX_FMT_YUV444P;
337                 else if (CHROMA422(h)) s->format = AV_PIX_FMT_YUV422P;
338                 else                   s->format = AV_PIX_FMT_YUV420P;
339                 break;
340             default:
341                 s->format = AV_PIX_FMT_NONE;
342             }
343
344             avctx->profile = ff_h264_get_profile(sps);
345             avctx->level   = sps->level_idc;
346
347             if (sps->frame_mbs_only_flag) {
348                 h->picture_structure = PICT_FRAME;
349             } else {
350                 if (get_bits1(&nal.gb)) { // field_pic_flag
351                     h->picture_structure = PICT_TOP_FIELD + get_bits1(&nal.gb); // bottom_field_flag
352                 } else {
353                     h->picture_structure = PICT_FRAME;
354                 }
355             }
356
357             if (h->nal_unit_type == NAL_IDR_SLICE)
358                 get_ue_golomb(&nal.gb); /* idr_pic_id */
359             if (sps->poc_type == 0) {
360                 h->poc_lsb = get_bits(&nal.gb, sps->log2_max_poc_lsb);
361
362                 if (p->ps.pps->pic_order_present == 1 &&
363                     h->picture_structure == PICT_FRAME)
364                     h->delta_poc_bottom = get_se_golomb(&nal.gb);
365             }
366
367             if (sps->poc_type == 1 &&
368                 !sps->delta_pic_order_always_zero_flag) {
369                 h->delta_poc[0] = get_se_golomb(&nal.gb);
370
371                 if (p->ps.pps->pic_order_present == 1 &&
372                     h->picture_structure == PICT_FRAME)
373                     h->delta_poc[1] = get_se_golomb(&nal.gb);
374             }
375
376             /* Decode POC of this picture.
377              * The prev_ values needed for decoding POC of the next picture are not set here. */
378             field_poc[0] = field_poc[1] = INT_MAX;
379             ff_init_poc(h, field_poc, &s->output_picture_number);
380
381             /* Continue parsing to check if MMCO_RESET is present.
382              * FIXME: MMCO_RESET could appear in non-first slice.
383              *        Maybe, we should parse all undisposable non-IDR slice of this
384              *        picture until encountering MMCO_RESET in a slice of it. */
385             if (h->nal_ref_idc && h->nal_unit_type != NAL_IDR_SLICE) {
386                 got_reset = scan_mmco_reset(s, &nal.gb);
387                 if (got_reset < 0)
388                     goto fail;
389             }
390
391             /* Set up the prev_ values for decoding POC of the next picture. */
392             h->prev_frame_num        = got_reset ? 0 : h->frame_num;
393             h->prev_frame_num_offset = got_reset ? 0 : h->frame_num_offset;
394             if (h->nal_ref_idc != 0) {
395                 if (!got_reset) {
396                     h->prev_poc_msb = h->poc_msb;
397                     h->prev_poc_lsb = h->poc_lsb;
398                 } else {
399                     h->prev_poc_msb = 0;
400                     h->prev_poc_lsb =
401                         h->picture_structure == PICT_BOTTOM_FIELD ? 0 : field_poc[0];
402                 }
403             }
404
405             if (sps->pic_struct_present_flag) {
406                 switch (h->sei_pic_struct) {
407                 case SEI_PIC_STRUCT_TOP_FIELD:
408                 case SEI_PIC_STRUCT_BOTTOM_FIELD:
409                     s->repeat_pict = 0;
410                     break;
411                 case SEI_PIC_STRUCT_FRAME:
412                 case SEI_PIC_STRUCT_TOP_BOTTOM:
413                 case SEI_PIC_STRUCT_BOTTOM_TOP:
414                     s->repeat_pict = 1;
415                     break;
416                 case SEI_PIC_STRUCT_TOP_BOTTOM_TOP:
417                 case SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM:
418                     s->repeat_pict = 2;
419                     break;
420                 case SEI_PIC_STRUCT_FRAME_DOUBLING:
421                     s->repeat_pict = 3;
422                     break;
423                 case SEI_PIC_STRUCT_FRAME_TRIPLING:
424                     s->repeat_pict = 5;
425                     break;
426                 default:
427                     s->repeat_pict = h->picture_structure == PICT_FRAME ? 1 : 0;
428                     break;
429                 }
430             } else {
431                 s->repeat_pict = h->picture_structure == PICT_FRAME ? 1 : 0;
432             }
433
434             if (h->picture_structure == PICT_FRAME) {
435                 s->picture_structure = AV_PICTURE_STRUCTURE_FRAME;
436                 if (sps->pic_struct_present_flag) {
437                     switch (h->sei_pic_struct) {
438                     case SEI_PIC_STRUCT_TOP_BOTTOM:
439                     case SEI_PIC_STRUCT_TOP_BOTTOM_TOP:
440                         s->field_order = AV_FIELD_TT;
441                         break;
442                     case SEI_PIC_STRUCT_BOTTOM_TOP:
443                     case SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM:
444                         s->field_order = AV_FIELD_BB;
445                         break;
446                     default:
447                         s->field_order = AV_FIELD_PROGRESSIVE;
448                         break;
449                     }
450                 } else {
451                     if (field_poc[0] < field_poc[1])
452                         s->field_order = AV_FIELD_TT;
453                     else if (field_poc[0] > field_poc[1])
454                         s->field_order = AV_FIELD_BB;
455                     else
456                         s->field_order = AV_FIELD_PROGRESSIVE;
457                 }
458             } else {
459                 if (h->picture_structure == PICT_TOP_FIELD)
460                     s->picture_structure = AV_PICTURE_STRUCTURE_TOP_FIELD;
461                 else
462                     s->picture_structure = AV_PICTURE_STRUCTURE_BOTTOM_FIELD;
463                 s->field_order = AV_FIELD_UNKNOWN;
464             }
465
466             av_freep(&nal.rbsp_buffer);
467             return 0; /* no need to evaluate the rest */
468         }
469         buf += consumed;
470     }
471     /* didn't find a picture! */
472     av_log(h->avctx, AV_LOG_ERROR, "missing picture in access unit\n");
473 fail:
474     av_freep(&nal.rbsp_buffer);
475     return -1;
476 }
477
478 static int h264_parse(AVCodecParserContext *s,
479                       AVCodecContext *avctx,
480                       const uint8_t **poutbuf, int *poutbuf_size,
481                       const uint8_t *buf, int buf_size)
482 {
483     H264ParseContext *p = s->priv_data;
484     H264Context      *h = &p->h;
485     ParseContext *pc = &p->pc;
486     int next;
487
488     if (!p->got_first) {
489         p->got_first = 1;
490         if (avctx->extradata_size) {
491             h->avctx = avctx;
492             // must be done like in the decoder.
493             // otherwise opening the parser, creating extradata,
494             // and then closing and opening again
495             // will cause has_b_frames to be always set.
496             // NB: estimate_timings_from_pts behaves exactly like this.
497             if (!avctx->has_b_frames)
498                 h->low_delay = 1;
499             ff_h264_decode_extradata(h);
500         }
501     }
502
503     if (s->flags & PARSER_FLAG_COMPLETE_FRAMES) {
504         next = buf_size;
505     } else {
506         next = h264_find_frame_end(p, buf, buf_size);
507
508         if (ff_combine_frame(pc, next, &buf, &buf_size) < 0) {
509             *poutbuf      = NULL;
510             *poutbuf_size = 0;
511             return buf_size;
512         }
513
514         if (next < 0 && next != END_NOT_FOUND) {
515             assert(pc->last_index + next >= 0);
516             h264_find_frame_end(p, &pc->buffer[pc->last_index + next], -next); // update state
517         }
518     }
519
520     parse_nal_units(s, avctx, buf, buf_size);
521
522     if (h->sei_cpb_removal_delay >= 0) {
523         s->dts_sync_point    = h->sei_buffering_period_present;
524         s->dts_ref_dts_delta = h->sei_cpb_removal_delay;
525         s->pts_dts_delta     = h->sei_dpb_output_delay;
526     } else {
527         s->dts_sync_point    = INT_MIN;
528         s->dts_ref_dts_delta = INT_MIN;
529         s->pts_dts_delta     = INT_MIN;
530     }
531
532     if (s->flags & PARSER_FLAG_ONCE) {
533         s->flags &= PARSER_FLAG_COMPLETE_FRAMES;
534     }
535
536     *poutbuf      = buf;
537     *poutbuf_size = buf_size;
538     return next;
539 }
540
541 static int h264_split(AVCodecContext *avctx,
542                       const uint8_t *buf, int buf_size)
543 {
544     int i;
545     uint32_t state = -1;
546     int has_sps    = 0;
547
548     for (i = 0; i <= buf_size; i++) {
549         if ((state & 0xFFFFFF1F) == 0x107)
550             has_sps = 1;
551         /*  if((state&0xFFFFFF1F) == 0x101 ||
552          *     (state&0xFFFFFF1F) == 0x102 ||
553          *     (state&0xFFFFFF1F) == 0x105) {
554          *  }
555          */
556         if ((state & 0xFFFFFF00) == 0x100 && (state & 0xFFFFFF1F) != 0x106 &&
557             (state & 0xFFFFFF1F) != 0x107 && (state & 0xFFFFFF1F) != 0x108 &&
558             (state & 0xFFFFFF1F) != 0x109 && (state & 0xFFFFFF1F) != 0x10d &&
559             (state & 0xFFFFFF1F) != 0x10f) {
560             if (has_sps) {
561                 while (i > 4 && buf[i - 5] == 0)
562                     i--;
563                 return i - 4;
564             }
565         }
566         if (i < buf_size)
567             state = (state << 8) | buf[i];
568     }
569     return 0;
570 }
571
572 static void h264_close(AVCodecParserContext *s)
573 {
574     H264ParseContext *p = s->priv_data;
575     H264Context      *h = &p->h;
576     ParseContext *pc = &p->pc;
577     int i;
578
579     av_free(pc->buffer);
580     ff_h264_free_context(h);
581
582     for (i = 0; i < FF_ARRAY_ELEMS(p->ps.sps_list); i++)
583         av_buffer_unref(&p->ps.sps_list[i]);
584
585     for (i = 0; i < FF_ARRAY_ELEMS(p->ps.pps_list); i++)
586         av_buffer_unref(&p->ps.pps_list[i]);
587 }
588
589 static av_cold int init(AVCodecParserContext *s)
590 {
591     H264ParseContext *p = s->priv_data;
592     H264Context      *h = &p->h;
593
594     h->slice_ctx = av_mallocz(sizeof(*h->slice_ctx));
595     if (!h->slice_ctx)
596         return 0;
597     h->nb_slice_ctx = 1;
598
599     h->slice_context_count = 1;
600     ff_h264dsp_init(&h->h264dsp, 8, 1);
601     return 0;
602 }
603
604 AVCodecParser ff_h264_parser = {
605     .codec_ids      = { AV_CODEC_ID_H264 },
606     .priv_data_size = sizeof(H264ParseContext),
607     .parser_init    = init,
608     .parser_parse   = h264_parse,
609     .parser_close   = h264_close,
610     .split          = h264_split,
611 };