2 * H.26L/H.264/AVC/JVT/14496-10/... SEI decoding
3 * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
5 * This file is part of FFmpeg.
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.
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.
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
24 * H.264 / AVC / MPEG-4 part10 SEI decoding.
25 * @author Michael Niedermayer <michaelni@gmx.at>
35 #define AVERROR_PS_NOT_FOUND FFERRTAG(0xF8,'?','P','S')
37 static const uint8_t sei_num_clock_ts_table[9] = {
38 1, 1, 1, 2, 2, 3, 3, 2, 3
41 void ff_h264_sei_uninit(H264SEIContext *h)
43 h->recovery_point.recovery_frame_cnt = -1;
45 h->picture_timing.dpb_output_delay = 0;
46 h->picture_timing.cpb_removal_delay = -1;
48 h->picture_timing.present = 0;
49 h->buffering_period.present = 0;
50 h->frame_packing.present = 0;
51 h->display_orientation.present = 0;
54 h->a53_caption.a53_caption_size = 0;
55 av_freep(&h->a53_caption.a53_caption);
58 static int decode_picture_timing(H264SEIPictureTiming *h, GetBitContext *gb,
59 const H264ParamSets *ps, void *logctx)
62 const SPS *sps = ps->sps;
64 for (i = 0; i<MAX_SPS_COUNT; i++)
65 if ((!sps || !sps->log2_max_frame_num) && ps->sps_list[i])
66 sps = (const SPS *)ps->sps_list[i]->data;
69 av_log(logctx, AV_LOG_ERROR, "SPS unavailable in decode_picture_timing\n");
70 return AVERROR_PS_NOT_FOUND;
73 if (sps->nal_hrd_parameters_present_flag ||
74 sps->vcl_hrd_parameters_present_flag) {
75 h->cpb_removal_delay = get_bits_long(gb, sps->cpb_removal_delay_length);
76 h->dpb_output_delay = get_bits_long(gb, sps->dpb_output_delay_length);
78 if (sps->pic_struct_present_flag) {
79 unsigned int i, num_clock_ts;
81 h->pic_struct = get_bits(gb, 4);
84 if (h->pic_struct > SEI_PIC_STRUCT_FRAME_TRIPLING)
85 return AVERROR_INVALIDDATA;
87 num_clock_ts = sei_num_clock_ts_table[h->pic_struct];
89 for (i = 0; i < num_clock_ts; i++) {
90 if (get_bits(gb, 1)) { /* clock_timestamp_flag */
91 unsigned int full_timestamp_flag;
93 h->ct_type |= 1 << get_bits(gb, 2);
94 skip_bits(gb, 1); /* nuit_field_based_flag */
95 skip_bits(gb, 5); /* counting_type */
96 full_timestamp_flag = get_bits(gb, 1);
97 skip_bits(gb, 1); /* discontinuity_flag */
98 skip_bits(gb, 1); /* cnt_dropped_flag */
99 skip_bits(gb, 8); /* n_frames */
100 if (full_timestamp_flag) {
101 skip_bits(gb, 6); /* seconds_value 0..59 */
102 skip_bits(gb, 6); /* minutes_value 0..59 */
103 skip_bits(gb, 5); /* hours_value 0..23 */
105 if (get_bits(gb, 1)) { /* seconds_flag */
106 skip_bits(gb, 6); /* seconds_value range 0..59 */
107 if (get_bits(gb, 1)) { /* minutes_flag */
108 skip_bits(gb, 6); /* minutes_value 0..59 */
109 if (get_bits(gb, 1)) /* hours_flag */
110 skip_bits(gb, 5); /* hours_value 0..23 */
114 if (sps->time_offset_length > 0)
116 sps->time_offset_length); /* time_offset */
120 av_log(logctx, AV_LOG_DEBUG, "ct_type:%X pic_struct:%d\n",
121 h->ct_type, h->pic_struct);
128 static int decode_registered_user_data_afd(H264SEIAFD *h, GetBitContext *gb, int size)
133 return AVERROR_INVALIDDATA;
134 skip_bits(gb, 1); // 0
135 flag = get_bits(gb, 1); // active_format_flag
136 skip_bits(gb, 6); // reserved
140 return AVERROR_INVALIDDATA;
141 skip_bits(gb, 4); // reserved
142 h->active_format_description = get_bits(gb, 4);
149 static int decode_registered_user_data_closed_caption(H264SEIA53Caption *h,
150 GetBitContext *gb, void *logctx,
154 int user_data_type_code;
158 return AVERROR(EINVAL);
160 user_data_type_code = get_bits(gb, 8);
161 if (user_data_type_code == 0x3) {
162 skip_bits(gb, 1); // reserved
164 flag = get_bits(gb, 1); // process_cc_data_flag
166 skip_bits(gb, 1); // zero bit
167 cc_count = get_bits(gb, 5);
168 skip_bits(gb, 8); // reserved
171 if (cc_count && size >= cc_count * 3) {
172 const uint64_t new_size = (h->a53_caption_size + cc_count
176 if (new_size > INT_MAX)
177 return AVERROR(EINVAL);
179 /* Allow merging of the cc data from two fields. */
180 ret = av_reallocp(&h->a53_caption, new_size);
184 for (i = 0; i < cc_count; i++) {
185 h->a53_caption[h->a53_caption_size++] = get_bits(gb, 8);
186 h->a53_caption[h->a53_caption_size++] = get_bits(gb, 8);
187 h->a53_caption[h->a53_caption_size++] = get_bits(gb, 8);
190 skip_bits(gb, 8); // marker_bits
195 for (i = 0; i < size - 1; i++)
202 static int decode_registered_user_data(H264SEIContext *h, GetBitContext *gb,
203 void *logctx, int size)
205 uint32_t country_code;
206 uint32_t user_identifier;
209 return AVERROR_INVALIDDATA;
212 country_code = get_bits(gb, 8); // itu_t_t35_country_code
213 if (country_code == 0xFF) {
214 skip_bits(gb, 8); // itu_t_t35_country_code_extension_byte
218 /* itu_t_t35_payload_byte follows */
219 skip_bits(gb, 8); // terminal provider code
220 skip_bits(gb, 8); // terminal provider oriented code
221 user_identifier = get_bits_long(gb, 32);
223 switch (user_identifier) {
224 case MKBETAG('D', 'T', 'G', '1'): // afd_data
225 return decode_registered_user_data_afd(&h->afd, gb, size);
226 case MKBETAG('G', 'A', '9', '4'): // closed captions
227 return decode_registered_user_data_closed_caption(&h->a53_caption, gb,
230 skip_bits(gb, size * 8);
237 static int decode_unregistered_user_data(H264SEIUnregistered *h, GetBitContext *gb,
238 void *logctx, int size)
243 if (size < 16 || size >= INT_MAX - 16)
244 return AVERROR_INVALIDDATA;
246 user_data = av_malloc(16 + size + 1);
248 return AVERROR(ENOMEM);
250 for (i = 0; i < size + 16; i++)
251 user_data[i] = get_bits(gb, 8);
254 e = sscanf(user_data + 16, "x264 - core %d", &build);
255 if (e == 1 && build > 0)
256 h->x264_build = build;
257 if (e == 1 && build == 1 && !strncmp(user_data+16, "x264 - core 0000", 16))
260 if (strlen(user_data + 16) > 0)
261 av_log(logctx, AV_LOG_DEBUG, "user data:\"%s\"\n", user_data + 16);
267 static int decode_recovery_point(H264SEIRecoveryPoint *h, GetBitContext *gb)
269 h->recovery_frame_cnt = get_ue_golomb_long(gb);
271 /* 1b exact_match_flag,
272 * 1b broken_link_flag,
273 * 2b changing_slice_group_idc */
279 static int decode_buffering_period(H264SEIBufferingPeriod *h, GetBitContext *gb,
280 const H264ParamSets *ps, void *logctx)
286 sps_id = get_ue_golomb_31(gb);
287 if (sps_id > 31 || !ps->sps_list[sps_id]) {
288 av_log(logctx, AV_LOG_ERROR,
289 "non-existing SPS %d referenced in buffering period\n", sps_id);
290 return sps_id > 31 ? AVERROR_INVALIDDATA : AVERROR_PS_NOT_FOUND;
292 sps = (const SPS*)ps->sps_list[sps_id]->data;
294 // NOTE: This is really so duplicated in the standard... See H.264, D.1.1
295 if (sps->nal_hrd_parameters_present_flag) {
296 for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
297 h->initial_cpb_removal_delay[sched_sel_idx] =
298 get_bits_long(gb, sps->initial_cpb_removal_delay_length);
299 // initial_cpb_removal_delay_offset
300 skip_bits(gb, sps->initial_cpb_removal_delay_length);
303 if (sps->vcl_hrd_parameters_present_flag) {
304 for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
305 h->initial_cpb_removal_delay[sched_sel_idx] =
306 get_bits_long(gb, sps->initial_cpb_removal_delay_length);
307 // initial_cpb_removal_delay_offset
308 skip_bits(gb, sps->initial_cpb_removal_delay_length);
316 static int decode_frame_packing_arrangement(H264SEIFramePacking *h,
319 h->frame_packing_arrangement_id = get_ue_golomb_long(gb);
320 h->frame_packing_arrangement_cancel_flag = get_bits1(gb);
321 h->present = !h->frame_packing_arrangement_cancel_flag;
324 h->frame_packing_arrangement_type = get_bits(gb, 7);
325 h->quincunx_sampling_flag = get_bits1(gb);
326 h->content_interpretation_type = get_bits(gb, 6);
328 // the following skips: spatial_flipping_flag, frame0_flipped_flag,
329 // field_views_flag, current_frame_is_frame0_flag,
330 // frame0_self_contained_flag, frame1_self_contained_flag
333 if (!h->quincunx_sampling_flag && h->frame_packing_arrangement_type != 5)
334 skip_bits(gb, 16); // frame[01]_grid_position_[xy]
335 skip_bits(gb, 8); // frame_packing_arrangement_reserved_byte
336 h->frame_packing_arrangement_repetition_period = get_ue_golomb_long(gb);
338 skip_bits1(gb); // frame_packing_arrangement_extension_flag
343 static int decode_display_orientation(H264SEIDisplayOrientation *h,
346 h->present = !get_bits1(gb);
349 h->hflip = get_bits1(gb); // hor_flip
350 h->vflip = get_bits1(gb); // ver_flip
352 h->anticlockwise_rotation = get_bits(gb, 16);
353 get_ue_golomb_long(gb); // display_orientation_repetition_period
354 skip_bits1(gb); // display_orientation_extension_flag
360 static int decode_green_metadata(H264SEIGreenMetaData *h, GetBitContext *gb)
362 h->green_metadata_type = get_bits(gb, 8);
364 if (h->green_metadata_type == 0) {
365 h->period_type = get_bits(gb, 8);
367 if (h->period_type == 2)
368 h->num_seconds = get_bits(gb, 16);
369 else if (h->period_type == 3)
370 h->num_pictures = get_bits(gb, 16);
372 h->percent_non_zero_macroblocks = get_bits(gb, 8);
373 h->percent_intra_coded_macroblocks = get_bits(gb, 8);
374 h->percent_six_tap_filtering = get_bits(gb, 8);
375 h->percent_alpha_point_deblocking_instance = get_bits(gb, 8);
377 } else if (h->green_metadata_type == 1) {
378 h->xsd_metric_type = get_bits(gb, 8);
379 h->xsd_metric_value = get_bits(gb, 16);
385 static int decode_alternative_transfer(H264SEIAlternativeTransfer *h,
389 h->preferred_transfer_characteristics = get_bits(gb, 8);
393 int ff_h264_sei_decode(H264SEIContext *h, GetBitContext *gb,
394 const H264ParamSets *ps, void *logctx)
398 while (get_bits_left(gb) > 16 && show_bits(gb, 16)) {
405 if (get_bits_left(gb) < 8)
406 return AVERROR_INVALIDDATA;
407 type += show_bits(gb, 8);
408 } while (get_bits(gb, 8) == 255);
411 if (get_bits_left(gb) < 8)
412 return AVERROR_INVALIDDATA;
413 size += show_bits(gb, 8);
414 } while (get_bits(gb, 8) == 255);
416 if (size > get_bits_left(gb) / 8) {
417 av_log(logctx, AV_LOG_ERROR, "SEI type %d size %d truncated at %d\n",
418 type, 8*size, get_bits_left(gb));
419 return AVERROR_INVALIDDATA;
421 next = get_bits_count(gb) + 8 * size;
424 case SEI_TYPE_PIC_TIMING: // Picture timing SEI
425 ret = decode_picture_timing(&h->picture_timing, gb, ps, logctx);
427 case SEI_TYPE_USER_DATA_REGISTERED:
428 ret = decode_registered_user_data(h, gb, logctx, size);
430 case SEI_TYPE_USER_DATA_UNREGISTERED:
431 ret = decode_unregistered_user_data(&h->unregistered, gb, logctx, size);
433 case SEI_TYPE_RECOVERY_POINT:
434 ret = decode_recovery_point(&h->recovery_point, gb);
436 case SEI_TYPE_BUFFERING_PERIOD:
437 ret = decode_buffering_period(&h->buffering_period, gb, ps, logctx);
439 case SEI_TYPE_FRAME_PACKING:
440 ret = decode_frame_packing_arrangement(&h->frame_packing, gb);
442 case SEI_TYPE_DISPLAY_ORIENTATION:
443 ret = decode_display_orientation(&h->display_orientation, gb);
445 case SEI_TYPE_GREEN_METADATA:
446 ret = decode_green_metadata(&h->green_metadata, gb);
448 case SEI_TYPE_ALTERNATIVE_TRANSFER:
449 ret = decode_alternative_transfer(&h->alternative_transfer, gb);
452 av_log(logctx, AV_LOG_DEBUG, "unknown SEI type %d\n", type);
454 if (ret < 0 && ret != AVERROR_PS_NOT_FOUND)
459 skip_bits_long(gb, next - get_bits_count(gb));
461 // FIXME check bits here
468 const char *ff_h264_sei_stereo_mode(const H264SEIFramePacking *h)
470 if (h->frame_packing_arrangement_cancel_flag == 0) {
471 switch (h->frame_packing_arrangement_type) {
472 case SEI_FPA_TYPE_CHECKERBOARD:
473 if (h->content_interpretation_type == 2)
474 return "checkerboard_rl";
476 return "checkerboard_lr";
477 case SEI_FPA_TYPE_INTERLEAVE_COLUMN:
478 if (h->content_interpretation_type == 2)
479 return "col_interleaved_rl";
481 return "col_interleaved_lr";
482 case SEI_FPA_TYPE_INTERLEAVE_ROW:
483 if (h->content_interpretation_type == 2)
484 return "row_interleaved_rl";
486 return "row_interleaved_lr";
487 case SEI_FPA_TYPE_SIDE_BY_SIDE:
488 if (h->content_interpretation_type == 2)
492 case SEI_FPA_TYPE_TOP_BOTTOM:
493 if (h->content_interpretation_type == 2)
497 case SEI_FPA_TYPE_INTERLEAVE_TEMPORAL:
498 if (h->content_interpretation_type == 2)
502 case SEI_FPA_TYPE_2D:
506 } else if (h->frame_packing_arrangement_cancel_flag == 1) {