libavcodec/h264_sei.c
9c095463
 /*
  * H.26L/H.264/AVC/JVT/14496-10/... sei decoding
  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
ba87f080
  * @file
9c095463
  * H.264 / AVC / MPEG4 part10 sei decoding.
  * @author Michael Niedermayer <michaelni@gmx.at>
  */
 
 #include "avcodec.h"
 #include "golomb.h"
066ad249
 #include "h264.h"
 #include "internal.h"
9c095463
 
b1841217
 static const uint8_t sei_num_clock_ts_table[9] = {
     1, 1, 1, 2, 2, 3, 3, 2, 3
9c095463
 };
 
b1841217
 void ff_h264_reset_sei(H264Context *h)
 {
9c095463
     h->sei_recovery_frame_cnt       = -1;
     h->sei_dpb_output_delay         =  0;
     h->sei_cpb_removal_delay        = -1;
     h->sei_buffering_period_present =  0;
5b10ef72
     h->sei_frame_packing_present    =  0;
18e3d61e
     h->sei_display_orientation_present = 0;
271ce76d
     h->sei_reguserdata_afd_present  =  0;
b0017579
 
8234f0e3
     h->a53_caption_size = 0;
b0017579
     av_freep(&h->a53_caption);
9c095463
 }
 
b1841217
 static int decode_picture_timing(H264Context *h)
 {
26482ae7
     SPS *sps = &h->sps;
     int i;
 
     for (i = 0; i<MAX_SPS_COUNT; i++)
         if (!sps->log2_max_frame_num && h->sps_buffers[i])
             sps = h->sps_buffers[i];
 
2ae5ac78
     if (sps->nal_hrd_parameters_present_flag || sps->vcl_hrd_parameters_present_flag) {
         h->sei_cpb_removal_delay = get_bits_long(&h->gb,
                                                  sps->cpb_removal_delay_length);
         h->sei_dpb_output_delay  = get_bits_long(&h->gb,
                                                  sps->dpb_output_delay_length);
9c095463
     }
2ae5ac78
     if (sps->pic_struct_present_flag) {
9c095463
         unsigned int i, num_clock_ts;
b1841217
 
2c541554
         h->sei_pic_struct = get_bits(&h->gb, 4);
9c095463
         h->sei_ct_type    = 0;
 
         if (h->sei_pic_struct > SEI_PIC_STRUCT_FRAME_TRIPLING)
0d8b943d
             return AVERROR_INVALIDDATA;
9c095463
 
         num_clock_ts = sei_num_clock_ts_table[h->sei_pic_struct];
 
b1841217
         for (i = 0; i < num_clock_ts; i++) {
             if (get_bits(&h->gb, 1)) {                /* clock_timestamp_flag */
9c095463
                 unsigned int full_timestamp_flag;
b1841217
 
                 h->sei_ct_type |= 1 << get_bits(&h->gb, 2);
2c541554
                 skip_bits(&h->gb, 1);                 /* nuit_field_based_flag */
                 skip_bits(&h->gb, 5);                 /* counting_type */
                 full_timestamp_flag = get_bits(&h->gb, 1);
                 skip_bits(&h->gb, 1);                 /* discontinuity_flag */
                 skip_bits(&h->gb, 1);                 /* cnt_dropped_flag */
                 skip_bits(&h->gb, 8);                 /* n_frames */
b1841217
                 if (full_timestamp_flag) {
2c541554
                     skip_bits(&h->gb, 6);             /* seconds_value 0..59 */
                     skip_bits(&h->gb, 6);             /* minutes_value 0..59 */
                     skip_bits(&h->gb, 5);             /* hours_value 0..23 */
b1841217
                 } else {
                     if (get_bits(&h->gb, 1)) {        /* seconds_flag */
2c541554
                         skip_bits(&h->gb, 6);         /* seconds_value range 0..59 */
b1841217
                         if (get_bits(&h->gb, 1)) {    /* minutes_flag */
2c541554
                             skip_bits(&h->gb, 6);     /* minutes_value 0..59 */
b1841217
                             if (get_bits(&h->gb, 1))  /* hours_flag */
2c541554
                                 skip_bits(&h->gb, 5); /* hours_value 0..23 */
9c095463
                         }
                     }
                 }
2ae5ac78
                 if (sps->time_offset_length > 0)
b1841217
                     skip_bits(&h->gb,
2ae5ac78
                               sps->time_offset_length); /* time_offset */
9c095463
             }
         }
 
b1841217
         if (h->avctx->debug & FF_DEBUG_PICT_INFO)
             av_log(h->avctx, AV_LOG_DEBUG, "ct_type:%X pic_struct:%d\n",
                    h->sei_ct_type, h->sei_pic_struct);
9c095463
     }
     return 0;
 }
 
