Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ionorg/ion-sfu
Pure Go WebRTC SFU
https://github.com/ionorg/ion-sfu
golang grpc json-rpc sfu webrtc
Last synced: 3 months ago
JSON representation
Pure Go WebRTC SFU
- Host: GitHub
- URL: https://github.com/ionorg/ion-sfu
- Owner: ionorg
- License: mit
- Created: 2020-06-25T14:57:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T08:27:20.000Z (over 1 year ago)
- Last Synced: 2024-04-17T22:02:03.501Z (9 months ago)
- Topics: golang, grpc, json-rpc, sfu, webrtc
- Language: Go
- Homepage:
- Size: 4.58 MB
- Stars: 936
- Watchers: 39
- Forks: 232
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome - ionorg/ion-sfu - rpc,sfu,webrtc pushed_at:2023-07 star:1.0k fork:0.2k Pure Go WebRTC SFU (Go)
README
Ion SFU
Go implementation of a WebRTC Selective Forwarding Unit
A [selective forwarding unit](https://webrtcglossary.com/sfu/) is a video routing service which allows webrtc sessions to scale more efficiently. This package provides a simple, flexible, high performance Go implementation of a WebRTC SFU. It can be called directly or through a [gRPC](cmd/signal/grpc) or [json-rpc](cmd/signal/json-rpc) interface.
## Features
* Audio/Video/Datachannel forwarding
* Congestion Control (TWCC, REMB, RR/SR)
* Unified plan semantics
* Pub/Sub Peer Connection (`O(n)` port usage)
* Audio level indication (RFC6464). "X is speaking"
## End to end solutions
ion-sfu is the engine behind several projects. It's designed to be focused, with minimal signaling or external dependencies. It's simple to embed ion-sfu within your service: we include a few examples inside `cmd/signal`.
For "batteries-included", end-to-end solutions that are easier to deploy, check out:
* [LiveKit](https://github.com/livekit/livekit-server): Open source platform for real-time communication (SDKs for all major platforms)
* [Ion](https://github.com/pion/ion): Real-Distributed RTC System by pure Go and Flutter
## Quickstart
Run the Echo Test example
```
docker-compose -f examples/echotest-jsonrpc/docker-compose.yaml up
```
Open the client
```
http://localhost:8000/
```
### SFU with json-rpc signaling
The json-rpc signaling service can be used to easily get up and running with the sfu. It can be used with the [corresponding javascript signaling module](https://github.com/pion/ion-sdk-js/blob/master/src/signal/json-rpc-impl.ts).
##### Using golang environment
```
go build ./cmd/signal/json-rpc/main.go && ./main -c config.toml
```
##### Using docker
```
docker run -p 7000:7000 -p 5000-5200:5000-5200/udp pionwebrtc/ion-sfu:latest-jsonrpc
```
### SFU with gRPC signaling
For service-to-service communication, you can use the grpc interface. A common pattern is to call the grpc endpoints from a custom signaling service.
##### Using golang environment
```
go build ./cmd/signal/grpc/main.go && ./main -c config.toml
```
##### Using docker
```
docker run -p 50051:50051 -p 5000-5200:5000-5200/udp pionwebrtc/ion-sfu:latest-grpc
```
## Documentation
Answers to some [Frequenty Asked Questions](FAQ.md).
## Examples
To see some other ways of interacting with the ion-sfu instance, check out our [examples](examples).
## Media Processing
`ion-sfu` supports real-time processing on media streamed through the sfu using [`ion-avp`](https://github.com/pion/ion-avp).
For an example of recording a MediaStream to webm, checkout the [save-to-webm](https://github.com/pion/ion-avp/tree/master/examples/save-to-webm) example.
### License
MIT License - see [LICENSE](LICENSE) for full text
## Development
Generate the protocol buffers and grpc code:
1. Best choice (uses docker): `make protos`.
2. Manually:
- Install protocol buffers and the protcol buffers compiler. On Fedora `dnf install protobuf protobuf-compiler`.
- `go get google.golang.org/grpc/cmd/protoc-gen-go-grpc`
- `go get google.golang.org/protobuf/cmd/protoc-gen-go`
- `protoc --go_out=. --go-grpc_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative cmd/signal/grpc/proto/sfu.proto`