@norskvideo/norsk-sdk 1.0.368 → 1.0.370

package/lib/package.json

@@ -1,11 +1,11 @@
 {
     "license": "MIT",
     "name": "@norskvideo/norsk-sdk",
-    "version": "1.0.368",
+    "version": "1.0.370",
     "dependencies": {
         "@bufbuild/protobuf": "^0.3.0",
         "@grpc/grpc-js": "^1.2.2",
-        "@norskvideo/norsk-api": "1.0.368",
+        "@norskvideo/norsk-api": "1.0.370",
         "lodash": "^4.17.21",
         "typescript-nullable": "^0.6.0"
     },

package/lib/src/media_nodes/processor.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { PlainMessage } from "@bufbuild/protobuf";
-import { StreamStatisticsSampling, Subscription } from "@norskvideo/norsk-api/lib/media_pb";
+import { StreamStatisticsSampling, Subscription, SipEvent_Status } from "@norskvideo/norsk-api/lib/media_pb";
 import { FrameRate, VancPayloadFormat, VancType2AncillaryId } from "../types";
 import { AutoSinkMediaNode, MediaClient, MediaNodeState, SinkNodeSettings, SourceMediaNode, SourceMediaNodeEvents, SourceNodeSettings, StreamStatisticsMixin } from "./common";
 import { AacProfile, AudioMeasureLevels, AwsCredentials, ChannelLayout, ComposeMissingStreamBehaviour, ComposeHardwareAcceleration, Db, IceServerSettings, LoganH264, LoganHevc, MultiStreamStatistics, NvidiaH264, NvidiaHevc, PixelFormat, QuadraH264, QuadraHevc, AmdU30H264, AmdU30Hevc, AmdMA35DH264, AmdMA35DHevc, Resolution, SampleAspectRatio, SampleRate, SentenceBuildMode, SimpleEasing, StabilizationMode, StreamKey, StreamMetadata, X264Codec, X265Codec, SubscriptionError, DeinterlaceSettings, Scte35SpliceInfoSection, Interval, SampleFormat } from "./types";
@@ -1160,6 +1160,52 @@ export declare class WebRTCBrowserNode extends AutoProcessorMediaNode<"audio" |
     /** @public The URL of the local player */
     playerUrl: string;
 }
+/**
+ * @public
+ * Settings for a SIP session
+ */
+export interface SipSettings extends ProcessorNodeSettings<SipNode>, StreamStatisticsMixin {
+    sourceName: string;
+    bufferDelayMs?: number;
+    account: SipAccountSettings;
+    call: SipCallSettings;
+    onStatus?: (status: SipEvent_Status) => void;
+    onConnectionStats?: (stats: SipConnectionStatistics) => void;
+}
+export interface SipAccountSettings {
+    id: string;
+    credentials: SipAccountCredentials;
+    regUri?: string;
+}
+export interface SipAccountCredentials {
+    realm: string;
+    username: string;
+    credential: SipAccountCredential;
+}
+export declare type SipAccountCredential = {
+    type: "plain";
+    password: string;
+} | {
+    type: "digest";
+    digest: string;
+};
+export interface SipCallSettings {
+    address: string;
+}
+export interface SipConnectionStatistics {
+    send: SipStreamStatistics;
+    receive: SipStreamStatistics;
+}
+export interface SipStreamStatistics {
+    numBytes: number;
+    numPackets: number;
+}
+/**
+ * @public
+ * see: {@link NorskDuplex.sip}
+ */
+export declare class SipNode extends AutoProcessorMediaNode<"audio"> {
+}
 /**
  * @public
  * Methods that allow you to both ingest and egest media from your application
@@ -1171,10 +1217,11 @@ export interface NorskDuplex {
      * The browser client must conform to a custom protocol as implemented in the hosted test page.
      * (Available from {@link WebRTCBrowserNode.playerUrl}
      * For general WebRTC ingest prefer the WHIP input node, and for egest to a downstream media server
-     * use the WHIP output node.
+     * use the WHIP output node. For browser egest (e.g. stream preview) use the WHEP output node.
      * @param settings - Options for the webrtc node
      */
     webRtcBrowser(settings: WebRTCBrowserSettings): Promise<WebRTCBrowserNode>;