80ea6611
 static int decode_registered_user_data_afd(H264Context *h, int size)
 {
     int flag;
 
     if (size-- < 1)
         return AVERROR_INVALIDDATA;
     skip_bits(&h->gb, 1);               // 0
     flag = get_bits(&h->gb, 1);         // active_format_flag
     skip_bits(&h->gb, 6);               // reserved
 
     if (flag) {
         if (size-- < 1)
             return AVERROR_INVALIDDATA;
         skip_bits(&h->gb, 4);           // reserved
         h->active_format_description   = get_bits(&h->gb, 4);
         h->sei_reguserdata_afd_present = 1;
db395bef
 #if FF_API_AFD
 FF_DISABLE_DEPRECATION_WARNINGS
         h->avctx->dtg_active_format = h->active_format_description;
 FF_ENABLE_DEPRECATION_WARNINGS
 #endif /* FF_API_AFD */
80ea6611
     }
 
     return 0;
 }
 
 static int decode_registered_user_data_closed_caption(H264Context *h, int size)
 {
     int flag;
     int user_data_type_code;
     int cc_count;
 
     if (size < 3)
         return AVERROR(EINVAL);
 
     user_data_type_code = get_bits(&h->gb, 8);
     if (user_data_type_code == 0x3) {
         skip_bits(&h->gb, 1);           // reserved
 
         flag = get_bits(&h->gb, 1);     // process_cc_data_flag
         if (flag) {
             skip_bits(&h->gb, 1);       // zero bit
             cc_count = get_bits(&h->gb, 5);
             skip_bits(&h->gb, 8);       // reserved
             size -= 2;
 
             if (cc_count && size >= cc_count * 3) {
                 const uint64_t new_size = (h->a53_caption_size + cc_count
                                            * UINT64_C(3));
                 int i, ret;
 
                 if (new_size > INT_MAX)
                     return AVERROR(EINVAL);
 
                 /* Allow merging of the cc data from two fields. */
                 ret = av_reallocp(&h->a53_caption, new_size);
                 if (ret < 0)
                     return ret;
 
                 for (i = 0; i < cc_count; i++) {
                     h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
                     h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
                     h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
                 }
 
                 skip_bits(&h->gb, 8);   // marker_bits
             }
         }
f9ab4fe1
     } else {
         int i;
         for (i = 0; i < size - 1; i++)
             skip_bits(&h->gb, 8);
80ea6611
     }
 
     return 0;
 }
 
271ce76d
 static int decode_registered_user_data(H264Context *h, int size)
2ae5ac78
 {
271ce76d
     uint32_t country_code;
d6e95669
     uint32_t user_identifier;
 
     if (size < 7)
271ce76d
         return AVERROR_INVALIDDATA;
d6e95669
     size -= 7;
 
271ce76d
     country_code = get_bits(&h->gb, 8); // itu_t_t35_country_code
     if (country_code == 0xFF) {
         skip_bits(&h->gb, 8);           // itu_t_t35_country_code_extension_byte
         size--;
     }
 
     /* itu_t_t35_payload_byte follows */
     skip_bits(&h->gb, 8);              // terminal provider code
     skip_bits(&h->gb, 8);              // terminal provider oriented code
b7fe35c9
     user_identifier = get_bits_long(&h->gb, 32);
d6e95669
 
     switch (user_identifier) {
271ce76d
         case MKBETAG('D', 'T', 'G', '1'):       // afd_data
80ea6611
             return decode_registered_user_data_afd(h, size);
b0017579
         case MKBETAG('G', 'A', '9', '4'):       // closed captions
80ea6611
             return decode_registered_user_data_closed_caption(h, size);
d6e95669
         default:
b7fe35c9
             skip_bits(&h->gb, size * 8);
d6e95669
             break;
     }
 
     return 0;
 }
 
