eyevinn-channel-engine 5.0.0-rc.8 → 5.0.0

package/README.md

@@ -32,17 +32,18 @@ Please see the [Documentation](https://vod2live.docs.eyevinn.technology) for int
 
 ![Screenshot of demo site](docs/demosite.png)
 
-A live demo and example is available here: [https://vod2live.eyevinn.technology](https://vod2live.eyevinn.technology)
-
 ## Features
 
 - Produce 24/7 HLS live channels based on already transcoded HLS VODs
 - Produce a personalized 24/7 HLS live channel unique for each viewer
 - Mix VOD2Live channel with a "real" live HLS stream
 - Develop adapters to plugin with custom scheduling endpoints
-- High Availability with Redis Cache as shared state store
+- High Availability with Redis Cache or Valkey as shared state store
 - Support for WebVTT subtitles
 - Support for DRM encrypted HLS VODs (in beta)
+- Improved performance with Redis connection pooling and pipelining
+- Enhanced stability in High Availability mode
+- Support for livemix with demuxed content (TS and CMAF)
 - And much more!
 
 ## System Requirements
@@ -57,24 +58,34 @@ Supported Node.js Versions
 
 ## Supported Source Formats
 
-| HLS Format | Muxed | Demuxed | Mix w. Live | Subtitles | DRM |
-| ---------- | ----- | ------- | ----------- | --------- | --- |
-| HLS + TS   | Yes   | Yes     | Yes*        | Yes       | No  |
-| HLS + CMAF | No    | Yes     | TBD         | Yes       | TBD |
+| HLS Format | Muxed | Demuxed | Mix w. Live | Subtitles | Mix w. Live & Subtitles | DRM |
+| ---------- | ----- | ------- | ----------- | --------- | ----------------------- | --- |
+| HLS + TS   | Yes   | Yes     | Yes         | Yes       | No                      | No  |
+| HLS + CMAF | Yes   | Yes     | Yes         | Yes       | No                      | No  |
 
-*\* not supported with demuxed sources*
+NOTE: The engine does not support subtitles in the live-mix + demux setting. Furthermore, then using the live-mix + demux setting, it is most optimal to use HLS content which has the same segment durations on all variants.
+Using a mix of different segment durations may result in occasional playback/audio sync issues, but not always. Further development will be needed to resolve this and improve the robustness of the live-mix + demux experience.
 
 ## High Availability Support
 
-[High availability support](https://vod2live.docs.eyevinn.technology/usage-guide.html#high-availability) is from v3 general available in the Channel Engine and it uses Redis as the shared storage. This allows you to run a replicaset behind a round-robin load balancer. Supported Redis Engine versions:
+[High availability support](https://vod2live.docs.eyevinn.technology/usage-guide.html#high-availability) is available in the Channel Engine and it uses Redis or Valkey as the shared storage. This allows you to run a replicaset behind a round-robin load balancer. 
+
+Supported Redis/Valkey Engine versions:
 
 | Version | Supported | 
 | ------- | --------- |
 | 5.x     | Yes       |
 | 6.x     | Yes       |
-| 7.x    | No        |
+| 7.x     | No        |
+
+### Redis/Valkey Configuration
+
+You can adjust Redis/Valkey connection pool size using the environment variable:
+```
+REDIS_POOL_SIZE=15  # Default is 15
+```
 
-## Usage
+## Usage (Docker)
 
 Follow [this tutorial](https://vod2live.docs.eyevinn.technology/getting-started.html) to get started building your own FAST channel engine.
 
@@ -88,8 +99,53 @@ docker run -d -p 8000:8000 -p 8001:8001 \
 
 Open the URL http://localhost:8001/ in your browser for a multiview of all 50 channels, and to playback one of the 50 channels point your HLS video player to the URL: http://localhost:8000/channels/<N>/master.m3u8 where <N> is a number between 1 and 50.
 
+## Usage (Eyevinn Open Source Cloud)
+
+Available as an open web service in [Eyevinn Open Source Cloud (OSC)](https://www.osaas.io).
+
+1. Sign up for an [OSC account](https://www.osaas.io)
+2. Get the personal access token in the web console (Settings/API)
+3. Store it in the environment variable `OSC_ACCESS_TOKEN` in your shell
+
+```bash
+% export OSC_ACCESS_TOKEN=<personal-access-token>
+```
+
+4. Launch a channel called `guide` using the OSC command line tool.
+
+```bash
+% npx -y @osaas/cli create channel-engine guide \
+  -o type=Loop \
+  -o url=https://lab.cdn.eyevinn.technology/osc/osc-reel/a4e1156e-f872-455f-9f1f-be73b5effba8/index.m3u8
+Instance created:
+{
+  id: 'eyevinnlab-guide',
+  name: 'guide',
+  type: 'Loop',
+  url: 'https://lab.cdn.eyevinn.technology/osc/osc-reel/a4e1156e-f872-455f-9f1f-be73b5effba8/index.m3u8',
+  playback: 'https://eyevinnlab.ce.prod.osaas.io/channels/guide/master.m3u8'
+}  
+```
+
+This will create a linear channel by looping the Open Source Cloud demo reel video. Channel is available for playback on URL https://eyevinnlab.ce.prod.osaas.io/channels/guide/master.m3u8 in this case.
+
 ## Migration
 
+### Upgrading from 4.x to >= 5.0.0
+
+Version 5.0.0 introduces several significant improvements:
+
+- **Web Framework Change**: Replaced Restify with Fastify for improved performance
+- **Redis Improvements**: Added connection pooling and pipelining for better performance
+- **Livemix Enhancements**: Support for demuxed content in both TS and CMAF formats
+- **Stability Improvements**: Better handling of alignment in High Availability mode
+- **Manifest Format Options**: Added option to disable legacy master manifest format
+
+To migrate:
+1. If you've extended the server functionality, you'll need to update your code to use Fastify instead of Restify
+2. Review the new Redis pooling configuration options
+3. Test your application thoroughly, especially if using High Availability mode
+
 ### Upgrading from 3.4.x to >= 4.0.0
 
 Support for HLS-CMAF and handling audio and video segments of different durations was added to v4
@@ -137,7 +193,7 @@ DEBUG=engine-* npm start
 
 In addition there other reference implemetations that can be used:
 - `examples/demux.ts` : example with demuxed audio
-- `examples/livemix.ts` : example with live mimxing
+- `examples/livemix.ts` : example with live mixing
 - `examples/multicodec.ts` : example with multicodec
 - `examples/drm.ts` : example with DRM
 - `examples/autocreate.ts` : example to auto create channel on demand
@@ -169,5 +225,4 @@ Join our [community on Slack](http://slack.streamingtech.se) where you can post
 
 [Eyevinn Technology](https://www.eyevinntechnology.se) is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in [blogs](https://dev.to/video) and by open sourcing the code we have written.
 
-Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!
-
+Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se! 

package/dist/engine/preflight.d.ts

@@ -1 +1 @@
-export function handler(req: any, res: any, next: any): any;
+export function handler(req: any, res: any): Promise<void>;

package/dist/engine/preflight.js

@@ -1,3 +1,39 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 var constants = {
     ALLOW_HEADERS: [
         'accept',
@@ -30,14 +66,19 @@ var constants = {
     STR_ORIGIN: 'origin',
     HTTP_NO_CONTENT: 204
 };
-exports.handler = function (req, res, next) {
-    if (req.method !== 'OPTIONS')
-        return next();
-    res.once('header', function () {
-        res.header(constants.AC_ALLOW_ORIGIN, '*');
-        res.header(constants.AC_ALLOW_CREDS, true);
-        res.header(constants.AC_ALLOW_METHODS, ['GET', 'OPTIONS']);
-        res.header(constants.AC_ALLOW_HEADERS, ['x-health-key']);
+module.exports.handler = function (req, res) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (req.method !== 'OPTIONS')
+                return [2 /*return*/];
+            res
+                .header(constants.AC_ALLOW_ORIGIN, '*')
+                .header(constants.AC_ALLOW_CREDS, 'true')
+                .header(constants.AC_ALLOW_METHODS, 'GET, OPTIONS')
+                .header(constants.AC_ALLOW_HEADERS, 'x-health-key')
+                .status(204)
+                .send();
+            return [2 /*return*/];
+        });
     });
-    res.send(constants.HTTP_NO_CONTENT);
 };

package/dist/engine/redis_state_store.d.ts

@@ -5,7 +5,7 @@ declare class RedisStateStore {
     volatileKeyTTL: any;
     pool: any[];
     createRedisPool(size: any, redisUrl: any): any[];
-    getClientFromPool(): any;
+    getClientFromPool(maxWaitTime?: number): Promise<any>;
     returnClientToPool(client: any): void;
     initAsync(id: any, initData: any): Promise<{}>;
     resetAsync(id: any, initData: any): Promise<void>;

package/dist/engine/redis_state_store.js

@@ -36,13 +36,14 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 var Redis = require("ioredis");
 var debug = require("debug")("redis-state-store");
-var cloudWatchLog = require("./util.js").cloudWatchLog;
+var _a = require("./util.js"), cloudWatchLog = _a.cloudWatchLog, timer = _a.timer;
 var DEFAULT_VOLATILE_KEY_TTL = 5; // Timeout so it should not expire within one normal increment iteration (in seconds)
 function isTrue(s) {
     var regex = /^\s*(true|1)\s*$/i;
     return regex.test(s);
 }
 var REDIS_VERBOSE_LOG = process.env.REDIS_VERBOSE_LOG ? isTrue(process.env.REDIS_VERBOSE_LOG) : false;
+var REDIS_POOL_SIZE = process.env.REDIS_POOL_SIZE ? parseInt(process.env.REDIS_POOL_SIZE) : 15;
 var RedisStateStore = /** @class */ (function () {
     function RedisStateStore(keyPrefix, opts) {
         this.keyPrefix = keyPrefix;
@@ -56,7 +57,7 @@ var RedisStateStore = /** @class */ (function () {
             debug("Overriding default, volatileKeyTTL=".concat(opts.volatileKeyTTL, "s"));
             this.volatileKeyTTL = opts.volatileKeyTTL;
         }
-        this.pool = this.createRedisPool(10, opts.redisUrl);
+        this.pool = this.createRedisPool(REDIS_POOL_SIZE, opts.redisUrl);
     }
     RedisStateStore.prototype.createRedisPool = function (size, redisUrl) {
         var pool = [];
@@ -66,8 +67,28 @@ var RedisStateStore = /** @class */ (function () {
         }
         return pool;
     };
-    RedisStateStore.prototype.getClientFromPool = function () {
-        return this.pool.pop();
+    RedisStateStore.prototype.getClientFromPool = function (maxWaitTime) {
+        if (maxWaitTime === void 0) { maxWaitTime = 5000; }
+        return __awaiter(this, void 0, void 0, function () {
+            var startTime;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        startTime = Date.now();
+                        _a.label = 1;
+                    case 1:
+                        if (!(this.pool.length === 0)) return [3 /*break*/, 3];
+                        if (Date.now() - startTime > maxWaitTime) {
+                            console.error("[!] Timeout: No available Redis clients in the pool");
+                        }
+                        return [4 /*yield*/, timer(100)];
+                    case 2:
+                        _a.sent();
+                        return [3 /*break*/, 1];
+                    case 3: return [2 /*return*/, this.pool.pop()];
+                }
+            });
+        });
     };
     RedisStateStore.prototype.returnClientToPool = function (client) {
         this.pool.push(client);
@@ -132,24 +153,25 @@ var RedisStateStore = /** @class */ (function () {
             var client, err_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        client = this.getClientFromPool();
-                        _a.label = 1;
+                    case 0: return [4 /*yield*/, this.getClientFromPool()];
                     case 1:
-                        _a.trys.push([1, 3, 4, 5]);
-                        return [4 /*yield*/, client.flushall()];
+                        client = _a.sent();
+                        _a.label = 2;
                     case 2:
+                        _a.trys.push([2, 4, 5, 6]);
+                        return [4 /*yield*/, client.flushall()];
+                    case 3:
                         _a.sent();
                         console.log("Flushed Redis db");
-                        return [3 /*break*/, 5];
-                    case 3:
+                        return [3 /*break*/, 6];
+                    case 4:
                         err_1 = _a.sent();
                         console.error("Error flushing Redis db:", err_1);
-                        return [3 /*break*/, 5];
-                    case 4:
+                        return [3 /*break*/, 6];
+                    case 5:
                         this.returnClientToPool(client);
                         return [7 /*endfinally*/];
-                    case 5: return [2 /*return*/];
+                    case 6: return [2 /*return*/];
                 }
             });
         });
@@ -160,8 +182,9 @@ var RedisStateStore = /** @class */ (function () {
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        client = this.getClientFromPool();
+                    case 0: return [4 /*yield*/, this.getClientFromPool()];
+                    case 1:
+                        client = _a.sent();
                         pipeline = client.pipeline();
                         data = {};
                         startMs = Date.now();
@@ -171,7 +194,7 @@ var RedisStateStore = /** @class */ (function () {
                             pipeline.get(storeKey);
                         }
                         return [4 /*yield*/, pipeline.exec()];
-                    case 1:
+                    case 2:
                         results = _a.sent();
                         ops = pipeline.length;
                         results.forEach(function (result, index) {
@@ -200,12 +223,13 @@ var RedisStateStore = /** @class */ (function () {
             var client, startMs, storeKey, reply, ioTimeMs;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        client = this.getClientFromPool();
+                    case 0: return [4 /*yield*/, this.getClientFromPool()];
+                    case 1:
+                        client = _a.sent();
                         startMs = Date.now();
                         storeKey = "".concat(this.keyPrefix).concat(id).concat(key);
                         return [4 /*yield*/, client.get(storeKey)];
-                    case 1:
+                    case 2:
                         reply = _a.sent();
                         ioTimeMs = Date.now() - startMs;
                         debug("REDIS get ".concat(storeKey, ":").concat(reply ? reply.length + " chars" : "null", " (").concat(ioTimeMs, "ms) ").concat(ioTimeMs > 1000 ? "REDISSLOW!" : ""));
@@ -230,8 +254,9 @@ var RedisStateStore = /** @class */ (function () {
             var _this = this;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0:
-                        client = this.getClientFromPool();
+                    case 0: return [4 /*yield*/, this.getClientFromPool()];
+                    case 1:
+                        client = _b.sent();
                         returnData = {};
                         startMs = Date.now();
                         pipeline = client.pipeline();
@@ -242,7 +267,7 @@ var RedisStateStore = /** @class */ (function () {
                             pipeline.set(storeKey, JSON.stringify(value));
                         }
                         return [4 /*yield*/, pipeline.exec()];
-                    case 1:
+                    case 2:
                         results = _b.sent();
                         ops = pipeline.length;
                         results.forEach(function (result, index) {
@@ -263,12 +288,13 @@ var RedisStateStore = /** @class */ (function () {
             var client, startMs, storeKey, res, ioTimeMs;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        client = this.getClientFromPool();
+                    case 0: return [4 /*yield*/, this.getClientFromPool()];
+                    case 1:
+                        client = _a.sent();
                         startMs = Date.now();
                         storeKey = "".concat(this.keyPrefix).concat(id).concat(key);
                         return [4 /*yield*/, client.set(storeKey, JSON.stringify(value))];
-                    case 1:
+                    case 2:
                         res = _a.sent();
                         ioTimeMs = Date.now() - startMs;
                         debug("REDIS set ".concat(storeKey, ": ").concat(res, " (").concat(ioTimeMs, "ms) ").concat(ioTimeMs > 1000 ? "REDISSLOW!" : ""));
@@ -288,9 +314,11 @@ var RedisStateStore = /** @class */ (function () {
                     case 1:
                         data = _a.sent();
                         storeKey = "".concat(this.keyPrefix).concat(id).concat(key);
-                        client = this.getClientFromPool();
-                        return [4 /*yield*/, client.expire(storeKey, this.volatileKeyTTL)];
+                        return [4 /*yield*/, this.getClientFromPool()];
                     case 2:
+                        client = _a.sent();
+                        return [4 /*yield*/, client.expire(storeKey, this.volatileKeyTTL)];
+                    case 3:
                         _a.sent();
                         debug("REDIS expire ".concat(storeKey, " ").concat(this.volatileKeyTTL, "s"));
                         this.returnClientToPool(client);
@@ -304,12 +332,13 @@ var RedisStateStore = /** @class */ (function () {
             var client, startMs, storeKey, res, ioTimeMs;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        client = this.getClientFromPool();
+                    case 0: return [4 /*yield*/, this.getClientFromPool()];
+                    case 1:
+                        client = _a.sent();
                         startMs = Date.now();
                         storeKey = "".concat(this.keyPrefix).concat(id).concat(key);
                         return [4 /*yield*/, client.del(storeKey)];
-                    case 1:
+                    case 2:
                         res = _a.sent();
                         ioTimeMs = Date.now() - startMs;
                         debug("REDIS remove ".concat(storeKey, ": (").concat(ioTimeMs, "ms) ").concat(ioTimeMs > 1000 ? "REDISSLOW!" : ""));

package/dist/engine/server.d.ts

@@ -169,19 +169,19 @@ export declare class ChannelEngine {
     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>;
-    _handleMediaManifest(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>;
-    _handleEventStream(req: any, res: any, next: any): void;
-    _handleStatus(req: any, res: any, next: any): Promise<void>;
-    _handleAggregatedSessionHealth(req: any, res: any, next: any): Promise<void>;
-    _handleSessionHealth(req: any, res: any, next: any): Promise<void>;
-    _handleSessionsReset(req: any, res: any, next: any): Promise<void>;
-    _handleSessionReset(req: any, res: any, next: any): Promise<void>;
-    _gracefulErrorHandler(errMsg: any): any;
-    _errorHandler(errMsg: any): any;
+    _handleHeartbeat(request: any, reply: any): void;
+    _handleMasterManifest(request: any, reply: any): Promise<void>;
+    _handleAudioManifest(request: any, reply: any): Promise<void>;
+    _handleSubtitleManifest(request: any, reply: any): Promise<void>;
+    _handleDummySubtitleEndpoint(request: any, reply: any): Promise<void>;
+    _handleSubtitleSliceEndpoint(request: any, reply: any): Promise<void>;
+    _handleMediaManifest(request: any, reply: any): Promise<void>;
+    _handleEventStream(request: any, reply: any): Promise<void>;
+    _handleStatus(request: any, reply: any): Promise<void>;
+    _handleAggregatedSessionHealth(request: any, reply: any): Promise<void>;
+    _handleSessionHealth(request: any, reply: any): Promise<void>;
+    _handleSessionsReset(request: any, reply: any): Promise<void>;
+    _handleSessionReset(request: any, reply: any): Promise<void>;
+    _gracefulErrorHandler(errMsg: any): Error;
+    _errorHandler(errMsg: any): Error;
 }