WebRTC streamer for V4L2 capture devices and RTSP sources
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update config.yml Jan 26, 2019
.github fix build for windows disabling H264 Jan 20, 2019
civetweb @ 3ebb61e upgrade civetweb Aug 24, 2018
getopt @ 4173eb5 add getopt for windows Aug 31, 2018
html @ b7880a5 update html Jan 6, 2019
images add snaphot with layout display and use width+height capture option Sep 8, 2018
inc Merge branch 'master' of https://github.com/mpromonet/webrtc-streamer Feb 14, 2019
live555helper @ de09337 add thread name for debugging Sep 22, 2018
src Merge branch 'master' of https://github.com/mpromonet/webrtc-streamer Feb 14, 2019
.cirrus.yml add cirrusci link Feb 10, 2019
.gitignore try to fix deadlock running PeerConnection::Close Sep 23, 2018
.gitlab-ci.yml try to build rpi container Jan 19, 2019
.gitmodules add getopt for windows Aug 31, 2018
.travis.yml Update .travis.yml Feb 8, 2019
CMakeLists.txt add cirrusci link Feb 10, 2019
Dockerfile add cirrusci link Feb 10, 2019
Dockerfile.rpi replace maintener tag in docker Feb 2, 2019
Dockerfile.windows Update Dockerfile.windows Feb 8, 2019
LICENSE add license file and update readme Feb 10, 2016
Makefile Update Makefile Dec 24, 2018
Procfile extract urls in config file Oct 14, 2018
README.md add cirrusci link Feb 10, 2019
appveyor.yml add cirrusci link Feb 10, 2019
config.json try to fix build on circleci & travis Oct 14, 2018
docker-compose.yml add docker compose file Apr 24, 2018
joinjanusvideoroom.js rework janusvideoroom to work with nodejs & webbrowser Apr 2, 2018
joinxmpproom.js fix some codacy issues Feb 2, 2019
manifest.yml upgrade cf manifest Oct 28, 2018
package.json work on jitsi publishing Aug 18, 2018

README.md

TravisCI CircleCI Appveyor CirusCI

Codacy Badge

Release Download Docker Pulls

Heroku Openshift

WebRTC-streamer

This is a try to stream video sources through WebRTC using simple mechanism.

It embeds a HTTP server that implements API and serves a simple HTML page that use them through AJAX.

The WebRTC signaling is implemented through HTTP requests:

  • /api/call : send offer and get answer

  • /api/hangup : close a call

  • /api/addIceCandidate : add a candidate

  • /api/getIceCandidate : get the list of candidates

The list of HTTP API is available using /api/help.

Nowdays there is 3 builds on CircleCI :

  • for x86_64 on Ubuntu Bionic
  • for armv7 crosscompiling with gcc-linaro-arm-linux-gnueabihf-raspbian-x64 (this build is running on Raspberry Pi2 and NanoPi NEO)
  • for armv6+vfp crosscompiling with gcc-linaro-arm-linux-gnueabihf-raspbian-x64 (this build is running on Raspberry PiB and should run on a Raspberry Zero)

and 4 builds on Appveyor :

  • for Windows using Visual 2017 64bits Release/Debug
  • for x86_64 Ubuntu Xenial Release/Debug

The webrtc stream name could be :

  • an alias defined using -n argument then the corresponding -u argument will be used to create the capturer
  • an "rtsp://" url that will be openned using an RTSP capturer based on live555
  • an "file://" url that will be openned using an MKV capturer based on live555
  • an "screen://" url that will be openned by webrtc::DesktopCapturer::CreateScreenCapturer
  • an "window://" url that will be openned by webrtc::DesktopCapturer::CreateWindowCapturer
  • a V4L2 capture device name

Dependencies :

It is based on :

Build

Install the Chromium depot tools (for WebRTC).

pushd ..
git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git
export PATH=$PATH:`realpath depot_tools`
popd

Download WebRTC

mkdir ../webrtc
pushd ../webrtc
fetch --no-history webrtc 
popd

Build WebRTC Streamer

cmake . -DWEBRTCBUILD=<Release or Debug> -DWEBRTCROOT=<path to WebRTC>
make

where WEBRTCROOT and WEBRTCBUILD indicate how to point to WebRTC :

  • $WEBRTCROOT/src should contains source (default is $(pwd)/../webrtc)
  • $WEBRTCROOT/src/out/$WEBRTCBUILD should contains libraries (default is Release)

Usage

