// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "third_party/blink/renderer/modules/mediastream/media_stream_audio_processing_layout.h"

#include "build/build_config.h"
#include "media/base/audio_parameters.h"
#include "media/base/media_switches.h"

namespace blink {

namespace {

static constexpr media::AudioProcessingSettings kDummyWebrtcSettings{
    .echo_cancellation = false,
    .noise_suppression = false,
    .automatic_gain_control = false,
    .multi_channel_capture_processing = false,
    .use_loopback_aec_reference = false};

// Returns whether system noise suppression is allowed to be used regardless of
// whether the noise suppression constraint is set, or whether a browser-based
// AEC is active. This is currently the default on at least MacOS but is not
// allowed for ChromeOS or Windows setups. On Windows, the system effects AEC,
// NS and AGC always come as a "package" and it it not possible to enable or
// disable the system NS independently. TODO(crbug.com/417413190): delete if not
// relevant any more.
constexpr bool IsIndependentSystemNsAllowed() {
#if BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_WIN)
  return false;
#else
  return true;
#endif
}

// Returns `enabled_platform_effects` adjusted based on the requested
// processing.
int ConfigureEchoCancellationEffects(const EchoCanceller& echo_canceller,
                                     bool ns_requested,
                                     bool agc_requested,
                                     int enabled_platform_effects) {
  if (!echo_canceller.IsPlatformProvided()) {
    // No platform processing if platform AEC is not requested.
    enabled_platform_effects &= ~media::AudioParameters::ECHO_CANCELLER;
    enabled_platform_effects &= ~media::AudioParameters::AUTOMATIC_GAIN_CONTROL;
    if (!IsIndependentSystemNsAllowed()) {
      // Special case for NS. TODO(crbug.com/417413190): Rethink.
      enabled_platform_effects &= ~media::AudioParameters::NOISE_SUPPRESSION;
    }
    return enabled_platform_effects;
  }

  // Platform echo cancellation is requested.
  // TODO(crbug.com/405165917): CHECK(platform_effects &
  // media::AudioParameters::ECHO_CANCELLER);

#if !BUILDFLAG(IS_WIN)
  // On Windows  can only disable platform NS and AGC effects if platform
  // AEC effect is disabled.

  // Disable platform NS effect if it's not requested.
  if (!ns_requested) {
    if (!IsIndependentSystemNsAllowed()) {
      // Special case for NS. TODO(crbug.com/417413190): Rethink.
      enabled_platform_effects &= ~media::AudioParameters::NOISE_SUPPRESSION;
    }
  }

  // Disable platform AGC effect if not requested.
  if (!agc_requested) {
    enabled_platform_effects &= ~media::AudioParameters::AUTOMATIC_GAIN_CONTROL;
  }
#endif

  return enabled_platform_effects;
}

#if BUILDFLAG(IS_CHROMEOS)
// Adjusts voice processing bits of `enabled_platform_effects` based on what
// is requested and returns the adjusted value.
int UpdateVoiceIsolationEffects(
    bool use_chrome_aec,
    AudioProcessingProperties::VoiceIsolationType voice_isolation,
    int enabled_platform_effects) {
  if (!(base::FeatureList::IsEnabled(media::kCrOSSystemVoiceIsolationOption) &&
        enabled_platform_effects &
            media::AudioParameters::VOICE_ISOLATION_SUPPORTED)) {
    return enabled_platform_effects;
  }

  if (use_chrome_aec || voice_isolation ==
                            AudioProcessingProperties::VoiceIsolationType::
                                kVoiceIsolationDisabled) {
    // Force voice isolation effect to be disabled if disabled in the
    // properties, or if browser-based AEC is enabled (platform voice
    // isolation would break browser-based AEC).
    enabled_platform_effects |=
        media::AudioParameters::CLIENT_CONTROLLED_VOICE_ISOLATION;
    enabled_platform_effects &= ~media::AudioParameters::VOICE_ISOLATION;
  } else if (voice_isolation == AudioProcessingProperties::VoiceIsolationType::
                                    kVoiceIsolationEnabled) {
    // No browser-based AEC involved; voice isolation is enabled in the
    // properties: force voice isolation to be enabled in the effects.
    enabled_platform_effects |=
        media::AudioParameters::CLIENT_CONTROLLED_VOICE_ISOLATION;

    enabled_platform_effects |= media::AudioParameters::VOICE_ISOLATION;
  } else {
    // Turn off voice isolation control.
    enabled_platform_effects &=
        ~media::AudioParameters::CLIENT_CONTROLLED_VOICE_ISOLATION;
  }

  return enabled_platform_effects;
}
#endif

int ApplyPropertiesToEffects(const EchoCanceller& echo_canceller,
                             const AudioProcessingProperties& properties,
                             int enabled_platform_effects) {
  enabled_platform_effects = ConfigureEchoCancellationEffects(
      echo_canceller,
      /*ns_requested=*/properties.noise_suppression,
      /*agc_requested=*/properties.auto_gain_control, enabled_platform_effects);

#if BUILDFLAG(IS_CHROMEOS)
  enabled_platform_effects = UpdateVoiceIsolationEffects(
      /*use_chrome_aec=*/echo_canceller.IsChromeProvided(),
      properties.voice_isolation, enabled_platform_effects);
  if (base::FeatureList::IsEnabled(media::kIgnoreUiGains)) {
    // Ignore UI Gains if AGC is running in either browser or system
    if (properties.auto_gain_control) {
      return enabled_platform_effects | media::AudioParameters::IGNORE_UI_GAINS;
    }
  }
#endif

  return enabled_platform_effects;
}

media::AudioProcessingSettings ComputeWebrtcProcessingSettings(
    const EchoCanceller& echo_canceller,
    const AudioProcessingProperties& properties,
    int enabled_platform_effects,
    bool multichannel_processing) {
  media::AudioProcessingSettings out;

  out.echo_cancellation = echo_canceller.IsChromeProvided();

  out.noise_suppression =
      properties.noise_suppression &&
      (media::IsSystemEchoCancellationEnforcedAndAllowNsInTandem() ||
       !(enabled_platform_effects & media::AudioParameters::NOISE_SUPPRESSION));

  out.automatic_gain_control =
      properties.auto_gain_control &&
      (media::IsSystemEchoCancellationEnforcedAndAllowAgcInTandem() ||
       !(enabled_platform_effects &
         media::AudioParameters::AUTOMATIC_GAIN_CONTROL));

  out.multi_channel_capture_processing = multichannel_processing;

  out.use_loopback_aec_reference = echo_canceller.NeedSystemLoopback();

#if BUILDFLAG(CHROME_WIDE_ECHO_CANCELLATION)
  // `media::AudioParameters::VOICE_ISOLATION_SUPPORTED` is a platform
  // capability effect bit that was already taken into account when
  // `AudioProcessingProperties` were calculated; changing platform effects
  // does not directly determine the WebRTC voice isolation state.
  out.voice_isolation =
      (properties.voice_isolation ==
       AudioProcessingProperties::VoiceIsolationType::kVoiceIsolationEnabled);
#endif

  return out;
}

}  // namespace

// static
bool MediaStreamAudioProcessingLayout::IsIndependentSystemNsAllowedForTests() {
  return IsIndependentSystemNsAllowed();
}

// static
media::AudioProcessingSettings
MediaStreamAudioProcessingLayout::ComputeWebrtcProcessingSettingsForTests(
    const AudioProcessingProperties& properties,
    int enabled_platform_effects,
    bool multichannel_processing) {
  return ComputeWebrtcProcessingSettings(
      EchoCanceller::From(properties, enabled_platform_effects), properties,
      enabled_platform_effects, multichannel_processing);
}

// static
MediaStreamAudioProcessingLayout MediaStreamAudioProcessingLayout::None() {
  return MediaStreamAudioProcessingLayout(
      AudioProcessingProperties::Disabled(),
      EchoCanceller(EchoCanceller::Type::kNone), /*platform_effects=*/0,
      kDummyWebrtcSettings);
}

// static
// TODO(crbug.com://40247860, crbug.com://415952276): retire this
// logic when restrictOwnAudio is launched.
std::optional<MediaStreamAudioProcessingLayout>
MediaStreamAudioProcessingLayout::MaybeMakeForProcessedDisplayCapture(
    const AudioProcessingProperties& properties,
    int channels) {
  if (!EchoCanceller::From(properties, /*available_platform_effects=*/0)
           .IsEnabled()) {
    return std::nullopt;
  }

  // Run APM locally to only remove PeerConnection playout.
  return MediaStreamAudioProcessingLayout(
      properties, EchoCanceller(EchoCanceller::Type::kPeerConnection),
      /*available_platform_effects=*/0, channels);
}

// static
// Keep only echo cancellation info and apply only it to platform effects.
// TODO(http://crbug.com/428837201)
// This is how the code works historically. Needs to be reconsidered.
MediaStreamAudioProcessingLayout
MediaStreamAudioProcessingLayout::MakeForUnprocessedLocalSource(
    const AudioProcessingProperties& properties,
    int platform_effects) {
  AudioProcessingProperties properties_aec_only(
      AudioProcessingProperties::Disabled());
  properties_aec_only.echo_cancellation_mode =
      properties.echo_cancellation_mode;

  EchoCanceller echo_canceller =
      EchoCanceller::From(properties_aec_only, platform_effects);

  CHECK(!echo_canceller.IsChromeProvided());

  if (echo_canceller.IsPlatformProvided()) {
    CHECK(platform_effects & media::AudioParameters::ECHO_CANCELLER);
  } else {
    platform_effects &= ~media::AudioParameters::ECHO_CANCELLER;
  }

  return MediaStreamAudioProcessingLayout(properties_aec_only, echo_canceller,
                                          platform_effects,
                                          kDummyWebrtcSettings);
}

// static
MediaStreamAudioProcessingLayout
MediaStreamAudioProcessingLayout::MakeForUnprocessedLocalSourceForTests(
    bool platform_aec,
    int available_platform_effects) {
  AudioProcessingProperties properties(AudioProcessingProperties::Disabled());
  if (platform_aec) {
    CHECK(available_platform_effects & media::AudioParameters::ECHO_CANCELLER);
    properties.echo_cancellation_mode = EchoCancellationMode::kAll;
  }

  return MakeForUnprocessedLocalSource(properties, available_platform_effects);
}

MediaStreamAudioProcessingLayout::MediaStreamAudioProcessingLayout(
    const AudioProcessingProperties& properties,
    int available_platform_effects,
    int channels)
    : MediaStreamAudioProcessingLayout(
          properties,
          EchoCanceller::From(properties, available_platform_effects),
          available_platform_effects,
          channels) {}

MediaStreamAudioProcessingLayout::MediaStreamAudioProcessingLayout(
    const AudioProcessingProperties& properties,
    const EchoCanceller& echo_canceller,
    int available_platform_effects,
    int channels)
    : properties_(properties),
      echo_canceller_(echo_canceller),
      platform_effects_(ApplyPropertiesToEffects(echo_canceller_,
                                                 properties_,
                                                 available_platform_effects)),
      webrtc_processing_settings_(
          ComputeWebrtcProcessingSettings(echo_canceller_,
                                          properties_,
                                          platform_effects_,
                                          channels > 1)) {}

MediaStreamAudioProcessingLayout::MediaStreamAudioProcessingLayout(
    const AudioProcessingProperties& properties,
    const EchoCanceller& echo_canceller,
    int platform_effects,
    const media::AudioProcessingSettings& webrtc_processing_settings)
    : properties_(properties),
      echo_canceller_(echo_canceller),
      platform_effects_(platform_effects),
      webrtc_processing_settings_(webrtc_processing_settings) {}

bool MediaStreamAudioProcessingLayout::NeedApmInAudioService() const {
#if BUILDFLAG(CHROME_WIDE_ECHO_CANCELLATION)
  if (properties_.voice_isolation ==
      AudioProcessingProperties::VoiceIsolationType::kVoiceIsolationEnabled) {
    return true;
  }
#endif
  return echo_canceller_.GetApmLocation() ==
         EchoCanceller::ApmLocation::kAudioService;
}

bool MediaStreamAudioProcessingLayout::NeedWebrtcAudioProcessing() const {
  if (webrtc_processing_settings_.NeedWebrtcAudioProcessing()) {
    return true;
  }

// TODO(crbug.com/40205004): reconsider the logic below; see also
// AudioProcessingSettings::NeedWebrtcAudioProcessing().
#if !BUILDFLAG(IS_IOS)
  if (properties_.auto_gain_control) {
    return true;
  }
#endif

  if (properties_.noise_suppression) {
    return true;
  }

  return false;
}

bool MediaStreamAudioProcessingLayout::NoiseSuppressionInTandem() const {
  return (platform_effects_ & media::AudioParameters::NOISE_SUPPRESSION) &&
         webrtc_processing_settings_.noise_suppression;
}

bool MediaStreamAudioProcessingLayout::AutomaticGainControlInTandem() const {
  return (platform_effects_ & media::AudioParameters::AUTOMATIC_GAIN_CONTROL) &&
         webrtc_processing_settings_.automatic_gain_control;
}

}  // namespace blink