Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Documents: Update page title prefix

Overview

Periodic WAV playback supporting pitch shifting

Discussion

This module outputs wave data in loop mode. It extracts wave data from AWE Flash File System container on control input pin fsInstance, based on WAVFILE argument. User has to specify the file name as an argument and can also change file name directly into fileName array as 32-bit packed data during run time. Along with the above parameters, the playback functionality can be enabled from the control input pin, 1 - Enable and 0 - Disable.

...

If any errors occurs in the module, it is captured in the parameter .errorCodes. Please check in Errors.h for the meaning of error code returned.

Type Definition

Code Block
typedef struct _ModuleWaveLoopPlayerFFS
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 smoothingTime;                          // Time constant of the pitch smoothing process
    INT32 smoothingFactor;                        // Update rate for smoothing coeffs (per block)
    INT32 startDelay;                             // Starting delay value in samples
    INT32 enable;                                 // En/Disable playback. Resets sample position to startDelay value upon stop
    INT32 interpMode;                             // Linear or cubic interpolation
    FLOAT32 normRate;                             // Rate of data used to compute the ratio for normalized players
    FLOAT32 maxRate;                              // Highest allowed rate of playback that can be specified
    INT32 waveLength;                             // Number of samples in currently loaded file
    INT32 fsInstance;                             // AWE flash file system instance pointer
    INT32 fIndex;                                 // Current index in the wave file
    FLOAT32 fIndexFract;                          // Current fract index in the wave file
    INT32 errorCode;                              // Captures errors that could arise in the module C code. Appears on the inspector
    INT32 isReady;                                // Boolean that indicates the module is not ready to output data
    INT32 waitForMuteDone;                        // Internal flag to check if the smooth mute is done
    FLOAT32 currentFStep;                         // Current (smoothed) rate at which audio is read from the input buffer
    INT32 waveSR;                                 // Actual sample rate of the wave file.
    INT32 waveNumChannels;                        // Number of channels in the wave file.
    INT32 waveBit;                                // Wave data sample bit resolution.
    FLOAT32 scaleFactor;                          // Scale factor for playback rate
    FLOAT32 smoothingCoeff;                       // Smoothing (pitch) coefficient
    UINT32 pinID;                                 // Specifies which control pins are available.
    INT32* fileName;                              // Name of wave file to playback
    INT32* fileNamePrev;                          // Name of wave file to playback
    void * muteModPtr;                            // Internal pointer to mute module to mute before reconfiguration
    void * unMuteModPtr;                          // Internal pointer to mute module to unmute after reconfiguration
    UINT32 * fsInstancePtr;                       // AWE flash file system instance pointer
    UINT32 * waveBuffer;                          // State variable holds the start address of the wave file in filesystem.
} ModuleWaveLoopPlayerFFSClass;

Variables

Properties

Name

Type

Usage

isHidden

Default value

Range

Units

smoothingTime

int

parameter

0

10

0:1000

msec

smoothingFactor

int

parameter

0

4

1:512

startDelay

int

parameter

0

0

Unrestricted

enable

int

state

0

1

0:1

interpMode

int

const

0

2

Unrestricted

normRate

float

const

0

1

Unrestricted

maxRate

float

const

0

2

Unrestricted

waveLength

int

derived

0

0

Unrestricted

fsInstance

int

state

0

0

Unrestricted

fIndex

int

state

0

0

Unrestricted

fIndexFract

float

state

0

0

Unrestricted

errorCode

int

state

0

0

Unrestricted

isReady

int

state

0

0

Unrestricted

waitForMuteDone

int

state

0

0

Unrestricted

currentFStep

float

state

0

1

Unrestricted

waveSR

int

derived

1

0

Unrestricted

waveNumChannels

int

derived

1

0

Unrestricted

waveBit

int

derived

1

0

Unrestricted

scaleFactor

float

derived

1

1

Unrestricted

smoothingCoeff

float

derived

1

0

Unrestricted

pinID

uint

const

1

3

Unrestricted

fileName

int*

parameter

1

[14 x 1]

Unrestricted

fileNamePrev

int*

state

1

[14 x 1]

Unrestricted

muteModPtr

void *

state

1

0

Unrestricted

unMuteModPtr

void *

state

1

0

Unrestricted

fsInstancePtr

UINT32 *

state

1

Unrestricted

waveBuffer

UINT32 *

state

1

Unrestricted

Pins

Input Pins

Name: enable

Description: Flag to enable playback

...

Sample rate range: Unrestricted

Complex support: Real

Output Pins

Name: audio

Description: output data

...

Description: playing state

Data type: int

MATLAB Usage

File Name: wave_loop_player_ffs_module.m