Web Inspector: NMI add instrumentation for WebAudo related stuff.
[WebKit-https.git] / Source / WebCore / platform / audio / HRTFElevation.cpp
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 #include "config.h"
30
31 #if ENABLE(WEB_AUDIO)
32
33 #include "HRTFElevation.h"
34
35 #include "AudioBus.h"
36 #include "AudioFileReader.h"
37 #include "Biquad.h"
38 #include "FFTFrame.h"
39 #include "HRTFPanner.h"
40 #include "PlatformMemoryInstrumentation.h"
41 #include <algorithm>
42 #include <math.h>
43 #include <wtf/MemoryInstrumentationVector.h>
44 #include <wtf/OwnPtr.h>
45
46 using namespace std;
47  
48 namespace WebCore {
49
50 const unsigned HRTFElevation::AzimuthSpacing = 15;
51 const unsigned HRTFElevation::NumberOfRawAzimuths = 360 / AzimuthSpacing;
52 const unsigned HRTFElevation::InterpolationFactor = 8;
53 const unsigned HRTFElevation::NumberOfTotalAzimuths = NumberOfRawAzimuths * InterpolationFactor;
54
55 // Total number of components of an HRTF database.
56 const size_t TotalNumberOfResponses = 240;
57
58 // Number of frames in an individual impulse response.
59 const size_t ResponseFrameSize = 256;
60
61 // Sample-rate of the spatialization impulse responses as stored in the resource file.
62 // The impulse responses may be resampled to a different sample-rate (depending on the audio hardware) when they are loaded.
63 const float ResponseSampleRate = 44100;
64
65 #if PLATFORM(MAC) || USE(WEBAUDIO_GSTREAMER)
66 #define USE_CONCATENATED_IMPULSE_RESPONSES
67 #endif
68
69 #ifdef USE_CONCATENATED_IMPULSE_RESPONSES
70 // Lazily load a concatenated HRTF database for given subject and store it in a
71 // local hash table to ensure quick efficient future retrievals.
72 static AudioBus* getConcatenatedImpulseResponsesForSubject(const String& subjectName)
73 {
74     typedef HashMap<String, AudioBus*> AudioBusMap;
75     DEFINE_STATIC_LOCAL(AudioBusMap, audioBusMap, ());
76
77     AudioBus* bus;
78     AudioBusMap::iterator iterator = audioBusMap.find(subjectName);
79     if (iterator == audioBusMap.end()) {
80         OwnPtr<AudioBus> concatenatedImpulseResponses = AudioBus::loadPlatformResource(subjectName.utf8().data(), ResponseSampleRate);
81         bus = concatenatedImpulseResponses.leakPtr();
82         audioBusMap.set(subjectName, bus);
83     } else
84         bus = iterator->value;
85
86     size_t responseLength = bus->length();
87     size_t expectedLength = static_cast<size_t>(TotalNumberOfResponses * ResponseFrameSize);
88
89     // Check number of channels and length. For now these are fixed and known.
90     bool isBusGood = responseLength == expectedLength && bus->numberOfChannels() == 2;
91     ASSERT(isBusGood);
92     if (!isBusGood)
93         return 0;
94
95     return bus;
96 }
97 #endif
98
99 // Takes advantage of the symmetry and creates a composite version of the two measured versions.  For example, we have both azimuth 30 and -30 degrees
100 // where the roles of left and right ears are reversed with respect to each other.
101 bool HRTFElevation::calculateSymmetricKernelsForAzimuthElevation(int azimuth, int elevation, float sampleRate, const String& subjectName,
102                                                                  RefPtr<HRTFKernel>& kernelL, RefPtr<HRTFKernel>& kernelR)
103 {
104     RefPtr<HRTFKernel> kernelL1;
105     RefPtr<HRTFKernel> kernelR1;
106     bool success = calculateKernelsForAzimuthElevation(azimuth, elevation, sampleRate, subjectName, kernelL1, kernelR1);
107     if (!success)
108         return false;
109         
110     // And symmetric version
111     int symmetricAzimuth = !azimuth ? 0 : 360 - azimuth;
112                                                               
113     RefPtr<HRTFKernel> kernelL2;
114     RefPtr<HRTFKernel> kernelR2;
115     success = calculateKernelsForAzimuthElevation(symmetricAzimuth, elevation, sampleRate, subjectName, kernelL2, kernelR2);
116     if (!success)
117         return false;
118         
119     // Notice L/R reversal in symmetric version.
120     kernelL = HRTFKernel::createInterpolatedKernel(kernelL1.get(), kernelR2.get(), 0.5f);
121     kernelR = HRTFKernel::createInterpolatedKernel(kernelR1.get(), kernelL2.get(), 0.5f);
122     
123     return true;
124 }
125
126 bool HRTFElevation::calculateKernelsForAzimuthElevation(int azimuth, int elevation, float sampleRate, const String& subjectName,
127                                                         RefPtr<HRTFKernel>& kernelL, RefPtr<HRTFKernel>& kernelR)
128 {
129     // Valid values for azimuth are 0 -> 345 in 15 degree increments.
130     // Valid values for elevation are -45 -> +90 in 15 degree increments.
131
132     bool isAzimuthGood = azimuth >= 0 && azimuth <= 345 && (azimuth / 15) * 15 == azimuth;
133     ASSERT(isAzimuthGood);
134     if (!isAzimuthGood)
135         return false;
136
137     bool isElevationGood = elevation >= -45 && elevation <= 90 && (elevation / 15) * 15 == elevation;
138     ASSERT(isElevationGood);
139     if (!isElevationGood)
140         return false;
141     
142     // Construct the resource name from the subject name, azimuth, and elevation, for example:
143     // "IRC_Composite_C_R0195_T015_P000"
144     // Note: the passed in subjectName is not a string passed in via JavaScript or the web.
145     // It's passed in as an internal ASCII identifier and is an implementation detail.
146     int positiveElevation = elevation < 0 ? elevation + 360 : elevation;
147
148 #ifdef USE_CONCATENATED_IMPULSE_RESPONSES
149     AudioBus* bus(getConcatenatedImpulseResponsesForSubject(subjectName));
150
151     if (!bus)
152         return false;
153
154     int elevationIndex = positiveElevation / AzimuthSpacing;
155     if (positiveElevation > 90)
156         elevationIndex -= AzimuthSpacing;
157
158     // The concatenated impulse response is a bus containing all
159     // the elevations per azimuth, for all azimuths by increasing
160     // order. So for a given azimuth and elevation we need to compute
161     // the index of the wanted audio frames in the concatenated table.
162     unsigned index = ((azimuth / AzimuthSpacing) * HRTFDatabase::NumberOfRawElevations) + elevationIndex;
163     bool isIndexGood = index < TotalNumberOfResponses;
164     ASSERT(isIndexGood);
165     if (!isIndexGood)
166         return false;
167
168     // Extract the individual impulse response from the concatenated
169     // responses and potentially sample-rate convert it to the desired
170     // (hardware) sample-rate.
171     unsigned startFrame = index * ResponseFrameSize;
172     unsigned stopFrame = startFrame + ResponseFrameSize;
173     OwnPtr<AudioBus> preSampleRateConvertedResponse = AudioBus::createBufferFromRange(bus, startFrame, stopFrame);
174     OwnPtr<AudioBus> response = AudioBus::createBySampleRateConverting(preSampleRateConvertedResponse.get(), false, sampleRate);
175     AudioChannel* leftEarImpulseResponse = response->channel(AudioBus::ChannelLeft);
176     AudioChannel* rightEarImpulseResponse = response->channel(AudioBus::ChannelRight);
177 #else
178     String resourceName = String::format("IRC_%s_C_R0195_T%03d_P%03d", subjectName.utf8().data(), azimuth, positiveElevation);
179
180     OwnPtr<AudioBus> impulseResponse(AudioBus::loadPlatformResource(resourceName.utf8().data(), sampleRate));
181
182     ASSERT(impulseResponse.get());
183     if (!impulseResponse.get())
184         return false;
185     
186     size_t responseLength = impulseResponse->length();
187     size_t expectedLength = static_cast<size_t>(256 * (sampleRate / 44100.0));
188
189     // Check number of channels and length.  For now these are fixed and known.
190     bool isBusGood = responseLength == expectedLength && impulseResponse->numberOfChannels() == 2;
191     ASSERT(isBusGood);
192     if (!isBusGood)
193         return false;
194     
195     AudioChannel* leftEarImpulseResponse = impulseResponse->channelByType(AudioBus::ChannelLeft);
196     AudioChannel* rightEarImpulseResponse = impulseResponse->channelByType(AudioBus::ChannelRight);
197 #endif
198
199     // Note that depending on the fftSize returned by the panner, we may be truncating the impulse response we just loaded in.
200     const size_t fftSize = HRTFPanner::fftSizeForSampleRate(sampleRate);
201     kernelL = HRTFKernel::create(leftEarImpulseResponse, fftSize, sampleRate, true);
202     kernelR = HRTFKernel::create(rightEarImpulseResponse, fftSize, sampleRate, true);
203     
204     return true;
205 }
206
207 // The range of elevations for the IRCAM impulse responses varies depending on azimuth, but the minimum elevation appears to always be -45.
208 //
209 // Here's how it goes:
210 static int maxElevations[] = {
211         //  Azimuth
212         //
213     90, // 0  
214     45, // 15 
215     60, // 30 
216     45, // 45 
217     75, // 60 
218     45, // 75 
219     60, // 90 
220     45, // 105 
221     75, // 120 
222     45, // 135 
223     60, // 150 
224     45, // 165 
225     75, // 180 
226     45, // 195 
227     60, // 210 
228     45, // 225 
229     75, // 240 
230     45, // 255 
231     60, // 270 
232     45, // 285 
233     75, // 300 
234     45, // 315 
235     60, // 330 
236     45 //  345 
237 };
238
239 PassOwnPtr<HRTFElevation> HRTFElevation::createForSubject(const String& subjectName, int elevation, float sampleRate)
240 {
241     bool isElevationGood = elevation >= -45 && elevation <= 90 && (elevation / 15) * 15 == elevation;
242     ASSERT(isElevationGood);
243     if (!isElevationGood)
244         return nullptr;
245         
246     OwnPtr<HRTFKernelList> kernelListL = adoptPtr(new HRTFKernelList(NumberOfTotalAzimuths));
247     OwnPtr<HRTFKernelList> kernelListR = adoptPtr(new HRTFKernelList(NumberOfTotalAzimuths));
248
249     // Load convolution kernels from HRTF files.
250     int interpolatedIndex = 0;
251     for (unsigned rawIndex = 0; rawIndex < NumberOfRawAzimuths; ++rawIndex) {
252         // Don't let elevation exceed maximum for this azimuth.
253         int maxElevation = maxElevations[rawIndex];
254         int actualElevation = min(elevation, maxElevation);
255
256         bool success = calculateKernelsForAzimuthElevation(rawIndex * AzimuthSpacing, actualElevation, sampleRate, subjectName, kernelListL->at(interpolatedIndex), kernelListR->at(interpolatedIndex));
257         if (!success)
258             return nullptr;
259             
260         interpolatedIndex += InterpolationFactor;
261     }
262
263     // Now go back and interpolate intermediate azimuth values.
264     for (unsigned i = 0; i < NumberOfTotalAzimuths; i += InterpolationFactor) {
265         int j = (i + InterpolationFactor) % NumberOfTotalAzimuths;
266
267         // Create the interpolated convolution kernels and delays.
268         for (unsigned jj = 1; jj < InterpolationFactor; ++jj) {
269             float x = float(jj) / float(InterpolationFactor); // interpolate from 0 -> 1
270
271             (*kernelListL)[i + jj] = HRTFKernel::createInterpolatedKernel(kernelListL->at(i).get(), kernelListL->at(j).get(), x);
272             (*kernelListR)[i + jj] = HRTFKernel::createInterpolatedKernel(kernelListR->at(i).get(), kernelListR->at(j).get(), x);
273         }
274     }
275     
276     OwnPtr<HRTFElevation> hrtfElevation = adoptPtr(new HRTFElevation(kernelListL.release(), kernelListR.release(), elevation, sampleRate));
277     return hrtfElevation.release();
278 }
279
280 PassOwnPtr<HRTFElevation> HRTFElevation::createByInterpolatingSlices(HRTFElevation* hrtfElevation1, HRTFElevation* hrtfElevation2, float x, float sampleRate)
281 {
282     ASSERT(hrtfElevation1 && hrtfElevation2);
283     if (!hrtfElevation1 || !hrtfElevation2)
284         return nullptr;
285         
286     ASSERT(x >= 0.0 && x < 1.0);
287     
288     OwnPtr<HRTFKernelList> kernelListL = adoptPtr(new HRTFKernelList(NumberOfTotalAzimuths));
289     OwnPtr<HRTFKernelList> kernelListR = adoptPtr(new HRTFKernelList(NumberOfTotalAzimuths));
290
291     HRTFKernelList* kernelListL1 = hrtfElevation1->kernelListL();
292     HRTFKernelList* kernelListR1 = hrtfElevation1->kernelListR();
293     HRTFKernelList* kernelListL2 = hrtfElevation2->kernelListL();
294     HRTFKernelList* kernelListR2 = hrtfElevation2->kernelListR();
295     
296     // Interpolate kernels of corresponding azimuths of the two elevations.
297     for (unsigned i = 0; i < NumberOfTotalAzimuths; ++i) {
298         (*kernelListL)[i] = HRTFKernel::createInterpolatedKernel(kernelListL1->at(i).get(), kernelListL2->at(i).get(), x);
299         (*kernelListR)[i] = HRTFKernel::createInterpolatedKernel(kernelListR1->at(i).get(), kernelListR2->at(i).get(), x);
300     }
301
302     // Interpolate elevation angle.
303     double angle = (1.0 - x) * hrtfElevation1->elevationAngle() + x * hrtfElevation2->elevationAngle();
304     
305     OwnPtr<HRTFElevation> hrtfElevation = adoptPtr(new HRTFElevation(kernelListL.release(), kernelListR.release(), static_cast<int>(angle), sampleRate));
306     return hrtfElevation.release();  
307 }
308
309 void HRTFElevation::getKernelsFromAzimuth(double azimuthBlend, unsigned azimuthIndex, HRTFKernel* &kernelL, HRTFKernel* &kernelR, double& frameDelayL, double& frameDelayR)
310 {
311     bool checkAzimuthBlend = azimuthBlend >= 0.0 && azimuthBlend < 1.0;
312     ASSERT(checkAzimuthBlend);
313     if (!checkAzimuthBlend)
314         azimuthBlend = 0.0;
315     
316     unsigned numKernels = m_kernelListL->size();
317
318     bool isIndexGood = azimuthIndex < numKernels;
319     ASSERT(isIndexGood);
320     if (!isIndexGood) {
321         kernelL = 0;
322         kernelR = 0;
323         return;
324     }
325     
326     // Return the left and right kernels.
327     kernelL = m_kernelListL->at(azimuthIndex).get();
328     kernelR = m_kernelListR->at(azimuthIndex).get();
329
330     frameDelayL = m_kernelListL->at(azimuthIndex)->frameDelay();
331     frameDelayR = m_kernelListR->at(azimuthIndex)->frameDelay();
332
333     int azimuthIndex2 = (azimuthIndex + 1) % numKernels;
334     double frameDelay2L = m_kernelListL->at(azimuthIndex2)->frameDelay();
335     double frameDelay2R = m_kernelListR->at(azimuthIndex2)->frameDelay();
336
337     // Linearly interpolate delays.
338     frameDelayL = (1.0 - azimuthBlend) * frameDelayL + azimuthBlend * frameDelay2L;
339     frameDelayR = (1.0 - azimuthBlend) * frameDelayR + azimuthBlend * frameDelay2R;
340 }
341
342 void HRTFElevation::reportMemoryUsage(MemoryObjectInfo* memoryObjectInfo) const
343 {
344     MemoryClassInfo info(memoryObjectInfo, this, PlatformMemoryTypes::AudioSharedData);
345     info.addMember(m_kernelListL);
346     info.addMember(m_kernelListR);
347 }
348
349 } // namespace WebCore
350
351 #endif // ENABLE(WEB_AUDIO)