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
|
/*
* 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 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.
*/
#pragma once
#include "AudioContext.h"
#include "AudioParamTimeline.h"
#include "AudioSummingJunction.h"
#include "AutomationRate.h"
#include <JavaScriptCore/Forward.h>
#include <sys/types.h>
#include <wtf/LoggerHelper.h>
#include <wtf/RefCounted.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
class AudioNodeOutput;
enum class AutomationRateMode : bool { Fixed, Variable };
class AudioParam final
: public AudioSummingJunction
, public RefCounted<AudioParam>
#if !RELEASE_LOG_DISABLED
, private LoggerHelper
#endif
{
public:
static constexpr double SmoothingConstant = 0.05;
static constexpr double SnapThreshold = 0.001;
static Ref<AudioParam> create(BaseAudioContext& context, const String& name, float defaultValue, float minValue, float maxValue, AutomationRate automationRate, AutomationRateMode automationRateMode = AutomationRateMode::Variable)
{
return adoptRef(*new AudioParam(context, name, defaultValue, minValue, maxValue, automationRate, automationRateMode));
}
// AudioSummingJunction
bool canUpdateState() override { return true; }
void didUpdate() override { }
// Intrinsic value.
float value();
void setValue(float);
float valueForBindings() const;
ExceptionOr<void> setValueForBindings(float);
AutomationRate automationRate() const { return m_automationRate; }
ExceptionOr<void> setAutomationRate(AutomationRate);
// Final value for k-rate parameters, otherwise use calculateSampleAccurateValues() for a-rate.
// Must be called in the audio thread.
float finalValue();
const String& name() const { return m_name; }
float minValue() const { return m_minValue; }
float maxValue() const { return m_maxValue; }
float defaultValue() const { return m_defaultValue; }
// 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() { m_smoothedValue = m_value; }
// Parameter automation.
ExceptionOr<AudioParam&> setValueAtTime(float value, double startTime);
ExceptionOr<AudioParam&> linearRampToValueAtTime(float value, double endTime);
ExceptionOr<AudioParam&> exponentialRampToValueAtTime(float value, double endTime);
ExceptionOr<AudioParam&> setTargetAtTime(float target, double startTime, float timeConstant);
ExceptionOr<AudioParam&> setValueCurveAtTime(Vector<float>&& curve, double startTime, double duration);
ExceptionOr<AudioParam&> cancelScheduledValues(double cancelTime);
ExceptionOr<AudioParam&> cancelAndHoldAtTime(double cancelTime);
bool hasSampleAccurateValues() const;
// Calculates numberOfValues parameter values starting at the context's current time.
// Must be called in the context's render thread.
void calculateSampleAccurateValues(std::span<float> values);
// Connect an audio-rate signal to control this parameter.
void connect(AudioNodeOutput*);
void disconnect(AudioNodeOutput*);
protected:
AudioParam(BaseAudioContext&, const String&, float defaultValue, float minValue, float maxValue, AutomationRate, AutomationRateMode);
private:
// sampleAccurate corresponds to a-rate (audio rate) vs. k-rate in the Web Audio specification.
void calculateFinalValues(std::span<float> values, bool sampleAccurate);
void calculateTimelineValues(std::span<float> values);
#if !RELEASE_LOG_DISABLED
const Logger& logger() const final { return m_logger.get(); }
uint64_t logIdentifier() const final { return m_logIdentifier; }
ASCIILiteral logClassName() const final { return "AudioParam"_s; }
WTFLogChannel& logChannel() const final;
#endif
String m_name;
float m_value;
float m_defaultValue;
float m_minValue;
float m_maxValue;
AutomationRate m_automationRate;
AutomationRateMode m_automationRateMode;
// Smoothing (de-zippering)
float m_smoothedValue;
AudioParamTimeline m_timeline;
Ref<AudioBus> m_summingBus;
#if !RELEASE_LOG_DISABLED
mutable Ref<const Logger> m_logger;
const uint64_t m_logIdentifier;
#endif
};
} // namespace WebCore
|
