Line data    Source code

       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 ReverbInputBuffer_h
      30             : #define ReverbInputBuffer_h
      31             : 
      32             : #include "nsTArray.h"
      33             : #include "mozilla/MemoryReporting.h"
      34             : 
      35             : namespace WebCore {
      36             : 
      37             : // ReverbInputBuffer is used to buffer input samples for deferred processing by the background threads.
      38           0 : class ReverbInputBuffer {
      39             : public:
      40             :     explicit ReverbInputBuffer(size_t length);
      41             : 
      42             :     // The realtime audio thread keeps writing samples here.
      43             :     // The assumption is that the buffer's length is evenly divisible by numberOfFrames (for nearly all cases this will be fine).
      44             :     // FIXME: remove numberOfFrames restriction...
      45             :     void write(const float* sourceP, size_t numberOfFrames);
      46             : 
      47             :     // Background threads can call this to check if there's anything to read...
      48           0 :     size_t writeIndex() const { return m_writeIndex; }
      49             : 
      50             :     // The individual background threads read here (and hope that they can keep up with the buffer writing).
      51             :     // readIndex is updated with the next readIndex to read from...
      52             :     // The assumption is that the buffer's length is evenly divisible by numberOfFrames.
      53             :     // FIXME: remove numberOfFrames restriction...
      54             :     float* directReadFrom(int* readIndex, size_t numberOfFrames);
      55             : 
      56             :     void reset();
      57             : 
      58           0 :     size_t sizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const
      59             :     {
      60           0 :         return m_buffer.ShallowSizeOfExcludingThis(aMallocSizeOf);
      61             :     }
      62             : 
      63             : 
      64             : private:
      65             :     nsTArray<float> m_buffer;
      66             :     size_t m_writeIndex;
      67             : };
      68             : 
      69             : } // namespace WebCore
      70             : 
      71             : #endif // ReverbInputBuffer_h