eyevinn-channel-engine 4.0.19 → 4.1.0

package/.github/workflows/nodejs.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
 
     steps:
     - uses: actions/checkout@v3

package/README.md

@@ -35,6 +35,7 @@ A live demo and example is available here: [https://vod2live.eyevinn.technology]
 - 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
+- Support for DRM encrypted HLS VODs (in beta)
 - And much more!
 
 ## System Requirements
@@ -45,7 +46,7 @@ Supported Node.js Versions
 | ------- | --------- |
 | 14.x    | Yes       |
 | 16.x    | Yes       |
-| 18.x    | No        |
+| 18.x    | Yes       |
 
 ## Supported Source Formats
 
@@ -97,14 +98,7 @@ Read [CONTRIBUTING](CONTRIBUTING.md) first and then follow the instructions belo
 
 ### Development
 
-Ensure that you are running node version 16 as version 18 is not supported yet.
-
-```
-node --version
-v16.17.0
-```
-
-Then install the dependencies:
+Install the dependencies:
 
 ```
 npm install
@@ -138,6 +132,7 @@ 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
 
 ### Source linking hls-vodtolive library
 

package/dist/engine/session.js

@@ -1403,7 +1403,7 @@ var Session = /** @class */ (function () {
                                             ",NAME=\"".concat(audioTrack.name, "\"") +
                                             ",AUTOSELECT=YES,DEFAULT=".concat(audioTrack.default ? 'YES' : 'NO') +
                                             ",CHANNELS=\"".concat(channels ? channels : 2, "\"") +
-                                            ",URI=\"master-".concat(audioGroupIdFileName, "_").concat(audioTrack.language, ".m3u8;session=").concat(this._sessionId, "\"") +
+                                            ",URI=\"master-".concat(audioGroupIdFileName, "_").concat(audioTrack.language, ".m3u8%3Bsession=").concat(this._sessionId, "\"") +
                                             "\n";
                                     }
                                 }
@@ -1433,7 +1433,7 @@ var Session = /** @class */ (function () {
                                             ',CODECS="' + profile.codecs + '"' +
                                             ",AUDIO=\"".concat(audioGroupIdToUse, "\"") +
                                             (hasClosedCaptions ? ',CLOSED-CAPTIONS="cc"' : '') + '\n';
-                                        m3u8 += "master" + profile.bw + ".m3u8;session=" + _this._sessionId + "\n";
+                                        m3u8 += "master" + profile.bw + ".m3u8%3Bsession=" + _this._sessionId + "\n";
                                     }
                                 }
                                 else {
@@ -1442,7 +1442,7 @@ var Session = /** @class */ (function () {
                                         ',CODECS="' + profile.codecs + '"' +
                                         (defaultAudioGroupId ? ",AUDIO=\"".concat(defaultAudioGroupId, "\"") : '') +
                                         (hasClosedCaptions ? ',CLOSED-CAPTIONS="cc"' : '') + '\n';
-                                    m3u8 += "master" + profile.bw + ".m3u8;session=" + _this._sessionId + "\n";
+                                    m3u8 += "master" + profile.bw + ".m3u8%3Bsession=" + _this._sessionId + "\n";
                                 }
                             });
                         }
@@ -1453,7 +1453,7 @@ var Session = /** @class */ (function () {
                                     ',CODECS="' + profile.codecs + '"' +
                                     (defaultAudioGroupId ? ",AUDIO=\"".concat(defaultAudioGroupId, "\"") : '') +
                                     (hasClosedCaptions ? ',CLOSED-CAPTIONS="cc"' : '') + '\n';
-                                m3u8 += "master" + profile.bw + ".m3u8;session=" + _this._sessionId + "\n";
+                                m3u8 += "master" + profile.bw + ".m3u8%3Bsession=" + _this._sessionId + "\n";
                             });
                         }
                         this.produceEvent({

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyevinn-channel-engine",
-  "version": "4.0.19",
+  "version": "4.1.0",
   "description": "OTT TV Channel Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,7 +14,7 @@
     "start-livemix": "node dist/server-livemix.js"
   },
   "engines": {
-    "node": "<18"
+    "node": ">=14 <20"
   },
   "author": "Eyevinn Technology AB <work@eyevinn.se>",
   "contributors": [
@@ -29,7 +29,7 @@
   "dependencies": {
     "@eyevinn/hls-repeat": "^0.2.0",
     "@eyevinn/hls-truncate": "^0.2.0",
-    "@eyevinn/hls-vodtolive": "^2.3.9",
+    "@eyevinn/hls-vodtolive": "^2.3.10",
     "@eyevinn/m3u8": "^0.5.3",
     "abort-controller": "^3.0.0",
     "debug": "^3.2.7",
@@ -39,7 +39,7 @@
     "promise.allsettled": "^1.0.4",
     "redis": "3.1.0",
     "request": ">=2.88.0",
-    "restify": "9.0.0",
+    "restify": "10.0.0",
     "restify-errors": "^8.0.2",
     "uuid": "^8.3.2"
   },

package/dist/server-drm.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/server-drm.js

@@ -0,0 +1,114 @@
+"use strict";
+/*
+ * Reference implementation of Channel Engine library using DRM (HLS+Widevine) VOD assets.
+ *
+ * Playback: https://shaka-player-demo.appspot.com/demo/#audiolang=sv-SE;textlang=sv-SE;uilang=sv-SE;asset=http://localhost:8000/channels/1/master.m3u8;license=https://cwip-shaka-proxy.appspot.com/no_auth;panel=CUSTOM%20CONTENT;build=uncompiled
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+var index_1 = require("./index");
+var RefAssetManager = /** @class */ (function () {
+    function RefAssetManager(opts) {
+        this.assets = {
+            1: [
+                {
+                    id: 1,
+                    title: "VINN DRM",
+                    uri: "https://testcontent.eyevinn.technology/vinn/multidrm/index.m3u8"
+                    // License server urL: https://widevine-dash.ezdrm.com/proxy?pX=1D331C
+                },
+                {
+                    id: 2,
+                    title: "VINN No DRM",
+                    uri: "https://testcontent.eyevinn.technology/vinn/cmaf/index.m3u8"
+                },
+                {
+                    id: 3,
+                    title: "CE Promo DRM",
+                    uri: "https://testcontent.eyevinn.technology/drm/CE-promo/index.m3u8"
+                    // License server urL: https://widevine-dash.ezdrm.com/proxy?pX=1D331C
+                },
+                {
+                    id: 4,
+                    title: "Eyevinn Reel DRM",
+                    uri: "https://testcontent.eyevinn.technology/drm/Eyevinn-Reel/index.m3u8"
+                    // License server urL: https://widevine-dash.ezdrm.com/proxy?pX=1D331C
+                }
+            ],
+        };
+        this.pos = {
+            1: 0,
+        };
+    }
+    /**
+     *
+     * @param {Object} vodRequest
+     *   {
+     *      sessionId,
+     *      category,
+     *      playlistId
+     *   }
+     */
+    RefAssetManager.prototype.getNextVod = function (vodRequest) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var channelId = vodRequest.playlistId;
+            if (_this.assets[channelId]) {
+                var vod = _this.assets[channelId][_this.pos[channelId]++];
+                if (_this.pos[channelId] > _this.assets[channelId].length - 1) {
+                    _this.pos[channelId] = 0;
+                }
+                resolve(vod);
+            }
+            else {
+                reject("Invalid channelId provided");
+            }
+        });
+    };
+    return RefAssetManager;
+}());
+var RefChannelManager = /** @class */ (function () {
+    function RefChannelManager() {
+    }
+    RefChannelManager.prototype.getChannels = function () {
+        return [{ id: "1", profile: this._getProfile(), audioTracks: this._getAudioTracks() }];
+    };
+    RefChannelManager.prototype._getProfile = function () {
+        return [
+            {
+                bw: 7934000,
+                codecs: "avc1.4d001f,mp4a.40.2",
+                resolution: [2880, 1440],
+            },
+            {
+                bw: 7514000,
+                codecs: "avc1.4d001f,mp4a.40.2",
+                resolution: [1920, 1080],
+            },
+            { bw: 7134000, codecs: "avc1.4d001f,mp4a.40.2", resolution: [1280, 720] },
+            { bw: 6134000, codecs: "avc1.4d001f,mp4a.40.2", resolution: [1024, 458] },
+            { bw: 2323000, codecs: "avc1.4d001f,mp4a.40.2", resolution: [640, 286] },
+            { bw: 495894, codecs: "avc1.4d001f,mp4a.40.2", resolution: [480, 214] },
+        ];
+    };
+    RefChannelManager.prototype._getAudioTracks = function () {
+        return [
+            { language: "en", name: "English" },
+        ];
+    };
+    return RefChannelManager;
+}());
+var refAssetManager = new RefAssetManager();
+var refChannelManager = new RefChannelManager();
+var engineOptions = {
+    heartbeat: "/",
+    averageSegmentDuration: 4000,
+    channelManager: refChannelManager,
+    defaultSlateUri: "https://maitv-vod.lab.eyevinn.technology/slate-consuo.mp4/master.m3u8",
+    slateRepetitions: 10,
+    redisUrl: process.env.REDIS_URL,
+    useDemuxedAudio: true,
+    alwaysNewSegments: true,
+};
+var engine = new index_1.ChannelEngine(refAssetManager, engineOptions);
+engine.start();
+engine.listen(process.env.PORT || 8000);

package/engine/session.js

@@ -983,7 +983,7 @@ class Session {
               `,NAME="${audioTrack.name}"` +
               `,AUTOSELECT=YES,DEFAULT=${audioTrack.default ? 'YES' : 'NO'}` +
               `,CHANNELS="${channels ? channels : 2}"` +
-              `,URI="master-${audioGroupIdFileName}_${audioTrack.language}.m3u8;session=${this._sessionId}"` +
+              `,URI="master-${audioGroupIdFileName}_${audioTrack.language}.m3u8%3Bsession=${this._sessionId}"` +
               "\n";
           }
         }
@@ -1015,7 +1015,7 @@ class Session {
               ',CODECS="' + profile.codecs + '"' + 
               `,AUDIO="${audioGroupIdToUse}"` + 
               (hasClosedCaptions ? ',CLOSED-CAPTIONS="cc"' : '') + '\n';
-            m3u8 += "master" + profile.bw + ".m3u8;session=" + this._sessionId + "\n";
+            m3u8 += "master" + profile.bw + ".m3u8%3Bsession=" + this._sessionId + "\n";
           }
         } else {
           m3u8 += '#EXT-X-STREAM-INF:BANDWIDTH=' + profile.bw + 
@@ -1023,7 +1023,7 @@ class Session {
             ',CODECS="' + profile.codecs + '"' + 
             (defaultAudioGroupId ? `,AUDIO="${defaultAudioGroupId}"` : '') + 
             (hasClosedCaptions ? ',CLOSED-CAPTIONS="cc"' : '') + '\n';
-          m3u8 += "master" + profile.bw + ".m3u8;session=" + this._sessionId + "\n";
+          m3u8 += "master" + profile.bw + ".m3u8%3Bsession=" + this._sessionId + "\n";
         }
       });
     } else {
@@ -1033,7 +1033,7 @@ class Session {
           ',CODECS="' + profile.codecs + '"' + 
           (defaultAudioGroupId ? `,AUDIO="${defaultAudioGroupId}"` : '') + 
           (hasClosedCaptions ? ',CLOSED-CAPTIONS="cc"' : '') + '\n';
-        m3u8 += "master" + profile.bw + ".m3u8;session=" + this._sessionId + "\n";
+        m3u8 += "master" + profile.bw + ".m3u8%3Bsession=" + this._sessionId + "\n";
       });
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyevinn-channel-engine",
-  "version": "4.0.19",
+  "version": "4.1.0",
   "description": "OTT TV Channel Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,7 +14,7 @@
     "start-livemix": "node dist/server-livemix.js"
   },
   "engines": {
-    "node": "<18"
+    "node": ">=14 <20"
   },
   "author": "Eyevinn Technology AB <work@eyevinn.se>",
   "contributors": [
@@ -29,7 +29,7 @@
   "dependencies": {
     "@eyevinn/hls-repeat": "^0.2.0",
     "@eyevinn/hls-truncate": "^0.2.0",
-    "@eyevinn/hls-vodtolive": "^2.3.9",
+    "@eyevinn/hls-vodtolive": "^2.3.10",
     "@eyevinn/m3u8": "^0.5.3",
     "abort-controller": "^3.0.0",
     "debug": "^3.2.7",
@@ -39,7 +39,7 @@
     "promise.allsettled": "^1.0.4",
     "redis": "3.1.0",
     "request": ">=2.88.0",
-    "restify": "9.0.0",
+    "restify": "10.0.0",
     "restify-errors": "^8.0.2",
     "uuid": "^8.3.2"
   },

package/server-drm.ts

@@ -0,0 +1,126 @@
+/*
+ * Reference implementation of Channel Engine library using DRM (HLS+Widevine) VOD assets.
+ *
+ * Playback: https://shaka-player-demo.appspot.com/demo/#audiolang=sv-SE;textlang=sv-SE;uilang=sv-SE;asset=http://localhost:8000/channels/1/master.m3u8;license=https://cwip-shaka-proxy.appspot.com/no_auth;panel=CUSTOM%20CONTENT;build=uncompiled
+ */
+
+import {
+  ChannelEngine,
+  ChannelEngineOpts,
+  IAssetManager,
+  IChannelManager,
+  VodRequest,
+  VodResponse,
+  Channel,
+  ChannelProfile,
+  AudioTracks,
+} from "./index";
+
+class RefAssetManager implements IAssetManager {
+  private assets;
+  private pos;
+  constructor(opts?) {
+    this.assets = {
+      1: [
+        {
+          id: 1,
+          title: "VINN DRM",
+          uri: "https://testcontent.eyevinn.technology/vinn/multidrm/index.m3u8"
+          // License server urL: https://widevine-dash.ezdrm.com/proxy?pX=1D331C
+        },
+        {
+          id: 2,
+          title: "VINN No DRM",
+          uri: "https://testcontent.eyevinn.technology/vinn/cmaf/index.m3u8"
+        },
+        {
+          id: 3,
+          title: "CE Promo DRM",
+          uri: "https://testcontent.eyevinn.technology/drm/CE-promo/index.m3u8"
+          // License server urL: https://widevine-dash.ezdrm.com/proxy?pX=1D331C
+        },
+        {
+          id: 4,
+          title: "Eyevinn Reel DRM",
+          uri: "https://testcontent.eyevinn.technology/drm/Eyevinn-Reel/index.m3u8"
+          // License server urL: https://widevine-dash.ezdrm.com/proxy?pX=1D331C
+        }
+      ],
+    };
+    this.pos = {
+      1: 0,
+    };
+  }
+
+  /**
+   *
+   * @param {Object} vodRequest
+   *   {
+   *      sessionId,
+   *      category,
+   *      playlistId
+   *   }
+   */
+  getNextVod(vodRequest: VodRequest): Promise<VodResponse> {
+    return new Promise((resolve, reject) => {
+      const channelId = vodRequest.playlistId;
+      if (this.assets[channelId]) {
+        let vod: VodResponse = this.assets[channelId][this.pos[channelId]++];
+        if (this.pos[channelId] > this.assets[channelId].length - 1) {
+          this.pos[channelId] = 0;
+        }
+        resolve(vod);
+      } else {
+        reject("Invalid channelId provided");
+      }
+    });
+  }
+}
+
+class RefChannelManager implements IChannelManager {
+  getChannels(): Channel[] {
+    return [{ id: "1", profile: this._getProfile(), audioTracks: this._getAudioTracks() }];
+  }
+
+  _getProfile(): ChannelProfile[] {
+    return [
+      {
+        bw: 7934000,
+        codecs: "avc1.4d001f,mp4a.40.2",
+        resolution: [2880, 1440],
+      },
+      {
+        bw: 7514000,
+        codecs: "avc1.4d001f,mp4a.40.2",
+        resolution: [1920, 1080],
+      },
+      { bw: 7134000, codecs: "avc1.4d001f,mp4a.40.2", resolution: [1280, 720] },
+      { bw: 6134000, codecs: "avc1.4d001f,mp4a.40.2", resolution: [1024, 458] },
+      { bw: 2323000, codecs: "avc1.4d001f,mp4a.40.2", resolution: [640, 286] },
+      { bw: 495894, codecs: "avc1.4d001f,mp4a.40.2", resolution: [480, 214] },
+    ];
+  }
+  _getAudioTracks(): AudioTracks[] {
+    return [
+      { language: "en", name: "English" },
+    ];
+  }
+}
+
+const refAssetManager = new RefAssetManager();
+const refChannelManager = new RefChannelManager();
+
+const engineOptions: ChannelEngineOpts = {
+  heartbeat: "/",
+  averageSegmentDuration: 4000,
+  channelManager: refChannelManager,
+  defaultSlateUri: "https://maitv-vod.lab.eyevinn.technology/slate-consuo.mp4/master.m3u8",
+  slateRepetitions: 10,
+  redisUrl: process.env.REDIS_URL,
+  useDemuxedAudio: true,
+  alwaysNewSegments: true,
+};
+
+const engine = new ChannelEngine(refAssetManager, engineOptions);
+engine.start();
+engine.listen(process.env.PORT || 8000);

package/tsconfig.json

@@ -6,5 +6,12 @@
     "esModuleInterop": true,
     "declaration": true
   },
-  "include": ["./server.ts", "./server-demux.ts", "./server-livemix.ts", "./server-multicodec.ts", "./engine/**/*"]
+  "include": [
+    "./server.ts", 
+    "./server-demux.ts", 
+    "./server-livemix.ts", 
+    "./server-multicodec.ts", 
+    "./server-drm.ts", 
+    "./engine/**/*"
+  ]
 }