function M=scaler_smoothed_example_module(NAME)
% M=scaler_smoothed_example_module(NAME)
% Creates a smoothly varying scaler module with a single input
% and single output pin.  This module operates on floating-point
% signals.  Arguments:
%    NAME - name of the module.

% Copyright 2007-2016.  DSP Concepts, Inc.  All Rights Reserved.

% ----------------------------------------------------------------------
% Create the high-level object with interface variables only.
% ----------------------------------------------------------------------

M=awe_module('ScalerSmoothedExample', 'Linear multichannel smoothly varying scaler');

% Version is auto-updated by SVN:
M.moduleVersion = generate_version('$Revision: 30333 $');
if (nargin == 0)
    return;
end
M.name=NAME;
M.preBuildFunc=@scaler_smoothed_example_prebuild;
M.processFunc=@scaler_smoothed_example_process;
M.setFunc=@scaler_smoothed_example_set;

PT=new_pin_type;

add_pin(M, 'input', 'in', 'audio input', PT);
add_pin(M, 'output', 'out', 'audio output', PT);

add_variable(M, 'gain', 'float', 0, 'parameter', 'Target gain');
M.gain.range=[-10 10];
M.gain.units='linear';

add_variable(M, 'smoothingTime', 'float', 10, 'parameter', 'Time constant of the smoothing process');
M.smoothingTime.range=[0 1000];
M.smoothingTime.units='msec';

add_variable(M, 'currentGain', 'float', M.gain, 'state', 'Instantaneous gain applied by the module.  This is also the starting gain of the module.', 1);
M.currentGain.range=M.gain.range;
M.currentGain.units='linear';

add_variable(M, 'smoothingCoeff', 'float', NaN, 'derived', 'Smoothing coefficient', 1);

awe_addcodemarker(M, 'processFunction', 'Insert:InnerScalerSmoothedExample_Process.c');
awe_addcodemarker(M, 'setFunction', 'Insert:InnerScalerSmoothedExample_Set.c');
awe_addcodemarker(M, 'srcFileInclude', '#include "FilterDesign.h"');
M.wireAllocation='across';

% ----------------------------------------------------------------------
% Documentation
% ----------------------------------------------------------------------

M.docInfo.discussion={'Scales all input channels by a single gain value. ', ...
    'Changes to the gain parameter are exponentially smoothed (first order IIR) at the sample rate, with the time constant determined by the smoothingTime parameter. ', ...
    'This module is controlled by varying the gain variable.  Internally, currentGain represents the instantaneous smoothed gain that is applied. ', ...
    'currentGain exponentially approaches gain with a time constant equal to smoothingTime. ', ...
    '', ...
    'The module''s prebuild function initializes the currentGain equal to the gain.  Thus, the module begins in a converged state.'};

% ----------------------------------------------------------------------
% Add the inspector information
% ----------------------------------------------------------------------

M.guiInfo.isExpanded=0;

M.gain.guiInfo.controlType='slider';
add_control(M, '.gain');

add_control(M, '.moduleStatus', 'right', 1);
add_control(M, '.smoothingTime', 'below', 1);

% ----------------------------------------------------------------------
% Module browser information
% ----------------------------------------------------------------------

M.moduleBrowser.path = 'Examples';
M.moduleBrowser.image = '../images/ExamplesIcon.bmp';
M.moduleBrowser.searchTags = 'scaler volume';
M.shapeInfo.basicShape = 'triangle';
M.shapeInfo.legend = ' ';

return;

% ----------------------------------------------------------------------
% Prebuild function.  Behavior is based on the data type of the
% input pin
% ----------------------------------------------------------------------

function M=scaler_smoothed_example_prebuild(M)

M.currentGain=M.gain;
M.currentGain.range=M.gain.range;

% Propagate the type of the input pin to the output
M.outputPin{1}.type=M.inputPin{1}.type;

return;

% ----------------------------------------------------------------------
% Set function.  Computes the smoothing coefficient
% ----------------------------------------------------------------------

function M=scaler_smoothed_example_set(M)

% Compute the smoothing coefficient based on the smoothing time
SR=M.inputPin{1}.type.sampleRate;
M.smoothingCoeff = design_smoother(M.smoothingTime, SR, 1);

return;

awe_modScalerSmoothedExampleInstance *S = (awe_modScalerSmoothedExampleInstance *)pInstance;
WireInstance **pWires = ClassModule_GetWires(S);
FLOAT32 targetGain = S->gain;
FLOAT32 smoothingCoeff = S->smoothingCoeff;
FLOAT32 *src = (FLOAT32 *)pWires[0]->buffer;
FLOAT32 *dst = (FLOAT32 *)pWires[1]->buffer;
UINT32 channels = ClassWire_GetChannelCount(pWires[0]);
UINT32 blockSize = ClassWire_GetBlockSize(pWires[0]);
FLOAT32 currentGain;
UINT32 i;
FLOAT32 *inPtr;
FLOAT32 *outPtr;
FLOAT32 oneMinusRate = 1.0f - smoothingCoeff;
INT32 sample;

