node-datachannel 0.5.5 → 0.6.0

package/.github/workflows/build-linux.yml

@@ -76,8 +76,8 @@ jobs:
           sudo apt update
           sudo apt install -y g++-aarch64-linux-gnu gcc-aarch64-linux-gnu
           mkdir sysroot && cd sysroot
-          wget https://commondatastorage.googleapis.com/chrome-linux-sysroot/toolchain/953c2471bc7e71a788309f6c2d2003e8b703305d/debian_sid_arm64_sysroot.tar.xz
-          tar xf debian_sid_arm64_sysroot.tar.xz
+          wget https://commondatastorage.googleapis.com/chrome-linux-sysroot/toolchain/41a6c8dec4c4304d6509e30cbaf9218dffb4438e/debian_bullseye_arm64_sysroot.tar.xz
+          tar xf debian_bullseye_arm64_sysroot.tar.xz
           echo "ARM64_SYSROOT=$(pwd)" >> $GITHUB_ENV
           ls -l
       - name: Use Node.js ${{ matrix.node-version }}

package/CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0091 NEW)
 cmake_policy(SET CMP0042 NEW)
 
-project(node_datachannel VERSION 0.5.5)
+project(node_datachannel VERSION 0.6.0)
 
 # -Dnapi_build_version=8
 add_definitions(-DNAPI_VERSION=8)
@@ -20,14 +20,8 @@ if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Android")
     set(CMAKE_C_FLAGS "-Wno-error=unused-but-set-variable -Wno-error=strict-prototypes")
 endif()
 
-# Got linker error for arm64
-# /usr/lib/gcc-cross/aarch64-linux-gnu/9/../../../../aarch64-linux-gnu/bin/ld: ../sysroot/usr/lib/aarch64-linux-gnu/libcrypto.a(sha1-armv8.o): relocation R_AARCH64_PREL64 against symbol `OPENSSL_armcap_P' which may bind externally can not be used when making a shared object; recompile with -fPIC
-# ../sysroot/usr/lib/aarch64-linux-gnu/libcrypto.a(sha1-armv8.o): in function `sha1_block_armv8':
-# (.text+0x1240): dangerous relocation: unsupported relocation
-if(NOT ${NODE_ARCH} STREQUAL "arm64")
-    set(OPENSSL_USE_STATIC_LIBS TRUE)
-    find_package(OpenSSL REQUIRED)
-endif()
+set(OPENSSL_USE_STATIC_LIBS TRUE)
+find_package(OpenSSL REQUIRED)
 
 include(FetchContent)
 
@@ -39,7 +33,7 @@ FetchContent_Declare(
 )
 
 option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)
-option(NO_WEBSOCKET "Disable WebSocket support in libdatachannel" ON)
+option(NO_WEBSOCKET "Disable WebSocket support in libdatachannel" OFF)
 
 FetchContent_GetProperties(libdatachannel)
 
@@ -58,6 +52,8 @@ add_library(${PROJECT_NAME} SHARED
     src/data-channel-wrapper.cpp
     src/peer-connection-wrapper.cpp
     src/thread-safe-callback.cpp
+    src/web-socket-wrapper.cpp
+    src/web-socket-server-wrapper.cpp
     src/main.cpp
     ${CMAKE_JS_SRC}
 )

package/examples/electron-demo/package-lock.json

