Use old-style RTMP handshake for old servers.
[libav.git] / libavformat / rtmpproto.c
CommitLineData
9fd6b843
KS
1/*
2 * RTMP network protocol
3 * Copyright (c) 2009 Kostya Shishkov
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 libavformat/rtmpproto.c
24 * RTMP protocol
25 */
26
27#include "libavcodec/bytestream.h"
28#include "libavutil/avstring.h"
29#include "libavutil/lfg.h"
30#include "libavutil/sha.h"
31#include "avformat.h"
32
33#include "network.h"
34
35#include "flv.h"
36#include "rtmp.h"
37#include "rtmppkt.h"
38
39/* we can't use av_log() with URLContext yet... */
40#if LIBAVFORMAT_VERSION_MAJOR < 53
41#define LOG_CONTEXT NULL
42#else
43#define LOG_CONTEXT s
44#endif
45
cfac91fe
KS
46//#define DEBUG
47
9fd6b843
KS
48/** RTMP protocol handler state */
49typedef enum {
50 STATE_START, ///< client has not done anything yet
51 STATE_HANDSHAKED, ///< client has performed handshake
6bf22e18
S
52 STATE_RELEASING, ///< client releasing stream before publish it (for output)
53 STATE_FCPUBLISH, ///< client FCPublishing stream (for output)
9fd6b843
KS
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
6bf22e18 57 STATE_PUBLISHING, ///< client has started sending multimedia data to server (for output)
72b870b9 58 STATE_STOPPED, ///< the broadcast has been stopped
9fd6b843
KS
59} ClientState;
60
61/** protocol handler context */
62typedef 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
b316991b 66 int is_input; ///< input/output flag
9fd6b843 67 char playpath[256]; ///< path to filename to play (with possible "mp4:" prefix)
5e9ad759 68 char app[128]; ///< application
9fd6b843
KS
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
6bf22e18 74 RTMPPacket out_pkt; ///< rtmp packet, created from flv a/v or metadata (for output)
9fd6b843
KS
75} RTMPContext;
76
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 */
79static 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',
82
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
86};
87
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 */
90static 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',
94
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
98};
99
100/**
101 * Generates 'connect' call and sends it to the server.
102 */
103static void gen_connect(URLContext *s, RTMPContext *rt, const char *proto,
5e9ad759 104 const char *host, int port)
9fd6b843
KS
105{
106 RTMPPacket pkt;
6bf22e18 107 uint8_t ver[64], *p;
9fd6b843
KS
108 char tcurl[512];
109
31da5966 110 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0, 4096);
9fd6b843
KS
111 p = pkt.data;
112
5e9ad759 113 snprintf(tcurl, sizeof(tcurl), "%s://%s:%d/%s", proto, host, port, rt->app);
9fd6b843
KS
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");
5e9ad759 118 ff_amf_write_string(&p, rt->app);
9fd6b843 119
6bf22e18 120 if (rt->is_input) {
c7240611
KS
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);
6bf22e18
S
123 } else {
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");
127 }
9fd6b843
KS
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);
6bf22e18 132 if (rt->is_input) {
c7240611
KS
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);
6bf22e18 143 }
9fd6b843
KS
144 ff_amf_write_object_end(&p);
145
146 pkt.data_size = p - pkt.data;
147
148 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
f8caa544 149 ff_rtmp_packet_destroy(&pkt);
9fd6b843
KS
150}
151
152/**
6bf22e18
S
153 * Generates 'releaseStream' call and sends it to the server. It should make
154 * the server release some channel for media streams.
155 */
156static void gen_release_stream(URLContext *s, RTMPContext *rt)
157{
158 RTMPPacket pkt;
159 uint8_t *p;
160
161 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0,
162 29 + strlen(rt->playpath));
163
164 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Releasing stream...\n");
165 p = pkt.data;
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);
170
171 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
172 ff_rtmp_packet_destroy(&pkt);
173}
174
175/**
176 * Generates 'FCPublish' call and sends it to the server. It should make
177 * the server preapare for receiving media streams.
178 */
179static void gen_fcpublish_stream(URLContext *s, RTMPContext *rt)
180{
181 RTMPPacket pkt;
182 uint8_t *p;
183
184 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0,
185 25 + strlen(rt->playpath));
186
187 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "FCPublish stream...\n");
188 p = pkt.data;
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);
193
194 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
195 ff_rtmp_packet_destroy(&pkt);
196}
197
198/**
199 * Generates 'FCUnpublish' call and sends it to the server. It should make
200 * the server destroy stream.
201 */
202static void gen_fcunpublish_stream(URLContext *s, RTMPContext *rt)
203{
204 RTMPPacket pkt;
205 uint8_t *p;
206
207 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0,
208 27 + strlen(rt->playpath));
209
210 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "UnPublishing stream...\n");
211 p = pkt.data;
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);
216
217 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
218 ff_rtmp_packet_destroy(&pkt);
219}
220
221/**
9fd6b843
KS
222 * Generates 'createStream' call and sends it to the server. It should make
223 * the server allocate some channel for media streams.
224 */
225static void gen_create_stream(URLContext *s, RTMPContext *rt)
226{
227 RTMPPacket pkt;
228 uint8_t *p;
229
230 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Creating stream...\n");
31da5966 231 ff_rtmp_packet_create(&pkt, RTMP_SYSTEM_CHANNEL, RTMP_PT_INVOKE, 0, 25);
9fd6b843
KS
232
233 p = pkt.data;
234 ff_amf_write_string(&p, "createStream");
6bf22e18
S
235 ff_amf_write_number(&p, rt->is_input ? 3.0 : 4.0);
236 ff_amf_write_null(&p);
237
238 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
239 ff_rtmp_packet_destroy(&pkt);
240}
241
242
243/**
244 * Generates 'deleteStream' call and sends it to the server. It should make
245 * the server remove some channel for media streams.
246 */
247static void gen_delete_stream(URLContext *s, RTMPContext *rt)
248{
249 RTMPPacket pkt;
250 uint8_t *p;
251
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);
254
255 p = pkt.data;
256 ff_amf_write_string(&p, "deleteStream");
257 ff_amf_write_number(&p, 0.0);
9fd6b843 258 ff_amf_write_null(&p);
6bf22e18 259 ff_amf_write_number(&p, rt->main_channel_id);
9fd6b843
KS
260
261 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
262 ff_rtmp_packet_destroy(&pkt);
263}
264
265/**
266 * Generates 'play' call and sends it to the server, then pings the server
267 * to start actual playing.
268 */
269static void gen_play(URLContext *s, RTMPContext *rt)
270{
271 RTMPPacket pkt;
272 uint8_t *p;
273
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,
f836fa17 276 20 + strlen(rt->playpath));
9fd6b843
KS
277 pkt.extra = rt->main_channel_id;
278
279 p = pkt.data;
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);
9fd6b843
KS
284
285 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
286 ff_rtmp_packet_destroy(&pkt);
287
288 // set client buffer time disguised in ping packet
289 ff_rtmp_packet_create(&pkt, RTMP_NETWORK_CHANNEL, RTMP_PT_PING, 1, 10);
290
291 p = pkt.data;
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?
295
296 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
297 ff_rtmp_packet_destroy(&pkt);
298}
299
300/**
6bf22e18
S
301 * Generates 'publish' call and sends it to the server.
302 */
303static void gen_publish(URLContext *s, RTMPContext *rt)
304{
305 RTMPPacket pkt;
306 uint8_t *p;
307
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;
312
313 p = pkt.data;
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");
319
320 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
321 ff_rtmp_packet_destroy(&pkt);
322}
323
324/**
9fd6b843
KS
325 * Generates ping reply and sends it to the server.
326 */
327static void gen_pong(URLContext *s, RTMPContext *rt, RTMPPacket *ppkt)
328{
329 RTMPPacket pkt;
330 uint8_t *p;
331
332 ff_rtmp_packet_create(&pkt, RTMP_NETWORK_CHANNEL, RTMP_PT_PING, ppkt->timestamp + 1, 6);
333 p = pkt.data;
334 bytestream_put_be16(&p, 7);
4aaebf78 335 bytestream_put_be32(&p, AV_RB32(ppkt->data+2));
9fd6b843
KS
336 ff_rtmp_packet_write(rt->stream, &pkt, rt->chunk_size, rt->prev_pkt[1]);
337 ff_rtmp_packet_destroy(&pkt);
338}
339
340//TODO: Move HMAC code somewhere. Eventually.
341#define HMAC_IPAD_VAL 0x36
342#define HMAC_OPAD_VAL 0x5C
343
344/**
345 * Calculates HMAC-SHA2 digest for RTMP handshake packets.
346 *
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)
354 */
355static void rtmp_calc_digest(const uint8_t *src, int len, int gap,
356 const uint8_t *key, int keylen, uint8_t *dst)
357{
358 struct AVSHA *sha;
359 uint8_t hmac_buf[64+32] = {0};
360 int i;
361
362 sha = av_mallocz(av_sha_size);
363
364 if (keylen < 64) {
365 memcpy(hmac_buf, key, keylen);
366 } else {
367 av_sha_init(sha, 256);
368 av_sha_update(sha,key, keylen);
369 av_sha_final(sha, hmac_buf);
370 }
371 for (i = 0; i < 64; i++)
372 hmac_buf[i] ^= HMAC_IPAD_VAL;
373
374 av_sha_init(sha, 256);
375 av_sha_update(sha, hmac_buf, 64);
376 if (gap <= 0) {
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);
381 }
382 av_sha_final(sha, hmac_buf + 64);
383
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);
389
390 av_free(sha);
391}
392
393/**
394 * Puts HMAC-SHA2 digest of packet data (except for the bytes where this digest
395 * will be stored) into that packet.
396 *
397 * @param buf handshake data (1536 bytes)
398 * @return offset to the digest inside input data
399 */
400static int rtmp_handshake_imprint_with_digest(uint8_t *buf)
401{
402 int i, digest_pos = 0;
403
404 for (i = 8; i < 12; i++)
405 digest_pos += buf[i];
406 digest_pos = (digest_pos % 728) + 12;
407
408 rtmp_calc_digest(buf, RTMP_HANDSHAKE_PACKET_SIZE, digest_pos,
409 rtmp_player_key, PLAYER_KEY_OPEN_PART_LEN,
410 buf + digest_pos);
411 return digest_pos;
412}
413
414/**
415 * Verifies that the received server response has the expected digest value.
416 *
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
420 */
421static int rtmp_validate_digest(uint8_t *buf, int off)
422{
423 int i, digest_pos = 0;
424 uint8_t digest[32];
425
426 for (i = 0; i < 4; i++)
427 digest_pos += buf[i + off];
428 digest_pos = (digest_pos % 728) + off + 4;
429
430 rtmp_calc_digest(buf, RTMP_HANDSHAKE_PACKET_SIZE, digest_pos,
431 rtmp_server_key, SERVER_KEY_OPEN_PART_LEN,
432 digest);
433 if (!memcmp(digest, buf + digest_pos, 32))
434 return digest_pos;
435 return 0;
436}
437
438/**
439 * Performs handshake with the server by means of exchanging pseudorandom data
440 * signed with HMAC-SHA2 digest.
441 *
442 * @return 0 if handshake succeeds, negative value otherwise
443 */
444static int rtmp_handshake(URLContext *s, RTMPContext *rt)
445{
446 AVLFG rnd;
447 uint8_t tosend [RTMP_HANDSHAKE_PACKET_SIZE+1] = {
448 3, // unencrypted data
449 0, 0, 0, 0, // client uptime
450 RTMP_CLIENT_VER1,
451 RTMP_CLIENT_VER2,
452 RTMP_CLIENT_VER3,
453 RTMP_CLIENT_VER4,
454 };
455 uint8_t clientdata[RTMP_HANDSHAKE_PACKET_SIZE];
456 uint8_t serverdata[RTMP_HANDSHAKE_PACKET_SIZE+1];
457 int i;
458 int server_pos, client_pos;
459 uint8_t digest[32];
460
461 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Handshaking...\n");
462
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);
468
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");
473 return -1;
474 }
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");
478 return -1;
479 }
480
481 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Server version %d.%d.%d.%d\n",
482 serverdata[5], serverdata[6], serverdata[7], serverdata[8]);
483
e2ee11e8 484 if (rt->is_input && serverdata[5] >= 3) {
c7240611 485 server_pos = rtmp_validate_digest(serverdata + 1, 772);
9fd6b843 486 if (!server_pos) {
c7240611
KS
487 server_pos = rtmp_validate_digest(serverdata + 1, 8);
488 if (!server_pos) {
489 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Server response validating failed\n");
490 return -1;
491 }
9fd6b843 492 }
9fd6b843 493
c7240611
KS
494 rtmp_calc_digest(tosend + 1 + client_pos, 32, 0,
495 rtmp_server_key, sizeof(rtmp_server_key),
496 digest);
497 rtmp_calc_digest(clientdata, RTMP_HANDSHAKE_PACKET_SIZE-32, 0,
498 digest, 32,
499 digest);
500 if (memcmp(digest, clientdata + RTMP_HANDSHAKE_PACKET_SIZE - 32, 32)) {
501 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Signature mismatch\n");
502 return -1;
503 }
9fd6b843 504
c7240611
KS
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),
509 digest);
510 rtmp_calc_digest(tosend, RTMP_HANDSHAKE_PACKET_SIZE - 32, 0,
511 digest, 32,
512 tosend + RTMP_HANDSHAKE_PACKET_SIZE - 32);
513
514 // write reply back to the server
515 url_write(rt->stream, tosend, RTMP_HANDSHAKE_PACKET_SIZE);
6bf22e18
S
516 } else {
517 url_write(rt->stream, serverdata+1, RTMP_HANDSHAKE_PACKET_SIZE);
518 }
519
9fd6b843
KS
520 return 0;
521}
522
523/**
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
528 */
529static int rtmp_parse_result(URLContext *s, RTMPContext *rt, RTMPPacket *pkt)
530{
531 int i, t;
532 const uint8_t *data_end = pkt->data + pkt->data_size;
533
cfac91fe
KS
534#ifdef DEBUG
535 ff_rtmp_packet_dump(LOG_CONTEXT, pkt);
536#endif
537
9fd6b843
KS
538 switch (pkt->type) {
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);
543 return -1;
544 }
6bf22e18
S
545 if (!rt->is_input)
546 ff_rtmp_packet_write(rt->stream, pkt, rt->chunk_size, rt->prev_pkt[1]);
9fd6b843
KS
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);
550 return -1;
551 }
552 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "New chunk size = %d\n", rt->chunk_size);
553 break;
554 case RTMP_PT_PING:
555 t = AV_RB16(pkt->data);
556 if (t == 6)
557 gen_pong(s, rt, pkt);
558 break;
559 case RTMP_PT_INVOKE:
560 //TODO: check for the messages sent for wrong state?
561 if (!memcmp(pkt->data, "\002\000\006_error", 9)) {
562 uint8_t tmpstr[256];
563
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);
567 return -1;
568 } else if (!memcmp(pkt->data, "\002\000\007_result", 10)) {
569 switch (rt->state) {
570 case STATE_HANDSHAKED:
6bf22e18
S
571 if (!rt->is_input) {
572 gen_release_stream(s, rt);
573 gen_fcpublish_stream(s, rt);
574 rt->state = STATE_RELEASING;
575 } else {
576 rt->state = STATE_CONNECTING;
577 }
9fd6b843 578 gen_create_stream(s, rt);
6bf22e18
S
579 break;
580 case STATE_FCPUBLISH:
9fd6b843
KS
581 rt->state = STATE_CONNECTING;
582 break;
6bf22e18
S
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));
589 if (pkt_id == 4)
590 rt->state = STATE_CONNECTING;
591 }
e07c92e4 592 if (rt->state != STATE_CONNECTING)
6bf22e18 593 break;
9fd6b843
KS
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");
598 } else {
599 rt->main_channel_id = (int) av_int2dbl(AV_RB64(pkt->data + 21));
600 }
6bf22e18 601 if (rt->is_input) {
c7240611 602 gen_play(s, rt);
6bf22e18
S
603 } else {
604 gen_publish(s, rt);
605 }
9fd6b843
KS
606 rt->state = STATE_READY;
607 break;
608 }
609 } else if (!memcmp(pkt->data, "\002\000\010onStatus", 11)) {
610 const uint8_t* ptr = pkt->data + 11;
611 uint8_t tmpstr[256];
9fd6b843
KS
612
613 for (i = 0; i < 2; i++) {
614 t = ff_amf_tag_size(ptr, data_end);
615 if (t < 0)
616 return 1;
617 ptr += t;
618 }
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);
625 return -1;
626 }
627 t = ff_amf_get_field_value(ptr, data_end,
628 "code", tmpstr, sizeof(tmpstr));
6bf22e18 629 if (!t && !strcmp(tmpstr, "NetStream.Play.Start")) rt->state = STATE_PLAYING;
72b870b9
MS
630 if (!t && !strcmp(tmpstr, "NetStream.Play.Stop")) rt->state = STATE_STOPPED;
631 if (!t && !strcmp(tmpstr, "NetStream.Play.UnpublishNotify")) rt->state = STATE_STOPPED;
6bf22e18 632 if (!t && !strcmp(tmpstr, "NetStream.Publish.Start")) rt->state = STATE_PUBLISHING;
9fd6b843
KS
633 }
634 break;
635 }
636 return 0;
637}
638
639/**
640 * Interacts with the server by receiving and sending RTMP packets until
641 * there is some significant data (media data or expected status notification).
642 *
643 * @param s reading context
1d8041b3
SS
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
647 * an error happens)
9fd6b843
KS
648 * @return 0 for successful operation, negative value in case of error
649 */
650static int get_packet(URLContext *s, int for_header)
651{
652 RTMPContext *rt = s->priv_data;
653 int ret;
654
72b870b9
MS
655 if (rt->state == STATE_STOPPED)
656 return AVERROR_EOF;
657
e07c92e4 658 for (;;) {
9fd6b843
KS
659 RTMPPacket rpkt;
660 if ((ret = ff_rtmp_packet_read(rt->stream, &rpkt,
661 rt->chunk_size, rt->prev_pkt[0])) != 0) {
662 if (ret > 0) {
663 return AVERROR(EAGAIN);
664 } else {
665 return AVERROR(EIO);
666 }
667 }
668
669 ret = rtmp_parse_result(s, rt, &rpkt);
670 if (ret < 0) {//serious error in current packet
671 ff_rtmp_packet_destroy(&rpkt);
672 return -1;
673 }
72b870b9
MS
674 if (rt->state == STATE_STOPPED) {
675 ff_rtmp_packet_destroy(&rpkt);
676 return AVERROR_EOF;
677 }
6bf22e18 678 if (for_header && (rt->state == STATE_PLAYING || rt->state == STATE_PUBLISHING)) {
9fd6b843
KS
679 ff_rtmp_packet_destroy(&rpkt);
680 return 0;
681 }
6bf22e18 682 if (!rpkt.data_size || !rt->is_input) {
9fd6b843
KS
683 ff_rtmp_packet_destroy(&rpkt);
684 continue;
685 }
686 if (rpkt.type == RTMP_PT_VIDEO || rpkt.type == RTMP_PT_AUDIO ||
afbacb93 687 (rpkt.type == RTMP_PT_NOTIFY && !memcmp("\002\000\012onMetaData", rpkt.data, 13))) {
9fd6b843
KS
688 uint8_t *p;
689 uint32_t ts = rpkt.timestamp;
690
9fd6b843
KS
691 // generate packet header and put data into buffer for FLV demuxer
692 rt->flv_off = 0;
693 rt->flv_size = rpkt.data_size + 15;
694 rt->flv_data = p = av_realloc(rt->flv_data, rt->flv_size);
695 bytestream_put_byte(&p, rpkt.type);
696 bytestream_put_be24(&p, rpkt.data_size);
697 bytestream_put_be24(&p, ts);
698 bytestream_put_byte(&p, ts >> 24);
699 bytestream_put_be24(&p, 0);
700 bytestream_put_buffer(&p, rpkt.data, rpkt.data_size);
701 bytestream_put_be32(&p, 0);
702 ff_rtmp_packet_destroy(&rpkt);
703 return 0;
704 } else if (rpkt.type == RTMP_PT_METADATA) {
705 // we got raw FLV data, make it available for FLV demuxer
706 rt->flv_off = 0;
707 rt->flv_size = rpkt.data_size;
708 rt->flv_data = av_realloc(rt->flv_data, rt->flv_size);
709 memcpy(rt->flv_data, rpkt.data, rpkt.data_size);
710 ff_rtmp_packet_destroy(&rpkt);
711 return 0;
712 }
713 ff_rtmp_packet_destroy(&rpkt);
714 }
715 return 0;
716}
717
718static int rtmp_close(URLContext *h)
719{
720 RTMPContext *rt = h->priv_data;
721
e07c92e4 722 if (!rt->is_input) {
6bf22e18
S
723 rt->flv_data = NULL;
724 if (rt->out_pkt.data_size)
725 ff_rtmp_packet_destroy(&rt->out_pkt);
615c2879
S
726 if (rt->state > STATE_FCPUBLISH)
727 gen_fcunpublish_stream(h, rt);
6bf22e18 728 }
615c2879
S
729 if (rt->state > STATE_HANDSHAKED)
730 gen_delete_stream(h, rt);
6bf22e18 731
9fd6b843
KS
732 av_freep(&rt->flv_data);
733 url_close(rt->stream);
734 av_free(rt);
735 return 0;
736}
737
738/**
739 * Opens RTMP connection and verifies that the stream can be played.
740 *
741 * URL syntax: rtmp://server[:port][/app][/playpath]
742 * where 'app' is first one or two directories in the path
743 * (e.g. /ondemand/, /flash/live/, etc.)
744 * and 'playpath' is a file name (the rest of the path,
745 * may be prefixed with "mp4:")
746 */
747static int rtmp_open(URLContext *s, const char *uri, int flags)
748{
749 RTMPContext *rt;
5e9ad759 750 char proto[8], hostname[256], path[1024], *fname;
9fd6b843 751 uint8_t buf[2048];
b316991b 752 int port;
9fd6b843
KS
753 int ret;
754
9fd6b843
KS
755 rt = av_mallocz(sizeof(RTMPContext));
756 if (!rt)
757 return AVERROR(ENOMEM);
758 s->priv_data = rt;
b316991b 759 rt->is_input = !(flags & URL_WRONLY);
9fd6b843
KS
760
761 url_split(proto, sizeof(proto), NULL, 0, hostname, sizeof(hostname), &port,
762 path, sizeof(path), s->filename);
763
764 if (port < 0)
765 port = RTMP_DEFAULT_PORT;
766 snprintf(buf, sizeof(buf), "tcp://%s:%d", hostname, port);
767
fe523958
KS
768 if (url_open(&rt->stream, buf, URL_RDWR) < 0) {
769 av_log(LOG_CONTEXT, AV_LOG_ERROR, "Cannot open connection %s\n", buf);
9fd6b843 770 goto fail;
fe523958 771 }
9fd6b843 772
c7240611
KS
773 rt->state = STATE_START;
774 if (rtmp_handshake(s, rt))
775 return -1;
9fd6b843 776
c7240611
KS
777 rt->chunk_size = 128;
778 rt->state = STATE_HANDSHAKED;
779 //extract "app" part from path
780 if (!strncmp(path, "/ondemand/", 10)) {
781 fname = path + 10;
782 memcpy(rt->app, "ondemand", 9);
783 } else {
784 char *p = strchr(path + 1, '/');
785 if (!p) {
786 fname = path + 1;
787 rt->app[0] = '\0';
9fd6b843 788 } else {
c7240611
KS
789 char *c = strchr(p + 1, ':');
790 fname = strchr(p + 1, '/');
791 if (!fname || c < fname) {
792 fname = p + 1;
793 av_strlcpy(rt->app, path + 1, p - path);
9fd6b843 794 } else {
c7240611
KS
795 fname++;
796 av_strlcpy(rt->app, path + 1, fname - path - 1);
9fd6b843
KS
797 }
798 }
c7240611
KS
799 }
800 if (!strchr(fname, ':') &&
801 (!strcmp(fname + strlen(fname) - 4, ".f4v") ||
802 !strcmp(fname + strlen(fname) - 4, ".mp4"))) {
803 memcpy(rt->playpath, "mp4:", 5);
804 } else {
805 rt->playpath[0] = 0;
806 }
807 strncat(rt->playpath, fname, sizeof(rt->playpath) - 5);
9fd6b843 808
c7240611
KS
809 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "Proto = %s, path = %s, app = %s, fname = %s\n",
810 proto, path, rt->app, rt->playpath);
811 gen_connect(s, rt, proto, hostname, port);
9fd6b843 812
c7240611
KS
813 do {
814 ret = get_packet(s, 1);
815 } while (ret == EAGAIN);
816 if (ret < 0)
817 goto fail;
6bf22e18
S
818
819 if (rt->is_input) {
9fd6b843
KS
820 // generate FLV header for demuxer
821 rt->flv_size = 13;
822 rt->flv_data = av_realloc(rt->flv_data, rt->flv_size);
823 rt->flv_off = 0;
824 memcpy(rt->flv_data, "FLV\1\5\0\0\0\011\0\0\0\0", rt->flv_size);
6bf22e18
S
825 } else {
826 rt->flv_size = 0;
827 rt->flv_data = NULL;
828 rt->flv_off = 0;
9fd6b843
KS
829 }
830
831 s->max_packet_size = url_get_max_packet_size(rt->stream);
832 s->is_streamed = 1;
833 return 0;
834
835fail:
836 rtmp_close(s);
837 return AVERROR(EIO);
838}
839
840static int rtmp_read(URLContext *s, uint8_t *buf, int size)
841{
842 RTMPContext *rt = s->priv_data;
843 int orig_size = size;
844 int ret;
845
846 while (size > 0) {
847 int data_left = rt->flv_size - rt->flv_off;
848
849 if (data_left >= size) {
850 memcpy(buf, rt->flv_data + rt->flv_off, size);
851 rt->flv_off += size;
852 return orig_size;
853 }
854 if (data_left > 0) {
855 memcpy(buf, rt->flv_data + rt->flv_off, data_left);
856 buf += data_left;
857 size -= data_left;
858 rt->flv_off = rt->flv_size;
859 }
860 if ((ret = get_packet(s, 0)) < 0)
861 return ret;
862 }
863 return orig_size;
864}
865
866static int rtmp_write(URLContext *h, uint8_t *buf, int size)
867{
6bf22e18
S
868 RTMPContext *rt = h->priv_data;
869 int size_temp = size;
870 int pktsize, pkttype;
871 uint32_t ts;
872 const uint8_t *buf_temp = buf;
873
874 if (size < 11) {
875 av_log(LOG_CONTEXT, AV_LOG_DEBUG, "FLV packet too small %d\n", size);
876 return 0;
877 }
878
879 do {
880 if (!rt->flv_off) {
881 //skip flv header
882 if (buf_temp[0] == 'F' && buf_temp[1] == 'L' && buf_temp[2] == 'V') {
883 buf_temp += 9 + 4;
884 size_temp -= 9 + 4;
885 }
886
887 pkttype = bytestream_get_byte(&buf_temp);
888 pktsize = bytestream_get_be24(&buf_temp);
889 ts = bytestream_get_be24(&buf_temp);
890 ts |= bytestream_get_byte(&buf_temp) << 24;
891 bytestream_get_be24(&buf_temp);
892 size_temp -= 11;
893 rt->flv_size = pktsize;
894
895 //force 12bytes header
896 if (((pkttype == RTMP_PT_VIDEO || pkttype == RTMP_PT_AUDIO) && ts == 0) ||
897 pkttype == RTMP_PT_NOTIFY) {
898 if (pkttype == RTMP_PT_NOTIFY)
899 pktsize += 16;
900 rt->prev_pkt[1][RTMP_SOURCE_CHANNEL].channel_id = 0;
901 }
902
903 //this can be a big packet, it's better to send it right here
904 ff_rtmp_packet_create(&rt->out_pkt, RTMP_SOURCE_CHANNEL, pkttype, ts, pktsize);
905 rt->out_pkt.extra = rt->main_channel_id;
906 rt->flv_data = rt->out_pkt.data;
907
908 if (pkttype == RTMP_PT_NOTIFY)
909 ff_amf_write_string(&rt->flv_data, "@setDataFrame");
910 }
911
912 if (rt->flv_size - rt->flv_off > size_temp) {
913 bytestream_get_buffer(&buf_temp, rt->flv_data + rt->flv_off, size_temp);
914 rt->flv_off += size_temp;
915 } else {
916 bytestream_get_buffer(&buf_temp, rt->flv_data + rt->flv_off, rt->flv_size - rt->flv_off);
917 rt->flv_off += rt->flv_size - rt->flv_off;
918 }
919
920 if (rt->flv_off == rt->flv_size) {
921 bytestream_get_be32(&buf_temp);
922
923 ff_rtmp_packet_write(rt->stream, &rt->out_pkt, rt->chunk_size, rt->prev_pkt[1]);
924 ff_rtmp_packet_destroy(&rt->out_pkt);
925 rt->flv_size = 0;
926 rt->flv_off = 0;
927 }
928 } while (buf_temp - buf < size_temp);
929 return size;
9fd6b843
KS
930}
931
932URLProtocol rtmp_protocol = {
933 "rtmp",
934 rtmp_open,
935 rtmp_read,
936 rtmp_write,
937 NULL, /* seek */
938 rtmp_close,
939};