summaryrefslogtreecommitdiffstats
path: root/dom/media/webaudio/blink/DynamicsCompressor.h
blob: 1838e268fe5dbf4669c5bdd9f51d796bf8603ae8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DynamicsCompressor_h
#define DynamicsCompressor_h

#include "DynamicsCompressorKernel.h"
#include "ZeroPole.h"

#include "nsTArray.h"
#include "mozilla/MemoryReporting.h"
#include "mozilla/UniquePtr.h"

namespace mozilla {
class AudioBlock;
}  // namespace mozilla

namespace WebCore {

using mozilla::AudioBlock;
using mozilla::UniquePtr;

// DynamicsCompressor implements a flexible audio dynamics compression effect
// such as is commonly used in musical production and game audio. It lowers the
// volume of the loudest parts of the signal and raises the volume of the
// softest parts, making the sound richer, fuller, and more controlled.

class DynamicsCompressor {
 public:
  enum {
    ParamThreshold,
    ParamKnee,
    ParamRatio,
    ParamAttack,
    ParamRelease,
    ParamPreDelay,
    ParamReleaseZone1,
    ParamReleaseZone2,
    ParamReleaseZone3,
    ParamReleaseZone4,
    ParamPostGain,
    ParamFilterStageGain,
    ParamFilterStageRatio,
    ParamFilterAnchor,
    ParamEffectBlend,
    ParamReduction,
    ParamLast
  };

  DynamicsCompressor(float sampleRate, unsigned numberOfChannels);

  void process(const AudioBlock* sourceChunk, AudioBlock* destinationChunk,
               unsigned framesToProcess);
  void reset();
  void setNumberOfChannels(unsigned);
  unsigned numberOfChannels() const { return m_numberOfChannels; }

  void setParameterValue(unsigned parameterID, float value);
  float parameterValue(unsigned parameterID);

  float sampleRate() const { return m_sampleRate; }
  float nyquist() const { return m_sampleRate / 2; }

  double tailTime() const { return 0; }
  double latencyTime() const {
    return m_compressor.latencyFrames() / static_cast<double>(sampleRate());
  }

  size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;

 protected:
  unsigned m_numberOfChannels;

  // m_parameters holds the tweakable compressor parameters.
  float m_parameters[ParamLast];
  void initializeParameters();

  float m_sampleRate;

  // Emphasis filter controls.
  float m_lastFilterStageRatio;
  float m_lastAnchor;
  float m_lastFilterStageGain;

  struct ZeroPoleFilterPack4 {
    ZeroPole filters[4];
    size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const {
      return aMallocSizeOf(this);
    }
  };

  // Per-channel emphasis filters.
  nsTArray<UniquePtr<ZeroPoleFilterPack4> > m_preFilterPacks;
  nsTArray<UniquePtr<ZeroPoleFilterPack4> > m_postFilterPacks;

  mozilla::UniquePtr<const float*[]> m_sourceChannels;
  mozilla::UniquePtr<float*[]> m_destinationChannels;

  void setEmphasisStageParameters(unsigned stageIndex, float gain,
                                  float normalizedFrequency /* 0 -> 1 */);
  void setEmphasisParameters(float gain, float anchorFreq,
                             float filterStageRatio);

  // The core compressor.
  DynamicsCompressorKernel m_compressor;
};

}  // namespace WebCore

#endif  // DynamicsCompressor_h