@@ -3832,9 +3832,9 @@
             }
         },
         "node_modules/follow-redirects": {
-            "version": "1.15.4",
-            "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
-            "integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==",
+            "version": "1.15.6",
+            "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz",
+            "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==",
             "dev": true,
             "funding": [
                 {
@@ -11877,9 +11877,9 @@
             }
         },
         "follow-redirects": {
-            "version": "1.15.4",
-            "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
-            "integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==",
+            "version": "1.15.6",
+            "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz",
+            "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==",
             "dev": true
         },
         "foreground-child": {

package/examples/media/README.md

@@ -20,3 +20,15 @@ Use the following gstreamer demo pipeline to display the traffic
 ```
 $ gst-launch-1.0 udpsrc address=127.0.0.1 port=5000 caps="application/x-rtp" ! queue ! rtph264depay ! video/x-h264,stream-format=byte-stream ! queue ! avdec_h264 ! queue ! autovideosink
 ```
+
+For saving the stream to a file, use the following pipeline (mp4):
+
+```
+gst-launch-1.0 -e udpsrc address=127.0.0.1 port=5000 caps="application/x-rtp" ! queue ! rtph264depay ! h264parse ! mp4mux ! filesink location=out.mp4
+```
+
+## Requirements
+
+-   GStreamer 1.0
+-   gstreamer1.0-libav (sudo apt-get install gstreamer1.0-libav)
+-   h264enc (sudo apt-get install h264enc)

package/lib/index.d.ts

@@ -189,11 +189,58 @@ export class Track {
     onMessage(cb: (msg: Buffer) => void): void;
 }
 
-export class DataChannel {
+export interface Channel {
     close(): void;
+    sendMessage(msg: string): boolean;
+    sendMessageBinary(buffer: Uint8Array): boolean;
+    isOpen(): boolean;
+    bufferedAmount(): number;
+    maxMessageSize(): number;
+    setBufferedAmountLowThreshold(newSize: number): void;
+    onOpen(cb: () => void): void;
+    onClosed(cb: () => void): void;
+    onError(cb: (err: string) => void): void;
+    onBufferedAmountLow(cb: () => void): void;
+    onMessage(cb: (msg: string | Buffer) => void): void;
+}
+export class DataChannel implements Channel {
     getLabel(): string;
     getId(): number;
     getProtocol(): string;
+
+    // Channel implementation
+    close(): void;
+    sendMessage(msg: string): boolean;
+    sendMessageBinary(buffer: Uint8Array): boolean;
+    isOpen(): boolean;
+    bufferedAmount(): number;
+    maxMessageSize(): number;
+    setBufferedAmountLowThreshold(newSize: number): void;
+    onOpen(cb: () => void): void;
+    onClosed(cb: () => void): void;
+    onError(cb: (err: string) => void): void;
+    onBufferedAmountLow(cb: () => void): void;
+    onMessage(cb: (msg: string | Buffer) => void): void;
+}
+
+export interface WebSocketConfiguration {
+    disableTlsVerification?: boolean; // default = false, if true, don't verify the TLS certificate
+    proxyServer?: ProxyServer; // only non-authenticated http supported for now
+    protocols?: string[];
+    connectionTimeout?: number; // miliseconds, zero to disable
+    pingInterval?: number; // millisecondrs, zero to disable
+    maxOutstandingPings?: number;
+    caCertificatePemFile?: string;
+    certificatePemFile?: string;
+    keyPemFile?: string;
+    keyPemPass?: string;
+    maxMessageSize: number;
+}
+export class WebSocket implements Channel {
+    constructor(config?: WebSocketConfiguration);
+
+    // Channel implementation
+    close(): void;
     sendMessage(msg: string): boolean;
     sendMessageBinary(buffer: Uint8Array): boolean;
     isOpen(): boolean;
@@ -207,6 +254,24 @@ export class DataChannel {
     onMessage(cb: (msg: string | Buffer) => void): void;
 }
 
+export interface WebSocketServerConfiguration {
+    port?: number; // default 8080
+    enableTls?: boolean; // default = false;
+    certificatePemFile?: string;
+    keyPemFile?: string;
+    keyPemPass?: string;
+    bindAddress?: string;
+    connectionTimeout?: number; // milliseconds
+    maxMessageSize?: number;
+}
+
+export class WebSocketServer {
+    constructor(config?: WebSocketServerConfiguration);
+    port(): number;
+    stop(): void;
+    onClient(cb: (ws: WebSocket) => void): void;
+}
+
 export class PeerConnection {
     constructor(peerName: string, config: RtcConfig);
     close(): void;

package/lib/index.js

@@ -16,6 +16,8 @@ const {
     Audio,
     DataChannel,
     PeerConnection,
+    WebSocket,
+    WebSocketServer,
 } = nodeDataChannel;
 
 export {
@@ -29,6 +31,8 @@ export {
     Audio,
     DataChannel,
     PeerConnection,
+    WebSocket,
+    WebSocketServer,
     // Extra exports
     DataChannelStream,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-datachannel",
-    "version": "0.5.5",
+    "version": "0.6.0",
     "description": "libdatachannel node bindings",
     "type": "module",
     "exports": {
@@ -44,7 +44,8 @@
         "p2p",
         "peer-to-peer",
         "datachannel",
-        "data channel"
+        "data channel",
+        "websocket"
     ],
     "contributors": [
         {

package/src/main.cpp

@@ -6,6 +6,8 @@
 #include "media-track-wrapper.h"
 #include "media-video-wrapper.h"
 #include "media-audio-wrapper.h"
+#include "web-socket-wrapper.h"
+#include "web-socket-server-wrapper.h"
 
 Napi::Object InitAll(Napi::Env env, Napi::Object exports)
 {
@@ -16,6 +18,8 @@ Napi::Object InitAll(Napi::Env env, Napi::Object exports)
     AudioWrapper::Init(env, exports);
     DataChannelWrapper::Init(env, exports);
     PeerConnectionWrapper::Init(env, exports);
+    WebSocketWrapper::Init(env, exports);
+    WebSocketServerWrapper::Init(env, exports);
     return exports;
 }
 

package/src/rtc-wrapper.cpp

@@ -2,6 +2,8 @@
 #include "peer-connection-wrapper.h"
 #include "data-channel-wrapper.h"
 #include "media-track-wrapper.h"
+#include "web-socket-wrapper.h"
+#include "web-socket-server-wrapper.h"
 
 #include "plog/Log.h"
 
@@ -116,6 +118,8 @@ void RtcWrapper::cleanup(const Napi::CallbackInfo &info)
         PeerConnectionWrapper::CloseAll();
         DataChannelWrapper::CloseAll();
         TrackWrapper::CloseAll();
+        WebSocketWrapper::CloseAll();
+        WebSocketServerWrapper::StopAll();
 
         const auto timeout = std::chrono::seconds(10);
         if (rtc::Cleanup().wait_for(std::chrono::seconds(timeout)) == std::future_status::timeout)

package/src/web-socket-server-wrapper.cpp

@@ -0,0 +1,265 @@
+#include "web-socket-server-wrapper.h"
+
+#include "plog/Log.h"
+
+void WebSocketServerWrapper::StopAll()
+{
+    PLOG_DEBUG << "StopAll() called";
+    auto copy(instances);
+    for (auto inst : copy)
+        inst->doStop();
+}
+
+Napi::FunctionReference WebSocketServerWrapper::constructor;
+std::unordered_set<WebSocketServerWrapper *> WebSocketServerWrapper::instances;
+
+Napi::Object WebSocketServerWrapper::Init(Napi::Env env, Napi::Object exports)
+{
+    Napi::HandleScope scope(env);
+
+    Napi::Function func = DefineClass(
+        env,
+        "WebSocketServer",
+        {
+            InstanceMethod("stop", &WebSocketServerWrapper::stop),
+            InstanceMethod("port", &WebSocketServerWrapper::port),
+            InstanceMethod("onClient", &WebSocketServerWrapper::onClient)
+        });
+
+    constructor = Napi::Persistent(func);
+    constructor.SuppressDestruct();
+
+    exports.Set("WebSocketServer", func);
+    return exports;
+}
+
+WebSocketServerWrapper::WebSocketServerWrapper(const Napi::CallbackInfo &info) : Napi::ObjectWrap<WebSocketServerWrapper>(info)
+{
+    PLOG_DEBUG << "Constructor called";
+    
+    Napi::Env env = info.Env();
+
+    // Create WebSocketServer without config
+    if (info.Length() == 0)
+    {
+        try
+        {
+            PLOG_DEBUG << "Creating a new WebSocketServer without config";
+            mWebSocketServerPtr = std::make_unique<rtc::WebSocketServer>();
+        }
+        catch (std::exception &ex)
+        {
+            Napi::Error::New(env, std::string("libdatachannel error while creating WebSocketServer without config: ") + ex.what()).ThrowAsJavaScriptException();
+            return;
+        }
+ 
+        PLOG_DEBUG << "WebSocketServer created without config";
+
+        instances.insert(this);
+        return;
+    }
+
+    // Create WebSocketServer with config
+    
+    Napi::Object config = info[0].As<Napi::Object>();    
+    rtc::WebSocketServerConfiguration webSocketServerConfig;
+
+    // Port
+    if (config.Has("port"))
+    {
+        if (!config.Get("port").IsNumber()) 
+        {
+            Napi::TypeError::New(info.Env(), "port must be a number").ThrowAsJavaScriptException();
+            return;
+        }
+        webSocketServerConfig.port = config.Get("port").ToNumber().Uint32Value();
+    }
+
+    // Enable TLS
+    if (config.Has("enableTls"))
+    {
+        if (!config.Get("enableTls").IsBoolean()) 
+        {
+            Napi::TypeError::New(info.Env(), "enableTls must be boolean").ThrowAsJavaScriptException();
+            return;
+        }
+        webSocketServerConfig.enableTls = config.Get("enableTls").ToBoolean();
+    }
+
+    // Certificate PEM File
+    if (config.Has("certificatePemFile"))
+    {
+        if (!config.Get("certificatePemFile").IsString()) 
+        {
+            Napi::TypeError::New(info.Env(), "certificatePemFile must be a string").ThrowAsJavaScriptException();
+            return;
+        }
+        webSocketServerConfig.certificatePemFile = config.Get("certificatePemFile").ToString();
+    }
+
+    // Key PEM File
+    if (config.Has("keyPemFile"))
+    {
+        if (!config.Get("keyPemFile").IsString()) 
+        {
+            Napi::TypeError::New(info.Env(), "keyPemFile must be a string").ThrowAsJavaScriptException();
+            return;
+        }
+        webSocketServerConfig.keyPemFile = config.Get("keyPemFile").ToString();
+    }
+
+    // Key PEM Pass
+    if (config.Has("keyPemPass"))
+    {
+        if (!config.Get("keyPemPass").IsString()) 
+        {
+            Napi::TypeError::New(info.Env(), "keyPemPass must be a string").ThrowAsJavaScriptException();
+            return;
+        }
+        webSocketServerConfig.keyPemPass = config.Get("keyPemPass").ToString();
+    }
+
+    // Bind Address
+    if (config.Has("bindAddress"))
+    {
+        if (!config.Get("bindAddress").IsString()) 
+        {
+            Napi::TypeError::New(info.Env(), "bindAddress must be a string").ThrowAsJavaScriptException();
+            return;
+        }
+        webSocketServerConfig.bindAddress = config.Get("bindAddress").ToString();
+    }
+
+    // Connection Timeout
+    if (config.Has("connectionTimeout"))
+    {
+        if (!config.Get("connectionTimeout").IsNumber()) 
+        {
+            Napi::TypeError::New(info.Env(), "connectionTimeout must be a number").ThrowAsJavaScriptException();
+            return;
+        }
+        webSocketServerConfig.connectionTimeout = std::chrono::milliseconds(config.Get("connectionTimeout").ToNumber().Int64Value());
+    }
+
+    // Max Message Size
+    if (config.Has("maxMessageSize"))
+    {
+        if (!config.Get("maxMessageSize").IsNumber()) 
+        {
+            Napi::TypeError::New(info.Env(), "maxMessageSize must be a number").ThrowAsJavaScriptException();
+            return;
+        }
+        webSocketServerConfig.maxMessageSize = config.Get("maxMessageSize").ToNumber().Int32Value();
+    }
+
+    // Create WebSocketServer with config
+    try
+    {
+        PLOG_DEBUG << "Creating a new WebSocketServer";
+        mWebSocketServerPtr = std::make_unique<rtc::WebSocketServer>(webSocketServerConfig);
+    }
+    catch (std::exception &ex)
+    {
+        Napi::Error::New(env, std::string("libdatachannel error while creating WebSocketServer: ") + ex.what()).ThrowAsJavaScriptException();
+        return;
+    }
+ 
+    PLOG_DEBUG << "WebSocketServer created";
+    instances.insert(this);
+}
+
+WebSocketServerWrapper::~WebSocketServerWrapper()
+{
+    PLOG_DEBUG << "Destructor called";
+    doStop();
+}
+
+void WebSocketServerWrapper::doStop()
+{
+    PLOG_DEBUG << "doStop() called";
+    if (mWebSocketServerPtr)
+    {
+        PLOG_DEBUG << "Closing...";
+        try
+        {
+            mWebSocketServerPtr->stop();
+            mWebSocketServerPtr.reset();
+        }
+        catch (std::exception &ex)
+        {
+            std::cerr << std::string("libWebRtc error while closing WebSocketServer: ") + ex.what() << std::endl;
+            return;
+        }
+    }
+
+    mOnClientCallback.reset();
+
+    instances.erase(this);
+}
+
+void WebSocketServerWrapper::stop(const Napi::CallbackInfo &info)
+{
+    PLOG_DEBUG << "stop() called";
+    doStop();
+}
+
+Napi::Value WebSocketServerWrapper::port(const Napi::CallbackInfo &info)
+{
+    PLOG_DEBUG << "port() called";
+    Napi::Env env = info.Env();
+
+    if (!mWebSocketServerPtr)
+    {
+        return Napi::Number::New(info.Env(), 0);
+    }
+
+    try
+    {
+        return Napi::Number::New(info.Env(), mWebSocketServerPtr->port());
+    }
+    catch (std::exception &ex)
+    {
+        Napi::Error::New(env, std::string("WebSocketServer error: ") + ex.what()).ThrowAsJavaScriptException();
+        return Napi::Number::New(info.Env(), 0);
+    }
+}
+
+void WebSocketServerWrapper::onClient(const Napi::CallbackInfo &info)
+{
+    PLOG_DEBUG << "onClient() called";
+    Napi::Env env = info.Env();
+    int length = info.Length();
+
+    if (!mWebSocketServerPtr)
+    {
+        Napi::Error::New(env, "onClient() called on destroyed WebSocketServer").ThrowAsJavaScriptException();
+        return;
+    }
+
+    if (length < 1 || !info[0].IsFunction())
+    {
+        Napi::TypeError::New(env, "Function expected as onClient calback").ThrowAsJavaScriptException();
+        return;
+    }
+
+    // Callback
+    mOnClientCallback = std::make_unique<ThreadSafeCallback>(info[0].As<Napi::Function>());
+
+    mWebSocketServerPtr->onClient([&](std::shared_ptr<rtc::WebSocket> ws)
+                                   {
+        PLOG_DEBUG << "onClient ws received from WebSocketServer";
+        if (mOnClientCallback)
+            mOnClientCallback->call([this, ws](Napi::Env env, std::vector<napi_value> &args) {
+                PLOG_DEBUG << "mOnClientCallback call(1)";
+                // Check the WebSocketServer is not stopped
+                if(instances.find(this) == instances.end())
+                    throw ThreadSafeCallback::CancelException();
+
+                // This will run in main thread and needs to construct the
+                // arguments for the call
+                std::shared_ptr<rtc::WebSocket> webSocket = ws;
+                auto instance = WebSocketWrapper::constructor.New({Napi::External<std::shared_ptr<rtc::WebSocket>>::New(env, nullptr), Napi::External<std::shared_ptr<rtc::WebSocket>>::New(env, &webSocket)});
+                args = {instance};
+                PLOG_DEBUG << "mOnClientCallback call(2)";
+            }); });
+}

package/src/web-socket-server-wrapper.h

@@ -0,0 +1,43 @@
+#ifndef WEB_SOCKET_SERVER_WRAPPER_H
+#define WEB_SOCKET_SERVER_WRAPPER_H
+
+#include <iostream>
+#include <string>
+#include <variant>
+#include <memory>
+#include <unordered_set>
+
+#include <napi.h>
+#include <rtc/rtc.hpp>
+
+#include "web-socket-wrapper.h"
+#include "thread-safe-callback.h"
+
+class WebSocketServerWrapper : public Napi::ObjectWrap<WebSocketServerWrapper>
+{
+public:
+  static Napi::FunctionReference constructor;
+  static Napi::Object Init(Napi::Env env, Napi::Object exports);
+  WebSocketServerWrapper(const Napi::CallbackInfo &info);
+  ~WebSocketServerWrapper();
+
+  // Functions
+
+  void stop(const Napi::CallbackInfo &info);
+  Napi::Value port(const Napi::CallbackInfo &info);
+
+  // Callbacks
+  void onClient(const Napi::CallbackInfo &info);
+
+  // Close all existing WebSocketServers
+  static void StopAll();
+ 
+private:
+  static std::unordered_set<WebSocketServerWrapper*> instances;
+  std::unique_ptr<rtc::WebSocketServer> mWebSocketServerPtr = nullptr;
+  std::unique_ptr<ThreadSafeCallback> mOnClientCallback = nullptr;
+
+  void doStop();
+};
+
+#endif // WEB_SOCKET_SERVER_WRAPPER_H