]> git.sesse.net Git - ffmpeg/blob - libavcodec/h264_sei.c
Merge commit '4012fe1ee819edc7689e182189e66c5401fb4b41'
[ffmpeg] / libavcodec / h264_sei.c
1 /*
2  * H.26L/H.264/AVC/JVT/14496-10/... sei decoding
3  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * H.264 / AVC / MPEG4 part10 sei decoding.
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #include "avcodec.h"
29 #include "get_bits.h"
30 #include "golomb.h"
31 #include "h264.h"
32 #include "h264_sei.h"
33 #include "internal.h"
34
35 static const uint8_t sei_num_clock_ts_table[9] = {
36     1, 1, 1, 2, 2, 3, 3, 2, 3
37 };
38
39 void ff_h264_sei_uninit(H264SEIContext *h)
40 {
41     h->recovery_point.recovery_frame_cnt = -1;
42
43     h->picture_timing.dpb_output_delay  = 0;
44     h->picture_timing.cpb_removal_delay = -1;
45
46     h->buffering_period.present    = 0;
47     h->frame_packing.present       = 0;
48     h->display_orientation.present = 0;
49     h->afd.present                 =  0;
50
51     h->a53_caption.a53_caption_size = 0;
52     av_freep(&h->a53_caption.a53_caption);
53 }
54
55 static int decode_picture_timing(H264SEIPictureTiming *h, GetBitContext *gb,
56                                  const H264ParamSets *ps, void *logctx)
57 {
58     int i;
59     const SPS *sps = ps->sps;
60
61     for (i = 0; i<MAX_SPS_COUNT; i++)
62         if ((!sps || !sps->log2_max_frame_num) && ps->sps_list[i])
63             sps = (const SPS *)ps->sps_list[i]->data;
64
65     if (!sps) {
66         av_log(logctx, AV_LOG_ERROR, "SPS unavailable in decode_picture_timing\n");
67         return 0;
68     }
69
70     if (sps->nal_hrd_parameters_present_flag ||
71         sps->vcl_hrd_parameters_present_flag) {
72         h->cpb_removal_delay = get_bits_long(gb, sps->cpb_removal_delay_length);
73         h->dpb_output_delay  = get_bits_long(gb, sps->dpb_output_delay_length);
74     }
75     if (sps->pic_struct_present_flag) {
76         unsigned int i, num_clock_ts;
77
78         h->pic_struct = get_bits(gb, 4);
79         h->ct_type    = 0;
80
81         if (h->pic_struct > SEI_PIC_STRUCT_FRAME_TRIPLING)
82             return AVERROR_INVALIDDATA;
83
84         num_clock_ts = sei_num_clock_ts_table[h->pic_struct];
85
86         for (i = 0; i < num_clock_ts; i++) {
87             if (get_bits(gb, 1)) {                /* clock_timestamp_flag */
88                 unsigned int full_timestamp_flag;
89
90                 h->ct_type |= 1 << get_bits(gb, 2);
91                 skip_bits(gb, 1);                 /* nuit_field_based_flag */
92                 skip_bits(gb, 5);                 /* counting_type */
93                 full_timestamp_flag = get_bits(gb, 1);
94                 skip_bits(gb, 1);                 /* discontinuity_flag */
95                 skip_bits(gb, 1);                 /* cnt_dropped_flag */
96                 skip_bits(gb, 8);                 /* n_frames */
97                 if (full_timestamp_flag) {
98                     skip_bits(gb, 6);             /* seconds_value 0..59 */
99                     skip_bits(gb, 6);             /* minutes_value 0..59 */
100                     skip_bits(gb, 5);             /* hours_value 0..23 */
101                 } else {
102                     if (get_bits(gb, 1)) {        /* seconds_flag */
103                         skip_bits(gb, 6);         /* seconds_value range 0..59 */
104                         if (get_bits(gb, 1)) {    /* minutes_flag */
105                             skip_bits(gb, 6);     /* minutes_value 0..59 */
106                             if (get_bits(gb, 1))  /* hours_flag */
107                                 skip_bits(gb, 5); /* hours_value 0..23 */
108                         }
109                     }
110                 }
111                 if (sps->time_offset_length > 0)
112                     skip_bits(gb,
113                               sps->time_offset_length); /* time_offset */
114             }
115         }
116
117         av_log(logctx, AV_LOG_DEBUG, "ct_type:%X pic_struct:%d\n",
118                h->ct_type, h->pic_struct);
119     }
120     return 0;
121 }
122
123 static int decode_registered_user_data_afd(H264SEIAFD *h, GetBitContext *gb, int size)
124 {
125     int flag;
126
127     if (size-- < 1)
128         return AVERROR_INVALIDDATA;
129     skip_bits(gb, 1);               // 0
130     flag = get_bits(gb, 1);         // active_format_flag
131     skip_bits(gb, 6);               // reserved
132
133     if (flag) {
134         if (size-- < 1)
135             return AVERROR_INVALIDDATA;
136         skip_bits(gb, 4);           // reserved
137         h->active_format_description = get_bits(gb, 4);
138         h->present                   = 1;
139     }
140
141     return 0;
142 }
143
144 static int decode_registered_user_data_closed_caption(H264SEIA53Caption *h,
145                                                      GetBitContext *gb, void *logctx,
146                                                      int size)
147 {
148     int flag;
149     int user_data_type_code;
150     int cc_count;
151
152     if (size < 3)
153         return AVERROR(EINVAL);
154
155     user_data_type_code = get_bits(gb, 8);
156     if (user_data_type_code == 0x3) {
157         skip_bits(gb, 1);           // reserved
158
159         flag = get_bits(gb, 1);     // process_cc_data_flag
160         if (flag) {
161             skip_bits(gb, 1);       // zero bit
162             cc_count = get_bits(gb, 5);
163             skip_bits(gb, 8);       // reserved
164             size -= 2;
165
166             if (cc_count && size >= cc_count * 3) {
167                 const uint64_t new_size = (h->a53_caption_size + cc_count
168                                            * UINT64_C(3));
169                 int i, ret;
170
171                 if (new_size > INT_MAX)
172                     return AVERROR(EINVAL);
173
174                 /* Allow merging of the cc data from two fields. */
175                 ret = av_reallocp(&h->a53_caption, new_size);
176                 if (ret < 0)
177                     return ret;
178
179                 for (i = 0; i < cc_count; i++) {
180                     h->a53_caption[h->a53_caption_size++] = get_bits(gb, 8);
181                     h->a53_caption[h->a53_caption_size++] = get_bits(gb, 8);
182                     h->a53_caption[h->a53_caption_size++] = get_bits(gb, 8);
183                 }
184
185                 skip_bits(gb, 8);   // marker_bits
186             }
187         }
188     } else {
189         int i;
190         for (i = 0; i < size - 1; i++)
191             skip_bits(gb, 8);
192     }
193
194     return 0;
195 }
196
197 static int decode_registered_user_data(H264SEIContext *h, GetBitContext *gb,
198                                        void *logctx, int size)
199 {
200     uint32_t country_code;
201     uint32_t user_identifier;
202
203     if (size < 7)
204         return AVERROR_INVALIDDATA;
205     size -= 7;
206
207     country_code = get_bits(gb, 8); // itu_t_t35_country_code
208     if (country_code == 0xFF) {
209         skip_bits(gb, 8);           // itu_t_t35_country_code_extension_byte
210         size--;
211     }
212
213     /* itu_t_t35_payload_byte follows */
214     skip_bits(gb, 8);              // terminal provider code
215     skip_bits(gb, 8);              // terminal provider oriented code
216     user_identifier = get_bits_long(gb, 32);
217
218     switch (user_identifier) {
219         case MKBETAG('D', 'T', 'G', '1'):       // afd_data
220             return decode_registered_user_data_afd(&h->afd, gb, size);
221         case MKBETAG('G', 'A', '9', '4'):       // closed captions
222             return decode_registered_user_data_closed_caption(&h->a53_caption, gb,
223                                                               logctx, size);
224         default:
225             skip_bits(gb, size * 8);
226             break;
227     }
228
229     return 0;
230 }
231
232 static int decode_unregistered_user_data(H264SEIUnregistered *h, GetBitContext *gb,
233                                          void *logctx, int size)
234 {
235     uint8_t *user_data;
236     int e, build, i;
237
238     if (size < 16 || size >= INT_MAX - 16)
239         return AVERROR_INVALIDDATA;
240
241     user_data = av_malloc(16 + size + 1);
242     if (!user_data)
243         return AVERROR(ENOMEM);
244
245     for (i = 0; i < size + 16; i++)
246         user_data[i] = get_bits(gb, 8);
247
248     user_data[i] = 0;
249     e = sscanf(user_data + 16, "x264 - core %d", &build);
250     if (e == 1 && build > 0)
251         h->x264_build = build;
252     if (e == 1 && build == 1 && !strncmp(user_data+16, "x264 - core 0000", 16))
253         h->x264_build = 67;
254
255     if (strlen(user_data + 16) > 0)
256         av_log(logctx, AV_LOG_DEBUG, "user data:\"%s\"\n", user_data + 16);
257
258     av_free(user_data);
259     return 0;
260 }
261
262 static int decode_recovery_point(H264SEIRecoveryPoint *h, GetBitContext *gb)
263 {
264     h->recovery_frame_cnt = get_ue_golomb_long(gb);
265
266     /* 1b exact_match_flag,
267      * 1b broken_link_flag,
268      * 2b changing_slice_group_idc */
269     skip_bits(gb, 4);
270
271     return 0;
272 }
273
274 static int decode_buffering_period(H264SEIBufferingPeriod *h, GetBitContext *gb,
275                                    const H264ParamSets *ps, void *logctx)
276 {
277     unsigned int sps_id;
278     int sched_sel_idx;
279     SPS *sps;
280
281     sps_id = get_ue_golomb_31(gb);
282     if (sps_id > 31 || !ps->sps_list[sps_id]) {
283         av_log(logctx, AV_LOG_ERROR,
284                "non-existing SPS %d referenced in buffering period\n", sps_id);
285         return AVERROR_INVALIDDATA;
286     }
287     sps = (SPS*)ps->sps_list[sps_id]->data;
288
289     // NOTE: This is really so duplicated in the standard... See H.264, D.1.1
290     if (sps->nal_hrd_parameters_present_flag) {
291         for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
292             h->initial_cpb_removal_delay[sched_sel_idx] =
293                 get_bits_long(gb, sps->initial_cpb_removal_delay_length);
294             // initial_cpb_removal_delay_offset
295             skip_bits(gb, sps->initial_cpb_removal_delay_length);
296         }
297     }
298     if (sps->vcl_hrd_parameters_present_flag) {
299         for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
300             h->initial_cpb_removal_delay[sched_sel_idx] =
301                 get_bits_long(gb, sps->initial_cpb_removal_delay_length);
302             // initial_cpb_removal_delay_offset
303             skip_bits(gb, sps->initial_cpb_removal_delay_length);
304         }
305     }
306
307     h->present = 1;
308     return 0;
309 }
310
311 static int decode_frame_packing_arrangement(H264SEIFramePacking *h,
312                                             GetBitContext *gb)
313 {
314     h->frame_packing_arrangement_id          = get_ue_golomb_long(gb);
315     h->frame_packing_arrangement_cancel_flag = get_bits1(gb);
316     h->present = !h->frame_packing_arrangement_cancel_flag;
317
318     if (h->present) {
319         h->frame_packing_arrangement_type = get_bits(gb, 7);
320         h->quincunx_sampling_flag         = get_bits1(gb);
321         h->content_interpretation_type    = get_bits(gb, 6);
322
323         // the following skips: spatial_flipping_flag, frame0_flipped_flag,
324         // field_views_flag, current_frame_is_frame0_flag,
325         // frame0_self_contained_flag, frame1_self_contained_flag
326         skip_bits(gb, 6);
327
328         if (!h->quincunx_sampling_flag && h->frame_packing_arrangement_type != 5)
329             skip_bits(gb, 16);      // frame[01]_grid_position_[xy]
330         skip_bits(gb, 8);           // frame_packing_arrangement_reserved_byte
331         h->frame_packing_arrangement_repetition_period = get_ue_golomb_long(gb);
332     }
333     skip_bits1(gb);                 // frame_packing_arrangement_extension_flag
334
335     return 0;
336 }
337
338 static int decode_display_orientation(H264SEIDisplayOrientation *h,
339                                       GetBitContext *gb)
340 {
341     h->present = !get_bits1(gb);
342
343     if (h->present) {
344         h->hflip = get_bits1(gb);     // hor_flip
345         h->vflip = get_bits1(gb);     // ver_flip
346
347         h->anticlockwise_rotation = get_bits(gb, 16);
348         get_ue_golomb_long(gb);       // display_orientation_repetition_period
349         skip_bits1(gb);               // display_orientation_extension_flag
350     }
351
352     return 0;
353 }
354
355 static int decode_green_metadata(H264SEIGreenMetaData *h, GetBitContext *gb)
356 {
357     h->green_metadata_type = get_bits(gb, 8);
358
359     if (h->green_metadata_type == 0) {
360         h->period_type = get_bits(gb, 8);
361
362         if (h->period_type == 2)
363             h->num_seconds = get_bits(gb, 16);
364         else if (h->period_type == 3)
365             h->num_pictures = get_bits(gb, 16);
366
367         h->percent_non_zero_macroblocks            = get_bits(gb, 8);
368         h->percent_intra_coded_macroblocks         = get_bits(gb, 8);
369         h->percent_six_tap_filtering               = get_bits(gb, 8);
370         h->percent_alpha_point_deblocking_instance = get_bits(gb, 8);
371
372     } else if (h->green_metadata_type == 1) {
373         h->xsd_metric_type  = get_bits(gb, 8);
374         h->xsd_metric_value = get_bits(gb, 16);
375     }
376
377     return 0;
378 }
379
380 int ff_h264_sei_decode(H264SEIContext *h, GetBitContext *gb,
381                        const H264ParamSets *ps, void *logctx)
382 {
383     while (get_bits_left(gb) > 16 && show_bits(gb, 16)) {
384         int type = 0;
385         unsigned size = 0;
386         unsigned next;
387         int ret  = 0;
388
389         do {
390             if (get_bits_left(gb) < 8)
391                 return AVERROR_INVALIDDATA;
392             type += show_bits(gb, 8);
393         } while (get_bits(gb, 8) == 255);
394
395         do {
396             if (get_bits_left(gb) < 8)
397                 return AVERROR_INVALIDDATA;
398             size += show_bits(gb, 8);
399         } while (get_bits(gb, 8) == 255);
400
401         if (size > get_bits_left(gb) / 8) {
402             av_log(logctx, AV_LOG_ERROR, "SEI type %d size %d truncated at %d\n",
403                    type, 8*size, get_bits_left(gb));
404             return AVERROR_INVALIDDATA;
405         }
406         next = get_bits_count(gb) + 8 * size;
407
408         switch (type) {
409         case SEI_TYPE_PIC_TIMING: // Picture timing SEI
410             ret = decode_picture_timing(&h->picture_timing, gb, ps, logctx);
411             break;
412         case SEI_TYPE_USER_DATA_REGISTERED:
413             ret = decode_registered_user_data(h, gb, logctx, size);
414             break;
415         case SEI_TYPE_USER_DATA_UNREGISTERED:
416             ret = decode_unregistered_user_data(&h->unregistered, gb, logctx, size);
417             break;
418         case SEI_TYPE_RECOVERY_POINT:
419             ret = decode_recovery_point(&h->recovery_point, gb);
420             break;
421         case SEI_TYPE_BUFFERING_PERIOD:
422             ret = decode_buffering_period(&h->buffering_period, gb, ps, logctx);
423             break;
424         case SEI_TYPE_FRAME_PACKING:
425             ret = decode_frame_packing_arrangement(&h->frame_packing, gb);
426             break;
427         case SEI_TYPE_DISPLAY_ORIENTATION:
428             ret = decode_display_orientation(&h->display_orientation, gb);
429             break;
430         case SEI_TYPE_GREEN_METADATA:
431             ret = decode_green_metadata(&h->green_metadata, gb);
432             break;
433         default:
434             av_log(logctx, AV_LOG_DEBUG, "unknown SEI type %d\n", type);
435         }
436         if (ret < 0)
437             return ret;
438
439         skip_bits_long(gb, next - get_bits_count(gb));
440
441         // FIXME check bits here
442         align_get_bits(gb);
443     }
444
445     return 0;
446 }
447
448 const char *ff_h264_sei_stereo_mode(const H264SEIFramePacking *h)
449 {
450     if (h->frame_packing_arrangement_cancel_flag == 0) {
451         switch (h->frame_packing_arrangement_type) {
452             case SEI_FPA_TYPE_CHECKERBOARD:
453                 if (h->content_interpretation_type == 2)
454                     return "checkerboard_rl";
455                 else
456                     return "checkerboard_lr";
457             case SEI_FPA_TYPE_INTERLEAVE_COLUMN:
458                 if (h->content_interpretation_type == 2)
459                     return "col_interleaved_rl";
460                 else
461                     return "col_interleaved_lr";
462             case SEI_FPA_TYPE_INTERLEAVE_ROW:
463                 if (h->content_interpretation_type == 2)
464                     return "row_interleaved_rl";
465                 else
466                     return "row_interleaved_lr";
467             case SEI_FPA_TYPE_SIDE_BY_SIDE:
468                 if (h->content_interpretation_type == 2)
469                     return "right_left";
470                 else
471                     return "left_right";
472             case SEI_FPA_TYPE_TOP_BOTTOM:
473                 if (h->content_interpretation_type == 2)
474                     return "bottom_top";
475                 else
476                     return "top_bottom";
477             case SEI_FPA_TYPE_INTERLEAVE_TEMPORAL:
478                 if (h->content_interpretation_type == 2)
479                     return "block_rl";
480                 else
481                     return "block_lr";
482             case SEI_FPA_TYPE_2D:
483             default:
484                 return "mono";
485         }
486     } else if (h->frame_packing_arrangement_cancel_flag == 1) {
487         return "mono";
488     } else {
489         return NULL;
490     }
491 }