@eluvio/elv-client-js 4.0.113 → 4.0.115

package/dist/src/client/LiveConf.js

@@ -0,0 +1,569 @@
+var _defineProperty = require("@babel/runtime/helpers/defineProperty");
+var _classCallCheck = require("@babel/runtime/helpers/classCallCheck");
+var _createClass = require("@babel/runtime/helpers/createClass");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+/* eslint no-console: 0 */
+
+var DefaultABRLadder = {
+  "video": [{
+    bit_rate: 14000000,
+    codecs: "avc1.640028,mp4a.40.2",
+    height: 2160,
+    width: 3840
+  }, {
+    bit_rate: 9500000,
+    codecs: "avc1.640028,mp4a.40.2",
+    height: 1080,
+    width: 1920
+  }, {
+    bit_rate: 4500000,
+    codecs: "avc1.640028,mp4a.40.2",
+    height: 720,
+    width: 1280
+  }, {
+    bit_rate: 2000000,
+    codecs: "avc1.640028,mp4a.40.2",
+    height: 540,
+    width: 960
+  }, {
+    bit_rate: 900000,
+    codecs: "avc1.640028,mp4a.40.2",
+    height: 540,
+    width: 960
+  }],
+  "audio": [{
+    bit_rate: 192000,
+    channels: 2,
+    codecs: "mp4a.40.2"
+  }, {
+    bit_rate: 384000,
+    channels: 6,
+    codecs: "mp4a.40.2"
+  }]
+};
+var LiveconfTemplate = {
+  live_recording: {
+    fabric_config: {
+      ingress_node_api: "",
+      ingress_node_id: ""
+    },
+    playout_config: {
+      dvr_enabled: true,
+      dvr_max_duration: 0,
+      rebroadcast_start_time_sec_epoch: 0,
+      vod_enabled: false
+    },
+    recording_config: {
+      recording_params: {
+        description: "",
+        ladder_specs: [],
+        listen: true,
+        live_delay_nano: 2000000000,
+        max_duration_sec: -1,
+        name: "",
+        origin_url: "",
+        part_ttl: 3600,
+        playout_type: "live",
+        source_timescale: null,
+        reconnect_timeout: 600,
+        xc_params: {
+          audio_bitrate: 384000,
+          audio_index: [0, 0, 0, 0, 0, 0, 0, 0],
+          audio_seg_duration_ts: null,
+          connection_timeout: 600,
+          ecodec2: "aac",
+          enc_height: null,
+          enc_width: null,
+          filter_descriptor: "",
+          force_keyint: null,
+          format: "fmp4-segment",
+          listen: true,
+          n_audio: 1,
+          preset: "faster",
+          sample_rate: 48000,
+          seg_duration: null,
+          skip_decoding: false,
+          start_segment_str: "1",
+          stream_id: -1,
+          sync_audio_to_stream_id: -1,
+          video_bitrate: null,
+          video_seg_duration_ts: null,
+          video_time_base: null,
+          video_frame_duration_ts: null,
+          xc_type: 3
+        }
+      }
+    }
+  }
+};
+var LiveConf = /*#__PURE__*/function () {
+  "use strict";
+
+  function LiveConf(probeData, nodeId, nodeUrl, includeAVSegDurations, overwriteOriginUrl, syncAudioToVideo) {
+    _classCallCheck(this, LiveConf);
+    this.probeData = probeData;
+    this.nodeId = nodeId;
+    this.nodeUrl = nodeUrl;
+    this.includeAVSegDurations = includeAVSegDurations;
+    this.overwriteOriginUrl = overwriteOriginUrl;
+    this.syncAudioToVideo = syncAudioToVideo;
+  }
+  _createClass(LiveConf, [{
+    key: "probeKind",
+    value: function probeKind() {
+      var fileNameSplit = this.probeData.format.filename.split(":");
+      return fileNameSplit[0];
+    }
+  }, {
+    key: "getStreamDataForCodecType",
+    value: function getStreamDataForCodecType(codecType) {
+      var stream = null;
+      for (var index = 0; index < this.probeData.streams.length; index++) {
+        if (this.probeData.streams[index].codec_type == codecType) {
+          stream = this.probeData.streams[index];
+        }
+      }
+      return stream;
+    }
+
+    // Return all audio streams found in the probe
+    // Used by generateAudioStreamsConfig()
+  }, {
+    key: "getAudioStreamsFromProbe",
+    value: function getAudioStreamsFromProbe() {
+      var audioStreams = {};
+      for (var index = 0; index < this.probeData.streams.length; index++) {
+        if (this.probeData.streams[index].codec_type == "audio") {
+          audioStreams[index] = {
+            recordingBitrate: Math.max(this.probeData.streams[index].bit_rate, 128000),
+            recordingChannels: this.probeData.streams[index].channels,
+            playoutLabel: "Audio ".concat(index)
+          };
+        }
+      }
+      return audioStreams;
+    }
+  }, {
+    key: "getFrameRate",
+    value: function getFrameRate() {
+      var videoStream = this.getStreamDataForCodecType("video");
+      var frameRate = videoStream.r_frame_rate || videoStream.frame_rate;
+      return frameRate.split("/");
+    }
+  }, {
+    key: "isFrameRateWhole",
+    value: function isFrameRateWhole() {
+      var frameRate = this.getFrameRate();
+      return frameRate[1] == "1";
+    }
+  }, {
+    key: "getForceKeyint",
+    value: function getForceKeyint() {
+      var frameRate = this.getFrameRate();
+      var roundedFrameRate = Math.round(frameRate[0] / frameRate[1]);
+      if (roundedFrameRate > 30) {
+        return roundedFrameRate;
+      } else {
+        return roundedFrameRate * 2;
+      }
+    }
+
+    /*
+     * Calculates mez segment durations based on input stream parameters
+     *
+     * Live input formats have fixed timebase:
+     * - MPEG-TS/SRT input stream timebase is 90000
+     * - RTMP input stream timebase is 1000 and gets translated to 16000 if not otherwise specified
+     *
+     * This causes frame duration irregularities for certain frame rates.
+     * For example RTMP 60fps has frames of durations 16 and 17.  MPEG-TS 59.94fps has frames of
+     * durations 1001 and 1002.
+     *
+     * Live mez segmentation requires that the segment be cut at the specific number of frames, and when
+     * the frame durations are irregular we adjust both the video timebase and the video frame duration
+     * to make the math possible.  This adjustment is also required for live-to-vod conversion.
+     *
+     * For example for MPEG-TS 59.94fps, the mez segment timebase needs to be 60000
+     * (and resulting frame duration is 1001) and for RTMP 60fps the timebase needs to be 15360 (resulting frame
+     * duration is 256).
+     *
+     * @sourceTimescale - adjusted source video stream timescale (eg. MPEGTS 90000, RTMP 16000 )
+     * @sampleRate - audio sample rate (commonly 48000 but can be different)
+     * @audioCodec - audio codec as a string (eg. "aac")
+     * @return - segment encoding parameters
+     */
+  }, {
+    key: "calcSegDuration",
+    value: function calcSegDuration(_ref) {
+      var sourceTimescale = _ref.sourceTimescale,
+        sampleRate = _ref.sampleRate,
+        audioCodec = _ref.audioCodec;
+      var seg = {};
+      switch (this.probeKind()) {
+        case "rtmp":
+          seg = this.calcSegDurationRtmp({
+            sourceTimescale: sourceTimescale,
+            sampleRate: sampleRate,
+            audioCodec: audioCodec
+          });
+          break;
+        case "udp":
+        case "srt":
+          seg = this.calcSegDurationMpegts({
+            sourceTimescale: sourceTimescale,
+            sampleRate: sampleRate,
+            audioCodec: audioCodec
+          });
+          break;
+        default:
+          throw "protocol not supported - " + this.probeKind();
+      }
+      if (audioCodec == "aac") {
+        seg.audio = 29.76 * sampleRate;
+      } else {
+        seg.audio = 29.76 * 48000; // Other codecs are resampled @48000
+      }
+
+      return seg;
+    }
+
+    /*
+    * Calculate output timebase from the encoder (codec) timebase. The videoTimeBase parameter
+    * represents the encoder timebase. The format muxer will change it so it is greater than 10000.
+    */
+  }, {
+    key: "calcOutputTimebase",
+    value: function calcOutputTimebase(codecTimebase) {
+      var outputTimebase = codecTimebase;
+      while (outputTimebase < 10000) outputTimebase = outputTimebase * 2;
+      return outputTimebase;
+    }
+  }, {
+    key: "calcSegDurationMpegts",
+    value: function calcSegDurationMpegts(_ref2) {
+      var sourceTimescale = _ref2.sourceTimescale;
+      var videoStream = this.getStreamDataForCodecType("video");
+      var frameRate = videoStream.frame_rate;
+
+      // PENDING(SS) - calculate frame duration here
+      // let frameRateNum = 0;
+      var seg = {
+        //  videoFrameDurationTs: sourceTimescale / frameRateNum
+      };
+      switch (frameRate) {
+        case "24":
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 48;
+          seg.duration = "30";
+          break;
+        case "25":
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 50;
+          seg.duration = "30";
+          break;
+        case "30":
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 60;
+          seg.duration = "30";
+          break;
+        case "30000/1001":
+          //seg.videoFrameDurationTs = 3003;
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 60;
+          seg.duration = "30.03";
+          break;
+        case "48":
+          //seg.videoFrameDurationTs = 1875;
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 96;
+          seg.duration = "30";
+          break;
+        case "50":
+          //seg.videoFrameDurationTs = 1800;
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 100;
+          seg.duration = "30";
+          break;
+        case "60":
+          //seg.videoFrameDurationTs = 1500;
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 120;
+          seg.duration = "30";
+          break;
+        case "60000/1001":
+          seg.videoTimeBase = 60000;
+          seg.video = seg.videoTimeBase * 30.03;
+          seg.keyint = 120;
+          seg.duration = "30.03";
+          break;
+        default:
+          throw "unsupported frame rate for MPEGTS - " + frameRate;
+      }
+      return seg;
+    }
+  }, {
+    key: "calcSegDurationRtmp",
+    value: function calcSegDurationRtmp(_ref3) {
+      var sourceTimescale = _ref3.sourceTimescale;
+      var videoStream = this.getStreamDataForCodecType("video");
+      var frameRate = videoStream.frame_rate;
+      var seg = {};
+      switch (frameRate) {
+        case "24":
+          seg.videoTimeBase = 768; // Note 1536 produces low output bitrate
+          seg.videoFrameDurationTs = 512;
+          seg.video = this.calcOutputTimebase(seg.videoTimeBase) * 30;
+          seg.keyint = 48;
+          seg.duration = "30";
+          break;
+        case "25":
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 50;
+          seg.duration = "30";
+          break;
+        case "30":
+          seg.videoTimeBase = 960; // Output timebase: 15360
+          seg.videoFrameDurationTs = 512;
+          seg.video = this.calcOutputTimebase(seg.videoTimeBase) * 30;
+          seg.keyint = 60;
+          seg.duration = "30";
+          break;
+        case "30000/1001":
+          seg.video = sourceTimescale * 30.03;
+          seg.keyint = 60;
+          seg.duration = "30.03";
+          break;
+        case "48":
+          seg.videoTimeBase = 1536; // Output timebase: 12288
+          seg.videoFrameDurationTs = 256;
+          seg.video = this.calcOutputTimebase(seg.videoTimeBase) * 30;
+          seg.keyint = 96;
+          seg.duration = "30";
+          break;
+        case "50":
+          seg.video = sourceTimescale * 30;
+          seg.keyint = 100;
+          seg.duration = "30";
+          break;
+        case "60":
+          seg.videoTimeBase = 960; // Output timebase: 15360
+          seg.videoFrameDurationTs = 256;
+          seg.video = this.calcOutputTimebase(seg.videoTimeBase) * 30;
+          seg.keyint = 120;
+          seg.duration = "30";
+          break;
+        case "60000/1001":
+          seg.video = sourceTimescale * 30.03;
+          seg.keyint = 120;
+          seg.duration = "30.03";
+          break;
+        default:
+          throw "unsupported frame rate for RTMP - " + frameRate;
+      }
+      return seg;
+    }
+  }, {
+    key: "syncAudioToStreamIdValue",
+    value: function syncAudioToStreamIdValue() {
+      var sync_id = -1;
+      var videoStream = this.getStreamDataForCodecType("video");
+      switch (this.probeKind()) {
+        case "udp":
+        case "srt":
+          sync_id = videoStream.stream_id;
+          break;
+        case "rtmp":
+          sync_id = videoStream.stream_index;
+          break;
+      }
+      return sync_id;
+    }
+
+    /*
+    * Generate audio streams recording configuration based on the optional custom settings.
+    * If no custom "audio" section is present, record all the acceptable audio streams found in the probe
+    */
+  }, {
+    key: "generateAudioStreamsConfig",
+    value: function generateAudioStreamsConfig(_ref4) {
+      var customSettings = _ref4.customSettings;
+      var audioStreams = {};
+      if (customSettings && customSettings.audio && Object.keys(customSettings.audio).length > 0) {
+        for (var i = 0; i < Object.keys(customSettings.audio).length; i++) {
+          var audioIdx = Object.keys(customSettings.audio)[i];
+          var audio = customSettings.audio[audioIdx];
+          audioStreams[audioIdx] = {
+            recordingBitrate: audio.recording_bitrate || 192000,
+            recordingChannels: audio.recording_channels || 2
+          };
+          if (audio.playout) {
+            audioStreams[audioIdx].playoutLabel = audio.playout_label || "Audio ".concat(audioIdx);
+          }
+        }
+      }
+
+      // If no audio streams specified in custom config, set up all the suitable audio streams in the probe
+      if (!customSettings.audio || Object.keys(customSettings.audio).length == 0) {
+        audioStreams = this.getAudioStreamsFromProbe();
+      }
+      return audioStreams;
+    }
+
+    /*
+    * Generate the live recording config as required by QFAB, based on defaults and optional custom settings.
+    */
+  }, {
+    key: "generateLiveConf",
+    value: function generateLiveConf(_ref5) {
+      var customSettings = _ref5.customSettings;
+      // gather required data
+      var conf = JSON.parse(JSON.stringify(LiveconfTemplate));
+      var fileName = this.overwriteOriginUrl || this.probeData.format.filename;
+      var audioStreams = this.generateAudioStreamsConfig({
+        customSettings: customSettings
+      });
+
+      // Retrieve one audio stream from the probe to read the sample rate and codec name
+      var audioStream = this.getStreamDataForCodecType("audio");
+      var sampleRate = parseInt(audioStream.sample_rate);
+      var audioCodec = audioStream.codec_name;
+      var videoStream = this.getStreamDataForCodecType("video");
+      var sourceTimescale;
+
+      // Fill in liveconf all formats have in common
+      conf.live_recording.fabric_config.ingress_node_api = this.nodeUrl || null;
+      conf.live_recording.fabric_config.ingress_node_id = this.nodeId || null;
+      conf.live_recording.recording_config.recording_params.description;
+      conf.live_recording.recording_config.recording_params.origin_url = fileName;
+      conf.live_recording.recording_config.recording_params.description = "Ingest stream ".concat(fileName);
+      conf.live_recording.recording_config.recording_params.name = "Ingest stream ".concat(fileName);
+      conf.live_recording.recording_config.recording_params.xc_params.sample_rate = sampleRate;
+      conf.live_recording.recording_config.recording_params.xc_params.enc_height = videoStream.height;
+      conf.live_recording.recording_config.recording_params.xc_params.enc_width = videoStream.width;
+      for (var i = 0; i < Object.keys(audioStreams).length; i++) {
+        conf.live_recording.recording_config.recording_params.xc_params.audio_index[i] = parseInt(Object.keys(audioStreams)[i]);
+      }
+      if (this.syncAudioToVideo) {
+        conf.live_recording.recording_config.recording_params.xc_params.sync_audio_to_stream_id = this.syncAudioToStreamIdValue();
+      }
+      if (customSettings.edge_write_token) {
+        conf.live_recording.fabric_config.edge_write_token = customSettings.edge_write_token;
+      }
+      if (customSettings.part_ttl) {
+        conf.live_recording.recording_config.recording_params.part_ttl = customSettings.part_ttl;
+      }
+      if (customSettings.connection_timeout) {
+        conf.live_recording.recording_config.recording_params.xc_params.connection_timeout = customSettings.connection_timeout;
+      }
+      if (customSettings.reconnect_timeout) {
+        conf.live_recording.recording_config.recording_params.reconnect_timeout = customSettings.reconnect_timeout;
+      }
+
+      // Fill in specifics for protocol
+      switch (this.probeKind()) {
+        case "udp":
+          sourceTimescale = 90000;
+          conf.live_recording.recording_config.recording_params.source_timescale = sourceTimescale;
+          break;
+        case "srt":
+          sourceTimescale = 90000;
+          conf.live_recording.recording_config.recording_params.source_timescale = sourceTimescale;
+          conf.live_recording.recording_config.recording_params.live_delay_nano = 4000000000;
+          break;
+        case "rtmp":
+          sourceTimescale = 16000;
+          conf.live_recording.recording_config.recording_params.source_timescale = sourceTimescale;
+          break;
+        case "hls":
+          console.log("HLS detected. Not yet implemented");
+          break;
+        default:
+          console.log("Unsupported media", this.probeKind());
+          break;
+      }
+      var segDurations = this.calcSegDuration({
+        sourceTimescale: sourceTimescale,
+        sampleRate: sampleRate,
+        audioCodec: audioCodec
+      });
+
+      // Segment conditioning parameters
+      conf.live_recording.recording_config.recording_params.xc_params.seg_duration = segDurations.duration;
+      conf.live_recording.recording_config.recording_params.xc_params.audio_seg_duration_ts = segDurations.audio;
+      conf.live_recording.recording_config.recording_params.xc_params.video_seg_duration_ts = segDurations.video;
+      conf.live_recording.recording_config.recording_params.xc_params.force_keyint = segDurations.keyint;
+
+      // Optional override output timebase and frame duration (ts)
+      if (segDurations.videoTimeBase) {
+        conf.live_recording.recording_config.recording_params.xc_params.video_time_base = segDurations.videoTimeBase;
+
+        // Note 'source_timescale' needs to be set to the output timebase and is used by playout
+        conf.live_recording.recording_config.recording_params.source_timescale = this.calcOutputTimebase(segDurations.videoTimeBase);
+      }
+      if (segDurations.videoFrameDurationTs) {
+        conf.live_recording.recording_config.recording_params.xc_params.video_frame_duration_ts = segDurations.videoFrameDurationTs;
+      }
+      var ladderProfile = customSettings.ladder_profile || DefaultABRLadder;
+      conf.live_recording.recording_config.recording_params.xc_params.enc_height = videoStream.height;
+      conf.live_recording.recording_config.recording_params.xc_params.enc_width = videoStream.width;
+
+      // Determine video recording bitrate and ABR ladder
+      var topLadderRate = 0;
+      for (var _i = 0; _i < ladderProfile.video.length; _i++) {
+        var elem = ladderProfile.video[_i];
+        if (elem.height > videoStream.height) continue;
+        if (elem.bit_rate > topLadderRate) {
+          topLadderRate = elem.bit_rate;
+        }
+        elem.media_type = 1;
+        elem.stream_name = "video";
+        elem.stream_index = 0;
+        elem.representation = "videovideo_" + elem.width + "x" + elem.height + "_h264@" + elem.bit_rate;
+        conf.live_recording.recording_config.recording_params.ladder_specs.push(elem);
+      }
+      // Currently the recording bitrate is the top bitrate of the ladder (it will be configurable separately in the future)
+      conf.live_recording.recording_config.recording_params.xc_params.video_bitrate = topLadderRate;
+
+      // Determine audio recording bitrate and ABR ladder
+      var globalAudioBitrate = 0;
+      var nAudio = 0;
+      for (var _i2 = 0; _i2 < Object.keys(audioStreams).length; _i2++) {
+        var audioLadderSpec = {};
+        var audioIndex = Object.keys(audioStreams)[_i2];
+        var audio = audioStreams[audioIndex];
+
+        // Find ladder rung for the specific channel layout (2 or 6 channels)
+        for (var j = 0; j < ladderProfile.audio.length; j++) {
+          var _elem = ladderProfile.audio[j];
+          if (_elem.channels == audio.recordingChannels) {
+            audioLadderSpec = _objectSpread({}, _elem);
+            break;
+          }
+        }
+        if (Object.keys(audioLadderSpec).length === 0) {
+          // If no channels layout match, just use the first element in the ladder
+          audioLadderSpec = _objectSpread({}, ladderProfile.audio[0]);
+        }
+        audioLadderSpec.representation = "audioaudio_aac@".concat(audioLadderSpec.bit_rate);
+        audioLadderSpec.channels = audio.recordingChannels;
+        audioLadderSpec.stream_index = parseInt(audioIndex);
+        audioLadderSpec.stream_name = "audio_".concat(audioIndex);
+        audioLadderSpec.stream_label = audio.playoutLabel ? audio.playoutLabel : null;
+        audioLadderSpec.media_type = 2;
+        conf.live_recording.recording_config.recording_params.ladder_specs.push(audioLadderSpec);
+        if (audio.recordingBitrate > globalAudioBitrate) {
+          globalAudioBitrate = audio.recordingBitrate;
+        }
+        nAudio++;
+      }
+
+      // Global recording bitrate for all audio streams
+      conf.live_recording.recording_config.recording_params.xc_params.audio_bitrate = globalAudioBitrate;
+      conf.live_recording.recording_config.recording_params.xc_params.n_audio = nAudio;
+      return conf;
+    }
+  }]);
+  return LiveConf;
+}();
+exports.LiveConf = LiveConf;