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