Source/WebCore/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 "AudioBuffer.h"
  29 #include "AudioBus.h"
  30 #include "AudioIOCallback.h"
  31 #include "AudioNode.h"
  32 #include "AudioSourceProvider.h"
  33 #if ENABLE(TIZEN_WEB_AUDIO)
  34 #include "ExceptionCode.h"
  35 #endif
  36
  37 namespace WebCore {
  38
  39 class AudioBus;
  40 class AudioContext;
  41
  42 class AudioDestinationNode : public AudioNode, public AudioIOCallback {
  43 public:
  44     AudioDestinationNode(AudioContext*, float sampleRate);
  45     virtual ~AudioDestinationNode();
  46
  47     // AudioNode
  48     virtual void process(size_t) { }; // we're pulled by hardware so this is never called
  49     virtual void reset() { m_currentSampleFrame = 0; };
  50
  51     // The audio hardware calls render() to get the next render quantum of audio into destinationBus.
  52     // It will optionally give us local/live audio input in sourceBus (if it's not 0).
  53     virtual void render(AudioBus* sourceBus, AudioBus* destinationBus, size_t numberOfFrames);
  54
  55     size_t currentSampleFrame() const { return m_currentSampleFrame; }
  56     double currentTime() const { return currentSampleFrame() / static_cast<double>(sampleRate()); }
  57
  58 #if ENABLE(TIZEN_WEB_AUDIO)
  59     virtual unsigned long maxNumberOfChannels() const { return 2; } // FIXME: update when multi-channel (more than stereo) is supported
  60
  61     //Number of channels supported by AudioDestinationNode.
  62     unsigned long numberOfChannels();
  63     void setNumberOfChannels(unsigned long channels, ExceptionCode&);
  64 #else
  65     virtual unsigned numberOfChannels() const { return 2; } // FIXME: update when multi-channel (more than stereo) is supported
  66 #endif
  67
  68     virtual void enableInput() = 0;
  69     virtual void startRendering() = 0;
  70 #if ENABLE(TIZEN_WEB_AUDIO)
  71     virtual void pauseRendering() = 0;
  72 #endif
  73
  74     AudioSourceProvider* localAudioInputProvider() { return &m_localAudioInputProvider; }
  75
  76 protected:
  77     // LocalAudioInputProvider allows us to expose an AudioSourceProvider for local/live audio input.
  78     // If there is local/live audio input, we call set() with the audio input data every render quantum.
  79     class LocalAudioInputProvider : public AudioSourceProvider {
  80     public:
  81         LocalAudioInputProvider()
  82             : m_sourceBus(2, AudioNode::ProcessingSizeInFrames) // FIXME: handle non-stereo local input.
  83         {
  84         }
  85
  86         void set(AudioBus* bus)
  87         {
  88             if (bus)
  89                 m_sourceBus.copyFrom(*bus);
  90         }
  91
  92         // AudioSourceProvider.
  93         virtual void provideInput(AudioBus* destinationBus, size_t numberOfFrames)
  94         {
  95             bool isGood = destinationBus && destinationBus->length() == numberOfFrames && m_sourceBus.length() == numberOfFrames;
  96             ASSERT(isGood);
  97             if (isGood)
  98                 destinationBus->copyFrom(m_sourceBus);
  99         }
 100
 101     private:
 102         AudioBus m_sourceBus;
 103     };
 104
 105     virtual double tailTime() const OVERRIDE { return 0; }
 106     virtual double latencyTime() const OVERRIDE { return 0; }
 107
 108     // Counts the number of sample-frames processed by the destination.
 109     size_t m_currentSampleFrame;
 110
 111     LocalAudioInputProvider m_localAudioInputProvider;
 112
 113 #if ENABLE(TIZEN_WEB_AUDIO)
 114     //Number of channels supported.
 115     unsigned long m_channelCount;
 116 #endif
 117 };
 118
 119 } // namespace WebCore
 120
 121 #endif // AudioDestinationNode_h