7643cf39f0dee7749115846c0c9c640770d3177e
[WebKit.git] / WebCore / webaudio / AudioParam.h
1 /*
2  * Copyright (C) 2010 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 AudioParam_h
30 #define AudioParam_h
31
32 #include "PlatformString.h"
33 #include <math.h>
34 #include <sys/types.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37
38 namespace WebCore {
39
40 class AudioParam : public RefCounted<AudioParam> {
41 public:
42     static const double DefaultSmoothingConstant = 0.05;
43     static const double SnapThreshold = 0.001;
44
45     static PassRefPtr<AudioParam> create(const String& name, double defaultValue, double minValue, double maxValue, unsigned units = 0)
46     {
47         return adoptRef(new AudioParam(name, defaultValue, minValue, maxValue, units));
48     }
49
50     AudioParam(const String& name, double defaultValue, double minValue, double maxValue, unsigned units = 0)
51         : m_name(name)
52         , m_value(defaultValue)
53         , m_defaultValue(defaultValue)
54         , m_minValue(minValue)
55         , m_maxValue(maxValue)
56         , m_units(units)
57         , m_smoothedValue(defaultValue)
58         , m_smoothingConstant(DefaultSmoothingConstant)
59     {
60     }
61
62     float value() const { return static_cast<float>(m_value); }
63     
64     void setValue(float value)
65     {
66         // Check against JavaScript giving us bogus floating-point values.
67         // Don't ASSERT, since this can happen if somebody writes bad JS.
68         if (!isnan(value) && !isinf(value))
69             m_value = value;
70     }
71
72     String name() const { return m_name; }
73
74     float minValue() const { return static_cast<float>(m_minValue); }
75     float maxValue() const { return static_cast<float>(m_maxValue); }
76     float defaultValue() const { return static_cast<float>(m_defaultValue); }
77     unsigned units() const { return m_units; }
78
79     // Value smoothing:
80
81     // When a new value is set with setValue(), in our internal use of the parameter we don't immediately jump to it.
82     // Instead we smoothly approach this value to avoid glitching.
83     float smoothedValue() const { return static_cast<float>(m_smoothedValue); }
84
85     // Smoothly exponentially approaches to (de-zippers) the desired value.
86     // Returns true if smoothed value has already snapped exactly to value.
87     bool smooth()
88     {
89         if (m_smoothedValue == m_value) {
90             // Smoothed value has already approached and snapped to value.
91             return true;
92         }
93
94         // Exponential approach
95         m_smoothedValue += (m_value - m_smoothedValue) * m_smoothingConstant;
96
97         // If we get close enough then snap to actual value.
98         if (fabs(m_smoothedValue - m_value) < SnapThreshold) // FIXME: the threshold needs to be adjustable depending on range - but this is OK general purpose value.
99             m_smoothedValue = m_value;
100
101         return false;
102     }
103
104     void resetSmoothedValue() { m_smoothedValue = m_value; }
105     void setSmoothingConstant(double k) { m_smoothingConstant = k; }
106
107 private:
108     String m_name;
109     double m_value;
110     double m_defaultValue;
111     double m_minValue;
112     double m_maxValue;
113     unsigned m_units;
114
115     // Smoothing (de-zippering)
116     double m_smoothedValue;
117     double m_smoothingConstant;
118 };
119
120 } // namespace WebCore
121
122 #endif // AudioParam_h