cd55d50212547fcfe868863e585609250aa4a46b
[ffmpeg.git] / 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 "golomb.h"
26 #include "hevc_ps.h"
27 #include "hevc_sei.h"
28
29 static int decode_nal_sei_decoded_picture_hash(HEVCSEIPictureHash *s, GetBitContext *gb)
30 {
31     int cIdx, i;
32     uint8_t hash_type;
33     //uint16_t picture_crc;
34     //uint32_t picture_checksum;
35     hash_type = get_bits(gb, 8);
36
37     for (cIdx = 0; cIdx < 3/*((s->sps->chroma_format_idc == 0) ? 1 : 3)*/; cIdx++) {
38         if (hash_type == 0) {
39             s->is_md5 = 1;
40             for (i = 0; i < 16; i++)
41                 s->md5[cIdx][i] = get_bits(gb, 8);
42         } else if (hash_type == 1) {
43             // picture_crc = get_bits(gb, 16);
44             skip_bits(gb, 16);
45         } else if (hash_type == 2) {
46             // picture_checksum = get_bits_long(gb, 32);
47             skip_bits(gb, 32);
48         }
49     }
50     return 0;
51 }
52
53 static int decode_nal_sei_mastering_display_info(HEVCSEIMasteringDisplay *s, GetBitContext *gb)
54 {
55     int i;
56     // Mastering primaries
57     for (i = 0; i < 3; i++) {
58         s->display_primaries[i][0] = get_bits(gb, 16);
59         s->display_primaries[i][1] = get_bits(gb, 16);
60     }
61     // White point (x, y)
62     s->white_point[0] = get_bits(gb, 16);
63     s->white_point[1] = get_bits(gb, 16);
64
65     // Max and min luminance of mastering display
66     s->max_luminance = get_bits_long(gb, 32);
67     s->min_luminance = get_bits_long(gb, 32);
68
69     // As this SEI message comes before the first frame that references it,
70     // initialize the flag to 2 and decrement on IRAP access unit so it
71     // persists for the coded video sequence (e.g., between two IRAPs)
72     s->present = 2;
73     return 0;
74 }
75
76 static int decode_nal_sei_content_light_info(HEVCSEIContentLight *s, GetBitContext *gb)
77 {
78     // Max and average light levels
79     s->max_content_light_level     = get_bits_long(gb, 16);
80     s->max_pic_average_light_level = get_bits_long(gb, 16);
81     // As this SEI message comes before the first frame that references it,
82     // initialize the flag to 2 and decrement on IRAP access unit so it
83     // persists for the coded video sequence (e.g., between two IRAPs)
84     s->present = 2;
85     return  0;
86 }
87
88 static int decode_nal_sei_frame_packing_arrangement(HEVCSEIFramePacking *s, GetBitContext *gb)
89 {
90     get_ue_golomb_long(gb);             // frame_packing_arrangement_id
91     s->present = !get_bits1(gb);
92
93     if (s->present) {
94         s->arrangement_type               = get_bits(gb, 7);
95         s->quincunx_subsampling           = get_bits1(gb);
96         s->content_interpretation_type    = get_bits(gb, 6);
97
98         // the following skips spatial_flipping_flag frame0_flipped_flag
99         // field_views_flag current_frame_is_frame0_flag
100         // frame0_self_contained_flag frame1_self_contained_flag
101         skip_bits(gb, 6);
102
103         if (!s->quincunx_subsampling && s->arrangement_type != 5)
104             skip_bits(gb, 16);  // frame[01]_grid_position_[xy]
105         skip_bits(gb, 8);       // frame_packing_arrangement_reserved_byte
106         skip_bits1(gb);         // frame_packing_arrangement_persistence_flag
107     }
108     skip_bits1(gb);             // upsampled_aspect_ratio_flag
109     return 0;
110 }
111
112 static int decode_nal_sei_display_orientation(HEVCSEIDisplayOrientation *s, GetBitContext *gb)
113 {
114     s->present = !get_bits1(gb);
115
116     if (s->present) {
117         s->hflip = get_bits1(gb);     // hor_flip
118         s->vflip = get_bits1(gb);     // ver_flip
119
120         s->anticlockwise_rotation = get_bits(gb, 16);
121         skip_bits1(gb);     // display_orientation_persistence_flag
122     }
123
124     return 0;
125 }
126
127 static int decode_nal_sei_pic_timing(HEVCSEIContext *s, GetBitContext *gb, const HEVCParamSets *ps,
128                                      void *logctx, int size)
129 {
130     HEVCSEIPictureTiming *h = &s->picture_timing;
131     HEVCSPS *sps;
132
133     if (!ps->sps_list[s->active_seq_parameter_set_id])
134         return(AVERROR(ENOMEM));
135     sps = (HEVCSPS*)ps->sps_list[s->active_seq_parameter_set_id]->data;
136
137     if (sps->vui.frame_field_info_present_flag) {
138         int pic_struct = get_bits(gb, 4);
139         h->picture_struct = AV_PICTURE_STRUCTURE_UNKNOWN;
140         if (pic_struct == 2) {
141             av_log(logctx, AV_LOG_DEBUG, "BOTTOM Field\n");
142             h->picture_struct = AV_PICTURE_STRUCTURE_BOTTOM_FIELD;
143         } else if (pic_struct == 1) {
144             av_log(logctx, AV_LOG_DEBUG, "TOP Field\n");
145             h->picture_struct = AV_PICTURE_STRUCTURE_TOP_FIELD;
146         }
147         get_bits(gb, 2);                   // source_scan_type
148         get_bits(gb, 1);                   // duplicate_flag
149         skip_bits1(gb);
150         size--;
151     }
152     skip_bits_long(gb, 8 * size);
153
154     return 0;
155 }
156
157 static int decode_registered_user_data_closed_caption(HEVCSEIA53Caption *s, GetBitContext *gb,
158                                                       int size)
159 {
160     int flag;
161     int user_data_type_code;
162     int cc_count;
163
164     if (size < 3)
165        return AVERROR(EINVAL);
166
167     user_data_type_code = get_bits(gb, 8);
168     if (user_data_type_code == 0x3) {
169         skip_bits(gb, 1); // reserved
170
171         flag = get_bits(gb, 1); // process_cc_data_flag
172         if (flag) {
173             skip_bits(gb, 1);
174             cc_count = get_bits(gb, 5);
175             skip_bits(gb, 8); // reserved
176             size -= 2;
177
178             if (cc_count && size >= cc_count * 3) {
179                 const uint64_t new_size = (s->a53_caption_size + cc_count
180                                            * UINT64_C(3));
181                 int i, ret;
182
183                 if (new_size > INT_MAX)
184                     return AVERROR(EINVAL);
185
186                 /* Allow merging of the cc data from two fields. */
187                 ret = av_reallocp(&s->a53_caption, new_size);
188                 if (ret < 0)
189                     return ret;
190
191                 for (i = 0; i < cc_count; i++) {
192                     s->a53_caption[s->a53_caption_size++] = get_bits(gb, 8);
193                     s->a53_caption[s->a53_caption_size++] = get_bits(gb, 8);
194                     s->a53_caption[s->a53_caption_size++] = get_bits(gb, 8);
195                 }
196                 skip_bits(gb, 8); // marker_bits
197             }
198         }
199     } else {
200         int i;
201         for (i = 0; i < size - 1; i++)
202             skip_bits(gb, 8);
203     }
204
205     return 0;
206 }
207
208 static int decode_nal_sei_user_data_registered_itu_t_t35(HEVCSEIContext *s, GetBitContext *gb,
209                                                          int size)
210 {
211     uint32_t country_code;
212     uint32_t user_identifier;
213
214     if (size < 7)
215         return AVERROR(EINVAL);
216     size -= 7;
217
218     country_code = get_bits(gb, 8);
219     if (country_code == 0xFF) {
220         skip_bits(gb, 8);
221         size--;
222     }
223
224     skip_bits(gb, 8);
225     skip_bits(gb, 8);
226
227     user_identifier = get_bits_long(gb, 32);
228
229     switch (user_identifier) {
230         case MKBETAG('G', 'A', '9', '4'):
231             return decode_registered_user_data_closed_caption(&s->a53_caption, gb, size);
232         default:
233             skip_bits_long(gb, size * 8);
234             break;
235     }
236     return 0;
237 }
238
239 static int decode_nal_sei_active_parameter_sets(HEVCSEIContext *s, GetBitContext *gb, void *logctx)
240 {
241     int num_sps_ids_minus1;
242     int i;
243     unsigned active_seq_parameter_set_id;
244
245     get_bits(gb, 4); // active_video_parameter_set_id
246     get_bits(gb, 1); // self_contained_cvs_flag
247     get_bits(gb, 1); // num_sps_ids_minus1
248     num_sps_ids_minus1 = get_ue_golomb_long(gb); // num_sps_ids_minus1
249
250     if (num_sps_ids_minus1 < 0 || num_sps_ids_minus1 > 15) {
251         av_log(logctx, AV_LOG_ERROR, "num_sps_ids_minus1 %d invalid\n", num_sps_ids_minus1);
252         return AVERROR_INVALIDDATA;
253     }
254
255     active_seq_parameter_set_id = get_ue_golomb_long(gb);
256     if (active_seq_parameter_set_id >= HEVC_MAX_SPS_COUNT) {
257         av_log(logctx, AV_LOG_ERROR, "active_parameter_set_id %d invalid\n", active_seq_parameter_set_id);
258         return AVERROR_INVALIDDATA;
259     }
260     s->active_seq_parameter_set_id = active_seq_parameter_set_id;
261
262     for (i = 1; i <= num_sps_ids_minus1; i++)
263         get_ue_golomb_long(gb); // active_seq_parameter_set_id[i]
264
265     return 0;
266 }
267
268 static int decode_nal_sei_alternative_transfer(HEVCSEIAlternativeTransfer *s, GetBitContext *gb)
269 {
270     s->present = 1;
271     s->preferred_transfer_characteristics = get_bits(gb, 8);
272     return 0;
273 }
274
275 static int decode_nal_sei_prefix(GetBitContext *gb, HEVCSEIContext *s, const HEVCParamSets *ps,
276                                  int type, int size, void *logctx)
277 {
278     switch (type) {
279     case 256:  // Mismatched value from HM 8.1
280         return decode_nal_sei_decoded_picture_hash(&s->picture_hash, gb);
281     case HEVC_SEI_TYPE_FRAME_PACKING:
282         return decode_nal_sei_frame_packing_arrangement(&s->frame_packing, gb);
283     case HEVC_SEI_TYPE_DISPLAY_ORIENTATION:
284         return decode_nal_sei_display_orientation(&s->display_orientation, gb);
285     case HEVC_SEI_TYPE_PICTURE_TIMING:
286         return decode_nal_sei_pic_timing(s, gb, ps, logctx, size);
287     case HEVC_SEI_TYPE_MASTERING_DISPLAY_INFO:
288         return decode_nal_sei_mastering_display_info(&s->mastering_display, gb);
289     case HEVC_SEI_TYPE_CONTENT_LIGHT_LEVEL_INFO:
290         return decode_nal_sei_content_light_info(&s->content_light, gb);
291     case HEVC_SEI_TYPE_ACTIVE_PARAMETER_SETS:
292         return decode_nal_sei_active_parameter_sets(s, gb, logctx);
293     case HEVC_SEI_TYPE_USER_DATA_REGISTERED_ITU_T_T35:
294         return decode_nal_sei_user_data_registered_itu_t_t35(s, gb, size);
295     case HEVC_SEI_TYPE_ALTERNATIVE_TRANSFER_CHARACTERISTICS:
296         return decode_nal_sei_alternative_transfer(&s->alternative_transfer, gb);
297     default:
298         av_log(logctx, AV_LOG_DEBUG, "Skipped PREFIX SEI %d\n", type);
299         skip_bits_long(gb, 8 * size);
300         return 0;
301     }
302 }
303
304 static int decode_nal_sei_suffix(GetBitContext *gb, HEVCSEIContext *s,
305                                  int type, int size, void *logctx)
306 {
307     switch (type) {
308     case HEVC_SEI_TYPE_DECODED_PICTURE_HASH:
309         return decode_nal_sei_decoded_picture_hash(&s->picture_hash, gb);
310     default:
311         av_log(logctx, AV_LOG_DEBUG, "Skipped SUFFIX SEI %d\n", type);
312         skip_bits_long(gb, 8 * size);
313         return 0;
314     }
315 }
316
317 static int decode_nal_sei_message(GetBitContext *gb, HEVCSEIContext *s,
318                                   const HEVCParamSets *ps, int nal_unit_type,
319                                   void *logctx)
320 {
321     int payload_type = 0;
322     int payload_size = 0;
323     int byte = 0xFF;
324     av_log(logctx, AV_LOG_DEBUG, "Decoding SEI\n");
325
326     while (byte == 0xFF) {
327         byte          = get_bits(gb, 8);
328         payload_type += byte;
329     }
330     byte = 0xFF;
331     while (byte == 0xFF) {
332         byte          = get_bits(gb, 8);
333         payload_size += byte;
334     }
335     if (nal_unit_type == HEVC_NAL_SEI_PREFIX) {
336         return decode_nal_sei_prefix(gb, s, ps, payload_type, payload_size, logctx);
337     } else { /* nal_unit_type == NAL_SEI_SUFFIX */
338         return decode_nal_sei_suffix(gb, s, payload_type, payload_size, logctx);
339     }
340 }
341
342 static int more_rbsp_data(GetBitContext *gb)
343 {
344     return get_bits_left(gb) > 0 && show_bits(gb, 8) != 0x80;
345 }
346
347 int ff_hevc_decode_nal_sei(GetBitContext *gb, void *logctx, HEVCSEIContext *s,
348                            const HEVCParamSets *ps, int type)
349 {
350     int ret;
351
352     do {
353         ret = decode_nal_sei_message(gb, s, ps, type, logctx);
354         if (ret < 0)
355             return ret;
356     } while (more_rbsp_data(gb));
357     return 1;
358 }
359
360 void ff_hevc_reset_sei(HEVCSEIContext *s)
361 {
362     s->a53_caption.a53_caption_size = 0;
363     av_freep(&s->a53_caption.a53_caption);
364 }