Open Source SRT WHIP Gateway
A Docker container to receive MPEG-TS over SRT and stream to a WHIP compatible endpoint for WebRTC based broadcast distribution.
The receiving MPEG-TS can be restreamed to an SRT ingest endpoint for HTTP-based distribution in addition.
A transmitter is an SRT receiver and WHIP encoder based on the whip-mpegts command line tool. Each transmitter has an configured SRT port in listener mode and configured for a specific WHIP URL. The transmitters can be managed via the REST API or the Web GUI.
| IN (SRT/MPEG-TS) | UDP (MPEG-TS) | SRT (MPEG-TS) | WHIP (SRTP) |
|---|---|---|---|
| AVC/AAC | AVC/AAC | AVC/AAC | VP8/OPUS |
| HEVC/AAC | HEVC/AAC | HEVC/AAC | VP8/OPUS |
To run the latest version of SRT WHIP Gateway.
docker run -d -p 3000:3000 -p 9000-9999:9000-9999/udp \
eyevinntechnology/srt-whip
Run a specific version of SRT WHIP Gateway.
docker run -d -p 3000:3000 -p 9000-9999:9000-9999/udp \
eyevinntechnology/srt-whip:<version number>
Once the container is up and running you can access the API at http://localhost:3000/api/docs and the Web GUI at http://localhost:3000/ui.
To run the SRT WHIP Gateway with WHIP/WHEP local development environment you need to attach the SRT WHIP Gateway container to the same network as the WHIP/WHEP containers are running on.
Start the WHIP/WHEP containers:
curl -SL https://github.com/Eyevinn/whip-whep/releases/download/v0.2.0/docker-compose.yml | docker-compose -f - up
Find the network that these containers are running on
docker network ls
NETWORK ID NAME DRIVER SCOPE
d8e65abb5e48 host host local
18bd740cfe25 none null local
02eedf7089a9 whip-whep_default bridge local
In this case they are running on the docker network called whip-whep_default
Start the SRT WHIP Gateway on this network:
docker run --network whip-whep_default -p 3000:3000 -p 9000-9999:9000-9999/udp eyevinntechnology/srt-whip
And then use the following WHIP URL in the transmitter: http://ingest:8200/api/v2/whip/sfu-broadcaster?channelId=test
To add a transmitter enter the SRT Port to listen to. If you have followed the above container running instructions you can choose a port number between 9000 and 9999. Then enter the WHIP Url to the WHIP endpoint you want to stream to. If you wish to also restream to an additional SRT input then add the SRT-url (srt://<ip>:<port>) in the SRT Restream URL input field. Then press Add button.
A green border indicates that the transmitter is idle and can be started. Click anywhere in the white area within the green border to start a transmitter. Once the transmitter is running the box will turn red to indicate that it is a running transmitter.
When the transmitter is running you can start your video software to stream to the designated SRT port that you have configured for this transmitter. The below ffmpeg command line illustrates an example.
ffmpeg -re -i video.mp4 -c:v libx264 -c:a aac -f mpegts srt://localhost:9191/
To stop a running transmitter (indicated by red color) you click on the red area for the transmitter to stop.
To remove a transmitter click on the X in the top right corner of the transmitter.
If you're interested in contributing to the project:
- We welcome all people who want to contribute in a healthy and constructive manner within our community. To help us create a safe and positive community experience for all, we require all participants to adhere to the Code of Conduct.
- If you are looking to make a code change first learn how to setup your local environment in our Developer guide. Then create a Pull Request with suggested changes.
- Report, triage bugs or suggest enhancements.
- Help others by answering questions.
Copyright 2022 Eyevinn Technology AB
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Join our community on Slack where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:
- Further development of this component
- Customization and integration of this component into your platform
- Support and maintenance agreement
Contact sales@eyevinn.se if you are interested.
Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in blogs and by open sourcing the code we have written.
Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!