/* * RTMP network protocol * Copyright (c) 2010 Howard Chu * * This file is part of FFmpeg. * * FFmpeg is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * FFmpeg is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with FFmpeg; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ /** * @file * RTMP protocol based on http://rtmpdump.mplayerhq.hu/ librtmp */ #include "libavutil/avstring.h" #include "libavutil/bprint.h" #include "libavutil/mathematics.h" #include "libavutil/opt.h" #include "avformat.h" #if CONFIG_NETWORK #include "network.h" #endif #include "url.h" #include <librtmp/rtmp.h> #include <librtmp/log.h> typedef struct LibRTMPContext { const AVClass *class; AVBPrint filename; RTMP rtmp; char *app; char *conn; char *subscribe; char *playpath; char *tcurl; char *flashver; char *swfurl; char *swfverify; char *pageurl; char *client_buffer_time; int live; int buffer_size; } LibRTMPContext; static void rtmp_log(int level, const char *fmt, va_list args) { switch (level) { default: case RTMP_LOGCRIT: level = AV_LOG_FATAL; break; case RTMP_LOGERROR: level = AV_LOG_ERROR; break; case RTMP_LOGWARNING: level = AV_LOG_WARNING; break; case RTMP_LOGINFO: level = AV_LOG_INFO; break; case RTMP_LOGDEBUG: level = AV_LOG_VERBOSE; break; case RTMP_LOGDEBUG2: level = AV_LOG_DEBUG; break; } av_vlog(NULL, level, fmt, args); av_log(NULL, level, "\n"); } static int rtmp_close(URLContext *s) { LibRTMPContext *ctx = s->priv_data; RTMP *r = &ctx->rtmp; RTMP_Close(r); av_bprint_finalize(&ctx->filename, NULL); return 0; } /** * Open RTMP connection and verify that the stream can be played. * * URL syntax: rtmp://server[:port][/app][/playpath][ keyword=value]... * where 'app' is first one or two directories in the path * (e.g. /ondemand/, /flash/live/, etc.) * and 'playpath' is a file name (the rest of the path, * may be prefixed with "mp4:") * * Additional RTMP library options may be appended as * space-separated key-value pairs. */ static int rtmp_open(URLContext *s, const char *uri, int flags) { LibRTMPContext *ctx = s->priv_data; RTMP *r = &ctx->rtmp; int rc = 0, level; /* This needs to stay allocated for as long as the RTMP context exists. */ av_bprint_init(&ctx->filename, 0, AV_BPRINT_SIZE_UNLIMITED); switch (av_log_get_level()) { default: case AV_LOG_FATAL: level = RTMP_LOGCRIT; break; case AV_LOG_ERROR: level = RTMP_LOGERROR; break; case AV_LOG_WARNING: level = RTMP_LOGWARNING; break; case AV_LOG_INFO: level = RTMP_LOGINFO; break; case AV_LOG_VERBOSE: level = RTMP_LOGDEBUG; break; case AV_LOG_DEBUG: level = RTMP_LOGDEBUG2; break; } RTMP_LogSetLevel(level); RTMP_LogSetCallback(rtmp_log); av_bprintf(&ctx->filename, "%s", s->filename); if (ctx->app) av_bprintf(&ctx->filename, " app=%s", ctx->app); if (ctx->tcurl) av_bprintf(&ctx->filename, " tcUrl=%s", ctx->tcurl); if (ctx->pageurl) av_bprintf(&ctx->filename, " pageUrl=%s", ctx->pageurl); if (ctx->swfurl) av_bprintf(&ctx->filename, " swfUrl=%s", ctx->swfurl); if (ctx->flashver) av_bprintf(&ctx->filename, " flashVer=%s", ctx->flashver); if (ctx->conn) { char *sep, *p = ctx->conn; while (p) { av_bprintf(&ctx->filename, " conn="); p += strspn(p, " "); if (!*p) break; sep = strchr(p, ' '); if (sep) *sep = '\0'; av_bprintf(&ctx->filename, "%s", p); if (sep) p = sep + 1; else break; } } if (ctx->playpath) av_bprintf(&ctx->filename, " playpath=%s", ctx->playpath); if (ctx->live) av_bprintf(&ctx->filename, " live=1"); if (ctx->subscribe) av_bprintf(&ctx->filename, " subscribe=%s", ctx->subscribe); if (ctx->client_buffer_time) av_bprintf(&ctx->filename, " buffer=%s", ctx->client_buffer_time); if (ctx->swfurl || ctx->swfverify) { if (ctx->swfverify) av_bprintf(&ctx->filename, " swfUrl=%s swfVfy=1", ctx->swfverify); else av_bprintf(&ctx->filename, " swfUrl=%s", ctx->swfurl); } if (!av_bprint_is_complete(&ctx->filename)) { av_bprint_finalize(&ctx->filename, NULL); return AVERROR(ENOMEM); } RTMP_Init(r); /* This will modify filename by null terminating the URL portion */ if (!RTMP_SetupURL(r, ctx->filename.str)) { rc = AVERROR_UNKNOWN; goto fail; } if (flags & AVIO_FLAG_WRITE) RTMP_EnableWrite(r); if (!RTMP_Connect(r, NULL) || !RTMP_ConnectStream(r, 0)) { rc = AVERROR_UNKNOWN; goto fail; } #if CONFIG_NETWORK if (ctx->buffer_size >= 0 && (flags & AVIO_FLAG_WRITE)) { int tmp = ctx->buffer_size; if (setsockopt(r->m_sb.sb_socket, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp))) { rc = AVERROR_EXTERNAL; goto fail; } } #endif s->is_streamed = 1; return 0; fail: if (rc) RTMP_Close(r); av_bprint_finalize(&ctx->filename, NULL); return rc; } static int rtmp_write(URLContext *s, const uint8_t *buf, int size) { LibRTMPContext *ctx = s->priv_data; RTMP *r = &ctx->rtmp; int ret = RTMP_Write(r, buf, size); if (!ret) return AVERROR_EOF; return ret; } static int rtmp_read(URLContext *s, uint8_t *buf, int size) { LibRTMPContext *ctx = s->priv_data; RTMP *r = &ctx->rtmp; int ret = RTMP_Read(r, buf, size); if (!ret) return AVERROR_EOF; return ret; } static int rtmp_read_pause(URLContext *s, int pause) { LibRTMPContext *ctx = s->priv_data; RTMP *r = &ctx->rtmp; if (!RTMP_Pause(r, pause)) return AVERROR_UNKNOWN; return 0; } static int64_t rtmp_read_seek(URLContext *s, int stream_index, int64_t timestamp, int flags) { LibRTMPContext *ctx = s->priv_data; RTMP *r = &ctx->rtmp; if (flags & AVSEEK_FLAG_BYTE) return AVERROR(ENOSYS); /* seeks are in milliseconds */ if (stream_index < 0) timestamp = av_rescale_rnd(timestamp, 1000, AV_TIME_BASE, flags & AVSEEK_FLAG_BACKWARD ? AV_ROUND_DOWN : AV_ROUND_UP); if (!RTMP_SendSeek(r, timestamp)) return AVERROR_UNKNOWN; return timestamp; } static int rtmp_get_file_handle(URLContext *s) { LibRTMPContext *ctx = s->priv_data; RTMP *r = &ctx->rtmp; return RTMP_Socket(r); } #define OFFSET(x) offsetof(LibRTMPContext, x) #define DEC AV_OPT_FLAG_DECODING_PARAM #define ENC AV_OPT_FLAG_ENCODING_PARAM static const AVOption options[] = { {"rtmp_app", "Name of application to connect to on the RTMP server", OFFSET(app), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC}, {"rtmp_buffer", "Set buffer time in milliseconds. The default is 3000.", OFFSET(client_buffer_time), AV_OPT_TYPE_STRING, {.str = "3000"}, 0, 0, DEC|ENC}, {"rtmp_conn", "Append arbitrary AMF data to the Connect message", OFFSET(conn), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC}, {"rtmp_flashver", "Version of the Flash plugin used to run the SWF player.", OFFSET(flashver), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC}, {"rtmp_live", "Specify that the media is a live stream.", OFFSET(live), AV_OPT_TYPE_INT, {.i64 = 0}, INT_MIN, INT_MAX, DEC, "rtmp_live"}, {"any", "both", 0, AV_OPT_TYPE_CONST, {.i64 = -2}, 0, 0, DEC, "rtmp_live"}, {"live", "live stream", 0, AV_OPT_TYPE_CONST, {.i64 = -1}, 0, 0, DEC, "rtmp_live"}, {"recorded", "recorded stream", 0, AV_OPT_TYPE_CONST, {.i64 = 0}, 0, 0, DEC, "rtmp_live"}, {"rtmp_pageurl", "URL of the web page in which the media was embedded. By default no value will be sent.", OFFSET(pageurl), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC}, {"rtmp_playpath", "Stream identifier to play or to publish", OFFSET(playpath), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC}, {"rtmp_subscribe", "Name of live stream to subscribe to. Defaults to rtmp_playpath.", OFFSET(subscribe), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC}, {"rtmp_swfurl", "URL of the SWF player. By default no value will be sent", OFFSET(swfurl), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC}, {"rtmp_swfverify", "URL to player swf file, compute hash/size automatically. (unimplemented)", OFFSET(swfverify), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC}, {"rtmp_tcurl", "URL of the target stream. Defaults to proto://host[:port]/app.", OFFSET(tcurl), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC}, #if CONFIG_NETWORK {"rtmp_buffer_size", "set buffer size in bytes", OFFSET(buffer_size), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, DEC|ENC }, #endif { NULL }, }; #define RTMP_CLASS(flavor)\ static const AVClass lib ## flavor ## _class = {\ .class_name = "lib" #flavor " protocol",\ .item_name = av_default_item_name,\ .option = options,\ .version = LIBAVUTIL_VERSION_INT,\ }; RTMP_CLASS(rtmp) const URLProtocol ff_librtmp_protocol = { .name = "rtmp", .url_open = rtmp_open, .url_read = rtmp_read, .url_write = rtmp_write, .url_close = rtmp_close, .url_read_pause = rtmp_read_pause, .url_read_seek = rtmp_read_seek, .url_get_file_handle = rtmp_get_file_handle, .priv_data_size = sizeof(LibRTMPContext), .priv_data_class = &librtmp_class, .flags = URL_PROTOCOL_FLAG_NETWORK, }; RTMP_CLASS(rtmpt) const URLProtocol ff_librtmpt_protocol = { .name = "rtmpt", .url_open = rtmp_open, .url_read = rtmp_read, .url_write = rtmp_write, .url_close = rtmp_close, .url_read_pause = rtmp_read_pause, .url_read_seek = rtmp_read_seek, .url_get_file_handle = rtmp_get_file_handle, .priv_data_size = sizeof(LibRTMPContext), .priv_data_class = &librtmpt_class, .flags = URL_PROTOCOL_FLAG_NETWORK, }; RTMP_CLASS(rtmpe) const URLProtocol ff_librtmpe_protocol = { .name = "rtmpe", .url_open = rtmp_open, .url_read = rtmp_read, .url_write = rtmp_write, .url_close = rtmp_close, .url_read_pause = rtmp_read_pause, .url_read_seek = rtmp_read_seek, .url_get_file_handle = rtmp_get_file_handle, .priv_data_size = sizeof(LibRTMPContext), .priv_data_class = &librtmpe_class, .flags = URL_PROTOCOL_FLAG_NETWORK, }; RTMP_CLASS(rtmpte) const URLProtocol ff_librtmpte_protocol = { .name = "rtmpte", .url_open = rtmp_open, .url_read = rtmp_read, .url_write = rtmp_write, .url_close = rtmp_close, .url_read_pause = rtmp_read_pause, .url_read_seek = rtmp_read_seek, .url_get_file_handle = rtmp_get_file_handle, .priv_data_size = sizeof(LibRTMPContext), .priv_data_class = &librtmpte_class, .flags = URL_PROTOCOL_FLAG_NETWORK, }; RTMP_CLASS(rtmps) const URLProtocol ff_librtmps_protocol = { .name = "rtmps", .url_open = rtmp_open, .url_read = rtmp_read, .url_write = rtmp_write, .url_close = rtmp_close, .url_read_pause = rtmp_read_pause, .url_read_seek = rtmp_read_seek, .url_get_file_handle = rtmp_get_file_handle, .priv_data_size = sizeof(LibRTMPContext), .priv_data_class = &librtmps_class, .flags = URL_PROTOCOL_FLAG_NETWORK, };