1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
|
/*
* Copyright (C) 2010, Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef PannerNode_h
#define PannerNode_h
#include "platform/audio/AudioBus.h"
#include "platform/audio/Cone.h"
#include "platform/audio/Distance.h"
#include "platform/audio/HRTFDatabaseLoader.h"
#include "platform/audio/Panner.h"
#include "modules/webaudio/AudioListener.h"
#include "modules/webaudio/AudioNode.h"
#include "platform/geometry/FloatPoint3D.h"
#include "wtf/HashMap.h"
#include "wtf/OwnPtr.h"
namespace WebCore {
// PannerNode is an AudioNode with one input and one output.
// It positions a sound in 3D space, with the exact effect dependent on the panning model.
// It has a position and an orientation in 3D space which is relative to the position and orientation of the context's AudioListener.
// A distance effect will attenuate the gain as the position moves away from the listener.
// A cone effect will attenuate the gain as the orientation moves away from the listener.
// All of these effects follow the OpenAL specification very closely.
class PannerNode FINAL : public AudioNode {
public:
// These enums are used to distinguish what cached values of panner are dirty.
enum {
AzimuthElevationDirty = 0x1,
DistanceConeGainDirty = 0x2,
DopplerRateDirty = 0x4,
};
static PassRefPtrWillBeRawPtr<PannerNode> create(AudioContext* context, float sampleRate)
{
return adoptRefWillBeNoop(new PannerNode(context, sampleRate));
}
virtual ~PannerNode();
// AudioNode
virtual void process(size_t framesToProcess) OVERRIDE;
virtual void pullInputs(size_t framesToProcess) OVERRIDE;
virtual void initialize() OVERRIDE;
virtual void uninitialize() OVERRIDE;
// Panning model
String panningModel() const;
void setPanningModel(const String&);
// Position, orientation and velocity
void setPosition(float x, float y, float z);
void setOrientation(float x, float y, float z);
void setVelocity(float x, float y, float z);
// Distance parameters
String distanceModel() const;
void setDistanceModel(const String&);
double refDistance() { return m_distanceEffect.refDistance(); }
void setRefDistance(double);
double maxDistance() { return m_distanceEffect.maxDistance(); }
void setMaxDistance(double);
double rolloffFactor() { return m_distanceEffect.rolloffFactor(); }
void setRolloffFactor(double);
// Sound cones - angles in degrees
double coneInnerAngle() const { return m_coneEffect.innerAngle(); }
void setConeInnerAngle(double);
double coneOuterAngle() const { return m_coneEffect.outerAngle(); }
void setConeOuterAngle(double);
double coneOuterGain() const { return m_coneEffect.outerGain(); }
void setConeOuterGain(double);
void markPannerAsDirty(unsigned);
// It must be called on audio thread, currently called only process() in AudioBufferSourceNode.
double dopplerRate();
virtual double tailTime() const OVERRIDE { return m_panner ? m_panner->tailTime() : 0; }
virtual double latencyTime() const OVERRIDE { return m_panner ? m_panner->latencyTime() : 0; }
private:
PannerNode(AudioContext*, float sampleRate);
// AudioContext's listener
AudioListener* listener();
bool setPanningModel(unsigned); // Returns true on success.
bool setDistanceModel(unsigned); // Returns true on success.
void calculateAzimuthElevation(double* outAzimuth, double* outElevation);
float calculateDistanceConeGain(); // Returns the combined distance and cone gain attenuation.
double calculateDopplerRate();
void azimuthElevation(double* outAzimuth, double* outElevation);
float distanceConeGain();
bool isAzimuthElevationDirty() const { return m_isAzimuthElevationDirty; }
bool isDistanceConeGainDirty() const { return m_isDistanceConeGainDirty; }
bool isDopplerRateDirty() const { return m_isDopplerRateDirty; }
// Notifies any AudioBufferSourceNodes connected to us either directly or indirectly about our existence.
// This is in order to handle the pitch change necessary for the doppler shift.
void notifyAudioSourcesConnectedToNode(AudioNode*, HashMap<AudioNode*, bool> &visitedNodes);
OwnPtr<Panner> m_panner;
unsigned m_panningModel;
unsigned m_distanceModel;
// Current source location information
FloatPoint3D m_position;
FloatPoint3D m_orientation;
FloatPoint3D m_velocity;
bool m_isAzimuthElevationDirty;
bool m_isDistanceConeGainDirty;
bool m_isDopplerRateDirty;
// Gain
DistanceEffect m_distanceEffect;
ConeEffect m_coneEffect;
float m_lastGain;
// Cached values
double m_cachedAzimuth;
double m_cachedElevation;
float m_cachedDistanceConeGain;
double m_cachedDopplerRate;
RefPtr<HRTFDatabaseLoader> m_hrtfDatabaseLoader;
// AudioContext's connection count
unsigned m_connectionCount;
// Synchronize process() with setting of the panning model, source's location information, listener, distance parameters and sound cones.
mutable Mutex m_processLock;
};
} // namespace WebCore
#endif // PannerNode_h
|