Simple-RTMP-Server
SRS(SIMPLE RTMP Server) over state-threads created in 2013.
SRS is a simple, RTMP/HLS, high-performance, single/multiple(plan) processes, edge(plan)/origin live server, compile depends on st(required), ssl and http-parser, use nginx, ffmpeg and cherrypy as external tools. that is, only need st to run srs for minimum run. see Build.
SRS supports vhost, rtmp(encoder push, client/edge pull), ingester(srs pull), HLS, HLS audio only, transcoding, forward, http hooks.
Blog: http://blog.csdn.net/win_lin
See also: https://github.com/winlinvip/simple-rtmp-server
Github demo(with your SRS): http://winlinvip.github.io/simple-rtmp-server
Wiki: https://github.com/winlinvip/simple-rtmp-server/wiki
TencentQQ: http://url.cn/WAHICw (Group: 212189142)
AUTHORS
The PRIMARY AUTHORS are (and/or have been)(Authors ordered by first contribution):
- winlin(winterserver): http://blog.csdn.net/win_lin
- wenjie(wenjiegit): http://blog.chinaunix.net/uid/25006789.html
About the primary AUTHORS:
- Contribute important features to SRS.
- Names of all PRIMARY AUTHORS response in NetConnection.connect and metadata.
And here is an inevitably incomplete list of MUCH-APPRECIATED CONTRIBUTORS --
people who have submitted patches, reported bugs, added translations, helped
answer newbie questions, and generally made SRS that much better: AUTHORS.txt
A big THANK YOU goes to:
- Genes amd Mabbott for creating st(state-threads).
- Michael Talyanksy for introducing us to use st.
- Roman Arutyunyan for creating nginx-rtmp for srs to refer to.
- Joyent for creating http-parser for http-api for srs.
- Igor Sysoev for creating nginx for srs to refer to.
- FFMPEG and libx264 group for srs to use to transcode.
- Guido van Rossum for creating Python for api-server for srs.
Usage
Step 1: get SRS
git clone https://github.com/winlinvip/simple-rtmp-server && cd simple-rtmp-server/trunk
Step 2: build SRS,
Requires Centos6.x/Ubuntu12 32/64bits, others see Build
./configure && make
Step 3: start SRS
./objs/srs -c conf/srs.conf
See also:
Usage: How to delivery RTMP?
Usage: How to delivery HLS?
Usage: How to delivery HLS for other codec?
Usage: How to transode RTMP stream by SRS?
Usage: How to forward stream to other server?
Usage: How to deploy low lantency application?
Usage: How to deploy srs on ARM?
Usage: How to show the demo of SRS?
Usage: Solution using SRS?
System Requirements
Supported operating systems and hardware:
- All Linux , both 32 and 64 bits
- All handware.
Summary
- Simple: also stable enough.
-
High-performance: single-thread, async socket, event/st-thread driven.
- With RTMP edge server, support origin server.
- RTMP without vod streaming, live streaming only.
- With multiple processes, support single process.
- Support vhost, support __defaultVhost__.
- Support adobe rtmp live streaming.
- Support apple HLS(m3u8) live streaming.
- Support HLS audio-only live streaming.
- Support reload config to enable changes.
- Support cache last gop for flash player to fast startup.
- Support listen at multiple ports.
- Support long time(>4.6hours) publish/play.
- High performace, 1800 connections(500kbps), 900Mbps, CPU 90.2%, 41MB
- Support forward publish stream to build active-standby cluster.
- Support broadcast by forward the stream to other servers(origin/edge).
- Support live stream transcoding by ffmpeg.
- Support live stream forward(acopy/vcopy) by ffmpeg.
- Support ffmpeg filters(logo/overlay/crop), x264 params, copy/vn/an.
- Support audio transcode only, speex/mp3 to aac
- Support http callback api hooks(for authentication and injection).
- Support bandwidth test api and flash client.
- Player, publisher(encoder), and demo pages(jquery+bootstrap).
- Demo video meeting or chat(SRS+cherrypy+jquery+bootstrap).
- Full documents in wiki, in chineses.
- Support RTMP(play-publish) library: srs-librtmp
- Support ARM(debian armhf, v7cpu) with rtmp/ssl/hls/librtmp.
- [plan] Support system utest
- [plan] Support embeded http server for api and hls(live/vod)
- [plan] Support vod(file to hls stream)
- [plan] Support stream ingester using ffmpeg.
- [plan] Support ingest RTSP(RTP, SDP) stream to RTMP.
- [plan] Support network based cli and json result.
- [plan] Support HLS cluster, use RTMP ATC to generate the TS
- [plan] Support RTMP edge server, push/pull stream from any RTMP server
- [plan] Support multiple processes, for both origin and edge
- [no-plan] Support adobe flash refer/token/swf verification.
- [no-plan] Support adobe amf3 codec.
- [no-plan] Support dvr(record live to vod file)
- [no-plan] Support encryption: RTMPE/RTMPS, HLS DRM
- [no-plan] Support RTMPT, http to tranverse firewalls
- [no-plan] Support file source, transcoding file to live stream
Performance
- 300 connections, 150Mbps, 500kbps, CPU 18.8%, MEM 5956KB.
- 600 connections, 300Mbps, 500kbps, CPU 32.1%, MEM 9808KB.
- 900 connections, 450Mbps, 500kbps, CPU 49.9%, MEM 11MB.
- 1200 connections, 600Mbps, 500kbps, CPU 72.4%, MEM 15MB.
- 1500 connections, 750Mbps, 500kbps, CPU 81.9%, MEM 28MB.
- 1800 connections, 900Mbps, 500kbps, CPU 90.2%, MEM 41MB.
[winlin@dev6 srs]$ dstat ----total-cpu-usage---- -dsk/total- ---net/lo-- ---paging-- ---system-- usr sys idl wai hiq siq| read writ| recv send| in out | int csw 58 9 32 0 0 1| 0 4168k| 277M 277M| 0 0 | 29k 25k 61 8 30 0 0 1| 0 1168k| 336M 336M| 0 0 | 29k 24k 63 8 27 0 0 1| 0 2240k| 124M 124M| 0 0 | 32k 33k 62 8 28 0 0 1| 0 1632k| 110M 110M| 0 0 | 31k 33k 53 7 40 0 0 1| 0 1360k| 115M 115M| 0 0 | 24k 26k 51 7 41 0 0 1| 0 1184k| 146M 146M| 0 0 | 24k 27k 39 6 54 0 0 1| 0 1284k| 105M 105M| 0 0 | 22k 28k 41 6 52 0 0 1| 0 1264k| 116M 116M| 0 0 | 25k 28k 48 6 45 0 0 1| 0 1272k| 143M 143M| 0 0 | 27k 27k
See also: Performance Test Guide
Releases
- 2013-12-25, Release v0.9, support bandwidth test, player/encoder/chat demos. 20926 lines.
- 2013-12-08, Release v0.8, support http hooks callback, update st_load. 19186 lines.
- 2013-12-03, Release v0.7, support live stream transcoding. 17605 lines.
- 2013-11-29, Release v0.6, support forward stream to origin/edge. 16094 lines.
- 2013-11-26, Release v0.5, support HLS(m3u8), fragment and window. 14449 lines.
- 2013-11-10, Release v0.4, support reload config, pause, longtime publish/play. 12500 lines.
- 2013-11-04, Release v0.3, support vhost, refer, gop cache, listen multiple ports. 11773 lines.
- 2013-10-25, Release v0.2, support rtmp flash publish, h264, time jitter correct. 10125 lines.
- 2013-10-23, Release v0.1, support rtmp FMLE/FFMPEG publish, vp6. 8287 lines.
- 2013-10-17, Created.
Compare
- SRS v0.9: 20926 lines. player/encoder/chat demos. bandwidth test for encoder/CDN.
- SRS v0.8: 19186 lines. implements http hooks refer to nginx-rtmp.
- SRS v0.7: 17605 lines. implements transcoding(FFMPEG) feature refer to wowza.
- SRS v0.6: 16094 lines. important feature forward for CDN.
- SRS v0.5: 14449 lines. implements HLS feature refer to nginx-rtmp.
- SRS v0.4: 12500 lines. important feature reload for CDN.
- SRS v0.3: 11773 lines. implements vhost feature refer to FMS.
- SRS v0.2: 10125 lines. implements rtmp protocol stack refer to nginx-rtmp.
- SRS v0.1: 8287 lines. base on state-threads.
- nginx-rtmp v1.0.4: 26786 lines
- nginx v1.5.0: 139524 lines
History
- v1.0, 2014-03-20, refine hls code, support pure audio HLS.
- v1.0, 2014-03-19, add vn/an for FFMPEG to drop video/audio for radio stream.
- v1.0, 2014-03-19, refine handshake, client support coplex handshake, add utest.
- v1.0, 2014-03-16, support ARM(debian armhf, v7cpu) with rtmp/ssl/hls/librtmp.
- v1.0, 2014-03-12, finish utest for amf0 codec.
- v1.0, 2014-03-06, add gperftools for mem leak detect, mem/cpu profile.
- v1.0, 2014-03-04, add gest framework for utest, build success.
- v1.0, 2014-03-02, add wiki srs-librtmp, srs for arm, product
- v1.0, 2014-03-02, srs-librtmp, client publish/play library like librtmp.
- v1.0, 2014-03-01, modularity, extract core/kernel/rtmp/app/main module.
- v1.0, 2014-02-28, support arm build(SRS/ST), add ssl to 3rdparty package.
- v1.0, 2014-02-28, add wiki BuildArm, FFMPEG, Reload
- v1.0, 2014-02-27, add wiki LowLatency, HTTPCallback, ServerSideScript, IDE
- v1.0, 2014-01-19, add wiki DeliveryHLS
- v1.0, 2014-01-12, add wiki HowToAskQuestion, RtmpUrlVhost
- v1.0, 2014-01-11, fix jw/flower player pause bug, which send closeStream actually.
- v1.0, 2014-01-05, add wiki Build, Performance, Cluster
- v1.0, 2014-01-01, change listen(512), chunk-size(60000), to improve performance.
- v1.0, 2013-12-27, merge from wenjie, the bandwidth test feature.
- v0.9, 2013-12-25, v0.9 released. 20926 lines.
- v0.9, 2013-12-25, fix the bitrate bug(in Bps), use enhanced microphone.
- v0.9, 2013-12-22, demo video meeting or chat(SRS+cherrypy+jquery+bootstrap).
- v0.9, 2013-12-22, merge from wenjie, support banwidth test.
- v0.9, 2013-12-22, merge from wenjie: support set chunk size at vhost level
- v0.9, 2013-12-21, add players for play and publish.
- v0.9, 2013-12-15, ensure the HLS(ts) is continous when republish stream.
- v0.9, 2013-12-15, fix the hls reload bug, feed it the sequence header.
- v0.9, 2013-12-15, refine protocol, use int64_t timestamp for ts and jitter.
- v0.9, 2013-12-15, support set the live queue length(in seconds), drop when full.
- v0.9, 2013-12-15, fix the forwarder reconnect bug, feed it the sequence header.
- v0.9, 2013-12-15, support reload the hls/forwarder/transcoder.
- v0.9, 2013-12-14, refine the thread model for the retry threads.
- v0.9, 2013-12-10, auto install depends tools/libs on centos/ubuntu.
- v0.8, 2013-12-08, v0.8 released. 19186 lines.
- v0.8, 2013-12-08, support http hooks: on_connect/close/publish/unpublish/play/stop.
- v0.8, 2013-12-08, support multiple http hooks for a event.
- v0.8, 2013-12-07, support http callback hooks, on_connect.
- v0.8, 2013-12-07, support network based cli and json result, add CherryPy 3.2.4.
- v0.8, 2013-12-07, update http/hls/rtmp load test tool st_load, use SRS rtmp sdk.
- v0.8, 2013-12-06, support max_connections, drop if exceed.
- v0.8, 2013-12-05, support log_dir, write ffmpeg log to file.
- v0.8, 2013-12-05, fix the forward/hls/encoder bug.
- v0.7, 2013-12-03, v0.7 released. 17605 lines.
- v0.7, 2013-12-01, support dead-loop detect for forwarder and transcoder.
- v0.7, 2013-12-01, support all ffmpeg filters and params.
- v0.7, 2013-11-30, support live stream transcoder by ffmpeg.
- v0.7, 2013-11-30, support --with/without -ffmpeg, build ffmpeg-2.1.
- v0.7, 2013-11-30, add ffmpeg-2.1, x264-core138, lame-3.99.5, libaacplus-2.0.2.
- v0.6, 2013-11-29, v0.6 released. 16094 lines.
- v0.6, 2013-11-29, add performance summary, 1800 clients, 900Mbps, CPU 90.2%, 41MB.
- v0.6, 2013-11-29, support forward stream to other edge server.
- v0.6, 2013-11-29, support forward stream to other origin server.
- v0.6, 2013-11-28, fix memory leak bug, aac decode bug.
- v0.6, 2013-11-27, support --with or --without -hls and -ssl options.
- v0.6, 2013-11-27, support AAC 44100HZ sample rate for iphone, adjust the timestamp.
- v0.5, 2013-11-26, v0.5 released. 14449 lines.
- v0.5, 2013-11-24, support HLS(m3u8), fragment and window.
- v0.5, 2013-11-24, support record to ts file for HLS.
- v0.5, 2013-11-21, add ts_info tool to demux ts file.
- v0.5, 2013-11-16, add rtmp players(OSMF/jwplayer5/jwplayer6).
- v0.4, 2013-11-10, v0.4 released. 12500 lines.
- v0.4, 2013-11-10, support config and reload the pithy print.
- v0.4, 2013-11-09, support reload config(vhost and its detail).
- v0.4, 2013-11-09, support reload config(listen and chunk_size) by SIGHUP(1).
- v0.4, 2013-11-09, support longtime(>4.6hours) publish/play.
- v0.4, 2013-11-09, support config the chunk_size.
- v0.4, 2013-11-09, support pause for live stream.
- v0.3, 2013-11-04, v0.3 released. 11773 lines.
- v0.3, 2013-11-04, support refer/play-refer/publish-refer.
- v0.3, 2013-11-04, support vhosts specified config.
- v0.3, 2013-11-02, support listen multiple ports.
- v0.3, 2013-11-02, support config file in nginx-conf style.
- v0.3, 2013-10-29, support pithy print log message specified by stage.
- v0.3, 2013-10-28, support librtmp without extended-timestamp in 0xCX chunk packet.
- v0.3, 2013-10-27, support cache last gop for client fast startup.
- v0.2, 2013-10-25, v0.2 released. 10125 lines.
- v0.2, 2013-10-25, support flash publish.
- v0.2, 2013-10-25, support h264/avc codec by rtmp complex handshake.
- v0.2, 2013-10-24, support time jitter detect and correct algorithm
- v0.2, 2013-10-24, support decode codec type to cache the h264/avc sequence header.
- v0.1, 2013-10-23, v0.1 released. 8287 lines.
- v0.1, 2013-10-23, support basic amf0 codec, simplify the api using c-style api.
- v0.1, 2013-10-23, support shared ptr msg for zero memory copy.
- v0.1, 2013-10-22, support vp6 codec with rtmp protocol specified simple handshake.
- v0.1, 2013-10-20, support multiple flash client play live streaming.
- v0.1, 2013-10-20, support FMLE/FFMPEG publish live streaming.
- v0.1, 2013-10-18, support rtmp message2chunk protocol(send_message).
- v0.1, 2013-10-17, support rtmp chunk2message protocol(recv_message).
Architecture
System Architecture:
+------------------------------------------------------+ | SRS(Simple RTMP Server) | +---------------+---------------+-----------+----------+ | API/hook | Transcoder | HLS | RTMP | | http-parser | FFMPEG/x264 | NGINX/ts | protocol | +---------------+---------------+-----------+----------+ | Network(state-threads) | +------------------------------------------------------+ | All Linux(RHEL,CentOS,Ubuntu,Fedora...) | +------------------------------------------------------+
Modularity Architecture:
+------------------------------------------------------+ | Main(srs/bandwidth/librtmp) | +------------------------------------------------------+ | App(Server/Client application) | +------------------------------------------------------+ | RTMP(Protocol stack) | +------------------------------------------------------+ | Kernel(depends on Core, provides error/log) | +------------------------------------------------------+ | Core(depends only on system apis) | +------------------------------------------------------+
Stream Architecture:
+---------+ +----------+
+ Publish + + Deliver |
+---|-----+ +----|-----+
+------------------+-------------------------+----------------+
| Input | SRS(Simple RTMP Server) | Output |
+------------------+-------------------------+----------------+
| Encoder(1) | +-> RTMP protocol ----+-> Flash Player |
| (FMLE,FFMPEG, --+->-+-> HLS/NGINX --------+-> m3u8 player |
| Flash,XSPLIT, | +-> Fowarder ---------+-> RTMP Server |
| ......) | +-> Transcoder -------+-> RTMP Server |
| | +-> DVR --------------+-> FILE |
| | +-> BandwidthTest ----+-> Flash/StLoad |
+------------------+ | |
| MediaSource(2) | | |
| (RTSP,FILE, | | |
| HTTP,HLS, --+->-- Ingester -----------+-> SRS |
| Device, | | |
| ......) | | |
+------------------+-------------------------+----------------+
Remark:
(1) Encoder: encoder must push RTMP stream to SRS server.
(2) MediaSource: any media source, which can be ingest by ffmpeg.
(plan) RTMP cluster(origin/edge) Architecture:
Remark: cluster over forward, see Cluster
+---------+ +-----------------+ +-----------------------+
+ Encoder +--+-->-+ SRS(RTMP Edge) +--->-+ (RTMP Origin) |
+---------+ | +-----------------+ | SRS/FMS/NGINX-RTMP |
| | Red5/HELIX/CRTMP |
+-------------------------->-+ ...... |
+-----------------------+
Schema#1: Any RTMP encoder push RTMP stream to RTMP (origin/edge)server,
where SRS RTMP Edge server will forward stream to origin.
+-------------+ +-----------------+ +--------------------+
| RTMP Origin +-->-+ SRS(RTMP Edge) +--+->-+ Client(RTMP/HLS) |
+-------------+ +-----------------+ | | Flash/IOS/Android |
| +--------------------+
|
| +-----------------+
+->-+ SRS(RTMP Edge) +
+-----------------+
Schema#2: SRS RTMP Edge server pull stream from origin (or upstream SRS
RTMP Edge server), then delivery to Client.
(plan) SRS Multiple processes Architecture(design by wenjie):
+---------------+ +--------+
| upnode server | + client +
+-------+-------+ +---+----+
-------------+------------network-------+---------
| |
+--------+ +----+-----------+ +----+----------+
| master +--fork->-+ back source(1) +-->-pull-+ stream 1-N(2) +
+---+----+ +----------------+ +-------+-------+
| |
+-------------------------------------fork--->-----+
| +-------------+
+-------------------fork-->-+ http/vod(3) |
+-------------+
Remark:
(1) back source process: create by master process, get stream from
upnode server if edge, create stream if origin, serve the stream
process.
(2) stream process: create by master process, get stream from back
source process, serve the client.
(3) the embeded mininum http server, also provides vod service. for
http server, it provides http api, hls(live/vod) delivery. for
vod server, it slice the file to hls(m3u8/ts).
Remark:
(a) This multiple processes architecture is design by wenjie, it's a
very simple and powerful multiple process architecture, for the
master no need to pass between stream process.
(b) The CLI architecture is similar to this, instead, cli process
will collect informations from all stream process, master process
only send signals to child processes.
CLI Architecture:
+---------+
+--+ stream1 +---------+
| +---------+ |
+--------+ | +---------+ | +-------+
| master +--fork->-+--+ streamN +---amf0--+>--+ cli +
+--------+ | +---------+ | +-------+
| +-------------+ |
+--+ back source +-----+
+-------------+
Remark:
(1) master listen the global api port, for example, 33330
(2) back source and stream processes listen at private api port,
for example, 33331, 33332, 33333
(3) work processes(stream and back-source), report private api
port to master global api port.
(4) cli connect to master global api port, get all other private
api ports
(5) cli connect to each stream/back-source process to get api data,
cli analysis and summary the data, return to user.
Bandwidth Test Workflow:
+------------+ +----------+
| Client | | Server |
+-----+------+ +-----+----+
| |
| connect vhost-------------> |
| <-----------result(success) |
| |
| <----------call(start play) |
| result(playing)----------> |
| <-------------data(playing) |
| <-----------call(stop play) |
| result(stopped)----------> |
| |
| <-------call(start publish) |
| result(publishing)-------> |
| data(publishing)---------> |
| <--------call(stop publish) |
| result(stopped)(1)-------> |
| |
| <--------------------report |
| final(2)-----------------> |
| <END> |
@See: class SrsBandwidth comments.
Beijing, 2013
Winlin