third_party/WebKit/Source/platform/audio/Panner.h

   1 /*
   2  * Copyright (C) 2009 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef Panner_h
  30 #define Panner_h
  31
  32 #include "platform/PlatformExport.h"
  33 #include "wtf/PassOwnPtr.h"
  34
  35 namespace blink {
  36
  37 class AudioBus;
  38 class HRTFDatabaseLoader;
  39
  40 // Abstract base class for panning a mono or stereo source.
  41
  42 class PLATFORM_EXPORT Panner {
  43 public:
  44     enum {
  45         PanningModelEqualPower = 0,
  46         PanningModelHRTF = 1
  47     };
  48
  49     typedef unsigned PanningModel;
  50
  51     static PassOwnPtr<Panner> create(PanningModel, float sampleRate, HRTFDatabaseLoader*);
  52
  53     virtual ~Panner() { };
  54
  55     PanningModel panningModel() const { return m_panningModel; }
  56
  57     virtual void pan(double azimuth, double elevation, const AudioBus* inputBus, AudioBus* outputBus, size_t framesToProcess) = 0;
  58
  59     virtual void reset() = 0;
  60
  61     virtual double tailTime() const = 0;
  62     virtual double latencyTime() const = 0;
  63
  64 protected:
  65     Panner(PanningModel model) : m_panningModel(model) { }
  66
  67     PanningModel m_panningModel;
  68 };
  69
  70 } // namespace blink
  71
  72 #endif // Panner_h