b1841217
 static int decode_unregistered_user_data(H264Context *h, int size)
 {
     uint8_t user_data[16 + 256];
9c095463
     int e, build, i;
 
b1841217
     if (size < 16)
0d8b943d
         return AVERROR_INVALIDDATA;
9c095463
 
b1841217
     for (i = 0; i < sizeof(user_data) - 1 && i < size; i++)
         user_data[i] = get_bits(&h->gb, 8);
9c095463
 
b1841217
     user_data[i] = 0;
4c7fd58f
     e = sscanf(user_data + 16, "x264 - core %d", &build);
b1841217
     if (e == 1 && build > 0)
         h->x264_build = build;
2ae5ac78
     if (e == 1 && build == 1 && !strncmp(user_data+16, "x264 - core 0000", 16))
e9d0ab57
         h->x264_build = 67;
9c095463
 
b1841217
     if (h->avctx->debug & FF_DEBUG_BUGS)
         av_log(h->avctx, AV_LOG_DEBUG, "user data:\"%s\"\n", user_data + 16);
9c095463
 
b1841217
     for (; i < size; i++)
2c541554
         skip_bits(&h->gb, 8);
9c095463
 
     return 0;
 }
 
b1841217
 static int decode_recovery_point(H264Context *h)
 {
2c541554
     h->sei_recovery_frame_cnt = get_ue_golomb(&h->gb);
9c095463
 
b1841217
     /* 1b exact_match_flag,
      * 1b broken_link_flag,
      * 2b changing_slice_group_idc */
     skip_bits(&h->gb, 4);
9c095463
 
2ae5ac78
     if (h->avctx->debug & FF_DEBUG_PICT_INFO)
19688e87
         av_log(h->avctx, AV_LOG_DEBUG, "sei_recovery_frame_cnt: %d\n", h->sei_recovery_frame_cnt);
 
19c9d1e8
     h->has_recovery_point = 1;
 
9c095463
     return 0;
 }
 
b1841217
 static int decode_buffering_period(H264Context *h)
 {
9c095463
     unsigned int sps_id;
     int sched_sel_idx;
     SPS *sps;
 
2c541554
     sps_id = get_ue_golomb_31(&h->gb);
b1841217
     if (sps_id > 31 || !h->sps_buffers[sps_id]) {
         av_log(h->avctx, AV_LOG_ERROR,
                "non-existing SPS %d referenced in buffering period\n", sps_id);
0d8b943d
         return AVERROR_INVALIDDATA;
9c095463
     }
     sps = h->sps_buffers[sps_id];
 
     // NOTE: This is really so duplicated in the standard... See H.264, D.1.1
     if (sps->nal_hrd_parameters_present_flag) {
         for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
b1841217
             h->initial_cpb_removal_delay[sched_sel_idx] =
2ae5ac78
                 get_bits_long(&h->gb, sps->initial_cpb_removal_delay_length);
b1841217
             // initial_cpb_removal_delay_offset
             skip_bits(&h->gb, sps->initial_cpb_removal_delay_length);
9c095463
         }
     }
     if (sps->vcl_hrd_parameters_present_flag) {
         for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
b1841217
             h->initial_cpb_removal_delay[sched_sel_idx] =
2ae5ac78
                 get_bits_long(&h->gb, sps->initial_cpb_removal_delay_length);
b1841217
             // initial_cpb_removal_delay_offset
             skip_bits(&h->gb, sps->initial_cpb_removal_delay_length);
9c095463
         }
     }
 
     h->sei_buffering_period_present = 1;
     return 0;
 }
 
