michael@0: /*
michael@0:  * Copyright (C) 2010 Google Inc. All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  * 1.  Redistributions of source code must retain the above copyright
michael@0:  *     notice, this list of conditions and the following disclaimer.
michael@0:  * 2.  Redistributions in binary form must reproduce the above copyright
michael@0:  *     notice, this list of conditions and the following disclaimer in the
michael@0:  *     documentation and/or other materials provided with the distribution.
michael@0:  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
michael@0:  *     its contributors may be used to endorse or promote products derived
michael@0:  *     from this software without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
michael@0:  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
michael@0:  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
michael@0:  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
michael@0:  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
michael@0:  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
michael@0:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
michael@0:  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
michael@0:  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: 
michael@0: #ifndef HRTFElevation_h
michael@0: #define HRTFElevation_h
michael@0: 
michael@0: #include "HRTFKernel.h"
michael@0: #include "nsAutoRef.h"
michael@0: #include "mozilla/MemoryReporting.h"
michael@0: 
michael@0: struct SpeexResamplerState_;
michael@0: typedef struct SpeexResamplerState_ SpeexResamplerState;
michael@0: 
michael@0: namespace WebCore {
michael@0: 
michael@0: // HRTFElevation contains all of the HRTFKernels (one left ear and one right ear per azimuth angle) for a particular elevation.
michael@0: 
michael@0: class HRTFElevation {
michael@0: public:
michael@0:     // Loads and returns an HRTFElevation with the given HRTF database subject name and elevation from browser (or WebKit.framework) resources.
michael@0:     // Normally, there will only be a single HRTF database set, but this API supports the possibility of multiple ones with different names.
michael@0:     // Interpolated azimuths will be generated based on InterpolationFactor.
michael@0:     // Valid values for elevation are -45 -> +90 in 15 degree increments.
michael@0:     static nsReturnRef<HRTFElevation> createBuiltin(int elevation, float sampleRate);
michael@0: 
michael@0:     // Given two HRTFElevations, and an interpolation factor x: 0 -> 1, returns an interpolated HRTFElevation.
michael@0:     static nsReturnRef<HRTFElevation> createByInterpolatingSlices(HRTFElevation* hrtfElevation1, HRTFElevation* hrtfElevation2, float x, float sampleRate);
michael@0: 
michael@0:     double elevationAngle() const { return m_elevationAngle; }
michael@0:     unsigned numberOfAzimuths() const { return NumberOfTotalAzimuths; }
michael@0:     float sampleRate() const { return m_sampleRate; }
michael@0:     
michael@0:     // Returns the left and right kernels for the given azimuth index.
michael@0:     // The interpolated delays based on azimuthBlend: 0 -> 1 are returned in frameDelayL and frameDelayR.
michael@0:     void getKernelsFromAzimuth(double azimuthBlend, unsigned azimuthIndex, HRTFKernel* &kernelL, HRTFKernel* &kernelR, double& frameDelayL, double& frameDelayR);
michael@0:     
michael@0:     // Total number of azimuths after interpolation.
michael@0:     static const unsigned NumberOfTotalAzimuths;
michael@0: 
michael@0:     static size_t fftSizeForSampleRate(float sampleRate);
michael@0: 
michael@0:     size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
michael@0: 
michael@0: private:
michael@0:     HRTFElevation(const HRTFElevation& other) MOZ_DELETE;
michael@0:     void operator=(const HRTFElevation& other) MOZ_DELETE;
michael@0: 
michael@0:     HRTFElevation(HRTFKernelList *kernelListL, int elevation, float sampleRate)
michael@0:         : m_elevationAngle(elevation)
michael@0:         , m_sampleRate(sampleRate)
michael@0:     {
michael@0:         m_kernelListL.SwapElements(*kernelListL);
michael@0:     }
michael@0: 
michael@0:     // Returns the list of left ear HRTFKernels for all the azimuths going from 0 to 360 degrees.
michael@0:     const HRTFKernelList& kernelListL() { return m_kernelListL; }
michael@0: 
michael@0:     // Given a specific azimuth and elevation angle, returns the left HRTFKernel.
michael@0:     // Values for azimuth must be multiples of 15 in 0 -> 345,
michael@0:     // but not all azimuths are available for elevations > +45.
michael@0:     // Valid values for elevation are -45 -> +90 in 15 degree increments.
michael@0:     static nsReturnRef<HRTFKernel> calculateKernelForAzimuthElevation(int azimuth, int elevation, SpeexResamplerState* resampler, float sampleRate);
michael@0: 
michael@0:     HRTFKernelList m_kernelListL;
michael@0:     double m_elevationAngle;
michael@0:     float m_sampleRate;
michael@0: };
michael@0: 
michael@0: } // namespace WebCore
michael@0: 
michael@0: template <>
michael@0: class nsAutoRefTraits<WebCore::HRTFElevation> :
michael@0:     public nsPointerRefTraits<WebCore::HRTFElevation> {
michael@0: public:
michael@0:     static void Release(WebCore::HRTFElevation* ptr) { delete(ptr); }
michael@0: };
michael@0: 
michael@0: #endif // HRTFElevation_h