git.sesse.net Git - ffmpeg/blob - libavformat/librist.c

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   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.
   8  *
   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.
  13  *
  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
  17  */
  18
  19 /**
  20  * @file
  21  * Reliable Internet Streaming Transport protocol
  22  */
  23
  24 #include "libavutil/avassert.h"
  25 #include "libavutil/opt.h"
  26 #include "libavutil/parseutils.h"
  27 #include "libavutil/time.h"
  28
  29 #include "avformat.h"
  30 #include "internal.h"
  31 #include "network.h"
  32 #include "os_support.h"
  33 #include "url.h"
  34
  35 #include <librist/librist.h>
  36
  37 // RIST_MAX_PACKET_SIZE - 28 minimum protocol overhead
  38 #define MAX_PAYLOAD_SIZE (10000-28)
  39
  40 typedef struct RISTContext {
  41     const AVClass *class;
  42
  43     int profile;
  44     int buffer_size;
  45     int packet_size;
  46     int log_level;
  47     int encryption;
  48     char *secret;
  49
  50     struct rist_logging_settings logging_settings;
  51     struct rist_peer_config peer_config;
  52
  53     struct rist_peer *peer;
  54     struct rist_ctx *ctx;
  55 } RISTContext;
  56
  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", OFFSET(buffer_size), AV_OPT_TYPE_INT,   {.i64=0},                     0, INT_MAX, .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=-1},                   -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 },
  70     { NULL }
  71 };
  72
  73 static int risterr2ret(int err)
  74 {
  75     switch (err) {
  76     case RIST_ERR_MALLOC:
  77         return AVERROR(ENOMEM);
  78     default:
  79         return AVERROR_EXTERNAL;
  80     }
  81 }
  82
  83 static int log_cb(void *arg, enum rist_log_level log_level, const char *msg)
  84 {
  85     int level;
  86
  87     switch (log_level) {
  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_VERBOSE; break;
  91     case RIST_LOG_INFO:     level = AV_LOG_INFO;    break;
  92     case RIST_LOG_DEBUG:    level = AV_LOG_DEBUG;   break;
  93     case RIST_LOG_DISABLE:  level = AV_LOG_QUIET;   break;
  94     case RIST_LOG_SIMULATE: level = AV_LOG_TRACE;   break;
  95     default: level = AV_LOG_PANIC;
  96     }
  97
  98     av_log(arg, level, "%s", msg);
  99
 100     return 0;
 101 }
 102
 103 static int librist_close(URLContext *h)
 104 {
 105     RISTContext *s = h->priv_data;
 106     int ret = 0;
 107
 108     s->peer = NULL;
 109
 110     if (s->ctx)
 111         ret = rist_destroy(s->ctx);
 112     s->ctx = NULL;
 113
 114     return risterr2ret(ret);
 115 }
 116
 117 static int librist_open(URLContext *h, const char *uri, int flags)
 118 {
 119     RISTContext *s = h->priv_data;
 120     struct rist_logging_settings *logging_settings = &s->logging_settings;
 121     struct rist_peer_config *peer_config = &s->peer_config;
 122     int ret;
 123
 124     if ((flags & AVIO_FLAG_READ_WRITE) == AVIO_FLAG_READ_WRITE)
 125         return AVERROR(EINVAL);
 126
 127     ret = rist_logging_set(&logging_settings, s->log_level, log_cb, h, NULL, NULL);
 128     if (ret < 0)
 129         return risterr2ret(ret);
 130
 131     if (flags & AVIO_FLAG_WRITE) {
 132         h->max_packet_size = s->packet_size;
 133         ret = rist_sender_create(&s->ctx, s->profile, 0, logging_settings);
 134     }
 135     if (ret < 0)
 136         goto err;
 137
 138     if (flags & AVIO_FLAG_READ) {
 139         h->max_packet_size = MAX_PAYLOAD_SIZE;
 140         ret = rist_receiver_create(&s->ctx, s->profile, logging_settings);
 141     }
 142     if (ret < 0)
 143         goto err;
 144
 145     ret = rist_peer_config_defaults_set(peer_config);
 146     if (ret < 0)
 147         goto err;
 148
 149     ret = rist_parse_address(uri, (const struct rist_peer_config **)&peer_config);
 150     if (ret < 0)
 151         goto err;
 152
 153     if (((s->encryption == 128 || s->encryption == 256) && !s->secret) ||
 154         ((peer_config->key_size == 128 || peer_config->key_size == 256) && !peer_config->secret[0])) {
 155         av_log(h, AV_LOG_ERROR, "secret is mandatory if encryption is enabled\n");
 156         librist_close(h);
 157         return AVERROR(EINVAL);
 158     }
 159
 160     if (s->secret && peer_config->secret[0] == 0)
 161         av_strlcpy(peer_config->secret, s->secret, RIST_MAX_STRING_SHORT);
 162
 163     if (s->secret && (s->encryption == 128 || s->encryption == 256))
 164         peer_config->key_size = s->encryption;
 165
 166     if (s->buffer_size) {
 167         peer_config->recovery_length_min = s->buffer_size;
 168         peer_config->recovery_length_max = s->buffer_size;
 169     }
 170
 171     ret = rist_peer_create(s->ctx, &s->peer, &s->peer_config);
 172     if (ret < 0)
 173         goto err;
 174
 175     ret = rist_start(s->ctx);
 176     if (ret < 0)
 177         goto err;
 178
 179     return 0;
 180
 181 err:
 182     librist_close(h);
 183
 184     return risterr2ret(ret);
 185 }
 186
 187 static int librist_read(URLContext *h, uint8_t *buf, int size)
 188 {
 189     RISTContext *s = h->priv_data;
 190     const struct rist_data_block *data_block;
 191     int ret;
 192
 193     ret = rist_receiver_data_read(s->ctx, &data_block, POLLING_TIME);
 194     if (ret < 0)
 195         return risterr2ret(ret);
 196
 197     if (ret == 0)
 198         return AVERROR(EAGAIN);
 199
 200     if (data_block->payload_len > MAX_PAYLOAD_SIZE) {
 201         rist_receiver_data_block_free((struct rist_data_block**)&data_block);
 202         return AVERROR_EXTERNAL;
 203     }
 204
 205     size = data_block->payload_len;
 206     memcpy(buf, data_block->payload, size);
 207     rist_receiver_data_block_free((struct rist_data_block**)&data_block);
 208
 209     return size;
 210 }
 211
 212 static int librist_write(URLContext *h, const uint8_t *buf, int size)
 213 {
 214     RISTContext *s = h->priv_data;
 215     struct rist_data_block data_block = { 0 };
 216     int ret;
 217
 218     data_block.ts_ntp = 0;
 219     data_block.payload = buf;
 220     data_block.payload_len = size;
 221
 222     ret = rist_sender_data_write(s->ctx, &data_block);
 223     if (ret < 0)
 224         return risterr2ret(ret);
 225
 226     return ret;
 227 }
 228
 229 static const AVClass librist_class = {
 230     .class_name = "librist",
 231     .item_name  = av_default_item_name,
 232     .option     = librist_options,
 233     .version    = LIBAVUTIL_VERSION_INT,
 234 };
 235
 236 const URLProtocol ff_librist_protocol = {
 237     .name                = "rist",
 238     .url_open            = librist_open,
 239     .url_read            = librist_read,
 240     .url_write           = librist_write,
 241     .url_close           = librist_close,
 242     .priv_data_size      = sizeof(RISTContext),
 243     .flags               = URL_PROTOCOL_FLAG_NETWORK,
 244     .priv_data_class     = &librist_class,
 245 };