h264: Print user data SEI under normal debug verbosity
[libav.git] / libavcodec / h264_sei.c
CommitLineData
9c095463
MN
1/*
2 * H.26L/H.264/AVC/JVT/14496-10/... sei decoding
3 * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
4 *
2912e87a 5 * This file is part of Libav.
9c095463 6 *
2912e87a 7 * Libav is free software; you can redistribute it and/or
9c095463
MN
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 *
2912e87a 12 * Libav is distributed in the hope that it will be useful,
9c095463
MN
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
2912e87a 18 * License along with Libav; if not, write to the Free Software
9c095463
MN
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22/**
ba87f080 23 * @file
9c095463
MN
24 * H.264 / AVC / MPEG4 part10 sei decoding.
25 * @author Michael Niedermayer <michaelni@gmx.at>
26 */
27
9c095463 28#include "avcodec.h"
9c095463 29#include "golomb.h"
066ad249
VG
30#include "h264.h"
31#include "internal.h"
9c095463 32
b1841217
VG
33static const uint8_t sei_num_clock_ts_table[9] = {
34 1, 1, 1, 2, 2, 3, 3, 2, 3
9c095463
MN
35};
36
b1841217
VG
37void ff_h264_reset_sei(H264Context *h)
38{
9c095463
MN
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;
5b10ef72 43 h->sei_frame_packing_present = 0;
18e3d61e 44 h->sei_display_orientation_present = 0;
271ce76d 45 h->sei_reguserdata_afd_present = 0;
b0017579
KK
46
47 h->a53_caption_size = 0;
48 av_freep(&h->a53_caption);
9c095463
MN
49}
50
b1841217
VG
51static int decode_picture_timing(H264Context *h)
52{
53 if (h->sps.nal_hrd_parameters_present_flag ||
54 h->sps.vcl_hrd_parameters_present_flag) {
55 h->sei_cpb_removal_delay = get_bits(&h->gb,
56 h->sps.cpb_removal_delay_length);
57 h->sei_dpb_output_delay = get_bits(&h->gb,
58 h->sps.dpb_output_delay_length);
9c095463 59 }
b1841217 60 if (h->sps.pic_struct_present_flag) {
9c095463 61 unsigned int i, num_clock_ts;
b1841217 62
2c541554 63 h->sei_pic_struct = get_bits(&h->gb, 4);
9c095463
MN
64 h->sei_ct_type = 0;
65
66 if (h->sei_pic_struct > SEI_PIC_STRUCT_FRAME_TRIPLING)
0d8b943d 67 return AVERROR_INVALIDDATA;
9c095463
MN
68
69 num_clock_ts = sei_num_clock_ts_table[h->sei_pic_struct];
70
b1841217
VG
71 for (i = 0; i < num_clock_ts; i++) {
72 if (get_bits(&h->gb, 1)) { /* clock_timestamp_flag */
9c095463 73 unsigned int full_timestamp_flag;
b1841217
VG
74
75 h->sei_ct_type |= 1 << get_bits(&h->gb, 2);
2c541554
AK
76 skip_bits(&h->gb, 1); /* nuit_field_based_flag */
77 skip_bits(&h->gb, 5); /* counting_type */
78 full_timestamp_flag = get_bits(&h->gb, 1);
79 skip_bits(&h->gb, 1); /* discontinuity_flag */
80 skip_bits(&h->gb, 1); /* cnt_dropped_flag */
81 skip_bits(&h->gb, 8); /* n_frames */
b1841217 82 if (full_timestamp_flag) {
2c541554
AK
83 skip_bits(&h->gb, 6); /* seconds_value 0..59 */
84 skip_bits(&h->gb, 6); /* minutes_value 0..59 */
85 skip_bits(&h->gb, 5); /* hours_value 0..23 */
b1841217
VG
86 } else {
87 if (get_bits(&h->gb, 1)) { /* seconds_flag */
2c541554 88 skip_bits(&h->gb, 6); /* seconds_value range 0..59 */
b1841217 89 if (get_bits(&h->gb, 1)) { /* minutes_flag */
2c541554 90 skip_bits(&h->gb, 6); /* minutes_value 0..59 */
b1841217 91 if (get_bits(&h->gb, 1)) /* hours_flag */
2c541554 92 skip_bits(&h->gb, 5); /* hours_value 0..23 */
9c095463
MN
93 }
94 }
95 }
b1841217
VG
96 if (h->sps.time_offset_length > 0)
97 skip_bits(&h->gb,
98 h->sps.time_offset_length); /* time_offset */
9c095463
MN
99 }
100 }
101
b1841217
VG
102 if (h->avctx->debug & FF_DEBUG_PICT_INFO)
103 av_log(h->avctx, AV_LOG_DEBUG, "ct_type:%X pic_struct:%d\n",
104 h->sei_ct_type, h->sei_pic_struct);
9c095463
MN
105 }
106 return 0;
107}
108
80ea6611
DH
109static int decode_registered_user_data_afd(H264Context *h, int size)
110{
111 int flag;
112
113 if (size-- < 1)
114 return AVERROR_INVALIDDATA;
115 skip_bits(&h->gb, 1); // 0
116 flag = get_bits(&h->gb, 1); // active_format_flag
117 skip_bits(&h->gb, 6); // reserved
118
119 if (flag) {
120 if (size-- < 1)
121 return AVERROR_INVALIDDATA;
122 skip_bits(&h->gb, 4); // reserved
123 h->active_format_description = get_bits(&h->gb, 4);
124 h->sei_reguserdata_afd_present = 1;
125 }
126
127 return 0;
128}
129
130static int decode_registered_user_data_closed_caption(H264Context *h, int size)
131{
132 int flag;
133 int user_data_type_code;
134 int cc_count;
135
136 if (size < 3)
137 return AVERROR(EINVAL);
138
139 user_data_type_code = get_bits(&h->gb, 8);
140 if (user_data_type_code == 0x3) {
141 skip_bits(&h->gb, 1); // reserved
142
143 flag = get_bits(&h->gb, 1); // process_cc_data_flag
144 if (flag) {
145 skip_bits(&h->gb, 1); // zero bit
146 cc_count = get_bits(&h->gb, 5);
147 skip_bits(&h->gb, 8); // reserved
148 size -= 2;
149
150 if (cc_count && size >= cc_count * 3) {
151 const uint64_t new_size = (h->a53_caption_size + cc_count
152 * UINT64_C(3));
153 int i, ret;
154
155 if (new_size > INT_MAX)
156 return AVERROR(EINVAL);
157
158 /* Allow merging of the cc data from two fields. */
159 ret = av_reallocp(&h->a53_caption, new_size);
160 if (ret < 0)
161 return ret;
162
163 for (i = 0; i < cc_count; i++) {
164 h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
165 h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
166 h->a53_caption[h->a53_caption_size++] = get_bits(&h->gb, 8);
167 }
168
169 skip_bits(&h->gb, 8); // marker_bits
170 }
171 }
f9ab4fe1
JH
172 } else {
173 int i;
61d8fa2a 174 avpriv_request_sample(h->avctx, "Subtitles with data type 0x%02x",
f9ab4fe1
JH
175 user_data_type_code);
176 for (i = 0; i < size - 1; i++)
177 skip_bits(&h->gb, 8);
80ea6611
DH
178 }
179
180 return 0;
181}
182
271ce76d
VG
183static int decode_registered_user_data(H264Context *h, int size)
184{
185 uint32_t country_code;
186 uint32_t user_identifier;
271ce76d
VG
187
188 if (size < 7)
189 return AVERROR_INVALIDDATA;
190 size -= 7;
191
192 country_code = get_bits(&h->gb, 8); // itu_t_t35_country_code
193 if (country_code == 0xFF) {
194 skip_bits(&h->gb, 8); // itu_t_t35_country_code_extension_byte
195 size--;
196 }
197
198 /* itu_t_t35_payload_byte follows */
199 skip_bits(&h->gb, 8); // terminal provider code
200 skip_bits(&h->gb, 8); // terminal provider oriented code
201 user_identifier = get_bits_long(&h->gb, 32);
202
203 switch (user_identifier) {
204 case MKBETAG('D', 'T', 'G', '1'): // afd_data
80ea6611 205 return decode_registered_user_data_afd(h, size);
b0017579 206 case MKBETAG('G', 'A', '9', '4'): // closed captions
80ea6611 207 return decode_registered_user_data_closed_caption(h, size);
271ce76d
VG
208 default:
209 skip_bits(&h->gb, size * 8);
210 break;
211 }
212
213 return 0;
214}
215
b1841217
VG
216static int decode_unregistered_user_data(H264Context *h, int size)
217{
218 uint8_t user_data[16 + 256];
9c095463
MN
219 int e, build, i;
220
b1841217 221 if (size < 16)
0d8b943d 222 return AVERROR_INVALIDDATA;
9c095463 223
b1841217
VG
224 for (i = 0; i < sizeof(user_data) - 1 && i < size; i++)
225 user_data[i] = get_bits(&h->gb, 8);
9c095463 226
b1841217 227 user_data[i] = 0;
4c7fd58f 228 e = sscanf(user_data + 16, "x264 - core %d", &build);
b1841217
VG
229 if (e == 1 && build > 0)
230 h->x264_build = build;
9c095463 231
8487987b 232 if (strlen(user_data + 16) > 0)
b1841217 233 av_log(h->avctx, AV_LOG_DEBUG, "user data:\"%s\"\n", user_data + 16);
9c095463 234
b1841217 235 for (; i < size; i++)
2c541554 236 skip_bits(&h->gb, 8);
9c095463
MN
237
238 return 0;
239}
240
b1841217
VG
241static int decode_recovery_point(H264Context *h)
242{
2c541554 243 h->sei_recovery_frame_cnt = get_ue_golomb(&h->gb);
b1841217
VG
244
245 /* 1b exact_match_flag,
246 * 1b broken_link_flag,
247 * 2b changing_slice_group_idc */
248 skip_bits(&h->gb, 4);
9c095463
MN
249
250 return 0;
251}
252
b1841217
VG
253static int decode_buffering_period(H264Context *h)
254{
9c095463
MN
255 unsigned int sps_id;
256 int sched_sel_idx;
257 SPS *sps;
258
2c541554 259 sps_id = get_ue_golomb_31(&h->gb);
b1841217
VG
260 if (sps_id > 31 || !h->sps_buffers[sps_id]) {
261 av_log(h->avctx, AV_LOG_ERROR,
262 "non-existing SPS %d referenced in buffering period\n", sps_id);
0d8b943d 263 return AVERROR_INVALIDDATA;
9c095463
MN
264 }
265 sps = h->sps_buffers[sps_id];
266
267 // NOTE: This is really so duplicated in the standard... See H.264, D.1.1
268 if (sps->nal_hrd_parameters_present_flag) {
269 for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
b1841217
VG
270 h->initial_cpb_removal_delay[sched_sel_idx] =
271 get_bits(&h->gb, sps->initial_cpb_removal_delay_length);
272 // initial_cpb_removal_delay_offset
273 skip_bits(&h->gb, sps->initial_cpb_removal_delay_length);
9c095463
MN
274 }
275 }
276 if (sps->vcl_hrd_parameters_present_flag) {
277 for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
b1841217
VG
278 h->initial_cpb_removal_delay[sched_sel_idx] =
279 get_bits(&h->gb, sps->initial_cpb_removal_delay_length);
280 // initial_cpb_removal_delay_offset
281 skip_bits(&h->gb, sps->initial_cpb_removal_delay_length);
9c095463
MN
282 }
283 }
284
285 h->sei_buffering_period_present = 1;
286 return 0;
287}
288
5b10ef72
VG
289static int decode_frame_packing_arrangement(H264Context *h)
290{
5b10ef72 291 get_ue_golomb(&h->gb); // frame_packing_arrangement_id
3d9fc21e
VG
292 h->sei_frame_packing_present = !get_bits1(&h->gb);
293
294 if (h->sei_frame_packing_present) {
295 h->frame_packing_arrangement_type = get_bits(&h->gb, 7);
296 h->quincunx_subsampling = get_bits1(&h->gb);
297 h->content_interpretation_type = get_bits(&h->gb, 6);
5b10ef72
VG
298
299 // the following skips: spatial_flipping_flag, frame0_flipped_flag,
300 // field_views_flag, current_frame_is_frame0_flag,
301 // frame0_self_contained_flag, frame1_self_contained_flag
302 skip_bits(&h->gb, 6);
303
3d9fc21e 304 if (!h->quincunx_subsampling && h->frame_packing_arrangement_type != 5)
5b10ef72
VG
305 skip_bits(&h->gb, 16); // frame[01]_grid_position_[xy]
306 skip_bits(&h->gb, 8); // frame_packing_arrangement_reserved_byte
307 get_ue_golomb(&h->gb); // frame_packing_arrangement_repetition_period
308 }
309 skip_bits1(&h->gb); // frame_packing_arrangement_extension_flag
310
5b10ef72
VG
311 return 0;
312}
313
18e3d61e
VG
314static int decode_display_orientation(H264Context *h)
315{
316 h->sei_display_orientation_present = !get_bits1(&h->gb);
317
318 if (h->sei_display_orientation_present) {
319 h->sei_hflip = get_bits1(&h->gb); // hor_flip
320 h->sei_vflip = get_bits1(&h->gb); // ver_flip
321
322 h->sei_anticlockwise_rotation = get_bits(&h->gb, 16);
323 get_ue_golomb(&h->gb); // display_orientation_repetition_period
324 skip_bits1(&h->gb); // display_orientation_extension_flag
325 }
326
327 return 0;
328}
329
b1841217
VG
330int ff_h264_decode_sei(H264Context *h)
331{
2c541554 332 while (get_bits_left(&h->gb) > 16) {
b1841217
VG
333 int size = 0;
334 int type = 0;
0d8b943d 335 int ret = 0;
7ab551f9 336 int last = 0;
9c095463 337
7ab551f9
VG
338 while (get_bits_left(&h->gb) >= 8 &&
339 (last = get_bits(&h->gb, 8)) == 255) {
340 type += 255;
341 }
342 type += last;
9c095463 343
7ab551f9
VG
344 last = 0;
345 while (get_bits_left(&h->gb) >= 8 &&
346 (last = get_bits(&h->gb, 8)) == 255) {
347 size += 255;
348 }
349 size += last;
9c095463 350
84df6d6a
MN
351 if (size > get_bits_left(&h->gb) / 8) {
352 av_log(h->avctx, AV_LOG_ERROR, "SEI type %d truncated at %d\n",
353 type, get_bits_left(&h->gb));
354 return AVERROR_INVALIDDATA;
355 }
356
b1841217 357 switch (type) {
9c095463 358 case SEI_TYPE_PIC_TIMING: // Picture timing SEI
0d8b943d 359 ret = decode_picture_timing(h);
9c095463 360 break;
271ce76d
VG
361 case SEI_TYPE_USER_DATA_REGISTERED:
362 ret = decode_registered_user_data(h, size);
363 break;
9c095463 364 case SEI_TYPE_USER_DATA_UNREGISTERED:
0d8b943d 365 ret = decode_unregistered_user_data(h, size);
9c095463
MN
366 break;
367 case SEI_TYPE_RECOVERY_POINT:
0d8b943d 368 ret = decode_recovery_point(h);
9c095463 369 break;
304e916a 370 case SEI_TYPE_BUFFERING_PERIOD:
0d8b943d 371 ret = decode_buffering_period(h);
9c095463 372 break;
5b10ef72
VG
373 case SEI_TYPE_FRAME_PACKING:
374 ret = decode_frame_packing_arrangement(h);
5b10ef72 375 break;
18e3d61e
VG
376 case SEI_TYPE_DISPLAY_ORIENTATION:
377 ret = decode_display_orientation(h);
18e3d61e 378 break;
9c095463 379 default:
26179964 380 av_log(h->avctx, AV_LOG_DEBUG, "unknown SEI type %d\n", type);
b1841217 381 skip_bits(&h->gb, 8 * size);
9c095463 382 }
0bfab80a
VG
383 if (ret < 0)
384 return ret;
9c095463 385
b1841217 386 // FIXME check bits here
2c541554 387 align_get_bits(&h->gb);
9c095463
MN
388 }
389
390 return 0;
391}