for (i = 0; i < channels; i++)
{
    /* The same currentGain is used for each channel. Then we store the result
       from the final channel back into the state. */
    currentGain = S->currentGain;
    
    /*awe_vecScaleSmooth(src + i, channels, dst + i, channels, &currentGain, targetGain,
              smoothingCoeff, blockSize);*/
              
    inPtr = src + i;
    outPtr = dst + i;
    
    for(sample = 0; sample < (INT32)blockSize; sample++)
    {
        currentGain = currentGain * oneMinusRate + targetGain * smoothingCoeff;
        
        *outPtr = *inPtr * currentGain;
        
        inPtr += channels;
        outPtr += channels;
    }
}

S->currentGain = currentGain;

awe_modScalerSmoothedExampleInstance *S = (awe_modScalerSmoothedExampleInstance *) pInstance;
WireInstance **pWires = ClassModule_GetWires(S);
FLOAT32 SR;

if (mask & MASK_ScalerSmoothedExample_smoothingTime)
{
    SR = (float) ClassWire_GetSampleRate(pWires[0]);

    S->smoothingCoeff = design_smoother(S->smoothingTime, SR, 1);
}

return(0);

/****************************************************************************
*
*               Audio Framework
*               ---------------
*
****************************************************************************
*     ModScalerSmoothedExample.h
****************************************************************************
*
*     Description:  Linear multichannel smoothly varying scaler
*
*     Copyright:    2019 DSP Concepts, Inc. All rights reserved.
*                   3235 Kifer Road
*                   Santa Clara, CA 95054
*
***************************************************************************/

/**
 * @addtogroup Modules
 * @{
 */

/**
 * @file
 * @brief Linear multichannel smoothly varying scaler
 */

#ifndef _MOD_SCALERSMOOTHEDEXAMPLE_H
#define _MOD_SCALERSMOOTHEDEXAMPLE_H

#include "ModCommon.h"
#include "MathHelper.h"

#define MASK_ScalerSmoothedExample_gain 0x00000100
#define MASK_ScalerSmoothedExample_smoothingTime 0x00000200
#define MASK_ScalerSmoothedExample_currentGain 0x00000400
#define MASK_ScalerSmoothedExample_smoothingCoeff 0x00000800
#define OFFSET_ScalerSmoothedExample_gain 0x00000008
#define OFFSET_ScalerSmoothedExample_smoothingTime 0x00000009
#define OFFSET_ScalerSmoothedExample_currentGain 0x0000000A
#define OFFSET_ScalerSmoothedExample_smoothingCoeff 0x0000000B

#define CLASSID_SCALERSMOOTHEDEXAMPLE (CLASS_ID_MODBASE + 32768)

#ifdef __cplusplus
extern "C" {
#endif

// ----------------------------------------------------------------------
// Overall instance class
// ----------------------------------------------------------------------

typedef struct _awe_modScalerSmoothedExampleInstance
{
    ModuleInstanceDescriptor instance;
    FLOAT32            gain;                // Target gain
    FLOAT32            smoothingTime;       // Time constant of the smoothing process
    FLOAT32            currentGain;         // Instantaneous gain applied by the module.  This is also the starting gain of the module.
    FLOAT32            smoothingCoeff;      // Smoothing coefficient
    
} awe_modScalerSmoothedExampleInstance;

#if !defined(NOREDEF)
extern const ModClassModule awe_modScalerSmoothedExampleClass;
#endif // #if !defined(NOREDEF)

/* Dynamic instantiation is used by default.  When building for static
** code, define AWE_STATIC_CODE to eliminate the constructor function. */

#ifndef AWE_STATIC_CODE
// This points the constructor for this class to the base constructor
#define awe_modScalerSmoothedExampleConstructor(ARG1, ARG2, ARG3, ARG4, ARG5) ClassModule_Constructor(CLASSID_SCALERSMOOTHEDEXAMPLE, ARG1, ARG2, ARG3, ARG4, ARG5)
#endif // #ifndef AWE_STATIC_CODE


void awe_modScalerSmoothedExampleProcess(void *pInstance);

UINT32 awe_modScalerSmoothedExampleSet(void *pInstance, UINT32 mask);
 



#ifdef __cplusplus
}
#endif


#endif // _MOD_SCALERSMOOTHEDEXAMPLE_H

/**
 * @}
 *
 * End of file.
 */

