Unreviewed, reverting r278846.
[WebKit-https.git] / Source / WebCore / platform / audio / DynamicsCompressorKernel.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef DynamicsCompressorKernel_h
30 #define DynamicsCompressorKernel_h
31
32 #include "AudioArray.h"
33 #include <memory>
34 #include <wtf/Vector.h>
35
36 namespace WebCore {
37
38 class DynamicsCompressorKernel final {
39     WTF_MAKE_FAST_ALLOCATED;
40 public:
41     explicit DynamicsCompressorKernel(float sampleRate, unsigned numberOfChannels);
42
43     void setNumberOfChannels(unsigned);
44
45     // Performs stereo-linked compression.
46     void process(const float* sourceChannels[],
47                  float* destinationChannels[],
48                  unsigned numberOfChannels,
49                  unsigned framesToProcess,
50
51                  float dbThreshold,
52                  float dbKnee,
53                  float ratio,
54                  float attackTime,
55                  float releaseTime,
56                  float preDelayTime,
57                  float dbPostGain,
58                  float effectBlend,
59
60                  float releaseZone1,
61                  float releaseZone2,
62                  float releaseZone3,
63                  float releaseZone4
64                  );
65
66     void reset();
67
68     unsigned latencyFrames() const { return m_lastPreDelayFrames; }
69
70     float sampleRate() const { return m_sampleRate; }
71
72     float meteringGain() const { return m_meteringGain; }
73
74     double tailTime() const;
75
76 protected:
77     static constexpr float uninitializedValue = -1;
78     float m_sampleRate;
79
80     float m_detectorAverage;
81     float m_compressorGain;
82
83     // Metering
84     float m_meteringReleaseK;
85     float m_meteringGain;
86
87     // Lookahead section.
88     enum { MaxPreDelayFrames = 1024 };
89     enum { MaxPreDelayFramesMask = MaxPreDelayFrames - 1 };
90     enum { DefaultPreDelayFrames = 256 }; // setPreDelayTime() will override this initial value
91     unsigned m_lastPreDelayFrames { DefaultPreDelayFrames };
92     void setPreDelayTime(float);
93
94     Vector<std::unique_ptr<AudioFloatArray>> m_preDelayBuffers;
95     int m_preDelayReadIndex { 0 };
96     int m_preDelayWriteIndex { DefaultPreDelayFrames };
97
98     float m_maxAttackCompressionDiffDb;
99
100     // Static compression curve.
101     float kneeCurve(float x, float k);
102     float saturate(float x, float k);
103     float slopeAt(float x, float k);
104     float kAtSlope(float desiredSlope);
105
106     float updateStaticCurveParameters(float dbThreshold, float dbKnee, float ratio);
107
108     // Amount of input change in dB required for 1 dB of output change.
109     // This applies to the portion of the curve above m_kneeThresholdDb (see below).
110     float m_ratio { uninitializedValue };
111     float m_slope { uninitializedValue }; // Inverse ratio.
112
113     // The input to output change below the threshold is linear 1:1.
114     float m_linearThreshold { uninitializedValue };
115     float m_dbThreshold { uninitializedValue };
116
117     // m_dbKnee is the number of dB above the threshold before we enter the "ratio" portion of the curve.
118     // m_kneeThresholdDb = m_dbThreshold + m_dbKnee
119     // The portion between m_dbThreshold and m_kneeThresholdDb is the "soft knee" portion of the curve
120     // which transitions smoothly from the linear portion to the ratio portion.
121     float m_dbKnee { uninitializedValue };
122     float m_kneeThreshold { uninitializedValue };
123     float m_kneeThresholdDb { uninitializedValue };
124     float m_ykneeThresholdDb { uninitializedValue };
125
126     // Internal parameter for the knee portion of the curve.
127     float m_K { uninitializedValue };
128 };
129
130 } // namespace WebCore
131
132 #endif // DynamicsCompressorKernel_h