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