marcocom / Project-Lightspeed

A self contained OBS -> FTL -> WebRTC live streaming server. Comprised of 3 parts once configured anyone can achieve sub-second OBS to the browser livestreaming

Project Lightspeed

A self contained OBS -> FTL -> WebRTC live streaming server. Comprised of 3 parts once configured anyone can achieve sub-second OBS to the browser livestreaming

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Project Lightspeed is a fully self contained live streaming server. With Lightspeed you will be able to deploy your own sub-second latency live streaming platform. The Lightspeed repository contains the instructions for installing and deploying the entire application.

Built With

• Rust
• Golang
• React

Components

• Lightspeed Ingest
• Lightspeed WebRTC
• Lightspeed React

Getting Started

In order to get Lightspeed running you will need to install all 3 repositories. There are installation instructions in each repository however I will include them here for the sake of simplicity.

Prerequisites

In order to run Lightspeed, Golang, Rust, and npm are required. Additionally the Rust repo requires a C compiler. If you get a linker cc not found error then you need to install a C compiler.

Installation

Lightspeed Ingest

git clone https://github.com/GRVYDEV/Lightspeed-ingest.git
cd Lightspeed-ingest
cargo build

Lightspeed WebRTC

Using go get

export GO111MODULE=on
go get github.com/GRVYDEV/lightspeed-webrtc

Using git

git clone https://github.com/GRVYDEV/Lightspeed-webrtc.git
cd Lightspeed-webrtc
export GO111MODULE=on
go build

Lightspeed React

git clone https://github.com/GRVYDEV/Lightspeed-react.git
cd Lightspeed-react
npm install

Usage

Lightspeed Ingest

cd Lightspeed-ingest
cargo run --release

Lightspeed WebRTC

Using go get

lightspeed-webrtc --addr=XXX.XXX.XXX.XXX

Using git

cd Lightspeed-webrtc
go build
./lightspeed-webrtc --addr=XXX.XXX.XXX.XXX

Arguments

Argument	Supported Values	Notes
--addr	A valid IP address	This is the local Ip address of your machine. It defaults to localhost but should be set to your local IP. For example 10.17.0.5 This is where the server will listen for UDP packets and where it will host the websocket endpoint for SDP negotiation

Lightspeed React

First you need to configure the websocket url in src/wsUrl.js. If you are using an IP then it will be the public IP of your machine if you have DNS then it will be your hostname.

You can host the static site locally using serve which can be found here

cd Lightspeed-react
npm run build
serve -s build -l 80

The above will serve the build folder on port 80.

View Lightspeed in your web browser by visiting http://hostname or http://your.ip.address.here

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:

Windows: %AppData%\obs-studio\plugin_config\rtmp-services\services.json

Mac: /Users/YOURUSERNAME/Library/Application\ Support/obs-studio/plugin_config/rtmp-services/services.json

Paste the below 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

I will be fleshing out the roadmap in the coming days. As of right now I want to get Lightspeed to a point where it is as close to other live streaming services as possible. If there are any features that you want to see then feel free to suggest them!

See the open issues for a list of proposed features (and known issues).

Bugs

I am very far from perfect and there are bound to be bugs and things I've overlooked in the installation process. Please add issues and feel free to reach out if anything is unclear. If Lightspeed gets enough attention I can make a Discord server where I can more easily interact with people.

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/Project-Lightspeed

Acknowledgements

• Sean Dubois
• Hayden McAfee