@norskvideo/norsk-sdk 1.0.341 → 1.0.342

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

@@ -80,8 +80,20 @@ export declare class SourceMediaNode extends MediaNodeState {
     registerForContextChange(subscriber: SinkMediaNode<string>): void;
     unregisterForContextChange(subscriber: SinkMediaNode<string>): void;
 }
+/**
+ * @public
+ * Determines what to do with an incoming context
+ *
+ * - true/accept: Allow the incoming context through, and any subsequent/queued data that belongs to it
+ * - false/deny: Deny the incoming context, if no context has been accepted, then queue data until one is
+ * - accept_and_terminate: Allow the incoming context, then deny further data, flush and shut down the node
+ *      this is useful for cleanly terminating outputs when the context is empty
+ * */
+export declare type SubscriptionValidationResponse = true | false | "accept" | "deny" | "accept_and_terminate";
 /** @public */
 export declare class SinkMediaNode<Pins extends string> extends MediaNodeState {
+    permissiveSubscriptionValidation(_context: Context): SubscriptionValidationResponse;
+    restrictiveSubscriptionValidation(context: Context): SubscriptionValidationResponse;
     /** Subscribe to the given sources.
      *
      * This version of the function call accepts the target pins of an output
@@ -97,8 +109,9 @@ export declare class SinkMediaNode<Pins extends string> extends MediaNodeState {
      *
      * Errors are also logged to the debug log.
      */
-    subscribeToPins(sources: ReceiveFromAddress<Pins>[], validation?: (context: Context) => boolean, done?: (error?: SubscriptionError) => void): void;
+    subscribeToPins(sources: ReceiveFromAddress<Pins>[], validation?: (context: Context) => SubscriptionValidationResponse, done?: (error?: SubscriptionError) => void): void;
     sourceContextChange(responseCallback: (error?: SubscriptionError) => void): Promise<boolean>;
+    finalise(): void;
 }
 /** @public */
 export declare class AutoSinkMediaNode<Pins extends string> extends SinkMediaNode<Pins | "auto"> {
@@ -117,6 +130,6 @@ export declare class AutoSinkMediaNode<Pins extends string> extends SinkMediaNod
      *
      * Errors are also logged to the debug log.
      */
-    subscribe(sources: ReceiveFromAddressAuto[], validation?: (context: Context) => boolean, done?: (error?: SubscriptionError) => void): void;
+    subscribe(sources: ReceiveFromAddressAuto[], validation?: (context: Context) => SubscriptionValidationResponse, done?: (error?: SubscriptionError) => void): void;
 }
 //# sourceMappingURL=common.d.ts.map

package/lib/src/media_nodes/common.js

@@ -69,6 +69,10 @@ class MediaNodeState {
     close() {
         console.log("Default close operator called on medianode, this is probably a missing implementation");
     }
+    /** @internal */
+    finalise() {
+        // We don't care here, only in Sink
+    }
 }
 exports.MediaNodeState = MediaNodeState;
 /** @public */
@@ -90,18 +94,20 @@ class SourceMediaNode extends MediaNodeState {
         this.subscribers.delete(subscriber);
     }
     /** @internal */
