From eb9244f20210fd420fb9b3c98126f9cae525d1cc Mon Sep 17 00:00:00 2001 From: Marvin Scholz Date: Mon, 28 Jul 2014 11:55:38 +0200 Subject: Add Icecast protocol MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Icecast is basically a convenience wrapper around the HTTP protocol. Signed-off-by: Martin Storsjö --- Changelog | 1 + configure | 1 + doc/general.texi | 1 + doc/protocols.texi | 40 +++++++++ libavformat/Makefile | 1 + libavformat/allformats.c | 1 + libavformat/icecast.c | 228 +++++++++++++++++++++++++++++++++++++++++++++++ libavformat/version.h | 2 +- 8 files changed, 274 insertions(+), 1 deletion(-) create mode 100644 libavformat/icecast.c diff --git a/Changelog b/Changelog index bfdd8d1486..edba289814 100644 --- a/Changelog +++ b/Changelog @@ -28,6 +28,7 @@ version : - native Opus decoder - display matrix export and rotation api - drop avserver, it was unmaintained for years and largely broken +- Icecast protocol version 10: diff --git a/configure b/configure index 03742f0c31..b9242e29f6 100755 --- a/configure +++ b/configure @@ -2098,6 +2098,7 @@ gopher_protocol_select="network" http_protocol_select="tcp_protocol" httpproxy_protocol_select="tcp_protocol" https_protocol_select="tls_protocol" +icecast_protocol_select="http_protocol" librtmp_protocol_deps="librtmp" librtmpe_protocol_deps="librtmp" librtmps_protocol_deps="librtmp" diff --git a/doc/general.texi b/doc/general.texi index 1fd5f36fd9..ae59941bf6 100644 --- a/doc/general.texi +++ b/doc/general.texi @@ -948,6 +948,7 @@ performance on systems without hardware floating point support). @item HLS @tab X @item HTTP @tab X @item HTTPS @tab X +@item Icecast @tab X @item MMSH @tab X @item MMST @tab X @item pipe @tab X diff --git a/doc/protocols.texi b/doc/protocols.texi index 1501dab60c..ec7d92440a 100644 --- a/doc/protocols.texi +++ b/doc/protocols.texi @@ -138,6 +138,46 @@ Set initial byte offset. Try to limit the request to bytes preceding this offset. @end table +@section Icecast + +Icecast (stream to Icecast servers) + +This protocol accepts the following options: + +@table @option +@item ice_genre +Set the stream genre. + +@item ice_name +Set the stream name. + +@item ice_description +Set the stream description. + +@item ice_url +Set the stream website URL. + +@item ice_public +Set if the stream should be public or not. +The default is 0 (not public). + +@item user_agent +Override the User-Agent header. If not specified a string of the form +"Lavf/" will be used. + +@item password +Set the Icecast mountpoint password. + +@item content_type +Set the stream content type. This must be set if it is different from +audio/mpeg. + +@item legacy_icecast +This enables support for Icecast versions < 2.4.0, that do not support the +HTTP PUT method but the SOURCE method. + +@end table + @section mmst MMS (Microsoft Media Server) protocol over TCP. diff --git a/libavformat/Makefile b/libavformat/Makefile index c2d77b37c9..a048157375 100644 --- a/libavformat/Makefile +++ b/libavformat/Makefile @@ -375,6 +375,7 @@ OBJS-$(CONFIG_HLS_PROTOCOL) += hlsproto.o OBJS-$(CONFIG_HTTP_PROTOCOL) += http.o httpauth.o urldecode.o OBJS-$(CONFIG_HTTPPROXY_PROTOCOL) += http.o httpauth.o urldecode.o OBJS-$(CONFIG_HTTPS_PROTOCOL) += http.o httpauth.o urldecode.o +OBJS-$(CONFIG_ICECAST_PROTOCOL) += icecast.o OBJS-$(CONFIG_MMSH_PROTOCOL) += mmsh.o mms.o asf.o OBJS-$(CONFIG_MMST_PROTOCOL) += mmst.o mms.o asf.o OBJS-$(CONFIG_MD5_PROTOCOL) += md5proto.o diff --git a/libavformat/allformats.c b/libavformat/allformats.c index 8083ef3e97..984bb52aaf 100644 --- a/libavformat/allformats.c +++ b/libavformat/allformats.c @@ -270,6 +270,7 @@ void av_register_all(void) REGISTER_PROTOCOL(HTTP, http); REGISTER_PROTOCOL(HTTPPROXY, httpproxy); REGISTER_PROTOCOL(HTTPS, https); + REGISTER_PROTOCOL(ICECAST, icecast); REGISTER_PROTOCOL(MMSH, mmsh); REGISTER_PROTOCOL(MMST, mmst); REGISTER_PROTOCOL(MD5, md5); diff --git a/libavformat/icecast.c b/libavformat/icecast.c new file mode 100644 index 0000000000..b671d8ced9 --- /dev/null +++ b/libavformat/icecast.c @@ -0,0 +1,228 @@ +/* + * Icecast protocol for Libav + * Copyright (c) 2014 Marvin Scholz + * + * This file is part of Libav. + * + * Libav 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. + * + * Libav 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 Libav; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + + +#include "libavutil/avstring.h" +#include "libavutil/opt.h" + +#include "avformat.h" +#include "network.h" + + +typedef struct IcecastContext { + const AVClass *class; + URLContext *hd; + int send_started; + char *user; + // Options + char *content_type; + char *description; + char *genre; + int legacy_icecast; + char *name; + char *pass; + int public; + char *url; + char *user_agent; +} IcecastContext; + +#define DEFAULT_ICE_USER "source" + +#define NOT_EMPTY(s) (s && s[0]) + +#define OFFSET(x) offsetof(IcecastContext, x) +#define E AV_OPT_FLAG_ENCODING_PARAM + +static const AVOption options[] = { + { "ice_genre", "set stream genre", OFFSET(genre), AV_OPT_TYPE_STRING, { 0 }, 0, 0, E }, + { "ice_name", "set stream description", OFFSET(name), AV_OPT_TYPE_STRING, { 0 }, 0, 0, E }, + { "ice_description", "set stream description", OFFSET(description), AV_OPT_TYPE_STRING, { 0 }, 0, 0, E }, + { "ice_url", "set stream website", OFFSET(url), AV_OPT_TYPE_STRING, { 0 }, 0, 0, E }, + { "ice_public", "set if stream is public", OFFSET(public), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, E }, + { "user_agent", "override User-Agent header", OFFSET(user_agent), AV_OPT_TYPE_STRING, { 0 }, 0, 0, E }, + { "password", "set password", OFFSET(pass), AV_OPT_TYPE_STRING, { 0 }, 0, 0, E }, + { "content_type", "set content-type, MUST be set if not audio/mpeg", OFFSET(content_type), AV_OPT_TYPE_STRING, { 0 }, 0, 0, E }, + { "legacy_icecast", "use legacy SOURCE method, for Icecast < v2.4", OFFSET(legacy_icecast), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, E }, + { NULL } +}; + + +static char *cat_header(char buf[], const char key[], const char value[]) +{ + if (NOT_EMPTY(value)) { + int len = strlen(key) + strlen(value) + 5; + int is_first = !buf; + char *tmp = NULL; + + if (buf) + len += strlen(buf); + if (!(tmp = av_realloc(buf, len))) { + av_freep(&buf); + return NULL; + } else { + buf = tmp; + } + if (is_first) + *buf = '\0'; + + av_strlcatf(buf, len, "%s: %s\r\n", key, value); + } + return buf; +} + +static int icecast_close(URLContext *h) +{ + IcecastContext *s = h->priv_data; + if (s->hd) + ffurl_close(s->hd); + return 0; +} + +static int icecast_open(URLContext *h, const char *uri, int flags) +{ + IcecastContext *s = h->priv_data; + + // Dict to set options that we pass to the HTTP protocol + AVDictionary *opt_dict = NULL; + + // URI part variables + char h_url[1024], host[1024], auth[1024], path[1024]; + char *headers = NULL, *user = NULL; + int port, ret; + + if (flags & AVIO_FLAG_READ) + return AVERROR(ENOSYS); + + // Build header strings + headers = cat_header(headers, "Ice-Name", s->name); + headers = cat_header(headers, "Ice-Description", s->description); + headers = cat_header(headers, "Ice-URL", s->url); + headers = cat_header(headers, "Ice-Genre", s->genre); + headers = cat_header(headers, "Ice-Public", s->public ? "1" : "0"); + if (!headers) { + ret = AVERROR(ENOMEM); + goto cleanup; + } + + // Set options + av_dict_set(&opt_dict, "method", s->legacy_icecast ? "SOURCE" : "PUT", 0); + av_dict_set(&opt_dict, "auth_type", "basic", 0); + av_dict_set(&opt_dict, "headers", headers, 0); + if (NOT_EMPTY(s->content_type)) + av_dict_set(&opt_dict, "content_type", s->content_type, 0); + if (NOT_EMPTY(s->user_agent)) + av_dict_set(&opt_dict, "user_agent", s->user_agent, 0); + + // Parse URI + av_url_split(NULL, 0, auth, sizeof(auth), host, sizeof(host), + &port, path, sizeof(path), uri); + + // Check for auth data in URI + if (auth[0]) { + char *sep = strchr(auth,':'); + if (sep) { + *sep = 0; + sep++; + if (s->pass) { + av_free(s->pass); + av_log(h, AV_LOG_WARNING, "Overwriting -password with URI password!\n"); + } + if (!(s->pass = av_strdup(sep))) { + ret = AVERROR(ENOMEM); + goto cleanup; + } + } + if (!(user = av_strdup(auth))) { + ret = AVERROR(ENOMEM); + goto cleanup; + } + } + + // Build new authstring + snprintf(auth, sizeof(auth), + "%s:%s", + user ? user : DEFAULT_ICE_USER, + s->pass ? s->pass : ""); + + // Check for mountpoint (path) + if (!path[0] || strcmp(path, "/") == 0) { + av_log(h, AV_LOG_ERROR, "No mountpoint (path) specified!\n"); + ret = AVERROR(EIO); + goto cleanup; + } + + // Build new URI for passing to http protocol + ff_url_join(h_url, sizeof(h_url), "http", auth, host, port, "%s", path); + // Finally open http proto handler + ret = ffurl_open(&s->hd, h_url, AVIO_FLAG_READ_WRITE, NULL, &opt_dict); + +cleanup: + // Free variables + av_freep(&user); + av_freep(&headers); + av_dict_free(&opt_dict); + + return ret; +} + +static int icecast_write(URLContext *h, const uint8_t *buf, int size) +{ + IcecastContext *s = h->priv_data; + if (!s->send_started) { + s->send_started = 1; + if (!s->content_type && size >= 8) { + static const uint8_t oggs[4] = { 0x4F, 0x67, 0x67, 0x53 }; + static const uint8_t webm[4] = { 0x1A, 0x45, 0xDF, 0xA3 }; + static const uint8_t opus[8] = { 0x4F, 0x70, 0x75, 0x73, 0x48, 0x65, 0x61, 0x64 }; + if (memcmp(buf, oggs, sizeof(oggs)) == 0) { + av_log(h, AV_LOG_WARNING, "Streaming Ogg but appropriate content type NOT set!\n"); + av_log(h, AV_LOG_WARNING, "Set it with -content_type application/ogg\n"); + } else if (memcmp(buf, opus, sizeof(opus)) == 0) { + av_log(h, AV_LOG_WARNING, "Streaming Opus but appropriate content type NOT set!\n"); + av_log(h, AV_LOG_WARNING, "Set it with -content_type audio/ogg\n"); + } else if (memcmp(buf, webm, sizeof(webm)) == 0) { + av_log(h, AV_LOG_WARNING, "Streaming WebM but appropriate content type NOT set!\n"); + av_log(h, AV_LOG_WARNING, "Set it with -content_type video/webm\n"); + } else { + av_log(h, AV_LOG_WARNING, "It seems you are streaming an unsupported format.\n"); + av_log(h, AV_LOG_WARNING, "It might work, but is not officially supported in Icecast!\n"); + } + } + } + return ffurl_write(s->hd, buf, size); +} + +static const AVClass icecast_context_class = { + .class_name = "icecast", + .item_name = av_default_item_name, + .option = options, + .version = LIBAVUTIL_VERSION_INT, +}; + +URLProtocol ff_icecast_protocol = { + .name = "icecast", + .url_open = icecast_open, + .url_write = icecast_write, + .url_close = icecast_close, + .priv_data_size = sizeof(IcecastContext), + .priv_data_class = &icecast_context_class, + .flags = URL_PROTOCOL_FLAG_NETWORK, +}; diff --git a/libavformat/version.h b/libavformat/version.h index 6e9ce674bc..fbf5a0cc8b 100644 --- a/libavformat/version.h +++ b/libavformat/version.h @@ -30,7 +30,7 @@ #include "libavutil/version.h" #define LIBAVFORMAT_VERSION_MAJOR 55 -#define LIBAVFORMAT_VERSION_MINOR 20 +#define LIBAVFORMAT_VERSION_MINOR 21 #define LIBAVFORMAT_VERSION_MICRO 0 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \ -- cgit v1.2.3