armlesshobo / lightspeed-ingest

A FTL handshake server written in Rust. This server listens on port 8084 and performs the FTL handshake with incoming connections

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

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Streaming From OBS
   • Stream Key
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgements

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

• Lightspeed WebRTC
• Lightspeed React

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 print out full command line usage information.

cargo run -- -h

To run it with default settings type the following command.

cargo run --release

To specify which address to bind to.

cargo run --release -- -a 12.34.56.78

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

We are no longer using a default streamkey! If you are still using one please pull from master on the Lightspeed-ingest repository. Now, by default on first time startup a new streamkey will be generated and output to the terminal for you. In order to regenerate this key simply delete the file it generates called hash. In a Docker context we will work to make the key reset process as easy as possible. Simply copy the key output in the terminal to OBS and you are all set! This key WILL NOT change unless the hash file is deleted.

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. 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

Acknowledgements

• Sean Dubois
• Hayden McAfee