e5d1352821e7e01fb93b65168afff2765965b0b0
[WebKit-https.git] / Source / WebCore / platform / audio / AudioUtilities.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  * 1.  Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2.  Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef AudioUtilities_h
26 #define AudioUtilities_h
27
28 namespace WebCore {
29
30 namespace AudioUtilities {
31
32 // https://www.w3.org/TR/webaudio/#render-quantum-size
33 constexpr size_t renderQuantumSize = 128;
34
35 // Standard functions for converting to and from decibel values from linear.
36 float linearToDecibels(float);
37 float decibelsToLinear(float);
38
39 // timeConstant is the time it takes a first-order linear time-invariant system
40 // to reach the value 1 - 1/e (around 63.2%) given a step input response.
41 // discreteTimeConstantForSampleRate() will return the discrete time-constant for the specific sampleRate.
42 double discreteTimeConstantForSampleRate(double timeConstant, double sampleRate);
43
44 // How to do rounding when converting time to sample frame.
45 enum class SampleFrameRounding {
46     Nearest,
47     Down,
48     Up
49 };
50
51 // Convert the time to a sample frame at the given sample rate.
52 size_t timeToSampleFrame(double time, double sampleRate, SampleFrameRounding = SampleFrameRounding::Nearest);
53
54 inline float linearToDecibels(float linear)
55 {
56     ASSERT(linear >= 0);
57     return 20 * log10f(linear);
58 }
59
60 inline float decibelsToLinear(float decibels)
61 {
62     return powf(10, 0.05f * decibels);
63 }
64
65 } // AudioUtilites
66
67 } // WebCore
68
69 #endif // AudioUtilities_h