Project Lightspeed Ingest
A FTL handshake server written in Rust. This server listens on port 8084 and performs the FTL handshake with incoming connections
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
This is one of three components required for Project Lightspeed. Project Lightspeed is a fully self contained live streaming server. With this you will be able to deploy your own sub-second latency live streaming platform. This particular repository performs the FTL handshake with clients. It verifies the stream key and negotiates a port with the client connection that we will accept RTP packets on. In order for this to work the Project Lightspeed WebRTC is required in order to accept and broadcast the RTP packets. In order to view the live stream the Project Lightspeed React is required.
Built With
- Rust
Dependencies
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
In order to run this Rust is required. Installation instructions can be found here. A C compiler is required as well. If you get a linker cc not found error
try installing a C compiler
Installation
git clone https://github.com/GRVYDEV/Lightspeed-ingest.git
cd Lightspeed-ingest
cargo build
Usage
To run type the following command.
cd Lightspeed-ingest
cargo run --release
Streaming From OBS
By default since we are using the FTL protocol you cannot just use a custom server. You will need to edit your services.json
file. It can be found at %AppData%\obs-studio\plugin_config\rtmp-services\services.json
on Windows and /Users/YOURUSERNAME/Library/Application\ Support/obs-studio/plugin_config/rtmp-services/services.json
Paste this into the services array and change the url to either the IP or the hostname of your Project Lightspeed server
{
"name": "Project Lightspeed",
"common": false,
"servers": [
{
"name": "SERVER NAME HERE",
"url": "your.lightspeed.hostname"
}
],
"recommended": {
"keyint": 2,
"output": "ftl_output",
"max audio bitrate": 160,
"max video bitrate": 8000,
"profile": "main",
"bframes": 0
}
},
After restarting OBS you should be able to see your service in the OBS settings pane (Special Thanks to Glimesh for these instructions)
Stream Key
By default the stream key is 123456789-aBcDeFgHiJkLmNoPqRsTuVwXyZ123456
This can be changed by editing line 248 in src/connection.rs
in the Lighspeed Ingest project. In the future I will develop a system that makes it easier to reset and manage your stream key.
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Garrett Graves - @grvydev
Project Link: https://github.com/GRVYDEV/Lightspeed-ingest