2 * This file is part of FFmpeg.
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 * Reliable Internet Streaming Transport protocol
24 #include "libavutil/avassert.h"
25 #include "libavutil/opt.h"
26 #include "libavutil/parseutils.h"
27 #include "libavutil/time.h"
32 #include "os_support.h"
35 #include <librist/librist.h>
37 // RIST_MAX_PACKET_SIZE - 28 minimum protocol overhead
38 #define MAX_PAYLOAD_SIZE (10000-28)
40 typedef struct RISTContext {
50 struct rist_logging_settings logging_settings;
51 struct rist_peer_config peer_config;
53 struct rist_peer *peer;
57 #define D AV_OPT_FLAG_DECODING_PARAM
58 #define E AV_OPT_FLAG_ENCODING_PARAM
59 #define OFFSET(x) offsetof(RISTContext, x)
60 static const AVOption librist_options[] = {
61 { "rist_profile","set profile", OFFSET(profile), AV_OPT_TYPE_INT, {.i64=RIST_PROFILE_MAIN}, 0, 2, .flags = D|E, "profile" },
62 { "simple", NULL, 0, AV_OPT_TYPE_CONST, {.i64=RIST_PROFILE_SIMPLE}, 0, 0, .flags = D|E, "profile" },
63 { "main", NULL, 0, AV_OPT_TYPE_CONST, {.i64=RIST_PROFILE_MAIN}, 0, 0, .flags = D|E, "profile" },
64 { "advanced", NULL, 0, AV_OPT_TYPE_CONST, {.i64=RIST_PROFILE_ADVANCED}, 0, 0, .flags = D|E, "profile" },
65 { "buffer_size", "set buffer_size in ms", OFFSET(buffer_size), AV_OPT_TYPE_INT, {.i64=0}, 0, 30000, .flags = D|E },
66 { "pkt_size", "set packet size", OFFSET(packet_size), AV_OPT_TYPE_INT, {.i64=1316}, 1, MAX_PAYLOAD_SIZE, .flags = D|E },
67 { "log_level", "set loglevel", OFFSET(log_level), AV_OPT_TYPE_INT, {.i64=RIST_LOG_INFO}, -1, INT_MAX, .flags = D|E },
68 { "secret", "set encryption secret",OFFSET(secret), AV_OPT_TYPE_STRING,{.str=NULL}, 0, 0, .flags = D|E },
69 { "encryption","set encryption type",OFFSET(encryption), AV_OPT_TYPE_INT ,{.i64=0}, 0, INT_MAX, .flags = D|E },
73 static int risterr2ret(int err)
77 return AVERROR(ENOMEM);
79 return AVERROR_EXTERNAL;
83 static int log_cb(void *arg, enum rist_log_level log_level, const char *msg)
88 case RIST_LOG_ERROR: level = AV_LOG_ERROR; break;
89 case RIST_LOG_WARN: level = AV_LOG_WARNING; break;
90 case RIST_LOG_NOTICE: level = AV_LOG_INFO; break;
91 case RIST_LOG_INFO: level = AV_LOG_VERBOSE; break;
92 case RIST_LOG_DEBUG: level = AV_LOG_DEBUG; break;
93 case RIST_LOG_DISABLE: level = AV_LOG_QUIET; break;
94 default: level = AV_LOG_WARNING;
97 av_log(arg, level, "%s", msg);
102 static int librist_close(URLContext *h)
104 RISTContext *s = h->priv_data;
110 ret = rist_destroy(s->ctx);
113 return risterr2ret(ret);
116 static int librist_open(URLContext *h, const char *uri, int flags)
118 RISTContext *s = h->priv_data;
119 struct rist_logging_settings *logging_settings = &s->logging_settings;
120 struct rist_peer_config *peer_config = &s->peer_config;
123 if ((flags & AVIO_FLAG_READ_WRITE) == AVIO_FLAG_READ_WRITE)
124 return AVERROR(EINVAL);
126 ret = rist_logging_set(&logging_settings, s->log_level, log_cb, h, NULL, NULL);
128 return risterr2ret(ret);
130 if (flags & AVIO_FLAG_WRITE) {
131 h->max_packet_size = s->packet_size;
132 ret = rist_sender_create(&s->ctx, s->profile, 0, logging_settings);
137 if (flags & AVIO_FLAG_READ) {
138 h->max_packet_size = MAX_PAYLOAD_SIZE;
139 ret = rist_receiver_create(&s->ctx, s->profile, logging_settings);
144 ret = rist_peer_config_defaults_set(peer_config);
148 ret = rist_parse_address(uri, (const struct rist_peer_config **)&peer_config);
152 if (((s->encryption == 128 || s->encryption == 256) && !s->secret) ||
153 ((peer_config->key_size == 128 || peer_config->key_size == 256) && !peer_config->secret[0])) {
154 av_log(h, AV_LOG_ERROR, "secret is mandatory if encryption is enabled\n");
156 return AVERROR(EINVAL);
159 if (s->secret && peer_config->secret[0] == 0)
160 av_strlcpy(peer_config->secret, s->secret, RIST_MAX_STRING_SHORT);
162 if (s->secret && (s->encryption == 128 || s->encryption == 256))
163 peer_config->key_size = s->encryption;
165 if (s->buffer_size) {
166 peer_config->recovery_length_min = s->buffer_size;
167 peer_config->recovery_length_max = s->buffer_size;
170 ret = rist_peer_create(s->ctx, &s->peer, &s->peer_config);
174 ret = rist_start(s->ctx);
183 return risterr2ret(ret);
186 static int librist_read(URLContext *h, uint8_t *buf, int size)
188 RISTContext *s = h->priv_data;
189 const struct rist_data_block *data_block;
192 ret = rist_receiver_data_read(s->ctx, &data_block, POLLING_TIME);
194 return risterr2ret(ret);
197 return AVERROR(EAGAIN);
199 if (data_block->payload_len > MAX_PAYLOAD_SIZE) {
200 rist_receiver_data_block_free((struct rist_data_block**)&data_block);
201 return AVERROR_EXTERNAL;
204 size = data_block->payload_len;
205 memcpy(buf, data_block->payload, size);
206 rist_receiver_data_block_free((struct rist_data_block**)&data_block);
211 static int librist_write(URLContext *h, const uint8_t *buf, int size)
213 RISTContext *s = h->priv_data;
214 struct rist_data_block data_block = { 0 };
217 data_block.ts_ntp = 0;
218 data_block.payload = buf;
219 data_block.payload_len = size;
221 ret = rist_sender_data_write(s->ctx, &data_block);
223 return risterr2ret(ret);
228 static const AVClass librist_class = {
229 .class_name = "librist",
230 .item_name = av_default_item_name,
231 .option = librist_options,
232 .version = LIBAVUTIL_VERSION_INT,
235 const URLProtocol ff_librist_protocol = {
237 .url_open = librist_open,
238 .url_read = librist_read,
239 .url_write = librist_write,
240 .url_close = librist_close,
241 .priv_data_size = sizeof(RISTContext),
242 .flags = URL_PROTOCOL_FLAG_NETWORK,
243 .priv_data_class = &librist_class,