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 ReverbConvolver_h
michael@0: #define ReverbConvolver_h
michael@0: 
michael@0: #include "ReverbAccumulationBuffer.h"
michael@0: #include "ReverbInputBuffer.h"
michael@0: #include "nsAutoPtr.h"
michael@0: #include "mozilla/MemoryReporting.h"
michael@0: #ifdef LOG
michael@0: #undef LOG
michael@0: #endif
michael@0: #include "base/condition_variable.h"
michael@0: #include "base/lock.h"
michael@0: #include "base/thread.h"
michael@0: 
michael@0: namespace WebCore {
michael@0: 
michael@0: class ReverbConvolverStage;
michael@0: 
michael@0: class ReverbConvolver {
michael@0: public:
michael@0:     // maxFFTSize can be adjusted (from say 2048 to 32768) depending on how much precision is necessary.
michael@0:     // For certain tweaky de-convolving applications the phase errors add up quickly and lead to non-sensical results with
michael@0:     // larger FFT sizes and single-precision floats.  In these cases 2048 is a good size.
michael@0:     // If not doing multi-threaded convolution, then should not go > 8192.
michael@0:     ReverbConvolver(const float* impulseResponseData, size_t impulseResponseLength, size_t renderSliceSize, size_t maxFFTSize, size_t convolverRenderPhase, bool useBackgroundThreads);
michael@0:     ~ReverbConvolver();
michael@0: 
michael@0:     void process(const float* sourceChannelData, size_t sourceChannelLength,
michael@0:                  float* destinationChannelData, size_t destinationChannelLength,
michael@0:                  size_t framesToProcess);
michael@0:     void reset();
michael@0: 
michael@0:     size_t impulseResponseLength() const { return m_impulseResponseLength; }
michael@0: 
michael@0:     ReverbInputBuffer* inputBuffer() { return &m_inputBuffer; }
michael@0: 
michael@0:     bool useBackgroundThreads() const { return m_useBackgroundThreads; }
michael@0:     void backgroundThreadEntry();
michael@0: 
michael@0:     size_t latencyFrames() const;
michael@0: 
michael@0:     size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
michael@0: private:
michael@0:     nsTArray<nsAutoPtr<ReverbConvolverStage> > m_stages;
michael@0:     nsTArray<nsAutoPtr<ReverbConvolverStage> > m_backgroundStages;
michael@0:     size_t m_impulseResponseLength;
michael@0: 
michael@0:     ReverbAccumulationBuffer m_accumulationBuffer;
michael@0: 
michael@0:     // One or more background threads read from this input buffer which is fed from the realtime thread.
michael@0:     ReverbInputBuffer m_inputBuffer;
michael@0: 
michael@0:     // First stage will be of size m_minFFTSize.  Each next stage will be twice as big until we hit m_maxFFTSize.
michael@0:     size_t m_minFFTSize;
michael@0:     size_t m_maxFFTSize;
michael@0: 
michael@0:     // But don't exceed this size in the real-time thread (if we're doing background processing).
michael@0:     size_t m_maxRealtimeFFTSize;
michael@0: 
michael@0:     // Background thread and synchronization
michael@0:     base::Thread m_backgroundThread;
michael@0:     Lock m_backgroundThreadLock;
michael@0:     ConditionVariable m_backgroundThreadCondition;
michael@0:     bool m_useBackgroundThreads;
michael@0:     bool m_wantsToExit;
michael@0:     bool m_moreInputBuffered;
michael@0: };
michael@0: 
michael@0: } // namespace WebCore
michael@0: 
michael@0: #endif // ReverbConvolver_h