2 * MMS protocol over TCP
3 * Copyright (c) 2006,2007 Ryan Martell
4 * Copyright (c) 2007 Björn Axelsson
5 * Copyright (c) 2010 Zhentan Feng <spyfeng at gmail dot com>
7 * This file is part of FFmpeg.
9 * FFmpeg is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * FFmpeg is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with FFmpeg; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "libavutil/intreadwrite.h"
26 #include "libavcodec/bytestream.h"
30 #define LOCAL_ADDRESS 0xc0a80081 // FIXME get and use correct local ip address.
31 #define LOCAL_PORT 1037 // as above.
32 /** Client to server packet types. */
34 CS_PKT_INITIAL = 0x01,
35 CS_PKT_PROTOCOL_SELECT = 0x02,
36 CS_PKT_MEDIA_FILE_REQUEST = 0x05,
37 CS_PKT_START_FROM_PKT_ID = 0x07,
38 CS_PKT_STREAM_PAUSE = 0x09,
39 CS_PKT_STREAM_CLOSE = 0x0d,
40 CS_PKT_MEDIA_HEADER_REQUEST = 0x15,
41 CS_PKT_TIMING_DATA_REQUEST = 0x18,
42 CS_PKT_USER_PASSWORD = 0x1a,
43 CS_PKT_KEEPALIVE = 0x1b,
44 CS_PKT_STREAM_ID_REQUEST = 0x33,
47 /** Server to client packet types. */
49 /** Control packets. */
51 SC_PKT_CLIENT_ACCEPTED = 0x01,
52 SC_PKT_PROTOCOL_ACCEPTED = 0x02,
53 SC_PKT_PROTOCOL_FAILED = 0x03,
54 SC_PKT_MEDIA_PKT_FOLLOWS = 0x05,
55 SC_PKT_MEDIA_FILE_DETAILS = 0x06,
56 SC_PKT_HEADER_REQUEST_ACCEPTED = 0x11,
57 SC_PKT_TIMING_TEST_REPLY = 0x15,
58 SC_PKT_PASSWORD_REQUIRED = 0x1a,
59 SC_PKT_KEEPALIVE = 0x1b,
60 SC_PKT_STREAM_STOPPED = 0x1e,
61 SC_PKT_STREAM_CHANGING = 0x20,
62 SC_PKT_STREAM_ID_ACCEPTED = 0x21,
65 /** Pseudo packets. */
73 SC_PKT_ASF_HEADER = 0x010000,// make it bigger than 0xFF in case of
74 SC_PKT_ASF_MEDIA = 0x010001,// receiving false data packets.
83 int outgoing_packet_seq; ///< Outgoing packet sequence number.
84 char path[256]; ///< Path of the resource being asked for.
85 char host[128]; ///< Host of the resources.
87 URLContext *mms_hd; ///< TCP connection handle
88 MMSStream streams[MAX_STREAMS];
90 /** Buffer for outgoing packets. */
92 uint8_t *write_out_ptr; ///< Pointer for writting the buffer.
93 uint8_t out_buffer[512]; ///< Buffer for outgoing packet.
96 /** Buffer for incoming packets. */
98 uint8_t in_buffer[8192]; ///< Buffer for incoming packets.
99 uint8_t *read_in_ptr; ///< Pointer for reading from incoming buffer.
100 int remaining_in_len; ///< Reading length from incoming buffer.
103 int incoming_packet_seq; ///< Incoming packet sequence number.
104 int incoming_flags; ///< Incoming packet flags.
106 int packet_id; ///< Identifier for packets in the current stream.
107 unsigned int header_packet_id; ///< default is 2.
109 /** Internal handling of the ASF header */
111 uint8_t *asf_header; ///< Stored ASF header.
112 int asf_header_size; ///< Size of stored ASF header.
113 int header_parsed; ///< The header has been received and parsed.
117 int stream_num; ///< stream numbers.
121 /** Create MMST command packet header */
122 static void start_command_packet(MMSContext *mms, MMSCSPacketType packet_type)
124 mms->write_out_ptr = mms->out_buffer;
126 bytestream_put_le32(&mms->write_out_ptr, 1); // start sequence
127 bytestream_put_le32(&mms->write_out_ptr, 0xb00bface);
128 bytestream_put_le32(&mms->write_out_ptr, 0); // Length starts from after the protocol type bytes
129 bytestream_put_le32(&mms->write_out_ptr, MKTAG('M','M','S',' '));
130 bytestream_put_le32(&mms->write_out_ptr, 0);
131 bytestream_put_le32(&mms->write_out_ptr, mms->outgoing_packet_seq++);
132 bytestream_put_le64(&mms->write_out_ptr, 0); // timestamp
133 bytestream_put_le32(&mms->write_out_ptr, 0);
134 bytestream_put_le16(&mms->write_out_ptr, packet_type);
135 bytestream_put_le16(&mms->write_out_ptr, 3); // direction to server
138 /** Add prefixes to MMST command packet. */
139 static void insert_command_prefixes(MMSContext *mms,
140 uint32_t prefix1, uint32_t prefix2)
142 bytestream_put_le32(&mms->write_out_ptr, prefix1); // first prefix
143 bytestream_put_le32(&mms->write_out_ptr, prefix2); // second prefix
146 /** Send a prepared MMST command packet. */
147 static int send_command_packet(MMSContext *mms)
149 int exact_length= mms->write_out_ptr - mms->out_buffer;
150 int first_length= exact_length - 16;
151 int len8= first_length/8;
154 // update packet length fields.
155 AV_WL32(mms->out_buffer + 8, first_length);
156 AV_WL32(mms->out_buffer + 16, len8);
157 AV_WL32(mms->out_buffer + 32, len8-2);
160 write_result= url_write(mms->mms_hd, mms->out_buffer, exact_length);
161 if(write_result != exact_length) {
162 dprintf(NULL, "url_write returned: %d != %d\n",
163 write_result, exact_length);
170 static void mms_put_utf16(MMSContext *mms, uint8_t *src)
173 int size = mms->write_out_ptr - mms->out_buffer;
175 init_put_byte(&bic, mms->write_out_ptr,
176 sizeof(mms->out_buffer) - size, 1, NULL, NULL, NULL, NULL);
178 len = ff_put_str16_nolen(&bic, src);
179 mms->write_out_ptr += len;
182 static int send_time_test_data(MMSContext *mms)
184 start_command_packet(mms, CS_PKT_TIMING_DATA_REQUEST);
185 insert_command_prefixes(mms, 0xf0f0f0f1, 0x0004000b);
186 return send_command_packet(mms);
189 static int send_protocol_select(MMSContext *mms)
191 char data_string[256];
193 start_command_packet(mms, CS_PKT_PROTOCOL_SELECT);
194 insert_command_prefixes(mms, 0, 0xffffffff);
195 bytestream_put_le32(&mms->write_out_ptr, 0); // maxFunnelBytes
196 bytestream_put_le32(&mms->write_out_ptr, 0x00989680); // maxbitRate
197 bytestream_put_le32(&mms->write_out_ptr, 2); // funnelMode
198 snprintf(data_string, sizeof(data_string), "\\\\%d.%d.%d.%d\\%s\\%d",
199 (LOCAL_ADDRESS>>24)&0xff,
200 (LOCAL_ADDRESS>>16)&0xff,
201 (LOCAL_ADDRESS>>8)&0xff,
206 mms_put_utf16(mms, data_string);
207 return send_command_packet(mms);
210 static int send_media_file_request(MMSContext *mms)
212 start_command_packet(mms, CS_PKT_MEDIA_FILE_REQUEST);
213 insert_command_prefixes(mms, 1, 0xffffffff);
214 bytestream_put_le32(&mms->write_out_ptr, 0);
215 bytestream_put_le32(&mms->write_out_ptr, 0);
216 mms_put_utf16(mms, mms->path + 1); // +1 for skip "/"
218 return send_command_packet(mms);
221 static void handle_packet_stream_changing_type(MMSContext *mms)
223 dprintf(NULL, "Stream changing!\n");
225 // 40 is the packet header size, 7 is the prefix size.
226 mms->header_packet_id= AV_RL32(mms->in_buffer + 40 + 7);
227 dprintf(NULL, "Changed header prefix to 0x%x", mms->header_packet_id);
230 static int send_keepalive_packet(MMSContext *mms)
232 // respond to a keepalive with a keepalive...
233 start_command_packet(mms, CS_PKT_KEEPALIVE);
234 insert_command_prefixes(mms, 1, 0x100FFFF);
235 return send_command_packet(mms);
238 /** Pad media packets smaller than max_packet_size and/or adjust read position
240 static void pad_media_packet(MMSContext *mms)
242 if(mms->remaining_in_len<mms->asf_packet_len) {
243 int padding_size = mms->asf_packet_len - mms->remaining_in_len;
244 memset(mms->in_buffer + mms->remaining_in_len, 0, padding_size);
245 mms->remaining_in_len += padding_size;
249 /** Read incoming MMST media, header or command packet. */
250 static MMSSCPacketType get_tcp_server_response(MMSContext *mms)
253 MMSSCPacketType packet_type= -1;
256 if((read_result= url_read_complete(mms->mms_hd, mms->in_buffer, 8))==8) {
257 // handle command packet.
258 if(AV_RL32(mms->in_buffer + 4)==0xb00bface) {
259 mms->incoming_flags= mms->in_buffer[3];
260 read_result= url_read_complete(mms->mms_hd, mms->in_buffer+8, 4);
261 if(read_result == 4) {
262 int length_remaining= AV_RL32(mms->in_buffer+8) + 4;
265 dprintf(NULL, "Length remaining is %d\n", length_remaining);
266 // read the rest of the packet.
267 if (length_remaining < 0
268 || length_remaining > sizeof(mms->in_buffer) - 12) {
269 dprintf(NULL, "Incoming message len %d exceeds buffer len %d\n",
270 length_remaining, sizeof(mms->in_buffer) - 12);
273 read_result = url_read_complete(mms->mms_hd, mms->in_buffer + 12,
275 if (read_result == length_remaining) {
276 packet_type= AV_RL16(mms->in_buffer+36);
278 dprintf(NULL, "read for packet type failed%d!\n", read_result);
281 hr = AV_RL32(mms->in_buffer + 40);
283 dprintf(NULL, "The server side send back error code:0x%x\n", hr);
287 dprintf(NULL, "read for length remaining failed%d!\n", read_result);
291 int length_remaining;
295 assert(mms->remaining_in_len==0);
297 // note we cache the first 8 bytes,
298 // then fill up the buffer with the others
299 tmp = AV_RL16(mms->in_buffer + 6);
300 length_remaining = (tmp - 8) & 0xffff;
301 mms->incoming_packet_seq = AV_RL32(mms->in_buffer);
302 packet_id_type = mms->in_buffer[4];
303 mms->incoming_flags = mms->in_buffer[5];
305 if (length_remaining < 0
306 || length_remaining > sizeof(mms->in_buffer) - 8) {
307 dprintf(NULL, "Incoming data len %d exceeds buffer len %d\n",
308 length_remaining, sizeof(mms->in_buffer));
311 mms->remaining_in_len = length_remaining;
312 mms->read_in_ptr = mms->in_buffer;
313 read_result= url_read_complete(mms->mms_hd, mms->in_buffer, length_remaining);
314 if(read_result != length_remaining) {
315 dprintf(NULL, "read_bytes result: %d asking for %d\n",
316 read_result, length_remaining);
319 // if we successfully read everything.
320 if(packet_id_type == mms->header_packet_id) {
321 packet_type = SC_PKT_ASF_HEADER;
322 // Store the asf header
323 if(!mms->header_parsed) {
324 void *p = av_realloc(mms->asf_header,
326 + mms->remaining_in_len);
328 av_freep(&mms->asf_header);
329 return AVERROR(ENOMEM);
332 memcpy(mms->asf_header + mms->asf_header_size,
334 mms->remaining_in_len);
335 mms->asf_header_size += mms->remaining_in_len;
337 } else if(packet_id_type == mms->packet_id) {
338 packet_type = SC_PKT_ASF_MEDIA;
340 dprintf(NULL, "packet id type %d is old.", packet_id_type);
346 // preprocess some packet type
347 if(packet_type == SC_PKT_KEEPALIVE) {
348 send_keepalive_packet(mms);
350 } else if(packet_type == SC_PKT_STREAM_CHANGING) {
351 handle_packet_stream_changing_type(mms);
352 } else if(packet_type == SC_PKT_ASF_MEDIA) {
353 pad_media_packet(mms);
358 dprintf(NULL, "Read error (or cancelled) returned %d!\n", read_result);
359 packet_type = SC_PKT_CANCEL;
361 dprintf(NULL, "Read result of zero?!\n");
362 packet_type = SC_PKT_NO_DATA;
369 static int mms_safe_send_recv(MMSContext *mms,
370 int (*send_fun)(MMSContext *mms),
371 const MMSSCPacketType expect_type)
373 MMSSCPacketType type;
375 int ret = send_fun(mms);
377 dprintf(NULL, "Send Packet error before expecting recv packet %d\n", expect_type);
382 if ((type = get_tcp_server_response(mms)) != expect_type) {
383 dprintf(NULL,"Unexpected packet type %d with type %d\n", type, expect_type);
390 static int send_media_header_request(MMSContext *mms)
392 start_command_packet(mms, CS_PKT_MEDIA_HEADER_REQUEST);
393 insert_command_prefixes(mms, 1, 0);
394 bytestream_put_le32(&mms->write_out_ptr, 0);
395 bytestream_put_le32(&mms->write_out_ptr, 0x00800000);
396 bytestream_put_le32(&mms->write_out_ptr, 0xffffffff);
397 bytestream_put_le32(&mms->write_out_ptr, 0);
398 bytestream_put_le32(&mms->write_out_ptr, 0);
399 bytestream_put_le32(&mms->write_out_ptr, 0);
401 // the media preroll value in milliseconds?
402 bytestream_put_le32(&mms->write_out_ptr, 0);
403 bytestream_put_le32(&mms->write_out_ptr, 0x40AC2000);
404 bytestream_put_le32(&mms->write_out_ptr, 2);
405 bytestream_put_le32(&mms->write_out_ptr, 0);
407 return send_command_packet(mms);
410 /** Send the initial handshake. */
411 static int send_startup_packet(MMSContext *mms)
413 char data_string[256];
414 // SubscriberName is defined in MS specification linked below.
415 // The guid value can be any valid value.
416 // http://download.microsoft.com/
417 // download/9/5/E/95EF66AF-9026-4BB0-A41D-A4F81802D92C/%5BMS-WMSP%5D.pdf
418 snprintf(data_string, sizeof(data_string),
419 "NSPlayer/7.0.0.1956; {%s}; Host: %s",
420 "7E667F5D-A661-495E-A512-F55686DDA178", mms->host);
422 start_command_packet(mms, CS_PKT_INITIAL);
423 insert_command_prefixes(mms, 0, 0x0004000b);
424 bytestream_put_le32(&mms->write_out_ptr, 0x0003001c);
425 mms_put_utf16(mms, data_string);
426 return send_command_packet(mms);
429 static int asf_header_parser(MMSContext *mms)
431 uint8_t *p = mms->asf_header;
433 int flags, stream_id, real_header_size;
436 if (mms->asf_header_size < sizeof(ff_asf_guid) * 2 + 22 ||
437 memcmp(p, ff_asf_header, sizeof(ff_asf_guid)))
440 real_header_size = AV_RL64(p + sizeof(ff_asf_guid));
441 end = mms->asf_header + real_header_size;
443 p += sizeof(ff_asf_guid) + 14;
444 while(end - p >= sizeof(ff_asf_guid) + 8) {
445 uint64_t chunksize = AV_RL64(p + sizeof(ff_asf_guid));
446 if (!chunksize || chunksize > end - p) {
447 dprintf(NULL, "chunksize is exceptional value:%"PRId64"!\n", chunksize);
450 if (!memcmp(p, ff_asf_file_header, sizeof(ff_asf_guid))) {
451 /* read packet size */
452 if (end - p > sizeof(ff_asf_guid) * 2 + 68) {
453 mms->asf_packet_len = AV_RL32(p + sizeof(ff_asf_guid) * 2 + 64);
454 if (mms->asf_packet_len <= 0 || mms->asf_packet_len > sizeof(mms->in_buffer)) {
455 dprintf(NULL,"Too large packet len:%d"
456 " may overwrite in_buffer when padding", mms->asf_packet_len);
460 } else if (!memcmp(p, ff_asf_stream_header, sizeof(ff_asf_guid))) {
461 flags = AV_RL16(p + sizeof(ff_asf_guid)*3 + 24);
462 stream_id = flags & 0x7F;
463 //The second condition is for checking CS_PKT_STREAM_ID_REQUEST packet size,
464 //we can calcuate the packet size by stream_num.
465 //Please see function send_stream_selection_request().
466 if (mms->stream_num < MAX_STREAMS &&
467 46 + mms->stream_num * 6 < sizeof(mms->out_buffer)) {
468 mms->streams[mms->stream_num].id = stream_id;
471 dprintf(NULL, "Too many streams.\n");
481 /** Send MMST stream selection command based on the AVStream->discard values. */
482 static int send_stream_selection_request(MMSContext *mms)
486 // send the streams we want back...
487 start_command_packet(mms, CS_PKT_STREAM_ID_REQUEST);
488 bytestream_put_le32(&mms->write_out_ptr, mms->stream_num); // stream nums
489 for(i= 0; i<mms->stream_num; i++) {
490 bytestream_put_le16(&mms->write_out_ptr, 0xffff); // flags
491 bytestream_put_le16(&mms->write_out_ptr, mms->streams[i].id); // stream id
492 bytestream_put_le16(&mms->write_out_ptr, 0); // selection
495 bytestream_put_le16(&mms->write_out_ptr, 0);
497 return send_command_packet(mms);
500 static int read_data(MMSContext *mms, uint8_t *buf, const int buf_size)
503 read_size = FFMIN(buf_size, mms->remaining_in_len);
504 memcpy(buf, mms->read_in_ptr, read_size);
505 mms->remaining_in_len -= read_size;
506 mms->read_in_ptr += read_size;
510 /** Read at most one media packet (or a whole header). */
511 static int read_mms_packet(MMSContext *mms, uint8_t *buf, int buf_size)
513 int result = 0, read_header_size = 0;
517 if(read_header_size < mms->asf_header_size && !mms->is_playing) {
518 /* Read from ASF header buffer */
519 size_to_copy= FFMIN(buf_size,
520 mms->asf_header_size - read_header_size);
521 memcpy(buf, mms->asf_header + read_header_size, size_to_copy);
522 read_header_size += size_to_copy;
523 result += size_to_copy;
524 dprintf(NULL, "Copied %d bytes from stored header. left: %d\n",
525 size_to_copy, mms->asf_header_size - read_header_size);
526 if (mms->asf_header_size == read_header_size) {
527 av_freep(&mms->asf_header);
530 } else if(mms->remaining_in_len) {
531 /* Read remaining packet data to buffer.
532 * the result can not be zero because remaining_in_len is positive.*/
533 result = read_data(mms, buf, buf_size);
535 /* Read from network */
536 int err = mms_safe_send_recv(mms, NULL, SC_PKT_ASF_MEDIA);
538 if(mms->remaining_in_len>mms->asf_packet_len) {
539 dprintf(NULL, "Incoming packet"
540 "larger than the asf packet size stated (%d>%d)\n",
541 mms->remaining_in_len, mms->asf_packet_len);
544 // copy the data to the packet buffer.
545 result = read_data(mms, buf, buf_size);
547 dprintf(NULL, "read asf media paket size is zero!\n");
552 dprintf(NULL, "read packet error!\n");
556 } while(!result); // only return one packet.
560 static int send_close_packet(MMSContext *mms)
562 start_command_packet(mms, CS_PKT_STREAM_CLOSE);
563 insert_command_prefixes(mms, 1, 1);
565 return send_command_packet(mms);
568 /** Close the MMSH/MMST connection */
569 static int mms_close(URLContext *h)
571 MMSContext *mms = (MMSContext *)h->priv_data;
574 send_close_packet(mms);
575 url_close(mms->mms_hd);
578 /* free all separately allocated pointers in mms */
579 av_free(mms->asf_header);
580 av_freep(&h->priv_data);
585 static int mms_open(URLContext *h, const char *uri, int flags)
592 mms = h->priv_data = av_mallocz(sizeof(MMSContext));
594 return AVERROR(ENOMEM);
596 // only for MMS over TCP, so set proto = NULL
597 av_url_split(NULL, 0, NULL, 0,
598 mms->host, sizeof(mms->host), &port, mms->path,
599 sizeof(mms->path), uri);
602 port = 1755; // defaut mms protocol port
604 // establish tcp connection.
605 ff_url_join(tcpname, sizeof(tcpname), "tcp", NULL, mms->host, port, NULL);
606 err = url_open(&mms->mms_hd, tcpname, URL_RDWR);
610 mms->packet_id = 3; // default, initial value.
611 mms->header_packet_id = 2; // default, initial value.
612 err = mms_safe_send_recv(mms, send_startup_packet, SC_PKT_CLIENT_ACCEPTED);
615 err = mms_safe_send_recv(mms, send_time_test_data, SC_PKT_TIMING_TEST_REPLY);
618 err = mms_safe_send_recv(mms, send_protocol_select, SC_PKT_PROTOCOL_ACCEPTED);
621 err = mms_safe_send_recv(mms, send_media_file_request, SC_PKT_MEDIA_FILE_DETAILS);
624 err = mms_safe_send_recv(mms, send_media_header_request, SC_PKT_HEADER_REQUEST_ACCEPTED);
627 err = mms_safe_send_recv(mms, NULL, SC_PKT_ASF_HEADER);
630 if((mms->incoming_flags != 0X08) && (mms->incoming_flags != 0X0C))
632 err = asf_header_parser(mms);
634 dprintf(NULL, "asf header parsed failed!\n");
637 mms->header_parsed = 1;
639 if (!mms->asf_packet_len || !mms->stream_num)
642 dprintf(NULL, "Leaving open (success)\n");
646 dprintf(NULL, "Leaving open (failure: %d)\n", err);
650 static int send_media_packet_request(MMSContext *mms)
652 start_command_packet(mms, CS_PKT_START_FROM_PKT_ID);
653 insert_command_prefixes(mms, 1, 0x0001FFFF);
654 bytestream_put_le64(&mms->write_out_ptr, 0); // seek timestamp
655 bytestream_put_le32(&mms->write_out_ptr, 0xffffffff); // unknown
656 bytestream_put_le32(&mms->write_out_ptr, 0xffffffff); // packet offset
657 bytestream_put_byte(&mms->write_out_ptr, 0xff); // max stream time limit
658 bytestream_put_byte(&mms->write_out_ptr, 0xff); // max stream time limit
659 bytestream_put_byte(&mms->write_out_ptr, 0xff); // max stream time limit
660 bytestream_put_byte(&mms->write_out_ptr, 0x00); // stream time limit flag
662 mms->packet_id++; // new packet_id
663 bytestream_put_le32(&mms->write_out_ptr, mms->packet_id);
664 return send_command_packet(mms);
668 static void clear_stream_buffers(MMSContext *mms)
670 mms->remaining_in_len = 0;
671 mms->read_in_ptr = mms->in_buffer;
674 /** Read ASF data through the protocol. */
675 static int mms_read(URLContext *h, uint8_t *buf, int size)
677 /* TODO: see tcp.c:tcp_read() about a possible timeout scheme */
678 MMSContext *mms = h->priv_data;
681 /* Since we read the header at open(), this shouldn't be possible */
682 assert(mms->header_parsed);
684 if (!mms->is_playing) {
685 dprintf(NULL, "mms_read() before play().\n");
686 clear_stream_buffers(mms);
687 result = mms_safe_send_recv(mms, send_stream_selection_request, SC_PKT_STREAM_ID_ACCEPTED);
690 // send media packet request
691 result = mms_safe_send_recv(mms, send_media_packet_request, SC_PKT_MEDIA_PKT_FOLLOWS);
696 return read_mms_packet(mms, buf, size);
699 URLProtocol mmst_protocol = {