src/third_party/WebKit/Source/modules/webaudio/ConvolverNode.h

   1 /*
   2  * Copyright (C) 2010, 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 ConvolverNode_h
  26 #define ConvolverNode_h
  27
  28 #include "modules/webaudio/AudioNode.h"
  29 #include "wtf/OwnPtr.h"
  30 #include "wtf/RefPtr.h"
  31 #include "wtf/ThreadingPrimitives.h"
  32
  33 namespace WebCore {
  34
  35 class AudioBuffer;
  36 class ExceptionState;
  37 class Reverb;
  38
  39 class ConvolverNode FINAL : public AudioNode {
  40 public:
  41     static PassRefPtrWillBeRawPtr<ConvolverNode> create(AudioContext* context, float sampleRate)
  42     {
  43         return adoptRefWillBeNoop(new ConvolverNode(context, sampleRate));
  44     }
  45
  46     virtual ~ConvolverNode();
  47
  48     // AudioNode
  49     virtual void process(size_t framesToProcess) OVERRIDE;
  50     virtual void initialize() OVERRIDE;
  51     virtual void uninitialize() OVERRIDE;
  52
  53     // Impulse responses
  54     void setBuffer(AudioBuffer*, ExceptionState&);
  55     AudioBuffer* buffer();
  56
  57     bool normalize() const { return m_normalize; }
  58     void setNormalize(bool normalize) { m_normalize = normalize; }
  59
  60     virtual void trace(Visitor*) OVERRIDE;
  61
  62 private:
  63     ConvolverNode(AudioContext*, float sampleRate);
  64
  65     virtual double tailTime() const OVERRIDE;
  66     virtual double latencyTime() const OVERRIDE;
  67
  68     OwnPtr<Reverb> m_reverb;
  69     RefPtrWillBeMember<AudioBuffer> m_buffer;
  70
  71     // This synchronizes dynamic changes to the convolution impulse response with process().
  72     mutable Mutex m_processLock;
  73
  74     // Normalize the impulse response or not. Must default to true.
  75     bool m_normalize;
  76 };
  77
  78 } // namespace WebCore
  79
  80 #endif // ConvolverNode_h