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 * MMS protocol specification:
26 * [1]http://msdn.microsoft.com/en-us/library/cc234711(PROT.10).aspx
27 * ASF specification. Revision 01.20.03.
28 * [2]http://msdn.microsoft.com/en-us/library/bb643323.aspx
34 #include "libavutil/intreadwrite.h"
35 #include "libavcodec/bytestream.h"
39 #define LOCAL_ADDRESS 0xc0a80081 // FIXME get and use correct local ip address.
40 #define LOCAL_PORT 1037 // as above.
41 /** Client to server packet types. */
43 CS_PKT_INITIAL = 0x01,
44 CS_PKT_PROTOCOL_SELECT = 0x02,
45 CS_PKT_MEDIA_FILE_REQUEST = 0x05,
46 CS_PKT_START_FROM_PKT_ID = 0x07,
47 CS_PKT_STREAM_PAUSE = 0x09,
48 CS_PKT_STREAM_CLOSE = 0x0d,
49 CS_PKT_MEDIA_HEADER_REQUEST = 0x15,
50 CS_PKT_TIMING_DATA_REQUEST = 0x18,
51 CS_PKT_USER_PASSWORD = 0x1a,
52 CS_PKT_KEEPALIVE = 0x1b,
53 CS_PKT_STREAM_ID_REQUEST = 0x33,
56 /** Server to client packet types. */
58 /** Control packets. */
60 SC_PKT_CLIENT_ACCEPTED = 0x01,
61 SC_PKT_PROTOCOL_ACCEPTED = 0x02,
62 SC_PKT_PROTOCOL_FAILED = 0x03,
63 SC_PKT_MEDIA_PKT_FOLLOWS = 0x05,
64 SC_PKT_MEDIA_FILE_DETAILS = 0x06,
65 SC_PKT_HEADER_REQUEST_ACCEPTED = 0x11,
66 SC_PKT_TIMING_TEST_REPLY = 0x15,
67 SC_PKT_PASSWORD_REQUIRED = 0x1a,
68 SC_PKT_KEEPALIVE = 0x1b,
69 SC_PKT_STREAM_STOPPED = 0x1e,
70 SC_PKT_STREAM_CHANGING = 0x20,
71 SC_PKT_STREAM_ID_ACCEPTED = 0x21,
74 /** Pseudo packets. */
82 SC_PKT_ASF_HEADER = 0x010000,// make it bigger than 0xFF in case of
83 SC_PKT_ASF_MEDIA = 0x010001,// receiving false data packets.
89 int outgoing_packet_seq; ///< Outgoing packet sequence number.
90 char path[256]; ///< Path of the resource being asked for.
91 char host[128]; ///< Host of the resources.
92 int incoming_packet_seq; ///< Incoming packet sequence number.
93 int incoming_flags; ///< Incoming packet flags.
94 int packet_id; ///< Identifier for packets in the current stream.
95 unsigned int header_packet_id; ///< default is 2.
98 /** Create MMST command packet header */
99 static void start_command_packet(MMSTContext *mmst, MMSCSPacketType packet_type)
101 MMSContext *mms = &mmst->mms;
102 mms->write_out_ptr = mms->out_buffer;
104 bytestream_put_le32(&mms->write_out_ptr, 1); // start sequence
105 bytestream_put_le32(&mms->write_out_ptr, 0xb00bface);
106 bytestream_put_le32(&mms->write_out_ptr, 0); // Length starts from after the protocol type bytes
107 bytestream_put_le32(&mms->write_out_ptr, MKTAG('M','M','S',' '));
108 bytestream_put_le32(&mms->write_out_ptr, 0);
109 bytestream_put_le32(&mms->write_out_ptr, mmst->outgoing_packet_seq++);
110 bytestream_put_le64(&mms->write_out_ptr, 0); // timestamp
111 bytestream_put_le32(&mms->write_out_ptr, 0);
112 bytestream_put_le16(&mms->write_out_ptr, packet_type);
113 bytestream_put_le16(&mms->write_out_ptr, 3); // direction to server
116 /** Add prefixes to MMST command packet. */
117 static void insert_command_prefixes(MMSContext *mms,
118 uint32_t prefix1, uint32_t prefix2)
120 bytestream_put_le32(&mms->write_out_ptr, prefix1); // first prefix
121 bytestream_put_le32(&mms->write_out_ptr, prefix2); // second prefix
124 /** Send a prepared MMST command packet. */
125 static int send_command_packet(MMSTContext *mmst)
127 MMSContext *mms = &mmst->mms;
128 int len= mms->write_out_ptr - mms->out_buffer;
129 int exact_length = FFALIGN(len, 8);
130 int first_length= exact_length - 16;
131 int len8= first_length/8;
134 // update packet length fields.
135 AV_WL32(mms->out_buffer + 8, first_length);
136 AV_WL32(mms->out_buffer + 16, len8);
137 AV_WL32(mms->out_buffer + 32, len8-2);
138 memset(mms->write_out_ptr, 0, exact_length - len);
141 write_result= url_write(mms->mms_hd, mms->out_buffer, exact_length);
142 if(write_result != exact_length) {
143 av_log(NULL, AV_LOG_ERROR,
144 "Failed to write data of length %d: %d (%s)\n",
145 exact_length, write_result,
146 write_result < 0 ? strerror(write_result) :
147 "The server closed the connection");
154 static void mms_put_utf16(MMSContext *mms, uint8_t *src)
157 int size = mms->write_out_ptr - mms->out_buffer;
159 init_put_byte(&bic, mms->write_out_ptr,
160 sizeof(mms->out_buffer) - size, 1, NULL, NULL, NULL, NULL);
162 len = ff_put_str16_nolen(&bic, src);
163 mms->write_out_ptr += len;
166 static int send_time_test_data(MMSTContext *mmst)
168 start_command_packet(mmst, CS_PKT_TIMING_DATA_REQUEST);
169 insert_command_prefixes(&mmst->mms, 0x00f0f0f0, 0x0004000b);
170 return send_command_packet(mmst);
173 static int send_protocol_select(MMSTContext *mmst)
175 char data_string[256];
176 MMSContext *mms = &mmst->mms;
178 start_command_packet(mmst, CS_PKT_PROTOCOL_SELECT);
179 insert_command_prefixes(mms, 0, 0xffffffff);
180 bytestream_put_le32(&mms->write_out_ptr, 0); // maxFunnelBytes
181 bytestream_put_le32(&mms->write_out_ptr, 0x00989680); // maxbitRate
182 bytestream_put_le32(&mms->write_out_ptr, 2); // funnelMode
183 snprintf(data_string, sizeof(data_string), "\\\\%d.%d.%d.%d\\%s\\%d",
184 (LOCAL_ADDRESS>>24)&0xff,
185 (LOCAL_ADDRESS>>16)&0xff,
186 (LOCAL_ADDRESS>>8)&0xff,
191 mms_put_utf16(mms, data_string);
192 return send_command_packet(mmst);
195 static int send_media_file_request(MMSTContext *mmst)
197 MMSContext *mms = &mmst->mms;
198 start_command_packet(mmst, CS_PKT_MEDIA_FILE_REQUEST);
199 insert_command_prefixes(mms, 1, 0xffffffff);
200 bytestream_put_le32(&mms->write_out_ptr, 0);
201 bytestream_put_le32(&mms->write_out_ptr, 0);
202 mms_put_utf16(mms, mmst->path + 1); // +1 for skip "/"
204 return send_command_packet(mmst);
207 static void handle_packet_stream_changing_type(MMSTContext *mmst)
209 MMSContext *mms = &mmst->mms;
210 dprintf(NULL, "Stream changing!\n");
212 // 40 is the packet header size, 7 is the prefix size.
213 mmst->header_packet_id= AV_RL32(mms->in_buffer + 40 + 7);
214 dprintf(NULL, "Changed header prefix to 0x%x", mmst->header_packet_id);
217 static int send_keepalive_packet(MMSTContext *mmst)
219 // respond to a keepalive with a keepalive...
220 start_command_packet(mmst, CS_PKT_KEEPALIVE);
221 insert_command_prefixes(&mmst->mms, 1, 0x100FFFF);
222 return send_command_packet(mmst);
225 /** Pad media packets smaller than max_packet_size and/or adjust read position
227 static void pad_media_packet(MMSContext *mms)
229 if(mms->remaining_in_len<mms->asf_packet_len) {
230 int padding_size = mms->asf_packet_len - mms->remaining_in_len;
231 memset(mms->in_buffer + mms->remaining_in_len, 0, padding_size);
232 mms->remaining_in_len += padding_size;
236 /** Read incoming MMST media, header or command packet. */
237 static MMSSCPacketType get_tcp_server_response(MMSTContext *mmst)
240 MMSSCPacketType packet_type= -1;
241 MMSContext *mms = &mmst->mms;
243 read_result = url_read_complete(mms->mms_hd, mms->in_buffer, 8);
244 if (read_result != 8) {
245 if(read_result < 0) {
246 av_log(NULL, AV_LOG_ERROR,
247 "Error reading packet header: %d (%s)\n",
248 read_result, strerror(read_result));
249 packet_type = SC_PKT_CANCEL;
251 av_log(NULL, AV_LOG_ERROR,
252 "The server closed the connection\n");
253 packet_type = SC_PKT_NO_DATA;
258 // handle command packet.
259 if(AV_RL32(mms->in_buffer + 4)==0xb00bface) {
260 int length_remaining, hr;
262 mmst->incoming_flags= mms->in_buffer[3];
263 read_result= url_read_complete(mms->mms_hd, mms->in_buffer+8, 4);
264 if(read_result != 4) {
265 av_log(NULL, AV_LOG_ERROR,
266 "Reading command packet length failed: %d (%s)\n",
268 read_result < 0 ? strerror(read_result) :
269 "The server closed the connection");
270 return read_result < 0 ? read_result : AVERROR_IO;
273 length_remaining= AV_RL32(mms->in_buffer+8) + 4;
274 dprintf(NULL, "Length remaining is %d\n", length_remaining);
275 // read the rest of the packet.
276 if (length_remaining < 0
277 || length_remaining > sizeof(mms->in_buffer) - 12) {
278 av_log(NULL, AV_LOG_ERROR,
279 "Incoming packet length %d exceeds bufsize %zu\n",
280 length_remaining, sizeof(mms->in_buffer) - 12);
281 return AVERROR_INVALIDDATA;
283 read_result = url_read_complete(mms->mms_hd, mms->in_buffer + 12,
285 if (read_result != length_remaining) {
286 av_log(NULL, AV_LOG_ERROR,
287 "Reading pkt data (length=%d) failed: %d (%s)\n",
288 length_remaining, read_result,
289 read_result < 0 ? strerror(read_result) :
290 "The server closed the connection");
291 return read_result < 0 ? read_result : AVERROR_IO;
293 packet_type= AV_RL16(mms->in_buffer+36);
294 hr = AV_RL32(mms->in_buffer + 40);
296 av_log(NULL, AV_LOG_ERROR,
297 "Server sent an error status code: 0x%08x\n", hr);
298 return AVERROR_UNKNOWN;
301 int length_remaining;
305 // note we cache the first 8 bytes,
306 // then fill up the buffer with the others
307 tmp = AV_RL16(mms->in_buffer + 6);
308 length_remaining = (tmp - 8) & 0xffff;
309 mmst->incoming_packet_seq = AV_RL32(mms->in_buffer);
310 packet_id_type = mms->in_buffer[4];
311 mmst->incoming_flags = mms->in_buffer[5];
313 if (length_remaining < 0
314 || length_remaining > sizeof(mms->in_buffer) - 8) {
315 av_log(NULL, AV_LOG_ERROR,
316 "Data length %d is invalid or too large (max=%zu)\n",
317 length_remaining, sizeof(mms->in_buffer));
318 return AVERROR_INVALIDDATA;
320 mms->remaining_in_len = length_remaining;
321 mms->read_in_ptr = mms->in_buffer;
322 read_result= url_read_complete(mms->mms_hd, mms->in_buffer, length_remaining);
323 if(read_result != length_remaining) {
324 av_log(NULL, AV_LOG_ERROR,
325 "Failed to read packet data of size %d: %d (%s)\n",
326 length_remaining, read_result,
327 read_result < 0 ? strerror(read_result) :
328 "The server closed the connection");
329 return read_result < 0 ? read_result : AVERROR_IO;
332 // if we successfully read everything.
333 if(packet_id_type == mmst->header_packet_id) {
334 packet_type = SC_PKT_ASF_HEADER;
335 // Store the asf header
336 if(!mms->header_parsed) {
337 void *p = av_realloc(mms->asf_header,
338 mms->asf_header_size + mms->remaining_in_len);
340 av_freep(&mms->asf_header);
341 return AVERROR(ENOMEM);
344 memcpy(mms->asf_header + mms->asf_header_size,
345 mms->read_in_ptr, mms->remaining_in_len);
346 mms->asf_header_size += mms->remaining_in_len;
348 // 0x04 means asf header is sent in multiple packets.
349 if (mmst->incoming_flags == 0x04)
351 } else if(packet_id_type == mmst->packet_id) {
352 packet_type = SC_PKT_ASF_MEDIA;
354 dprintf(NULL, "packet id type %d is old.", packet_id_type);
359 // preprocess some packet type
360 if(packet_type == SC_PKT_KEEPALIVE) {
361 send_keepalive_packet(mmst);
363 } else if(packet_type == SC_PKT_STREAM_CHANGING) {
364 handle_packet_stream_changing_type(mmst);
365 } else if(packet_type == SC_PKT_ASF_MEDIA) {
366 pad_media_packet(mms);
372 static int mms_safe_send_recv(MMSTContext *mmst,
373 int (*send_fun)(MMSTContext *mmst),
374 const MMSSCPacketType expect_type)
376 MMSSCPacketType type;
378 int ret = send_fun(mmst);
380 dprintf(NULL, "Send Packet error before expecting recv packet %d\n", expect_type);
385 if ((type = get_tcp_server_response(mmst)) != expect_type) {
386 av_log(NULL, AV_LOG_ERROR,
387 "Corrupt stream (unexpected packet type 0x%x, expected 0x%x)\n",
389 return AVERROR_INVALIDDATA;
395 static int send_media_header_request(MMSTContext *mmst)
397 MMSContext *mms = &mmst->mms;
398 start_command_packet(mmst, CS_PKT_MEDIA_HEADER_REQUEST);
399 insert_command_prefixes(mms, 1, 0);
400 bytestream_put_le32(&mms->write_out_ptr, 0);
401 bytestream_put_le32(&mms->write_out_ptr, 0x00800000);
402 bytestream_put_le32(&mms->write_out_ptr, 0xffffffff);
403 bytestream_put_le32(&mms->write_out_ptr, 0);
404 bytestream_put_le32(&mms->write_out_ptr, 0);
405 bytestream_put_le32(&mms->write_out_ptr, 0);
407 // the media preroll value in milliseconds?
408 bytestream_put_le32(&mms->write_out_ptr, 0);
409 bytestream_put_le32(&mms->write_out_ptr, 0x40AC2000);
410 bytestream_put_le32(&mms->write_out_ptr, 2);
411 bytestream_put_le32(&mms->write_out_ptr, 0);
413 return send_command_packet(mmst);
416 /** Send the initial handshake. */
417 static int send_startup_packet(MMSTContext *mmst)
419 char data_string[256];
420 MMSContext *mms = &mmst->mms;
421 // SubscriberName is defined in MS specification linked below.
422 // The guid value can be any valid value.
423 // http://download.microsoft.com/
424 // download/9/5/E/95EF66AF-9026-4BB0-A41D-A4F81802D92C/%5BMS-WMSP%5D.pdf
425 snprintf(data_string, sizeof(data_string),
426 "NSPlayer/7.0.0.1956; {%s}; Host: %s",
427 "7E667F5D-A661-495E-A512-F55686DDA178", mmst->host);
429 start_command_packet(mmst, CS_PKT_INITIAL);
430 insert_command_prefixes(mms, 0, 0x0004000b);
431 bytestream_put_le32(&mms->write_out_ptr, 0x0003001c);
432 mms_put_utf16(mms, data_string);
433 return send_command_packet(mmst);
436 /** Send MMST stream selection command based on the AVStream->discard values. */
437 static int send_stream_selection_request(MMSTContext *mmst)
440 MMSContext *mms = &mmst->mms;
441 // send the streams we want back...
442 start_command_packet(mmst, CS_PKT_STREAM_ID_REQUEST);
443 bytestream_put_le32(&mms->write_out_ptr, mms->stream_num); // stream nums
444 for(i= 0; i<mms->stream_num; i++) {
445 bytestream_put_le16(&mms->write_out_ptr, 0xffff); // flags
446 bytestream_put_le16(&mms->write_out_ptr, mms->streams[i].id); // stream id
447 bytestream_put_le16(&mms->write_out_ptr, 0); // selection
449 return send_command_packet(mmst);
452 static int send_close_packet(MMSTContext *mmst)
454 start_command_packet(mmst, CS_PKT_STREAM_CLOSE);
455 insert_command_prefixes(&mmst->mms, 1, 1);
457 return send_command_packet(mmst);
460 /** Close the MMSH/MMST connection */
461 static int mms_close(URLContext *h)
463 MMSTContext *mmst = (MMSTContext *)h->priv_data;
464 MMSContext *mms = &mmst->mms;
466 send_close_packet(mmst);
467 url_close(mms->mms_hd);
470 /* free all separately allocated pointers in mms */
471 av_free(mms->asf_header);
472 av_freep(&h->priv_data);
477 static int send_media_packet_request(MMSTContext *mmst)
479 MMSContext *mms = &mmst->mms;
480 start_command_packet(mmst, CS_PKT_START_FROM_PKT_ID);
481 insert_command_prefixes(mms, 1, 0x0001FFFF);
482 bytestream_put_le64(&mms->write_out_ptr, 0); // seek timestamp
483 bytestream_put_le32(&mms->write_out_ptr, 0xffffffff); // unknown
484 bytestream_put_le32(&mms->write_out_ptr, 0xffffffff); // packet offset
485 bytestream_put_byte(&mms->write_out_ptr, 0xff); // max stream time limit
486 bytestream_put_byte(&mms->write_out_ptr, 0xff); // max stream time limit
487 bytestream_put_byte(&mms->write_out_ptr, 0xff); // max stream time limit
488 bytestream_put_byte(&mms->write_out_ptr, 0x00); // stream time limit flag
490 mmst->packet_id++; // new packet_id
491 bytestream_put_le32(&mms->write_out_ptr, mmst->packet_id);
492 return send_command_packet(mmst);
496 static void clear_stream_buffers(MMSContext *mms)
498 mms->remaining_in_len = 0;
499 mms->read_in_ptr = mms->in_buffer;
502 static int mms_open(URLContext *h, const char *uri, int flags)
510 mmst = h->priv_data = av_mallocz(sizeof(MMSTContext));
512 return AVERROR(ENOMEM);
515 // only for MMS over TCP, so set proto = NULL
516 av_url_split(NULL, 0, NULL, 0,
517 mmst->host, sizeof(mmst->host), &port, mmst->path,
518 sizeof(mmst->path), uri);
521 port = 1755; // defaut mms protocol port
523 // establish tcp connection.
524 ff_url_join(tcpname, sizeof(tcpname), "tcp", NULL, mmst->host, port, NULL);
525 err = url_open(&mms->mms_hd, tcpname, URL_RDWR);
529 mmst->packet_id = 3; // default, initial value.
530 mmst->header_packet_id = 2; // default, initial value.
531 err = mms_safe_send_recv(mmst, send_startup_packet, SC_PKT_CLIENT_ACCEPTED);
534 err = mms_safe_send_recv(mmst, send_time_test_data, SC_PKT_TIMING_TEST_REPLY);
537 err = mms_safe_send_recv(mmst, send_protocol_select, SC_PKT_PROTOCOL_ACCEPTED);
540 err = mms_safe_send_recv(mmst, send_media_file_request, SC_PKT_MEDIA_FILE_DETAILS);
543 err = mms_safe_send_recv(mmst, send_media_header_request, SC_PKT_HEADER_REQUEST_ACCEPTED);
546 err = mms_safe_send_recv(mmst, NULL, SC_PKT_ASF_HEADER);
549 if((mmst->incoming_flags != 0X08) && (mmst->incoming_flags != 0X0C))
551 err = ff_mms_asf_header_parser(mms);
553 dprintf(NULL, "asf header parsed failed!\n");
556 mms->header_parsed = 1;
558 if (!mms->asf_packet_len || !mms->stream_num)
561 clear_stream_buffers(mms);
562 err = mms_safe_send_recv(mmst, send_stream_selection_request, SC_PKT_STREAM_ID_ACCEPTED);
565 // send media packet request
566 err = mms_safe_send_recv(mmst, send_media_packet_request, SC_PKT_MEDIA_PKT_FOLLOWS);
570 dprintf(NULL, "Leaving open (success)\n");
574 dprintf(NULL, "Leaving open (failure: %d)\n", err);
578 /** Read ASF data through the protocol. */
579 static int mms_read(URLContext *h, uint8_t *buf, int size)
581 /* TODO: see tcp.c:tcp_read() about a possible timeout scheme */
582 MMSTContext *mmst = h->priv_data;
583 MMSContext *mms = &mmst->mms;
587 if(mms->asf_header_read_size < mms->asf_header_size) {
588 /* Read from ASF header buffer */
589 result = ff_mms_read_header(mms, buf, size);
590 } else if(mms->remaining_in_len) {
591 /* Read remaining packet data to buffer.
592 * the result can not be zero because remaining_in_len is positive.*/
593 result = ff_mms_read_data(mms, buf, size);
595 /* Read from network */
596 int err = mms_safe_send_recv(mmst, NULL, SC_PKT_ASF_MEDIA);
598 if(mms->remaining_in_len>mms->asf_packet_len) {
599 av_log(NULL, AV_LOG_ERROR,
600 "Incoming pktlen %d is larger than ASF pktsize %d\n",
601 mms->remaining_in_len, mms->asf_packet_len);
604 // copy the data to the packet buffer.
605 result = ff_mms_read_data(mms, buf, size);
607 dprintf(NULL, "read asf media paket size is zero!\n");
612 dprintf(NULL, "read packet error!\n");
616 } while(!result); // only return one packet.
620 URLProtocol mmst_protocol = {