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 ReverbInputBuffer_h
michael@0: #define ReverbInputBuffer_h
michael@0: 
michael@0: #include "nsTArray.h"
michael@0: #include "mozilla/MemoryReporting.h"
michael@0: 
michael@0: namespace WebCore {
michael@0: 
michael@0: // ReverbInputBuffer is used to buffer input samples for deferred processing by the background threads.
michael@0: class ReverbInputBuffer {
michael@0: public:
michael@0:     ReverbInputBuffer(size_t length);
michael@0: 
michael@0:     // The realtime audio thread keeps writing samples here.
michael@0:     // The assumption is that the buffer's length is evenly divisible by numberOfFrames (for nearly all cases this will be fine).
michael@0:     // FIXME: remove numberOfFrames restriction...
michael@0:     void write(const float* sourceP, size_t numberOfFrames);
michael@0: 
michael@0:     // Background threads can call this to check if there's anything to read...
michael@0:     size_t writeIndex() const { return m_writeIndex; }
michael@0: 
michael@0:     // The individual background threads read here (and hope that they can keep up with the buffer writing).
michael@0:     // readIndex is updated with the next readIndex to read from...
michael@0:     // The assumption is that the buffer's length is evenly divisible by numberOfFrames.
michael@0:     // FIXME: remove numberOfFrames restriction...
michael@0:     float* directReadFrom(int* readIndex, size_t numberOfFrames);
michael@0: 
michael@0:     void reset();
michael@0: 
michael@0:     size_t sizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const
michael@0:     {
michael@0:         return m_buffer.SizeOfExcludingThis(aMallocSizeOf);
michael@0:     }
michael@0: 
michael@0: 
michael@0: private:
michael@0:     nsTArray<float> m_buffer;
michael@0:     size_t m_writeIndex;
michael@0: };
michael@0: 
michael@0: } // namespace WebCore
michael@0: 
michael@0: #endif // ReverbInputBuffer_h