Skip to content

Latest commit

 

History

History
158 lines (119 loc) · 6.61 KB

README.md

File metadata and controls

158 lines (119 loc) · 6.61 KB
Raw

Stream Play Server (SPS)

SPS Logo

Stream Play Server (SPS) is a WebRTC-powered media server for real-time video streaming and remote control of Windows applications enabling Remote Gaming in a simple web browser environment.

Demo

Small video showing the usage of SPS using a phone with one controller connected to play a game (Biped) remotely

Demo with Biped game

Features

  • Low latency video streaming of a window application with WebRTC
  • Input catching from a browser instance to the server for remote interaction (using Gamepad API + ViGEm for controllers or Windows API SendInput for mouse and keyboard)

Description

Release 0.0.2

Release notes :

  • Upgraded the client UI (simplified overall process)

  • Removed pion WebRTC and FFMPEG dependencies by using the getDisplayMedia() method of the MediaDevices interface implemented in (most) browsers.

    This was done to improve the performance of the video/audio transmission as I was not able to make it work properly for my use-case using the previous implementation. I would like to avoid depending on the browser methods to focus on a Golang media-server for recording and transmission. I will try to follow the development of the Pion MediaDevice implementation for a future release.

  • getDisplayMedia() is browser dependent (https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia) and it was mainly tested on Google Chrome (which enable recording for browser tab video+audio, application video or system video+audio)

  • For now, hosting is only available on localhost:web_port due to the required secure contexts of getDisplayMedia().

  • Added Gamepad index modification to be able to separate the multiple clients.

SPS Diagram 0.0.2

Release 0.0.1

SPS Diagram 0.0.1

  • Media-Server

Handles real-time communication and peer inputs to the application (Media Processing and Input Management)

  • Signaling Server

Intermediary for WebRTC clients to exchange session information and coordinate the establishment of direct peer-to-peer connections

  • Client (Webserver)

User-facing part of the WebRTC application that runs in the web browser (User Interface), 3 tabs available for the connection setup, media stream and controllers setup.

Connection Game Controllers
Connection Game Controllers

Custom Installation

Prerequisites :

Installation steps :

  1. Clone the repository.
git clone https://github.com/delcourtfl/stream-play-server.git
  1. Navigate to the project directory.
cd stream-play-server
  1. Install the dependencies before running (optionnal).
go get ./...
  1. Modify the config.json file to change the ip address and ports used.
{
    "ip_address": "192.168.68.101",
    "web_port": "3000",
    "sign_port": "3001",
    "input_port": "3002"
}
  1. (optional) Modify the media capture settings to suit your needs (webrtc.js).
const displayMediaOptions = { 
    video: getVideo ? {
        width: { ideal: 1280 },
        height: { ideal: 720 },
        frameRate: { max: 30 },
        latency: 0
    } : false,
    audio: getAudio ? {
        noiseSuppression: false,
        autoGainControl: false,
        echoCancellation: false,
        sampleRate: 48000,
        latency: 0
    } : false
};
  1. Launch the SPS application.
go run .

Usage

Once the application is running some commands are available :

  • exit : close everything
  • stop : stop the 3 subprocesses (signaling, client, server)
  • sign : restart signaling server
  • client : restart client webserver
  • server : restart media server

When the signaling server is up, you can open the user interface as host (on a local instance only, http://localhost:web_port) or as client (on the ip address you provided in the config.json file, http://ip_address:web_port).

There you can find 3 tabs for managing the game sharing process:

  • Connection Tab
    • Host button to capture the media and share it using WebRTC
    • Join button to create a P2P connection and read the recorded media
  • Game Tab
    • Game streamed by the WebRTC connection
  • Controllers Tab
    • Settings of the controllers which will send inputs back to the host

Enjoy !

Technologies Used

  • HTML, CSS, and JavaScript (for the browser client/host instance).
  • Golang for the input management, webserver and signaling server.
  • WebRTC for low latency media transmission.
  • ViGEm for game controller emulation.
  • GamepadAPI for input reading.
  • getDisplayMedia for game recording.

Areas of Improvement

This project is a work in progress and as such there are areas that are still being refined and improved. This repository is open to any contributions, suggestions and recommendations for improvements and fixes.

Current issues :

  • Video + inputs introduce latency that is still too high for many games (WiFi tests on my network showed a delay of about 0.5 to 1 second between action and visual feedback on 720p 30FPS)
  • Audio recording for specific application is not supported in getDisplayMedia() (or not at all for some browsers)
  • Controllers are hard to map manually in the client browser
  • Gamepad API will need secure context in the future
  • Issue where a process won't stop after closing the main golang script
  • Automated benchmarking and realtime evaluation could be great

License

MIT License

Acknowledgement