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 WebCore {
  33
  34 class DynamicsCompressor;
  35
  36 class DynamicsCompressorNode FINAL : public AudioNode {
  37 public:
  38     static PassRefPtrWillBeRawPtr<DynamicsCompressorNode> create(AudioContext* context, float sampleRate)
  39     {
  40         return adoptRefWillBeNoop(new DynamicsCompressorNode(context, sampleRate));
  41     }
  42
  43     virtual ~DynamicsCompressorNode();
  44
  45     // AudioNode
  46     virtual void process(size_t framesToProcess) OVERRIDE;
  47     virtual void initialize() OVERRIDE;
  48     virtual void uninitialize() OVERRIDE;
  49
  50     // Static compression curve parameters.
  51     AudioParam* threshold() { return m_threshold.get(); }
  52     AudioParam* knee() { return m_knee.get(); }
  53     AudioParam* ratio() { return m_ratio.get(); }
  54     AudioParam* attack() { return m_attack.get(); }
  55     AudioParam* release() { return m_release.get(); }
  56
  57     // Amount by which the compressor is currently compressing the signal in decibels.
  58     AudioParam* reduction() { return m_reduction.get(); }
  59
  60     virtual void trace(Visitor*) OVERRIDE;
  61
  62 private:
  63     virtual double tailTime() const OVERRIDE;
  64     virtual double latencyTime() const OVERRIDE;
  65
  66     DynamicsCompressorNode(AudioContext*, float sampleRate);
  67
  68     OwnPtr<DynamicsCompressor> m_dynamicsCompressor;
  69     RefPtrWillBeMember<AudioParam> m_threshold;
  70     RefPtrWillBeMember<AudioParam> m_knee;
  71     RefPtrWillBeMember<AudioParam> m_ratio;
  72     RefPtrWillBeMember<AudioParam> m_reduction;
  73     RefPtrWillBeMember<AudioParam> m_attack;
  74     RefPtrWillBeMember<AudioParam> m_release;
  75 };
  76
  77 } // namespace WebCore
  78
  79 #endif // DynamicsCompressorNode_h