Add is_keyframe param to ff_rdt_parse_header(). See ML discussion in
[ffmpeg.git] / libavformat / rdt.c
1 /*
2  * Realmedia RTSP protocol (RDT) support.
3  * Copyright (c) 2007 Ronald S. Bultje
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 rdt.c
24  * @brief Realmedia RTSP protocol (RDT) support
25  * @author Ronald S. Bultje <rbultje@ronald.bitfreak.net>
26  */
27
28 #include "avformat.h"
29 #include "libavutil/avstring.h"
30 #include "rtp_internal.h"
31 #include "rdt.h"
32 #include "libavutil/base64.h"
33 #include "libavutil/md5.h"
34 #include "rm.h"
35 #include "internal.h"
36
37 struct RDTDemuxContext {
38     AVFormatContext *ic;
39     AVStream *st;
40     void *dynamic_protocol_context;
41     DynamicPayloadPacketHandlerProc parse_packet;
42     uint32_t prev_set_id, prev_timestamp;
43 };
44
45 RDTDemuxContext *
46 ff_rdt_parse_open(AVFormatContext *ic, AVStream *st,
47                   void *priv_data, RTPDynamicProtocolHandler *handler)
48 {
49     RDTDemuxContext *s = av_mallocz(sizeof(RDTDemuxContext));
50     if (!s)
51         return NULL;
52
53     s->ic = ic;
54     s->st = st;
55     s->prev_set_id    = -1;
56     s->prev_timestamp = -1;
57     s->parse_packet = handler->parse_packet;
58     s->dynamic_protocol_context = priv_data;
59
60     return s;
61 }
62
63 void
64 ff_rdt_parse_close(RDTDemuxContext *s)
65 {
66     av_free(s);
67 }
68
69 struct PayloadContext {
70     AVFormatContext *rmctx;
71     uint8_t *mlti_data;
72     unsigned int mlti_data_size;
73     char buffer[RTP_MAX_PACKET_LENGTH + FF_INPUT_BUFFER_PADDING_SIZE];
74 };
75
76 void
77 ff_rdt_calc_response_and_checksum(char response[41], char chksum[9],
78                                   const char *challenge)
79 {
80     int ch_len = strlen (challenge), i;
81     unsigned char zres[16],
82         buf[64] = { 0xa1, 0xe9, 0x14, 0x9d, 0x0e, 0x6b, 0x3b, 0x59 };
83 #define XOR_TABLE_SIZE 37
84     const unsigned char xor_table[XOR_TABLE_SIZE] = {
85         0x05, 0x18, 0x74, 0xd0, 0x0d, 0x09, 0x02, 0x53,
86         0xc0, 0x01, 0x05, 0x05, 0x67, 0x03, 0x19, 0x70,
87         0x08, 0x27, 0x66, 0x10, 0x10, 0x72, 0x08, 0x09,
88         0x63, 0x11, 0x03, 0x71, 0x08, 0x08, 0x70, 0x02,
89         0x10, 0x57, 0x05, 0x18, 0x54 };
90
91     /* some (length) checks */
92     if (ch_len == 40) /* what a hack... */
93         ch_len = 32;
94     else if (ch_len > 56)
95         ch_len = 56;
96     memcpy(buf + 8, challenge, ch_len);
97
98     /* xor challenge bytewise with xor_table */
99     for (i = 0; i < XOR_TABLE_SIZE; i++)
100         buf[8 + i] ^= xor_table[i];
101
102     av_md5_sum(zres, buf, 64);
103     ff_data_to_hex(response, zres, 16);
104     for (i=0;i<32;i++) response[i] = tolower(response[i]);
105
106     /* add tail */
107     strcpy (response + 32, "01d0a8e3");
108
109     /* calculate checksum */
110     for (i = 0; i < 8; i++)
111         chksum[i] = response[i * 4];
112     chksum[8] = 0;
113 }
114
115 static int
116 rdt_load_mdpr (PayloadContext *rdt, AVStream *st, int rule_nr)
117 {
118     ByteIOContext *pb;
119     int size;
120     uint32_t tag;
121
122     /**
123      * Layout of the MLTI chunk:
124      * 4:MLTI
125      * 2:<number of streams>
126      * Then for each stream ([number_of_streams] times):
127      *     2:<mdpr index>
128      * 2:<number of mdpr chunks>
129      * Then for each mdpr chunk ([number_of_mdpr_chunks] times):
130      *     4:<size>
131      *     [size]:<data>
132      * we skip MDPR chunks until we reach the one of the stream
133      * we're interested in, and forward that ([size]+[data]) to
134      * the RM demuxer to parse the stream-specific header data.
135      */
136     if (!rdt->mlti_data)
137         return -1;
138     url_open_buf(&pb, rdt->mlti_data, rdt->mlti_data_size, URL_RDONLY);
139     tag = get_le32(pb);
140     if (tag == MKTAG('M', 'L', 'T', 'I')) {
141         int num, chunk_nr;
142
143         /* read index of MDPR chunk numbers */
144         num = get_be16(pb);
145         if (rule_nr < 0 || rule_nr >= num)
146             return -1;
147         url_fskip(pb, rule_nr * 2);
148         chunk_nr = get_be16(pb);
149         url_fskip(pb, (num - 1 - rule_nr) * 2);
150
151         /* read MDPR chunks */
152         num = get_be16(pb);
153         if (chunk_nr >= num)
154             return -1;
155         while (chunk_nr--)
156             url_fskip(pb, get_be32(pb));
157         size = get_be32(pb);
158     } else {
159         size = rdt->mlti_data_size;
160         url_fseek(pb, 0, SEEK_SET);
161     }
162     rdt->rmctx->pb = pb;
163     if (ff_rm_read_mdpr_codecdata(rdt->rmctx, st, size) < 0)
164         return -1;
165
166     url_close_buf(pb);
167     return 0;
168 }
169
170 /**
171  * Actual data handling.
172  */
173
174 int
175 ff_rdt_parse_header(const uint8_t *buf, int len,
176                     int *set_id, int *seq_no, int *stream_id,
177                     int *is_keyframe, uint32_t *timestamp)
178 {
179     int consumed = 10;
180
181     if (len > 0 && (buf[0] < 0x40 || buf[0] > 0x42)) {
182         buf += 9;
183         len -= 9;
184         consumed += 9;
185     }
186     if (len < 10)
187         return -1;
188     /**
189      * Layout of the header (in bits):
190      * 1:  len_included
191      *     Flag indicating whether this header includes a length field;
192      *     this can be used to concatenate multiple RDT packets in a
193      *     single UDP/TCP data frame and is used to precede RDT data
194      *     by stream status packets
195      * 1:  need_reliable
196      *     Flag indicating whether this header includes a "reliable
197      *     sequence number"; these are apparently sequence numbers of
198      *     data packets alone. For data packets, this flag is always
199      *     set, according to the Real documentation [1]
200      * 5:  set_id
201      *     ID of a set of streams of identical content, possibly with
202      *     different codecs or bitrates
203      * 1:  is_reliable
204      *     Flag set for certain streams deemed less tolerable for packet
205      *     loss
206      * 16: seq_no
207      *     Packet sequence number; if >=0xFF00, this is a non-data packet
208      *     containing stream status info, the second byte indicates the
209      *     type of status packet (see wireshark docs / source code [2])
210      * if (len_included) {
211      *     16: packet_len
212      * } else {
213      *     packet_len = remainder of UDP/TCP frame
214      * }
215      * 1:  is_back_to_back
216      *     Back-to-Back flag; used for timing, set for one in every 10
217      *     packets, according to the Real documentation [1]
218      * 1:  is_slow_data
219      *     Slow-data flag; currently unused, according to Real docs [1]
220      * 5:  stream_id
221      *     ID of the stream within this particular set of streams
222      * 1:  is_no_keyframe
223      *     Non-keyframe flag (unset if packet belongs to a keyframe)
224      * 32: timestamp (PTS)
225      * if (set_id == 0x1F) {
226      *     16: set_id (extended set-of-streams ID; see set_id)
227      * }
228      * if (need_reliable) {
229      *     16: reliable_seq_no
230      *         Reliable sequence number (see need_reliable)
231      * }
232      * if (stream_id == 0x3F) {
233      *     16: stream_id (extended stream ID; see stream_id)
234      * }
235      * [1] https://protocol.helixcommunity.org/files/2005/devdocs/RDT_Feature_Level_20.txt
236      * [2] http://www.wireshark.org/docs/dfref/r/rdt.html and
237      *     http://anonsvn.wireshark.org/viewvc/trunk/epan/dissectors/packet-rdt.c
238      */
239     if (set_id)    *set_id    = (buf[0]>>1) & 0x1f;
240     if (seq_no)    *seq_no    = AV_RB16(buf+1);
241     if (timestamp) *timestamp = AV_RB32(buf+4);
242     if (stream_id) *stream_id = (buf[3]>>1) & 0x1f;
243     if (is_keyframe) *is_keyframe = !(buf[3] & 0x1);
244
245     return consumed;
246 }
247
248 /**< return 0 on packet, no more left, 1 on packet, 1 on partial packet... */
249 static int
250 rdt_parse_packet (PayloadContext *rdt, AVStream *st,
251                   AVPacket *pkt, uint32_t *timestamp,
252                   const uint8_t *buf, int len, int flags)
253 {
254     int seq = 1, res;
255     ByteIOContext *pb = rdt->rmctx->pb;
256     RMContext *rm = rdt->rmctx->priv_data;
257
258     if (rm->audio_pkt_cnt == 0) {
259         int pos;
260
261         url_open_buf (&pb, buf, len, URL_RDONLY);
262         flags = (flags & PKT_FLAG_KEY) ? 2 : 0;
263         rdt->rmctx->pb = pb;
264         res = ff_rm_parse_packet (rdt->rmctx, st, len, pkt,
265                                   &seq, &flags, timestamp);
266         pos = url_ftell(pb);
267         url_close_buf (pb);
268         if (res < 0)
269             return res;
270         if (rm->audio_pkt_cnt > 0 &&
271             st->codec->codec_id == CODEC_ID_AAC) {
272             memcpy (rdt->buffer, buf + pos, len - pos);
273             url_open_buf (&pb, rdt->buffer, len - pos, URL_RDONLY);
274             rdt->rmctx->pb = pb;
275         }
276     } else {
277         ff_rm_retrieve_cache (rdt->rmctx, st, pkt);
278         if (rm->audio_pkt_cnt == 0 &&
279             st->codec->codec_id == CODEC_ID_AAC)
280             url_close_buf (pb);
281     }
282     pkt->stream_index = st->index;
283     pkt->pts = *timestamp;
284
285     return rm->audio_pkt_cnt > 0;
286 }
287
288 int
289 ff_rdt_parse_packet(RDTDemuxContext *s, AVPacket *pkt,
290                     const uint8_t *buf, int len)
291 {
292     int seq_no, flags = 0, stream_id, set_id, is_keyframe;
293     uint32_t timestamp;
294     int rv= 0;
295
296     if (!s->parse_packet)
297         return -1;
298
299     if (!buf) {
300         /* return the next packets, if any */
301         timestamp= 0; ///< Should not be used if buf is NULL, but should be set to the timestamp of the packet returned....
302         rv= s->parse_packet(s->dynamic_protocol_context,
303                             s->st, pkt, &timestamp, NULL, 0, flags);
304         return rv;
305     }
306
307     if (len < 12)
308         return -1;
309     rv = ff_rdt_parse_header(buf, len, &set_id, &seq_no, &stream_id, &is_keyframe, &timestamp);
310     if (rv < 0)
311         return rv;
312     if (is_keyframe && (set_id != s->prev_set_id || timestamp != s->prev_timestamp)) {
313         flags |= PKT_FLAG_KEY;
314         s->prev_set_id    = set_id;
315         s->prev_timestamp = timestamp;
316     }
317     buf += rv;
318     len -= rv;
319
320     rv = s->parse_packet(s->dynamic_protocol_context,
321                          s->st, pkt, &timestamp, buf, len, flags);
322
323     return rv;
324 }
325
326 void
327 ff_rdt_subscribe_rule (char *cmd, int size,
328                        int stream_nr, int rule_nr)
329 {
330     av_strlcatf(cmd, size, "stream=%d;rule=%d,stream=%d;rule=%d",
331                 stream_nr, rule_nr * 2, stream_nr, rule_nr * 2 + 1);
332 }
333
334 void
335 ff_rdt_subscribe_rule2 (RDTDemuxContext *s, char *cmd, int size,
336                         int stream_nr, int rule_nr)
337 {
338     PayloadContext *rdt = s->dynamic_protocol_context;
339
340     rdt_load_mdpr(rdt, s->st, rule_nr * 2);
341 }
342
343 static unsigned char *
344 rdt_parse_b64buf (unsigned int *target_len, const char *p)
345 {
346     unsigned char *target;
347     int len = strlen(p);
348     if (*p == '\"') {
349         p++;
350         len -= 2; /* skip embracing " at start/end */
351     }
352     *target_len = len * 3 / 4;
353     target = av_mallocz(*target_len + FF_INPUT_BUFFER_PADDING_SIZE);
354     av_base64_decode(target, p, *target_len);
355     return target;
356 }
357
358 static int
359 rdt_parse_sdp_line (AVStream *stream, PayloadContext *rdt, const char *line)
360 {
361     const char *p = line;
362
363     if (av_strstart(p, "OpaqueData:buffer;", &p)) {
364         rdt->mlti_data = rdt_parse_b64buf(&rdt->mlti_data_size, p);
365     } else if (av_strstart(p, "StartTime:integer;", &p))
366         stream->first_dts = atoi(p);
367
368     return 0;
369 }
370
371 static PayloadContext *
372 rdt_new_extradata (void)
373 {
374     PayloadContext *rdt = av_mallocz(sizeof(PayloadContext));
375
376     av_open_input_stream(&rdt->rmctx, NULL, "", &rdt_demuxer, NULL);
377
378     return rdt;
379 }
380
381 static void
382 rdt_free_extradata (PayloadContext *rdt)
383 {
384     if (rdt->rmctx)
385         av_close_input_stream(rdt->rmctx);
386     av_freep(&rdt->mlti_data);
387     av_free(rdt);
388 }
389
390 #define RDT_HANDLER(n, s, t) \
391 static RTPDynamicProtocolHandler ff_rdt_ ## n ## _handler = { \
392     s, \
393     t, \
394     CODEC_ID_NONE, \
395     rdt_parse_sdp_line, \
396     rdt_new_extradata, \
397     rdt_free_extradata, \
398     rdt_parse_packet \
399 };
400
401 RDT_HANDLER(live_video, "x-pn-multirate-realvideo-live", CODEC_TYPE_VIDEO);
402 RDT_HANDLER(live_audio, "x-pn-multirate-realaudio-live", CODEC_TYPE_AUDIO);
403 RDT_HANDLER(video,      "x-pn-realvideo",                CODEC_TYPE_VIDEO);
404 RDT_HANDLER(audio,      "x-pn-realaudio",                CODEC_TYPE_AUDIO);
405
406 void av_register_rdt_dynamic_payload_handlers(void)
407 {
408     ff_register_dynamic_payload_handler(&ff_rdt_video_handler);
409     ff_register_dynamic_payload_handler(&ff_rdt_audio_handler);
410     ff_register_dynamic_payload_handler(&ff_rdt_live_video_handler);
411     ff_register_dynamic_payload_handler(&ff_rdt_live_audio_handler);
412 }