feat(DSI) Calculate dominant speakers locally when audio susbscription is enabled on client.

Author: jallamsetty1

JitsiConferenceEventManager.js

@@ -9,6 +9,7 @@ import Statistics from './modules/statistics/statistics';
 import EventEmitterForwarder from './modules/util/EventEmitterForwarder';
 import { MediaType } from './service/RTC/MediaType';
 import RTCEvents from './service/RTC/RTCEvents';
+import { ReceiverAudioSubscription } from './service/RTC/ReceiverAudioSubscription';
 import AuthenticationEvents
     from './service/authentication/AuthenticationEvents';
 import {
@@ -466,8 +467,27 @@ export default class JitsiConferenceEventManager {
             RTCEvents.REMOTE_TRACK_REMOVED,
             conference.onRemoteTrackRemoved.bind(conference));
 
+        rtc.addListener(
+            RTCEvents.AUDIO_SUBSCRIPTION_MODE_CHANGED,
+            (mode, list) => {
+                conference.eventEmitter.emit(
+                    JitsiConferenceEvents.AUDIO_SUBSCRIPTION_MODE_CHANGED, mode, list);
+
+                // We need to update the speaker list if audio subscription mode changes such that it triggers a
+                // dominant speaker change based on the remote audio levels.
+                if (conference.statistics && mode !== ReceiverAudioSubscription.ALL) {
+                    const remoteSpeakerIds = Array.isArray(list) ? list.map(source => source.split('-')[0]) : [];
+
+                    conference.statistics.setSpeakerList(remoteSpeakerIds);
+                }
+            }
+        );
+
         rtc.addListener(RTCEvents.DOMINANT_SPEAKER_CHANGED,
             (dominant, previous, silence) => {
+                if (conference.statistics.dominantSpeakerEnabled) {
+                    return;
+                }
                 if ((conference.lastDominantSpeaker !== dominant || conference.dominantSpeakerIsSilent !== silence)
                         && conference.room) {
                     conference.lastDominantSpeaker = dominant;
@@ -658,14 +678,16 @@ export default class JitsiConferenceEventManager {
             conference.rtc.setAudioLevel(tpc, ssrc, level, isLocal);
         });
 
-        /* eslint-enable max-params */
-
         // Forward the "before stats disposed" event
         conference.statistics.addBeforeDisposedListener(() => {
             conference.eventEmitter.emit(
                 JitsiConferenceEvents.BEFORE_STATISTICS_DISPOSED);
         });
 
+        conference.statistics.addDominantSpeakerListener((tpc, dominant, previous) => {
+            conference.eventEmitter.emit(JitsiConferenceEvents.DOMINANT_SPEAKER_CHANGED, dominant, previous);
+        });
+
         conference.statistics.addEncodeTimeStatsListener((tpc, stats) => {
             conference.eventEmitter.emit(
                 JitsiConferenceEvents.ENCODE_TIME_STATS_RECEIVED, tpc, stats);

JitsiConferenceEvents.spec.ts

@@ -5,6 +5,7 @@ import * as exported from "./JitsiConferenceEvents";
 describe( "/JitsiConferenceEvents members", () => {
     const {
         AUDIO_INPUT_STATE_CHANGE,
+        AUDIO_SUBSCRIPTION_MODE_CHANGED,
         AUDIO_UNMUTE_PERMISSIONS_CHANGED,
         AUTH_STATUS_CHANGED,
         BEFORE_STATISTICS_DISPOSED,
@@ -98,6 +99,7 @@ describe( "/JitsiConferenceEvents members", () => {
 
     it( "known members", () => {
         expect( AUDIO_INPUT_STATE_CHANGE ).toBe( 'conference.audio_input_state_changed' );
+        expect( AUDIO_SUBSCRIPTION_MODE_CHANGED ).toBe( 'conference.audio_subscription_mode_changed' );
         expect( AUDIO_UNMUTE_PERMISSIONS_CHANGED ).toBe( 'conference.audio_unmute_permissions_changed' );
         expect( AUTH_STATUS_CHANGED ).toBe( 'conference.auth_status_changed' );
         expect( BEFORE_STATISTICS_DISPOSED ).toBe( 'conference.beforeStatisticsDisposed' );
@@ -185,6 +187,7 @@ describe( "/JitsiConferenceEvents members", () => {
         expect( JitsiConferenceEvents ).toBeDefined();
 
         expect( JitsiConferenceEvents.AUDIO_INPUT_STATE_CHANGE ).toBe( 'conference.audio_input_state_changed' );
+        expect( JitsiConferenceEvents.AUDIO_SUBSCRIPTION_MODE_CHANGED ).toBe( 'conference.audio_subscription_mode_changed' );
         expect( JitsiConferenceEvents.AUDIO_UNMUTE_PERMISSIONS_CHANGED ).toBe( 'conference.audio_unmute_permissions_changed' );
         expect( JitsiConferenceEvents.AUTH_STATUS_CHANGED ).toBe( 'conference.auth_status_changed' );
         expect( JitsiConferenceEvents.BEFORE_STATISTICS_DISPOSED ).toBe( 'conference.beforeStatisticsDisposed' );

JitsiConferenceEvents.ts

@@ -9,6 +9,10 @@ export enum JitsiConferenceEvents {
      */
     AUDIO_INPUT_STATE_CHANGE = 'conference.audio_input_state_changed',
 
+    /**
+     * Event indicates that the audio subscription mode changed.
+     */
+    AUDIO_SUBSCRIPTION_MODE_CHANGED = 'conference.audio_subscription_mode_changed',
     /**
      * Event indicates that the permission for unmuting audio has changed based on the number of audio senders in the
      * call and the audio sender limit configured in Jicofo.
@@ -534,6 +538,7 @@ export enum JitsiConferenceEvents {
 export const _MEDIA_SESSION_STARTED = JitsiConferenceEvents._MEDIA_SESSION_STARTED;
 export const _MEDIA_SESSION_ACTIVE_CHANGED = JitsiConferenceEvents._MEDIA_SESSION_ACTIVE_CHANGED;
 export const AUDIO_INPUT_STATE_CHANGE = JitsiConferenceEvents.AUDIO_INPUT_STATE_CHANGE;
+export const AUDIO_SUBSCRIPTION_MODE_CHANGED = JitsiConferenceEvents.AUDIO_SUBSCRIPTION_MODE_CHANGED;
 export const AUDIO_UNMUTE_PERMISSIONS_CHANGED = JitsiConferenceEvents.AUDIO_UNMUTE_PERMISSIONS_CHANGED;
 export const AUTH_STATUS_CHANGED = JitsiConferenceEvents.AUTH_STATUS_CHANGED;
 export const AV_MODERATION_APPROVED = JitsiConferenceEvents.AV_MODERATION_APPROVED;

modules/qualitycontrol/ReceiveAudioController.ts

@@ -3,6 +3,8 @@ import { getLogger } from '@jitsi/logger';
 import { isEqual } from 'lodash-es';
 
 import JitsiConference from '../../JitsiConference';
+import { MediaType } from '../../service/RTC/MediaType';
+import RTCEvents from '../../service/RTC/RTCEvents';
 import { IReceiverAudioSubscriptionMessage, ReceiverAudioSubscription } from '../../service/RTC/ReceiverAudioSubscription';
 import RTC from '../RTC/RTC';
 
@@ -13,6 +15,11 @@ const logger = getLogger('modules/qualitycontrol/ReceiveAudioController');
  * based on different modes such as ALL, EXCLUDE, INCLUDE, and NONE.
  */
 export class ReceiverAudioController {
+
+    /**
+     * The JitsiConference instance associated with this controller.
+     */
+    private _conference: JitsiConference;
     private _rtc: RTC;
 
     /**
@@ -30,6 +37,7 @@ export class ReceiverAudioController {
      * Creates a new instance of the ReceiverAudioController.
      */
     constructor(conference: JitsiConference) {
+        this._conference = conference;
         this._rtc = conference.rtc;
         this._sourceList = [];
         this._subscriptionMode = ReceiverAudioSubscription.ALL;
@@ -70,6 +78,7 @@ export class ReceiverAudioController {
             return;
         }
         this._subscriptionMode = message.mode;
+
         if (message.mode == ReceiverAudioSubscription.INCLUDE
             || message.mode == ReceiverAudioSubscription.EXCLUDE) {
 
@@ -92,5 +101,10 @@ export class ReceiverAudioController {
             list: this._sourceList,
             mode: this._subscriptionMode
         });
+
+        this._rtc.eventEmitter.emit(RTCEvents.AUDIO_SUBSCRIPTION_MODE_CHANGED, {
+            list: this._sourceList,
+            mode: this._subscriptionMode
+        });
     }
 }