Merge commit '3176217c60ca7828712985092d9102d331ea4f3d'
[ffmpeg.git] / libavcodec / h264_sei.c
1 /*
2  * H.26L/H.264/AVC/JVT/14496-10/... sei decoding
3  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * H.264 / AVC / MPEG4 part10 sei decoding.
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #include "avcodec.h"
29 #include "golomb.h"
30 #include "h264.h"
31 #include "internal.h"
32
33 static const uint8_t sei_num_clock_ts_table[9] = {
34     1, 1, 1, 2, 2, 3, 3, 2, 3
35 };
36
37 void ff_h264_reset_sei(H264Context *h)
38 {
39     h->sei_recovery_frame_cnt       = -1;
40     h->sei_dpb_output_delay         =  0;
41     h->sei_cpb_removal_delay        = -1;
42     h->sei_buffering_period_present =  0;
43     h->sei_frame_packing_present    =  0;
44     h->sei_display_orientation_present = 0;
45     h->sei_reguserdata_afd_present  =  0;
46
47     h->a53_caption_size = 0;
48     av_freep(&h->a53_caption);
49 }
50
51 static int decode_picture_timing(H264Context *h)
52 {
53     const SPS *sps = h->ps.sps;
54     int i;
55
56     for (i = 0; i<MAX_SPS_COUNT; i++)
57         if ((!sps || !sps->log2_max_frame_num) && h->ps.sps_list[i])
58             sps = (const SPS *)h->ps.sps_list[i]->data;
59
60     if (!sps) {
61         av_log(h->avctx, AV_LOG_ERROR, "SPS unavailable in decode_picture_timing\n");
62         return 0;
63     }
64
65     if (sps->nal_hrd_parameters_present_flag || sps->vcl_hrd_parameters_present_flag) {
66         h->sei_cpb_removal_delay = get_bits_long(&h->gb,
67                                                  sps->cpb_removal_delay_length);
68         h->sei_dpb_output_delay  = get_bits_long(&h->gb,
69                                                  sps->dpb_output_delay_length);
70     }
71     if (sps->pic_struct_present_flag) {
72         unsigned int i, num_clock_ts;
73
74         h->sei_pic_struct = get_bits(&h->gb, 4);
75         h->sei_ct_type    = 0;
76
77         if (h->sei_pic_struct > SEI_PIC_STRUCT_FRAME_TRIPLING)
78             return AVERROR_INVALIDDATA;
79
80         num_clock_ts = sei_num_clock_ts_table[h->sei_pic_struct];
81
82         for (i = 0; i < num_clock_ts; i++) {
83             if (get_bits(&h->gb, 1)) {                /* clock_timestamp_flag */
84                 unsigned int full_timestamp_flag;
85
86                 h->sei_ct_type |= 1 << get_bits(&h->gb, 2);
87                 skip_bits(&h->gb, 1);                 /* nuit_field_based_flag */
88                 skip_bits(&h->gb, 5);                 /* counting_type */
89                 full_timestamp_flag = get_bits(&h->gb, 1);
90                 skip_bits(&h->gb, 1);                 /* discontinuity_flag */
91                 skip_bits(&h->gb, 1);                 /* cnt_dropped_flag */
92                 skip_bits(&h->gb, 8);                 /* n_frames */
93                 if (full_timestamp_flag) {
94                     skip_bits(&h->gb, 6);             /* seconds_value 0..59 */
95                     skip_bits(&h->gb, 6);             /* minutes_value 0..59 */
96                     skip_bits(&h->gb, 5);             /* hours_value 0..23 */
97                 } else {
98                     if (get_bits(&h->gb, 1)) {        /* seconds_flag */
99                         skip_bits(&h->gb, 6);         /* seconds_value range 0..59 */
100                         if (get_bits(&h->gb, 1)) {    /* minutes_flag */
101                             skip_bits(&h->gb, 6);     /* minutes_value 0..59 */
102                             if (get_bits(&h->gb, 1))  /* hours_flag */
103                                 skip_bits(&h->gb, 5); /* hours_value 0..23 */
104                         }
105                     }
106                 }
107                 if (sps->time_offset_length > 0)
108                     skip_bits(&h->gb,
109                               sps->time_offset_length); /* time_offset */
110             }
111         }
112
113         if (h->avctx->debug & FF_DEBUG_PICT_INFO)
114             av_log(h->avctx, AV_LOG_DEBUG, "ct_type:%X pic_struct:%d\n",
115                    h->sei_ct_type, h->sei_pic_struct);
116     }
117     return 0;
118 }
119
120 static int decode_registered_user_data_afd(H264Context *h, int size)
121 {
122     int flag;
123
124     if (size-- < 1)
125         return AVERROR_INVALIDDATA;
126     skip_bits(&h->gb, 1);               // 0
127     flag = get_bits(&h->gb, 1);         // active_format_flag
128     skip_bits(&h->gb, 6);               // reserved
129
130     if (flag) {
131         if (size-- < 1)
132             return AVERROR_INVALIDDATA;
133         skip_bits(&h->gb, 4);           // reserved
134         h->active_format_description   = get_bits(&h->gb, 4);
135         h->sei_reguserdata_afd_present = 1;
136 #if FF_API_AFD
137 FF_DISABLE_DEPRECATION_WARNINGS
138         h->avctx->dtg_active_format = h->active_format_description;
139 FF_ENABLE_DEPRECATION_WARNINGS
140 #endif /* FF_API_AFD */
141     }
142
143     return 0;
144 }
145
146 static int decode_registered_user_data_closed_caption(H264Context *h, int size)
147 {
148     int flag;
149     int user_data_type_code;
150     int cc_count;
151
152     if (size < 3)
153         return AVERROR(EINVAL);
154
155     user_data_type_code = get_bits(&h->gb, 8);
156     if (user_data_type_code == 0x3) {
157         skip_bits(&h->gb, 1);           // reserved
158
159         flag = get_bits(&h->gb, 1);     // process_cc_data_flag
160         if (flag) {
161             skip_bits(&h->gb, 1);       // zero bit
162             cc_count = get_bits(&h->gb, 5);
163             skip_bits(&h->gb, 8);       // reserved
164             size -= 2;
165
166             if (cc_count && size >= cc_count * 3) {
167                 const uint64_t new_size = (h->a53_caption_size + cc_count
168                                            * UINT64_C(3));
169                 int i, ret;
170
171                 if (new_size > INT_MAX)
172                     return AVERROR(EINVAL);
173
174                 /* Allow merging of the cc data from two fields. */
175                 ret = av_reallocp(&h->a53_caption, new_size);
176                 if (ret < 0)
177                     return ret;
178
179                 for (i = 0; i < cc_count; i++) {
180                     h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
181                     h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
182                     h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
183                 }
184
185                 skip_bits(&h->gb, 8);   // marker_bits
186             }
187         }
188     } else {
189         int i;
190         for (i = 0; i < size - 1; i++)
191             skip_bits(&h->gb, 8);
192     }
193
194     return 0;
195 }
196
197 static int decode_registered_user_data(H264Context *h, int size)
198 {
199     uint32_t country_code;
200     uint32_t user_identifier;
201
202     if (size < 7)
203         return AVERROR_INVALIDDATA;
204     size -= 7;
205
206     country_code = get_bits(&h->gb, 8); // itu_t_t35_country_code
207     if (country_code == 0xFF) {
208         skip_bits(&h->gb, 8);           // itu_t_t35_country_code_extension_byte
209         size--;
210     }
211
212     /* itu_t_t35_payload_byte follows */
213     skip_bits(&h->gb, 8);              // terminal provider code
214     skip_bits(&h->gb, 8);              // terminal provider oriented code
215     user_identifier = get_bits_long(&h->gb, 32);
216
217     switch (user_identifier) {
218         case MKBETAG('D', 'T', 'G', '1'):       // afd_data
219             return decode_registered_user_data_afd(h, size);
220         case MKBETAG('G', 'A', '9', '4'):       // closed captions
221             return decode_registered_user_data_closed_caption(h, size);
222         default:
223             skip_bits(&h->gb, size * 8);
224             break;
225     }
226
227     return 0;
228 }
229
230 static int decode_unregistered_user_data(H264Context *h, int size)
231 {
232     uint8_t *user_data;
233     int e, build, i;
234
235     if (size < 16 || size >= INT_MAX - 16)
236         return AVERROR_INVALIDDATA;
237
238     user_data = av_malloc(16 + size + 1);
239     if (!user_data)
240         return AVERROR(ENOMEM);
241
242     for (i = 0; i < size + 16; i++)
243         user_data[i] = get_bits(&h->gb, 8);
244
245     user_data[i] = 0;
246     e = sscanf(user_data + 16, "x264 - core %d", &build);
247     if (e == 1 && build > 0)
248         h->x264_build = build;
249     if (e == 1 && build == 1 && !strncmp(user_data+16, "x264 - core 0000", 16))
250         h->x264_build = 67;
251
252     if (strlen(user_data + 16) > 0)
253         av_log(h->avctx, AV_LOG_DEBUG, "user data:\"%s\"\n", user_data + 16);
254
255     av_free(user_data);
256     return 0;
257 }
258
259 static int decode_recovery_point(H264Context *h)
260 {
261     h->sei_recovery_frame_cnt = get_ue_golomb_long(&h->gb);
262
263     /* 1b exact_match_flag,
264      * 1b broken_link_flag,
265      * 2b changing_slice_group_idc */
266     skip_bits(&h->gb, 4);
267
268     if (h->avctx->debug & FF_DEBUG_PICT_INFO)
269         av_log(h->avctx, AV_LOG_DEBUG, "sei_recovery_frame_cnt: %d\n", h->sei_recovery_frame_cnt);
270
271     h->has_recovery_point = 1;
272
273     return 0;
274 }
275
276 static int decode_buffering_period(H264Context *h)
277 {
278     unsigned int sps_id;
279     int sched_sel_idx;
280     SPS *sps;
281
282     sps_id = get_ue_golomb_31(&h->gb);
283     if (sps_id > 31 || !h->ps.sps_list[sps_id]) {
284         av_log(h->avctx, AV_LOG_ERROR,
285                "non-existing SPS %d referenced in buffering period\n", sps_id);
286         return AVERROR_INVALIDDATA;
287     }
288     sps = (SPS*)h->ps.sps_list[sps_id]->data;
289
290     // NOTE: This is really so duplicated in the standard... See H.264, D.1.1
291     if (sps->nal_hrd_parameters_present_flag) {
292         for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
293             h->initial_cpb_removal_delay[sched_sel_idx] =
294                 get_bits_long(&h->gb, sps->initial_cpb_removal_delay_length);
295             // initial_cpb_removal_delay_offset
296             skip_bits(&h->gb, sps->initial_cpb_removal_delay_length);
297         }
298     }
299     if (sps->vcl_hrd_parameters_present_flag) {
300         for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
301             h->initial_cpb_removal_delay[sched_sel_idx] =
302                 get_bits_long(&h->gb, sps->initial_cpb_removal_delay_length);
303             // initial_cpb_removal_delay_offset
304             skip_bits(&h->gb, sps->initial_cpb_removal_delay_length);
305         }
306     }
307
308     h->sei_buffering_period_present = 1;
309     return 0;
310 }
311
312 static int decode_frame_packing_arrangement(H264Context *h)
313 {
314     h->sei_fpa.frame_packing_arrangement_id          = get_ue_golomb_long(&h->gb);
315     h->sei_fpa.frame_packing_arrangement_cancel_flag = get_bits1(&h->gb);
316     h->sei_frame_packing_present = !h->sei_fpa.frame_packing_arrangement_cancel_flag;
317
318     if (h->sei_frame_packing_present) {
319         h->sei_fpa.frame_packing_arrangement_type =
320         h->frame_packing_arrangement_type = get_bits(&h->gb, 7);
321         h->sei_fpa.quincunx_sampling_flag         =
322         h->quincunx_subsampling           = get_bits1(&h->gb);
323         h->sei_fpa.content_interpretation_type    =
324         h->content_interpretation_type    = get_bits(&h->gb, 6);
325
326         // the following skips: spatial_flipping_flag, frame0_flipped_flag,
327         // field_views_flag, current_frame_is_frame0_flag,
328         // frame0_self_contained_flag, frame1_self_contained_flag
329         skip_bits(&h->gb, 6);
330
331         if (!h->quincunx_subsampling && h->frame_packing_arrangement_type != 5)
332             skip_bits(&h->gb, 16);      // frame[01]_grid_position_[xy]
333         skip_bits(&h->gb, 8);           // frame_packing_arrangement_reserved_byte
334         h->sei_fpa.frame_packing_arrangement_repetition_period = get_ue_golomb_long(&h->gb);
335     }
336     skip_bits1(&h->gb);                 // frame_packing_arrangement_extension_flag
337
338     if (h->avctx->debug & FF_DEBUG_PICT_INFO)
339         av_log(h->avctx, AV_LOG_DEBUG, "SEI FPA %d %d %d %d %d %d\n",
340                                        h->sei_fpa.frame_packing_arrangement_id,
341                                        h->sei_fpa.frame_packing_arrangement_cancel_flag,
342                                        h->sei_fpa.frame_packing_arrangement_type,
343                                        h->sei_fpa.quincunx_sampling_flag,
344                                        h->sei_fpa.content_interpretation_type,
345                                        h->sei_fpa.frame_packing_arrangement_repetition_period);
346
347     return 0;
348 }
349
350 static int decode_display_orientation(H264Context *h)
351 {
352     h->sei_display_orientation_present = !get_bits1(&h->gb);
353
354     if (h->sei_display_orientation_present) {
355         h->sei_hflip = get_bits1(&h->gb);     // hor_flip
356         h->sei_vflip = get_bits1(&h->gb);     // ver_flip
357
358         h->sei_anticlockwise_rotation = get_bits(&h->gb, 16);
359         get_ue_golomb_long(&h->gb);  // display_orientation_repetition_period
360         skip_bits1(&h->gb);          // display_orientation_extension_flag
361     }
362
363     return 0;
364 }
365
366 static int decode_GreenMetadata(H264Context *h)
367 {
368     if (h->avctx->debug & FF_DEBUG_GREEN_MD)
369         av_log(h->avctx, AV_LOG_DEBUG,          "Green Metadata Info SEI message\n");
370
371     h->sei_green_metadata.green_metadata_type=get_bits(&h->gb, 8);
372
373     if (h->avctx->debug & FF_DEBUG_GREEN_MD)
374         av_log(h->avctx, AV_LOG_DEBUG,          "green_metadata_type                            = %d\n",
375                h->sei_green_metadata.green_metadata_type);
376
377     if (h->sei_green_metadata.green_metadata_type==0){
378         h->sei_green_metadata.period_type=get_bits(&h->gb, 8);
379
380         if (h->avctx->debug & FF_DEBUG_GREEN_MD)
381             av_log(h->avctx, AV_LOG_DEBUG,      "green_metadata_period_type                     = %d\n",
382                    h->sei_green_metadata.period_type);
383
384         if (h->sei_green_metadata.green_metadata_type==2){
385             h->sei_green_metadata.num_seconds = get_bits(&h->gb, 16);
386             if (h->avctx->debug & FF_DEBUG_GREEN_MD)
387                 av_log(h->avctx, AV_LOG_DEBUG,  "green_metadata_num_seconds                     = %d\n",
388                        h->sei_green_metadata.num_seconds);
389         }
390         else if (h->sei_green_metadata.period_type==3){
391             h->sei_green_metadata.num_pictures = get_bits(&h->gb, 16);
392             if (h->avctx->debug & FF_DEBUG_GREEN_MD)
393                 av_log(h->avctx, AV_LOG_DEBUG,  "green_metadata_num_pictures                    = %d\n",
394                        h->sei_green_metadata.num_pictures);
395         }
396
397         h->sei_green_metadata.percent_non_zero_macroblocks=get_bits(&h->gb, 8);
398         h->sei_green_metadata.percent_intra_coded_macroblocks=get_bits(&h->gb, 8);
399         h->sei_green_metadata.percent_six_tap_filtering=get_bits(&h->gb, 8);
400         h->sei_green_metadata.percent_alpha_point_deblocking_instance=get_bits(&h->gb, 8);
401
402         if (h->avctx->debug & FF_DEBUG_GREEN_MD)
403             av_log(h->avctx, AV_LOG_DEBUG,      "SEI GREEN Complexity Metrics                   = %f %f %f %f\n",
404                                            (float)h->sei_green_metadata.percent_non_zero_macroblocks/255,
405                                            (float)h->sei_green_metadata.percent_intra_coded_macroblocks/255,
406                                            (float)h->sei_green_metadata.percent_six_tap_filtering/255,
407                                            (float)h->sei_green_metadata.percent_alpha_point_deblocking_instance/255);
408
409     }else if( h->sei_green_metadata.green_metadata_type==1){
410         h->sei_green_metadata.xsd_metric_type=get_bits(&h->gb, 8);
411         h->sei_green_metadata.xsd_metric_value=get_bits(&h->gb, 16);
412
413         if (h->avctx->debug & FF_DEBUG_GREEN_MD)
414             av_log(h->avctx, AV_LOG_DEBUG,      "xsd_metric_type                                = %d\n",
415                    h->sei_green_metadata.xsd_metric_type);
416         if ( h->sei_green_metadata.xsd_metric_type==0){
417             if (h->avctx->debug & FF_DEBUG_GREEN_MD)
418                 av_log(h->avctx, AV_LOG_DEBUG,  "xsd_metric_value                               = %f\n",
419                        (float)h->sei_green_metadata.xsd_metric_value/100);
420         }
421     }
422
423     return 0;
424 }
425
426 int ff_h264_decode_sei(H264Context *h)
427 {
428     while (get_bits_left(&h->gb) > 16 && show_bits(&h->gb, 16)) {
429         int type = 0;
430         unsigned size = 0;
431         unsigned next;
432         int ret  = 0;
433
434         do {
435             if (get_bits_left(&h->gb) < 8)
436                 return AVERROR_INVALIDDATA;
437             type += show_bits(&h->gb, 8);
438         } while (get_bits(&h->gb, 8) == 255);
439
440         do {
441             if (get_bits_left(&h->gb) < 8)
442                 return AVERROR_INVALIDDATA;
443             size += show_bits(&h->gb, 8);
444         } while (get_bits(&h->gb, 8) == 255);
445
446         if (h->avctx->debug&FF_DEBUG_STARTCODE)
447             av_log(h->avctx, AV_LOG_DEBUG, "SEI %d len:%d\n", type, size);
448
449         if (size > get_bits_left(&h->gb) / 8) {
450             av_log(h->avctx, AV_LOG_ERROR, "SEI type %d size %d truncated at %d\n",
451                    type, 8*size, get_bits_left(&h->gb));
452             return AVERROR_INVALIDDATA;
453         }
454         next = get_bits_count(&h->gb) + 8 * size;
455
456         switch (type) {
457         case SEI_TYPE_PIC_TIMING: // Picture timing SEI
458             ret = decode_picture_timing(h);
459             break;
460         case SEI_TYPE_USER_DATA_REGISTERED:
461             ret = decode_registered_user_data(h, size);
462             break;
463         case SEI_TYPE_USER_DATA_UNREGISTERED:
464             ret = decode_unregistered_user_data(h, size);
465             break;
466         case SEI_TYPE_RECOVERY_POINT:
467             ret = decode_recovery_point(h);
468             break;
469         case SEI_TYPE_BUFFERING_PERIOD:
470             ret = decode_buffering_period(h);
471             break;
472         case SEI_TYPE_FRAME_PACKING:
473             ret = decode_frame_packing_arrangement(h);
474             break;
475         case SEI_TYPE_DISPLAY_ORIENTATION:
476             ret = decode_display_orientation(h);
477             break;
478         case SEI_TYPE_GREEN_METADATA:
479             ret = decode_GreenMetadata(h);
480             break;
481         default:
482             av_log(h->avctx, AV_LOG_DEBUG, "unknown SEI type %d\n", type);
483         }
484         if (ret < 0)
485             return ret;
486
487         skip_bits_long(&h->gb, next - get_bits_count(&h->gb));
488
489         // FIXME check bits here
490         align_get_bits(&h->gb);
491     }
492
493     return 0;
494 }
495
496 const char* ff_h264_sei_stereo_mode(H264Context *h)
497 {
498     if (h->sei_fpa.frame_packing_arrangement_cancel_flag == 0) {
499         switch (h->sei_fpa.frame_packing_arrangement_type) {
500             case SEI_FPA_TYPE_CHECKERBOARD:
501                 if (h->sei_fpa.content_interpretation_type == 2)
502                     return "checkerboard_rl";
503                 else
504                     return "checkerboard_lr";
505             case SEI_FPA_TYPE_INTERLEAVE_COLUMN:
506                 if (h->sei_fpa.content_interpretation_type == 2)
507                     return "col_interleaved_rl";
508                 else
509                     return "col_interleaved_lr";
510             case SEI_FPA_TYPE_INTERLEAVE_ROW:
511                 if (h->sei_fpa.content_interpretation_type == 2)
512                     return "row_interleaved_rl";
513                 else
514                     return "row_interleaved_lr";
515             case SEI_FPA_TYPE_SIDE_BY_SIDE:
516                 if (h->sei_fpa.content_interpretation_type == 2)
517                     return "right_left";
518                 else
519                     return "left_right";
520             case SEI_FPA_TYPE_TOP_BOTTOM:
521                 if (h->sei_fpa.content_interpretation_type == 2)
522                     return "bottom_top";
523                 else
524                     return "top_bottom";
525             case SEI_FPA_TYPE_INTERLEAVE_TEMPORAL:
526                 if (h->sei_fpa.content_interpretation_type == 2)
527                     return "block_rl";
528                 else
529                     return "block_lr";
530             case SEI_FPA_TYPE_2D:
531             default:
532                 return "mono";
533         }
534     } else if (h->sei_fpa.frame_packing_arrangement_cancel_flag == 1) {
535         return "mono";
536     } else {
537         return NULL;
538     }
539 }