Overview

Module with different time delay for each channel specified in samples

Discussion

This time delay module has multiple input and multiple output channels. The delay in samples of each output channel can be independently set by the currentDelay array. The initial number of channels is specified at construction time and this also equals the length of the currentDelay array. Actual size of the currentDelay is updated in the prebuild function. Delays are specified in samples and are in the range of [0 MaxDelayPerChannel].

At construction time, you specify the maximum delay (maxDelay) of each channel. The maxDelay determines the size of the internal state buffer. The size of the internal state buffer equals sum of (maxDelay + 1) of each channel, samples. The delay in samples per channel is specified by the currentDelay array. Delays can be adjusted at run-time. However, the module is not smoothly updating and you may get audible clicks when adjusting the currentDelay at run-time.

Type Definition

typedef struct _ModuleDelayNChanV2
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 stateHeap;                              // Heap in which to allocate memory.
    INT32 maxDelayTotal;                          // Total max delay of all channels.
    INT32* maxDelay;                              // Maximum delay per channel, in samples.
    INT32* currentDelay;                          // Current delay per channel, in samples.
    INT32* stateIndex;                            // Index of the oldest state variable in the array of state variables.
    FLOAT32* state;                               // State variable array.
} ModuleDelayNChanV2Class;

Variables

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
stateHeap	int	const	1	561	Unrestricted
maxDelayTotal	int	state	1	133	Unrestricted
maxDelay	int*	const	0	[1 x 1]	Unrestricted	samples
currentDelay	int*	parameter	0	[1 x 1]	Unrestricted	samples
stateIndex	int*	state	1	[1 x 1]	Unrestricted
state	float*	state	1	[133 x 1]	Unrestricted

Pins

Input Pins

Name: in

Description: audio input

Data type: {float, int, fract32}

Channel range: Unrestricted

Block size range: Unrestricted

Sample rate range: Unrestricted

Complex support: Real

Output Pins

Name: out

Description: audio output

Data type: {float, int, fract32}

MATLAB Usage

File Name: delaynchan_v2_module.m

 M=delaynchan_v2_module(NAME, NUMCHANNELS, MEMHEAP)
 Creates a multi-channel time delay. The module has a multichannel input pin
 and an multichannel output pin. Each output channel is a delayed
 version of the corresponding input channel with different delay times 
 per channel.
 
 Arguments:
    NAME - name of the module.
    NUMCHANNELS - number of channels for the module.
    MEMHEAP - specifies the memory heap to use to allocate the main
         state buffer. This is a string and follows the memory allocation
         enumeration in Framework.h. Allowable values are:
            'AWE_HEAP_FAST' - always use internal DM memory.
            'AWE_HEAP_FASTB' - always use internal PM memory.
            'AWE_HEAP_SLOW' - always use external memory.
            'AWE_HEAP_FAST2SLOW' - use internal memory. If this fails
               then use external memory (the default).
            'AWE_HEAP_FASTB2SLOW' - use internal memory. If this fails
               then use external memory.

Documentation Hub [PUBLIC]

(8.D.2.5) DelayNChanV2