michael@0: /*
michael@0:  * Copyright (C) 2011 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 DynamicsCompressor_h
michael@0: #define DynamicsCompressor_h
michael@0: 
michael@0: #include "DynamicsCompressorKernel.h"
michael@0: #include "ZeroPole.h"
michael@0: 
michael@0: #include "nsTArray.h"
michael@0: #include "nsAutoPtr.h"
michael@0: #include "mozilla/MemoryReporting.h"
michael@0: 
michael@0: namespace mozilla {
michael@0: struct AudioChunk;
michael@0: }
michael@0: 
michael@0: namespace WebCore {
michael@0: 
michael@0: using mozilla::AudioChunk;
michael@0: 
michael@0: // DynamicsCompressor implements a flexible audio dynamics compression effect such as
michael@0: // is commonly used in musical production and game audio. It lowers the volume
michael@0: // of the loudest parts of the signal and raises the volume of the softest parts,
michael@0: // making the sound richer, fuller, and more controlled.
michael@0: 
michael@0: class DynamicsCompressor {
michael@0: public:
michael@0:     enum {
michael@0:         ParamThreshold,
michael@0:         ParamKnee,
michael@0:         ParamRatio,
michael@0:         ParamAttack,
michael@0:         ParamRelease,
michael@0:         ParamPreDelay,
michael@0:         ParamReleaseZone1,
michael@0:         ParamReleaseZone2,
michael@0:         ParamReleaseZone3,
michael@0:         ParamReleaseZone4,
michael@0:         ParamPostGain,
michael@0:         ParamFilterStageGain,
michael@0:         ParamFilterStageRatio,
michael@0:         ParamFilterAnchor,
michael@0:         ParamEffectBlend,
michael@0:         ParamReduction,
michael@0:         ParamLast
michael@0:     };
michael@0: 
michael@0:     DynamicsCompressor(float sampleRate, unsigned numberOfChannels);
michael@0: 
michael@0:     void process(const AudioChunk* sourceChunk, AudioChunk* destinationChunk, unsigned framesToProcess);
michael@0:     void reset();
michael@0:     void setNumberOfChannels(unsigned);
michael@0:     unsigned numberOfChannels() const { return m_numberOfChannels; }
michael@0: 
michael@0:     void setParameterValue(unsigned parameterID, float value);
michael@0:     float parameterValue(unsigned parameterID);
michael@0: 
michael@0:     float sampleRate() const { return m_sampleRate; }
michael@0:     float nyquist() const { return m_sampleRate / 2; }
michael@0: 
michael@0:     double tailTime() const { return 0; }
michael@0:     double latencyTime() const { return m_compressor.latencyFrames() / static_cast<double>(sampleRate()); }
michael@0: 
michael@0:     size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
michael@0: 
michael@0: protected:
michael@0:     unsigned m_numberOfChannels;
michael@0: 
michael@0:     // m_parameters holds the tweakable compressor parameters.
michael@0:     float m_parameters[ParamLast];
michael@0:     void initializeParameters();
michael@0: 
michael@0:     float m_sampleRate;
michael@0: 
michael@0:     // Emphasis filter controls.
michael@0:     float m_lastFilterStageRatio;
michael@0:     float m_lastAnchor;
michael@0:     float m_lastFilterStageGain;
michael@0: 
michael@0:     typedef struct {
michael@0:         ZeroPole filters[4];
michael@0:         size_t sizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const
michael@0:         {
michael@0:             return aMallocSizeOf(this);
michael@0:         }
michael@0:     } ZeroPoleFilterPack4;
michael@0: 
michael@0:     // Per-channel emphasis filters.
michael@0:     nsTArray<nsAutoPtr<ZeroPoleFilterPack4> > m_preFilterPacks;
michael@0:     nsTArray<nsAutoPtr<ZeroPoleFilterPack4> > m_postFilterPacks;
michael@0: 
michael@0:     nsAutoArrayPtr<const float*> m_sourceChannels;
michael@0:     nsAutoArrayPtr<float*> m_destinationChannels;
michael@0: 
michael@0:     void setEmphasisStageParameters(unsigned stageIndex, float gain, float normalizedFrequency /* 0 -> 1 */);
michael@0:     void setEmphasisParameters(float gain, float anchorFreq, float filterStageRatio);
michael@0: 
michael@0:     // The core compressor.
michael@0:     DynamicsCompressorKernel m_compressor;
michael@0: };
michael@0: 
michael@0: } // namespace WebCore
michael@0: 
michael@0: #endif // DynamicsCompressor_h