FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
librtmp.c
Go to the documentation of this file.
1 /*
2  * RTMP network protocol
3  * Copyright (c) 2010 Howard Chu
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
24  * RTMP protocol based on http://rtmpdump.mplayerhq.hu/ librtmp
25  */
26 
27 #include "libavutil/avstring.h"
28 #include "libavutil/mathematics.h"
29 #include "libavutil/opt.h"
30 #include "avformat.h"
31 #if CONFIG_NETWORK
32 #include "network.h"
33 #endif
34 #include "url.h"
35 
36 #include <librtmp/rtmp.h>
37 #include <librtmp/log.h>
38 
39 typedef struct LibRTMPContext {
40  const AVClass *class;
41  RTMP rtmp;
42  char *app;
43  char *conn;
44  char *subscribe;
45  char *playpath;
46  char *tcurl;
47  char *flashver;
48  char *swfurl;
49  char *swfverify;
50  char *pageurl;
52  int live;
56 
57 static void rtmp_log(int level, const char *fmt, va_list args)
58 {
59  switch (level) {
60  default:
61  case RTMP_LOGCRIT: level = AV_LOG_FATAL; break;
62  case RTMP_LOGERROR: level = AV_LOG_ERROR; break;
63  case RTMP_LOGWARNING: level = AV_LOG_WARNING; break;
64  case RTMP_LOGINFO: level = AV_LOG_INFO; break;
65  case RTMP_LOGDEBUG: level = AV_LOG_VERBOSE; break;
66  case RTMP_LOGDEBUG2: level = AV_LOG_DEBUG; break;
67  }
68 
69  av_vlog(NULL, level, fmt, args);
70  av_log(NULL, level, "\n");
71 }
72 
73 static int rtmp_close(URLContext *s)
74 {
76  RTMP *r = &ctx->rtmp;
77 
78  RTMP_Close(r);
79  av_freep(&ctx->temp_filename);
80  return 0;
81 }
82 
83 /**
84  * Open RTMP connection and verify that the stream can be played.
85  *
86  * URL syntax: rtmp://server[:port][/app][/playpath][ keyword=value]...
87  * where 'app' is first one or two directories in the path
88  * (e.g. /ondemand/, /flash/live/, etc.)
89  * and 'playpath' is a file name (the rest of the path,
90  * may be prefixed with "mp4:")
91  *
92  * Additional RTMP library options may be appended as
93  * space-separated key-value pairs.
94  */
95 static int rtmp_open(URLContext *s, const char *uri, int flags)
96 {
98  RTMP *r = &ctx->rtmp;
99  int rc = 0, level;
100  char *filename = s->filename;
101  int len = strlen(s->filename) + 1;
102 
103  switch (av_log_get_level()) {
104  default:
105  case AV_LOG_FATAL: level = RTMP_LOGCRIT; break;
106  case AV_LOG_ERROR: level = RTMP_LOGERROR; break;
107  case AV_LOG_WARNING: level = RTMP_LOGWARNING; break;
108  case AV_LOG_INFO: level = RTMP_LOGINFO; break;
109  case AV_LOG_VERBOSE: level = RTMP_LOGDEBUG; break;
110  case AV_LOG_DEBUG: level = RTMP_LOGDEBUG2; break;
111  }
112  RTMP_LogSetLevel(level);
113  RTMP_LogSetCallback(rtmp_log);
114 
115  if (ctx->app) len += strlen(ctx->app) + sizeof(" app=");
116  if (ctx->tcurl) len += strlen(ctx->tcurl) + sizeof(" tcUrl=");
117  if (ctx->pageurl) len += strlen(ctx->pageurl) + sizeof(" pageUrl=");
118  if (ctx->flashver) len += strlen(ctx->flashver) + sizeof(" flashver=");
119 
120  if (ctx->conn) {
121  char *sep, *p = ctx->conn;
122  int options = 0;
123 
124  while (p) {
125  options++;
126  p += strspn(p, " ");
127  if (!*p)
128  break;
129  sep = strchr(p, ' ');
130  if (sep)
131  p = sep + 1;
132  else
133  break;
134  }
135  len += options * sizeof(" conn=");
136  len += strlen(ctx->conn);
137  }
138 
139  if (ctx->playpath)
140  len += strlen(ctx->playpath) + sizeof(" playpath=");
141  if (ctx->live)
142  len += sizeof(" live=1");
143  if (ctx->subscribe)
144  len += strlen(ctx->subscribe) + sizeof(" subscribe=");
145 
146  if (ctx->client_buffer_time)
147  len += strlen(ctx->client_buffer_time) + sizeof(" buffer=");
148 
149  if (ctx->swfurl || ctx->swfverify) {
150  len += sizeof(" swfUrl=");
151 
152  if (ctx->swfverify)
153  len += strlen(ctx->swfverify) + sizeof(" swfVfy=1");
154  else
155  len += strlen(ctx->swfurl);
156  }
157 
158  if (!(ctx->temp_filename = filename = av_malloc(len)))
159  return AVERROR(ENOMEM);
160 
161  av_strlcpy(filename, s->filename, len);
162  if (ctx->app) {
163  av_strlcat(filename, " app=", len);
164  av_strlcat(filename, ctx->app, len);
165  }
166  if (ctx->tcurl) {
167  av_strlcat(filename, " tcUrl=", len);
168  av_strlcat(filename, ctx->tcurl, len);
169  }
170  if (ctx->pageurl) {
171  av_strlcat(filename, " pageUrl=", len);
172  av_strlcat(filename, ctx->pageurl, len);
173  }
174  if (ctx->swfurl) {
175  av_strlcat(filename, " swfUrl=", len);
176  av_strlcat(filename, ctx->swfurl, len);
177  }
178  if (ctx->flashver) {
179  av_strlcat(filename, " flashVer=", len);
180  av_strlcat(filename, ctx->flashver, len);
181  }
182  if (ctx->conn) {
183  char *sep, *p = ctx->conn;
184  while (p) {
185  av_strlcat(filename, " conn=", len);
186  p += strspn(p, " ");
187  if (!*p)
188  break;
189  sep = strchr(p, ' ');
190  if (sep)
191  *sep = '\0';
192  av_strlcat(filename, p, len);
193 
194  if (sep)
195  p = sep + 1;
196  else
197  break;
198  }
199  }
200  if (ctx->playpath) {
201  av_strlcat(filename, " playpath=", len);
202  av_strlcat(filename, ctx->playpath, len);
203  }
204  if (ctx->live)
205  av_strlcat(filename, " live=1", len);
206  if (ctx->subscribe) {
207  av_strlcat(filename, " subscribe=", len);
208  av_strlcat(filename, ctx->subscribe, len);
209  }
210  if (ctx->client_buffer_time) {
211  av_strlcat(filename, " buffer=", len);
212  av_strlcat(filename, ctx->client_buffer_time, len);
213  }
214  if (ctx->swfurl || ctx->swfverify) {
215  av_strlcat(filename, " swfUrl=", len);
216 
217  if (ctx->swfverify) {
218  av_strlcat(filename, ctx->swfverify, len);
219  av_strlcat(filename, " swfVfy=1", len);
220  } else {
221  av_strlcat(filename, ctx->swfurl, len);
222  }
223  }
224 
225  RTMP_Init(r);
226  if (!RTMP_SetupURL(r, filename)) {
227  rc = AVERROR_UNKNOWN;
228  goto fail;
229  }
230 
231  if (flags & AVIO_FLAG_WRITE)
232  RTMP_EnableWrite(r);
233 
234  if (!RTMP_Connect(r, NULL) || !RTMP_ConnectStream(r, 0)) {
235  rc = AVERROR_UNKNOWN;
236  goto fail;
237  }
238 
239 #if CONFIG_NETWORK
240  if (ctx->buffer_size >= 0 && (flags & AVIO_FLAG_WRITE)) {
241  int tmp = ctx->buffer_size;
242  setsockopt(r->m_sb.sb_socket, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp));
243  }
244 #endif
245 
246  s->is_streamed = 1;
247  return 0;
248 fail:
249  av_freep(&ctx->temp_filename);
250  if (rc)
251  RTMP_Close(r);
252 
253  return rc;
254 }
255 
256 static int rtmp_write(URLContext *s, const uint8_t *buf, int size)
257 {
259  RTMP *r = &ctx->rtmp;
260 
261  return RTMP_Write(r, buf, size);
262 }
263 
264 static int rtmp_read(URLContext *s, uint8_t *buf, int size)
265 {
267  RTMP *r = &ctx->rtmp;
268 
269  return RTMP_Read(r, buf, size);
270 }
271 
272 static int rtmp_read_pause(URLContext *s, int pause)
273 {
275  RTMP *r = &ctx->rtmp;
276 
277  if (!RTMP_Pause(r, pause))
278  return AVERROR_UNKNOWN;
279  return 0;
280 }
281 
282 static int64_t rtmp_read_seek(URLContext *s, int stream_index,
283  int64_t timestamp, int flags)
284 {
286  RTMP *r = &ctx->rtmp;
287 
288  if (flags & AVSEEK_FLAG_BYTE)
289  return AVERROR(ENOSYS);
290 
291  /* seeks are in milliseconds */
292  if (stream_index < 0)
293  timestamp = av_rescale_rnd(timestamp, 1000, AV_TIME_BASE,
295 
296  if (!RTMP_SendSeek(r, timestamp))
297  return AVERROR_UNKNOWN;
298  return timestamp;
299 }
300 
302 {
304  RTMP *r = &ctx->rtmp;
305 
306  return RTMP_Socket(r);
307 }
308 
309 #define OFFSET(x) offsetof(LibRTMPContext, x)
310 #define DEC AV_OPT_FLAG_DECODING_PARAM
311 #define ENC AV_OPT_FLAG_ENCODING_PARAM
312 static const AVOption options[] = {
313  {"rtmp_app", "Name of application to connect to on the RTMP server", OFFSET(app), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC},
314  {"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},
315  {"rtmp_conn", "Append arbitrary AMF data to the Connect message", OFFSET(conn), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC},
316  {"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},
317  {"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"},
318  {"any", "both", 0, AV_OPT_TYPE_CONST, {.i64 = -2}, 0, 0, DEC, "rtmp_live"},
319  {"live", "live stream", 0, AV_OPT_TYPE_CONST, {.i64 = -1}, 0, 0, DEC, "rtmp_live"},
320  {"recorded", "recorded stream", 0, AV_OPT_TYPE_CONST, {.i64 = 0}, 0, 0, DEC, "rtmp_live"},
321  {"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},
322  {"rtmp_playpath", "Stream identifier to play or to publish", OFFSET(playpath), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC|ENC},
323  {"rtmp_subscribe", "Name of live stream to subscribe to. Defaults to rtmp_playpath.", OFFSET(subscribe), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC},
324  {"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},
325  {"rtmp_swfverify", "URL to player swf file, compute hash/size automatically. (unimplemented)", OFFSET(swfverify), AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0, DEC},
326  {"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},
327 #if CONFIG_NETWORK
328  {"rtmp_buffer_size", "set buffer size in bytes", OFFSET(buffer_size), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, DEC|ENC },
329 #endif
330  { NULL },
331 };
332 
333 #define RTMP_CLASS(flavor)\
334 static const AVClass lib ## flavor ## _class = {\
335  .class_name = "lib" #flavor " protocol",\
336  .item_name = av_default_item_name,\
337  .option = options,\
338  .version = LIBAVUTIL_VERSION_INT,\
339 };
340 
341 RTMP_CLASS(rtmp)
343  .name = "rtmp",
344  .url_open = rtmp_open,
345  .url_read = rtmp_read,
346  .url_write = rtmp_write,
347  .url_close = rtmp_close,
348  .url_read_pause = rtmp_read_pause,
349  .url_read_seek = rtmp_read_seek,
350  .url_get_file_handle = rtmp_get_file_handle,
351  .priv_data_size = sizeof(LibRTMPContext),
352  .priv_data_class = &librtmp_class,
354 };
355 
356 RTMP_CLASS(rtmpt)
358  .name = "rtmpt",
359  .url_open = rtmp_open,
360  .url_read = rtmp_read,
361  .url_write = rtmp_write,
362  .url_close = rtmp_close,
363  .url_read_pause = rtmp_read_pause,
364  .url_read_seek = rtmp_read_seek,
365  .url_get_file_handle = rtmp_get_file_handle,
366  .priv_data_size = sizeof(LibRTMPContext),
367  .priv_data_class = &librtmpt_class,
369 };
370 
371 RTMP_CLASS(rtmpe)
373  .name = "rtmpe",
374  .url_open = rtmp_open,
375  .url_read = rtmp_read,
376  .url_write = rtmp_write,
377  .url_close = rtmp_close,
378  .url_read_pause = rtmp_read_pause,
379  .url_read_seek = rtmp_read_seek,
380  .url_get_file_handle = rtmp_get_file_handle,
381  .priv_data_size = sizeof(LibRTMPContext),
382  .priv_data_class = &librtmpe_class,
384 };
385 
386 RTMP_CLASS(rtmpte)
388  .name = "rtmpte",
389  .url_open = rtmp_open,
390  .url_read = rtmp_read,
391  .url_write = rtmp_write,
392  .url_close = rtmp_close,
393  .url_read_pause = rtmp_read_pause,
394  .url_read_seek = rtmp_read_seek,
395  .url_get_file_handle = rtmp_get_file_handle,
396  .priv_data_size = sizeof(LibRTMPContext),
397  .priv_data_class = &librtmpte_class,
399 };
400 
401 RTMP_CLASS(rtmps)
403  .name = "rtmps",
404  .url_open = rtmp_open,
405  .url_read = rtmp_read,
406  .url_write = rtmp_write,
407  .url_close = rtmp_close,
408  .url_read_pause = rtmp_read_pause,
409  .url_read_seek = rtmp_read_seek,
410  .url_get_file_handle = rtmp_get_file_handle,
411  .priv_data_size = sizeof(LibRTMPContext),
412  .priv_data_class = &librtmps_class,
414 };
#define AVSEEK_FLAG_BACKWARD
Definition: avformat.h:2378
#define NULL
Definition: coverity.c:32
char * app
Definition: librtmp.c:42
const char * s
Definition: avisynth_c.h:768
#define ENC
Definition: librtmp.c:311
#define URL_PROTOCOL_FLAG_NETWORK
Definition: url.h:34
static int64_t rtmp_read_seek(URLContext *s, int stream_index, int64_t timestamp, int flags)
Definition: librtmp.c:282
AVOption.
Definition: opt.h:245
const URLProtocol ff_librtmps_protocol
Definition: librtmp.c:402
const char * fmt
Definition: avisynth_c.h:769
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int is_streamed
true if streamed (no seek possible), default = false
Definition: url.h:45
#define AVIO_FLAG_WRITE
write-only
Definition: avio.h:607
char * temp_filename
Definition: librtmp.c:53
char * flashver
Definition: librtmp.c:47
static int rtmp_read_pause(URLContext *s, int pause)
Definition: librtmp.c:272
char * tcurl
Definition: librtmp.c:46
char * swfverify
Definition: librtmp.c:49
uint8_t
Round toward +infinity.
Definition: mathematics.h:83
#define av_malloc(s)
AVOptions.
int buffer_size
Definition: librtmp.c:54
static int rtmp_close(URLContext *s)
Definition: librtmp.c:73
static int rtmp_open(URLContext *s, const char *uri, int flags)
Open RTMP connection and verify that the stream can be played.
Definition: librtmp.c:95
#define DEC
Definition: librtmp.c:310
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
ptrdiff_t size
Definition: opengl_enc.c:101
#define av_log(a,...)
const URLProtocol ff_librtmpt_protocol
Definition: librtmp.c:357
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
static void rtmp_log(int level, const char *fmt, va_list args)
Definition: librtmp.c:57
#define AVERROR(e)
Definition: error.h:43
const char * r
Definition: vf_curves.c:111
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
int av_log_get_level(void)
Get the current log level.
Definition: log.c:386
const URLProtocol ff_librtmp_protocol
Definition: librtmp.c:342
size_t av_strlcpy(char *dst, const char *src, size_t size)
Copy the string src to dst, but no more than size - 1 bytes, and null-terminate dst.
Definition: avstring.c:83
#define fail()
Definition: checkasm.h:82
char * pageurl
Definition: librtmp.c:50
#define AV_TIME_BASE
Internal time base represented as integer.
Definition: avutil.h:248
char * conn
Definition: librtmp.c:43
AVFormatContext * ctx
Definition: movenc.c:48
int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding rnd)
Rescale a 64-bit integer with specified rounding.
Definition: mathematics.c:58
char * client_buffer_time
Definition: librtmp.c:51
#define AV_LOG_INFO
Standard information.
Definition: log.h:187
static const AVOption options[]
Definition: librtmp.c:312
void * buf
Definition: avisynth_c.h:690
Definition: url.h:38
Describe the class of an AVClass context structure.
Definition: log.h:67
void * priv_data
Definition: url.h:41
#define OFFSET(x)
Definition: librtmp.c:309
#define AVSEEK_FLAG_BYTE
seeking based on position in bytes
Definition: avformat.h:2379
void av_vlog(void *avcl, int level, const char *fmt, va_list vl)
Send the specified message to the log if the level is less than or equal to the current av_log_level...
Definition: log.c:379
char * playpath
Definition: librtmp.c:45
static int rtmp_write(URLContext *s, const uint8_t *buf, int size)
Definition: librtmp.c:256
size_t av_strlcat(char *dst, const char *src, size_t size)
Append the string src to the string dst, but to a total length of no more than size - 1 bytes...
Definition: avstring.c:93
const char * name
Definition: url.h:54
Round toward -infinity.
Definition: mathematics.h:82
const URLProtocol ff_librtmpte_protocol
Definition: librtmp.c:387
static int flags
Definition: cpu.c:47
uint8_t level
Definition: svq3.c:207
Main libavformat public API header.
char * filename
specified URL
Definition: url.h:42
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:71
char * swfurl
Definition: librtmp.c:48
static int rtmp_get_file_handle(URLContext *s)
Definition: librtmp.c:301
int len
static uint8_t tmp[8]
Definition: des.c:38
static int rtmp_read(URLContext *s, uint8_t *buf, int size)
Definition: librtmp.c:264
const URLProtocol ff_librtmpe_protocol
Definition: librtmp.c:372
char * subscribe
Definition: librtmp.c:44
#define av_freep(p)
unbuffered private I/O API
#define AV_LOG_FATAL
Something went wrong and recovery is not possible.
Definition: log.h:170
#define RTMP_CLASS(flavor)
Definition: librtmp.c:333