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