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