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 HRTFDatabase_h
michael@0: #define HRTFDatabase_h
michael@0: 
michael@0: #include "HRTFElevation.h"
michael@0: #include "nsAutoRef.h"
michael@0: #include "nsTArray.h"
michael@0: #include "mozilla/MemoryReporting.h"
michael@0: 
michael@0: namespace WebCore {
michael@0: 
michael@0: class HRTFKernel;
michael@0: 
michael@0: class HRTFDatabase {
michael@0: public:
michael@0:     static nsReturnRef<HRTFDatabase> create(float sampleRate);
michael@0: 
michael@0:     // getKernelsFromAzimuthElevation() returns a left and right ear kernel, and an interpolated left and right frame delay for the given azimuth and elevation.
michael@0:     // azimuthBlend must be in the range 0 -> 1.
michael@0:     // Valid values for azimuthIndex are 0 -> HRTFElevation::NumberOfTotalAzimuths - 1 (corresponding to angles of 0 -> 360).
michael@0:     // Valid values for elevationAngle are MinElevation -> MaxElevation.
michael@0:     void getKernelsFromAzimuthElevation(double azimuthBlend, unsigned azimuthIndex, double elevationAngle, HRTFKernel* &kernelL, HRTFKernel* &kernelR, double& frameDelayL, double& frameDelayR);
michael@0: 
michael@0:     // Returns the number of different azimuth angles.
michael@0:     static unsigned numberOfAzimuths() { return HRTFElevation::NumberOfTotalAzimuths; }
michael@0: 
michael@0:     float sampleRate() const { return m_sampleRate; }
michael@0: 
michael@0:     // Number of elevations loaded from resource.
michael@0:     static const unsigned NumberOfRawElevations;
michael@0: 
michael@0:     size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
michael@0: 
michael@0: private:
michael@0:     HRTFDatabase(const HRTFDatabase& other) MOZ_DELETE;
michael@0:     void operator=(const HRTFDatabase& other) MOZ_DELETE;
michael@0: 
michael@0:     explicit HRTFDatabase(float sampleRate);
michael@0: 
michael@0:     // Minimum and maximum elevation angles (inclusive) for a HRTFDatabase.
michael@0:     static const int MinElevation;
michael@0:     static const int MaxElevation;
michael@0:     static const unsigned RawElevationAngleSpacing;
michael@0: 
michael@0:     // Interpolates by this factor to get the total number of elevations from every elevation loaded from resource.
michael@0:     static const unsigned InterpolationFactor;
michael@0:     
michael@0:     // Total number of elevations after interpolation.
michael@0:     static const unsigned NumberOfTotalElevations;
michael@0: 
michael@0:     // Returns the index for the correct HRTFElevation given the elevation angle.
michael@0:     static unsigned indexFromElevationAngle(double);
michael@0: 
michael@0:     nsTArray<nsAutoRef<HRTFElevation> > m_elevations;
michael@0:     float m_sampleRate;
michael@0: };
michael@0: 
michael@0: } // namespace WebCore
michael@0: 
michael@0: template <>
michael@0: class nsAutoRefTraits<WebCore::HRTFDatabase> :
michael@0:     public nsPointerRefTraits<WebCore::HRTFDatabase> {
michael@0: public:
michael@0:     static void Release(WebCore::HRTFDatabase* ptr) { delete(ptr); }
michael@0: };
michael@0: 
michael@0: #endif // HRTFDatabase_h