src/third_party/WebKit/Source/modules/webaudio/AudioDestinationNode.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 AudioDestinationNode_h
  26 #define AudioDestinationNode_h
  27
  28 #include "platform/audio/AudioBus.h"
  29 #include "platform/audio/AudioIOCallback.h"
  30 #include "platform/audio/AudioSourceProvider.h"
  31 #include "modules/webaudio/AudioBuffer.h"
  32 #include "modules/webaudio/AudioNode.h"
  33
  34 namespace blink {
  35
  36 class AudioBus;
  37 class AudioContext;
  38
  39 class AudioDestinationNode : public AudioNode, public AudioIOCallback {
  40 public:
  41     AudioDestinationNode(AudioContext*, float sampleRate);
  42     virtual ~AudioDestinationNode();
  43
  44     // AudioNode
  45     virtual void dispose() OVERRIDE;
  46     virtual void process(size_t) OVERRIDE FINAL { } // we're pulled by hardware so this is never called
  47
  48     // The audio hardware calls render() to get the next render quantum of audio into destinationBus.
  49     // It will optionally give us local/live audio input in sourceBus (if it's not 0).
  50     virtual void render(AudioBus* sourceBus, AudioBus* destinationBus, size_t numberOfFrames) OVERRIDE FINAL;
  51
  52     size_t currentSampleFrame() const { return m_currentSampleFrame; }
  53     double currentTime() const { return currentSampleFrame() / static_cast<double>(sampleRate()); }
  54
  55     virtual unsigned long maxChannelCount() const { return 0; }
  56
  57     virtual void startRendering() = 0;
  58
  59 protected:
  60     // LocalAudioInputProvider allows us to expose an AudioSourceProvider for local/live audio input.
  61     // If there is local/live audio input, we call set() with the audio input data every render quantum.
  62     class LocalAudioInputProvider FINAL : public AudioSourceProvider {
  63     public:
  64         LocalAudioInputProvider()
  65             : m_sourceBus(AudioBus::create(2, AudioNode::ProcessingSizeInFrames)) // FIXME: handle non-stereo local input.
  66         {
  67         }
  68
  69         void set(AudioBus* bus)
  70         {
  71             if (bus)
  72                 m_sourceBus->copyFrom(*bus);
  73         }
  74
  75         // AudioSourceProvider.
  76         virtual void provideInput(AudioBus* destinationBus, size_t numberOfFrames) OVERRIDE
  77         {
  78             bool isGood = destinationBus && destinationBus->length() == numberOfFrames && m_sourceBus->length() == numberOfFrames;
  79             ASSERT(isGood);
  80             if (isGood)
  81                 destinationBus->copyFrom(*m_sourceBus);
  82         }
  83
  84     private:
  85         RefPtr<AudioBus> m_sourceBus;
  86     };
  87
  88     virtual double tailTime() const OVERRIDE FINAL { return 0; }
  89     virtual double latencyTime() const OVERRIDE FINAL { return 0; }
  90
  91     // Counts the number of sample-frames processed by the destination.
  92     size_t m_currentSampleFrame;
  93
  94     LocalAudioInputProvider m_localAudioInputProvider;
  95 };
  96
  97 } // namespace blink
  98
  99 #endif // AudioDestinationNode_h