-    subscriptionComplete(context) {
+    subscriptionComplete(context, subscriber) {
         return () => {
-            const numPending = this.pendingContextAcks.get(context);
-            if (numPending === undefined)
+            const pending = this.pendingContextAcks.get(context);
+            if (pending === undefined)
                 return;
-            if (numPending == 1) {
+            (0, utils_1.debuglog)("Checking context on %s:  %O", this.id, context.blockingCallRef);
+            if (pending.length == 1) {
                 (0, utils_1.debuglog)("Node '%s' acknowledging context %O", this.id, context.blockingCallRef);
                 _ackContext(this.client, this.id, context);
                 this.pendingContextAcks.delete(context);
             }
             else {
-                this.pendingContextAcks.set(context, numPending - 1);
+                let index = pending.indexOf(subscriber); // should error if not null?
+                this.pendingContextAcks.set(context, pending.splice(index, 1));
             }
         };
     }
@@ -114,18 +120,18 @@ class SourceMediaNode extends MediaNodeState {
             if (this.onOutboundContextChange) {
                 yield this.onOutboundContextChange(this.outputStreams);
             }
-            let numPending = 0;
+            let pending = [];
             for (let [subscriber, _] of this.subscribers) {
-                const pending = yield subscriber.sourceContextChange(this.subscriptionComplete(context));
-                if (pending) {
-                    numPending++;
+                const alive = yield subscriber.sourceContextChange(this.subscriptionComplete(context, subscriber));
+                if (alive) {
+                    pending.push(subscriber);
                 }
                 else {
                     (0, utils_1.debuglog)("Skipping updating subscription to closed node %s", subscriber.id);
                 }
             }
-            if (numPending > 0) {
-                this.pendingContextAcks.set(context, numPending);
+            if (pending.length > 0) {
+                this.pendingContextAcks.set(context, pending);
             }
             else {
                 (0, utils_1.debuglog)("Node '%s' acknowledging context immediately %O", this.id, context.blockingCallRef);
@@ -145,6 +151,8 @@ class SinkMediaNode extends MediaNodeState {
         /** @internal */
         this.currentSubscription = null;
         /** @internal */
+        this.subscriptionValidated = false;
+        /** @internal */
         this.currentSourcesActive = 0;
         /** @internal */
         this.subscriptionResponseCallbacks = new Map();
@@ -153,30 +161,46 @@ class SinkMediaNode extends MediaNodeState {
         this.getGrpcStream = getGrpcStream;
         this.subscribeFn = subscribeFn;
         this.subscribeErrorFn = subscribeErrorFn;
-        this.subscriptionValidation = (_) => true;
+        this.subscriptionValidation = this.permissiveSubscriptionValidation;
+        this.defaultSubscriptionValidation = this.restrictiveSubscriptionValidation;
         this.subscribedStreamsChangedFn = subscribedStreamsChangedFn;
     }
+    // Always allow streams and contexts through, essentially a no-op
+    // This is the default case for most nodes that aren't outputs or don't need to 
+    // synchronise their streams at all
+    permissiveSubscriptionValidation(_context) {
+        return "accept";
+    }
     // If all sources have returned some keys
     // and if all streams are accounted for in the context
     // then we're good to go, otherwise, wait and keep queuing
-    /** @internal */
-    defaultSubscriptionValidation(context) {
+    restrictiveSubscriptionValidation(context) {
         if (!this.currentSubscription) {
             (0, utils_1.debuglog)("Node %s ignoring inbound context, no current subscription", this.id);
-            return false;
-        }
-        if (this.currentSourcesActive < this.currentSources.size) {
-            (0, utils_1.debuglog)("Node '%s' ignoring inbound context because not all sources are active yet %O", this.id, debugFormatContext(context));
-            return false;
+            return "deny";
         }
         const numStreams = context.streams.length;
         const expected = this.currentSubscription.sources.length;
+        if (numStreams == 0 && this.subscriptionValidated) {
+            (0, utils_1.debuglog)("Node '%s' accepting inbound context because it is empty and we have previously accepted a full context %O", this.id, debugFormatContext(context));
+            this.subscriptionValidated = false;
+            return "accept";
+        }
+        if (this.currentSourcesActive < this.currentSources.size && !this.subscriptionValidated) {
+            (0, utils_1.debuglog)("Node '%s' ignoring inbound context because not all sources are active yet %O", this.id, debugFormatContext(context));
+            return "deny";
+        }
+        if (this.currentSourcesActive < this.currentSources.size) {
+            (0, utils_1.debuglog)("Node '%s' ignoring inbound context because it is smaller than the already-accepted one %O", this.id, debugFormatContext(context));
+            return "deny";
+        }
         if (numStreams == expected) {
             (0, utils_1.debuglog)("Node '%s' accepting inbound context because all keys and streams are accounted for %O", this.id, debugFormatContext(context));
-            return true;
+            this.subscriptionValidated = true;
+            return "accept";
         }
         (0, utils_1.debuglog)("Node '%s' ignoring inbound context because not all keys are accounted for yet %O", this.id, debugFormatContext(context));
-        return false;
+        return "deny";
     }
     /** Subscribe to the given sources.
      *
@@ -298,11 +322,33 @@ class SinkMediaNode extends MediaNodeState {
                 .bind(this.client);
             yield responseFn(new media_pb_1.ValidationResponse({
                 mediaNodeId: (0, types_1.toMediaNodeId)(this.id),
-                result: validationResponse,
+                result: this.toValidationResponse(validationResponse),
             }));
             _ackContext(this.client, this.id, context);
         });
     }
+    /** @internal */
+    toValidationResponse(response) {
+        switch (response) {
+            case true:
+            case "accept":
+                return media_pb_1.ValidationResponse_ContextValidationResponse.CONTEXT_VALIDATION_ALLOW;
+            case false:
+            case "deny":
+                return media_pb_1.ValidationResponse_ContextValidationResponse.CONTEXT_VALIDATION_DENY;
+            case "accept_and_terminate":
+                return media_pb_1.ValidationResponse_ContextValidationResponse.CONTEXT_VALIDATION_ALLOW_AND_TERMINATE;
+            default:
+                (0, utils_1.exhaustiveCheck)(response);
+        }
+    }
+    finalise() {
+        // These will now never be invoked because grpc is gone, so do it now so we don't hang
+        for (const [id, callback] of this.subscriptionResponseCallbacks) {
+            (0, utils_1.debuglog)("Invoking subscription response for node %s because of a close %s", this.id, id);
+            callback();
+        }
+    }
 }
 exports.SinkMediaNode = SinkMediaNode;
 /** @public */
@@ -361,7 +407,7 @@ function registerStreamHandlers(grpcStream, unregisterNode, tag, reject, setting
         console.log("Error:", source, err.code, constants_1.Status[err.code], err.details, (_a = err.metadata) === null || _a === void 0 ? void 0 : _a.getMap());
     };
     grpcStream.on("end", () => {
-        (0, utils_1.debuglog)(`End of ${tag} source`);
+        (0, utils_1.debuglog)(`End of ${tag} node`);
         grpcStream.destroy();
     });
     grpcStream.on("error", (error) => {
@@ -369,11 +415,11 @@ function registerStreamHandlers(grpcStream, unregisterNode, tag, reject, setting
         if (constants_1.Status[error.code] == "CANCELLED") {
             return;
         }
-        logError(`${tag} source`, error);
+        logError(`${tag} node`, error);
         settings.onError && settings.onError(error);
     });
     grpcStream.on("close", () => {
-        (0, utils_1.debuglog)(`${tag} source close`);
+        (0, utils_1.debuglog)(`${tag} node close`);
         unregisterNode();
         settings.onClose && settings.onClose();
         reject();

package/lib/src/media_nodes/input.js

@@ -565,7 +565,7 @@ class WhipInputNode extends common_1.SourceMediaNode {
                     }
                 }
             });
-            (0, common_1.registerStreamHandlers)(this.grpcStream, () => unregisterNode(this), "whip", reject, settings);
+            (0, common_1.registerStreamHandlers)(this.grpcStream, () => unregisterNode(this), "whipInput", reject, settings);
         });
     }
     /** @internal */
@@ -1096,7 +1096,7 @@ class FileMp4InputNode extends common_1.SourceMediaNode {
         this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.FileMp4InputMessage, (0, utils_1.mkMessageCase)({ initialConfig: config })));
         this.initialised = new Promise((resolve, reject) => {
             this.grpcStream.on("data", (data) => {
-                var _a, _b, _c;
+                var _a, _b, _c, _d;
                 const messageCase = data.message.case;
                 switch (messageCase) {
                     case undefined:
@@ -1132,6 +1132,9 @@ class FileMp4InputNode extends common_1.SourceMediaNode {
                         (_c = settings.onStreamStatistics) === null || _c === void 0 ? void 0 : _c.call(settings, (0, types_1.fromStreamStatistics)(data.message.value, this.outputStreams));
                         break;
                     }
+                    case "gopStructure":
+                        (_d = settings.onGopStructure) === null || _d === void 0 ? void 0 : _d.call(settings, data.message.value);
+                        break;
                     default:
                         (0, utils_1.exhaustiveCheck)(messageCase);
                 }

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

@@ -48,6 +48,10 @@ export interface CmafOutputSettings extends SinkNodeSettings<CmafAudioOutputNode
      * XML fragment to add to the mpd Representation element
      */
     mpdAdditions?: string;
+    /**
+     * Audio or video bitrate for the {@link NorskOutput.cmafMultiVariant} playlist
+     */
+    bitrate?: number;
 }
 /**
  * @public
@@ -84,6 +88,10 @@ export interface HlsTsVideoOutputSettings extends SinkNodeSettings<HlsTsVideoOut
      * XML fragment to add to the mpd Representation element
      */
     mpdAdditions?: string;
+    /**
+     * Video bitrate for the {@link NorskOutput.hlsTsMultiVariant} playlist
+     */
+    bitrate?: number;
 }
 /**
  * @public
@@ -120,6 +128,10 @@ export interface HlsTsAudioOutputSettings extends SinkNodeSettings<HlsTsAudioOut
      * XML fragment to add to the mpd Representation element
      */
     mpdAdditions?: string;
+    /**
+     * Audio bitrate for the {@link NorskOutput.hlsTsMultiVariant} playlist
+     */
+    bitrate?: number;
 }
 /**
  * @public
@@ -368,7 +380,7 @@ declare class CmafNodeBase<ClientMessage, Pins extends string, T extends MediaNo
     close(): void;
 }
 declare class CmafNodeWithPlaylist<ClientMessage, Pins extends string, T extends MediaNodeState> extends CmafNodeBase<ClientMessage, Pins, T> {
-    constructor(client: MediaClient, unregisterNode: (node: MediaNodeState) => void, settings: ProcessorNodeSettings<T> & StreamStatisticsMixin, grpcInit: () => grpc.ClientDuplexStream<ClientMessage, HlsOutputEvent>, subscribeFn: (subscription: Subscription) => void, playlistPath: PlaylistPath);
+    constructor(client: MediaClient, unregisterNode: (node: MediaNodeState) => void, settings: ProcessorNodeSettings<T> & StreamStatisticsMixin, grpcInit: () => grpc.ClientDuplexStream<ClientMessage, HlsOutputEvent>, subscribeFn: (subscription: Subscription) => void, playlistPath: PlaylistPath, sessionId: string);
     /**
      * @public
      * Returns the URL to the HLS playlist entry.  Note this can only be evaluated once the stream is active as it
@@ -384,11 +396,11 @@ declare class CmafNodeWithPlaylist<ClientMessage, Pins extends string, T extends
  */
 export declare class CmafVideoOutputNode extends CmafNodeWithPlaylist<CmafVideoMessage, "video", CmafVideoOutputNode> {
     /**
-   * @public
-   * Updates the credentials for a specific destination within this output by id
-   * see: {@link UpdateCredentials}
-   * see: {@link CmafDestinationSettings}
-   */
+     * @public
+     * Updates the credentials for a specific destination within this output by id
+     * see: {@link UpdateCredentials}
+     * see: {@link CmafDestinationSettings}
+     */
     updateCredentials(settings: UpdateCredentials): void;
 }
 /**
@@ -613,6 +625,8 @@ export interface RtmpOutputSettings extends SinkNodeSettings<RtmpOutputNode>, St
     url: string;
     /** Jitter buffer delay in milliseconds */
     bufferDelayMs?: number;
+    /** Called when the RTMP output succesfully connects to a server and starts publishing data */
+    onPublishStart?: () => void;
 }
 /**
  * @public
@@ -660,6 +674,11 @@ export interface FileMp4OutputSettings extends SinkNodeSettings<FileMp4OutputNod
      * Settings for encrypting the video track.
      */
     videoEncryption?: EncryptionSettings;
+    /**
+     * Callback that will be invoked once data stops being received by the node (determined by an empty context)
+     * at which point it will automatically shut down
+     */
+    onStreamEof?: () => void;
 }
 /**
  * @public

package/lib/src/media_nodes/output.js

@@ -64,8 +64,9 @@ class CmafNodeBase extends processor_1.AutoProcessorMediaNode {
     }
 }
 class CmafNodeWithPlaylist extends CmafNodeBase {
-    constructor(client, unregisterNode, settings, grpcInit, subscribeFn, playlistPath) {
+    constructor(client, unregisterNode, settings, grpcInit, subscribeFn, playlistPath, sessionId) {
         super(client, unregisterNode, settings, grpcInit, subscribeFn, playlistPath, (streams) => {
+            this.sessionId = sessionId;
             if (streams.length === 0) {
                 this.subscribedStream = undefined;
             }
@@ -73,7 +74,7 @@ class CmafNodeWithPlaylist extends CmafNodeBase {
                 // An HLS segmenter can only be subscribed to one stream.
                 const theStream = streams[0];
                 this.subscribedStream = theStream;
-                const url = makePlaylistUrl(theStream, playlistPath);
+                const url = makePlaylistUrl(theStream, playlistPath, this.sessionId);
                 this.pendingUrlRequests.forEach((resolve) => resolve(url));
                 this.pendingUrlRequests = [];
             }
@@ -91,7 +92,7 @@ class CmafNodeWithPlaylist extends CmafNodeBase {
         return __awaiter(this, void 0, void 0, function* () {
             return (new Promise((resolve, _reject) => {
                 if (this.subscribedStream) {
-                    resolve(makePlaylistUrl(this.subscribedStream, this.playlistPath));
+                    resolve(makePlaylistUrl(this.subscribedStream, this.playlistPath, this.sessionId));
                 }
                 else {
                     this.pendingUrlRequests.push(resolve);
@@ -124,18 +125,18 @@ class CmafVideoOutputNode extends CmafNodeWithPlaylist {
                     ? (0, utils_1.provideFull)(media_pb_1.MediaNodeId, { id: settings.id })
                     : undefined, encryption: settings.encryption
                     ? (0, types_1.mkEncryptionSettings)(settings.encryption)
-                    : undefined, destinations: settings.destinations.map(mkCmafDestination), delayOutputMs: (_a = settings.delayOutputMs) !== null && _a !== void 0 ? _a : defaultDelayOutputMs, m3uAdditions: settings.m3uAdditions || "", mpdAdditions: settings.mpdAdditions || "" }));
+                    : undefined, destinations: settings.destinations.map(mkCmafDestination), delayOutputMs: (_a = settings.delayOutputMs) !== null && _a !== void 0 ? _a : defaultDelayOutputMs, m3uAdditions: settings.m3uAdditions || "", mpdAdditions: settings.mpdAdditions || "", bitrate: settings.bitrate || 0 }));
             const hls = client.createOutputCmafVideo();
             hls.write((0, utils_1.provideFull)(media_pb_1.CmafVideoMessage, (0, utils_1.mkMessageCase)({ configuration: config })));
             return hls;
-        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.CmafVideoMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Cmaf);
+        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.CmafVideoMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Cmaf, localDestinationSessionId(settings.destinations) || "");
     }
     /**
-   * @public
-   * Updates the credentials for a specific destination within this output by id
-   * see: {@link UpdateCredentials}
-   * see: {@link CmafDestinationSettings}
-   */
+     * @public
+     * Updates the credentials for a specific destination within this output by id
+     * see: {@link UpdateCredentials}
+     * see: {@link CmafDestinationSettings}
+     */
     updateCredentials(settings) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const conf = { destinationId: settings.destinationId, awsCredentials: (0, utils_1.provideFull)(media_pb_1.AwsCredentials, settings.awsCredentials) };
@@ -164,11 +165,11 @@ class CmafAudioOutputNode extends CmafNodeWithPlaylist {
                     ? (0, utils_1.provideFull)(media_pb_1.MediaNodeId, { id: settings.id })
                     : undefined, encryption: settings.encryption
                     ? (0, types_1.mkEncryptionSettings)(settings.encryption)
-                    : undefined, destinations: settings.destinations.map(mkCmafDestination), delayOutputMs: (_a = settings.delayOutputMs) !== null && _a !== void 0 ? _a : defaultDelayOutputMs, m3uAdditions: settings.m3uAdditions || "", mpdAdditions: settings.mpdAdditions || "" }));
+                    : undefined, destinations: settings.destinations.map(mkCmafDestination), delayOutputMs: (_a = settings.delayOutputMs) !== null && _a !== void 0 ? _a : defaultDelayOutputMs, m3uAdditions: settings.m3uAdditions || "", mpdAdditions: settings.mpdAdditions || "", bitrate: settings.bitrate || 0 }));
             const hls = client.createOutputCmafAudio();
             hls.write((0, utils_1.provideFull)(media_pb_1.CmafAudioMessage, (0, utils_1.mkMessageCase)({ configuration: config })));
             return hls;
