Unreviewed, rolling out r110951.
[WebKit-https.git] / Source / WebCore / platform / audio / DynamicsCompressor.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 Computer, 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 DynamicsCompressor_h
30 #define DynamicsCompressor_h
31
32 #include "AudioArray.h"
33 #include "DynamicsCompressorKernel.h"
34 #include "ZeroPole.h"
35
36 #include <wtf/OwnArrayPtr.h>
37
38 namespace WebCore {
39
40 class AudioBus;
41
42 // DynamicsCompressor implements a flexible audio dynamics compression effect such as
43 // is commonly used in musical production and game audio. It lowers the volume
44 // of the loudest parts of the signal and raises the volume of the softest parts,
45 // making the sound richer, fuller, and more controlled.
46
47 class DynamicsCompressor {
48 public:
49     enum {
50         ParamThreshold,
51         ParamKnee,
52         ParamRatio,
53         ParamAttack,
54         ParamRelease,
55         ParamPreDelay,
56         ParamReleaseZone1,
57         ParamReleaseZone2,
58         ParamReleaseZone3,
59         ParamReleaseZone4,
60         ParamPostGain,
61         ParamFilterStageGain,
62         ParamFilterStageRatio,
63         ParamFilterAnchor,
64         ParamEffectBlend,
65         ParamReduction,
66         ParamLast
67     };
68
69     DynamicsCompressor(float sampleRate, unsigned numberOfChannels);
70
71     void process(const AudioBus* sourceBus, AudioBus* destinationBus, unsigned framesToProcess);
72     void reset();
73     void setNumberOfChannels(unsigned);
74
75     void setParameterValue(unsigned parameterID, float value);
76     float parameterValue(unsigned parameterID);
77
78     float sampleRate() const { return m_sampleRate; }
79     float nyquist() const { return m_sampleRate / 2; }
80
81     double tailTime() const { return 0; }
82     double latencyTime() const { return m_compressor.latencyFrames() / static_cast<double>(sampleRate()); }
83
84 protected:
85     unsigned m_numberOfChannels;
86
87     // m_parameters holds the tweakable compressor parameters.
88     // FIXME: expose some of the most important ones (such as threshold, attack, release)
89     // as DynamicsCompressorNode attributes.
90     float m_parameters[ParamLast];
91     void initializeParameters();
92
93     float m_sampleRate;
94
95     // Emphasis filter controls.
96     float m_lastFilterStageRatio;
97     float m_lastAnchor;
98     float m_lastFilterStageGain;
99
100     typedef struct {
101         ZeroPole filters[4];
102     } ZeroPoleFilterPack4;
103
104     // Per-channel emphasis filters.
105     Vector<OwnPtr<ZeroPoleFilterPack4> > m_preFilterPacks;
106     Vector<OwnPtr<ZeroPoleFilterPack4> > m_postFilterPacks;
107
108     OwnArrayPtr<const float*> m_sourceChannels;
109     OwnArrayPtr<float*> m_destinationChannels;
110
111     void setEmphasisStageParameters(unsigned stageIndex, float gain, float normalizedFrequency /* 0 -> 1 */);
112     void setEmphasisParameters(float gain, float anchorFreq, float filterStageRatio);
113
114     // The core compressor.
115     DynamicsCompressorKernel m_compressor;
116 };
117
118 } // namespace WebCore
119
120 #endif // DynamicsCompressor_h