Skip to content

Commit

Permalink
README: update note on WHIP
Browse files Browse the repository at this point in the history
  • Loading branch information
erdnaxe committed Aug 20, 2023
1 parent 9c1b022 commit 73f0b11
Showing 1 changed file with 5 additions and 12 deletions.
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
Gateway to send streams such as RTMP or SRT to
[Galène videoconference server](https://galene.org/).
It is based on Gstreamer and implements the Galène protocol.
**This project is not production ready, and you might experience frame drops and crashes.**

> :warning: **This project is not production ready, and you might experience
> jittering and crashes.** [See future plans.](#future-plans)
> **Note**
> To stream from OBS Studio to Galène, you should rather prefer [WebRTC-HTTP ingestion protocol (WHIP)](https://datatracker.ietf.org/doc/draft-ietf-wish-whip/).
> OBS Studio introduced WHIP output in [version 30.0](https://github.com/obsproject/obs-studio/releases/tag/30.0.0-beta1).
> Galène supports WHIP on its master branch since July 2023, it will be part of Galène 0.8.
![Streaming from OBS to Galène, video background from KaMy Video Stock](./docs/demo.png)

Expand Down Expand Up @@ -129,16 +132,6 @@ For example, `export GST_DEBUG_DUMP_DOT_DIR=.`.
Then you can use GraphViz to generate an image from the dot file:
`dot -Tpng pipeline.dot > pipeline.png`.

## Future plans

The WISH IETF workgroup is working on the [WebRTC-HTTP ingestion protocol (WHIP)](https://datatracker.ietf.org/doc/draft-ietf-wish-whip/).
Galène has [an experimental branch `whip`](https://github.com/jech/galene/tree/whip) implementing a WHIP server.
OBS Studio is currently working (as of December 2022) on [adding WHIP output support](https://github.com/obsproject/obs-studio/pull/7926).

Using WHIP directly removes the need for a transcoding gateway, and make
streamers life simpler. Galène-stream should be considered as a temporary
solution until WHIP gets standardized and implemented.

## License

This gateway is developed by former members of [Crans](https://www.crans.org/)
Expand Down

0 comments on commit 73f0b11

Please sign in to comment.