-        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.CmafAudioMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Cmaf);
+        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.CmafAudioMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Cmaf, localDestinationSessionId(settings.destinations) || "");
     }
     /**
      * @public
@@ -184,7 +185,12 @@ class CmafAudioOutputNode extends CmafNodeWithPlaylist {
 }
 exports.CmafAudioOutputNode = CmafAudioOutputNode;
 /** @private */
-function makePlaylistUrl(stream, path) {
+function localDestinationSessionId(destinations) {
+    var _a;
+    return (_a = destinations.filter((d) => d.type === "local")[0]) === null || _a === void 0 ? void 0 : _a.sessionId;
+}
+/** @private */
+function makePlaylistUrl(stream, path, sessionId) {
     const theStreamKey = stream.streamKey;
     let pathPrefix;
     switch (path) {
@@ -195,7 +201,9 @@ function makePlaylistUrl(stream, path) {
             pathPrefix = "ts";
             break;
     }
-    return `${(0, utils_1.publicUrlPrefix)()}/${pathPrefix}/stream/${theStreamKey === null || theStreamKey === void 0 ? void 0 : theStreamKey.sourceName}/${theStreamKey === null || theStreamKey === void 0 ? void 0 : theStreamKey.programNumber}/${theStreamKey === null || theStreamKey === void 0 ? void 0 : theStreamKey.streamId}/${theStreamKey === null || theStreamKey === void 0 ? void 0 : theStreamKey.renditionName}/norsk.m3u8`;
+    const sessionIdPath = sessionId && sessionId !== "" ? sessionId + "/" : "";
+    // TODO Should really come from the server
+    return `${(0, utils_1.publicUrlPrefix)()}/${pathPrefix}/${sessionIdPath}${theStreamKey === null || theStreamKey === void 0 ? void 0 : theStreamKey.sourceName}/${theStreamKey === null || theStreamKey === void 0 ? void 0 : theStreamKey.programNumber}/${theStreamKey === null || theStreamKey === void 0 ? void 0 : theStreamKey.streamId}/${(theStreamKey === null || theStreamKey === void 0 ? void 0 : theStreamKey.renditionName) + "_local"}/norsk.m3u8`;
 }
 // TODO we'll need a Dash URL too?
 /**
@@ -217,11 +225,11 @@ class HlsTsVideoOutputNode extends CmafNodeWithPlaylist {
             var _a;
             const config = (0, utils_1.provideFull)(media_pb_1.HlsTsVideoConfiguration, Object.assign(Object.assign({}, settings), { id: settings.id
                     ? (0, utils_1.provideFull)(media_pb_1.MediaNodeId, { id: settings.id })
-                    : undefined, delayOutputMs: (_a = settings.delayOutputMs) !== null && _a !== void 0 ? _a : defaultDelayOutputMs, destinations: settings.destinations.map(mkCmafDestination), m3uAdditions: settings.m3uAdditions || "", mpdAdditions: settings.mpdAdditions || "" }));
+                    : undefined, delayOutputMs: (_a = settings.delayOutputMs) !== null && _a !== void 0 ? _a : defaultDelayOutputMs, destinations: settings.destinations.map(mkCmafDestination), m3uAdditions: settings.m3uAdditions || "", mpdAdditions: settings.mpdAdditions || "", bitrate: settings.bitrate || 0 }));
             const hls = client.createOutputHlsTsVideo();
             hls.write((0, utils_1.provideFull)(media_pb_1.HlsTsVideoMessage, (0, utils_1.mkMessageCase)({ configuration: config })));
             return hls;
-        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.HlsTsVideoMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Ts);
+        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.HlsTsVideoMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Ts, localDestinationSessionId(settings.destinations) || "");
     }
     /**
      * @public
@@ -255,11 +263,11 @@ class HlsTsAudioOutputNode extends CmafNodeWithPlaylist {
             var _a;
             const config = (0, utils_1.provideFull)(media_pb_1.HlsTsAudioConfiguration, Object.assign(Object.assign({}, settings), { id: settings.id
                     ? (0, utils_1.provideFull)(media_pb_1.MediaNodeId, { id: settings.id })
-                    : undefined, delayOutputMs: (_a = settings.delayOutputMs) !== null && _a !== void 0 ? _a : defaultDelayOutputMs, destinations: settings.destinations.map(mkCmafDestination), m3uAdditions: settings.m3uAdditions || "", mpdAdditions: settings.mpdAdditions || "" }));
+                    : undefined, delayOutputMs: (_a = settings.delayOutputMs) !== null && _a !== void 0 ? _a : defaultDelayOutputMs, destinations: settings.destinations.map(mkCmafDestination), m3uAdditions: settings.m3uAdditions || "", mpdAdditions: settings.mpdAdditions || "", bitrate: settings.bitrate || 0 }));
             const hls = client.createOutputHlsTsAudio();
             hls.write((0, utils_1.provideFull)(media_pb_1.HlsTsAudioMessage, (0, utils_1.mkMessageCase)({ configuration: config })));
             return hls;
-        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.HlsTsAudioMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Ts);
+        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.HlsTsAudioMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Ts, localDestinationSessionId(settings.destinations) || "");
     }
     /**
     * @public
@@ -297,7 +305,7 @@ class HlsTsCombinedPushOutputNode extends CmafNodeWithPlaylist {
             const hls = client.createOutputHlsTsCombinedPush();
             hls.write((0, utils_1.provideFull)(media_pb_1.HlsTsCombinedPushMessage, (0, utils_1.mkMessageCase)({ configuration: config })));
             return hls;
-        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.HlsTsCombinedPushMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Ts);
+        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.HlsTsCombinedPushMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Ts, localDestinationSessionId([settings.destination]) || "");
     }
 }
 exports.HlsTsCombinedPushOutputNode = HlsTsCombinedPushOutputNode;
@@ -324,7 +332,7 @@ class CmafWebVttOutputNode extends CmafNodeWithPlaylist {
             const hls = client.createOutputCmafWebVtt();
             hls.write((0, utils_1.provideFull)(media_pb_1.CmafWebVttMessage, (0, utils_1.mkMessageCase)({ configuration: config })));
             return hls;
-        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.CmafWebVttMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Cmaf);
+        }, (subscription) => this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.CmafWebVttMessage, (0, utils_1.mkMessageCase)({ subscription }))), PlaylistPath.Cmaf, localDestinationSessionId(settings.destinations) || "");
     }
     /**
     * @public
@@ -363,10 +371,13 @@ class CmafMultiVariantOutputNode extends CmafNodeBase {
     }
     /** @internal */
     static create(settings, client, unregisterNode) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const node = new CmafMultiVariantOutputNode(settings, client, unregisterNode);
             yield node.initialised;
-            node.url = `${(0, utils_1.publicUrlPrefix)()}/cmaf/file/${settings.playlistName}.m3u8`;
+            const sessionId = (_a = settings.destinations.filter((d) => d.type === "local")[0]) === null || _a === void 0 ? void 0 : _a.sessionId;
+            const sessionIdPath = sessionId && sessionId !== "" ? sessionId + "/" : "";
+            node.url = `${(0, utils_1.publicUrlPrefix)()}/cmaf/file/${sessionIdPath}${settings.playlistName}.m3u8`;
             return node;
         });
     }
