Replace WTF::move with WTFMove
[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 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 "HRTFDatabaseLoader.h"
40 #include "HRTFPanner.h"
41 #include <algorithm>
42 #include <math.h>
43
44 namespace WebCore {
45
46 const unsigned HRTFElevation::AzimuthSpacing = 15;
47 const unsigned HRTFElevation::NumberOfRawAzimuths = 360 / AzimuthSpacing;
48 const unsigned HRTFElevation::InterpolationFactor = 8;
49 const unsigned HRTFElevation::NumberOfTotalAzimuths = NumberOfRawAzimuths * InterpolationFactor;
50
51 // Total number of components of an HRTF database.
52 const size_t TotalNumberOfResponses = 240;
53
54 // Number of frames in an individual impulse response.
55 const size_t ResponseFrameSize = 256;
56
57 // Sample-rate of the spatialization impulse responses as stored in the resource file.
58 // The impulse responses may be resampled to a different sample-rate (depending on the audio hardware) when they are loaded.
59 const float ResponseSampleRate = 44100;
60
61 #if PLATFORM(COCOA) || USE(WEBAUDIO_GSTREAMER)
62 #define USE_CONCATENATED_IMPULSE_RESPONSES
63 #endif
64
65 #ifdef USE_CONCATENATED_IMPULSE_RESPONSES
66 // Lazily load a concatenated HRTF database for given subject and store it in a
67 // local hash table to ensure quick efficient future retrievals.
68 static AudioBus* getConcatenatedImpulseResponsesForSubject(const String& subjectName)
69 {
70     typedef HashMap<String, AudioBus*> AudioBusMap;
71     DEPRECATED_DEFINE_STATIC_LOCAL(AudioBusMap, audioBusMap, ());
72
73     AudioBus* bus;
74     AudioBusMap::iterator iterator = audioBusMap.find(subjectName);
75     if (iterator == audioBusMap.end()) {
76         RefPtr<AudioBus> concatenatedImpulseResponses = AudioBus::loadPlatformResource(subjectName.utf8().data(), ResponseSampleRate);
77         ASSERT(concatenatedImpulseResponses);
78         if (!concatenatedImpulseResponses)
79             return 0;
80
81         bus = concatenatedImpulseResponses.release().leakRef();
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     RefPtr<AudioBus> preSampleRateConvertedResponse = AudioBus::createBufferFromRange(bus, startFrame, stopFrame);
174     RefPtr<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     RefPtr<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);
202     kernelR = HRTFKernel::create(rightEarImpulseResponse, fftSize, sampleRate);
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 const 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 std::unique_ptr<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     auto kernelListL = std::make_unique<HRTFKernelList>(NumberOfTotalAzimuths);
247     auto kernelListR = std::make_unique<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 = std::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     return std::make_unique<HRTFElevation>(WTFMove(kernelListL), WTFMove(kernelListR), elevation, sampleRate);
277 }
278
279 std::unique_ptr<HRTFElevation> HRTFElevation::createByInterpolatingSlices(HRTFElevation* hrtfElevation1, HRTFElevation* hrtfElevation2, float x, float sampleRate)
280 {
281     ASSERT(hrtfElevation1 && hrtfElevation2);
282     if (!hrtfElevation1 || !hrtfElevation2)
283         return nullptr;
284         
285     ASSERT(x >= 0.0 && x < 1.0);
286     
287     auto kernelListL = std::make_unique<HRTFKernelList>(NumberOfTotalAzimuths);
288     auto kernelListR = std::make_unique<HRTFKernelList>(NumberOfTotalAzimuths);
289
290     HRTFKernelList* kernelListL1 = hrtfElevation1->kernelListL();
291     HRTFKernelList* kernelListR1 = hrtfElevation1->kernelListR();
292     HRTFKernelList* kernelListL2 = hrtfElevation2->kernelListL();
293     HRTFKernelList* kernelListR2 = hrtfElevation2->kernelListR();
294     
295     // Interpolate kernels of corresponding azimuths of the two elevations.
296     for (unsigned i = 0; i < NumberOfTotalAzimuths; ++i) {
297         (*kernelListL)[i] = HRTFKernel::createInterpolatedKernel(kernelListL1->at(i).get(), kernelListL2->at(i).get(), x);
298         (*kernelListR)[i] = HRTFKernel::createInterpolatedKernel(kernelListR1->at(i).get(), kernelListR2->at(i).get(), x);
299     }
300
301     // Interpolate elevation angle.
302     double angle = (1.0 - x) * hrtfElevation1->elevationAngle() + x * hrtfElevation2->elevationAngle();
303     
304     return std::make_unique<HRTFElevation>(WTFMove(kernelListL), WTFMove(kernelListR), static_cast<int>(angle), sampleRate);
305 }
306
307 void HRTFElevation::getKernelsFromAzimuth(double azimuthBlend, unsigned azimuthIndex, HRTFKernel* &kernelL, HRTFKernel* &kernelR, double& frameDelayL, double& frameDelayR)
308 {
309     bool checkAzimuthBlend = azimuthBlend >= 0.0 && azimuthBlend < 1.0;
310     ASSERT(checkAzimuthBlend);
311     if (!checkAzimuthBlend)
312         azimuthBlend = 0.0;
313     
314     unsigned numKernels = m_kernelListL->size();
315
316     bool isIndexGood = azimuthIndex < numKernels;
317     ASSERT(isIndexGood);
318     if (!isIndexGood) {
319         kernelL = 0;
320         kernelR = 0;
321         return;
322     }
323     
324     // Return the left and right kernels.
325     kernelL = m_kernelListL->at(azimuthIndex).get();
326     kernelR = m_kernelListR->at(azimuthIndex).get();
327
328     frameDelayL = m_kernelListL->at(azimuthIndex)->frameDelay();
329     frameDelayR = m_kernelListR->at(azimuthIndex)->frameDelay();
330
331     int azimuthIndex2 = (azimuthIndex + 1) % numKernels;
332     double frameDelay2L = m_kernelListL->at(azimuthIndex2)->frameDelay();
333     double frameDelay2R = m_kernelListR->at(azimuthIndex2)->frameDelay();
334
335     // Linearly interpolate delays.
336     frameDelayL = (1.0 - azimuthBlend) * frameDelayL + azimuthBlend * frameDelay2L;
337     frameDelayR = (1.0 - azimuthBlend) * frameDelayR + azimuthBlend * frameDelay2R;
338 }
339
340 } // namespace WebCore
341
342 #endif // ENABLE(WEB_AUDIO)