matrix-react-sdk/lib/audio/RecorderWorklet.js

SDK for matrix.org using React

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _consts = require("./consts");
var _numbers = require("../utils/numbers");
/*
Copyright 2024 New Vector Ltd.
Copyright 2021 The Matrix.org Foundation C.I.C.

SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
Please see LICENSE files in the repository root for full details.
*/

// from AudioWorkletGlobalScope: https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletGlobalScope

// declare const currentFrame: number;
// declare const sampleRate: number;

// We rate limit here to avoid overloading downstream consumers with amplitude information.
// The two major consumers are the voice message waveform thumbnail (resampled down to an
// appropriate length) and the live waveform shown to the user. Effectively, this controls
// the refresh rate of that live waveform and the number of samples the thumbnail has to
// work with.
const TARGET_AMPLITUDE_FREQUENCY = 16; // Hz

function roundTimeToTargetFreq(seconds) {
  // Epsilon helps avoid floating point rounding issues (1 + 1 = 1.999999, etc)
  return Math.round((seconds + Number.EPSILON) * TARGET_AMPLITUDE_FREQUENCY) / TARGET_AMPLITUDE_FREQUENCY;
}
function nextTimeForTargetFreq(roundedSeconds) {
  // The extra round is just to make sure we cut off any floating point issues
  return roundTimeToTargetFreq(roundedSeconds + 1 / TARGET_AMPLITUDE_FREQUENCY);
}
class MxVoiceWorklet extends AudioWorkletProcessor {
  constructor(...args) {
    super(...args);
    (0, _defineProperty2.default)(this, "nextAmplitudeSecond", 0);
    (0, _defineProperty2.default)(this, "amplitudeIndex", 0);
  }
  process(inputs, outputs, parameters) {
    const currentSecond = roundTimeToTargetFreq(currentTime);
    // We special case the first ping because there's a fairly good chance that we'll miss the zeroth
    // update. Firefox for instance takes 0.06 seconds (roughly) to call this function for the first
    // time. Edge and Chrome occasionally lag behind too, but for the most part are on time.
    //
    // When this doesn't work properly we end up producing a waveform of nulls and no live preview
    // of the recorded message.
    if (currentSecond === this.nextAmplitudeSecond || this.nextAmplitudeSecond === 0) {
      // We're expecting exactly one mono input source, so just grab the very first frame of
      // samples for the analysis.
      const monoChan = inputs[0][0];

      // The amplitude of the frame's samples is effectively the loudness of the frame. This
      // translates into a bar which can be rendered as part of the whole recording clip's
      // waveform.
      //
      // We translate the amplitude down to 0-1 for sanity's sake.
      const minVal = Math.min(...monoChan);
      const maxVal = Math.max(...monoChan);
      const amplitude = (0, _numbers.percentageOf)(maxVal, -1, 1) - (0, _numbers.percentageOf)(minVal, -1, 1);
      this.port.postMessage({
        ev: _consts.PayloadEvent.AmplitudeMark,
        amplitude: amplitude,
        forIndex: this.amplitudeIndex++
      });
      this.nextAmplitudeSecond = nextTimeForTargetFreq(currentSecond);
    }

    // We mostly use this worklet to fire regular clock updates through to components
    this.port.postMessage({
      ev: _consts.PayloadEvent.Timekeep,
      timeSeconds: currentTime
    });

    // We're supposed to return false when we're "done" with the audio clip, but seeing as
    // we are acting as a passive processor we are never truly "done". The browser will clean
    // us up when it is done with us.
    return true;
  }
}
registerProcessor(_consts.WORKLET_NAME, MxVoiceWorklet);
var _default = exports.default = ""; // to appease module loaders (we never use the export)
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["_consts","require","_numbers","TARGET_AMPLITUDE_FREQUENCY","roundTimeToTargetFreq","seconds","Math","round","Number","EPSILON","nextTimeForTargetFreq","roundedSeconds","MxVoiceWorklet","AudioWorkletProcessor","constructor","args","_defineProperty2","default","process","inputs","outputs","parameters","currentSecond","currentTime","nextAmplitudeSecond","monoChan","minVal","min","maxVal","max","amplitude","percentageOf","port","postMessage","ev","PayloadEvent","AmplitudeMark","forIndex","amplitudeIndex","Timekeep","timeSeconds","registerProcessor","WORKLET_NAME","_default","exports"],"sources":["../../src/audio/RecorderWorklet.ts"],"sourcesContent":["/*\nCopyright 2024 New Vector Ltd.\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nSPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only\nPlease see LICENSE files in the repository root for full details.\n*/\n\nimport { IAmplitudePayload, ITimingPayload, PayloadEvent, WORKLET_NAME } from \"./consts\";\nimport { percentageOf } from \"../utils/numbers\";\n\n// from AudioWorkletGlobalScope: https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletGlobalScope\ndeclare const currentTime: number;\n// declare const currentFrame: number;\n// declare const sampleRate: number;\n\n// We rate limit here to avoid overloading downstream consumers with amplitude information.\n// The two major consumers are the voice message waveform thumbnail (resampled down to an\n// appropriate length) and the live waveform shown to the user. Effectively, this controls\n// the refresh rate of that live waveform and the number of samples the thumbnail has to\n// work with.\nconst TARGET_AMPLITUDE_FREQUENCY = 16; // Hz\n\nfunction roundTimeToTargetFreq(seconds: number): number {\n    // Epsilon helps avoid floating point rounding issues (1 + 1 = 1.999999, etc)\n    return Math.round((seconds + Number.EPSILON) * TARGET_AMPLITUDE_FREQUENCY) / TARGET_AMPLITUDE_FREQUENCY;\n}\n\nfunction nextTimeForTargetFreq(roundedSeconds: number): number {\n    // The extra round is just to make sure we cut off any floating point issues\n    return roundTimeToTargetFreq(roundedSeconds + 1 / TARGET_AMPLITUDE_FREQUENCY);\n}\n\nclass MxVoiceWorklet extends AudioWorkletProcessor {\n    private nextAmplitudeSecond = 0;\n    private amplitudeIndex = 0;\n\n    public process(\n        inputs: Float32Array[][],\n        outputs: Float32Array[][],\n        parameters: Record<string, Float32Array>,\n    ): boolean {\n        const currentSecond = roundTimeToTargetFreq(currentTime);\n        // We special case the first ping because there's a fairly good chance that we'll miss the zeroth\n        // update. Firefox for instance takes 0.06 seconds (roughly) to call this function for the first\n        // time. Edge and Chrome occasionally lag behind too, but for the most part are on time.\n        //\n        // When this doesn't work properly we end up producing a waveform of nulls and no live preview\n        // of the recorded message.\n        if (currentSecond === this.nextAmplitudeSecond || this.nextAmplitudeSecond === 0) {\n            // We're expecting exactly one mono input source, so just grab the very first frame of\n            // samples for the analysis.\n            const monoChan = inputs[0][0];\n\n            // The amplitude of the frame's samples is effectively the loudness of the frame. This\n            // translates into a bar which can be rendered as part of the whole recording clip's\n            // waveform.\n            //\n            // We translate the amplitude down to 0-1 for sanity's sake.\n            const minVal = Math.min(...monoChan);\n            const maxVal = Math.max(...monoChan);\n            const amplitude = percentageOf(maxVal, -1, 1) - percentageOf(minVal, -1, 1);\n\n            this.port.postMessage(<IAmplitudePayload>{\n                ev: PayloadEvent.AmplitudeMark,\n                amplitude: amplitude,\n                forIndex: this.amplitudeIndex++,\n            });\n            this.nextAmplitudeSecond = nextTimeForTargetFreq(currentSecond);\n        }\n\n        // We mostly use this worklet to fire regular clock updates through to components\n        this.port.postMessage(<ITimingPayload>{ ev: PayloadEvent.Timekeep, timeSeconds: currentTime });\n\n        // We're supposed to return false when we're \"done\" with the audio clip, but seeing as\n        // we are acting as a passive processor we are never truly \"done\". The browser will clean\n        // us up when it is done with us.\n        return true;\n    }\n}\n\nregisterProcessor(WORKLET_NAME, MxVoiceWorklet);\n\nexport default \"\"; // to appease module loaders (we never use the export)\n"],"mappings":";;;;;;;;AAQA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AATA;AACA;AACA;AACA;AACA;AACA;AACA;;AAKA;;AAEA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA,MAAME,0BAA0B,GAAG,EAAE,CAAC,CAAC;;AAEvC,SAASC,qBAAqBA,CAACC,OAAe,EAAU;EACpD;EACA,OAAOC,IAAI,CAACC,KAAK,CAAC,CAACF,OAAO,GAAGG,MAAM,CAACC,OAAO,IAAIN,0BAA0B,CAAC,GAAGA,0BAA0B;AAC3G;AAEA,SAASO,qBAAqBA,CAACC,cAAsB,EAAU;EAC3D;EACA,OAAOP,qBAAqB,CAACO,cAAc,GAAG,CAAC,GAAGR,0BAA0B,CAAC;AACjF;AAEA,MAAMS,cAAc,SAASC,qBAAqB,CAAC;EAAAC,YAAA,GAAAC,IAAA;IAAA,SAAAA,IAAA;IAAA,IAAAC,gBAAA,CAAAC,OAAA,+BACjB,CAAC;IAAA,IAAAD,gBAAA,CAAAC,OAAA,0BACN,CAAC;EAAA;EAEnBC,OAAOA,CACVC,MAAwB,EACxBC,OAAyB,EACzBC,UAAwC,EACjC;IACP,MAAMC,aAAa,GAAGlB,qBAAqB,CAACmB,WAAW,CAAC;IACxD;IACA;IACA;IACA;IACA;IACA;IACA,IAAID,aAAa,KAAK,IAAI,CAACE,mBAAmB,IAAI,IAAI,CAACA,mBAAmB,KAAK,CAAC,EAAE;MAC9E;MACA;MACA,MAAMC,QAAQ,GAAGN,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;;MAE7B;MACA;MACA;MACA;MACA;MACA,MAAMO,MAAM,GAAGpB,IAAI,CAACqB,GAAG,CAAC,GAAGF,QAAQ,CAAC;MACpC,MAAMG,MAAM,GAAGtB,IAAI,CAACuB,GAAG,CAAC,GAAGJ,QAAQ,CAAC;MACpC,MAAMK,SAAS,GAAG,IAAAC,qBAAY,EAACH,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAAG,qBAAY,EAACL,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;MAE3E,IAAI,CAACM,IAAI,CAACC,WAAW,CAAoB;QACrCC,EAAE,EAAEC,oBAAY,CAACC,aAAa;QAC9BN,SAAS,EAAEA,SAAS;QACpBO,QAAQ,EAAE,IAAI,CAACC,cAAc;MACjC,CAAC,CAAC;MACF,IAAI,CAACd,mBAAmB,GAAGd,qBAAqB,CAACY,aAAa,CAAC;IACnE;;IAEA;IACA,IAAI,CAACU,IAAI,CAACC,WAAW,CAAiB;MAAEC,EAAE,EAAEC,oBAAY,CAACI,QAAQ;MAAEC,WAAW,EAAEjB;IAAY,CAAC,CAAC;;IAE9F;IACA;IACA;IACA,OAAO,IAAI;EACf;AACJ;AAEAkB,iBAAiB,CAACC,oBAAY,EAAE9B,cAAc,CAAC;AAAC,IAAA+B,QAAA,GAAAC,OAAA,CAAA3B,OAAA,GAEjC,EAAE,EAAE","ignoreList":[]}