MsM.SharpRTSPtoWebRTC 1.0.0

dotnet add package MsM.SharpRTSPtoWebRTC --version 1.0.0                
NuGet\Install-Package MsM.SharpRTSPtoWebRTC -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MsM.SharpRTSPtoWebRTC" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MsM.SharpRTSPtoWebRTC --version 1.0.0                
#r "nuget: MsM.SharpRTSPtoWebRTC, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MsM.SharpRTSPtoWebRTC as a Cake Addin
#addin nuget:?package=MsM.SharpRTSPtoWebRTC&version=1.0.0

// Install MsM.SharpRTSPtoWebRTC as a Cake Tool
#tool nuget:?package=MsM.SharpRTSPtoWebRTC&version=1.0.0                

SharpRTSP to WebRTC

This is a proof of concept bridge in between RTSP and WebRTC implemented in C#. It can take any H264/H265 RTSP stream and feed it through WebRTC to the web browser. It does not perform any video transcoding which makes it lightweight and portable. It does support audio transcoding from AAC to Opus, all implemented in netstandard without any native dependencies.

What can it do?

  • Re-stream H264/H265 RTSP from any source to the web browser
  • Stream aggregation - there is only a single session in between the gateway and the RTSP source, no matter how many users are watching the stream
  • Transcode AAC audio to Opus with a small latency in audio
  • Supports the experimental H265 WebRTC feature in Safari

Preview

Compatibility

Because no video transcoding is being performed, the web browsers must support decoding of the source video codecs in WebRTC.

H264

This should be supported by the majority of web browsers as it is among the codecs required by WebRTC. There might be an exception for Firefox on Android according to this: https://developer.mozilla.org/en-US/docs/Web/Media/Formats/WebRTC_codecs.

H265

Although most of the web browsers today support H265 video decoding, it does not mean H265 will also work in WebRTC. As of June 2023, H265 in WebRTC is only supported in Safari as an experimental feature. It has to be explicitly enabled by the user in Develop → Experimental Features → WebRTC H265 Codec. After enabling this option you should be able to play H265 video in the browser.

Samples

RTSPtoWebRTCGateway

There is a sample ASP.NET Core app that demonstrates the functionality on multiple live streams. To change the default configuration, just modify the appsettings.json:

"Cameras": [
    {
      "Name": "name1",
      "Url": "rtsp://url1",
      "UserName": "MyUserName",
      "Password": "MyPassword"
    },
    {
      "Name": "name2",
      "Url": "rtsp://url2",
      "UserName": null,
      "Password": null
    }
  ]

Minimal example

In Startup.cs, add the following piece of code to register the RTSPtoWebRTCProxyService:

builder.Services.AddSingleton<RTSPtoWebRTCProxyService>();

Then (optionally) add the configuration of streams from appsettings.json:

builder.Services.Configure<List<CameraConfiguration>>(builder.Configuration.GetSection("Cameras"));

Implement a minimal WebRTC signalling controller, for instance:

[ApiController]
[Route("api/[controller]")]
public class WebRTCController : ControllerBase
{
    private readonly IList<CameraConfiguration> _cameras;
    private readonly RTSPtoWebRTCProxyService _webRTCServer;

    public WebRTCController(IOptions<List<CameraConfiguration>> cameras, RTSPtoWebRTCProxyService webRTCServer)
    {
        _cameras = cameras.Value;
        _webRTCServer = webRTCServer;
    }

    [HttpGet]
    [Route("getcameras")]
    public IActionResult GetCameras()
    {
        return Ok(_cameras.Select(x => x.Name).ToList());
    }

    [HttpGet]
    [Route("getoffer")]
    public async Task<IActionResult> GetOffer(string id, string name)
    {
        return Ok(await _webRTCServer.GetOfferAsync(id, camera.Url, camera.UserName, camera.Password));
    }

    [HttpPost]
    [Route("setanswer")]
    public IActionResult SetAnswer(string id, [FromBody] RTCSessionDescriptionInit answer)
    {
        _webRTCServer.SetAnswer(id, answer);
        return Ok();
    }

    [HttpPost]
    [Route("addicecandidate")]
    public IActionResult AddIceCandidate(string id, [FromBody] RTCIceCandidateInit iceCandidate)
    {
        _webRTCServer.AddIceCandidate(id, iceCandidate);
        return Ok();
    }
}

Finally, for the WebRTC viewer you can refer to src/RTSPtoWebRTCGateway/ClientApp/src/components/CameraViewer.js.

Credits

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 336 5/3/2024