/****************************************************************************
*
*               Audio Framework
*               ---------------
*
****************************************************************************
*     ModScalerSmoothedExample.c
****************************************************************************
*
*     Description:  Linear multichannel smoothly varying scaler
*
*     Copyright:    2019 DSP Concepts, Inc. All rights reserved.
*                   3235 Kifer Road
*                   Santa Clara, CA 95054
*
***************************************************************************/

/**
 * @addtogroup Modules
 * @{
 */

/**
 * @file
 * @brief Linear multichannel smoothly varying scaler
 */

#define NOREDEF


#include "Framework.h"
#include "Errors.h"
#include "ModScalerSmoothedExample.h"

#include "FilterDesign.h"

#ifdef __cplusplus
extern "C" {
#endif

/* ----------------------------------------------------------------------
** Audio module class object.  This describes the audio module to the
** framework.  It contains pointers to functions and number of
** variables.
** ------------------------------------------------------------------- */

CREATE_MODULE_CLASS(Class_awe_modScalerSmoothedExample, (4 + 0))

AWE_MOD_SLOW_ANY_CONST
const Class_awe_modScalerSmoothedExample awe_modScalerSmoothedExampleClass =
{
    {
        { NULL, CLASSID_SCALERSMOOTHEDEXAMPLE, },
        awe_modScalerSmoothedExampleProcess,                // Processing function
        IOMatchUpModule_Bypass,                 // Bypass function
        awe_modScalerSmoothedExampleSet,                    // Set function
        0,                                    // Get function
        0x00000007,                      // Module version info
        ClassModule_PackArgCounts(4, 0),    // (Public words, private words)
        {0x0000000F, 0x00000000}, // Specifies which variables are floating-point
    },
#ifdef BUILD64
    {
        offsetof(awe_modScalerSmoothedExampleInstance, gain),
        offsetof(awe_modScalerSmoothedExampleInstance, smoothingTime),
        offsetof(awe_modScalerSmoothedExampleInstance, currentGain),
        offsetof(awe_modScalerSmoothedExampleInstance, smoothingCoeff),
    }
#endif
};


/* ----------------------------------------------------------------------
** Memory allocation function.  This is required because the module
** requires additional memory outside of its instance structure.
** ------------------------------------------------------------------- */


/* ----------------------------------------------------------------------
** Real-time Processing function.
** ------------------------------------------------------------------- */

AWE_MOD_FAST_CODE
void awe_modScalerSmoothedExampleProcess(void *pInstance)
{
    awe_modScalerSmoothedExampleInstance *S = (awe_modScalerSmoothedExampleInstance *)pInstance;
    WireInstance **pWires = ClassModule_GetWires(S);
    FLOAT32 targetGain = S->gain;
    FLOAT32 smoothingCoeff = S->smoothingCoeff;
    FLOAT32 *src = (FLOAT32 *)pWires[0]->buffer;
    FLOAT32 *dst = (FLOAT32 *)pWires[1]->buffer;
    UINT32 channels = ClassWire_GetChannelCount(pWires[0]);
    UINT32 blockSize = ClassWire_GetBlockSize(pWires[0]);
    FLOAT32 currentGain;
    UINT32 i;
    FLOAT32 *inPtr;
    FLOAT32 *outPtr;
    FLOAT32 oneMinusRate = 1.0f - smoothingCoeff;
    INT32 sample;
    
    for (i = 0; i < channels; i++)
    {
        /* The same currentGain is used for each channel. Then we store the result
           from the final channel back into the state. */
        currentGain = S->currentGain;
        
        /*awe_vecScaleSmooth(src + i, channels, dst + i, channels, &currentGain, targetGain,
                  smoothingCoeff, blockSize);*/
                  
        inPtr = src + i;
        outPtr = dst + i;
        
        for(sample = 0; sample < (INT32)blockSize; sample++)
        {
            currentGain = currentGain * oneMinusRate + targetGain * smoothingCoeff;
            
            *outPtr = *inPtr * currentGain;
            
            inPtr += channels;
            outPtr += channels;
        }
    }
    
    S->currentGain = currentGain;
}

/* ----------------------------------------------------------------------
** Set function which updates derived parameters based on the
** module's interface variables.
** ------------------------------------------------------------------- */

AWE_MOD_SLOW_CODE
UINT32 awe_modScalerSmoothedExampleSet(void *pInstance, UINT32 mask)
{
    awe_modScalerSmoothedExampleInstance *S = (awe_modScalerSmoothedExampleInstance *) pInstance;
    WireInstance **pWires = ClassModule_GetWires(S);
    FLOAT32 SR;
    
    if (mask & MASK_ScalerSmoothedExample_smoothingTime)
    {
        SR = (float) ClassWire_GetSampleRate(pWires[0]);
    
        S->smoothingCoeff = design_smoother(S->smoothingTime, SR, 1);
    }
    
    return(0);
}



#ifdef __cplusplus
}
#endif

