2 * HEVC Supplementary Enhancement Information messages
4 * Copyright (C) 2012 - 2013 Guillaume Martres
5 * Copyright (C) 2012 - 2013 Gildas Cocherel
6 * Copyright (C) 2013 Vittorio Giovara
8 * This file is part of FFmpeg.
10 * FFmpeg is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * FFmpeg is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with FFmpeg; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include "dynamic_hdr10_plus.h"
31 static int decode_nal_sei_decoded_picture_hash(HEVCSEIPictureHash *s, GetBitContext *gb)
35 //uint16_t picture_crc;
36 //uint32_t picture_checksum;
37 hash_type = get_bits(gb, 8);
39 for (cIdx = 0; cIdx < 3/*((s->sps->chroma_format_idc == 0) ? 1 : 3)*/; cIdx++) {
42 for (i = 0; i < 16; i++)
43 s->md5[cIdx][i] = get_bits(gb, 8);
44 } else if (hash_type == 1) {
45 // picture_crc = get_bits(gb, 16);
47 } else if (hash_type == 2) {
48 // picture_checksum = get_bits_long(gb, 32);
55 static int decode_nal_sei_mastering_display_info(HEVCSEIMasteringDisplay *s, GetBitContext *gb)
58 // Mastering primaries
59 for (i = 0; i < 3; i++) {
60 s->display_primaries[i][0] = get_bits(gb, 16);
61 s->display_primaries[i][1] = get_bits(gb, 16);
64 s->white_point[0] = get_bits(gb, 16);
65 s->white_point[1] = get_bits(gb, 16);
67 // Max and min luminance of mastering display
68 s->max_luminance = get_bits_long(gb, 32);
69 s->min_luminance = get_bits_long(gb, 32);
71 // As this SEI message comes before the first frame that references it,
72 // initialize the flag to 2 and decrement on IRAP access unit so it
73 // persists for the coded video sequence (e.g., between two IRAPs)
78 static int decode_nal_sei_content_light_info(HEVCSEIContentLight *s, GetBitContext *gb)
80 // Max and average light levels
81 s->max_content_light_level = get_bits(gb, 16);
82 s->max_pic_average_light_level = get_bits(gb, 16);
83 // As this SEI message comes before the first frame that references it,
84 // initialize the flag to 2 and decrement on IRAP access unit so it
85 // persists for the coded video sequence (e.g., between two IRAPs)
90 static int decode_nal_sei_frame_packing_arrangement(HEVCSEIFramePacking *s, GetBitContext *gb)
92 get_ue_golomb_long(gb); // frame_packing_arrangement_id
93 s->present = !get_bits1(gb);
96 s->arrangement_type = get_bits(gb, 7);
97 s->quincunx_subsampling = get_bits1(gb);
98 s->content_interpretation_type = get_bits(gb, 6);
100 // spatial_flipping_flag, frame0_flipped_flag, field_views_flag
102 s->current_frame_is_frame0_flag = get_bits1(gb);
103 // frame0_self_contained_flag, frame1_self_contained_flag
106 if (!s->quincunx_subsampling && s->arrangement_type != 5)
107 skip_bits(gb, 16); // frame[01]_grid_position_[xy]
108 skip_bits(gb, 8); // frame_packing_arrangement_reserved_byte
109 skip_bits1(gb); // frame_packing_arrangement_persistence_flag
111 skip_bits1(gb); // upsampled_aspect_ratio_flag
115 static int decode_nal_sei_display_orientation(HEVCSEIDisplayOrientation *s, GetBitContext *gb)
117 s->present = !get_bits1(gb);
120 s->hflip = get_bits1(gb); // hor_flip
121 s->vflip = get_bits1(gb); // ver_flip
123 s->anticlockwise_rotation = get_bits(gb, 16);
124 skip_bits1(gb); // display_orientation_persistence_flag
130 static int decode_nal_sei_pic_timing(HEVCSEI *s, GetBitContext *gb, const HEVCParamSets *ps,
131 void *logctx, int size)
133 HEVCSEIPictureTiming *h = &s->picture_timing;
136 if (!ps->sps_list[s->active_seq_parameter_set_id])
137 return(AVERROR(ENOMEM));
138 sps = (HEVCSPS*)ps->sps_list[s->active_seq_parameter_set_id]->data;
140 if (sps->vui.frame_field_info_present_flag) {
141 int pic_struct = get_bits(gb, 4);
142 h->picture_struct = AV_PICTURE_STRUCTURE_UNKNOWN;
143 if (pic_struct == 2 || pic_struct == 10 || pic_struct == 12) {
144 av_log(logctx, AV_LOG_DEBUG, "BOTTOM Field\n");
145 h->picture_struct = AV_PICTURE_STRUCTURE_BOTTOM_FIELD;
146 } else if (pic_struct == 1 || pic_struct == 9 || pic_struct == 11) {
147 av_log(logctx, AV_LOG_DEBUG, "TOP Field\n");
148 h->picture_struct = AV_PICTURE_STRUCTURE_TOP_FIELD;
149 } else if (pic_struct == 7) {
150 av_log(logctx, AV_LOG_DEBUG, "Frame/Field Doubling\n");
151 h->picture_struct = HEVC_SEI_PIC_STRUCT_FRAME_DOUBLING;
152 } else if (pic_struct == 8) {
153 av_log(logctx, AV_LOG_DEBUG, "Frame/Field Tripling\n");
154 h->picture_struct = HEVC_SEI_PIC_STRUCT_FRAME_TRIPLING;
156 get_bits(gb, 2); // source_scan_type
157 get_bits(gb, 1); // duplicate_flag
161 skip_bits_long(gb, 8 * size);
166 static int decode_registered_user_data_closed_caption(HEVCSEIA53Caption *s, GetBitContext *gb,
172 return AVERROR_INVALIDDATA;
174 ret = ff_parse_a53_cc(&s->buf_ref, gb->buffer + get_bits_count(gb) / 8, size);
179 skip_bits_long(gb, size * 8);
184 static int decode_nal_sei_user_data_unregistered(HEVCSEIUnregistered *s, GetBitContext *gb,
187 AVBufferRef *buf_ref, **tmp;
189 if (size < 16 || size >= INT_MAX - 1)
190 return AVERROR_INVALIDDATA;
192 tmp = av_realloc_array(s->buf_ref, s->nb_buf_ref + 1, sizeof(*s->buf_ref));
194 return AVERROR(ENOMEM);
197 buf_ref = av_buffer_alloc(size + 1);
199 return AVERROR(ENOMEM);
201 for (int i = 0; i < size; i++)
202 buf_ref->data[i] = get_bits(gb, 8);
203 buf_ref->data[size] = 0;
204 buf_ref->size = size;
205 s->buf_ref[s->nb_buf_ref++] = buf_ref;
210 static int decode_registered_user_data_dynamic_hdr_plus(HEVCSEIDynamicHDRPlus *s,
211 GetBitContext *gb, int size)
215 AVDynamicHDRPlus *metadata = av_dynamic_hdr_plus_alloc(&meta_size);
217 return AVERROR(ENOMEM);
219 err = ff_parse_itu_t_t35_to_dynamic_hdr10_plus(metadata,
220 gb->buffer + get_bits_count(gb) / 8, size);
226 av_buffer_unref(&s->info);
227 s->info = av_buffer_create((uint8_t *)metadata, meta_size, NULL, NULL, 0);
230 return AVERROR(ENOMEM);
233 skip_bits_long(gb, size * 8);
238 static int decode_nal_sei_user_data_registered_itu_t_t35(HEVCSEI *s, GetBitContext *gb,
239 void *logctx, int size)
241 int country_code, provider_code;
244 return AVERROR_INVALIDDATA;
247 country_code = get_bits(gb, 8);
248 if (country_code == 0xFF) {
250 return AVERROR_INVALIDDATA;
256 if (country_code != 0xB5) { // usa_country_code
257 av_log(logctx, AV_LOG_VERBOSE,
258 "Unsupported User Data Registered ITU-T T35 SEI message (country_code = %d)\n",
263 provider_code = get_bits(gb, 16);
265 switch (provider_code) {
266 case 0x3C: { // smpte_provider_code
267 // A/341 Amendment - 2094-40
268 const uint16_t smpte2094_40_provider_oriented_code = 0x0001;
269 const uint8_t smpte2094_40_application_identifier = 0x04;
270 uint16_t provider_oriented_code;
271 uint8_t application_identifier;
274 return AVERROR_INVALIDDATA;
277 provider_oriented_code = get_bits(gb, 16);
278 application_identifier = get_bits(gb, 8);
279 if (provider_oriented_code == smpte2094_40_provider_oriented_code &&
280 application_identifier == smpte2094_40_application_identifier) {
281 return decode_registered_user_data_dynamic_hdr_plus(&s->dynamic_hdr_plus, gb, size);
285 case 0x31: { // atsc_provider_code
286 uint32_t user_identifier;
289 return AVERROR_INVALIDDATA;
292 user_identifier = get_bits_long(gb, 32);
293 switch (user_identifier) {
294 case MKBETAG('G', 'A', '9', '4'):
295 return decode_registered_user_data_closed_caption(&s->a53_caption, gb, size);
297 av_log(logctx, AV_LOG_VERBOSE,
298 "Unsupported User Data Registered ITU-T T35 SEI message (atsc user_identifier = 0x%04x)\n",
305 av_log(logctx, AV_LOG_VERBOSE,
306 "Unsupported User Data Registered ITU-T T35 SEI message (provider_code = %d)\n",
312 skip_bits_long(gb, size * 8);
316 static int decode_nal_sei_active_parameter_sets(HEVCSEI *s, GetBitContext *gb, void *logctx)
318 int num_sps_ids_minus1;
320 unsigned active_seq_parameter_set_id;
322 get_bits(gb, 4); // active_video_parameter_set_id
323 get_bits(gb, 1); // self_contained_cvs_flag
324 get_bits(gb, 1); // num_sps_ids_minus1
325 num_sps_ids_minus1 = get_ue_golomb_long(gb); // num_sps_ids_minus1
327 if (num_sps_ids_minus1 < 0 || num_sps_ids_minus1 > 15) {
328 av_log(logctx, AV_LOG_ERROR, "num_sps_ids_minus1 %d invalid\n", num_sps_ids_minus1);
329 return AVERROR_INVALIDDATA;
332 active_seq_parameter_set_id = get_ue_golomb_long(gb);
333 if (active_seq_parameter_set_id >= HEVC_MAX_SPS_COUNT) {
334 av_log(logctx, AV_LOG_ERROR, "active_parameter_set_id %d invalid\n", active_seq_parameter_set_id);
335 return AVERROR_INVALIDDATA;
337 s->active_seq_parameter_set_id = active_seq_parameter_set_id;
339 for (i = 1; i <= num_sps_ids_minus1; i++)
340 get_ue_golomb_long(gb); // active_seq_parameter_set_id[i]
345 static int decode_nal_sei_alternative_transfer(HEVCSEIAlternativeTransfer *s, GetBitContext *gb)
348 s->preferred_transfer_characteristics = get_bits(gb, 8);
352 static int decode_nal_sei_timecode(HEVCSEITimeCode *s, GetBitContext *gb)
354 s->num_clock_ts = get_bits(gb, 2);
356 for (int i = 0; i < s->num_clock_ts; i++) {
357 s->clock_timestamp_flag[i] = get_bits(gb, 1);
359 if (s->clock_timestamp_flag[i]) {
360 s->units_field_based_flag[i] = get_bits(gb, 1);
361 s->counting_type[i] = get_bits(gb, 5);
362 s->full_timestamp_flag[i] = get_bits(gb, 1);
363 s->discontinuity_flag[i] = get_bits(gb, 1);
364 s->cnt_dropped_flag[i] = get_bits(gb, 1);
366 s->n_frames[i] = get_bits(gb, 9);
368 if (s->full_timestamp_flag[i]) {
369 s->seconds_value[i] = av_clip(get_bits(gb, 6), 0, 59);
370 s->minutes_value[i] = av_clip(get_bits(gb, 6), 0, 59);
371 s->hours_value[i] = av_clip(get_bits(gb, 5), 0, 23);
373 s->seconds_flag[i] = get_bits(gb, 1);
374 if (s->seconds_flag[i]) {
375 s->seconds_value[i] = av_clip(get_bits(gb, 6), 0, 59);
376 s->minutes_flag[i] = get_bits(gb, 1);
377 if (s->minutes_flag[i]) {
378 s->minutes_value[i] = av_clip(get_bits(gb, 6), 0, 59);
379 s->hours_flag[i] = get_bits(gb, 1);
380 if (s->hours_flag[i]) {
381 s->hours_value[i] = av_clip(get_bits(gb, 5), 0, 23);
387 s->time_offset_length[i] = get_bits(gb, 5);
388 if (s->time_offset_length[i] > 0) {
389 s->time_offset_value[i] = get_bits(gb, s->time_offset_length[i]);
399 static int decode_nal_sei_prefix(GetBitContext *gb, void *logctx, HEVCSEI *s,
400 const HEVCParamSets *ps, int type, int size)
403 case 256: // Mismatched value from HM 8.1
404 return decode_nal_sei_decoded_picture_hash(&s->picture_hash, gb);
405 case SEI_TYPE_FRAME_PACKING_ARRANGEMENT:
406 return decode_nal_sei_frame_packing_arrangement(&s->frame_packing, gb);
407 case SEI_TYPE_DISPLAY_ORIENTATION:
408 return decode_nal_sei_display_orientation(&s->display_orientation, gb);
409 case SEI_TYPE_PIC_TIMING:
410 return decode_nal_sei_pic_timing(s, gb, ps, logctx, size);
411 case SEI_TYPE_MASTERING_DISPLAY_COLOUR_VOLUME:
412 return decode_nal_sei_mastering_display_info(&s->mastering_display, gb);
413 case SEI_TYPE_CONTENT_LIGHT_LEVEL_INFO:
414 return decode_nal_sei_content_light_info(&s->content_light, gb);
415 case SEI_TYPE_ACTIVE_PARAMETER_SETS:
416 return decode_nal_sei_active_parameter_sets(s, gb, logctx);
417 case SEI_TYPE_USER_DATA_REGISTERED_ITU_T_T35:
418 return decode_nal_sei_user_data_registered_itu_t_t35(s, gb, logctx, size);
419 case SEI_TYPE_USER_DATA_UNREGISTERED:
420 return decode_nal_sei_user_data_unregistered(&s->unregistered, gb, size);
421 case SEI_TYPE_ALTERNATIVE_TRANSFER_CHARACTERISTICS:
422 return decode_nal_sei_alternative_transfer(&s->alternative_transfer, gb);
423 case SEI_TYPE_TIME_CODE:
424 return decode_nal_sei_timecode(&s->timecode, gb);
426 av_log(logctx, AV_LOG_DEBUG, "Skipped PREFIX SEI %d\n", type);
427 skip_bits_long(gb, 8 * size);
432 static int decode_nal_sei_suffix(GetBitContext *gb, void *logctx, HEVCSEI *s,
436 case SEI_TYPE_DECODED_PICTURE_HASH:
437 return decode_nal_sei_decoded_picture_hash(&s->picture_hash, gb);
439 av_log(logctx, AV_LOG_DEBUG, "Skipped SUFFIX SEI %d\n", type);
440 skip_bits_long(gb, 8 * size);
445 static int decode_nal_sei_message(GetBitContext *gb, void *logctx, HEVCSEI *s,
446 const HEVCParamSets *ps, int nal_unit_type)
448 int payload_type = 0;
449 int payload_size = 0;
451 av_log(logctx, AV_LOG_DEBUG, "Decoding SEI\n");
453 while (byte == 0xFF) {
454 if (get_bits_left(gb) < 16 || payload_type > INT_MAX - 255)
455 return AVERROR_INVALIDDATA;
456 byte = get_bits(gb, 8);
457 payload_type += byte;
460 while (byte == 0xFF) {
461 if (get_bits_left(gb) < 8 + 8LL*payload_size)
462 return AVERROR_INVALIDDATA;
463 byte = get_bits(gb, 8);
464 payload_size += byte;
466 if (get_bits_left(gb) < 8LL*payload_size)
467 return AVERROR_INVALIDDATA;
468 if (nal_unit_type == HEVC_NAL_SEI_PREFIX) {
469 return decode_nal_sei_prefix(gb, logctx, s, ps, payload_type, payload_size);
470 } else { /* nal_unit_type == NAL_SEI_SUFFIX */
471 return decode_nal_sei_suffix(gb, logctx, s, payload_type, payload_size);
475 static int more_rbsp_data(GetBitContext *gb)
477 return get_bits_left(gb) > 0 && show_bits(gb, 8) != 0x80;
480 int ff_hevc_decode_nal_sei(GetBitContext *gb, void *logctx, HEVCSEI *s,
481 const HEVCParamSets *ps, int type)
486 ret = decode_nal_sei_message(gb, logctx, s, ps, type);
489 } while (more_rbsp_data(gb));
493 void ff_hevc_reset_sei(HEVCSEI *s)
495 av_buffer_unref(&s->a53_caption.buf_ref);
497 for (int i = 0; i < s->unregistered.nb_buf_ref; i++)
498 av_buffer_unref(&s->unregistered.buf_ref[i]);
499 s->unregistered.nb_buf_ref = 0;
500 av_freep(&s->unregistered.buf_ref);
501 av_buffer_unref(&s->dynamic_hdr_plus.info);