import { EventEmitter } from 'events';
import { getLogger } from 'jitsi-meet-logger';
import * as JitsiConferenceEvents from '../../JitsiConferenceEvents';
import { VAD_SCORE_PUBLISHED, DETECTOR_STATE_CHANGE } from './DetectionEvents';
import TrackVADEmitter from './TrackVADEmitter';
const logger = getLogger(__filename);
/**
* Sample rate of TrackVADEmitter, it defines how many audio samples are processed at a time.
* @type {number}
*/
const VAD_EMITTER_SAMPLE_RATE = 4096;
/**
* Connects a TrackVADEmitter to the target conference local audio track and manages various services that use
* the data to produce audio analytics (VADTalkMutedDetection and VADNoiseDetection).
*/
export default class VADAudioAnalyser extends EventEmitter {
/**
* Creates VADAudioAnalyser
* @param {JitsiConference} conference - JitsiConference instance that created us.
* @param {Object} createVADProcessor - Function that creates a Voice activity detection processor. The processor
* needs to implement the following functions:
* - getSampleLength() - Returns the sample size accepted by getSampleLength.
* - getRequiredPCMFrequency() - Returns the PCM frequency at which the processor operates.
* - calculateAudioFrameVAD(pcmSample) - Process a 32 float pcm sample of getSampleLength size.
* @constructor
*/
constructor(conference, createVADProcessor) {
super();
/**
* Member function that instantiates a VAD processor.
*/
this._createVADProcessor = createVADProcessor;
/**
* Current {@link TrackVADEmitter}. VAD Emitter uses a {@link JitsiLocalTrack} and VAD processor to generate
* period voice probability scores.
*/
this._vadEmitter = null;
/**
* Current state of the _vadEmitter
*/
this._isVADEmitterRunning = false;
/**
* Array of currently attached VAD processing services.
*/
this._detectionServices = [];
/**
* Promise used to chain create and destroy operations associated with TRACK_ADDED and TRACK_REMOVED events
* coming from the conference.
* Because we have an async created component (VAD Processor) we need to make sure that it's initialized before
* we destroy it ( when changing the device for instance), or when we use it from an external point of entry
* i.e. (TRACK_MUTE_CHANGED event callback).
*/
this._vadInitTracker = Promise.resolve();
/**
* Listens for {@link TrackVADEmitter} events and processes them.
*/
this._processVADScore = this._processVADScore.bind(this);
conference.on(JitsiConferenceEvents.TRACK_ADDED, this._trackAdded.bind(this));
conference.on(JitsiConferenceEvents.TRACK_REMOVED, this._trackRemoved.bind(this));
conference.on(JitsiConferenceEvents.TRACK_MUTE_CHANGED, this._trackMuteChanged.bind(this));
}
/**
* Attach a VAD detector service to the analyser and handle it's state changes.
*
* @param {Object} vadTMDetector
*/
addVADDetectionService(vadService) {
this._detectionServices.push(vadService);
vadService.on(DETECTOR_STATE_CHANGE, () => {
// When the state of a detector changes check if there are any active detectors attached so that
// the _vadEmitter doesn't run needlessly.
const activeDetector = this._detectionServices.filter(detector => detector.isActive() === true);
// If there are no active detectors running and the vadEmitter is running then stop the emitter as it is
// uses a considerable amount of CPU. Otherwise start the service if it's stopped and there is a detector
// that needs it.
if (!activeDetector.length && this._isVADEmitterRunning) {
this._stopVADEmitter();
} else if (!this._isVADEmitterRunning) {
this._startVADEmitter();
}
});
}
/**
* Start the {@link TrackVADEmitter} and attach the event listener.
* @returns {void}
*/
_startVADEmitter() {
this._vadEmitter.on(VAD_SCORE_PUBLISHED, this._processVADScore);
this._vadEmitter.start();
this._isVADEmitterRunning = true;
}
/**
* Stop the {@link TrackVADEmitter} and detach the event listener.
* @returns {void}
*/
_stopVADEmitter() {
this._vadEmitter.removeListener(VAD_SCORE_PUBLISHED, this._processVADScore);
this._vadEmitter.stop();
this._isVADEmitterRunning = false;
}
/**
* Listens for {@link TrackVADEmitter} events and directs them to attached services as needed.
*
* @param {Object} vadScore -VAD score emitted by {@link TrackVADEmitter}
* @param {Date} vadScore.timestamp - Exact time at which processed PCM sample was generated.
* @param {number} vadScore.score - VAD score on a scale from 0 to 1 (i.e. 0.7)
* @param {Float32Array} pcmData - Raw PCM data with which the VAD score was calculated.
* @param {string} vadScore.deviceId - Device id of the associated track.
* @listens VAD_SCORE_PUBLISHED
*/
_processVADScore(vadScore) {
for (const detector of this._detectionServices) {
detector.processVADScore(vadScore);
}
}
/**
* Change the isMuted state of all attached detection services.
*
* @param {boolean} isMuted
*/
_changeDetectorsMuteState(isMuted) {
for (const detector of this._detectionServices) {
detector.changeMuteState(isMuted);
}
}
/**
* Notifies the detector that a track was added to the associated {@link JitsiConference}.
* Only take into account local audio tracks.
* @param {JitsiTrack} track - The added track.
* @returns {void}
* @listens TRACK_ADDED
*/
_trackAdded(track) {
if (track.isLocalAudioTrack()) {
// Keep a track promise so we take into account successive TRACK_ADD events being generated so that we
// destroy/create the processing context in the proper order.
this._vadInitTracker = this._vadInitTracker.then(() => this._createVADProcessor())
.then(vadProcessor =>
TrackVADEmitter.create(track.getDeviceId(), VAD_EMITTER_SAMPLE_RATE, vadProcessor)
)
.then(vadEmitter => {
logger.debug('Created VAD emitter for track: ', track.getTrackLabel());
this._vadEmitter = vadEmitter;
// Iterate through the detection services and set their appropriate mute state, depending on
// service this will trigger a DETECTOR_STATE_CHANGE which in turn might start the _vadEmitter.
this._changeDetectorsMuteState(track.isMuted());
});
}
}
/**
* Notifies the detector that the mute state of a {@link JitsiConference} track has changed. Only takes into account
* local audio tracks.
* @param {JitsiTrack} track - The track whose mute state has changed.
* @returns {void}
* @listens TRACK_MUTE_CHANGED
*/
_trackMuteChanged(track) {
if (track.isLocalAudioTrack()) {
// On a mute toggle reset the state.
this._vadInitTracker = this._vadInitTracker.then(() => {
// Set mute status for the attached detection services.
this._changeDetectorsMuteState(track.isMuted());
});
}
}
/**
* Notifies the detector that a track associated with the {@link JitsiConference} was removed. Only takes into
* account local audio tracks. Cleans up resources associated with the track and resets the processing context.
*
* @param {JitsiTrack} track - The removed track.
* @returns {void}
* @listens TRACK_REMOVED
*/
_trackRemoved(track) {
if (track.isLocalAudioTrack()) {
// Use the promise to make sure operations are in sequence.
this._vadInitTracker = this._vadInitTracker.then(() => {
logger.debug('Removing track from VAD detection - ', track.getTrackLabel());
// Track was removed, clean up and set appropriate states.
if (this._vadEmitter) {
this._stopVADEmitter();
this._vadEmitter.destroy();
this._vadEmitter = null;
}
// Reset state of detectors when active track is removed.
for (const detector of this._detectionServices) {
detector.reset();
}
});
}
}
}