]> git.sesse.net Git - ffmpeg/blob - libavcodec/hevc_sei.c
avcodec/hevc_sei: keep size in sync with the registered ITU-T T35 SEI GetBitContext
[ffmpeg] / libavcodec / hevc_sei.c
1 /*
2  * HEVC Supplementary Enhancement Information messages
3  *
4  * Copyright (C) 2012 - 2013 Guillaume Martres
5  * Copyright (C) 2012 - 2013 Gildas Cocherel
6  * Copyright (C) 2013 Vittorio Giovara
7  *
8  * This file is part of FFmpeg.
9  *
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.
14  *
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.
19  *
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
23  */
24
25 #include "atsc_a53.h"
26 #include "dynamic_hdr10_plus.h"
27 #include "golomb.h"
28 #include "hevc_ps.h"
29 #include "hevc_sei.h"
30
31 static int decode_nal_sei_decoded_picture_hash(HEVCSEIPictureHash *s, GetBitContext *gb)
32 {
33     int cIdx, i;
34     uint8_t hash_type;
35     //uint16_t picture_crc;
36     //uint32_t picture_checksum;
37     hash_type = get_bits(gb, 8);
38
39     for (cIdx = 0; cIdx < 3/*((s->sps->chroma_format_idc == 0) ? 1 : 3)*/; cIdx++) {
40         if (hash_type == 0) {
41             s->is_md5 = 1;
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);
46             skip_bits(gb, 16);
47         } else if (hash_type == 2) {
48             // picture_checksum = get_bits_long(gb, 32);
49             skip_bits(gb, 32);
50         }
51     }
52     return 0;
53 }
54
55 static int decode_nal_sei_mastering_display_info(HEVCSEIMasteringDisplay *s, GetBitContext *gb)
56 {
57     int i;
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);
62     }
63     // White point (x, y)
64     s->white_point[0] = get_bits(gb, 16);
65     s->white_point[1] = get_bits(gb, 16);
66
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);
70
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)
74     s->present = 2;
75     return 0;
76 }
77
78 static int decode_nal_sei_content_light_info(HEVCSEIContentLight *s, GetBitContext *gb)
79 {
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)
86     s->present = 2;
87     return  0;
88 }
89
90 static int decode_nal_sei_frame_packing_arrangement(HEVCSEIFramePacking *s, GetBitContext *gb)
91 {
92     get_ue_golomb_long(gb);             // frame_packing_arrangement_id
93     s->present = !get_bits1(gb);
94
95     if (s->present) {
96         s->arrangement_type               = get_bits(gb, 7);
97         s->quincunx_subsampling           = get_bits1(gb);
98         s->content_interpretation_type    = get_bits(gb, 6);
99
100         // spatial_flipping_flag, frame0_flipped_flag, field_views_flag
101         skip_bits(gb, 3);
102         s->current_frame_is_frame0_flag = get_bits1(gb);
103         // frame0_self_contained_flag, frame1_self_contained_flag
104         skip_bits(gb, 2);
105
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
110     }
111     skip_bits1(gb);             // upsampled_aspect_ratio_flag
112     return 0;
113 }
114
115 static int decode_nal_sei_display_orientation(HEVCSEIDisplayOrientation *s, GetBitContext *gb)
116 {
117     s->present = !get_bits1(gb);
118
119     if (s->present) {
120         s->hflip = get_bits1(gb);     // hor_flip
121         s->vflip = get_bits1(gb);     // ver_flip
122
123         s->anticlockwise_rotation = get_bits(gb, 16);
124         skip_bits1(gb);     // display_orientation_persistence_flag
125     }
126
127     return 0;
128 }
129
130 static int decode_nal_sei_pic_timing(HEVCSEI *s, GetBitContext *gb, const HEVCParamSets *ps,
131                                      void *logctx, int size)
132 {
133     HEVCSEIPictureTiming *h = &s->picture_timing;
134     HEVCSPS *sps;
135
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;
139
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;
155         }
156         get_bits(gb, 2);                   // source_scan_type
157         get_bits(gb, 1);                   // duplicate_flag
158         skip_bits1(gb);
159         size--;
160     }
161     skip_bits_long(gb, 8 * size);
162
163     return 0;
164 }
165
166 static int decode_registered_user_data_closed_caption(HEVCSEIA53Caption *s, GetBitContext *gb,
167                                                       int size)
168 {
169     int ret;
170
171     if (size < 3)
172        return AVERROR(EINVAL);
173
174     ret = ff_parse_a53_cc(&s->buf_ref, gb->buffer + get_bits_count(gb) / 8, size);
175
176     if (ret < 0)
177         return ret;
178
179     skip_bits_long(gb, size * 8);
180
181     return 0;
182 }
183
184 static int decode_nal_sei_user_data_unregistered(HEVCSEIUnregistered *s, GetBitContext *gb,
185                                                       int size)
186 {
187     AVBufferRef *buf_ref, **tmp;
188
189     if (size < 16 || size >= INT_MAX - 1)
190        return AVERROR_INVALIDDATA;
191
192     tmp = av_realloc_array(s->buf_ref, s->nb_buf_ref + 1, sizeof(*s->buf_ref));
193     if (!tmp)
194         return AVERROR(ENOMEM);
195     s->buf_ref = tmp;
196
197     buf_ref = av_buffer_alloc(size + 1);
198     if (!buf_ref)
199         return AVERROR(ENOMEM);
200
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;
206
207     return 0;
208 }
209
210 static int decode_registered_user_data_dynamic_hdr_plus(HEVCSEIDynamicHDRPlus *s,
211                                                         GetBitContext *gb, int size)
212 {
213     size_t meta_size;
214     int err;
215     AVDynamicHDRPlus *metadata = av_dynamic_hdr_plus_alloc(&meta_size);
216     if (!metadata)
217         return AVERROR(ENOMEM);
218
219     err = ff_parse_itu_t_t35_to_dynamic_hdr10_plus(gb, metadata);
220     if (err < 0) {
221         av_free(metadata);
222         return err;
223     }
224
225     av_buffer_unref(&s->info);
226     s->info = av_buffer_create((uint8_t *)metadata, meta_size, NULL, NULL, 0);
227     if (!s->info) {
228         av_free(metadata);
229         return AVERROR(ENOMEM);
230     }
231
232     return 0;
233 }
234
235 static int decode_nal_sei_user_data_registered_itu_t_t35(HEVCSEI *s, GetBitContext *gb,
236                                                          int size)
237 {
238     const uint8_t usa_country_code = 0xB5;
239     const uint16_t smpte_provider_code = 0x003C;
240
241     uint8_t country_code = 0;
242     uint16_t provider_code = 0;
243
244     if (size < 3)
245         return AVERROR(EINVAL);
246     size -= 3;
247
248     country_code = get_bits(gb, 8);
249     if (country_code == 0xFF) {
250         skip_bits(gb, 8);
251         size--;
252     }
253
254     provider_code = get_bits(gb, 16);
255
256     if (country_code == usa_country_code &&
257         provider_code == smpte_provider_code) {
258         // A/341 Amendment - 2094-40
259         const uint16_t smpte2094_40_provider_oriented_code = 0x0001;
260         const uint8_t smpte2094_40_application_identifier = 0x04;
261         uint16_t provider_oriented_code;
262         uint8_t application_identifier;
263
264         if (size < 3)
265             return AVERROR(EINVAL);
266         size -= 3;
267
268         provider_oriented_code = get_bits(gb, 16);
269         application_identifier = get_bits(gb, 8);
270         if (provider_oriented_code == smpte2094_40_provider_oriented_code &&
271             application_identifier == smpte2094_40_application_identifier) {
272             return decode_registered_user_data_dynamic_hdr_plus(&s->dynamic_hdr_plus, gb, size);
273         }
274     } else {
275         uint32_t user_identifier;
276
277         if (size < 4)
278             return AVERROR(EINVAL);
279         size -= 4;
280
281         user_identifier = get_bits_long(gb, 32);
282         switch (user_identifier) {
283         case MKBETAG('G', 'A', '9', '4'):
284             return decode_registered_user_data_closed_caption(&s->a53_caption, gb, size);
285         default:
286             break;
287         }
288     }
289     skip_bits_long(gb, size * 8);
290     return 0;
291 }
292
293 static int decode_nal_sei_active_parameter_sets(HEVCSEI *s, GetBitContext *gb, void *logctx)
294 {
295     int num_sps_ids_minus1;
296     int i;
297     unsigned active_seq_parameter_set_id;
298
299     get_bits(gb, 4); // active_video_parameter_set_id
300     get_bits(gb, 1); // self_contained_cvs_flag
301     get_bits(gb, 1); // num_sps_ids_minus1
302     num_sps_ids_minus1 = get_ue_golomb_long(gb); // num_sps_ids_minus1
303
304     if (num_sps_ids_minus1 < 0 || num_sps_ids_minus1 > 15) {
305         av_log(logctx, AV_LOG_ERROR, "num_sps_ids_minus1 %d invalid\n", num_sps_ids_minus1);
306         return AVERROR_INVALIDDATA;
307     }
308
309     active_seq_parameter_set_id = get_ue_golomb_long(gb);
310     if (active_seq_parameter_set_id >= HEVC_MAX_SPS_COUNT) {
311         av_log(logctx, AV_LOG_ERROR, "active_parameter_set_id %d invalid\n", active_seq_parameter_set_id);
312         return AVERROR_INVALIDDATA;
313     }
314     s->active_seq_parameter_set_id = active_seq_parameter_set_id;
315
316     for (i = 1; i <= num_sps_ids_minus1; i++)
317         get_ue_golomb_long(gb); // active_seq_parameter_set_id[i]
318
319     return 0;
320 }
321
322 static int decode_nal_sei_alternative_transfer(HEVCSEIAlternativeTransfer *s, GetBitContext *gb)
323 {
324     s->present = 1;
325     s->preferred_transfer_characteristics = get_bits(gb, 8);
326     return 0;
327 }
328
329 static int decode_nal_sei_timecode(HEVCSEITimeCode *s, GetBitContext *gb)
330 {
331     s->num_clock_ts = get_bits(gb, 2);
332
333     for (int i = 0; i < s->num_clock_ts; i++) {
334         s->clock_timestamp_flag[i] =  get_bits(gb, 1);
335
336         if (s->clock_timestamp_flag[i]) {
337             s->units_field_based_flag[i] = get_bits(gb, 1);
338             s->counting_type[i]          = get_bits(gb, 5);
339             s->full_timestamp_flag[i]    = get_bits(gb, 1);
340             s->discontinuity_flag[i]     = get_bits(gb, 1);
341             s->cnt_dropped_flag[i]       = get_bits(gb, 1);
342
343             s->n_frames[i]               = get_bits(gb, 9);
344
345             if (s->full_timestamp_flag[i]) {
346                 s->seconds_value[i]      = av_clip(get_bits(gb, 6), 0, 59);
347                 s->minutes_value[i]      = av_clip(get_bits(gb, 6), 0, 59);
348                 s->hours_value[i]        = av_clip(get_bits(gb, 5), 0, 23);
349             } else {
350                 s->seconds_flag[i] = get_bits(gb, 1);
351                 if (s->seconds_flag[i]) {
352                     s->seconds_value[i] = av_clip(get_bits(gb, 6), 0, 59);
353                     s->minutes_flag[i]  = get_bits(gb, 1);
354                     if (s->minutes_flag[i]) {
355                         s->minutes_value[i] = av_clip(get_bits(gb, 6), 0, 59);
356                         s->hours_flag[i] =  get_bits(gb, 1);
357                         if (s->hours_flag[i]) {
358                             s->hours_value[i] = av_clip(get_bits(gb, 5), 0, 23);
359                         }
360                     }
361                 }
362             }
363
364             s->time_offset_length[i] = get_bits(gb, 5);
365             if (s->time_offset_length[i] > 0) {
366                 s->time_offset_value[i] = get_bits(gb, s->time_offset_length[i]);
367             }
368         }
369     }
370
371     s->present = 1;
372     return 0;
373 }
374
375
376 static int decode_nal_sei_prefix(GetBitContext *gb, void *logctx, HEVCSEI *s,
377                                  const HEVCParamSets *ps, int type, int size)
378 {
379     switch (type) {
380     case 256:  // Mismatched value from HM 8.1
381         return decode_nal_sei_decoded_picture_hash(&s->picture_hash, gb);
382     case HEVC_SEI_TYPE_FRAME_PACKING:
383         return decode_nal_sei_frame_packing_arrangement(&s->frame_packing, gb);
384     case HEVC_SEI_TYPE_DISPLAY_ORIENTATION:
385         return decode_nal_sei_display_orientation(&s->display_orientation, gb);
386     case HEVC_SEI_TYPE_PICTURE_TIMING:
387         return decode_nal_sei_pic_timing(s, gb, ps, logctx, size);
388     case HEVC_SEI_TYPE_MASTERING_DISPLAY_INFO:
389         return decode_nal_sei_mastering_display_info(&s->mastering_display, gb);
390     case HEVC_SEI_TYPE_CONTENT_LIGHT_LEVEL_INFO:
391         return decode_nal_sei_content_light_info(&s->content_light, gb);
392     case HEVC_SEI_TYPE_ACTIVE_PARAMETER_SETS:
393         return decode_nal_sei_active_parameter_sets(s, gb, logctx);
394     case HEVC_SEI_TYPE_USER_DATA_REGISTERED_ITU_T_T35:
395         return decode_nal_sei_user_data_registered_itu_t_t35(s, gb, size);
396     case HEVC_SEI_TYPE_USER_DATA_UNREGISTERED:
397         return decode_nal_sei_user_data_unregistered(&s->unregistered, gb, size);
398     case HEVC_SEI_TYPE_ALTERNATIVE_TRANSFER_CHARACTERISTICS:
399         return decode_nal_sei_alternative_transfer(&s->alternative_transfer, gb);
400     case HEVC_SEI_TYPE_TIME_CODE:
401         return decode_nal_sei_timecode(&s->timecode, gb);
402     default:
403         av_log(logctx, AV_LOG_DEBUG, "Skipped PREFIX SEI %d\n", type);
404         skip_bits_long(gb, 8 * size);
405         return 0;
406     }
407 }
408
409 static int decode_nal_sei_suffix(GetBitContext *gb, void *logctx, HEVCSEI *s,
410                                  int type, int size)
411 {
412     switch (type) {
413     case HEVC_SEI_TYPE_DECODED_PICTURE_HASH:
414         return decode_nal_sei_decoded_picture_hash(&s->picture_hash, gb);
415     default:
416         av_log(logctx, AV_LOG_DEBUG, "Skipped SUFFIX SEI %d\n", type);
417         skip_bits_long(gb, 8 * size);
418         return 0;
419     }
420 }
421
422 static int decode_nal_sei_message(GetBitContext *gb, void *logctx, HEVCSEI *s,
423                                   const HEVCParamSets *ps, int nal_unit_type)
424 {
425     int payload_type = 0;
426     int payload_size = 0;
427     int byte = 0xFF;
428     av_log(logctx, AV_LOG_DEBUG, "Decoding SEI\n");
429
430     while (byte == 0xFF) {
431         if (get_bits_left(gb) < 16 || payload_type > INT_MAX - 255)
432             return AVERROR_INVALIDDATA;
433         byte          = get_bits(gb, 8);
434         payload_type += byte;
435     }
436     byte = 0xFF;
437     while (byte == 0xFF) {
438         if (get_bits_left(gb) < 8 + 8LL*payload_size)
439             return AVERROR_INVALIDDATA;
440         byte          = get_bits(gb, 8);
441         payload_size += byte;
442     }
443     if (nal_unit_type == HEVC_NAL_SEI_PREFIX) {
444         return decode_nal_sei_prefix(gb, logctx, s, ps, payload_type, payload_size);
445     } else { /* nal_unit_type == NAL_SEI_SUFFIX */
446         return decode_nal_sei_suffix(gb, logctx, s, payload_type, payload_size);
447     }
448 }
449
450 static int more_rbsp_data(GetBitContext *gb)
451 {
452     return get_bits_left(gb) > 0 && show_bits(gb, 8) != 0x80;
453 }
454
455 int ff_hevc_decode_nal_sei(GetBitContext *gb, void *logctx, HEVCSEI *s,
456                            const HEVCParamSets *ps, int type)
457 {
458     int ret;
459
460     do {
461         ret = decode_nal_sei_message(gb, logctx, s, ps, type);
462         if (ret < 0)
463             return ret;
464     } while (more_rbsp_data(gb));
465     return 1;
466 }
467
468 void ff_hevc_reset_sei(HEVCSEI *s)
469 {
470     av_buffer_unref(&s->a53_caption.buf_ref);
471
472     for (int i = 0; i < s->unregistered.nb_buf_ref; i++)
473         av_buffer_unref(&s->unregistered.buf_ref[i]);
474     s->unregistered.nb_buf_ref = 0;
475     av_freep(&s->unregistered.buf_ref);
476     av_buffer_unref(&s->dynamic_hdr_plus.info);
477 }