+    sip(settings: SipSettings): Promise<SipNode>;
 }
 /**
  * @public

package/lib/src/media_nodes/processor.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NorskProcessor = exports.WebRTCBrowserNode = exports.StreamChaosMonkeyNode = exports.VideoTransformNode = exports.VideoDecodeNode = exports.VideoEncodeNode = exports.AudioTranscribeWhisperNode = exports.AudioTranscribeAzureNode = exports.SubtitleConvertNode = exports.SubtitleTranslateAwsNode = exports.AudioTranscribeAwsNode = exports.AudioBuildMultichannelNode = exports.AudioSplitMultichannelNode = exports.AudioGainNode = exports.AudioMixMatrixNode = exports.AudioMixNode = exports.VideoComposeNode = exports.AudioEncodeNode = exports.MetadataCombineMode = exports.AncillaryNode = exports.StreamConditionNode = exports.StreamAlignNode = exports.StreamSyncNode = exports.JitterBufferNode = exports.StreamMetadataOverrideNode = exports.StreamKeyOverrideNode = exports.StreamTimestampNudgeNode = exports.AudioMeasureLevelsNode = exports.StreamStatisticsNode = exports.StreamSwitchSmoothNode = exports.StreamSwitchHardNode = exports.AutoProcessorMediaNode = exports.ProcessorMediaNode = void 0;
+exports.NorskProcessor = exports.SipNode = exports.WebRTCBrowserNode = exports.StreamChaosMonkeyNode = exports.VideoTransformNode = exports.VideoDecodeNode = exports.VideoEncodeNode = exports.AudioTranscribeWhisperNode = exports.AudioTranscribeAzureNode = exports.SubtitleConvertNode = exports.SubtitleTranslateAwsNode = exports.AudioTranscribeAwsNode = exports.AudioBuildMultichannelNode = exports.AudioSplitMultichannelNode = exports.AudioGainNode = exports.AudioMixMatrixNode = exports.AudioMixNode = exports.VideoComposeNode = exports.AudioEncodeNode = exports.MetadataCombineMode = exports.AncillaryNode = exports.StreamConditionNode = exports.StreamAlignNode = exports.StreamSyncNode = exports.JitterBufferNode = exports.StreamMetadataOverrideNode = exports.StreamKeyOverrideNode = exports.StreamTimestampNudgeNode = exports.AudioMeasureLevelsNode = exports.StreamStatisticsNode = exports.StreamSwitchSmoothNode = exports.StreamSwitchHardNode = exports.AutoProcessorMediaNode = exports.ProcessorMediaNode = void 0;
 const events_1 = __importDefault(require("events"));
 const media_pb_1 = require("@norskvideo/norsk-api/lib/media_pb");
 const common_pb_1 = require("@norskvideo/norsk-api/lib/shared/common_pb");
@@ -2418,6 +2418,110 @@ class WebRTCBrowserNode extends AutoProcessorMediaNode {
     }
 }
 exports.WebRTCBrowserNode = WebRTCBrowserNode;
+/**
+ * @public
+ * see: {@link NorskDuplex.sip}
+ */
+class SipNode extends AutoProcessorMediaNode {
+    /** @internal */
+    constructor(settings, client, unregisterNode) {
+        super(client, unregisterNode, () => this.grpcStream, async (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.SipMessage, (0, utils_1.mkMessageCase)({ subscription }))));
+        this.defaultSubscriptionValidation = this.restrictiveSubscriptionValidation;
+        this.subscriptionValidation = this.restrictiveSubscriptionValidation;
+        function accountToApi(account) {
+            const cred = account.credentials.credential;
+            const credential = cred.type === "digest" ? (0, utils_1.provideFull)(media_pb_1.SipCredentialData, (0, utils_1.mkMessageCase)({ digest: cred.digest })) : (0, utils_1.provideFull)(media_pb_1.SipCredentialData, (0, utils_1.mkMessageCase)({ plain: cred.password }));
+            return (0, utils_1.provideFull)(media_pb_1.SipAccount, {
+                id: account.id,
+                regUri: account.regUri || "",
+                credentials: (0, utils_1.provideFull)(media_pb_1.SipCredentials, {
+                    realm: account.credentials.realm,
+                    username: account.credentials.username,
+                    credential
+                })
+            });
+        }
+        function callToApi(call) {
+            return (0, utils_1.provideFull)(media_pb_1.SipCall, {
+                address: call.address
+            });
+        }
+        function toConnectionStatistics(stats) {
+            return ({
+                send: {
+                    numBytes: stats.send?.numBytes || 0,
+                    numPackets: stats.send?.numPackets || 0
+                },
+                receive: {
+                    numBytes: stats.recv?.numBytes || 0,
+                    numPackets: stats.recv?.numPackets || 0
+                }
+            });
+        }
+        const sipConfig = (0, utils_1.provideFull)(media_pb_1.SipConfiguration, {
+            ...settings,
+            id: settings.id
+                ? (0, utils_1.provideFull)(media_pb_1.MediaNodeId, { id: settings.id })
+                : undefined,
+            sourceName: settings.sourceName,
+            account: accountToApi(settings.account),
+            bufferDelayMs: (0, types_2.toOptInt)(settings.bufferDelayMs),
+            call: callToApi(settings.call),
+            statsSampling: settings.statsSampling
+                ? (0, utils_1.provideFull)(media_pb_1.StreamStatisticsSampling, settings.statsSampling)
+                : undefined
+        });
+        this.grpcStream = this.client.media.createDuplexSip();
+        this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.SipMessage, (0, utils_1.mkMessageCase)({ configuration: sipConfig })));
+        this.initialised = new Promise((resolve, reject) => {
+            this.grpcStream.on("data", (data) => {
+                const messageCase = data.message.case;
+                switch (messageCase) {
+                    case undefined:
+                        break;
+                    case "subscriptionResponse":
+                        super.subscriptionResponse(data.message.value);
+                        break;
+                    case "inboundContext": {
+                        const context = data.message.value;
+                        super.handleInboundContext(context);
+                        break;
+                    }
+                    case "outboundContext": {
+                        const context = data.message.value;
+                        super.outboundContextChange(context);
+                        break;
+                    }
+                    case "nodeId": {
+                        this.id = data.message.value.id;
+                        settings.onCreate && settings.onCreate(this);
+                        resolve();
+                        break;
+                    }
+                    case "streamStatistics":
+                        settings.onStreamStatistics?.((0, types_2.fromStreamStatistics)(data.message.value, this.subscribedStreams));
+                        break;
+                    case "status":
+                        settings.onStatus?.(data.message.value);
+                        break;
+                    case "connectionStatistics":
+                        settings.onConnectionStats?.(toConnectionStatistics(data.message.value));
+                        break;
+                    default:
+                        (0, utils_1.exhaustiveCheck)(messageCase);
+                }
+            });
+            (0, common_1.registerStreamHandlers)(this.grpcStream, () => unregisterNode(this), "webRtc", reject, settings);
+        });
+    }
+    /** @internal */
+    static async create(settings, client, unregisterNode) {
+        const node = new SipNode(settings, client, unregisterNode);
+        await node.initialised;
+        return node;
+    }
+}
+exports.SipNode = SipNode;
 /** @public */
 class NorskProcessor {
     constructor(client) {

package/lib/src/sdk.js

@@ -25,9 +25,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.streamKeysAreEqual = exports.requireExactAV = exports.requireAV = exports.subtitlesToPin = exports.sourceToPin = exports.avToPin = exports.audioToPin = exports.videoToPin = exports.mkEncryption = exports.selectPlaylist = exports.selectExactKey = exports.selectVideoRendition = exports.selectAncillary = exports.selectVideo = exports.selectAudio = exports.selectSubtitles = exports.selectAV = exports.selectAll = exports.mkSine = exports.newSilentMatrix = exports.ancillaryStreamKeys = exports.playlistStreamKeys = exports.subtitleStreamKeys = exports.videoStreamKeys = exports.audioStreamKeys = exports.ancillaryStreams = exports.playlistStreams = exports.subtitleStreams = exports.videoStreams = exports.audioStreams = exports.Norsk = exports.Version = exports.AudioCodec = exports.AmdMA35DLoad = exports.CurrentLoad = void 0;
 const grpc = __importStar(require("@grpc/grpc-js"));
@@ -42,8 +39,8 @@ const output_1 = require("./media_nodes/output");
 const system_1 = require("./system");
 const debug_1 = require("./media_nodes/debug");
 const mediaStore_1 = require("./media_nodes/mediaStore");
-const chalk_1 = __importDefault(require("chalk"));
 const pj = require("../package.json");
+const connectivity_state_1 = require("@grpc/grpc-js/build/src/connectivity-state");
 __exportStar(require("./types"), exports);
 __exportStar(require("./system"), exports);
 __exportStar(require("./media_nodes/types"), exports);
@@ -143,6 +140,7 @@ class Norsk {
         };
         this.duplex = {
             webRtcBrowser: async (settings) => processor_1.WebRTCBrowserNode.create(settings, this._client(), unregisterNode).then(registerNode),
+            sip: async (settings) => processor_1.SipNode.create(settings, this._client(), unregisterNode).then(registerNode)
         };
     }
     /** @internal */
@@ -226,7 +224,7 @@ class Norsk {
                 const stringVersion = `${this.version.majorVersion}.${this.version.minorVersion}.${this.version.buildNumber}`;
                 if (stringVersion != this.sdkVersion) {
                     const warning = `Norsk version mismatch: SDK=${this.sdkVersion}, runtime=${stringVersion}\nBEWARE POTENTIAL GRPC API CHANGES\nFunctionality may be partially or completely broken`;
-                    console.error(chalk_1.default.red(warning));
+                    console.error(warning);
                     (0, utils_1.errorlog)(warning);
                 }
                 this.resolveVersion();
@@ -344,7 +342,7 @@ class Norsk {
                 break;
             }
         }
-        (0, utils_1.debuglog)("Channel connectivity state change: %d", connectivityState);
+        (0, utils_1.debuglog)("Channel connectivity state change: %d (%s)", connectivityState, connectivity_state_1.ConnectivityState[connectivityState]);
         this.connectivityState = connectivityState;
         channel.watchConnectivityState(connectivityState, Infinity, () => {
             this.connectivityStateWatcher();

package/package.json

@@ -1,11 +1,11 @@
 {
   "license": "MIT",
   "name": "@norskvideo/norsk-sdk",
-  "version": "1.0.368",
+  "version": "1.0.370",
   "dependencies": {
     "@bufbuild/protobuf": "^0.3.0",
     "@grpc/grpc-js": "^1.2.2",
-    "@norskvideo/norsk-api": "1.0.368",
+    "@norskvideo/norsk-api": "1.0.370",
     "lodash": "^4.17.21",
     "typescript-nullable": "^0.6.0"
   },

package/src/sdk.ts

@@ -56,6 +56,8 @@ import {
   WebRTCBrowserNode,
   WebRTCBrowserSettings,
   NorskDuplex,
+  SipSettings,
+  SipNode,
 } from "./media_nodes/processor";
 import {
   CmafAudioOutputNode,
@@ -109,9 +111,9 @@ import {
   MediaStoreSnapshotSettings,
   MediaStoreSnapshot,
 } from "./media_nodes/mediaStore";
-import chalk from "chalk";
 
 import pj = require("../package.json");
+import { ConnectivityState } from "@grpc/grpc-js/build/src/connectivity-state";
 
 export * from "./types";
 export * from "./system";
@@ -345,7 +347,7 @@ export class Norsk {
         const stringVersion = `${this.version.majorVersion}.${this.version.minorVersion}.${this.version.buildNumber}`;
         if (stringVersion != this.sdkVersion) {
           const warning = `Norsk version mismatch: SDK=${this.sdkVersion}, runtime=${stringVersion}\nBEWARE POTENTIAL GRPC API CHANGES\nFunctionality may be partially or completely broken`;
-          console.error(chalk.red(warning));
+          console.error(warning);
           errorlog(warning)
         }
 
@@ -473,7 +475,7 @@ export class Norsk {
         break;
       }
     }
-    debuglog("Channel connectivity state change: %d", connectivityState);
+    debuglog("Channel connectivity state change: %d (%s)", connectivityState, ConnectivityState[connectivityState]);
 
     this.connectivityState = connectivityState;
     channel.watchConnectivityState(connectivityState, Infinity, () => {
@@ -615,6 +617,8 @@ export class Norsk {
     this.duplex = {
       webRtcBrowser: async (settings: WebRTCBrowserSettings) =>
         WebRTCBrowserNode.create(settings, this._client(), unregisterNode).then(registerNode),
+      sip: async (settings: SipSettings) => 
+        SipNode.create(settings, this._client(), unregisterNode).then(registerNode)
     };
   }
 }