@norskvideo/norsk-sdk 1.0.360 → 1.0.363

package/dist/norsk-sdk.d.ts

@@ -18,6 +18,7 @@ import { HlsTsCombinedPushMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsTsMultiVariantMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsTsVideoMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { Interval as Interval_2 } from '@norskvideo/norsk-api/lib/media_pb';
+import { M3u8MediaInputMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { MA35DCard as MA35DCard_2 } from '@norskvideo/norsk-api/lib/media_pb';
 import { MediaClient as MediaClient_2 } from '@norskvideo/norsk-api/lib/media_grpc_pb';
 import { Nullable } from 'typescript-nullable';
@@ -1418,10 +1419,27 @@ export declare class DeltacastInputNode extends SourceMediaNode {
  * see: {@link NorskInput.deltaCast}
  */
 export declare interface DeltacastInputSettings extends InputSettings<DeltacastInputNode>, StreamStatisticsMixin {
-    /** Which deviceto use */
+    /** Which device to use */
     deviceId: number;
-    /** Which card to use */
-    cardIndex: number;
+    /** Which channel on the device to use */
+    channelIndex: number;
+    /**
+     * An SDI signal can contain up to 16 (3G) or 32 (6G / 12G) audio channels, which are
+     * transmitted as groups of 4.  For example, a single stereo signal would typically be
+     * encoded with the left audio on the first channel of the first group, and the right
+     * audio as the second channel of the first group.  The remaining 2 channels on the first
+     * group will contain silence. Deltacast input captures all audio channels that are present
+     * in the signal and returns them as mono streams; the audioBuidMultichannel node can be
+     * used to combine these mono streams into stereo, 5.1 etc.
+     * The audioChannelMask is a bit field that indicates which streams should be returned out
+     * of those present in the signal.  Taking the stereo signal example from above, a sensible
+     * mask would be 0x3, indicating that channels 0 and 1 should be returned - thus saving
+     * your code from needing to deal with channels 2 and 3, which you know to just be silent.
+     * If you set a bit that is *not* present in the signal, then no stream will be created -
+     * only streams present in the signal will be returned.
+     * If left undefined, then a default of 0xFFFFFFFF is used - i.e., capture all
+     */
+    audioChannelMask?: number;
 }
 
 /** @public */
@@ -2299,6 +2317,16 @@ export declare type LoganHevcTier = "main" | "high";
 /** @public */
 export declare type LogicalCpuId = number;
 
+/**
+ * see: {@link NorskInput.m3u8Media}
+ */
+export declare class M3u8InputNode extends TsCommonInputNode<M3u8MediaInputMessage, M3u8InputNode> {
+}
+
+export declare interface M3u8MediaInputSettings extends InputSettings<M3u8InputNode> {
+    url: string;
+}
+
 /** @public */
 export declare interface MA35DCard {
     index: number;
@@ -2586,6 +2614,10 @@ export declare interface NorskInput {
      * @param settings - Configuration for the WHIP input
      */
     whip(settings: WhipInputSettings): Promise<WhipInputNode>;
+    /**
+     * Pull an m3u8 HLS media stream and output it into Norsk in realtime
+     */
+    m3u8Media(settings: M3u8MediaInputSettings): Promise<M3u8InputNode>;
     /**
      * Read from a Transport Stream on the network
      * This can be multicast/unicast or broadcast

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

@@ -1,5 +1,5 @@
 import * as grpc from "@grpc/grpc-js";
-import { TsInputEvent, StreamKey as StreamKeyPB, Wave, FileTsInputMessage, UdpTsInputMessage, TimestampProgramNudge, RtmpError_UnsupportedVideo, RtmpError_UnsupportedAudio } from "@norskvideo/norsk-api/lib/media_pb";
+import { TsInputEvent, StreamKey as StreamKeyPB, Wave, FileTsInputMessage, UdpTsInputMessage, M3u8MediaInputMessage, TimestampProgramNudge, RtmpError_UnsupportedVideo, RtmpError_UnsupportedAudio } from "@norskvideo/norsk-api/lib/media_pb";
 import { BrowserEvent, ChannelLayout, RtmpServerInputStatus, RtpLinearPcmBitDepth, SampleFormat, SampleRate, SrtMode, SrtInputStatus, ImageFormat, IceServerSettings, FrameStoreStreamSelection, FrameStoreCut } from "./types";
 import { FrameRate } from "../types";
 import { DeckLinkPixelFormat, DeckLinkVideoConnection, DeckLinkDisplayModeId } from "../types";
@@ -277,10 +277,27 @@ export declare class DeckLinkInputNode extends SourceMediaNode {
  * see: {@link NorskInput.deltaCast}
  */
 export interface DeltacastInputSettings extends InputSettings<DeltacastInputNode>, StreamStatisticsMixin {
-    /** Which deviceto use */
+    /** Which device to use */
     deviceId: number;
-    /** Which card to use */
-    cardIndex: number;
+    /** Which channel on the device to use */
+    channelIndex: number;
+    /**
+     * An SDI signal can contain up to 16 (3G) or 32 (6G / 12G) audio channels, which are
+     * transmitted as groups of 4.  For example, a single stereo signal would typically be
+     * encoded with the left audio on the first channel of the first group, and the right
+     * audio as the second channel of the first group.  The remaining 2 channels on the first
+     * group will contain silence. Deltacast input captures all audio channels that are present
+     * in the signal and returns them as mono streams; the audioBuidMultichannel node can be
+     * used to combine these mono streams into stereo, 5.1 etc.
+     * The audioChannelMask is a bit field that indicates which streams should be returned out
+     * of those present in the signal.  Taking the stereo signal example from above, a sensible
+     * mask would be 0x3, indicating that channels 0 and 1 should be returned - thus saving
+     * your code from needing to deal with channels 2 and 3, which you know to just be silent.
+     * If you set a bit that is *not* present in the signal, then no stream will be created -
+     * only streams present in the signal will be returned.
+     * If left undefined, then a default of 0xFFFFFFFF is used - i.e., capture all
+    */
+    audioChannelMask?: number;
 }
 /**
  * @public
@@ -477,6 +494,14 @@ export interface UdpTsInputSettings extends RemoteInputSettings<UdpTsInputNode>
  */
 export declare class UdpTsInputNode extends TsCommonInputNode<UdpTsInputMessage, UdpTsInputNode> {
 }
+export interface M3u8MediaInputSettings extends InputSettings<M3u8InputNode> {
+    url: string;
+}
+/**
+ * see: {@link NorskInput.m3u8Media}
+ */
+export declare class M3u8InputNode extends TsCommonInputNode<M3u8MediaInputMessage, M3u8InputNode> {
+}
 /**
  * @public
  * Settings for a Browser Input
@@ -717,6 +742,10 @@ export interface NorskInput {
      * @param settings - Configuration for the WHIP input
      */
     whip(settings: WhipInputSettings): Promise<WhipInputNode>;
+    /**
+     * Pull an m3u8 HLS media stream and output it into Norsk in realtime
+     */
+    m3u8Media(settings: M3u8MediaInputSettings): Promise<M3u8InputNode>;
     /**
      * Read from a Transport Stream on the network
      * This can be multicast/unicast or broadcast

package/lib/src/media_nodes/input.js

@@ -515,7 +515,8 @@ class DeltacastInputNode extends common_1.SourceMediaNode {
                 : undefined,
             sourceName: settings.sourceName,
             deviceId: settings.deviceId,
-            cardIndex: settings.cardIndex,
+            channelIndex: settings.channelIndex,
+            audioChannelMask: settings.audioChannelMask ? settings.audioChannelMask : 0xffffffff,
             statsSampling: settings.statsSampling
                 ? (0, utils_1.provideFull)(media_pb_1.StreamStatisticsSampling, settings.statsSampling)
                 : undefined,
@@ -908,7 +909,6 @@ class UdpTsInputNode extends TsCommonInputNode {
 }
 exports.UdpTsInputNode = UdpTsInputNode;
 /**
- * @internal
  * see: {@link NorskInput.m3u8Media}
  */
 class M3u8InputNode extends TsCommonInputNode {

package/lib/src/media_nodes/output.js

@@ -343,7 +343,7 @@ class CmafNodeWithPlaylist extends CmafNodeBase {
                 // An HLS segmenter can only be subscribed to one stream.
                 const theStream = streams[0];
                 this.subscribedStream = theStream;
-                const url = this.localDestination ? makePlaylistUrl(theStream, playlistPath, this.localDestination.sessionId) : "";
+                const url = this.localDestination ? makePlaylistUrl(theStream, playlistPath, this.localDestination.id, this.localDestination.sessionId) : "";
                 this.pendingUrlRequests.forEach((resolve) => resolve(url));
                 this.pendingUrlRequests = [];
             }
@@ -362,7 +362,7 @@ class CmafNodeWithPlaylist extends CmafNodeBase {
     async url() {
         return (new Promise((resolve, _reject) => {
             if (this.subscribedStream) {
-                resolve(this.localDestination ? makePlaylistUrl(this.subscribedStream, this.playlistPath, this.localDestination.sessionId) : "");
+                resolve(this.localDestination ? makePlaylistUrl(this.subscribedStream, this.playlistPath, this.localDestination.id, this.localDestination.sessionId) : "");
             }
             else {
                 this.pendingUrlRequests.push(resolve);
@@ -527,7 +527,7 @@ function sendPlaylistUpdateTs(destinationId, [playlistAdditions, programDateTime
  * Returns the *local* url of a playlist
  * TODO Would be cool if remote locations were supported also
 */
-function makePlaylistUrl(stream, path, sessionId) {
+function makePlaylistUrl(stream, path, id, sessionId) {
     const theStreamKey = stream.streamKey;
     let pathPrefix;
     switch (path) {
@@ -540,7 +540,7 @@ function makePlaylistUrl(stream, path, sessionId) {
     }
     const sessionIdPath = sessionId && sessionId !== "" ? sessionId + "/" : "";
     // TODO Should really come from the server
-    return `${(0, utils_1.publicUrlPrefix)()}/${pathPrefix}/${sessionIdPath}${theStreamKey?.sourceName}/${theStreamKey?.programNumber}/${theStreamKey?.streamId}/${theStreamKey?.renditionName + "___local"}/norsk.m3u8`; // FIXME this is wrong
+    return `${(0, utils_1.publicUrlPrefix)()}/${pathPrefix}/${sessionIdPath}${theStreamKey?.sourceName}/${theStreamKey?.programNumber}/${theStreamKey?.streamId}/${theStreamKey?.renditionName}___${id}/norsk.m3u8`;
 }
 // TODO we'll need a Dash URL too?
 /**
@@ -1395,7 +1395,7 @@ class FrameStoreRecorderNode extends common_1.AutoSinkMediaNode {
                     expiryPb = (0, utils_1.provideFull)(media_pb_1.FrameStoreExpiry, { message: (0, utils_1.mkCase)({ bySize: settings.expiry.size }) });
                     break;
                 case "byTime":
-                    expiryPb = (0, utils_1.provideFull)(media_pb_1.FrameStoreExpiry, { message: (0, utils_1.mkCase)({ bySize: settings.expiry.durationS }) });
+                    expiryPb = (0, utils_1.provideFull)(media_pb_1.FrameStoreExpiry, { message: (0, utils_1.mkCase)({ byDuration: settings.expiry.durationS }) });
                     break;
                 default:
                     (0, utils_1.exhaustiveCheck)(expiryType);

package/package.json

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