third_party/WebKit/Source/modules/webaudio/PannerNode.h

/*
 * 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 "modules/webaudio/AudioListener.h"
#include "modules/webaudio/AudioNode.h"
#include "modules/webaudio/AudioParam.h"
#include "platform/audio/AudioBus.h"
#include "platform/audio/Cone.h"
#include "platform/audio/Distance.h"
#include "platform/audio/Panner.h"
#include "platform/geometry/FloatPoint3D.h"
#include "wtf/HashMap.h"
#include <memory>

namespace blink {

class BaseAudioContext;
class PannerOptions;

// 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 PannerHandler final : public AudioHandler {
 public:
  // These enums are used to distinguish what cached values of panner are dirty.
  enum {
    AzimuthElevationDirty = 0x1,
    DistanceConeGainDirty = 0x2,
  };

  static PassRefPtr<PannerHandler> create(AudioNode&,
                                          float sampleRate,
                                          AudioParamHandler& positionX,
                                          AudioParamHandler& positionY,
                                          AudioParamHandler& positionZ,
                                          AudioParamHandler& orientationX,
                                          AudioParamHandler& orientationY,
                                          AudioParamHandler& orientationZ);

  ~PannerHandler() override;

  // AudioHandler
  void process(size_t framesToProcess) override;
  void processSampleAccurateValues(AudioBus* destination,
                                   const AudioBus* source,
                                   size_t framesToProcess);
  void initialize() override;
  void uninitialize() override;

  // Panning model
  String panningModel() const;
  void setPanningModel(const String&);

  // Position and orientation
  void setPosition(float x, float y, float z);
  void setOrientation(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);

  double tailTime() const override {
    return m_panner ? m_panner->tailTime() : 0;
  }
  double latencyTime() const override {
    return m_panner ? m_panner->latencyTime() : 0;
  }

  void setChannelCount(unsigned long, ExceptionState&) final;
  void setChannelCountMode(const String&, ExceptionState&) final;

 private:
  PannerHandler(AudioNode&,
                float sampleRate,
                AudioParamHandler& positionX,
                AudioParamHandler& positionY,
                AudioParamHandler& positionZ,
                AudioParamHandler& orientationX,
                AudioParamHandler& orientationY,
                AudioParamHandler& orientationZ);

  // BaseAudioContext's listener
  AudioListener* listener();

  bool setPanningModel(unsigned);   // Returns true on success.
  bool setDistanceModel(unsigned);  // Returns true on success.

  void calculateAzimuthElevation(double* outAzimuth,
                                 double* outElevation,
                                 const FloatPoint3D& position,
                                 const FloatPoint3D& listenerPosition,
                                 const FloatPoint3D& listenerForward,
                                 const FloatPoint3D& listenerUp);

  // Returns the combined distance and cone gain attenuation.
  float calculateDistanceConeGain(const FloatPoint3D& position,
                                  const FloatPoint3D& orientation,
                                  const FloatPoint3D& listenerPosition);

  void azimuthElevation(double* outAzimuth, double* outElevation);
  float distanceConeGain();

  bool isAzimuthElevationDirty() const { return m_isAzimuthElevationDirty; }
  bool isDistanceConeGainDirty() const { return m_isDistanceConeGainDirty; }
  void updateDirtyState();

  // This Persistent doesn't make a reference cycle including the owner
  // PannerNode.
  Persistent<AudioListener> m_listener;
  std::unique_ptr<Panner> m_panner;
  unsigned m_panningModel;
  unsigned m_distanceModel;

  bool m_isAzimuthElevationDirty;
  bool m_isDistanceConeGainDirty;

  // Gain
  DistanceEffect m_distanceEffect;
  ConeEffect m_coneEffect;
  float m_lastGain;

  // Cached values
  double m_cachedAzimuth;
  double m_cachedElevation;
  float m_cachedDistanceConeGain;

  const FloatPoint3D position() const {
    return FloatPoint3D(m_positionX->value(), m_positionY->value(),
                        m_positionZ->value());
  }

  const FloatPoint3D orientation() const {
    return FloatPoint3D(m_orientationX->value(), m_orientationY->value(),
                        m_orientationZ->value());
  }

  // True if any of this panner's AudioParams have automations.
  bool hasSampleAccurateValues() const;

  RefPtr<AudioParamHandler> m_positionX;
  RefPtr<AudioParamHandler> m_positionY;
  RefPtr<AudioParamHandler> m_positionZ;

  RefPtr<AudioParamHandler> m_orientationX;
  RefPtr<AudioParamHandler> m_orientationY;
  RefPtr<AudioParamHandler> m_orientationZ;

  FloatPoint3D m_lastPosition;
  FloatPoint3D m_lastOrientation;

  // Synchronize process() with setting of the panning model, source's location information, listener, distance parameters and sound cones.
  mutable Mutex m_processLock;
};

class PannerNode final : public AudioNode {
  DEFINE_WRAPPERTYPEINFO();

 public:
  static PannerNode* create(BaseAudioContext&, ExceptionState&);
  static PannerNode* create(BaseAudioContext*,
                            const PannerOptions&,
                            ExceptionState&);
  PannerHandler& pannerHandler() const;

  DECLARE_VIRTUAL_TRACE();

  // Uses a 3D cartesian coordinate system
  AudioParam* positionX() const { return m_positionX; };
  AudioParam* positionY() const { return m_positionY; };
  AudioParam* positionZ() const { return m_positionZ; };

  AudioParam* orientationX() const { return m_orientationX; };
  AudioParam* orientationY() const { return m_orientationY; };
  AudioParam* orientationZ() const { return m_orientationZ; };

  String panningModel() const;
  void setPanningModel(const String&);
  void setPosition(float x, float y, float z);
  void setOrientation(float x, float y, float z);
  void setVelocity(float x, float y, float z);
  String distanceModel() const;
  void setDistanceModel(const String&);
  double refDistance() const;
  void setRefDistance(double);
  double maxDistance() const;
  void setMaxDistance(double);
  double rolloffFactor() const;
  void setRolloffFactor(double);
  double coneInnerAngle() const;
  void setConeInnerAngle(double);
  double coneOuterAngle() const;
  void setConeOuterAngle(double);
  double coneOuterGain() const;
  void setConeOuterGain(double);

 private:
  PannerNode(BaseAudioContext&);

  Member<AudioParam> m_positionX;
  Member<AudioParam> m_positionY;
  Member<AudioParam> m_positionZ;

  Member<AudioParam> m_orientationX;
  Member<AudioParam> m_orientationY;
  Member<AudioParam> m_orientationZ;
};

}  // namespace blink

#endif  // PannerNode_h