webrtc: add advanced audio settings

autoGainControl, echoCancellation, and noiseSuppression are audio
processing options that are usually enabled by default on WebRTC input
tracks.

This commit adds the possibility to enable/disable them, as they can be
undesirable in some cases (audiophile use cases). For example, one might
want to stream electronic dance music, which is basically noise, so it
should not be suppressed in that specific case.

Note that these are not exact settings, they are set as "ideal" in order
not to break anything on devices where those constraints are not
implemented.

Signed-off-by: László Várady <laszlo.varady@protonmail.com>

Author: MrAnno

spec/unit/webrtc/mediaHandler.spec.ts

@@ -79,6 +79,23 @@ describe('Media Handler', function() {
         }));
     });
 
+    it("sets audio settings", async () => {
+        await mediaHandler.setAudioSettings({
+            autoGainControl: false,
+            echoCancellation: true,
+            noiseSuppression: false,
+        });
+
+        await mediaHandler.getUserMediaStream(true, false);
+        expect(mockMediaDevices.getUserMedia).toHaveBeenCalledWith(expect.objectContaining({
+            audio: expect.objectContaining({
+                autoGainControl: { ideal: false },
+                echoCancellation: { ideal: true },
+                noiseSuppression: { ideal: false },
+            }),
+        }));
+    });
+
     it("sets video device ID", async () => {
         await mediaHandler.setVideoInput(FAKE_VIDEO_INPUT_ID);
 

src/webrtc/mediaHandler.ts

@@ -40,10 +40,17 @@ export interface IScreensharingOpts {
     throwOnFail?: boolean;
 }
 
+export interface AudioSettings {
+    autoGainControl: boolean;
+    echoCancellation: boolean;
+    noiseSuppression: boolean;
+}
+
 export class MediaHandler extends TypedEventEmitter<
     MediaHandlerEvent.LocalStreamsChanged, MediaHandlerEventHandlerMap
 > {
     private audioInput?: string;
+    private audioSettings?: AudioSettings;
     private videoInput?: string;
     private localUserMediaStream?: MediaStream;
     public userMediaStreams: MediaStream[] = [];
@@ -72,6 +79,17 @@ export class MediaHandler extends TypedEventEmitter<
         await this.updateLocalUsermediaStreams();
     }
 
+    /**
+     * Set audio settings for MatrixCalls
+     * @param {AudioSettings} opts audio options to set
+     */
+    public async setAudioSettings(opts: AudioSettings): Promise<void> {
+        logger.info("LOG setting audio settings to", opts);
+
+        this.audioSettings = Object.assign({}, opts) as AudioSettings;
+        await this.updateLocalUsermediaStreams();
+    }
+
     /**
      * Set a video input device to use for MatrixCalls
      * @param {string} deviceId the identifier for the device
@@ -362,6 +380,9 @@ export class MediaHandler extends TypedEventEmitter<
             audio: audio
                 ? {
                     deviceId: this.audioInput ? { ideal: this.audioInput } : undefined,
+                    autoGainControl: this.audioSettings ? { ideal: this.audioSettings.autoGainControl } : undefined,
+                    echoCancellation: this.audioSettings ? { ideal: this.audioSettings.echoCancellation } : undefined,
+                    noiseSuppression: this.audioSettings ? { ideal: this.audioSettings.noiseSuppression } : undefined,
                 }
                 : false,
             video: video