./webrtc-streamer [-H http port] [-S[embeded stun address]] -[v[v]]  [url1]...[urln]
./webrtc-streamer [-H http port] [-s[external stun address]] -[v[v]] [url1]...[urln]
./webrtc-streamer -V
    	-v[v[v]]           : verbosity
    	-V                 : print version

    	-H [hostname:]port : HTTP server binding (default 0.0.0.0:8000)
	-w webroot         : path to get files
	-c sslkeycert      : path to private key and certificate for HTTPS
	-T nbthreads       : number of threads for HTTP server
	-A passwd          : password file for HTTP server access

     	-S[stun_address]   : start embeded STUN server bind to address (default 0.0.0.0:3478)
     	-s[stun_address]   : use an external STUN server (default stun.l.google.com:19302)
     	-t[username:password@]turn_address : use an external TURN relay server (default disabled)		
    	-a[audio layer]    : spefify audio capture layer to use (default:3)		

	-n name -u videourl -U audiourl : register a name for a video url and an audio url
     	[url]                           : url to register in the source list
	-C config.json                  : load urls from JSON config file 

Arguments of '-H' are forwarded to option listening_ports of civetweb, then it is possible to use the civetweb syntax like -H8000,9000 or -H8080r,8443s.

Example

webrtc-streamer rtsp://217.17.220.110/axis-media/media.amp \
			rtsp://85.255.175.241/h264 \
			rtsp://85.255.175.244/h264 \
			rtsp://184.72.239.149/vod/mp4:BigBuckBunny_175k.mov

Screenshot

Live Demo

We can access to the WebRTC stream using webrtcstreamer.html for instance :

An example displaying grid of WebRTC Streams is available using option "layout=x" Screenshot

Embed in a HTML page:

Instead of using the internal HTTP server, it is easy to display a WebRTC stream in a HTML page served by another HTTP server. The URL of the webrtc-streamer to use should be given creating the WebRtcStreamer instance :

var webRtcServer      = new WebRtcStreamer(<video tag>, <webrtc-streamer url>);

A short sample HTML page using webrtc-streamer running locally on port 8000 :

<html>
<head>
<script src="libs/request.min.js" ></script>
<script src="libs/adapter.min.js" ></script>
<script src="webrtcstreamer.js" ></script>
<script>        
    var webRtcServer      = new WebRtcStreamer("video",location.protocol+"//"+window.location.hostname+":8000");
    window.onload         = function() { webRtcServer.connect("rtsp://pi2.local:8554/unicast") }
    window.onbeforeunload = function() { webRtcServer.disconnect() }
</script>
</head>
<body> 
    <video id="video" />
</body>
</html>

Connect to Janus Gateway Video Room

A simple way to publish WebRTC stream to a Janus Gateway Video Room is to use the JanusVideoRoom interface

    var janus = new JanusVideoRoom(<janus url>, <webrtc-streamer url>)

A short sample to publish WebRTC streams to Janus Video Room could be :

<html>
<head>
<script src="libs/request.min.js" ></script>
<script src="janusvideoroom.js" ></script>
<script>        
	var janus = new JanusVideoRoom("https://janus.conf.meetecho.com/janus", null);
	janus.join(1234, "rtsp://pi2.local:8554/unicast","pi2");
	janus.join(1234, "rtsp://217.17.220.110/axis-media/media.amp","media");	    
</script>
</head>
</html>

Screenshot

Live Demo

This way the communication between Janus API and WebRTC Streamer API is implemented in Javascript running in browser.

The same logic could be implemented in NodeJS using the same JS API :

global.request = require('then-request');
var JanusVideoRoom = require('./html/janusvideoroom.js'); 
var janus = new JanusVideoRoom("http://192.168.0.15:8088/janus", "http://192.168.0.15:8000")
janus.join(1234,"mmal service 16.1","video")

Connect to Jitsi

A simple way to publish WebRTC stream to a Jitsi Video Room is to use the XMPPVideoRoom interface

    var xmpp = new XMPPVideoRoom(<xmpp server url>, <webrtc-streamer url>)

A short sample to publish WebRTC streams to a Jitsi Video Room could be :

<html>
<head>
<script src="libs/strophe.min.js" ></script>
<script src="libs/strophe.muc.min.js" ></script>
<script src="libs/strophe.disco.min.js" ></script>
<script src="libs/strophe.jingle.sdp.js"></script>
<script src="libs/jquery-1.12.4.min.js"></script>
<script src="libs/request.min.js" ></script>
<script src="xmppvideoroom.js" ></script>
<script>        
	var xmpp = new XMPPVideoRoom("meet.jit.si", null);
	xmpp.join("testroom", "rtsp://184.72.239.149/vod/mp4:BigBuckBunny_175k.mov","Bunny");	    
</script>
</head>
</html>

Live Demo

Docker image

You can start the application using the docker image :

    docker run -p 8000:8000 -it mpromonet/webrtc-streamer

You can expose V4L2 devices from your host using :

    docker run --device=/dev/video0 -p 8000:8000 -it mpromonet/webrtc-streamer

The container entry point is the webrtc-streamer application, then you can :

  • get the help using :

      docker run -p 8000:8000 -it mpromonet/webrtc-streamer -h
    
  • run the container registering a RTSP url using :

      docker run -p 8000:8000 -it mpromonet/webrtc-streamer -n raspicam -u rtsp://pi2.local:8554/unicast