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 #ifndef ReverbConvolver_h
30 #define ReverbConvolver_h
31 
32 #include "ReverbAccumulationBuffer.h"
33 #include "ReverbInputBuffer.h"
34 #include "nsAutoPtr.h"
35 #include "mozilla/MemoryReporting.h"
36 #ifdef LOG
37 #undef LOG
38 #endif
39 #include "base/condition_variable.h"
40 #include "base/lock.h"
41 #include "base/thread.h"
42 
43 namespace WebCore {
44 
45 class ReverbConvolverStage;
46 
47 class ReverbConvolver {
48 public:
49     // maxFFTSize can be adjusted (from say 2048 to 32768) depending on how much precision is necessary.
50     // For certain tweaky de-convolving applications the phase errors add up quickly and lead to non-sensical results with
51     // larger FFT sizes and single-precision floats.  In these cases 2048 is a good size.
52     // If not doing multi-threaded convolution, then should not go > 8192.
53     ReverbConvolver(const float* impulseResponseData,
54                     size_t impulseResponseLength, size_t maxFFTSize,
55                     size_t convolverRenderPhase, bool useBackgroundThreads);
56     ~ReverbConvolver();
57 
58     void process(const float* sourceChannelData,
59                  float* destinationChannelData);
60 
impulseResponseLength()61     size_t impulseResponseLength() const { return m_impulseResponseLength; }
62 
inputBuffer()63     ReverbInputBuffer* inputBuffer() { return &m_inputBuffer; }
64 
useBackgroundThreads()65     bool useBackgroundThreads() const { return m_useBackgroundThreads; }
66     void backgroundThreadEntry();
67 
68     size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
69 private:
70     nsTArray<nsAutoPtr<ReverbConvolverStage> > m_stages;
71     nsTArray<nsAutoPtr<ReverbConvolverStage> > m_backgroundStages;
72     size_t m_impulseResponseLength;
73 
74     ReverbAccumulationBuffer m_accumulationBuffer;
75 
76     // One or more background threads read from this input buffer which is fed from the realtime thread.
77     ReverbInputBuffer m_inputBuffer;
78 
79     // Background thread and synchronization
80     base::Thread m_backgroundThread;
81     Lock m_backgroundThreadLock;
82     ConditionVariable m_backgroundThreadCondition;
83     bool m_useBackgroundThreads;
84     bool m_wantsToExit;
85     bool m_moreInputBuffered;
86 };
87 
88 } // namespace WebCore
89 
90 #endif // ReverbConvolver_h
91