5b10ef72
 static int decode_frame_packing_arrangement(H264Context *h)
 {
8710a634
     h->sei_fpa.frame_packing_arrangement_id          = get_ue_golomb(&h->gb);
d6acf45e
     h->sei_fpa.frame_packing_arrangement_cancel_flag = get_bits1(&h->gb);
     h->sei_frame_packing_present = !h->sei_fpa.frame_packing_arrangement_cancel_flag;
3d9fc21e
 
     if (h->sei_frame_packing_present) {
d6acf45e
         h->sei_fpa.frame_packing_arrangement_type =
3d9fc21e
         h->frame_packing_arrangement_type = get_bits(&h->gb, 7);
d6acf45e
         h->sei_fpa.quincunx_sampling_flag         =
3d9fc21e
         h->quincunx_subsampling           = get_bits1(&h->gb);
d6acf45e
         h->sei_fpa.content_interpretation_type    =
3d9fc21e
         h->content_interpretation_type    = get_bits(&h->gb, 6);
5b10ef72
 
         // the following skips: spatial_flipping_flag, frame0_flipped_flag,
         // field_views_flag, current_frame_is_frame0_flag,
         // frame0_self_contained_flag, frame1_self_contained_flag
         skip_bits(&h->gb, 6);
 
3d9fc21e
         if (!h->quincunx_subsampling && h->frame_packing_arrangement_type != 5)
5b10ef72
             skip_bits(&h->gb, 16);      // frame[01]_grid_position_[xy]
         skip_bits(&h->gb, 8);           // frame_packing_arrangement_reserved_byte
8710a634
         h->sei_fpa.frame_packing_arrangement_repetition_period = get_ue_golomb(&h->gb) /* frame_packing_arrangement_repetition_period */;
     }
5b10ef72
     skip_bits1(&h->gb);                 // frame_packing_arrangement_extension_flag
 
8710a634
     if (h->avctx->debug & FF_DEBUG_PICT_INFO)
         av_log(h->avctx, AV_LOG_DEBUG, "SEI FPA %d %d %d %d %d %d\n",
                                        h->sei_fpa.frame_packing_arrangement_id,
                                        h->sei_fpa.frame_packing_arrangement_cancel_flag,
                                        h->sei_fpa.frame_packing_arrangement_type,
                                        h->sei_fpa.quincunx_sampling_flag,
                                        h->sei_fpa.content_interpretation_type,
                                        h->sei_fpa.frame_packing_arrangement_repetition_period);
be6e8146
 
8710a634
     return 0;
 }
 
18e3d61e
 static int decode_display_orientation(H264Context *h)
 {
     h->sei_display_orientation_present = !get_bits1(&h->gb);
 
     if (h->sei_display_orientation_present) {
         h->sei_hflip = get_bits1(&h->gb);     // hor_flip
         h->sei_vflip = get_bits1(&h->gb);     // ver_flip
 
         h->sei_anticlockwise_rotation = get_bits(&h->gb, 16);
         get_ue_golomb(&h->gb);  // display_orientation_repetition_period
         skip_bits1(&h->gb);     // display_orientation_extension_flag
     }
 
     return 0;
 }
 
