Tommi 51ad7c1277 Update FrameCombiner et al to use DeinterleavedView
* FrameCombiner is simpler. No additional channel pointers for buffers.
* Improve consistency in using views in downstream classes.
* Deprecate older methods (some have upstream dependencies).
* Use samples per channel instead of sample rate where the former is
  really what's needed.

Bug: chromium:335805780
Change-Id: I0dde8ed7a5a187bbddd18d3b6c649aa0865e6d4a
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/352582
Commit-Queue: Tomas Gunnarsson <tommi@webrtc.org>
Reviewed-by: Sam Zackrisson <saza@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#42575}
2024-07-02 15:58:20 +00:00

81 lines
2.7 KiB
C++

/*
* Copyright (c) 2018 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef MODULES_AUDIO_PROCESSING_AGC2_LIMITER_H_
#define MODULES_AUDIO_PROCESSING_AGC2_LIMITER_H_
#include <vector>
#include "absl/strings/string_view.h"
#include "api/audio/audio_frame.h"
#include "modules/audio_processing/agc2/fixed_digital_level_estimator.h"
#include "modules/audio_processing/agc2/interpolated_gain_curve.h"
#include "modules/audio_processing/include/audio_frame_view.h"
namespace webrtc {
class ApmDataDumper;
class Limiter {
public:
// See `SetSamplesPerChannel()` for valid values for `samples_per_channel`.
Limiter(ApmDataDumper* apm_data_dumper,
size_t samples_per_channel,
absl::string_view histogram_name_prefix);
[[deprecated("Use constructor that accepts samples_per_channel")]] Limiter(
int sample_rate_hz,
ApmDataDumper* apm_data_dumper,
absl::string_view histogram_name_prefix);
Limiter(const Limiter& limiter) = delete;
Limiter& operator=(const Limiter& limiter) = delete;
~Limiter();
// Applies limiter and hard-clipping to `signal`.
void Process(DeinterleavedView<float> signal);
[[deprecated("Use DeinterleavedView version")]] void Process(
AudioFrameView<float> signal) {
return Process(signal.view());
}
InterpolatedGainCurve::Stats GetGainCurveStats() const;
// Supported values must be
// * Supported by FixedDigitalLevelEstimator
// * Below or equal to kMaximalNumberOfSamplesPerChannel so that samples
// fit in the per_sample_scaling_factors_ array.
void SetSamplesPerChannel(size_t samples_per_channel);
[[deprecated("Use SetSamplesPerChannel")]] void SetSampleRate(
int sample_rate_hz) {
SetSamplesPerChannel(SampleRateToDefaultChannelSize(sample_rate_hz));
}
// Resets the internal state.
void Reset();
float LastAudioLevel() const;
private:
const InterpolatedGainCurve interp_gain_curve_;
FixedDigitalLevelEstimator level_estimator_;
ApmDataDumper* const apm_data_dumper_ = nullptr;
// Work array containing the sub-frame scaling factors to be interpolated.
std::array<float, kSubFramesInFrame + 1> scaling_factors_ = {};
std::array<float, kMaximalNumberOfSamplesPerChannel>
per_sample_scaling_factors_ = {};
float last_scaling_factor_ = 1.f;
};
} // namespace webrtc
#endif // MODULES_AUDIO_PROCESSING_AGC2_LIMITER_H_