Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flavioribeiro/donut
donut is a zero setup required SRT+MPEG-TS -> WebRTC Bridge powered by Pion.
https://github.com/flavioribeiro/donut
608 cea608 h264 live-streaming srt webrtc
Last synced: 3 days ago
JSON representation
donut is a zero setup required SRT+MPEG-TS -> WebRTC Bridge powered by Pion.
- Host: GitHub
- URL: https://github.com/flavioribeiro/donut
- Owner: flavioribeiro
- License: apache-2.0
- Created: 2022-10-23T23:37:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-07T09:58:39.000Z (8 months ago)
- Last Synced: 2025-01-19T22:12:20.799Z (10 days ago)
- Topics: 608, cea608, h264, live-streaming, srt, webrtc
- Language: Go
- Homepage:
- Size: 4.65 MB
- Stars: 357
- Watchers: 10
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**donut** is a zero setup required [SRT](https://en.wikipedia.org/wiki/Secure_Reliable_Transport) (_MPEG-TS_) and [RTMP](https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol) to [WebRTC](https://webrtc.org/) bridge powered by [Pion](http://pion.ly/).
# HOW IT WORKS
```mermaid
sequenceDiagram
actor User
box Cornsilk
participant browser
end
User->>+browser: input protocol, host, port, id, and opts
User->>+browser: click on [Connect]
Note over donut,browser: WebRTC connection setup
browser->>+browser: create WebRTC browserOffer
browser->>+donut: POST /doSignaling {browserOffer}
donut->>+browser: reply WebRTC {serverOffer}
Note over donut,browser: WebRTC connection setup
loop Async streaming
donut--)streaming server: fetchMedia
donut--)donut: ffmpeg::libav demux/transcode
donut--)browser: sendWebRTCMedia
browser--)browser: render audio/video frames
User--)browser: watch media
end
```
ref: [how donut works](/HOW_IT_WORKS.md)
# QUICK START
Make sure you have the `ffmpeg 5.x.x`. You must configure the CGO library path pointing it to **ffmpeg 5**.
```bash
export CGO_LDFLAGS="-L/opt/homebrew/Cellar/ffmpeg@5/5.1.4_6/lib/"
export CGO_CFLAGS="-I/opt/homebrew/Cellar/ffmpeg@5/5.1.4_6/include/"
export PKG_CONFIG_PATH="/opt/homebrew/Cellar/ffmpeg@5/5.1.4_6/lib/pkgconfig"
```
Now you can install and run it:
```bash
go install github.com/flavioribeiro/donut@latest
donut
```
Here are specific instructions [to run on MacOS](/MAC_DEVELOPMENT.md).
# RUN USING DOCKER-COMPOSE
Alternatively, you can use `docker-compose` to simulate an [SRT live transmission and run the donut effortless](/DOCKER_DEVELOPMENT.md).
```bash
make run
```
## OPEN THE WEB UI
Open [http://localhost:8080/demo](http://localhost:8080/demo). You will see two text fields. Fill them with the your streaming info and hit connect.
### FAQ
Please check the [FAQ](/FAQ.md) if you're facing any trouble.