2 * RTMP network protocol
3 * Copyright (c) 2009 Kostya Shishkov
5 * This file is part of FFmpeg.
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.
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.
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
23 * @file libavformat/rtmpproto.c
27 #include "libavcodec/bytestream.h"
28 #include "libavutil/avstring.h"
29 #include "libavutil/lfg.h"
30 #include "libavutil/sha.h"
39 /* we can't use av_log() with URLContext yet... */
40 #if LIBAVFORMAT_VERSION_MAJOR < 53
41 #define LOG_CONTEXT NULL
48 /** RTMP protocol handler state */
50 STATE_START, ///< client has not done anything yet
51 STATE_HANDSHAKED, ///< client has performed handshake
52 STATE_RELEASING, ///< client releasing stream before publish it (for output)
53 STATE_FCPUBLISH, ///< client FCPublishing stream (for output)
54 STATE_CONNECTING, ///< client connected to server successfully
55 STATE_READY, ///< client has sent all needed commands and waits for server reply
56 STATE_PLAYING, ///< client has started receiving multimedia data from server
57 STATE_PUBLISHING, ///< client has started sending multimedia data to server (for output)
58 STATE_STOPPED, ///< the broadcast has been stopped
61 /** protocol handler context */
62 typedef struct RTMPContext {
63 URLContext* stream; ///< TCP stream used in interactions with RTMP server
64 RTMPPacket prev_pkt[2][RTMP_CHANNELS]; ///< packet history used when reading and sending packets
65 int chunk_size; ///< size of the chunks RTMP packets are divided into
66 int is_input; ///< input/output flag
67 char playpath[256]; ///< path to filename to play (with possible "mp4:" prefix)
68 char app[128]; ///< application
69 ClientState state; ///< current state
70 int main_channel_id; ///< an additional channel ID which is used for some invocations
71 uint8_t* flv_data; ///< buffer with data for demuxer
72 int flv_size; ///< current buffer size
73 int flv_off; ///< number of bytes read from current buffer
74 RTMPPacket out_pkt; ///< rtmp packet, created from flv a/v or metadata (for output)
77 #define PLAYER_KEY_OPEN_PART_LEN 30 ///< length of partial key used for first client digest signing
78 /** Client key used for digest signing */
79 static const uint8_t rtmp_player_key[] = {
80 'G', 'e', 'n', 'u', 'i', 'n', 'e', ' ', 'A', 'd', 'o', 'b', 'e', ' ',
81 'F', 'l', 'a', 's', 'h', ' ', 'P', 'l', 'a', 'y', 'e', 'r', ' ', '0', '0', '1',
83 0xF0, 0xEE, 0xC2, 0x4A, 0x80, 0x68, 0xBE, 0xE8, 0x2E, 0x00, 0xD0, 0xD1, 0x02,
84 0x9E, 0x7E, 0x57, 0x6E, 0xEC, 0x5D, 0x2D, 0x29, 0x80, 0x6F, 0xAB, 0x93, 0xB8,
85 0xE6, 0x36, 0xCF, 0xEB, 0x31, 0xAE
88 #define SERVER_KEY_OPEN_PART_LEN 36 ///< length of partial key used for first server digest signing
89 /** Key used for RTMP server digest signing */
90 static const uint8_t rtmp_server_key[] = {
91 'G', 'e', 'n', 'u', 'i', 'n', 'e', ' ', 'A', 'd', 'o', 'b', 'e', ' ',
92 'F', 'l', 'a', 's', 'h', ' ', 'M', 'e', 'd', 'i', 'a', ' ',
93 'S', 'e', 'r', 'v', 'e', 'r', ' ', '0', '0', '1',
95 0xF0, 0xEE, 0xC2, 0x4A, 0x80, 0x68, 0xBE, 0xE8, 0x2E, 0x00, 0xD0, 0xD1, 0x02,
96 0x9E, 0x7E, 0x57, 0x6E, 0xEC, 0x5D, 0x2D, 0x29, 0x80, 0x6F, 0xAB, 0x93, 0xB8,
97 0xE6, 0x36, 0xCF, 0xEB, 0x31, 0xAE
101 * Generates 'connect' call and sends it to the server.
103 static void gen_connect(URLContext *s, RTMPContext *rt, const char *proto,
104 const char *host, int port)
110 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0, 4096);
113 snprintf(tcurl, sizeof(tcurl), "%s://%s:%d/%s", proto, host, port, rt->app);
114 ff_amf_write_string(&p, "connect");
115 ff_amf_write_number(&p, 1.0);
116 ff_amf_write_object_start(&p);
117 ff_amf_write_field_name(&p, "app");
118 ff_amf_write_string(&p, rt->app);
121 snprintf(ver, sizeof(ver), "%s %d,%d,%d,%d", RTMP_CLIENT_PLATFORM, RTMP_CLIENT_VER1,
122 RTMP_CLIENT_VER2, RTMP_CLIENT_VER3, RTMP_CLIENT_VER4);
124 snprintf(ver, sizeof(ver), "FMLE/3.0 (compatible; %s)", LIBAVFORMAT_IDENT);
125 ff_amf_write_field_name(&p, "type");
126 ff_amf_write_string(&p, "nonprivate");
128 ff_amf_write_field_name(&p, "flashVer");
129 ff_amf_write_string(&p, ver);
130 ff_amf_write_field_name(&p, "tcUrl");
131 ff_amf_write_string(&p, tcurl);
133 ff_amf_write_field_name(&p, "fpad");
134 ff_amf_write_bool(&p, 0);
135 ff_amf_write_field_name(&p, "capabilities");
136 ff_amf_write_number(&p, 15.0);
137 ff_amf_write_field_name(&p, "audioCodecs");
138 ff_amf_write_number(&p, 1639.0);
139 ff_amf_write_field_name(&p, "videoCodecs");
140 ff_amf_write_number(&p, 252.0);
141 ff_amf_write_field_name(&p, "videoFunction");
142 ff_amf_write_number(&p, 1.0);
144 ff_amf_write_object_end(&p);
146 pkt.data_size = p - pkt.data;
148 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
149 ff_rtmp_packet_destroy(&pkt);
153 * Generates 'releaseStream' call and sends it to the server. It should make
154 * the server release some channel for media streams.
156 static void gen_release_stream(URLContext *s, RTMPContext *rt)
161 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0,
162 29 + strlen(rt->playpath));
164 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Releasing stream...\n");
166 ff_amf_write_string(&p, "releaseStream");
167 ff_amf_write_number(&p, 2.0);
168 ff_amf_write_null(&p);
169 ff_amf_write_string(&p, rt->playpath);
171 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
172 ff_rtmp_packet_destroy(&pkt);
176 * Generates 'FCPublish' call and sends it to the server. It should make
177 * the server preapare for receiving media streams.
179 static void gen_fcpublish_stream(URLContext *s, RTMPContext *rt)
184 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0,
185 25 + strlen(rt->playpath));
187 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "FCPublish stream...\n");
189 ff_amf_write_string(&p, "FCPublish");
190 ff_amf_write_number(&p, 3.0);
191 ff_amf_write_null(&p);
192 ff_amf_write_string(&p, rt->playpath);
194 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
195 ff_rtmp_packet_destroy(&pkt);
199 * Generates 'FCUnpublish' call and sends it to the server. It should make
200 * the server destroy stream.
202 static void gen_fcunpublish_stream(URLContext *s, RTMPContext *rt)
207 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0,
208 27 + strlen(rt->playpath));
210 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "UnPublishing stream...\n");
212 ff_amf_write_string(&p, "FCUnpublish");
213 ff_amf_write_number(&p, 5.0);
214 ff_amf_write_null(&p);
215 ff_amf_write_string(&p, rt->playpath);
217 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
218 ff_rtmp_packet_destroy(&pkt);
222 * Generates 'createStream' call and sends it to the server. It should make
223 * the server allocate some channel for media streams.
225 static void gen_create_stream(URLContext *s, RTMPContext *rt)
230 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Creating stream...\n");
231 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0, 25);
234 ff_amf_write_string(&p, "createStream");
235 ff_amf_write_number(&p, rt->is_input ? 3.0 : 4.0);
236 ff_amf_write_null(&p);
238 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
239 ff_rtmp_packet_destroy(&pkt);
244 * Generates 'deleteStream' call and sends it to the server. It should make
245 * the server remove some channel for media streams.
247 static void gen_delete_stream(URLContext *s, RTMPContext *rt)
252 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Deleting stream...\n");
253 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0, 34);
256 ff_amf_write_string(&p, "deleteStream");
257 ff_amf_write_number(&p, 0.0);
258 ff_amf_write_null(&p);
259 ff_amf_write_number(&p, rt->main_channel_id);
261 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
262 ff_rtmp_packet_destroy(&pkt);
266 * Generates 'play' call and sends it to the server, then pings the server
267 * to start actual playing.
269 static void gen_play(URLContext *s, RTMPContext *rt)
274 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Sending play command for '%s'\n", rt->playpath);
275 ff_rtmp_packet_create(&pkt, RTMP_VIDEO_CHANNEL, RTMP_PT_INVOKE, 0,
276 20 + strlen(rt->playpath));
277 pkt.extra = rt->main_channel_id;
280 ff_amf_write_string(&p, "play");
281 ff_amf_write_number(&p, 0.0);
282 ff_amf_write_null(&p);
283 ff_amf_write_string(&p, rt->playpath);
285 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
286 ff_rtmp_packet_destroy(&pkt);
288 // set client buffer time disguised in ping packet
289 ff_rtmp_packet_create(&pkt, RTMP_NETWORK_CHANNEL, RTMP_PT_PING, 1, 10);
292 bytestream_put_be16(&p, 3);
293 bytestream_put_be32(&p, 1);
294 bytestream_put_be32(&p, 256); //TODO: what is a good value here?
296 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
297 ff_rtmp_packet_destroy(&pkt);
301 * Generates 'publish' call and sends it to the server.
303 static void gen_publish(URLContext *s, RTMPContext *rt)
308 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Sending publish command for '%s'\n", rt->playpath);
309 ff_rtmp_packet_create(&pkt, RTMP_SOURCE_CHANNEL, RTMP_PT_INVOKE, 0,
310 30 + strlen(rt->playpath));
311 pkt.extra = rt->main_channel_id;
314 ff_amf_write_string(&p, "publish");
315 ff_amf_write_number(&p, 0.0);
316 ff_amf_write_null(&p);
317 ff_amf_write_string(&p, rt->playpath);
318 ff_amf_write_string(&p, "live");
320 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
321 ff_rtmp_packet_destroy(&pkt);
325 * Generates ping reply and sends it to the server.
327 static void gen_pong(URLContext *s, RTMPContext *rt, RTMPPacket *ppkt)
332 ff_rtmp_packet_create(&pkt, RTMP_NETWORK_CHANNEL, RTMP_PT_PING, ppkt->timestamp + 1, 6);
334 bytestream_put_be16(&p, 7);
335 bytestream_put_be32(&p, AV_RB32(ppkt->data+2));
336 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
337 ff_rtmp_packet_destroy(&pkt);
340 //TODO: Move HMAC code somewhere. Eventually.
341 #define HMAC_IPAD_VAL 0x36
342 #define HMAC_OPAD_VAL 0x5C
345 * Calculates HMAC-SHA2 digest for RTMP handshake packets.
347 * @param src input buffer
348 * @param len input buffer length (should be 1536)
349 * @param gap offset in buffer where 32 bytes should not be taken into account
350 * when calculating digest (since it will be used to store that digest)
351 * @param key digest key
352 * @param keylen digest key length
353 * @param dst buffer where calculated digest will be stored (32 bytes)
355 static void rtmp_calc_digest(const uint8_t *src, int len, int gap,
356 const uint8_t *key, int keylen, uint8_t *dst)
359 uint8_t hmac_buf[64+32] = {0};
362 sha = av_mallocz(av_sha_size);
365 memcpy(hmac_buf, key, keylen);
367 av_sha_init(sha, 256);
368 av_sha_update(sha,key, keylen);
369 av_sha_final(sha, hmac_buf);
371 for (i = 0; i < 64; i++)
372 hmac_buf[i] ^= HMAC_IPAD_VAL;
374 av_sha_init(sha, 256);
375 av_sha_update(sha, hmac_buf, 64);
377 av_sha_update(sha, src, len);
378 } else { //skip 32 bytes used for storing digest
379 av_sha_update(sha, src, gap);
380 av_sha_update(sha, src + gap + 32, len - gap - 32);
382 av_sha_final(sha, hmac_buf + 64);
384 for (i = 0; i < 64; i++)
385 hmac_buf[i] ^= HMAC_IPAD_VAL ^ HMAC_OPAD_VAL; //reuse XORed key for opad
386 av_sha_init(sha, 256);
387 av_sha_update(sha, hmac_buf, 64+32);
388 av_sha_final(sha, dst);
394 * Puts HMAC-SHA2 digest of packet data (except for the bytes where this digest
395 * will be stored) into that packet.
397 * @param buf handshake data (1536 bytes)
398 * @return offset to the digest inside input data
400 static int rtmp_handshake_imprint_with_digest(uint8_t *buf)
402 int i, digest_pos = 0;
404 for (i = 8; i < 12; i++)
405 digest_pos += buf[i];
406 digest_pos = (digest_pos % 728) + 12;
408 rtmp_calc_digest(buf, RTMP_HANDSHAKE_PACKET_SIZE, digest_pos,
409 rtmp_player_key, PLAYER_KEY_OPEN_PART_LEN,
415 * Verifies that the received server response has the expected digest value.
417 * @param buf handshake data received from the server (1536 bytes)
418 * @param off position to search digest offset from
419 * @return 0 if digest is valid, digest position otherwise
421 static int rtmp_validate_digest(uint8_t *buf, int off)
423 int i, digest_pos = 0;
426 for (i = 0; i < 4; i++)
427 digest_pos += buf[i + off];
428 digest_pos = (digest_pos % 728) + off + 4;
430 rtmp_calc_digest(buf, RTMP_HANDSHAKE_PACKET_SIZE, digest_pos,
431 rtmp_server_key, SERVER_KEY_OPEN_PART_LEN,
433 if (!memcmp(digest, buf + digest_pos, 32))
439 * Performs handshake with the server by means of exchanging pseudorandom data
440 * signed with HMAC-SHA2 digest.
442 * @return 0 if handshake succeeds, negative value otherwise
444 static int rtmp_handshake(URLContext *s, RTMPContext *rt)
447 uint8_t tosend [RTMP_HANDSHAKE_PACKET_SIZE+1] = {
448 3, // unencrypted data
449 0, 0, 0, 0, // client uptime
455 uint8_t clientdata[RTMP_HANDSHAKE_PACKET_SIZE];
456 uint8_t serverdata[RTMP_HANDSHAKE_PACKET_SIZE+1];
458 int server_pos, client_pos;
461 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Handshaking...\n");
463 av_lfg_init(&rnd, 0xDEADC0DE);
464 // generate handshake packet - 1536 bytes of pseudorandom data
465 for (i = 9; i <= RTMP_HANDSHAKE_PACKET_SIZE; i++)
466 tosend[i] = av_lfg_get(&rnd) >> 24;
467 client_pos = rtmp_handshake_imprint_with_digest(tosend + 1);
469 url_write(rt->stream, tosend, RTMP_HANDSHAKE_PACKET_SIZE + 1);
470 i = url_read_complete(rt->stream, serverdata, RTMP_HANDSHAKE_PACKET_SIZE + 1);
471 if (i != RTMP_HANDSHAKE_PACKET_SIZE + 1) {
472 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Cannot read RTMP handshake response\n");
475 i = url_read_complete(rt->stream, clientdata, RTMP_HANDSHAKE_PACKET_SIZE);
476 if (i != RTMP_HANDSHAKE_PACKET_SIZE) {
477 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Cannot read RTMP handshake response\n");
481 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Server version %d.%d.%d.%d\n",
482 serverdata[5], serverdata[6], serverdata[7], serverdata[8]);
484 if (rt->is_input && serverdata[5] >= 3) {
485 server_pos = rtmp_validate_digest(serverdata + 1, 772);
487 server_pos = rtmp_validate_digest(serverdata + 1, 8);
489 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Server response validating failed\n");
494 rtmp_calc_digest(tosend + 1 + client_pos, 32, 0,
495 rtmp_server_key, sizeof(rtmp_server_key),
497 rtmp_calc_digest(clientdata, RTMP_HANDSHAKE_PACKET_SIZE-32, 0,
500 if (memcmp(digest, clientdata + RTMP_HANDSHAKE_PACKET_SIZE - 32, 32)) {
501 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Signature mismatch\n");
505 for (i = 0; i < RTMP_HANDSHAKE_PACKET_SIZE; i++)
506 tosend[i] = av_lfg_get(&rnd) >> 24;
507 rtmp_calc_digest(serverdata + 1 + server_pos, 32, 0,
508 rtmp_player_key, sizeof(rtmp_player_key),
510 rtmp_calc_digest(tosend, RTMP_HANDSHAKE_PACKET_SIZE - 32, 0,
512 tosend + RTMP_HANDSHAKE_PACKET_SIZE - 32);
514 // write reply back to the server
515 url_write(rt->stream, tosend, RTMP_HANDSHAKE_PACKET_SIZE);
517 url_write(rt->stream, serverdata+1, RTMP_HANDSHAKE_PACKET_SIZE);
524 * Parses received packet and may perform some action depending on
525 * the packet contents.
526 * @return 0 for no errors, negative values for serious errors which prevent
527 * further communications, positive values for uncritical errors
529 static int rtmp_parse_result(URLContext *s, RTMPContext *rt, RTMPPacket *pkt)
532 const uint8_t *data_end = pkt->data + pkt->data_size;
535 ff_rtmp_packet_dump(LOG_CONTEXT, pkt);
539 case RTMP_PT_CHUNK_SIZE:
540 if (pkt->data_size != 4) {
541 av_log(LOG_CONTEXT, AV_LOG_ERROR,
542 "Chunk size change packet is not 4 bytes long (%d)\n", pkt->data_size);
546 ff_rtmp_packet_write(rt->stream, pkt, rt->chunk_size, rt->prev_pkt[1]);
547 rt->chunk_size = AV_RB32(pkt->data);
548 if (rt->chunk_size <= 0) {
549 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Incorrect chunk size %d\n", rt->chunk_size);
552 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "New chunk size = %d\n", rt->chunk_size);
555 t = AV_RB16(pkt->data);
557 gen_pong(s, rt, pkt);
560 //TODO: check for the messages sent for wrong state?
561 if (!memcmp(pkt->data, "\002\000\006_error", 9)) {
564 if (!ff_amf_get_field_value(pkt->data + 9, data_end,
565 "description", tmpstr, sizeof(tmpstr)))
566 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Server error: %s\n",tmpstr);
568 } else if (!memcmp(pkt->data, "\002\000\007_result", 10)) {
570 case STATE_HANDSHAKED:
572 gen_release_stream(s, rt);
573 gen_fcpublish_stream(s, rt);
574 rt->state = STATE_RELEASING;
576 rt->state = STATE_CONNECTING;
578 gen_create_stream(s, rt);
580 case STATE_FCPUBLISH:
581 rt->state = STATE_CONNECTING;
583 case STATE_RELEASING:
584 rt->state = STATE_FCPUBLISH;
585 /* hack for Wowza Media Server, it does not send result for
586 * releaseStream and FCPublish calls */
587 if (!pkt->data[10]) {
588 int pkt_id = (int) av_int2dbl(AV_RB64(pkt->data + 11));
590 rt->state = STATE_CONNECTING;
592 if (rt->state != STATE_CONNECTING)
594 case STATE_CONNECTING:
595 //extract a number from the result
596 if (pkt->data[10] || pkt->data[19] != 5 || pkt->data[20]) {
597 av_log(LOG_CONTEXT, AV_LOG_WARNING, "Unexpected reply on connect()\n");
599 rt->main_channel_id = (int) av_int2dbl(AV_RB64(pkt->data + 21));
606 rt->state = STATE_READY;
609 } else if (!memcmp(pkt->data, "\002\000\010onStatus", 11)) {
610 const uint8_t* ptr = pkt->data + 11;
613 for (i = 0; i < 2; i++) {
614 t = ff_amf_tag_size(ptr, data_end);
619 t = ff_amf_get_field_value(ptr, data_end,
620 "level", tmpstr, sizeof(tmpstr));
621 if (!t && !strcmp(tmpstr, "error")) {
622 if (!ff_amf_get_field_value(ptr, data_end,
623 "description", tmpstr, sizeof(tmpstr)))
624 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Server error: %s\n",tmpstr);
627 t = ff_amf_get_field_value(ptr, data_end,
628 "code", tmpstr, sizeof(tmpstr));
629 if (!t && !strcmp(tmpstr, "NetStream.Play.Start")) rt->state = STATE_PLAYING;
630 if (!t && !strcmp(tmpstr, "NetStream.Play.Stop")) rt->state = STATE_STOPPED;
631 if (!t && !strcmp(tmpstr, "NetStream.Play.UnpublishNotify")) rt->state = STATE_STOPPED;
632 if (!t && !strcmp(tmpstr, "NetStream.Publish.Start")) rt->state = STATE_PUBLISHING;
640 * Interacts with the server by receiving and sending RTMP packets until
641 * there is some significant data (media data or expected status notification).
643 * @param s reading context
644 * @param for_header non-zero value tells function to work until it
645 * gets notification from the server that playing has been started,
646 * otherwise function will work until some media data is received (or
648 * @return 0 for successful operation, negative value in case of error
650 static int get_packet(URLContext *s, int for_header)
652 RTMPContext *rt = s->priv_data;
657 uint32_t ts, cts, pts=0;
659 if (rt->state == STATE_STOPPED)
664 if ((ret = ff_rtmp_packet_read(rt->stream, &rpkt,
665 rt->chunk_size, rt->prev_pkt[0])) != 0) {
667 return AVERROR(EAGAIN);
673 ret = rtmp_parse_result(s, rt, &rpkt);
674 if (ret < 0) {//serious error in current packet
675 ff_rtmp_packet_destroy(&rpkt);
678 if (rt->state == STATE_STOPPED) {
679 ff_rtmp_packet_destroy(&rpkt);
682 if (for_header && (rt->state == STATE_PLAYING || rt->state == STATE_PUBLISHING)) {
683 ff_rtmp_packet_destroy(&rpkt);
686 if (!rpkt.data_size || !rt->is_input) {
687 ff_rtmp_packet_destroy(&rpkt);
690 if (rpkt.type == RTMP_PT_VIDEO || rpkt.type == RTMP_PT_AUDIO ||
691 (rpkt.type == RTMP_PT_NOTIFY && !memcmp("\002\000\012onMetaData", rpkt.data, 13))) {
694 // generate packet header and put data into buffer for FLV demuxer
696 rt->flv_size = rpkt.data_size + 15;
697 rt->flv_data = p = av_realloc(rt->flv_data, rt->flv_size);
698 bytestream_put_byte(&p, rpkt.type);
699 bytestream_put_be24(&p, rpkt.data_size);
700 bytestream_put_be24(&p, ts);
701 bytestream_put_byte(&p, ts >> 24);
702 bytestream_put_be24(&p, 0);
703 bytestream_put_buffer(&p, rpkt.data, rpkt.data_size);
704 bytestream_put_be32(&p, 0);
705 ff_rtmp_packet_destroy(&rpkt);
707 } else if (rpkt.type == RTMP_PT_METADATA) {
708 // we got raw FLV data, make it available for FLV demuxer
710 rt->flv_size = rpkt.data_size;
711 rt->flv_data = av_realloc(rt->flv_data, rt->flv_size);
712 /* rewrite timestamps */
715 while (next - rpkt.data < rpkt.data_size - 11) {
717 data_size = bytestream_get_be24(&next);
719 cts = bytestream_get_be24(&next);
720 cts |= bytestream_get_byte(&next);
725 bytestream_put_be24(&p, ts);
726 bytestream_put_byte(&p, ts >> 24);
727 next += data_size + 3 + 4;
729 memcpy(rt->flv_data, rpkt.data, rpkt.data_size);
730 ff_rtmp_packet_destroy(&rpkt);
733 ff_rtmp_packet_destroy(&rpkt);
738 static int rtmp_close(URLContext *h)
740 RTMPContext *rt = h->priv_data;
744 if (rt->out_pkt.data_size)
745 ff_rtmp_packet_destroy(&rt->out_pkt);
746 if (rt->state > STATE_FCPUBLISH)
747 gen_fcunpublish_stream(h, rt);
749 if (rt->state > STATE_HANDSHAKED)
750 gen_delete_stream(h, rt);
752 av_freep(&rt->flv_data);
753 url_close(rt->stream);
759 * Opens RTMP connection and verifies that the stream can be played.
761 * URL syntax: rtmp://server[:port][/app][/playpath]
762 * where 'app' is first one or two directories in the path
763 * (e.g. /ondemand/, /flash/live/, etc.)
764 * and 'playpath' is a file name (the rest of the path,
765 * may be prefixed with "mp4:")
767 static int rtmp_open(URLContext *s, const char *uri, int flags)
770 char proto[8], hostname[256], path[1024], *fname;
775 rt = av_mallocz(sizeof(RTMPContext));
777 return AVERROR(ENOMEM);
779 rt->is_input = !(flags & URL_WRONLY);
781 url_split(proto, sizeof(proto), NULL, 0, hostname, sizeof(hostname), &port,
782 path, sizeof(path), s->filename);
785 port = RTMP_DEFAULT_PORT;
786 snprintf(buf, sizeof(buf), "tcp://%s:%d", hostname, port);
788 if (url_open(&rt->stream, buf, URL_RDWR) < 0) {
789 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Cannot open connection %s\n", buf);
793 rt->state = STATE_START;
794 if (rtmp_handshake(s, rt))
797 rt->chunk_size = 128;
798 rt->state = STATE_HANDSHAKED;
799 //extract "app" part from path
800 if (!strncmp(path, "/ondemand/", 10)) {
802 memcpy(rt->app, "ondemand", 9);
804 char *p = strchr(path + 1, '/');
809 char *c = strchr(p + 1, ':');
810 fname = strchr(p + 1, '/');
811 if (!fname || c < fname) {
813 av_strlcpy(rt->app, path + 1, p - path);
816 av_strlcpy(rt->app, path + 1, fname - path - 1);
820 if (!strchr(fname, ':') &&
821 (!strcmp(fname + strlen(fname) - 4, ".f4v") ||
822 !strcmp(fname + strlen(fname) - 4, ".mp4"))) {
823 memcpy(rt->playpath, "mp4:", 5);
827 strncat(rt->playpath, fname, sizeof(rt->playpath) - 5);
829 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Proto = %s, path = %s, app = %s, fname = %s\n",
830 proto, path, rt->app, rt->playpath);
831 gen_connect(s, rt, proto, hostname, port);
834 ret = get_packet(s, 1);
835 } while (ret == EAGAIN);
840 // generate FLV header for demuxer
842 rt->flv_data = av_realloc(rt->flv_data, rt->flv_size);
844 memcpy(rt->flv_data, "FLV\1\5\0\0\0\011\0\0\0\0", rt->flv_size);
851 s->max_packet_size = url_get_max_packet_size(rt->stream);
860 static int rtmp_read(URLContext *s, uint8_t *buf, int size)
862 RTMPContext *rt = s->priv_data;
863 int orig_size = size;
867 int data_left = rt->flv_size - rt->flv_off;
869 if (data_left >= size) {
870 memcpy(buf, rt->flv_data + rt->flv_off, size);
875 memcpy(buf, rt->flv_data + rt->flv_off, data_left);
878 rt->flv_off = rt->flv_size;
880 if ((ret = get_packet(s, 0)) < 0)
886 static int rtmp_write(URLContext *h, uint8_t *buf, int size)
888 RTMPContext *rt = h->priv_data;
889 int size_temp = size;
890 int pktsize, pkttype;
892 const uint8_t *buf_temp = buf;
895 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "FLV packet too small %d\n", size);
902 if (buf_temp[0] == 'F' && buf_temp[1] == 'L' && buf_temp[2] == 'V') {
907 pkttype = bytestream_get_byte(&buf_temp);
908 pktsize = bytestream_get_be24(&buf_temp);
909 ts = bytestream_get_be24(&buf_temp);
910 ts |= bytestream_get_byte(&buf_temp) << 24;
911 bytestream_get_be24(&buf_temp);
913 rt->flv_size = pktsize;
915 //force 12bytes header
916 if (((pkttype == RTMP_PT_VIDEO || pkttype == RTMP_PT_AUDIO) && ts == 0) ||
917 pkttype == RTMP_PT_NOTIFY) {
918 if (pkttype == RTMP_PT_NOTIFY)
920 rt->prev_pkt[1][RTMP_SOURCE_CHANNEL].channel_id = 0;
923 //this can be a big packet, it's better to send it right here
924 ff_rtmp_packet_create(&rt->out_pkt, RTMP_SOURCE_CHANNEL, pkttype, ts, pktsize);
925 rt->out_pkt.extra = rt->main_channel_id;
926 rt->flv_data = rt->out_pkt.data;
928 if (pkttype == RTMP_PT_NOTIFY)
929 ff_amf_write_string(&rt->flv_data, "@setDataFrame");
932 if (rt->flv_size - rt->flv_off > size_temp) {
933 bytestream_get_buffer(&buf_temp, rt->flv_data + rt->flv_off, size_temp);
934 rt->flv_off += size_temp;
936 bytestream_get_buffer(&buf_temp, rt->flv_data + rt->flv_off, rt->flv_size - rt->flv_off);
937 rt->flv_off += rt->flv_size - rt->flv_off;
940 if (rt->flv_off == rt->flv_size) {
941 bytestream_get_be32(&buf_temp);
943 ff_rtmp_packet_write(rt->stream, &rt->out_pkt, rt->chunk_size, rt->prev_pkt[1]);
944 ff_rtmp_packet_destroy(&rt->out_pkt);
948 } while (buf_temp - buf < size_temp);
952 URLProtocol rtmp_protocol = {