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