Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k-yle/rtsp-relay
📽 View an RTSP stream in your web browser using an express.js server
https://github.com/k-yle/rtsp-relay
express ffmpeg jsmpeg rtsp rtsp-stream websocket
Last synced: 27 days ago
JSON representation
📽 View an RTSP stream in your web browser using an express.js server
- Host: GitHub
- URL: https://github.com/k-yle/rtsp-relay
- Owner: k-yle
- License: mit
- Created: 2020-01-26T04:31:26.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T12:11:13.000Z (7 months ago)
- Last Synced: 2024-04-23T19:06:18.146Z (7 months ago)
- Topics: express, ffmpeg, jsmpeg, rtsp, rtsp-stream, websocket
- Language: JavaScript
- Homepage: https://npm.im/rtsp-relay
- Size: 24.7 MB
- Stars: 291
- Watchers: 7
- Forks: 56
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 📽 RTSP Relay
[](https://github.com/k-yle/rtsp-relay/actions)
[](https://coveralls.io/github/k-yle/rtsp-relay?branch=main)
[](https://badge.fury.io/js/rtsp-relay)
This module allows you to view an RTSP stream in your web browser using an existing express.js server.
Internally, this module uses websockets to create an endpoint in your web server (e.g. `/api/stream`) which relays the RTSP stream using ffmpeg. On the client side, JS-MPEG is used to decode the websocket stream.
The module handles all the complications that unreliable connections introduce:
- if the connection between `server` <=> `RTSP stream` is disconnected, it will automatically be reconnected when available
- if the connection between `client` <=> `server` is disconnected, the client will keep trying to reconnect
- if multiple clients connect, only one instance of the RTSP stream is consumed to improve performance (one-to-many)
## Install
```sh
npm install -S rtsp-relay express
```
You don't need to install ffmpeg!
## Example
```js
const express = require('express');
const app = express();
const { proxy, scriptUrl } = require('rtsp-relay')(app);
const handler = proxy({
url: `rtsp://admin:[email protected]:554/feed`,
// if your RTSP stream need credentials, include them in the URL as above
verbose: false,
});
// the endpoint our RTSP uses
app.ws('/api/stream', handler);
// this is an example html page to view the stream
app.get('/', (req, res) =>
res.send(`
loadPlayer({
url: 'ws://' + location.host + '/api/stream',
canvas: document.getElementById('canvas')
});
`),
);
app.listen(2000);
```
Open [http://localhost:2000](http://localhost:2000) in your web browser.
## Example using ES6 Imports (e.g. React, Vue)
If you have babel/webpack set up, you can import the `loadPlayer` instead of using a `` tag.
Example code is available [for react](examples/react.md) and [for angular](examples/angular.md).
```js
// client side code
import { loadPlayer } from 'rtsp-relay/browser';
loadPlayer({
url: `ws://${location.host}/stream`,
canvas: document.getElementById('canvas'),
// optional
onDisconnect: () => console.log('Connection lost!'),
});
```
### Usage with many cameras
If you have hundreds of cameras and don't want to define a seperate route for each one, you can use a dynamic URL:
```js
app.ws('/api/stream/:cameraIP', (ws, req) =>
proxy({
url: `rtsp://${req.params.cameraIP}:554/feed`,
})(ws),
);
```
### Usage with many clients
You may see a `MaxListenersExceededWarning` if the relay is re-transmitting 10+ streams at once, or if 10+ clients are watching.
This is expected, and you can silence the warning by adding `process.setMaxListeners(0);` to your code.
### Improving the video quality
Depending on your network configuration, you can try the following options to improve the stream quality:
```js
// try this:
app.ws('/api/stream', proxy({ additionalFlags: ['-q', '1'] }));
// or this:
app.ws('/api/stream', proxy({ transport: 'tcp' }));
```
Note that both these methods will use more bandwidth.
### SSL
If you want to use HTTPS, you will need to change the stream URL to `wss://`, like the following example:
```js
const rtspRelay = require('rtsp-relay');
const express = require('express');
const https = require('https');
const fs = require('fs');
const key = fs.readFileSync('./privatekey.pem', 'utf8');
const cert = fs.readFileSync('./fullchain.pem', 'utf8');
const ca = fs.readFileSync('./chain.pem', 'utf8'); // required for iOS 15+
const app = express();
const server = https.createServer({ key, cert, ca }, app);
const { proxy, scriptUrl } = rtspRelay(app, server);
app.ws('/api/stream', proxy({ url: 'rtsp://1.2.3.4:554' }));
app.get('/', (req, res) =>
res.send(`
<canvas id='canvas'></canvas>
<script src='${scriptUrl}'>
loadPlayer({
url: 'wss://' + location.host + '/api/stream',
canvas: document.getElementById('canvas')
});
`),
);
server.listen(443);
```
## Contributing
We have end-to-end tests to ensure that the module actually works. These tests spin up a RTSP server using [aler9/rtsp-simple-server](https://github.com/aler9/rtsp-simple-server) and create several different streams for testing. These tests are far from complete.
To make developing easier, run `node test/setupTests`. This creates two RTSP streams that can be used instead of real IP cameras (`rtsp://localhost:8554/sync-test-1` and `rtsp://localhost:8554/sync-test-2`).