aboutsummaryrefslogtreecommitdiffstats
path: root/Alc/mastering.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'Alc/mastering.cpp')
-rw-r--r--Alc/mastering.cpp479
1 files changed, 0 insertions, 479 deletions
diff --git a/Alc/mastering.cpp b/Alc/mastering.cpp
deleted file mode 100644
index 551fdcdf..00000000
--- a/Alc/mastering.cpp
+++ /dev/null
@@ -1,479 +0,0 @@
-#include "config.h"
-
-#include <cmath>
-#include <limits>
-#include <algorithm>
-#include <functional>
-
-#include "mastering.h"
-#include "alu.h"
-#include "almalloc.h"
-#include "math_defs.h"
-
-
-/* These structures assume BUFFERSIZE is a power of 2. */
-static_assert((BUFFERSIZE & (BUFFERSIZE-1)) == 0, "BUFFERSIZE is not a power of 2");
-
-struct SlidingHold {
- alignas(16) ALfloat mValues[BUFFERSIZE];
- ALsizei mExpiries[BUFFERSIZE];
- ALsizei mLowerIndex;
- ALsizei mUpperIndex;
- ALsizei mLength;
-};
-
-
-namespace {
-
-using namespace std::placeholders;
-
-/* This sliding hold follows the input level with an instant attack and a
- * fixed duration hold before an instant release to the next highest level.
- * It is a sliding window maximum (descending maxima) implementation based on
- * Richard Harter's ascending minima algorithm available at:
- *
- * http://www.richardhartersworld.com/cri/2001/slidingmin.html
- */
-ALfloat UpdateSlidingHold(SlidingHold *Hold, const ALsizei i, const ALfloat in)
-{
- static constexpr ALsizei mask{BUFFERSIZE - 1};
- const ALsizei length{Hold->mLength};
- ALfloat (&values)[BUFFERSIZE] = Hold->mValues;
- ALsizei (&expiries)[BUFFERSIZE] = Hold->mExpiries;
- ALsizei lowerIndex{Hold->mLowerIndex};
- ALsizei upperIndex{Hold->mUpperIndex};
-
- ASSUME(upperIndex >= 0);
- ASSUME(lowerIndex >= 0);
-
- if(i >= expiries[upperIndex])
- upperIndex = (upperIndex + 1) & mask;
-
- if(in >= values[upperIndex])
- {
- values[upperIndex] = in;
- expiries[upperIndex] = i + length;
- lowerIndex = upperIndex;
- }
- else
- {
- do {
- do {
- if(!(in >= values[lowerIndex]))
- goto found_place;
- } while(lowerIndex--);
- lowerIndex = mask;
- } while(1);
- found_place:
-
- lowerIndex = (lowerIndex + 1) & mask;
- values[lowerIndex] = in;
- expiries[lowerIndex] = i + length;
- }
-
- Hold->mLowerIndex = lowerIndex;
- Hold->mUpperIndex = upperIndex;
-
- return values[upperIndex];
-}
-
-void ShiftSlidingHold(SlidingHold *Hold, const ALsizei n)
-{
- ASSUME(Hold->mUpperIndex >= 0);
- ASSUME(Hold->mLowerIndex >= 0);
-
- auto exp_begin = std::begin(Hold->mExpiries) + Hold->mUpperIndex;
- auto exp_last = std::begin(Hold->mExpiries) + Hold->mLowerIndex;
- if(exp_last < exp_begin)
- {
- std::transform(exp_begin, std::end(Hold->mExpiries), exp_begin,
- std::bind(std::minus<ALsizei>{}, _1, n));
- exp_begin = std::begin(Hold->mExpiries);
- }
- std::transform(exp_begin, exp_last+1, exp_begin, std::bind(std::minus<ALsizei>{}, _1, n));
-}
-
-
-/* Multichannel compression is linked via the absolute maximum of all
- * channels.
- */
-void LinkChannels(Compressor *Comp, const ALsizei SamplesToDo, const FloatBufferLine *OutBuffer)
-{
- const ALsizei index{Comp->mLookAhead};
- const ALuint numChans{Comp->mNumChans};
-
- ASSUME(SamplesToDo > 0);
- ASSUME(numChans > 0);
- ASSUME(index >= 0);
-
- auto side_begin = std::begin(Comp->mSideChain) + index;
- std::fill(side_begin, side_begin+SamplesToDo, 0.0f);
-
- auto fill_max = [SamplesToDo,side_begin](const FloatBufferLine &input) -> void
- {
- const ALfloat *RESTRICT buffer{al::assume_aligned<16>(input.data())};
- auto max_abs = std::bind(maxf, _1, std::bind(static_cast<float(&)(float)>(std::fabs), _2));
- std::transform(side_begin, side_begin+SamplesToDo, buffer, side_begin, max_abs);
- };
- std::for_each(OutBuffer, OutBuffer+numChans, fill_max);
-}
-
-/* This calculates the squared crest factor of the control signal for the
- * basic automation of the attack/release times. As suggested by the paper,
- * it uses an instantaneous squared peak detector and a squared RMS detector
- * both with 200ms release times.
- */
-static void CrestDetector(Compressor *Comp, const ALsizei SamplesToDo)
-{
- const ALfloat a_crest{Comp->mCrestCoeff};
- const ALsizei index{Comp->mLookAhead};
- ALfloat y2_peak{Comp->mLastPeakSq};
- ALfloat y2_rms{Comp->mLastRmsSq};
-
- ASSUME(SamplesToDo > 0);
- ASSUME(index >= 0);
-
- auto calc_crest = [&y2_rms,&y2_peak,a_crest](const ALfloat x_abs) noexcept -> ALfloat
- {
- ALfloat x2 = maxf(0.000001f, x_abs * x_abs);
-
- y2_peak = maxf(x2, lerp(x2, y2_peak, a_crest));
- y2_rms = lerp(x2, y2_rms, a_crest);
- return y2_peak / y2_rms;
- };
- auto side_begin = std::begin(Comp->mSideChain) + index;
- std::transform(side_begin, side_begin+SamplesToDo, std::begin(Comp->mCrestFactor), calc_crest);
-
- Comp->mLastPeakSq = y2_peak;
- Comp->mLastRmsSq = y2_rms;
-}
-
-/* The side-chain starts with a simple peak detector (based on the absolute
- * value of the incoming signal) and performs most of its operations in the
- * log domain.
- */
-void PeakDetector(Compressor *Comp, const ALsizei SamplesToDo)
-{
- const ALsizei index{Comp->mLookAhead};
-
- ASSUME(SamplesToDo > 0);
- ASSUME(index >= 0);
-
- /* Clamp the minimum amplitude to near-zero and convert to logarithm. */
- auto side_begin = std::begin(Comp->mSideChain) + index;
- std::transform(side_begin, side_begin+SamplesToDo, side_begin,
- std::bind(static_cast<float(&)(float)>(std::log), std::bind(maxf, 0.000001f, _1)));
-}
-
-/* An optional hold can be used to extend the peak detector so it can more
- * solidly detect fast transients. This is best used when operating as a
- * limiter.
- */
-void PeakHoldDetector(Compressor *Comp, const ALsizei SamplesToDo)
-{
- const ALsizei index{Comp->mLookAhead};
-
- ASSUME(SamplesToDo > 0);
- ASSUME(index >= 0);
-
- SlidingHold *hold{Comp->mHold};
- ALsizei i{0};
- auto detect_peak = [&i,hold](const ALfloat x_abs) -> ALfloat
- {
- const ALfloat x_G{std::log(maxf(0.000001f, x_abs))};
- return UpdateSlidingHold(hold, i++, x_G);
- };
- auto side_begin = std::begin(Comp->mSideChain) + index;
- std::transform(side_begin, side_begin+SamplesToDo, side_begin, detect_peak);
-
- ShiftSlidingHold(hold, SamplesToDo);
-}
-
-/* This is the heart of the feed-forward compressor. It operates in the log
- * domain (to better match human hearing) and can apply some basic automation
- * to knee width, attack/release times, make-up/post gain, and clipping
- * reduction.
- */
-void GainCompressor(Compressor *Comp, const ALsizei SamplesToDo)
-{
- const bool autoKnee{Comp->mAuto.Knee};
- const bool autoAttack{Comp->mAuto.Attack};
- const bool autoRelease{Comp->mAuto.Release};
- const bool autoPostGain{Comp->mAuto.PostGain};
- const bool autoDeclip{Comp->mAuto.Declip};
- const ALsizei lookAhead{Comp->mLookAhead};
- const ALfloat threshold{Comp->mThreshold};
- const ALfloat slope{Comp->mSlope};
- const ALfloat attack{Comp->mAttack};
- const ALfloat release{Comp->mRelease};
- const ALfloat c_est{Comp->mGainEstimate};
- const ALfloat a_adp{Comp->mAdaptCoeff};
- const ALfloat (&crestFactor)[BUFFERSIZE] = Comp->mCrestFactor;
- ALfloat (&sideChain)[BUFFERSIZE*2] = Comp->mSideChain;
- ALfloat postGain{Comp->mPostGain};
- ALfloat knee{Comp->mKnee};
- ALfloat t_att{attack};
- ALfloat t_rel{release - attack};
- ALfloat a_att{std::exp(-1.0f / t_att)};
- ALfloat a_rel{std::exp(-1.0f / t_rel)};
- ALfloat y_1{Comp->mLastRelease};
- ALfloat y_L{Comp->mLastAttack};
- ALfloat c_dev{Comp->mLastGainDev};
-
- ASSUME(SamplesToDo > 0);
- ASSUME(lookAhead >= 0);
-
- for(ALsizei i{0};i < SamplesToDo;i++)
- {
- if(autoKnee)
- knee = maxf(0.0f, 2.5f * (c_dev + c_est));
- const ALfloat knee_h{0.5f * knee};
-
- /* This is the gain computer. It applies a static compression curve
- * to the control signal.
- */
- const ALfloat x_over{sideChain[lookAhead+i] - threshold};
- const ALfloat y_G{
- (x_over <= -knee_h) ? 0.0f :
- (std::fabs(x_over) < knee_h) ? (x_over + knee_h) * (x_over + knee_h) / (2.0f * knee) :
- x_over
- };
-
- const ALfloat y2_crest{crestFactor[i]};
- if(autoAttack)
- {
- t_att = 2.0f*attack/y2_crest;
- a_att = std::exp(-1.0f / t_att);
- }
- if(autoRelease)
- {
- t_rel = 2.0f*release/y2_crest - t_att;
- a_rel = std::exp(-1.0f / t_rel);
- }
-
- /* Gain smoothing (ballistics) is done via a smooth decoupled peak
- * detector. The attack time is subtracted from the release time
- * above to compensate for the chained operating mode.
- */
- const ALfloat x_L{-slope * y_G};
- y_1 = maxf(x_L, lerp(x_L, y_1, a_rel));
- y_L = lerp(y_1, y_L, a_att);
-
- /* Knee width and make-up gain automation make use of a smoothed
- * measurement of deviation between the control signal and estimate.
- * The estimate is also used to bias the measurement to hot-start its
- * average.
- */
- c_dev = lerp(-(y_L+c_est), c_dev, a_adp);
-
- if(autoPostGain)
- {
- /* Clipping reduction is only viable when make-up gain is being
- * automated. It modifies the deviation to further attenuate the
- * control signal when clipping is detected. The adaptation time
- * is sufficiently long enough to suppress further clipping at the
- * same output level.
- */
- if(autoDeclip)
- c_dev = maxf(c_dev, sideChain[i] - y_L - threshold - c_est);
-
- postGain = -(c_dev + c_est);
- }
-
- sideChain[i] = std::exp(postGain - y_L);
- }
-
- Comp->mLastRelease = y_1;
- Comp->mLastAttack = y_L;
- Comp->mLastGainDev = c_dev;
-}
-
-/* Combined with the hold time, a look-ahead delay can improve handling of
- * fast transients by allowing the envelope time to converge prior to
- * reaching the offending impulse. This is best used when operating as a
- * limiter.
- */
-void SignalDelay(Compressor *Comp, const ALsizei SamplesToDo, FloatBufferLine *OutBuffer)
-{
- const ALuint numChans{Comp->mNumChans};
- const ALsizei lookAhead{Comp->mLookAhead};
-
- ASSUME(SamplesToDo > 0);
- ASSUME(numChans > 0);
- ASSUME(lookAhead > 0);
-
- for(ALuint c{0};c < numChans;c++)
- {
- ALfloat *inout{al::assume_aligned<16>(OutBuffer[c].data())};
- ALfloat *delaybuf{al::assume_aligned<16>(Comp->mDelay[c].data())};
-
- auto inout_end = inout + SamplesToDo;
- if(LIKELY(SamplesToDo >= lookAhead))
- {
- auto delay_end = std::rotate(inout, inout_end - lookAhead, inout_end);
- std::swap_ranges(inout, delay_end, delaybuf);
- }
- else
- {
- auto delay_start = std::swap_ranges(inout, inout_end, delaybuf);
- std::rotate(delaybuf, delay_start, delaybuf + lookAhead);
- }
- }
-}
-
-} // namespace
-
-/* The compressor is initialized with the following settings:
- *
- * NumChans - Number of channels to process.
- * SampleRate - Sample rate to process.
- * AutoKnee - Whether to automate the knee width parameter.
- * AutoAttack - Whether to automate the attack time parameter.
- * AutoRelease - Whether to automate the release time parameter.
- * AutoPostGain - Whether to automate the make-up (post) gain parameter.
- * AutoDeclip - Whether to automate clipping reduction. Ignored when
- * not automating make-up gain.
- * LookAheadTime - Look-ahead time (in seconds).
- * HoldTime - Peak hold-time (in seconds).
- * PreGainDb - Gain applied before detection (in dB).
- * PostGainDb - Make-up gain applied after compression (in dB).
- * ThresholdDb - Triggering threshold (in dB).
- * Ratio - Compression ratio (x:1). Set to INFINITY for true
- * limiting. Ignored when automating knee width.
- * KneeDb - Knee width (in dB). Ignored when automating knee
- * width.
- * AttackTimeMin - Attack time (in seconds). Acts as a maximum when
- * automating attack time.
- * ReleaseTimeMin - Release time (in seconds). Acts as a maximum when
- * automating release time.
- */
-std::unique_ptr<Compressor> CompressorInit(const ALuint NumChans, const ALuint SampleRate,
- const ALboolean AutoKnee, const ALboolean AutoAttack, const ALboolean AutoRelease,
- const ALboolean AutoPostGain, const ALboolean AutoDeclip, const ALfloat LookAheadTime,
- const ALfloat HoldTime, const ALfloat PreGainDb, const ALfloat PostGainDb,
- const ALfloat ThresholdDb, const ALfloat Ratio, const ALfloat KneeDb, const ALfloat AttackTime,
- const ALfloat ReleaseTime)
-{
- const auto lookAhead = static_cast<ALsizei>(
- clampf(std::round(LookAheadTime*SampleRate), 0.0f, BUFFERSIZE-1));
- const auto hold = static_cast<ALsizei>(
- clampf(std::round(HoldTime*SampleRate), 0.0f, BUFFERSIZE-1));
-
- size_t size{sizeof(Compressor)};
- if(lookAhead > 0)
- {
- size += sizeof(*Compressor::mDelay) * NumChans;
- /* The sliding hold implementation doesn't handle a length of 1. A 1-
- * sample hold is useless anyway, it would only ever give back what was
- * just given to it.
- */
- if(hold > 1)
- size += sizeof(*Compressor::mHold);
- }
-
- auto Comp = std::unique_ptr<Compressor>{new (al_calloc(16, size)) Compressor{}};
- Comp->mNumChans = NumChans;
- Comp->mSampleRate = SampleRate;
- Comp->mAuto.Knee = AutoKnee != AL_FALSE;
- Comp->mAuto.Attack = AutoAttack != AL_FALSE;
- Comp->mAuto.Release = AutoRelease != AL_FALSE;
- Comp->mAuto.PostGain = AutoPostGain != AL_FALSE;
- Comp->mAuto.Declip = AutoPostGain && AutoDeclip;
- Comp->mLookAhead = lookAhead;
- Comp->mPreGain = std::pow(10.0f, PreGainDb / 20.0f);
- Comp->mPostGain = PostGainDb * std::log(10.0f) / 20.0f;
- Comp->mThreshold = ThresholdDb * std::log(10.0f) / 20.0f;
- Comp->mSlope = 1.0f / maxf(1.0f, Ratio) - 1.0f;
- Comp->mKnee = maxf(0.0f, KneeDb * std::log(10.0f) / 20.0f);
- Comp->mAttack = maxf(1.0f, AttackTime * SampleRate);
- Comp->mRelease = maxf(1.0f, ReleaseTime * SampleRate);
-
- /* Knee width automation actually treats the compressor as a limiter. By
- * varying the knee width, it can effectively be seen as applying
- * compression over a wide range of ratios.
- */
- if(AutoKnee)
- Comp->mSlope = -1.0f;
-
- if(lookAhead > 0)
- {
- if(hold > 1)
- {
- Comp->mHold = ::new (static_cast<void*>(Comp.get() + 1)) SlidingHold{};
- Comp->mHold->mValues[0] = -std::numeric_limits<float>::infinity();
- Comp->mHold->mExpiries[0] = hold;
- Comp->mHold->mLength = hold;
- Comp->mDelay = ::new (static_cast<void*>(Comp->mHold + 1)) FloatBufferLine[NumChans];
- }
- else
- {
- Comp->mDelay = ::new (static_cast<void*>(Comp.get() + 1)) FloatBufferLine[NumChans];
- }
- }
-
- Comp->mCrestCoeff = std::exp(-1.0f / (0.200f * SampleRate)); // 200ms
- Comp->mGainEstimate = Comp->mThreshold * -0.5f * Comp->mSlope;
- Comp->mAdaptCoeff = std::exp(-1.0f / (2.0f * SampleRate)); // 2s
-
- return Comp;
-}
-
-Compressor::~Compressor()
-{
- if(mHold)
- al::destroy_at(mHold);
- mHold = nullptr;
- if(mDelay)
- al::destroy_n(mDelay, mNumChans);
- mDelay = nullptr;
-}
-
-
-void Compressor::process(const ALsizei SamplesToDo, FloatBufferLine *OutBuffer)
-{
- const ALuint numChans{mNumChans};
-
- ASSUME(SamplesToDo > 0);
- ASSUME(numChans > 0);
-
- const ALfloat preGain{mPreGain};
- if(preGain != 1.0f)
- {
- auto apply_gain = [SamplesToDo,preGain](FloatBufferLine &input) noexcept -> void
- {
- ALfloat *buffer{al::assume_aligned<16>(input.data())};
- std::transform(buffer, buffer+SamplesToDo, buffer,
- std::bind(std::multiplies<float>{}, _1, preGain));
- };
- std::for_each(OutBuffer, OutBuffer+numChans, apply_gain);
- }
-
- LinkChannels(this, SamplesToDo, OutBuffer);
-
- if(mAuto.Attack || mAuto.Release)
- CrestDetector(this, SamplesToDo);
-
- if(mHold)
- PeakHoldDetector(this, SamplesToDo);
- else
- PeakDetector(this, SamplesToDo);
-
- GainCompressor(this, SamplesToDo);
-
- if(mDelay)
- SignalDelay(this, SamplesToDo, OutBuffer);
-
- const ALfloat (&sideChain)[BUFFERSIZE*2] = mSideChain;
- auto apply_comp = [SamplesToDo,&sideChain](FloatBufferLine &input) noexcept -> void
- {
- ALfloat *buffer{al::assume_aligned<16>(input.data())};
- const ALfloat *gains{al::assume_aligned<16>(&sideChain[0])};
- std::transform(gains, gains+SamplesToDo, buffer, buffer,
- std::bind(std::multiplies<float>{}, _1, _2));
- };
- std::for_each(OutBuffer, OutBuffer+numChans, apply_comp);
-
- ASSUME(mLookAhead >= 0);
- auto side_begin = std::begin(mSideChain) + SamplesToDo;
- std::copy(side_begin, side_begin+mLookAhead, std::begin(mSideChain));
-}