| /* |
| * 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. |
| * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of |
| * its contributors may be used to endorse or promote products derived |
| * from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY APPLE 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 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 THIRD_PARTY_BLINK_RENDERER_MODULES_WEBAUDIO_AUDIO_PARAM_H_ |
| #define THIRD_PARTY_BLINK_RENDERER_MODULES_WEBAUDIO_AUDIO_PARAM_H_ |
| |
| #include <sys/types.h> |
| #include <atomic> |
| #include "base/memory/scoped_refptr.h" |
| #include "third_party/blink/renderer/core/typed_arrays/array_buffer_view_helpers.h" |
| #include "third_party/blink/renderer/core/typed_arrays/dom_typed_array.h" |
| #include "third_party/blink/renderer/modules/webaudio/audio_param_timeline.h" |
| #include "third_party/blink/renderer/modules/webaudio/audio_summing_junction.h" |
| #include "third_party/blink/renderer/modules/webaudio/base_audio_context.h" |
| #include "third_party/blink/renderer/modules/webaudio/delete_soon_with_graph_lock.h" |
| #include "third_party/blink/renderer/platform/bindings/script_wrappable.h" |
| #include "third_party/blink/renderer/platform/wtf/text/wtf_string.h" |
| #include "third_party/blink/renderer/platform/wtf/thread_safe_ref_counted.h" |
| |
| namespace blink { |
| |
| class AudioNodeOutput; |
| struct AudioParamHandlerTraits; |
| |
| // Each AudioParam gets an identifier here. This is mostly for instrospection |
| // if warnings or other messages need to be printed. It's useful to know what |
| // the AudioParam represents. The name should include the node type and the |
| // name of the AudioParam. |
| enum AudioParamType { |
| kParamTypeAudioBufferSourcePlaybackRate, |
| kParamTypeAudioBufferSourceDetune, |
| kParamTypeBiquadFilterFrequency, |
| kParamTypeBiquadFilterQ, |
| kParamTypeBiquadFilterGain, |
| kParamTypeBiquadFilterDetune, |
| kParamTypeDelayDelayTime, |
| kParamTypeDynamicsCompressorThreshold, |
| kParamTypeDynamicsCompressorKnee, |
| kParamTypeDynamicsCompressorRatio, |
| kParamTypeDynamicsCompressorAttack, |
| kParamTypeDynamicsCompressorRelease, |
| kParamTypeGainGain, |
| kParamTypeOscillatorFrequency, |
| kParamTypeOscillatorDetune, |
| kParamTypeStereoPannerPan, |
| kParamTypePannerPositionX, |
| kParamTypePannerPositionY, |
| kParamTypePannerPositionZ, |
| kParamTypePannerOrientationX, |
| kParamTypePannerOrientationY, |
| kParamTypePannerOrientationZ, |
| kParamTypeAudioListenerPositionX, |
| kParamTypeAudioListenerPositionY, |
| kParamTypeAudioListenerPositionZ, |
| kParamTypeAudioListenerForwardX, |
| kParamTypeAudioListenerForwardY, |
| kParamTypeAudioListenerForwardZ, |
| kParamTypeAudioListenerUpX, |
| kParamTypeAudioListenerUpY, |
| kParamTypeAudioListenerUpZ, |
| kParamTypeConstantSourceOffset, |
| kParamTypeAudioWorklet, |
| }; |
| |
| // AudioParamHandler is an actual implementation of web-exposed AudioParam |
| // interface. Each of AudioParam object creates and owns an AudioParamHandler, |
| // and it is responsible for all of AudioParam tasks. An AudioParamHandler |
| // object is owned by the originator AudioParam object, and some audio |
| // processing classes have additional references. An AudioParamHandler can |
| // outlive the owner AudioParam, and it never dies before the owner AudioParam |
| // dies. |
| // |
| // Connected to AudioNodeOutput using AudioNodeWiring. |
| // |
| // Due to AudioParamHandlerTraits, AudioParamHandler is not deleted immediately |
| // upon losing its last reference. This is required since its last reference may |
| // be dropped during Oilpan finalization on the main thread, but the graph lock |
| // is required to perform handler teardown. See also |
| // delete_soon_with_graph_lock.h. |
| class AudioParamHandler final |
| : public ThreadSafeRefCounted<AudioParamHandler, AudioParamHandlerTraits>, |
| public AudioSummingJunction { |
| public: |
| // Automation rate of the AudioParam |
| enum AutomationRate { |
| // a-rate |
| kAudio, |
| // k-rate |
| kControl |
| }; |
| |
| // Indicates whether automation rate can be changed. |
| enum AutomationRateMode { |
| // Rate can't be changed after construction |
| kFixed, |
| // Rate can be selected |
| kVariable |
| }; |
| |
| AudioParamType GetParamType() const { return param_type_; } |
| void SetParamType(AudioParamType); |
| // Set the parameter name for an AudioWorklet. |
| void SetCustomParamName(const String name); |
| // Return a nice name for the AudioParam. |
| String GetParamName() const; |
| |
| static const double kDefaultSmoothingConstant; |
| static const double kSnapThreshold; |
| |
| static scoped_refptr<AudioParamHandler> Create(BaseAudioContext& context, |
| AudioParamType param_type, |
| double default_value, |
| AutomationRate rate, |
| AutomationRateMode rate_mode, |
| float min_value, |
| float max_value) { |
| return base::AdoptRef(new AudioParamHandler(context, param_type, |
| default_value, rate, rate_mode, |
| min_value, max_value)); |
| } |
| |
| // This should be used only in audio rendering thread. |
| AudioDestinationHandler& DestinationHandler() const; |
| |
| // AudioSummingJunction |
| void DidUpdate() override {} |
| |
| AudioParamTimeline& Timeline() { return timeline_; } |
| |
| // Intrinsic value. |
| float Value(); |
| void SetValue(float); |
| |
| AutomationRate GetAutomationRate() const { return automation_rate_; } |
| void SetAutomationRate(AutomationRate automation_rate) { |
| automation_rate_ = automation_rate; |
| }; |
| |
| bool IsAutomationRateFixed() const { |
| return rate_mode_ == AutomationRateMode::kFixed; |
| } |
| |
| // Final value for k-rate parameters, otherwise use |
| // calculateSampleAccurateValues() for a-rate. |
| // Must be called in the audio thread. |
| float FinalValue(); |
| |
| float DefaultValue() const { return static_cast<float>(default_value_); } |
| float MinValue() const { return min_value_; } |
| float MaxValue() const { return max_value_; } |
| |
| // Value smoothing: |
| |
| // When a new value is set with setValue(), in our internal use of the |
| // parameter we don't immediately jump to it. Instead we smoothly approach |
| // this value to avoid glitching. |
| float SmoothedValue(); |
| |
| // Smoothly exponentially approaches to (de-zippers) the desired value. |
| // Returns true if smoothed value has already snapped exactly to value. |
| bool Smooth(); |
| |
| void ResetSmoothedValue() { timeline_.SetSmoothedValue(IntrinsicValue()); } |
| |
| bool HasSampleAccurateValues() { |
| if (automation_rate_ != kAudio) |
| return false; |
| |
| bool has_values = |
| timeline_.HasValues(destination_handler_->CurrentSampleFrame(), |
| destination_handler_->SampleRate()); |
| |
| return has_values || NumberOfRenderingConnections(); |
| } |
| |
| bool IsAudioRate() const { return automation_rate_ == kAudio; } |
| |
| // Calculates numberOfValues parameter values starting at the context's |
| // current time. |
| // Must be called in the context's render thread. |
| void CalculateSampleAccurateValues(float* values, unsigned number_of_values); |
| |
| float IntrinsicValue() const { |
| return intrinsic_value_.load(std::memory_order_relaxed); |
| } |
| |
| private: |
| AudioParamHandler(BaseAudioContext&, |
| AudioParamType, |
| double default_value, |
| AutomationRate rate, |
| AutomationRateMode rate_mode, |
| float min, |
| float max); |
| |
| // sampleAccurate corresponds to a-rate (audio rate) vs. k-rate in the Web |
| // Audio specification. |
| void CalculateFinalValues(float* values, |
| unsigned number_of_values, |
| bool sample_accurate); |
| void CalculateTimelineValues(float* values, unsigned number_of_values); |
| |
| int ComputeQHistogramValue(float) const; |
| |
| // The type of AudioParam, indicating what this AudioParam represents and what |
| // node it belongs to. Mostly for informational purposes and doesn't affect |
| // implementation. |
| AudioParamType param_type_; |
| // Name of the AudioParam. This is only used for printing out more informative |
| // warnings, and only used for AudioWorklets. All others have a name derived |
| // from the |param_type_|. Worklets need custom names because they're defined |
| // by the user. |
| String custom_param_name_; |
| |
| // Intrinsic value |
| std::atomic<float> intrinsic_value_; |
| void SetIntrinsicValue(float new_value); |
| |
| float default_value_; |
| |
| // The automation rate of the AudioParam (k-rate or a-rate) |
| AutomationRate automation_rate_; |
| // |rate_mode_| determines if the user can change the automation rate to a |
| // different value. |
| const AutomationRateMode rate_mode_; |
| |
| // Nominal range for the value |
| float min_value_; |
| float max_value_; |
| |
| AudioParamTimeline timeline_; |
| |
| // The destination node used to get necessary information like the smaple rate |
| // and context time. |
| scoped_refptr<AudioDestinationHandler> destination_handler_; |
| |
| // Audio bus to sum in any connections to the AudioParam. |
| scoped_refptr<AudioBus> summing_bus_; |
| |
| friend class AudioNodeWiring; |
| }; |
| |
| struct AudioParamHandlerTraits { |
| static void Destruct(const AudioParamHandler* handler) { |
| DeleteSoonWithGraphLock(handler); |
| } |
| }; |
| |
| // AudioParam class represents web-exposed AudioParam interface. |
| class AudioParam final : public ScriptWrappable { |
| DEFINE_WRAPPERTYPEINFO(); |
| |
| public: |
| // The most common case where the rate, mode, and limits can default. |
| static AudioParam* Create(BaseAudioContext&, |
| AudioParamType, |
| double default_value); |
| // The general case where the rate and mode cannot use defaults (but the |
| // limits can). |
| static AudioParam* Create( |
| BaseAudioContext&, |
| AudioParamType, |
| double default_value, |
| AudioParamHandler::AutomationRate rate, |
| AudioParamHandler::AutomationRateMode rate_mode, |
| float min_value = -std::numeric_limits<float>::max(), |
| float max_value = std::numeric_limits<float>::max()); |
| |
| AudioParam(BaseAudioContext&, |
| AudioParamType, |
| double default_value, |
| AudioParamHandler::AutomationRate rate, |
| AudioParamHandler::AutomationRateMode rate_mode, |
| float min, |
| float max); |
| ~AudioParam() override; |
| |
| void Trace(blink::Visitor*) override; |
| // |handler| always returns a valid object. |
| AudioParamHandler& Handler() const { return *handler_; } |
| // |context| always returns a valid object. |
| BaseAudioContext* Context() const { return context_; } |
| |
| AudioParamType GetParamType() const { return Handler().GetParamType(); } |
| void SetParamType(AudioParamType); |
| void SetCustomParamName(const String name); |
| String GetParamName() const; |
| |
| float value() const; |
| void setValue(float, ExceptionState&); |
| void setValue(float); |
| |
| String automationRate() const; |
| void setAutomationRate(const String&, ExceptionState&); |
| |
| float defaultValue() const; |
| |
| float minValue() const; |
| float maxValue() const; |
| |
| AudioParam* setValueAtTime(float value, double time, ExceptionState&); |
| AudioParam* linearRampToValueAtTime(float value, |
| double time, |
| ExceptionState&); |
| AudioParam* exponentialRampToValueAtTime(float value, |
| double time, |
| ExceptionState&); |
| AudioParam* setTargetAtTime(float target, |
| double time, |
| double time_constant, |
| ExceptionState&); |
| AudioParam* setValueCurveAtTime(const Vector<float>& curve, |
| double time, |
| double duration, |
| ExceptionState&); |
| AudioParam* cancelScheduledValues(double start_time, ExceptionState&); |
| AudioParam* cancelAndHoldAtTime(double start_time, ExceptionState&); |
| |
| private: |
| void WarnIfOutsideRange(const String& param_methd, float value); |
| |
| scoped_refptr<AudioParamHandler> handler_; |
| Member<BaseAudioContext> context_; |
| |
| // Needed in the destructor, where |context_| is not guaranteed to be alive. |
| scoped_refptr<DeferredTaskHandler> deferred_task_handler_; |
| }; |
| |
| } // namespace blink |
| |
| #endif // THIRD_PARTY_BLINK_RENDERER_MODULES_WEBAUDIO_AUDIO_PARAM_H_ |