src/third_party/WebKit/Source/platform/audio/AudioDSPKernelProcessor.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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef AudioDSPKernelProcessor_h
  32 #define AudioDSPKernelProcessor_h
  33
  34 #include "platform/audio/AudioBus.h"
  35 #include "platform/audio/AudioProcessor.h"
  36 #include "wtf/OwnPtr.h"
  37 #include "wtf/PassOwnPtr.h"
  38 #include "wtf/ThreadingPrimitives.h"
  39 #include "wtf/Vector.h"
  40
  41 namespace blink {
  42
  43 class AudioBus;
  44 class AudioDSPKernel;
  45 class AudioProcessor;
  46
  47 // AudioDSPKernelProcessor processes one input -> one output (N channels each)
  48 // It uses one AudioDSPKernel object per channel to do the processing, thus there is no cross-channel processing.
  49 // Despite this limitation it turns out to be a very common and useful type of processor.
  50
  51 class PLATFORM_EXPORT AudioDSPKernelProcessor : public AudioProcessor {
  52 public:
  53     // numberOfChannels may be later changed if object is not yet in an "initialized" state
  54     AudioDSPKernelProcessor(float sampleRate, unsigned numberOfChannels);
  55     virtual ~AudioDSPKernelProcessor();
  56
  57     // Subclasses create the appropriate type of processing kernel here.
  58     // We'll call this to create a kernel for each channel.
  59     virtual PassOwnPtr<AudioDSPKernel> createKernel() = 0;
  60
  61     // AudioProcessor methods
  62     virtual void initialize() override;
  63     virtual void uninitialize() override;
  64     virtual void process(const AudioBus* source, AudioBus* destination, size_t framesToProcess) override;
  65     virtual void reset() override;
  66     virtual void setNumberOfChannels(unsigned) override;
  67     virtual unsigned numberOfChannels() const override { return m_numberOfChannels; }
  68
  69     virtual double tailTime() const override;
  70     virtual double latencyTime() const override;
  71
  72 protected:
  73     Vector<OwnPtr<AudioDSPKernel> > m_kernels;
  74     mutable Mutex m_processLock;
  75     bool m_hasJustReset;
  76 };
  77
  78 } // namespace blink
  79
  80 #endif // AudioDSPKernelProcessor_h