04a68f43
 static int decode_GreenMetadata(H264Context *h)
 {
     if (h->avctx->debug & FF_DEBUG_GREEN_MD)
         av_log(h->avctx, AV_LOG_DEBUG,          "Green Metadata Info SEI message\n");
 
     h->sei_green_metadata.green_metadata_type=get_bits(&h->gb, 8);
 
     if (h->avctx->debug & FF_DEBUG_GREEN_MD)
         av_log(h->avctx, AV_LOG_DEBUG,          "green_metadata_type                            = %d\n",
                h->sei_green_metadata.green_metadata_type);
 
     if (h->sei_green_metadata.green_metadata_type==0){
         h->sei_green_metadata.period_type=get_bits(&h->gb, 8);
 
         if (h->avctx->debug & FF_DEBUG_GREEN_MD)
             av_log(h->avctx, AV_LOG_DEBUG,      "green_metadata_period_type                     = %d\n",
                    h->sei_green_metadata.period_type);
 
         if (h->sei_green_metadata.green_metadata_type==2){
             h->sei_green_metadata.num_seconds = get_bits(&h->gb, 16);
             if (h->avctx->debug & FF_DEBUG_GREEN_MD)
                 av_log(h->avctx, AV_LOG_DEBUG,  "green_metadata_num_seconds                     = %d\n",
                        h->sei_green_metadata.num_seconds);
         }
         else if (h->sei_green_metadata.period_type==3){
             h->sei_green_metadata.num_pictures = get_bits(&h->gb, 16);
             if (h->avctx->debug & FF_DEBUG_GREEN_MD)
                 av_log(h->avctx, AV_LOG_DEBUG,  "green_metadata_num_pictures                    = %d\n",
                        h->sei_green_metadata.num_pictures);
         }
 
         h->sei_green_metadata.percent_non_zero_macroblocks=get_bits(&h->gb, 8);
         h->sei_green_metadata.percent_intra_coded_macroblocks=get_bits(&h->gb, 8);
         h->sei_green_metadata.percent_six_tap_filtering=get_bits(&h->gb, 8);
         h->sei_green_metadata.percent_alpha_point_deblocking_instance=get_bits(&h->gb, 8);
 
         if (h->avctx->debug & FF_DEBUG_GREEN_MD)
             av_log(h->avctx, AV_LOG_DEBUG,      "SEI GREEN Complexity Metrics                   = %f %f %f %f\n",
                                            (float)h->sei_green_metadata.percent_non_zero_macroblocks/255,
                                            (float)h->sei_green_metadata.percent_intra_coded_macroblocks/255,
                                            (float)h->sei_green_metadata.percent_six_tap_filtering/255,
                                            (float)h->sei_green_metadata.percent_alpha_point_deblocking_instance/255);
 
     }else if( h->sei_green_metadata.green_metadata_type==1){
         h->sei_green_metadata.xsd_metric_type=get_bits(&h->gb, 8);
         h->sei_green_metadata.xsd_metric_value=get_bits(&h->gb, 16);
 
         if (h->avctx->debug & FF_DEBUG_GREEN_MD)
             av_log(h->avctx, AV_LOG_DEBUG,      "xsd_metric_type                                = %d\n",
                    h->sei_green_metadata.xsd_metric_type);
         if ( h->sei_green_metadata.xsd_metric_type==0){
             if (h->avctx->debug & FF_DEBUG_GREEN_MD)
                 av_log(h->avctx, AV_LOG_DEBUG,  "xsd_metric_value                               = %f\n",
                        (float)h->sei_green_metadata.xsd_metric_value/100);
         }
     }
 
     return 0;
 }
 
