src/third_party/WebKit/Source/modules/webaudio/DynamicsCompressorNode.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  * 1.  Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2.  Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #ifndef DynamicsCompressorNode_h
  26 #define DynamicsCompressorNode_h
  27
  28 #include "modules/webaudio/AudioNode.h"
  29 #include "modules/webaudio/AudioParam.h"
  30 #include "wtf/OwnPtr.h"
  31
  32 namespace blink {
  33
  34 class DynamicsCompressor;
  35
  36 class DynamicsCompressorNode final : public AudioNode {
  37     DEFINE_WRAPPERTYPEINFO();
  38 public:
  39     static DynamicsCompressorNode* create(AudioContext* context, float sampleRate)
  40     {
  41         return new DynamicsCompressorNode(context, sampleRate);
  42     }
  43
  44     virtual ~DynamicsCompressorNode();
  45
  46     // AudioNode
  47     virtual void dispose() override;
  48     virtual void process(size_t framesToProcess) override;
  49     virtual void initialize() override;
  50     virtual void uninitialize() override;
  51     virtual void clearInternalStateWhenDisabled() override;
  52
  53     // Static compression curve parameters.
  54     AudioParam* threshold() { return m_threshold.get(); }
  55     AudioParam* knee() { return m_knee.get(); }
  56     AudioParam* ratio() { return m_ratio.get(); }
  57     AudioParam* attack() { return m_attack.get(); }
  58     AudioParam* release() { return m_release.get(); }
  59
  60     // Amount by which the compressor is currently compressing the signal in decibels.
  61     AudioParam* reduction() { return m_reduction.get(); }
  62
  63     virtual void trace(Visitor*) override;
  64
  65 private:
  66     virtual double tailTime() const override;
  67     virtual double latencyTime() const override;
  68
  69     DynamicsCompressorNode(AudioContext*, float sampleRate);
  70
  71     OwnPtr<DynamicsCompressor> m_dynamicsCompressor;
  72     Member<AudioParam> m_threshold;
  73     Member<AudioParam> m_knee;
  74     Member<AudioParam> m_ratio;
  75     Member<AudioParam> m_reduction;
  76     Member<AudioParam> m_attack;
  77     Member<AudioParam> m_release;
  78 };
  79
  80 } // namespace blink
  81
  82 #endif // DynamicsCompressorNode_h