]> git.sesse.net Git - ffmpeg/blob - libavcodec/h264_sei.c
doc/APIchanges: fill in missing hashes and dates
[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 Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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 "internal.h"
29 #include "avcodec.h"
30 #include "h264.h"
31 #include "golomb.h"
32
33 #include <assert.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_reset_sei(H264Context *h)
40 {
41     h->sei_recovery_frame_cnt       = -1;
42     h->sei_dpb_output_delay         =  0;
43     h->sei_cpb_removal_delay        = -1;
44     h->sei_buffering_period_present =  0;
45     h->sei_frame_packing_present    =  0;
46 }
47
48 static int decode_picture_timing(H264Context *h)
49 {
50     if (h->sps.nal_hrd_parameters_present_flag ||
51         h->sps.vcl_hrd_parameters_present_flag) {
52         h->sei_cpb_removal_delay = get_bits(&h->gb,
53                                             h->sps.cpb_removal_delay_length);
54         h->sei_dpb_output_delay  = get_bits(&h->gb,
55                                             h->sps.dpb_output_delay_length);
56     }
57     if (h->sps.pic_struct_present_flag) {
58         unsigned int i, num_clock_ts;
59
60         h->sei_pic_struct = get_bits(&h->gb, 4);
61         h->sei_ct_type    = 0;
62
63         if (h->sei_pic_struct > SEI_PIC_STRUCT_FRAME_TRIPLING)
64             return AVERROR_INVALIDDATA;
65
66         num_clock_ts = sei_num_clock_ts_table[h->sei_pic_struct];
67
68         for (i = 0; i < num_clock_ts; i++) {
69             if (get_bits(&h->gb, 1)) {                /* clock_timestamp_flag */
70                 unsigned int full_timestamp_flag;
71
72                 h->sei_ct_type |= 1 << get_bits(&h->gb, 2);
73                 skip_bits(&h->gb, 1);                 /* nuit_field_based_flag */
74                 skip_bits(&h->gb, 5);                 /* counting_type */
75                 full_timestamp_flag = get_bits(&h->gb, 1);
76                 skip_bits(&h->gb, 1);                 /* discontinuity_flag */
77                 skip_bits(&h->gb, 1);                 /* cnt_dropped_flag */
78                 skip_bits(&h->gb, 8);                 /* n_frames */
79                 if (full_timestamp_flag) {
80                     skip_bits(&h->gb, 6);             /* seconds_value 0..59 */
81                     skip_bits(&h->gb, 6);             /* minutes_value 0..59 */
82                     skip_bits(&h->gb, 5);             /* hours_value 0..23 */
83                 } else {
84                     if (get_bits(&h->gb, 1)) {        /* seconds_flag */
85                         skip_bits(&h->gb, 6);         /* seconds_value range 0..59 */
86                         if (get_bits(&h->gb, 1)) {    /* minutes_flag */
87                             skip_bits(&h->gb, 6);     /* minutes_value 0..59 */
88                             if (get_bits(&h->gb, 1))  /* hours_flag */
89                                 skip_bits(&h->gb, 5); /* hours_value 0..23 */
90                         }
91                     }
92                 }
93                 if (h->sps.time_offset_length > 0)
94                     skip_bits(&h->gb,
95                               h->sps.time_offset_length); /* time_offset */
96             }
97         }
98
99         if (h->avctx->debug & FF_DEBUG_PICT_INFO)
100             av_log(h->avctx, AV_LOG_DEBUG, "ct_type:%X pic_struct:%d\n",
101                    h->sei_ct_type, h->sei_pic_struct);
102     }
103     return 0;
104 }
105
106 static int decode_unregistered_user_data(H264Context *h, int size)
107 {
108     uint8_t user_data[16 + 256];
109     int e, build, i;
110
111     if (size < 16)
112         return AVERROR_INVALIDDATA;
113
114     for (i = 0; i < sizeof(user_data) - 1 && i < size; i++)
115         user_data[i] = get_bits(&h->gb, 8);
116
117     user_data[i] = 0;
118     e = sscanf(user_data + 16, "x264 - core %d", &build);
119     if (e == 1 && build > 0)
120         h->x264_build = build;
121
122     if (h->avctx->debug & FF_DEBUG_BUGS)
123         av_log(h->avctx, AV_LOG_DEBUG, "user data:\"%s\"\n", user_data + 16);
124
125     for (; i < size; i++)
126         skip_bits(&h->gb, 8);
127
128     return 0;
129 }
130
131 static int decode_recovery_point(H264Context *h)
132 {
133     h->sei_recovery_frame_cnt = get_ue_golomb(&h->gb);
134
135     /* 1b exact_match_flag,
136      * 1b broken_link_flag,
137      * 2b changing_slice_group_idc */
138     skip_bits(&h->gb, 4);
139
140     return 0;
141 }
142
143 static int decode_buffering_period(H264Context *h)
144 {
145     unsigned int sps_id;
146     int sched_sel_idx;
147     SPS *sps;
148
149     sps_id = get_ue_golomb_31(&h->gb);
150     if (sps_id > 31 || !h->sps_buffers[sps_id]) {
151         av_log(h->avctx, AV_LOG_ERROR,
152                "non-existing SPS %d referenced in buffering period\n", sps_id);
153         return AVERROR_INVALIDDATA;
154     }
155     sps = h->sps_buffers[sps_id];
156
157     // NOTE: This is really so duplicated in the standard... See H.264, D.1.1
158     if (sps->nal_hrd_parameters_present_flag) {
159         for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
160             h->initial_cpb_removal_delay[sched_sel_idx] =
161                 get_bits(&h->gb, sps->initial_cpb_removal_delay_length);
162             // initial_cpb_removal_delay_offset
163             skip_bits(&h->gb, sps->initial_cpb_removal_delay_length);
164         }
165     }
166     if (sps->vcl_hrd_parameters_present_flag) {
167         for (sched_sel_idx = 0; sched_sel_idx < sps->cpb_cnt; sched_sel_idx++) {
168             h->initial_cpb_removal_delay[sched_sel_idx] =
169                 get_bits(&h->gb, sps->initial_cpb_removal_delay_length);
170             // initial_cpb_removal_delay_offset
171             skip_bits(&h->gb, sps->initial_cpb_removal_delay_length);
172         }
173     }
174
175     h->sei_buffering_period_present = 1;
176     return 0;
177 }
178
179 static int decode_frame_packing_arrangement(H264Context *h)
180 {
181     get_ue_golomb(&h->gb);              // frame_packing_arrangement_id
182     h->sei_frame_packing_present = !get_bits1(&h->gb);
183
184     if (h->sei_frame_packing_present) {
185         h->frame_packing_arrangement_type = get_bits(&h->gb, 7);
186         h->quincunx_subsampling           = get_bits1(&h->gb);
187         h->content_interpretation_type    = get_bits(&h->gb, 6);
188
189         // the following skips: spatial_flipping_flag, frame0_flipped_flag,
190         // field_views_flag, current_frame_is_frame0_flag,
191         // frame0_self_contained_flag, frame1_self_contained_flag
192         skip_bits(&h->gb, 6);
193
194         if (!h->quincunx_subsampling && h->frame_packing_arrangement_type != 5)
195             skip_bits(&h->gb, 16);      // frame[01]_grid_position_[xy]
196         skip_bits(&h->gb, 8);           // frame_packing_arrangement_reserved_byte
197         get_ue_golomb(&h->gb);          // frame_packing_arrangement_repetition_period
198     }
199     skip_bits1(&h->gb);                 // frame_packing_arrangement_extension_flag
200
201     return 0;
202 }
203
204 int ff_h264_decode_sei(H264Context *h)
205 {
206     while (get_bits_left(&h->gb) > 16) {
207         int size = 0;
208         int type = 0;
209         int ret  = 0;
210
211         do
212             type += show_bits(&h->gb, 8);
213         while (get_bits(&h->gb, 8) == 255);
214
215         do
216             size += show_bits(&h->gb, 8);
217         while (get_bits(&h->gb, 8) == 255);
218
219         if (size > get_bits_left(&h->gb) / 8) {
220             av_log(h->avctx, AV_LOG_ERROR, "SEI type %d truncated at %d\n",
221                    type, get_bits_left(&h->gb));
222             return AVERROR_INVALIDDATA;
223         }
224
225         switch (type) {
226         case SEI_TYPE_PIC_TIMING: // Picture timing SEI
227             ret = decode_picture_timing(h);
228             if (ret < 0)
229                 return ret;
230             break;
231         case SEI_TYPE_USER_DATA_UNREGISTERED:
232             ret = decode_unregistered_user_data(h, size);
233             if (ret < 0)
234                 return ret;
235             break;
236         case SEI_TYPE_RECOVERY_POINT:
237             ret = decode_recovery_point(h);
238             if (ret < 0)
239                 return ret;
240             break;
241         case SEI_BUFFERING_PERIOD:
242             ret = decode_buffering_period(h);
243             if (ret < 0)
244                 return ret;
245             break;
246         case SEI_TYPE_FRAME_PACKING:
247             ret = decode_frame_packing_arrangement(h);
248             if (ret < 0)
249                 return ret;
250             break;
251         default:
252             av_log(h->avctx, AV_LOG_DEBUG, "unknown SEI type %d\n", type);
253             skip_bits(&h->gb, 8 * size);
254         }
255
256         // FIXME check bits here
257         align_get_bits(&h->gb);
258     }
259
260     return 0;
261 }