d949f30689f0a85f75e3c031379d86d577ede947
[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         ParamHeadroom,
52         ParamAttack,
53         ParamRelease,
54         ParamPreDelay,
55         ParamReleaseZone1,
56         ParamReleaseZone2,
57         ParamReleaseZone3,
58         ParamReleaseZone4,
59         ParamPostGain,
60         ParamFilterStageGain,
61         ParamFilterStageRatio,
62         ParamFilterAnchor,
63         ParamEffectBlend,
64         ParamLast
65     };
66
67     DynamicsCompressor(float sampleRate, unsigned numberOfChannels);
68
69     void process(const AudioBus* sourceBus, AudioBus* destinationBus, unsigned framesToProcess);
70     void reset();
71     void setNumberOfChannels(unsigned);
72
73     float parameterValue(unsigned parameterID);
74
75     float sampleRate() const { return m_sampleRate; }
76     float nyquist() const { return m_sampleRate / 2; }
77
78 protected:
79     unsigned m_numberOfChannels;
80
81     // m_parameters holds the tweakable compressor parameters.
82     // FIXME: expose some of the most important ones (such as threshold, attack, release)
83     // as DynamicsCompressorNode attributes.
84     float m_parameters[ParamLast];
85     void initializeParameters();
86
87     float m_sampleRate;
88
89     // Emphasis filter controls.
90     float m_lastFilterStageRatio;
91     float m_lastAnchor;
92     float m_lastFilterStageGain;
93
94     typedef struct {
95         ZeroPole filters[4];
96     } ZeroPoleFilterPack4;
97
98     // Per-channel emphasis filters.
99     Vector<OwnPtr<ZeroPoleFilterPack4> > m_preFilterPacks;
100     Vector<OwnPtr<ZeroPoleFilterPack4> > m_postFilterPacks;
101
102     OwnArrayPtr<const float*> m_sourceChannels;
103     OwnArrayPtr<float*> m_destinationChannels;
104
105     void setEmphasisStageParameters(unsigned stageIndex, float gain, float normalizedFrequency /* 0 -> 1 */);
106     void setEmphasisParameters(float gain, float anchorFreq, float filterStageRatio);
107
108     // The core compressor.
109     DynamicsCompressorKernel m_compressor;
110 };
111
112 } // namespace WebCore
113
114 #endif // DynamicsCompressor_h