@@ -407,10 +418,13 @@ class HlsTsMultiVariantOutputNode extends CmafNodeBase {
     }
     /** @internal */
     static create(settings, client, unregisterNode) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const node = new HlsTsMultiVariantOutputNode(settings, client, unregisterNode);
             yield node.initialised;
-            node.url = `${(0, utils_1.publicUrlPrefix)()}/ts/${settings.playlistName}.m3u8`;
+            const sessionId = (_a = settings.destinations.filter((d) => d.type === "local")[0]) === null || _a === void 0 ? void 0 : _a.sessionId;
+            const sessionIdPath = sessionId && sessionId != "" ? sessionId + "/" : "";
+            node.url = `${(0, utils_1.publicUrlPrefix)()}/ts/${sessionIdPath}${settings.playlistName}.m3u8`;
             return node;
         });
     }
@@ -612,7 +626,7 @@ class WhipOutputNode extends common_1.AutoSinkMediaNode {
                         (0, utils_1.exhaustiveCheck)(messageCase);
                 }
             });
-            (0, common_1.registerStreamHandlers)(this.grpcStream, () => unregisterNode(this), "webrtcWhep", reject, settings);
+            (0, common_1.registerStreamHandlers)(this.grpcStream, () => unregisterNode(this), "whipOutput", reject, settings);
         });
     }
     /** @internal */
