eyevinn-channel-engine 4.1.1 → 4.2.0-rc.2

package/dist/engine/playhead_state.js

@@ -138,6 +138,7 @@ var PlayheadStateStore = /** @class */ (function (_super) {
             mediaSeq: 0,
             vodMediaSeqVideo: 0,
             vodMediaSeqAudio: 0,
+            vodMediaSeqSubtitle: 0,
         }) || this;
     }
     PlayheadStateStore.prototype.create = function (sessionId) {

package/dist/engine/server.d.ts

@@ -13,6 +13,9 @@ export interface ChannelEngineOpts {
     maxTickInterval?: number;
     cloudWatchMetrics?: boolean;
     useDemuxedAudio?: boolean;
+    dummySubtitleEndpoint?: string;
+    subtitleSliceEndpoint?: string;
+    useVTTSubtitles?: boolean;
     alwaysNewSegments?: boolean;
     diffCompensationRate?: number;
     staticDirectory?: string;
@@ -66,6 +69,7 @@ export interface Channel {
     id: string;
     profile: ChannelProfile[];
     audioTracks?: AudioTracks[];
+    subtitleTracks?: SubtitleTracks[];
     closedCaptions?: ClosedCaptions[];
 }
 export interface ClosedCaptions {
@@ -81,6 +85,11 @@ export interface AudioTracks {
     default?: boolean;
     enforceAudioGroupId?: string;
 }
+export interface SubtitleTracks {
+    language: string;
+    name: string;
+    default?: boolean;
+}
 export interface IChannelManager {
     getChannels: () => Channel[];
 }
@@ -104,6 +113,9 @@ export interface IStreamSwitchManager {
 export declare class ChannelEngine {
     private options?;
     private useDemuxedAudio;
+    private dummySubtitleEndpoint;
+    private subtitleSliceEndpoint;
+    private useVTTSubtitles;
     private alwaysNewSegments;
     private defaultSlateUri?;
     private slateDuration?;
@@ -133,9 +145,13 @@ export declare class ChannelEngine {
     getMasterManifest(channelId: any): Promise<any>;
     getMediaManifests(channelId: any): Promise<{}>;
     getAudioManifests(channelId: any): Promise<{}>;
+    getSubtitleManifests(channelId: any): Promise<{}>;
     _handleHeartbeat(req: any, res: any, next: any): void;
     _handleMasterManifest(req: any, res: any, next: any): Promise<void>;
     _handleAudioManifest(req: any, res: any, next: any): Promise<void>;
+    _handleSubtitleManifest(req: any, res: any, next: any): Promise<void>;
+    _handleDummySubtitleEndpoint(req: any, res: any, next: any): Promise<void>;
+    _handleSubtitleSliceEndpoint(req: any, res: any, next: any): Promise<void>;
     _handleMediaManifest(req: any, res: any, next: any): Promise<void>;
     _handleEventStream(req: any, res: any, next: any): void;
     _handleStatus(req: any, res: any, next: any): Promise<void>;

package/dist/engine/server.js

@@ -46,6 +46,7 @@ var Session = require('./session.js');
 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 SessionStateStore = require('./session_state.js').SessionStateStore;
 var SessionLiveStateStore = require('./session_live_state.js').SessionLiveStateStore;
 var PlayheadStateStore = require('./playhead_state.js').PlayheadStateStore;
@@ -57,6 +58,8 @@ var sessionsLive = {}; // Should be a persistent store...
 var sessionSwitchers = {}; // Should be a persistent store...
 var switcherStatus = {}; // Should be a persistent store...
 var eventStreams = {};
+var DefaultDummySubtitleEndpointPath = "dummyUrl";
+var DefaultSubtitleSpliceEndpointPath = "sliceUrl";
 var ScheduleStreamType;
 (function (ScheduleStreamType) {
     ScheduleStreamType[ScheduleStreamType["LIVE"] = 1] = "LIVE";
@@ -77,6 +80,9 @@ var ChannelEngine = /** @class */ (function () {
         if (options && options.useDemuxedAudio) {
             this.useDemuxedAudio = true;
         }
+        this.useVTTSubtitles = (options && options.useVTTSubtitles) ? options.useVTTSubtitles : false;
+        this.dummySubtitleEndpoint = (options && options.dummySubtitleEndpoint) ? options.dummySubtitleEndpoint : DefaultDummySubtitleEndpointPath;
+        this.subtitleSliceEndpoint = (options && options.subtitleSliceEndpoint) ? options.dummySubtitleEndpoint : DefaultSubtitleSpliceEndpointPath;
         this.alwaysNewSegments = false;
         if (options && options.alwaysNewSegments) {
             this.alwaysNewSegments = true;
@@ -162,7 +168,7 @@ var ChannelEngine = /** @class */ (function () {
                         return [4 /*yield*/, this._handleMasterManifest(req, res, next)];
                     case 1:
                         _a.sent();
-                        return [3 /*break*/, 6];
+                        return [3 /*break*/, 8];
                     case 2:
                         if (!(m = req.params.file.match(/master(\d+).m3u8;session=(.*)$/))) return [3 /*break*/, 4];
                         req.params[0] = m[1];
@@ -170,7 +176,7 @@ var ChannelEngine = /** @class */ (function () {
                         return [4 /*yield*/, this._handleMediaManifest(req, res, next)];
                     case 3:
                         _a.sent();
-                        return [3 /*break*/, 6];
+                        return [3 /*break*/, 8];
                     case 4:
                         if (!(m = req.params.file.match(/master-(\S+)_(\S+).m3u8;session=(.*)$/))) return [3 /*break*/, 6];
                         req.params[0] = m[1];
@@ -179,8 +185,17 @@ var ChannelEngine = /** @class */ (function () {
                         return [4 /*yield*/, this._handleAudioManifest(req, res, next)];
                     case 5:
                         _a.sent();
-                        _a.label = 6;
-                    case 6: return [2 /*return*/];
+                        return [3 /*break*/, 8];
+                    case 6:
+                        if (!(m = req.params.file.match(/subtitles-(\S+)_(\S+).m3u8;session=(.*)$/))) return [3 /*break*/, 8];
+                        req.params[0] = m[1];
+                        req.params[1] = m[2];
+                        req.params[2] = m[3];
+                        return [4 /*yield*/, this._handleSubtitleManifest(req, res, next)];
+                    case 7:
+                        _a.sent();
+                        _a.label = 8;
+                    case 8: return [2 /*return*/];
                 }
             });
         }); };
@@ -235,6 +250,8 @@ var ChannelEngine = /** @class */ (function () {
         this.server.get('/health', this._handleAggregatedSessionHealth.bind(this));
         this.server.get('/health/:sessionId', this._handleSessionHealth.bind(this));
         this.server.get('/reset', this._handleSessionReset.bind(this));
+        this.server.get('/channels/:channelId/' + this.dummySubtitleEndpoint, this._handleDummySubtitleEndpoint.bind(this));
+        this.server.get('/channels/:channelId/' + this.subtitleSliceEndpoint, this._handleSubtitleSliceEndpoint.bind(this));
         this.server.on('NotFound', function (req, res, err, next) {
             res.header("X-Instance-Id", _this.instanceId + "<".concat(version, ">"));
             return next();
@@ -410,6 +427,9 @@ var ChannelEngine = /** @class */ (function () {
                                             sessionId: channel.id,
                                             averageSegmentDuration: channel.options && channel.options.averageSegmentDuration ? channel.options.averageSegmentDuration : this.streamerOpts.defaultAverageSegmentDuration,
                                             useDemuxedAudio: options.useDemuxedAudio,
+                                            dummySubtitleEndpoint: this.dummySubtitleEndpoint,
+                                            subtitleSliceEndpoint: this.subtitleSliceEndpoint,
+                                            useVTTSubtitles: this.useVTTSubtitles,
                                             alwaysNewSegments: options.alwaysNewSegments,
                                             noSessionDataTags: options.noSessionDataTags,
                                             playheadDiffThreshold: channel.options && channel.options.playheadDiffThreshold ? channel.options.playheadDiffThreshold : this.streamerOpts.defaultPlayheadDiffThreshold,
@@ -419,6 +439,7 @@ var ChannelEngine = /** @class */ (function () {
                                             diffCompensationRate: channel.options && channel.options.diffCompensationRate ? channel.options.diffCompensationRate : this.streamerOpts.diffCompensationRate,
                                             profile: channel.profile,
                                             audioTracks: channel.audioTracks,
+                                            subtitleTracks: channel.subtitleTracks,
                                             closedCaptions: channel.closedCaptions,
                                             slateUri: channel.slate && channel.slate.uri ? channel.slate.uri : this.defaultSlateUri,
                                             slateRepetitions: channel.slate && channel.slate.repetitions ? channel.slate.repetitions : this.slateRepetitions,
@@ -428,6 +449,9 @@ var ChannelEngine = /** @class */ (function () {
                                         sessionsLive[channel.id] = new SessionLive({
                                             sessionId: channel.id,
                                             useDemuxedAudio: options.useDemuxedAudio,
+                                            dummySubtitleEndpoint: this.dummySubtitleEndpoint,
+                                            subtitleSliceEndpoint: this.subtitleSliceEndpoint,
+                                            useVTTSubtitles: this.useVTTSubtitles,
                                             cloudWatchMetrics: this.logCloudWatchMetrics,
                                             profile: channel.profile,
                                         }, this.sessionLiveStore);
@@ -741,6 +765,55 @@ var ChannelEngine = /** @class */ (function () {
             });
         });
     };
+    ChannelEngine.prototype.getSubtitleManifests = function (channelId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var allSubtitleM3U8_1, promises_3, session_3, addM3U8_3, subtitleGroupsAndLangs, _loop_2, _i, _a, _b, subtitleGroup, languages, err;
+            var _this = this;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!sessions[channelId]) return [3 /*break*/, 3];
+                        allSubtitleM3U8_1 = {};
+                        promises_3 = [];
+                        session_3 = sessions[channelId];
+                        addM3U8_3 = function (groupId, lang) { return __awaiter(_this, void 0, void 0, function () {
+                            var subtitleM3U8;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, session_3.getCurrentSubtitleManifestAsync(groupId, lang)];
+                                    case 1:
+                                        subtitleM3U8 = _a.sent();
+                                        if (!allSubtitleM3U8_1[groupId]) {
+                                            allSubtitleM3U8_1[groupId] = {};
+                                        }
+                                        allSubtitleM3U8_1[groupId][lang] = subtitleM3U8;
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); };
+                        return [4 /*yield*/, session_3.getSubtitleGroupsAndLangs()];
+                    case 1:
+                        subtitleGroupsAndLangs = _c.sent();
+                        _loop_2 = function (subtitleGroup, languages) {
+                            languages.forEach(function (lang) {
+                                promises_3.push(addM3U8_3(subtitleGroup, lang));
+                            });
+                        };
+                        for (_i = 0, _a = Object.entries(subtitleGroupsAndLangs); _i < _a.length; _i++) {
+                            _b = _a[_i], subtitleGroup = _b[0], languages = _b[1];
+                            _loop_2(subtitleGroup, languages);
+                        }
+                        return [4 /*yield*/, Promise.all(promises_3)];
+                    case 2:
+                        _c.sent();
+                        return [2 /*return*/, allSubtitleM3U8_1];
+                    case 3:
+                        err = new errs.NotFoundError('Invalid session');
+                        return [2 /*return*/, Promise.reject(err)];
+                }
+            });
+        });
+    };
     ChannelEngine.prototype._handleHeartbeat = function (req, res, next) {
         debug('req.url=' + req.url);
         res.send(200);
@@ -774,6 +847,9 @@ var ChannelEngine = /** @class */ (function () {
                         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;
@@ -879,9 +955,106 @@ var ChannelEngine = /** @class */ (function () {
             });
         });
     };
+    ChannelEngine.prototype._handleSubtitleManifest = function (req, res, next) {
+        return __awaiter(this, void 0, void 0, function () {
+            var session, body, err_6, err;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        debug("req.url=".concat(req.url));
+                        session = sessions[req.params[2]];
+                        if (!session) return [3 /*break*/, 5];
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, session.getCurrentSubtitleManifestAsync(req.params[0], req.params[1], req.headers["x-playback-session-id"])];
+                    case 2:
+                        body = _a.sent();
+                        res.sendRaw(200, Buffer.from(body, 'utf8'), {
+                            "Content-Type": "application/vnd.apple.mpegurl",
+                            "Access-Control-Allow-Origin": "*",
+                            "Cache-Control": "max-age=".concat(this.streamerOpts.cacheTTL || '4'),
+                            "X-Instance-Id": this.instanceId + "<".concat(version, ">"),
+                        });
+                        next();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        err_6 = _a.sent();
+                        next(this._gracefulErrorHandler(err_6));
+                        return [3 /*break*/, 4];
+                    case 4: return [3 /*break*/, 6];
+                    case 5:
+                        err = new errs.NotFoundError('Invalid session');
+                        next(err);
+                        _a.label = 6;
+                    case 6: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ChannelEngine.prototype._handleDummySubtitleEndpoint = function (req, res, next) {
+        return __awaiter(this, void 0, void 0, function () {
+            var session, body, err;
+            return __generator(this, function (_a) {
+                debug("req.url=".concat(req.url));
+                session = sessions[req.params.channelId];
+                if (session) {
+                    try {
+                        body = "WEBVTT";
+                        res.sendRaw(200, Buffer.from(body, 'utf8'), {
+                            "Content-Type": "application/vnd.apple.mpegurl",
+                            "Access-Control-Allow-Origin": "*",
+                            "Cache-Control": "max-age=".concat(this.streamerOpts.cacheTTL || '4'),
+                            "X-Instance-Id": this.instanceId + "<".concat(version, ">"),
+                        });
+                        next();
+                    }
+                    catch (err) {
+                        next(this._gracefulErrorHandler(err));
+                    }
+                }
+                else {
+                    err = new errs.NotFoundError('Invalid session');
+                    next(err);
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    ChannelEngine.prototype._handleSubtitleSliceEndpoint = function (req, res, next) {
+        return __awaiter(this, void 0, void 0, function () {
+            var slicer, body, err_7;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        debug("req.url=".concat(req.url));
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        slicer = new SubtitleSlicer();
+                        return [4 /*yield*/, slicer.generateVtt(req.query)];
+                    case 2:
+                        body = _a.sent();
+                        res.sendRaw(200, Buffer.from(body, 'utf8'), {
+                            "Content-Type": "application/vnd.apple.mpegurl",
+                            "Access-Control-Allow-Origin": "*",
+                            "Cache-Control": "max-age=".concat(this.streamerOpts.cacheTTL || '4'),
+                            "X-Instance-Id": this.instanceId + "<".concat(version, ">"),
+                        });
+                        next();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        err_7 = _a.sent();
+                        next(this._gracefulErrorHandler(err_7));
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
     ChannelEngine.prototype._handleMediaManifest = function (req, res, next) {
         return __awaiter(this, void 0, void 0, function () {
-            var session, sessionLive, body, err_6, err;
+            var session, sessionLive, body, err_8, err;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -933,8 +1106,8 @@ var ChannelEngine = /** @class */ (function () {
                         next();
                         return [3 /*break*/, 11];
                     case 10:
-                        err_6 = _a.sent();
-                        next(this._gracefulErrorHandler(err_6));
+                        err_8 = _a.sent();
+                        next(this._gracefulErrorHandler(err_8));
                         return [3 /*break*/, 11];
                     case 11: return [3 /*break*/, 13];
                     case 12:

package/dist/engine/session.d.ts

@@ -17,6 +17,9 @@ declare class Session {
     _events: any[];
     averageSegmentDuration: any;
     use_demuxed_audio: boolean;
+    use_vtt_subtitles: any;
+    dummySubtitleEndpoint: any;
+    subtitleSliceEndpoint: any;
     cloudWatchLogging: boolean;
     playheadDiffThreshold: any;
     maxTickInterval: any;
@@ -27,10 +30,12 @@ declare class Session {
     prevVodMediaSeq: {
         video: any;
         audio: any;
+        subtitle: any;
     };
     prevMediaSeqOffset: {
         video: any;
         audio: any;
+        subtitle: any;
     };
     waitingForNextVod: boolean;
     leaderIsSettingNextVod: boolean;
@@ -48,6 +53,7 @@ declare class Session {
     startWithId: any;
     _sessionProfile: any;
     _audioTracks: any;
+    _subtitleTracks: any;
     _closedCaptions: any;
     _noSessionDataTags: any;
     slateUri: any;
@@ -87,11 +93,13 @@ declare class Session {
     }>;
     getCurrentMediaManifestAsync(bw: any, playbackSessionId: any): Promise<any>;
     getCurrentAudioManifestAsync(audioGroupId: any, audioLanguage: any, playbackSessionId: any): Promise<any>;
+    getCurrentSubtitleManifestAsync(subtitleGroupId: any, subtitleLanguage: any): Promise<any>;
     incrementAsync(): Promise<any>;
     getMediaManifestAsync(bw: any, opts: any): Promise<any>;
     getAudioManifestAsync(audioGroupId: any, audioLanguage: any, opts: any): Promise<any>;
     getMasterManifestAsync(filter: any): Promise<string>;
     getAudioGroupsAndLangs(): Promise<{}>;
+    getSubtitleGroupsAndLangs(): Promise<{}>;
     consumeEvent(): any;
     produceEvent(event: any): void;
     hasPlayhead(): boolean;
@@ -106,6 +114,7 @@ declare class Session {
     _getCurrentDeltaTime(): Promise<any>;
     _getCurrentPlayheadPosition(): Promise<any>;
     _getAudioPlayheadPosition(seqIdx: any): Promise<any>;
+    _getSubtitlePlayheadPosition(seqIdx: any): Promise<any>;
     _getLastDuration(manifest: any): Promise<any>;
     _getPlayheadDiffCompensationValue(diffMs: any, thresholdMs: any): number;
 }