eyevinn-channel-engine 4.2.1 → 4.2.3

package/README.md

@@ -110,7 +110,7 @@ Build the app:
 npm run build
 ```
 
-To start the reference implementation in `server.ts` run:
+To start the reference implementation in `examples/default.ts` run:
 
 ```
 npm start
@@ -129,10 +129,11 @@ DEBUG=engine-* npm start
 ```
 
 In addition there other reference implemetations that can be used:
-- `server-demux.ts` : example with demuxed audio
-- `server-livemix.ts` : example with live mimxing
-- `server-multicodec.ts` : example with multicodec
-- `server-drm.ts` : example with DRM
+- `examples/demux.ts` : example with demuxed audio
+- `examples/livemix.ts` : example with live mimxing
+- `examples/multicodec.ts` : example with multicodec
+- `examples/drm.ts` : example with DRM
+- `examples/autocreate.ts` : example to auto create channel on demand
 
 ### Source linking hls-vodtolive library
 

package/dist/engine/server.d.ts

@@ -26,6 +26,7 @@ export interface ChannelEngineOpts {
     adXchangeUri?: string;
     noSessionDataTags?: boolean;
     volatileKeyTTL?: number;
+    autoCreateSession?: boolean;
 }
 export interface VodRequest {
     sessionId: string;
@@ -43,13 +44,18 @@ export interface VodTimedMetadata {
     'x-channelid'?: string;
     'class': string;
 }
+export interface LiveTimedMetadata {
+    'id': string;
+    'start-date': string;
+    'x-title'?: string;
+}
 export interface VodResponse {
     title: any;
     id: string;
     uri: string;
     offset?: number;
     diffMs?: number;
-    desiredDuraiton?: number;
+    desiredDuration?: number;
     type?: string;
     currentMetadata?: VodResponseMetadata;
     timedMetadata?: VodTimedMetadata;
@@ -92,6 +98,7 @@ export interface SubtitleTracks {
 }
 export interface IChannelManager {
     getChannels: () => Channel[];
+    autoCreateChannel?: (channelId: string) => void;
 }
 export declare enum ScheduleStreamType {
     LIVE = 1,
@@ -106,6 +113,7 @@ export interface Schedule {
     end_time: number;
     uri: string;
     duration?: number;
+    timedMetadata?: LiveTimedMetadata;
 }
 export interface IStreamSwitchManager {
     getSchedule: (channelId: string) => Promise<Schedule[]>;
@@ -133,6 +141,7 @@ export declare class ChannelEngine {
     private logCloudWatchMetrics;
     private adCopyMgrUri?;
     private adXchangeUri?;
+    private autoCreateSession;
     constructor(assetMgr: IAssetManager, options?: ChannelEngineOpts);
     updateStreamSwitchAsync(): Promise<void>;
     updateChannelsAsync(channelMgr: any, options: any): Promise<void>;
@@ -142,6 +151,7 @@ export declare class ChannelEngine {
     getSessionCount(): number;
     getPlayheadCount(): number;
     _monitorAsync(session: any, sessionLive: any): Promise<void>;
+    createChannel(channelId: any): Promise<void>;
     getMasterManifest(channelId: any): Promise<any>;
     getMediaManifests(channelId: any): Promise<{}>;
     getAudioManifests(channelId: any): Promise<{}>;

package/dist/engine/server.js

@@ -47,12 +47,13 @@ var SessionLive = require('./session_live.js');
 var StreamSwitcher = require('./stream_switcher.js');
 var EventStream = require('./event_stream.js');
 var SubtitleSlicer = require('./subtitle_slicer.js');
+var timer = require('./util.js').timer;
 var SessionStateStore = require('./session_state.js').SessionStateStore;
 var SessionLiveStateStore = require('./session_live_state.js').SessionLiveStateStore;
 var PlayheadStateStore = require('./playhead_state.js').PlayheadStateStore;
 var _a = require('./util.js'), filterQueryParser = _a.filterQueryParser, toHHMMSS = _a.toHHMMSS, WaitTimeGenerator = _a.WaitTimeGenerator;
 var version = require('../package.json').version;
-var timer = function (ms) { return new Promise(function (res) { return setTimeout(res, ms); }); };
+var AUTO_CREATE_CHANNEL_TIMEOUT = 3000;
 var sessions = {}; // Should be a persistent store...
 var sessionsLive = {}; // Should be a persistent store...
 var sessionSwitchers = {}; // Should be a persistent store...
@@ -69,6 +70,7 @@ var ScheduleStreamType;
 var ChannelEngine = /** @class */ (function () {
     function ChannelEngine(assetMgr, options) {
         var _this = this;
+        this.autoCreateSession = false;
         this.options = options;
         if (options && options.adCopyMgrUri) {
             this.adCopyMgrUri = options.adCopyMgrUri;
@@ -95,6 +97,9 @@ var ChannelEngine = /** @class */ (function () {
         if (options && options.streamSwitchManager) {
             this.streamSwitchManager = options.streamSwitchManager;
         }
+        if (options && options.autoCreateSession !== undefined) {
+            this.autoCreateSession = options.autoCreateSession;
+        }
         this.assetMgr = assetMgr;
         this.monitorTimer = {};
         this.server = restify.createServer();
@@ -417,6 +422,7 @@ var ChannelEngine = /** @class */ (function () {
                     case 0:
                         debug("Do we have any new channels?");
                         newChannels = channelMgr.getChannels().filter(function (channel) { return !sessions[channel.id]; });
+                        debug(newChannels);
                         addAsync = function (channel) { return __awaiter(_this, void 0, void 0, function () {
                             var _this = this;
                             return __generator(this, function (_a) {
@@ -486,7 +492,7 @@ var ChannelEngine = /** @class */ (function () {
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0:
-                                        debug("Adding channel with ID ".concat(channel.id));
+                                        debug("Adding live channel with ID ".concat(channel.id));
                                         return [4 /*yield*/, sessionsLive[channel.id].initAsync()];
                                     case 1:
                                         _a.sent();
@@ -652,6 +658,32 @@ var ChannelEngine = /** @class */ (function () {
             });
         });
     };
+    ChannelEngine.prototype.createChannel = function (channelId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!!sessions[channelId]) return [3 /*break*/, 2];
+                        if (!this.options.channelManager.autoCreateChannel) return [3 /*break*/, 2];
+                        this.options.channelManager.autoCreateChannel(channelId);
+                        setTimeout(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, this.updateChannelsAsync(this.options.channelManager, this.options)];
+                                case 1:
+                                    _a.sent();
+                                    return [2 /*return*/];
+                            }
+                        }); }); });
+                        return [4 /*yield*/, timer(AUTO_CREATE_CHANNEL_TIMEOUT)];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [2 /*return*/];
+                }
+            });
+        });
+    };
     ChannelEngine.prototype.getMasterManifest = function (channelId) {
         return __awaiter(this, void 0, void 0, function () {
             var session, masterM3U8, err;
@@ -835,52 +867,25 @@ var ChannelEngine = /** @class */ (function () {
                         if (req.query['category']) {
                             options.category = req.query['category'];
                         }
-                        if (!(req.query['channel'] && sessions[req.query['channel']])) return [3 /*break*/, 1];
-                        session = sessions[req.query['channel']];
-                        return [3 /*break*/, 4];
+                        if (!(this.autoCreateSession && req.query['channel'])) return [3 /*break*/, 2];
+                        debug("Attempting to create channel with id ".concat(req.query['channel']));
+                        return [4 /*yield*/, this.createChannel(req.query['channel'])];
                     case 1:
-                        if (!(req.query['session'] && sessions[req.query['session']])) return [3 /*break*/, 2];
-                        session = sessions[req.query['session']];
-                        return [3 /*break*/, 4];
+                        _a.sent();
+                        debug("Automatically created channel with id ".concat(req.query['channel']));
+                        _a.label = 2;
                     case 2:
-                        options.adCopyMgrUri = this.adCopyMgrUri;
-                        options.adXchangeUri = this.adXchangeUri;
-                        options.averageSegmentDuration = this.streamerOpts.defaultAverageSegmentDuration;
-                        options.useDemuxedAudio = this.useDemuxedAudio;
-                        options.dummySubtitleEndpoint = this.dummySubtitleEndpoint;
-                        options.subtitleSliceEndpoint = this.subtitleSliceEndpoint;
-                        options.useVTTSubtitles = this.useVTTSubtitles;
-                        options.alwaysNewSegments = this.alwaysNewSegments;
-                        options.playheadDiffThreshold = this.streamerOpts.defaultPlayheadDiffThreshold;
-                        options.maxTickInterval = this.streamerOpts.defaultMaxTickInterval;
-                        options.targetDurationPadding = this.streamerOpts.targetDurationPadding;
-                        options.forceTargetDuration = this.streamerOpts.forceTargetDuration;
-                        options.diffCompensationRate = this.streamerOpts.diffCompensationRate;
-                        // if we are initiating a master manifest
-                        // outside of specific Channel context,
-                        // if slate options are set at the ChannelEngine level, then set these here
-                        if (this.defaultSlateUri) {
-                            options.slateUri = this.defaultSlateUri;
+                        if (req.query['channel'] && sessions[req.query['channel']]) {
+                            session = sessions[req.query['channel']];
                         }
-                        if (this.slateRepetitions) {
-                            options.slateRepetitions = this.slateRepetitions;
+                        else if (req.query['session'] && sessions[req.query['session']]) {
+                            session = sessions[req.query['session']];
                         }
-                        if (this.slateDuration) {
-                            options.slateDuration = this.slateDuration;
-                        }
-                        options.disabledPlayhead = true; // disable playhead for personalized streams
-                        session = new Session(this.assetMgr, options, this.sessionStore);
-                        return [4 /*yield*/, session.initAsync()];
-                    case 3:
-                        _a.sent();
-                        sessions[session.sessionId] = session;
-                        _a.label = 4;
-                    case 4:
                         if (req.query['startWithId']) {
                             options.startWithId = req.query['startWithId'];
                             debug("New session to start with assetId=".concat(options.startWithId));
                         }
-                        if (!session) return [3 /*break*/, 9];
+                        if (!session) return [3 /*break*/, 7];
                         eventStream = new EventStream(session);
                         eventStreams[session.sessionId] = eventStream;
                         filter = void 0;
@@ -888,11 +893,11 @@ var ChannelEngine = /** @class */ (function () {
                             debug("Applying filter on master manifest ".concat(req.query['filter']));
                             filter = filterQueryParser(req.query['filter']);
                         }
-                        _a.label = 5;
-                    case 5:
-                        _a.trys.push([5, 7, , 8]);
+                        _a.label = 3;
+                    case 3:
+                        _a.trys.push([3, 5, , 6]);
                         return [4 /*yield*/, session.getMasterManifestAsync(filter)];
-                    case 6:
+                    case 4:
                         body = _a.sent();
                         res.sendRaw(200, Buffer.from(body, 'utf8'), {
                             "Content-Type": "application/vnd.apple.mpegurl",
@@ -904,16 +909,16 @@ var ChannelEngine = /** @class */ (function () {
                             "X-Instance-Id": this.instanceId + "<".concat(version, ">"),
                         });
                         next();
-                        return [3 /*break*/, 8];
-                    case 7:
+                        return [3 /*break*/, 6];
+                    case 5:
                         err_4 = _a.sent();
                         next(this._errorHandler(err_4));
-                        return [3 /*break*/, 8];
-                    case 8: return [3 /*break*/, 10];
-                    case 9:
+                        return [3 /*break*/, 6];
+                    case 6: return [3 /*break*/, 8];
+                    case 7:
                         next(this._gracefulErrorHandler("Could not find a valid session"));
-                        _a.label = 10;
-                    case 10: return [2 /*return*/];
+                        _a.label = 8;
+                    case 8: return [2 /*return*/];
                 }
             });
         });

package/dist/engine/session.d.ts

@@ -107,6 +107,7 @@ declare class Session {
     _tickAsync(): Promise<void>;
     _getNextVod(): Promise<any>;
     _loadSlate(afterVod: any, reps: any): Promise<any>;
+    _truncateVod(vodResponse: any): Promise<any>;
     _truncateSlate(afterVod: any, requestedDuration: any, vodUri: any): Promise<any>;
     _fillGap(afterVod: any, desiredDuration: any): Promise<any>;
     _getNextVodById(id: any): Promise<any>;
@@ -117,4 +118,5 @@ declare class Session {
     _getSubtitlePlayheadPosition(seqIdx: any): Promise<any>;
     _getLastDuration(manifest: any): Promise<any>;
     _getPlayheadDiffCompensationValue(diffMs: any, thresholdMs: any): number;
+    _isOldVod(refTs: any, vodDur: any): boolean;
 }