Merge commit 'f3449062a8d100ac4f703647336c32b126aa99f1'
[ffmpeg.git] / libavformat / rtpdec_h264.c
1 /*
2  * RTP H264 Protocol (RFC3984)
3  * Copyright (c) 2006 Ryan Martell
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  * @brief H.264 / RTP Code (RFC3984)
25  * @author Ryan Martell <rdm4@martellventures.com>
26  *
27  * @note Notes:
28  * Notes:
29  * This currently supports packetization mode:
30  * Single Nal Unit Mode (0), or
31  * Non-Interleaved Mode (1).  It currently does not support
32  * Interleaved Mode (2). (This requires implementing STAP-B, MTAP16, MTAP24,
33  *                        FU-B packet types)
34  */
35
36 #include "libavutil/attributes.h"
37 #include "libavutil/base64.h"
38 #include "libavutil/intreadwrite.h"
39 #include "libavutil/avstring.h"
40 #include "avformat.h"
41
42 #include "rtpdec.h"
43 #include "rtpdec_formats.h"
44
45 struct PayloadContext {
46     // sdp setup parameters
47     uint8_t profile_idc;
48     uint8_t profile_iop;
49     uint8_t level_idc;
50     int packetization_mode;
51 #ifdef DEBUG
52     int packet_types_received[32];
53 #endif
54 };
55
56 #ifdef DEBUG
57 #define COUNT_NAL_TYPE(data, nal) data->packet_types_received[(nal) & 0x1f]++
58 #define NAL_COUNTERS data->packet_types_received
59 #else
60 #define COUNT_NAL_TYPE(data, nal) do { } while (0)
61 #define NAL_COUNTERS NULL
62 #endif
63 #define NAL_MASK 0x1f
64
65 static const uint8_t start_sequence[] = { 0, 0, 0, 1 };
66
67 static void parse_profile_level_id(AVFormatContext *s,
68                                    PayloadContext *h264_data,
69                                    char *value)
70 {
71     char buffer[3];
72     // 6 characters=3 bytes, in hex.
73     uint8_t profile_idc;
74     uint8_t profile_iop;
75     uint8_t level_idc;
76
77     buffer[0]   = value[0];
78     buffer[1]   = value[1];
79     buffer[2]   = '\0';
80     profile_idc = strtol(buffer, NULL, 16);
81     buffer[0]   = value[2];
82     buffer[1]   = value[3];
83     profile_iop = strtol(buffer, NULL, 16);
84     buffer[0]   = value[4];
85     buffer[1]   = value[5];
86     level_idc   = strtol(buffer, NULL, 16);
87
88     av_log(s, AV_LOG_DEBUG,
89            "RTP Profile IDC: %x Profile IOP: %x Level: %x\n",
90            profile_idc, profile_iop, level_idc);
91     h264_data->profile_idc = profile_idc;
92     h264_data->profile_iop = profile_iop;
93     h264_data->level_idc   = level_idc;
94 }
95
96 int ff_h264_parse_sprop_parameter_sets(AVFormatContext *s,
97                                        uint8_t **data_ptr, int *size_ptr,
98                                        const char *value)
99 {
100     char base64packet[1024];
101     uint8_t decoded_packet[1024];
102     int packet_size;
103
104     while (*value) {
105         char *dst = base64packet;
106
107         while (*value && *value != ','
108                && (dst - base64packet) < sizeof(base64packet) - 1) {
109             *dst++ = *value++;
110         }
111         *dst++ = '\0';
112
113         if (*value == ',')
114             value++;
115
116         packet_size = av_base64_decode(decoded_packet, base64packet,
117                                        sizeof(decoded_packet));
118         if (packet_size > 0) {
119             uint8_t *dest = av_realloc(*data_ptr,
120                                        packet_size + sizeof(start_sequence) +
121                                        *size_ptr +
122                                        FF_INPUT_BUFFER_PADDING_SIZE);
123             if (!dest) {
124                 av_log(s, AV_LOG_ERROR,
125                        "Unable to allocate memory for extradata!\n");
126                 return AVERROR(ENOMEM);
127             }
128             *data_ptr = dest;
129
130             memcpy(dest + *size_ptr, start_sequence,
131                    sizeof(start_sequence));
132             memcpy(dest + *size_ptr + sizeof(start_sequence),
133                    decoded_packet, packet_size);
134             memset(dest + *size_ptr + sizeof(start_sequence) +
135                    packet_size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
136
137             *size_ptr += sizeof(start_sequence) + packet_size;
138         }
139     }
140
141     return 0;
142 }
143
144 static int sdp_parse_fmtp_config_h264(AVFormatContext *s,
145                                       AVStream *stream,
146                                       PayloadContext *h264_data,
147                                       char *attr, char *value)
148 {
149     AVCodecContext *codec = stream->codec;
150
151     if (!strcmp(attr, "packetization-mode")) {
152         av_log(s, AV_LOG_DEBUG, "RTP Packetization Mode: %d\n", atoi(value));
153         h264_data->packetization_mode = atoi(value);
154         /*
155          * Packetization Mode:
156          * 0 or not present: Single NAL mode (Only nals from 1-23 are allowed)
157          * 1: Non-interleaved Mode: 1-23, 24 (STAP-A), 28 (FU-A) are allowed.
158          * 2: Interleaved Mode: 25 (STAP-B), 26 (MTAP16), 27 (MTAP24), 28 (FU-A),
159          *                      and 29 (FU-B) are allowed.
160          */
161         if (h264_data->packetization_mode > 1)
162             av_log(s, AV_LOG_ERROR,
163                    "Interleaved RTP mode is not supported yet.\n");
164     } else if (!strcmp(attr, "profile-level-id")) {
165         if (strlen(value) == 6)
166             parse_profile_level_id(s, h264_data, value);
167     } else if (!strcmp(attr, "sprop-parameter-sets")) {
168         int ret;
169         codec->extradata_size = 0;
170         av_freep(&codec->extradata);
171         ret = ff_h264_parse_sprop_parameter_sets(s, &codec->extradata,
172                                                  &codec->extradata_size, value);
173         av_log(s, AV_LOG_DEBUG, "Extradata set to %p (size: %d)\n",
174                codec->extradata, codec->extradata_size);
175         return ret;
176     }
177     return 0;
178 }
179
180 void ff_h264_parse_framesize(AVCodecContext *codec, const char *p)
181 {
182     char buf1[50];
183     char *dst = buf1;
184
185     // remove the protocol identifier
186     while (*p && *p == ' ')
187         p++;                     // strip spaces.
188     while (*p && *p != ' ')
189         p++;                     // eat protocol identifier
190     while (*p && *p == ' ')
191         p++;                     // strip trailing spaces.
192     while (*p && *p != '-' && (dst - buf1) < sizeof(buf1) - 1)
193         *dst++ = *p++;
194     *dst = '\0';
195
196     // a='framesize:96 320-240'
197     // set our parameters
198     codec->width   = atoi(buf1);
199     codec->height  = atoi(p + 1); // skip the -
200 }
201
202 int ff_h264_handle_aggregated_packet(AVFormatContext *ctx, PayloadContext *data, AVPacket *pkt,
203                                      const uint8_t *buf, int len,
204                                      int skip_between, int *nal_counters,
205                                      int nal_mask)
206 {
207     int pass         = 0;
208     int total_length = 0;
209     uint8_t *dst     = NULL;
210     int ret;
211
212     // first we are going to figure out the total size
213     for (pass = 0; pass < 2; pass++) {
214         const uint8_t *src = buf;
215         int src_len        = len;
216
217         while (src_len > 2) {
218             uint16_t nal_size = AV_RB16(src);
219
220             // consume the length of the aggregate
221             src     += 2;
222             src_len -= 2;
223
224             if (nal_size <= src_len) {
225                 if (pass == 0) {
226                     // counting
227                     total_length += sizeof(start_sequence) + nal_size;
228                 } else {
229                     // copying
230                     memcpy(dst, start_sequence, sizeof(start_sequence));
231                     dst += sizeof(start_sequence);
232                     memcpy(dst, src, nal_size);
233                     if (nal_counters)
234                         nal_counters[(*src) & nal_mask]++;
235                     dst += nal_size;
236                 }
237             } else {
238                 av_log(ctx, AV_LOG_ERROR,
239                        "nal size exceeds length: %d %d\n", nal_size, src_len);
240                 return AVERROR_INVALIDDATA;
241             }
242
243             // eat what we handled
244             src     += nal_size + skip_between;
245             src_len -= nal_size + skip_between;
246         }
247
248         if (pass == 0) {
249             /* now we know the total size of the packet (with the
250              * start sequences added) */
251             if ((ret = av_new_packet(pkt, total_length)) < 0)
252                 return ret;
253             dst = pkt->data;
254         }
255     }
256
257     return 0;
258 }
259
260 static int h264_handle_packet_fu_a(AVFormatContext *ctx, PayloadContext *data, AVPacket *pkt,
261                                    const uint8_t *buf, int len,
262                                    int *nal_counters, int nal_mask)
263 {
264     uint8_t fu_indicator, fu_header, start_bit, nal_type, nal;
265     int ret;
266
267     if (len < 3) {
268         av_log(ctx, AV_LOG_ERROR, "Too short data for FU-A H264 RTP packet\n");
269         return AVERROR_INVALIDDATA;
270     }
271
272     fu_indicator = buf[0];
273     fu_header    = buf[1];
274     start_bit    = fu_header >> 7;
275     nal_type     = fu_header & 0x1f;
276     nal          = fu_indicator & 0xe0 | nal_type;
277
278     // skip the fu_indicator and fu_header
279     buf += 2;
280     len -= 2;
281
282     if (start_bit) {
283         if (nal_counters)
284             nal_counters[nal_type & nal_mask]++;
285         /* copy in the start sequence, and the reconstructed nal */
286         if ((ret = av_new_packet(pkt, sizeof(start_sequence) + sizeof(nal) + len)) < 0)
287             return ret;
288         memcpy(pkt->data, start_sequence, sizeof(start_sequence));
289         pkt->data[sizeof(start_sequence)] = nal;
290         memcpy(pkt->data + sizeof(start_sequence) + sizeof(nal), buf, len);
291     } else {
292         if ((ret = av_new_packet(pkt, len)) < 0)
293             return ret;
294         memcpy(pkt->data, buf, len);
295     }
296
297     return 0;
298 }
299
300 // return 0 on packet, no more left, 1 on packet, 1 on partial packet
301 static int h264_handle_packet(AVFormatContext *ctx, PayloadContext *data,
302                               AVStream *st, AVPacket *pkt, uint32_t *timestamp,
303                               const uint8_t *buf, int len, uint16_t seq,
304                               int flags)
305 {
306     uint8_t nal;
307     uint8_t type;
308     int result = 0;
309
310     if (!len) {
311         av_log(ctx, AV_LOG_ERROR, "Empty H264 RTP packet\n");
312         return AVERROR_INVALIDDATA;
313     }
314     nal  = buf[0];
315     type = nal & 0x1f;
316
317     /* Simplify the case (these are all the nal types used internally by
318      * the h264 codec). */
319     if (type >= 1 && type <= 23)
320         type = 1;
321     switch (type) {
322     case 0:                    // undefined, but pass them through
323     case 1:
324         if ((result = av_new_packet(pkt, len + sizeof(start_sequence))) < 0)
325             return result;
326         memcpy(pkt->data, start_sequence, sizeof(start_sequence));
327         memcpy(pkt->data + sizeof(start_sequence), buf, len);
328         COUNT_NAL_TYPE(data, nal);
329         break;
330
331     case 24:                   // STAP-A (one packet, multiple nals)
332         // consume the STAP-A NAL
333         buf++;
334         len--;
335         result = ff_h264_handle_aggregated_packet(ctx, data, pkt, buf, len, 0,
336                                                   NAL_COUNTERS, NAL_MASK);
337         break;
338
339     case 25:                   // STAP-B
340     case 26:                   // MTAP-16
341     case 27:                   // MTAP-24
342     case 29:                   // FU-B
343         av_log(ctx, AV_LOG_ERROR,
344                "Unhandled type (%d) (See RFC for implementation details)\n",
345                type);
346         result = AVERROR(ENOSYS);
347         break;
348
349     case 28:                   // FU-A (fragmented nal)
350         result = h264_handle_packet_fu_a(ctx, data, pkt, buf, len,
351                                          NAL_COUNTERS, NAL_MASK);
352         break;
353
354     case 30:                   // undefined
355     case 31:                   // undefined
356     default:
357         av_log(ctx, AV_LOG_ERROR, "Undefined type (%d)\n", type);
358         result = AVERROR_INVALIDDATA;
359         break;
360     }
361
362     pkt->stream_index = st->index;
363
364     return result;
365 }
366
367 static void h264_free_context(PayloadContext *data)
368 {
369 #ifdef DEBUG
370     int ii;
371
372     for (ii = 0; ii < 32; ii++) {
373         if (data->packet_types_received[ii])
374             av_log(NULL, AV_LOG_DEBUG, "Received %d packets of type %d\n",
375                    data->packet_types_received[ii], ii);
376     }
377 #endif
378
379     av_free(data);
380 }
381
382 static int parse_h264_sdp_line(AVFormatContext *s, int st_index,
383                                PayloadContext *h264_data, const char *line)
384 {
385     AVStream *stream;
386     const char *p = line;
387
388     if (st_index < 0)
389         return 0;
390
391     stream = s->streams[st_index];
392
393     if (av_strstart(p, "framesize:", &p)) {
394         ff_h264_parse_framesize(stream->codec, p);
395     } else if (av_strstart(p, "fmtp:", &p)) {
396         return ff_parse_fmtp(s, stream, h264_data, p, sdp_parse_fmtp_config_h264);
397     } else if (av_strstart(p, "cliprect:", &p)) {
398         // could use this if we wanted.
399     }
400
401     return 0;
402 }
403
404 RTPDynamicProtocolHandler ff_h264_dynamic_handler = {
405     .enc_name         = "H264",
406     .codec_type       = AVMEDIA_TYPE_VIDEO,
407     .codec_id         = AV_CODEC_ID_H264,
408     .need_parsing     = AVSTREAM_PARSE_FULL,
409     .priv_data_size   = sizeof(PayloadContext),
410     .parse_sdp_a_line = parse_h264_sdp_line,
411     .free             = h264_free_context,
412     .parse_packet     = h264_handle_packet,
413 };