rtpdec_hevc: Initialize variables to silence false positive compiler warnings
[ffmpeg.git] / libavformat / rtpdec_hevc.c
1 /*
2  * RTP parser for HEVC/H.265 payload format (draft version 6)
3  * Copyright (c) 2014 Thomas Volkert <thomas@homer-conferencing.com>
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 #include "libavutil/avstring.h"
24 #include "libavutil/base64.h"
25
26 #include "avformat.h"
27 #include "rtpdec.h"
28 #include "rtpdec_formats.h"
29
30 #define RTP_HEVC_PAYLOAD_HEADER_SIZE  2
31 #define RTP_HEVC_FU_HEADER_SIZE       1
32 #define RTP_HEVC_DONL_FIELD_SIZE      2
33 #define HEVC_SPECIFIED_NAL_UNIT_TYPES 48
34
35 /* SDP out-of-band signaling data */
36 struct PayloadContext {
37     int using_donl_field;
38     int profile_id;
39     uint8_t *sps, *pps, *vps, *sei;
40     int sps_size, pps_size, vps_size, sei_size;
41 };
42
43 static const uint8_t start_sequence[] = { 0x00, 0x00, 0x00, 0x01 };
44
45 static av_cold PayloadContext *hevc_new_context(void)
46 {
47     return av_mallocz(sizeof(PayloadContext));
48 }
49
50 static av_cold void hevc_free_context(PayloadContext *data)
51 {
52     av_free(data);
53 }
54
55 static av_cold int hevc_init(AVFormatContext *ctx, int st_index,
56                              PayloadContext *data)
57 {
58     av_dlog(ctx, "hevc_init() for stream %d\n", st_index);
59
60     if (st_index < 0)
61         return 0;
62
63     ctx->streams[st_index]->need_parsing = AVSTREAM_PARSE_FULL;
64
65     return 0;
66 }
67
68 static av_cold int hevc_sdp_parse_fmtp_config(AVFormatContext *s,
69                                               AVStream *stream,
70                                               PayloadContext *hevc_data,
71                                               char *attr, char *value)
72 {
73     /* profile-space: 0-3 */
74     /* profile-id: 0-31 */
75     if (!strcmp(attr, "profile-id")) {
76         hevc_data->profile_id = atoi(value);
77         av_dlog(s, "SDP: found profile-id: %d\n", hevc_data->profile_id);
78     }
79
80     /* tier-flag: 0-1 */
81     /* level-id: 0-255 */
82     /* interop-constraints: [base16] */
83     /* profile-compatibility-indicator: [base16] */
84     /* sprop-sub-layer-id: 0-6, defines highest possible value for TID, default: 6 */
85     /* recv-sub-layer-id: 0-6 */
86     /* max-recv-level-id: 0-255 */
87     /* tx-mode: MSM,SSM */
88     /* sprop-vps: [base64] */
89     /* sprop-sps: [base64] */
90     /* sprop-pps: [base64] */
91     /* sprop-sei: [base64] */
92     if (!strcmp(attr, "sprop-vps") || !strcmp(attr, "sprop-sps") ||
93         !strcmp(attr, "sprop-pps") || !strcmp(attr, "sprop-sei")) {
94         uint8_t **data_ptr = NULL;
95         int *size_ptr = NULL;
96         if (!strcmp(attr, "sprop-vps")) {
97             data_ptr = &hevc_data->vps;
98             size_ptr = &hevc_data->vps_size;
99         } else if (!strcmp(attr, "sprop-sps")) {
100             data_ptr = &hevc_data->sps;
101             size_ptr = &hevc_data->sps_size;
102         } else if (!strcmp(attr, "sprop-pps")) {
103             data_ptr = &hevc_data->pps;
104             size_ptr = &hevc_data->pps_size;
105         } else if (!strcmp(attr, "sprop-sei")) {
106             data_ptr = &hevc_data->sei;
107             size_ptr = &hevc_data->sei_size;
108         }
109
110         ff_h264_parse_sprop_parameter_sets(s, data_ptr,
111                                            size_ptr, value);
112     }
113
114     /* max-lsr, max-lps, max-cpb, max-dpb, max-br, max-tr, max-tc */
115     /* max-fps */
116
117     /* sprop-max-don-diff: 0-32767
118
119          When the RTP stream depends on one or more other RTP
120          streams (in this case tx-mode MUST be equal to "MSM" and
121          MSM is in use), this parameter MUST be present and the
122          value MUST be greater than 0.
123     */
124     if (!strcmp(attr, "sprop-max-don-diff")) {
125         if (atoi(value) > 0)
126             hevc_data->using_donl_field = 1;
127         av_dlog(s, "Found sprop-max-don-diff in SDP, DON field usage is: %d\n",
128                 hevc_data->using_donl_field);
129     }
130
131     /* sprop-depack-buf-nalus: 0-32767 */
132     if (!strcmp(attr, "sprop-depack-buf-nalus")) {
133         if (atoi(value) > 0)
134             hevc_data->using_donl_field = 1;
135         av_dlog(s, "Found sprop-depack-buf-nalus in SDP, DON field usage is: %d\n",
136                 hevc_data->using_donl_field);
137     }
138
139     /* sprop-depack-buf-bytes: 0-4294967295 */
140     /* depack-buf-cap */
141     /* sprop-segmentation-id: 0-3 */
142     /* sprop-spatial-segmentation-idc: [base16] */
143     /* dec-parallel-ca: */
144     /* include-dph */
145
146     return 0;
147 }
148
149 static av_cold int hevc_parse_sdp_line(AVFormatContext *ctx, int st_index,
150                                        PayloadContext *hevc_data, const char *line)
151 {
152     AVStream *current_stream;
153     AVCodecContext *codec;
154     const char *sdp_line_ptr = line;
155
156     if (st_index < 0)
157         return 0;
158
159     current_stream = ctx->streams[st_index];
160     codec  = current_stream->codec;
161
162     if (av_strstart(sdp_line_ptr, "framesize:", &sdp_line_ptr)) {
163         char str_video_width[50];
164         char *str_video_width_ptr = str_video_width;
165
166         /*
167          * parse "a=framesize:96 320-240"
168          */
169
170         /* ignore spaces */
171         while (*sdp_line_ptr && *sdp_line_ptr == ' ')
172             sdp_line_ptr++;
173         /* ignore RTP payload ID */
174         while (*sdp_line_ptr && *sdp_line_ptr != ' ')
175             sdp_line_ptr++;
176         /* ignore spaces */
177         while (*sdp_line_ptr && *sdp_line_ptr == ' ')
178             sdp_line_ptr++;
179         /* extract the actual video resolution description */
180         while (*sdp_line_ptr && *sdp_line_ptr != '-' &&
181                (str_video_width_ptr - str_video_width) < sizeof(str_video_width) - 1)
182             *str_video_width_ptr++ = *sdp_line_ptr++;
183         /* add trailing zero byte */
184         *str_video_width_ptr = '\0';
185
186         /* determine the width value */
187         codec->width   = atoi(str_video_width);
188         /* jump beyond the "-" and determine the height value */
189         codec->height  = atoi(sdp_line_ptr + 1);
190     } else if (av_strstart(sdp_line_ptr, "fmtp:", &sdp_line_ptr)) {
191         int ret = ff_parse_fmtp(ctx, current_stream, hevc_data, sdp_line_ptr,
192                                 hevc_sdp_parse_fmtp_config);
193         if (hevc_data->vps_size || hevc_data->sps_size ||
194             hevc_data->pps_size || hevc_data->sei_size) {
195             av_freep(&codec->extradata);
196             codec->extradata_size = hevc_data->vps_size + hevc_data->sps_size +
197                                     hevc_data->pps_size + hevc_data->sei_size;
198             codec->extradata = av_malloc(codec->extradata_size +
199                                          FF_INPUT_BUFFER_PADDING_SIZE);
200             if (!codec->extradata) {
201                 ret = AVERROR(ENOMEM);
202                 codec->extradata_size = 0;
203             } else {
204                 int pos = 0;
205                 memcpy(codec->extradata + pos, hevc_data->vps, hevc_data->vps_size);
206                 pos += hevc_data->vps_size;
207                 memcpy(codec->extradata + pos, hevc_data->sps, hevc_data->sps_size);
208                 pos += hevc_data->sps_size;
209                 memcpy(codec->extradata + pos, hevc_data->pps, hevc_data->pps_size);
210                 pos += hevc_data->pps_size;
211                 memcpy(codec->extradata + pos, hevc_data->sei, hevc_data->sei_size);
212                 pos += hevc_data->sei_size;
213                 memset(codec->extradata + pos, 0, FF_INPUT_BUFFER_PADDING_SIZE);
214             }
215
216             av_freep(&hevc_data->vps);
217             av_freep(&hevc_data->sps);
218             av_freep(&hevc_data->pps);
219             av_freep(&hevc_data->sei);
220             hevc_data->vps_size = 0;
221             hevc_data->sps_size = 0;
222             hevc_data->pps_size = 0;
223             hevc_data->sei_size = 0;
224         }
225         return ret;
226     }
227
228     return 0;
229 }
230
231 static int hevc_handle_packet(AVFormatContext *ctx, PayloadContext *rtp_hevc_ctx,
232                               AVStream *st, AVPacket *pkt, uint32_t *timestamp,
233                               const uint8_t *buf, int len, uint16_t seq,
234                               int flags)
235 {
236     const uint8_t *rtp_pl = buf;
237     int tid, lid, nal_type;
238     int first_fragment, last_fragment, fu_type;
239     uint8_t new_nal_header[2];
240     int res = 0;
241
242     /* sanity check for size of input packet: 1 byte payload at least */
243     if (len < RTP_HEVC_PAYLOAD_HEADER_SIZE + 1) {
244         av_log(ctx, AV_LOG_ERROR, "Too short RTP/HEVC packet, got %d bytes\n", len);
245         return AVERROR_INVALIDDATA;
246     }
247
248     /*
249       decode the HEVC payload header according to section 4 of draft version 6:
250
251          0                   1
252          0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
253         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
254         |F|   Type    |  LayerId  | TID |
255         +-------------+-----------------+
256
257            Forbidden zero (F): 1 bit
258            NAL unit type (Type): 6 bits
259            NUH layer ID (LayerId): 6 bits
260            NUH temporal ID plus 1 (TID): 3 bits
261     */
262     nal_type =  (buf[0] >> 1) & 0x3f;
263     lid  = ((buf[0] << 5) & 0x20) | ((buf[1] >> 3) & 0x1f);
264     tid  =   buf[1] & 0x07;
265
266     /* sanity check for correct layer ID */
267     if (lid) {
268         /* future scalable or 3D video coding extensions */
269         avpriv_report_missing_feature(ctx, "Multi-layer HEVC coding\n");
270         return AVERROR_PATCHWELCOME;
271     }
272
273     /* sanity check for correct temporal ID */
274     if (!tid) {
275         av_log(ctx, AV_LOG_ERROR, "Illegal temporal ID in RTP/HEVC packet\n");
276         return AVERROR_INVALIDDATA;
277     }
278
279     /* sanity check for correct NAL unit type */
280     if (nal_type > 50) {
281         av_log(ctx, AV_LOG_ERROR, "Unsupported (HEVC) NAL type (%d)\n", nal_type);
282         return AVERROR_INVALIDDATA;
283     }
284
285     switch (nal_type) {
286     /* aggregated packets (AP) */
287     case 48:
288         /* pass the HEVC payload header */
289         buf += RTP_HEVC_PAYLOAD_HEADER_SIZE;
290         len -= RTP_HEVC_PAYLOAD_HEADER_SIZE;
291
292         /* pass the HEVC DONL field */
293         if (rtp_hevc_ctx->using_donl_field) {
294             buf += RTP_HEVC_DONL_FIELD_SIZE;
295             len -= RTP_HEVC_DONL_FIELD_SIZE;
296         }
297
298         /* fall-through */
299     /* video parameter set (VPS) */
300     case 32:
301     /* sequence parameter set (SPS) */
302     case 33:
303     /* picture parameter set (PPS) */
304     case 34:
305     /*  supplemental enhancement information (SEI) */
306     case 39:
307     /* single NAL unit packet */
308     default:
309         /* sanity check for size of input packet: 1 byte payload at least */
310         if (len < 1) {
311             av_log(ctx, AV_LOG_ERROR,
312                    "Too short RTP/HEVC packet, got %d bytes of NAL unit type %d\n",
313                    len, nal_type);
314             return AVERROR_INVALIDDATA;
315         }
316
317         /* create A/V packet */
318         if ((res = av_new_packet(pkt, sizeof(start_sequence) + len)) < 0)
319             return res;
320         /* A/V packet: copy start sequence */
321         memcpy(pkt->data, start_sequence, sizeof(start_sequence));
322         /* A/V packet: copy NAL unit data */
323         memcpy(pkt->data + sizeof(start_sequence), buf, len);
324
325         break;
326     /* fragmentation unit (FU) */
327     case 49:
328         /* pass the HEVC payload header */
329         buf += RTP_HEVC_PAYLOAD_HEADER_SIZE;
330         len -= RTP_HEVC_PAYLOAD_HEADER_SIZE;
331
332         /*
333              decode the FU header
334
335               0 1 2 3 4 5 6 7
336              +-+-+-+-+-+-+-+-+
337              |S|E|  FuType   |
338              +---------------+
339
340                 Start fragment (S): 1 bit
341                 End fragment (E): 1 bit
342                 FuType: 6 bits
343         */
344         first_fragment = buf[0] & 0x80;
345         last_fragment  = buf[0] & 0x40;
346         fu_type        = buf[0] & 0x3f;
347
348         /* pass the HEVC FU header */
349         buf += RTP_HEVC_FU_HEADER_SIZE;
350         len -= RTP_HEVC_FU_HEADER_SIZE;
351
352         /* pass the HEVC DONL field */
353         if (rtp_hevc_ctx->using_donl_field) {
354             buf += RTP_HEVC_DONL_FIELD_SIZE;
355             len -= RTP_HEVC_DONL_FIELD_SIZE;
356         }
357
358         av_dlog(ctx, " FU type %d with %d bytes\n", fu_type, len);
359
360         if (len > 0) {
361             new_nal_header[0] = (rtp_pl[0] & 0x81) | (fu_type << 1);
362             new_nal_header[1] = rtp_pl[1];
363
364             /* start fragment vs. subsequent fragments */
365             if (first_fragment) {
366                 if (!last_fragment) {
367                     /* create A/V packet which is big enough */
368                     if ((res = av_new_packet(pkt, sizeof(start_sequence) + sizeof(new_nal_header) + len)) < 0)
369                         return res;
370                     /* A/V packet: copy start sequence */
371                     memcpy(pkt->data, start_sequence, sizeof(start_sequence));
372                     /* A/V packet: copy new NAL header */
373                     memcpy(pkt->data + sizeof(start_sequence), new_nal_header, sizeof(new_nal_header));
374                     /* A/V packet: copy NAL unit data */
375                     memcpy(pkt->data + sizeof(start_sequence) + sizeof(new_nal_header), buf, len);
376                 } else {
377                     av_log(ctx, AV_LOG_ERROR, "Illegal combination of S and E bit in RTP/HEVC packet\n");
378                     res = AVERROR_INVALIDDATA;
379                 }
380             } else {
381                 /* create A/V packet */
382                 if ((res = av_new_packet(pkt, len)) < 0)
383                     return res;
384                 /* A/V packet: copy NAL unit data */
385                 memcpy(pkt->data, buf, len);
386             }
387         } else {
388             /* sanity check for size of input packet: 1 byte payload at least */
389             av_log(ctx, AV_LOG_ERROR,
390                    "Too short RTP/HEVC packet, got %d bytes of NAL unit type %d\n",
391                    len, nal_type);
392             res = AVERROR_INVALIDDATA;
393         }
394
395         break;
396     /* PACI packet */
397     case 50:
398         /* Temporal scalability control information (TSCI) */
399         avpriv_report_missing_feature(ctx, "PACI packets for RTP/HEVC\n");
400         res = AVERROR_PATCHWELCOME;
401         break;
402     }
403
404     pkt->stream_index = st->index;
405
406     return res;
407 }
408
409 RTPDynamicProtocolHandler ff_hevc_dynamic_handler = {
410     .enc_name         = "H265",
411     .codec_type       = AVMEDIA_TYPE_VIDEO,
412     .codec_id         = AV_CODEC_ID_HEVC,
413     .init             = hevc_init,
414     .parse_sdp_a_line = hevc_parse_sdp_line,
415     .alloc            = hevc_new_context,
416     .free             = hevc_free_context,
417     .parse_packet     = hevc_handle_packet
418 };