b1841217
 int ff_h264_decode_sei(H264Context *h)
 {
688a40b4
     while (get_bits_left(&h->gb) > 16 && show_bits(&h->gb, 16)) {
b1841217
         int type = 0;
2ae5ac78
         unsigned size = 0;
         unsigned next;
0d8b943d
         int ret  = 0;
9c095463
 
2ae5ac78
         do {
b7fe35c9
             if (get_bits_left(&h->gb) < 8)
800ffa1f
                 return AVERROR_INVALIDDATA;
b1841217
             type += show_bits(&h->gb, 8);
2ae5ac78
         } while (get_bits(&h->gb, 8) == 255);
9c095463
 
2ae5ac78
         do {
b7fe35c9
             if (get_bits_left(&h->gb) < 8)
800ffa1f
                 return AVERROR_INVALIDDATA;
b1841217
             size += show_bits(&h->gb, 8);
2ae5ac78
         } while (get_bits(&h->gb, 8) == 255);
9c095463
 
2ae5ac78
         if (h->avctx->debug&FF_DEBUG_STARTCODE)
b7fe35c9
             av_log(h->avctx, AV_LOG_DEBUG, "SEI %d len:%d\n", type, size);
62702075
 
45da7a0e
         if (size > get_bits_left(&h->gb) / 8) {
6565b1ad
             av_log(h->avctx, AV_LOG_ERROR, "SEI type %d size %d truncated at %d\n",
                    type, 8*size, get_bits_left(&h->gb));
45da7a0e
             return AVERROR_INVALIDDATA;
         }
2ae5ac78
         next = get_bits_count(&h->gb) + 8 * size;
45da7a0e
 
b1841217
         switch (type) {
9c095463
         case SEI_TYPE_PIC_TIMING: // Picture timing SEI
0d8b943d
             ret = decode_picture_timing(h);
9c095463
             break;
271ce76d
         case SEI_TYPE_USER_DATA_REGISTERED:
             ret = decode_registered_user_data(h, size);
d6e95669
             break;
9c095463
         case SEI_TYPE_USER_DATA_UNREGISTERED:
0d8b943d
             ret = decode_unregistered_user_data(h, size);
9c095463
             break;
         case SEI_TYPE_RECOVERY_POINT:
0d8b943d
             ret = decode_recovery_point(h);
9c095463
             break;
304e916a
         case SEI_TYPE_BUFFERING_PERIOD:
0d8b943d
             ret = decode_buffering_period(h);
9c095463
             break;
8710a634
         case SEI_TYPE_FRAME_PACKING:
5b10ef72
             ret = decode_frame_packing_arrangement(h);
             break;
18e3d61e
         case SEI_TYPE_DISPLAY_ORIENTATION:
             ret = decode_display_orientation(h);
9c2e31c3
             break;
04a68f43
         case SEI_TYPE_GREEN_METADATA:
             ret = decode_GreenMetadata(h);
             break;
9c095463
         default:
26179964
             av_log(h->avctx, AV_LOG_DEBUG, "unknown SEI type %d\n", type);
9c095463
         }
0bfab80a
         if (ret < 0)
             return ret;
9c095463
 
682e8a69
         skip_bits_long(&h->gb, next - get_bits_count(&h->gb));
9c095463
 
b1841217
         // FIXME check bits here
2c541554
         align_get_bits(&h->gb);
9c095463
     }
 
     return 0;
 }
8710a634
 
 const char* ff_h264_sei_stereo_mode(H264Context *h)
 {
     if (h->sei_fpa.frame_packing_arrangement_cancel_flag == 0) {
         switch (h->sei_fpa.frame_packing_arrangement_type) {
             case SEI_FPA_TYPE_CHECKERBOARD:
                 if (h->sei_fpa.content_interpretation_type == 2)
                     return "checkerboard_rl";
                 else
                     return "checkerboard_lr";
             case SEI_FPA_TYPE_INTERLEAVE_COLUMN:
                 if (h->sei_fpa.content_interpretation_type == 2)
                     return "col_interleaved_rl";
                 else
                     return "col_interleaved_lr";
             case SEI_FPA_TYPE_INTERLEAVE_ROW:
                 if (h->sei_fpa.content_interpretation_type == 2)
                     return "row_interleaved_rl";
                 else
                     return "row_interleaved_lr";
             case SEI_FPA_TYPE_SIDE_BY_SIDE:
                 if (h->sei_fpa.content_interpretation_type == 2)
                     return "right_left";
                 else
                     return "left_right";
             case SEI_FPA_TYPE_TOP_BOTTOM:
                 if (h->sei_fpa.content_interpretation_type == 2)
                     return "bottom_top";
                 else
                     return "top_bottom";
             case SEI_FPA_TYPE_INTERLEAVE_TEMPORAL:
                 if (h->sei_fpa.content_interpretation_type == 2)
                     return "block_rl";
                 else
                     return "block_lr";
             case SEI_FPA_TYPE_2D:
             default:
                 return "mono";
         }
     } else if (h->sei_fpa.frame_packing_arrangement_cancel_flag == 1) {
         return "mono";
     } else {
         return NULL;
     }
 }