Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
patcarter883 committed Nov 23, 2023
1 parent 5f47124 commit f4798ed
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# ndi-rist
# NDI RIST Encoder
Let's you select an NDI source, encodes it, sticks it in an MPEG Transport Stream, and pushes it out to a RIST receiver.

This is the ndi-rist project.
Will encode to H264, H265, or AV1 using software, Nvidia, AMD, or Intel encoding.

AV1 really works over the MPEG Transport Stream if you use the [GStreamer](https://github.com/patcarter883/gstreamer.git) that I've included a pending merge request for AV1 MPEGTS support in. There is a built windows version available under releases to make it easy to get the client side up and running.

Can control the NDI RIST server to automatically start a RIST receiver and GStreamer pipeline that will transcode to H264 if needed, and send to an RTMP server.

# NDI RIST Server
Receives from the NDI RIST Encoder and transcodes to FLV over RTMP for sending to the usual suspects of live streaming destinations. This is currently a fixed GStreamer pipeline that uses Nvidia hardware decode and encode.

# Why
I needed to make the best use of limited bandwidth streaming over mobile data. I think RTMP should be shot and the 90's can come and get it's transport protocol back. I also wanted to ability to use bonded connections as a first class citizen of the the transport, no hacky borderline abuse of a VPN setup. So RTMP is out, and RIST is in.

# Building and installing

Expand All @@ -12,8 +23,4 @@ See the [CONTRIBUTING](CONTRIBUTING.md) document.

# Licensing

<!--
Please go to https://choosealicense.com/licenses/ and choose a license that
fits your needs. The recommended license for a project of this type is the
GNU AGPLv3.
-->
This project is licensed under GNU AGPLv3.

0 comments on commit f4798ed

Please sign in to comment.