From 2c91fbf7f1384b5cb01e20e4f59e27a1f9bd9a61 Mon Sep 17 00:00:00 2001 From: Lioncash Date: Tue, 13 Sep 2022 13:50:39 -0400 Subject: audio_core: Amend documentation tags Resolves a wackload of -Wdocumentation warnings due to mismatching tags and whatnot. --- src/audio_core/renderer/command/mix/mix_ramp.cpp | 18 +++--------------- src/audio_core/renderer/command/mix/mix_ramp.h | 8 ++++---- src/audio_core/renderer/command/mix/mix_ramp_grouped.h | 4 ++-- 3 files changed, 9 insertions(+), 21 deletions(-) (limited to 'src/audio_core/renderer/command/mix') diff --git a/src/audio_core/renderer/command/mix/mix_ramp.cpp b/src/audio_core/renderer/command/mix/mix_ramp.cpp index ffdafa1c8..d67123cd8 100644 --- a/src/audio_core/renderer/command/mix/mix_ramp.cpp +++ b/src/audio_core/renderer/command/mix/mix_ramp.cpp @@ -7,17 +7,7 @@ #include "common/logging/log.h" namespace AudioCore::AudioRenderer { -/** - * Mix input mix buffer into output mix buffer, with volume applied to the input. - * - * @tparam Q - Number of bits for fixed point operations. - * @param output - Output mix buffer. - * @param input - Input mix buffer. - * @param volume - Volume applied to the input. - * @param ramp - Ramp applied to volume every sample. - * @param sample_count - Number of samples to process. - * @return The final gained input sample, used for depopping. - */ + template s32 ApplyMixRamp(std::span output, std::span input, const f32 volume_, const f32 ramp_, const u32 sample_count) { @@ -40,10 +30,8 @@ s32 ApplyMixRamp(std::span output, std::span input, const f32 vo return sample.to_int(); } -template s32 ApplyMixRamp<15>(std::span, std::span, const f32, const f32, - const u32); -template s32 ApplyMixRamp<23>(std::span, std::span, const f32, const f32, - const u32); +template s32 ApplyMixRamp<15>(std::span, std::span, f32, f32, u32); +template s32 ApplyMixRamp<23>(std::span, std::span, f32, f32, u32); void MixRampCommand::Dump(const ADSP::CommandListProcessor& processor, std::string& string) { const auto ramp{(volume - prev_volume) / static_cast(processor.sample_count)}; diff --git a/src/audio_core/renderer/command/mix/mix_ramp.h b/src/audio_core/renderer/command/mix/mix_ramp.h index 770f57e80..52f74a273 100644 --- a/src/audio_core/renderer/command/mix/mix_ramp.h +++ b/src/audio_core/renderer/command/mix/mix_ramp.h @@ -61,13 +61,13 @@ struct MixRampCommand : ICommand { * @tparam Q - Number of bits for fixed point operations. * @param output - Output mix buffer. * @param input - Input mix buffer. - * @param volume - Volume applied to the input. - * @param ramp - Ramp applied to volume every sample. + * @param volume_ - Volume applied to the input. + * @param ramp_ - Ramp applied to volume every sample. * @param sample_count - Number of samples to process. * @return The final gained input sample, used for depopping. */ template -s32 ApplyMixRamp(std::span output, std::span input, const f32 volume_, - const f32 ramp_, const u32 sample_count); +s32 ApplyMixRamp(std::span output, std::span input, f32 volume_, f32 ramp_, + u32 sample_count); } // namespace AudioCore::AudioRenderer diff --git a/src/audio_core/renderer/command/mix/mix_ramp_grouped.h b/src/audio_core/renderer/command/mix/mix_ramp_grouped.h index 027276e5a..3b0ce67ef 100644 --- a/src/audio_core/renderer/command/mix/mix_ramp_grouped.h +++ b/src/audio_core/renderer/command/mix/mix_ramp_grouped.h @@ -50,9 +50,9 @@ struct MixRampGroupedCommand : ICommand { std::array inputs; /// Output mix buffer indexes for each mix buffer std::array outputs; - /// Previous mix vloumes for each mix buffer + /// Previous mix volumes for each mix buffer std::array prev_volumes; - /// Current mix vloumes for each mix buffer + /// Current mix volumes for each mix buffer std::array volumes; /// Pointer to the previous sample buffer, used for depop CpuAddr previous_samples; -- cgit v1.2.3