/**
 * @}
 *
 * End of file.
 */

% Class ID list for the examples that are included in the Audio Weaver
% documentation.

IDOFFSET=32768

ScalerSmoothedExample,0
ScalerExample,1
FaderExample,2
FaderExampleFract32,3
PeakHoldExample,4
DownsamplerExample,5
LAHLimiterExample,6
PeakHoldExampleFract32,7
FeedbackExample,8

ModuleDownsamplerExample 0xBEEF8805, BaseModule

{

    D                       int        // Decimation factor.  1 out of every D samples is output
}

ModuleFaderExampleFract32 0xBEEF8803, BaseModule

{

    scaleFval               float      // Scaler Front
    scaleBval               float      // Scaler Back
    smoothingTimeF          float      // Time constant of the smoothing process
    smoothingTimeB          float      // Time constant of the smoothing process
    scalerF                 *ModuleScalerSmoothedFract32 // Linear multichannel smoothly varying scaler
    scalerB                 *ModuleScalerSmoothedFract32 // Linear multichannel smoothly varying scaler
    inter                   *ModuleInterleave // Interleaves multiple audio signals
}

ModuleFaderExample 0xBEEF8802, BaseModule

{

    fade                    float      // Front/back Balance.  +1 = front only.  -1 = rear only.
    smoothingTime           float      // Time constant of the smoothing process
    scalerF                 *ModuleScalerSmoothed // Gain control with linear units and smoothing
    scalerB                 *ModuleScalerSmoothed // Gain control with linear units and smoothing
    inter                   *ModuleInterleave // Interleaves multiple audio signals
}

ModuleLAHLimiterExample 0xBEEF8806, BaseModule

{

    maxDelayTime            float      // Maximum delay time
    max_abs                 *ModuleMaxAbs // Computes the maximum absolute value of all input channels on a sample-by-sample basis
    core                    *ModuleAGCLimiterCore // Gain computer used to realize soft-knee peak limiters
    delay                   *ModuleDelayMsec // Time delay in which the delay is specified in milliseconds
    mult                    *ModuleAGCMultiplier // Mono x N-channel multiplier
}

ModulePeakHoldExampleFract32 0xBEEF8807, BaseModule

{

    Reset                   int        // reset the current peak values
    attackTime              float      // Envelope detector attack time constant
    decayTime               float      // Envelope detector decay time constant
    decayCoef               fract32    // Computed coefficient used for decay
    attackCoef              fract32    // Computed coefficient used for attack
    peakHold                *fract32   // Array of peak values
    peakDecay               *fract32   // Array of decaying peak values
}

ModulePeakHoldExample 0xBEEF8804, BaseModule

{

    Reset                   int        // reset the current peak values
    attackTime              float      // Envelope detector attack time constant
    decayTime               float      // Envelope detector decay time constant
    decayCoef               float      // Computed coefficient used for decay
    attackCoef              float      // Computed coefficient used for attack
    peakHold                *float     // Array of peak values
    peakDecay               *float     // Array of decaying peak values
}

ModuleScalerExample 0xBEEF8801, BaseModule

{

    gain                    float      // Linear gain
}

ModuleScalerSmoothedExample 0xBEEF8800, BaseModule

{

    gain                    float      // Target gain
    smoothingTime           float      // Time constant of the smoothing process
    currentGain             float      // Instantaneous gain applied by the module.  This is also the starting gain of the module.
    smoothingCoeff          float      // Smoothing coefficient
}

extern const ModClassModule awe_modDownsamplerExampleClass;
extern const ModClassModule awe_modFaderExampleFract32Class;
extern const ModClassModule awe_modFaderExampleClass;
extern const ModClassModule awe_modLAHLimiterExampleClass;
extern const ModClassModule awe_modPeakHoldExampleFract32Class;
extern const ModClassModule awe_modPeakHoldExampleClass;
extern const ModClassModule awe_modScalerExampleClass;
extern const ModClassModule awe_modScalerSmoothedExampleClass;


#define LISTOFCLASSOBJECTS \
&awe_modDownsamplerExampleClass, \
&awe_modFaderExampleFract32Class, \
&awe_modFaderExampleClass, \
&awe_modLAHLimiterExampleClass, \
&awe_modPeakHoldExampleFract32Class, \
&awe_modPeakHoldExampleClass, \
&awe_modScalerExampleClass, \
&awe_modScalerSmoothedExampleClass

#define USESDLLS "ModulePackAweDeprecatedDLL.dll""