src/third_party/WebKit/Source/modules/webaudio/AudioBasicProcessorNode.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 AudioBasicProcessorNode_h
  26 #define AudioBasicProcessorNode_h
  27
  28 #include "modules/webaudio/AudioNode.h"
  29 #include "wtf/Forward.h"
  30 #include "wtf/Threading.h"
  31
  32 namespace blink {
  33
  34 class AudioBus;
  35 class AudioNodeInput;
  36 class AudioProcessor;
  37
  38 // AudioBasicProcessorNode is an AudioNode with one input and one output where the input and output have the same number of channels.
  39 class AudioBasicProcessorNode : public AudioNode {
  40 public:
  41     AudioBasicProcessorNode(AudioContext*, float sampleRate);
  42     virtual ~AudioBasicProcessorNode();
  43     virtual void trace(Visitor*) OVERRIDE;
  44
  45     // AudioNode
  46     virtual void dispose() OVERRIDE FINAL;
  47     virtual void process(size_t framesToProcess) OVERRIDE FINAL;
  48     virtual void pullInputs(size_t framesToProcess) OVERRIDE FINAL;
  49     virtual void initialize() OVERRIDE FINAL;
  50     virtual void uninitialize() OVERRIDE FINAL;
  51
  52     // Called in the main thread when the number of channels for the input may have changed.
  53     virtual void checkNumberOfChannelsForInput(AudioNodeInput*) OVERRIDE FINAL;
  54
  55     // Returns the number of channels for both the input and the output.
  56     unsigned numberOfChannels();
  57
  58 protected:
  59     virtual double tailTime() const OVERRIDE FINAL;
  60     virtual double latencyTime() const OVERRIDE FINAL;
  61
  62     AudioProcessor* processor() { return m_processor.get(); }
  63     Member<AudioProcessor> m_processor;
  64 };
  65
  66 } // namespace blink
  67
  68 #endif // AudioBasicProcessorNode_h