eyevinn-channel-engine 4.0.0-rc.0 → 4.0.0

package/README.md

@@ -1,5 +1,5 @@
 # Eyevinn Channel Engine
-> *Open Source FAST Channel Engine based on VOD2Live technology*
+> *Open Source FAST Channel Engine library based on VOD2Live technology*
 
 [![Slack](http://slack.streamingtech.se/badge.svg)](http://slack.streamingtech.se)
 
@@ -29,12 +29,36 @@ Supported Node.js Versions
 | 16.x    | Yes       |
 | 18.x    | No        |
 
+## Supported Source Formats
+
+| HLS Format | Muxed | Demuxed | Mix w. Live | Subtitles | DRM |
+| ---------- | ----- | ------- | ----------- | --------- | --- |
+| HLS + TS   | Yes   | Yes     | Yes*        | TBD       | No  |
+| HLS + CMAF | No    | Yes     | TBD         | TBD       | TBD |
+
+*\* not supported with demuxed sources*
+
 ## Usage
 
 Follow [this tutorial](https://vod2live.docs.eyevinn.technology/getting-started.html) to get started building your own FAST channel engine.
 
+You can also use prebuilt [Eyevinn FAST Engine Docker Container](https://github.com/Eyevinn/docker-fast) based on this library. To try it out you can start an instance with 50 demo channels by running this command:
+
+```
+docker run -d -p 8000:8000 -p 8001:8001 \
+  -e DEMO_NUM_CHANNELS=50 \
+  eyevinntechnology/fast-engine
+```
+
+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.
+
 ## Migration
 
+### 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
+and this means that it is not possible to mix muxed TS with demuxed CMAF.
+
 ### Upgrading from 3.3.x to >= 3.4.x
 
 A breaking change was introduced in v3.4.0 when Typescript types were introduced. The library no longer exports a default. This means that you need to change `const ChannelEngine = require('eyevinn-channel-engine')` to `const { ChannelEngine } = require('eyevinn-channel-engine')`;

package/dist/engine/chaos_monkey.js

@@ -13,7 +13,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        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]) {

package/dist/engine/memcached_state_store.js

@@ -13,7 +13,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        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]) {

package/dist/engine/memory_state_store.js

@@ -13,7 +13,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        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]) {

package/dist/engine/playhead_state.d.ts

@@ -13,14 +13,14 @@ declare class SharedPlayheadState {
     constructor(store: any, sessionId: any, opts: any);
     sessionId: any;
     store: any;
-    state: number;
+    state: 4;
     lastM3u8: any;
     get(key: any): Promise<any>;
-    getState(): Promise<number>;
+    getState(): Promise<4>;
     getLastM3u8(): Promise<any>;
     getValues(keys: any): Promise<any>;
     set(key: any, value: any): Promise<any>;
-    setState(newState: any): Promise<number>;
+    setState(newState: any): Promise<4>;
     setLastM3u8(m3u8: any): Promise<any>;
 }
 export {};

package/dist/engine/playhead_state.js

@@ -28,7 +28,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        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]) {

package/dist/engine/redis_state_store.js

@@ -13,7 +13,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        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]) {

package/dist/engine/server.d.ts

@@ -39,6 +39,7 @@ export interface VodTimedMetadata {
     'class': string;
 }
 export interface VodResponse {
+    title: any;
     id: string;
     uri: string;
     offset?: number;

package/dist/engine/server.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        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]) {

package/dist/engine/session.d.ts

@@ -86,7 +86,7 @@ declare class Session {
     }>;
     getCurrentMediaManifestAsync(bw: any, playbackSessionId: any): Promise<any>;
     getCurrentAudioManifestAsync(audioGroupId: any, audioLanguage: any, playbackSessionId: any): Promise<any>;
-    incrementAsync(): Promise<any>;
+    incrementAsync(incOpts: any): Promise<any>;
     getMediaManifestAsync(bw: any, opts: any): Promise<any>;
     getAudioManifestAsync(audioGroupId: any, audioLanguage: any, opts: any): Promise<any>;
     getMasterManifestAsync(filter: any): Promise<string>;
@@ -104,6 +104,7 @@ declare class Session {
     _getFirstDuration(manifest: any): Promise<any>;
     _getCurrentDeltaTime(): Promise<any>;
     _getCurrentPlayheadPosition(): Promise<any>;
+    _getAudioPlayheadPosition(seqIdx: any): Promise<any>;
     _getLastDuration(manifest: any): Promise<any>;
     _getPlayheadDiffCompesationValue(diffMs: any, thresholdMs: any): number;
 }