/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ReverbConvolver_h
#define ReverbConvolver_h

#include "ReverbAccumulationBuffer.h"
#include "ReverbInputBuffer.h"
#include "mozilla/MemoryReporting.h"
#include "mozilla/Monitor.h"
#include "mozilla/UniquePtr.h"
#ifdef LOG
#  undef LOG
#endif
#include "base/thread.h"
#include <atomic>

namespace WebCore {

using mozilla::UniquePtr;

class ReverbConvolverStage;

class ReverbConvolver {
 public:
  // maxFFTSize can be adjusted (from say 2048 to 32768) depending on how much
  // precision is necessary. For certain tweaky de-convolving applications the
  // phase errors add up quickly and lead to non-sensical results with larger
  // FFT sizes and single-precision floats.  In these cases 2048 is a good size.
  // If not doing multi-threaded convolution, then should not go > 8192.
  ReverbConvolver(const float* impulseResponseData,
                  size_t impulseResponseLength, size_t maxFFTSize,
                  size_t convolverRenderPhase, bool useBackgroundThreads,
                  bool* aAllocationFailure);
  ~ReverbConvolver();

  void process(const float* sourceChannelData, float* destinationChannelData);

  size_t impulseResponseLength() const { return m_impulseResponseLength; }

  ReverbInputBuffer* inputBuffer() { return &m_inputBuffer; }

  bool useBackgroundThreads() const { return m_useBackgroundThreads; }
  void backgroundThreadEntry();

  size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;

 private:
  nsTArray<UniquePtr<ReverbConvolverStage> > m_stages;
  nsTArray<UniquePtr<ReverbConvolverStage> > m_backgroundStages;
  size_t m_impulseResponseLength;

  ReverbAccumulationBuffer m_accumulationBuffer;

  // One or more background threads read from this input buffer which is fed
  // from the realtime thread.
  ReverbInputBuffer m_inputBuffer;

  // Background thread and synchronization
  base::Thread m_backgroundThread;
  mozilla::Monitor m_backgroundThreadMonitor MOZ_UNANNOTATED;
  bool m_useBackgroundThreads;
  std::atomic<bool> m_wantsToExit;
  std::atomic<bool> m_moreInputBuffered;
};

}  // namespace WebCore

#endif  // ReverbConvolver_h