@@ -672,7 +686,7 @@ class WhepOutputNode extends common_1.AutoSinkMediaNode {
                         (0, utils_1.exhaustiveCheck)(messageCase);
                 }
             });
-            (0, common_1.registerStreamHandlers)(this.grpcStream, () => unregisterNode(this), "webrtcWhip", reject, settings);
+            (0, common_1.registerStreamHandlers)(this.grpcStream, () => unregisterNode(this), "whepOutput", reject, settings);
         });
     }
     /** @internal */
@@ -703,6 +717,7 @@ class RtmpOutputNode extends common_1.AutoSinkMediaNode {
                 : undefined, statsSampling: settings.statsSampling
                 ? (0, utils_1.provideFull)(media_pb_1.StreamStatisticsSampling, settings.statsSampling)
                 : undefined, bufferDelayMs: Math.round(settings.bufferDelayMs || 0) }));
+        this.onPublishStart = settings.onPublishStart;
         this.grpcStream = this.client.createOutputRtmp();
         this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.RtmpOutputMessage, (0, utils_1.mkMessageCase)({ configuration: rtmpOutputConfig })));
         this.initialised = new Promise((resolve, reject) => {
@@ -729,6 +744,11 @@ class RtmpOutputNode extends common_1.AutoSinkMediaNode {
                     case "streamStatistics":
                         (_a = settings.onStreamStatistics) === null || _a === void 0 ? void 0 : _a.call(settings, (0, types_1.fromStreamStatistics)(data.message.value, this.subscribedStreams));
                         break;
+                    case "status":
+                        if (data.message.value == media_pb_1.RtmpOutputEvent_State.RTMP_OUTPUT_STATUS_PUBLISH_START && this.onPublishStart) {
+                            this.onPublishStart();
+                        }
+                        break;
                     default:
                         (0, utils_1.exhaustiveCheck)(messageCase);
                 }
@@ -830,7 +850,7 @@ class FileMp4OutputNode extends common_1.AutoSinkMediaNode {
         this.grpcStream.write((0, utils_1.provideFull)(media_pb_1.FileMp4OutputMessage, (0, utils_1.mkMessageCase)({ configuration: config })));
         this.initialised = new Promise((resolve, reject) => {
             this.grpcStream.on("data", (data) => {
-                var _a;
+                var _a, _b;
                 const messageCase = data.message.case;
                 switch (messageCase) {
                     case undefined:
@@ -852,6 +872,10 @@ class FileMp4OutputNode extends common_1.AutoSinkMediaNode {
                     case "streamStatistics":
                         (_a = settings.onStreamStatistics) === null || _a === void 0 ? void 0 : _a.call(settings, (0, types_1.fromStreamStatistics)(data.message.value, this.subscribedStreams));
                         break;
+                    case "status":
+                        if (data.message.value.state = media_pb_1.FileMp4OutputStatus_State.OUTPUT_STATUS_EOF)
+                            (_b = settings.onStreamEof) === null || _b === void 0 ? void 0 : _b.call(settings);
+                        break;
                     default:
                         (0, utils_1.exhaustiveCheck)(messageCase);
                         throw new Error(`Unhandled case: ${utils_1.exhaustiveCheck}`);

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

@@ -228,6 +228,20 @@ export interface StreamSyncSettings extends ProcessorNodeSettings<StreamSyncNode
 export declare class StreamSyncNode extends AutoProcessorMediaNode<"audio" | "video"> {
     close(): void;
 }
+/**
+ * @public
+ * Settings for a StreamProgramJoin node
+ * see {@link NorskTransform.streamSync}
+ * */
+export interface StreamProgramJoinSettings extends ProcessorNodeSettings<StreamProgramJoinNode> {
+}
+/**
+ * @public
+ * see: {@link NorskTransform.streamSync}
+ */
+export declare class StreamProgramJoinNode extends AutoProcessorMediaNode<"audio" | "video"> {
+    close(): void;
+}
 export interface Smpte2038Message {
     cNotYChannelFlag: boolean;
     lineNumber: number;
@@ -478,6 +492,10 @@ export interface AudioMixSettings<Pins extends string> extends ProcessorNodeSett
     sources: readonly AudioMixSource<Pins>[];
     /** The source name to use for the output stream */
     outputSource: string;
+    /** The channel layout that the mixer runs at
+     * all audio streams will be normalised to this value and therefore
+     * this will be the output channel layout of this node */
+    channelLayout: ChannelLayout;
     /** The sample rate that the mixer runs at
      * all audio streams will be normalised to this value and therefore
      * this will be the output sample rate of this node */
@@ -615,6 +633,12 @@ export interface AudioBuildMultichannelSettings extends ProcessorNodeSettings<Au
      * rate.
      */
     channelList: readonly StreamKey[];
+    /**
+     * Callback invoked when the inbound context changes
+     * a new channel list can be returned here that overrides the initial configuration
+     * and allows the channel order to be changed at runtime
+    */
+    onInputChanged?: (keys: StreamKey[]) => StreamKey[] | undefined;
     /** The stream key to use for the outoging stream*/
     outputStreamKey: StreamKey;
 }
@@ -929,6 +953,17 @@ export interface NorskTransform {
      * especially outputs.
      */
     streamSync(settings: StreamSyncSettings): Promise<StreamSyncNode>;
+    /**
+     * This processor does multiple things
+     * - joins together multiple streams from multiple sources
+     * - rebases their timestamps so that they all start at the same point
+     * - sets the program id to a common value
+     *
+     * It is useful for syncing multiple incoming streams that on paper are already synchronised but because
+     * of the time taken to set up connections and subscriptions across various protocols, are off by a few
+     * hundred milliseconds
+     */
+    streamProgramJoin(settings: StreamProgramJoinSettings): Promise<StreamProgramJoinNode>;
     ancillary(settings: AncillarySettings): Promise<AncillaryNode>;
 }
 /**