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