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

   1 /*
   2  * Copyright (C) 2012, Intel Corporation. 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 AudioBasicInspectorNode_h
  26 #define AudioBasicInspectorNode_h
  27
  28 #include "modules/webaudio/AudioNode.h"
  29
  30 namespace blink {
  31
  32 class ExceptionState;
  33
  34 // AudioBasicInspectorNode is an AudioNode with one input and one output where the output might not necessarily connect to another node's input.
  35 // If the output is not connected to any other node, then the AudioBasicInspectorNode's processIfNecessary() function will be called automatically by
  36 // AudioContext before the end of each render quantum so that it can inspect the audio stream.
  37 class AudioBasicInspectorNode : public AudioNode {
  38 public:
  39     AudioBasicInspectorNode(AudioContext*, float sampleRate, unsigned outputChannelCount);
  40
  41     // AudioNode
  42     virtual void pullInputs(size_t framesToProcess) OVERRIDE FINAL;
  43     virtual void connect(AudioNode*, unsigned outputIndex, unsigned inputIndex, ExceptionState&) OVERRIDE FINAL;
  44     virtual void disconnect(unsigned outputIndex, ExceptionState&) OVERRIDE FINAL;
  45     virtual void checkNumberOfChannelsForInput(AudioNodeInput*) OVERRIDE FINAL;
  46
  47 private:
  48     void updatePullStatus();
  49     bool m_needAutomaticPull; // When setting to true, AudioBasicInspectorNode will be pulled automaticlly by AudioContext before the end of each render quantum.
  50 };
  51
  52 } // namespace blink
  53
  54 #endif // AudioBasicInspectorNode_h