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