hevc: extract SEI caption data
[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.h"
27
28 enum HEVC_SEI_TYPE {
29     SEI_TYPE_BUFFERING_PERIOD                     = 0,
30     SEI_TYPE_PICTURE_TIMING                       = 1,
31     SEI_TYPE_PAN_SCAN_RECT                        = 2,
32     SEI_TYPE_FILLER_PAYLOAD                       = 3,
33     SEI_TYPE_USER_DATA_REGISTERED_ITU_T_T35       = 4,
34     SEI_TYPE_USER_DATA_UNREGISTERED               = 5,
35     SEI_TYPE_RECOVERY_POINT                       = 6,
36     SEI_TYPE_SCENE_INFO                           = 9,
37     SEI_TYPE_FULL_FRAME_SNAPSHOT                  = 15,
38     SEI_TYPE_PROGRESSIVE_REFINEMENT_SEGMENT_START = 16,
39     SEI_TYPE_PROGRESSIVE_REFINEMENT_SEGMENT_END   = 17,
40     SEI_TYPE_FILM_GRAIN_CHARACTERISTICS           = 19,
41     SEI_TYPE_POST_FILTER_HINT                     = 22,
42     SEI_TYPE_TONE_MAPPING_INFO                    = 23,
43     SEI_TYPE_FRAME_PACKING                        = 45,
44     SEI_TYPE_DISPLAY_ORIENTATION                  = 47,
45     SEI_TYPE_SOP_DESCRIPTION                      = 128,
46     SEI_TYPE_ACTIVE_PARAMETER_SETS                = 129,
47     SEI_TYPE_DECODING_UNIT_INFO                   = 130,
48     SEI_TYPE_TEMPORAL_LEVEL0_INDEX                = 131,
49     SEI_TYPE_DECODED_PICTURE_HASH                 = 132,
50     SEI_TYPE_SCALABLE_NESTING                     = 133,
51     SEI_TYPE_REGION_REFRESH_INFO                  = 134,
52     SEI_TYPE_MASTERING_DISPLAY_INFO               = 137,
53     SEI_TYPE_CONTENT_LIGHT_LEVEL_INFO             = 144,
54 };
55
56 static int decode_nal_sei_decoded_picture_hash(HEVCContext *s)
57 {
58     int cIdx, i;
59     uint8_t hash_type;
60     //uint16_t picture_crc;
61     //uint32_t picture_checksum;
62     GetBitContext *gb = &s->HEVClc->gb;
63     hash_type = get_bits(gb, 8);
64
65     for (cIdx = 0; cIdx < 3/*((s->sps->chroma_format_idc == 0) ? 1 : 3)*/; cIdx++) {
66         if (hash_type == 0) {
67             s->is_md5 = 1;
68             for (i = 0; i < 16; i++)
69                 s->md5[cIdx][i] = get_bits(gb, 8);
70         } else if (hash_type == 1) {
71             // picture_crc = get_bits(gb, 16);
72             skip_bits(gb, 16);
73         } else if (hash_type == 2) {
74             // picture_checksum = get_bits_long(gb, 32);
75             skip_bits(gb, 32);
76         }
77     }
78     return 0;
79 }
80
81 static int decode_nal_sei_frame_packing_arrangement(HEVCContext *s)
82 {
83     GetBitContext *gb = &s->HEVClc->gb;
84
85     get_ue_golomb(gb);                  // frame_packing_arrangement_id
86     s->sei_frame_packing_present = !get_bits1(gb);
87
88     if (s->sei_frame_packing_present) {
89         s->frame_packing_arrangement_type = get_bits(gb, 7);
90         s->quincunx_subsampling           = get_bits1(gb);
91         s->content_interpretation_type    = get_bits(gb, 6);
92
93         // the following skips spatial_flipping_flag frame0_flipped_flag
94         // field_views_flag current_frame_is_frame0_flag
95         // frame0_self_contained_flag frame1_self_contained_flag
96         skip_bits(gb, 6);
97
98         if (!s->quincunx_subsampling && s->frame_packing_arrangement_type != 5)
99             skip_bits(gb, 16);  // frame[01]_grid_position_[xy]
100         skip_bits(gb, 8);       // frame_packing_arrangement_reserved_byte
101         skip_bits1(gb);         // frame_packing_arrangement_persistance_flag
102     }
103     skip_bits1(gb);             // upsampled_aspect_ratio_flag
104     return 0;
105 }
106
107 static int decode_nal_sei_display_orientation(HEVCContext *s)
108 {
109     GetBitContext *gb = &s->HEVClc->gb;
110
111     s->sei_display_orientation_present = !get_bits1(gb);
112
113     if (s->sei_display_orientation_present) {
114         s->sei_hflip = get_bits1(gb);     // hor_flip
115         s->sei_vflip = get_bits1(gb);     // ver_flip
116
117         s->sei_anticlockwise_rotation = get_bits(gb, 16);
118         skip_bits1(gb);     // display_orientation_persistence_flag
119     }
120
121     return 0;
122 }
123
124 static int decode_pic_timing(HEVCContext *s)
125 {
126     GetBitContext *gb = &s->HEVClc->gb;
127     HEVCSPS *sps;
128
129     if (!s->ps.sps_list[s->active_seq_parameter_set_id])
130         return(AVERROR(ENOMEM));
131     sps = (HEVCSPS*)s->ps.sps_list[s->active_seq_parameter_set_id]->data;
132
133     if (sps->vui.frame_field_info_present_flag) {
134         int pic_struct = get_bits(gb, 4);
135         s->picture_struct = AV_PICTURE_STRUCTURE_UNKNOWN;
136         if (pic_struct == 2) {
137             av_log(s->avctx, AV_LOG_DEBUG, "BOTTOM Field\n");
138             s->picture_struct = AV_PICTURE_STRUCTURE_BOTTOM_FIELD;
139         } else if (pic_struct == 1) {
140             av_log(s->avctx, AV_LOG_DEBUG, "TOP Field\n");
141             s->picture_struct = AV_PICTURE_STRUCTURE_TOP_FIELD;
142         }
143         get_bits(gb, 2);                   // source_scan_type
144         get_bits(gb, 1);                   // duplicate_flag
145     }
146     return 1;
147 }
148
149 static int decode_registered_user_data_closed_caption(HEVCContext *s, int size)
150 {
151     int flag;
152     int user_data_type_code;
153     int cc_count;
154     int i;
155
156     GetBitContext *gb = &s->HEVClc->gb;
157
158     if (size < 3)
159        return AVERROR(EINVAL);
160
161     user_data_type_code = get_bits(gb, 8);
162     if (user_data_type_code == 0x3) {
163         skip_bits(gb, 1); // reserved
164
165         flag = get_bits(gb, 1); // process_cc_data_flag
166         if (flag) {
167             skip_bits(gb, 1);
168             cc_count = get_bits(gb, 5);
169             skip_bits(gb, 8); // reserved
170             size -= 2;
171
172             if (cc_count && size >= cc_count * 3) {
173                 av_freep(&s->a53_caption);
174                 s->a53_caption_size = cc_count * 3;
175
176                 s->a53_caption = av_malloc(s->a53_caption_size);
177                 if (!s->a53_caption)
178                     return(AVERROR(ENOMEM));
179
180                 for (i = 0; i < s->a53_caption_size; i++) {
181                     s->a53_caption[i++] = get_bits(gb, 8);
182                 }
183                 skip_bits(gb, 8); // marker_bits
184             }
185         }
186     } else {
187         for (i = 0; i < size - 1; i++)
188             skip_bits(gb, 8);
189     }
190
191     return 0;
192 }
193
194 static int decode_nal_sei_user_data_registered_itu_t_t35(HEVCContext *s, int size)
195 {
196     uint32_t country_code;
197     uint32_t user_identifier;
198
199     GetBitContext *gb = &s->HEVClc->gb;
200
201     if (size < 7)
202         return AVERROR(EINVAL);
203     size -= 7;
204
205     country_code = get_bits(gb, 8);
206     if (country_code == 0xFF) {
207         skip_bits(gb, 8);
208         size--;
209     }
210
211     skip_bits(gb, 8);
212     skip_bits(gb, 8);
213
214     user_identifier = get_bits_long(gb, 32);
215
216     switch (user_identifier) {
217         case MKBETAG('G', 'A', '9', '4'):
218             return decode_registered_user_data_closed_caption(s, size);
219         default:
220             skip_bits_long(gb, size * 8);
221             break;
222     }
223     return 0;
224 }
225
226 static int active_parameter_sets(HEVCContext *s)
227 {
228     GetBitContext *gb = &s->HEVClc->gb;
229     int num_sps_ids_minus1;
230     int i;
231     unsigned active_seq_parameter_set_id;
232
233     get_bits(gb, 4); // active_video_parameter_set_id
234     get_bits(gb, 1); // self_contained_cvs_flag
235     get_bits(gb, 1); // num_sps_ids_minus1
236     num_sps_ids_minus1 = get_ue_golomb_long(gb); // num_sps_ids_minus1
237
238     if (num_sps_ids_minus1 < 0 || num_sps_ids_minus1 > 15) {
239         av_log(s->avctx, AV_LOG_ERROR, "num_sps_ids_minus1 %d invalid\n", num_sps_ids_minus1);
240         return AVERROR_INVALIDDATA;
241     }
242
243     active_seq_parameter_set_id = get_ue_golomb_long(gb);
244     if (active_seq_parameter_set_id >= MAX_SPS_COUNT) {
245         av_log(s->avctx, AV_LOG_ERROR, "active_parameter_set_id %d invalid\n", active_seq_parameter_set_id);
246         return AVERROR_INVALIDDATA;
247     }
248     s->active_seq_parameter_set_id = active_seq_parameter_set_id;
249
250     for (i = 1; i <= num_sps_ids_minus1; i++)
251         get_ue_golomb_long(gb); // active_seq_parameter_set_id[i]
252
253     return 0;
254 }
255
256 static int decode_nal_sei_prefix(HEVCContext *s, int type, int size)
257 {
258     GetBitContext *gb = &s->HEVClc->gb;
259
260     switch (type) {
261     case 256:  // Mismatched value from HM 8.1
262         return decode_nal_sei_decoded_picture_hash(s);
263     case SEI_TYPE_FRAME_PACKING:
264         return decode_nal_sei_frame_packing_arrangement(s);
265     case SEI_TYPE_DISPLAY_ORIENTATION:
266         return decode_nal_sei_display_orientation(s);
267     case SEI_TYPE_PICTURE_TIMING:
268         {
269             int ret = decode_pic_timing(s);
270             av_log(s->avctx, AV_LOG_DEBUG, "Skipped PREFIX SEI %d\n", type);
271             skip_bits(gb, 8 * size);
272             return ret;
273         }
274     case SEI_TYPE_ACTIVE_PARAMETER_SETS:
275         active_parameter_sets(s);
276         av_log(s->avctx, AV_LOG_DEBUG, "Skipped PREFIX SEI %d\n", type);
277         return 0;
278     case SEI_TYPE_USER_DATA_REGISTERED_ITU_T_T35:
279         return decode_nal_sei_user_data_registered_itu_t_t35(s, size);
280     default:
281         av_log(s->avctx, AV_LOG_DEBUG, "Skipped PREFIX SEI %d\n", type);
282         skip_bits_long(gb, 8 * size);
283         return 0;
284     }
285 }
286
287 static int decode_nal_sei_suffix(HEVCContext *s, int type, int size)
288 {
289     GetBitContext *gb = &s->HEVClc->gb;
290
291     switch (type) {
292     case SEI_TYPE_DECODED_PICTURE_HASH:
293         return decode_nal_sei_decoded_picture_hash(s);
294     default:
295         av_log(s->avctx, AV_LOG_DEBUG, "Skipped SUFFIX SEI %d\n", type);
296         skip_bits_long(gb, 8 * size);
297         return 0;
298     }
299 }
300
301 static int decode_nal_sei_message(HEVCContext *s)
302 {
303     GetBitContext *gb = &s->HEVClc->gb;
304
305     int payload_type = 0;
306     int payload_size = 0;
307     int byte = 0xFF;
308     av_log(s->avctx, AV_LOG_DEBUG, "Decoding SEI\n");
309
310     while (byte == 0xFF) {
311         byte          = get_bits(gb, 8);
312         payload_type += byte;
313     }
314     byte = 0xFF;
315     while (byte == 0xFF) {
316         byte          = get_bits(gb, 8);
317         payload_size += byte;
318     }
319     if (s->nal_unit_type == NAL_SEI_PREFIX) {
320         return decode_nal_sei_prefix(s, payload_type, payload_size);
321     } else { /* nal_unit_type == NAL_SEI_SUFFIX */
322         return decode_nal_sei_suffix(s, payload_type, payload_size);
323     }
324     return 1;
325 }
326
327 static int more_rbsp_data(GetBitContext *gb)
328 {
329     return get_bits_left(gb) > 0 && show_bits(gb, 8) != 0x80;
330 }
331
332 int ff_hevc_decode_nal_sei(HEVCContext *s)
333 {
334     int ret;
335
336     do {
337         ret = decode_nal_sei_message(s);
338         if (ret < 0)
339             return(AVERROR(ENOMEM));
340     } while (more_rbsp_data(&s->HEVClc->gb));
341     return 1;
342 }