Document toolboxDocument toolbox

(8.D.1.2) WaveOneShotPlayerFFSFract32

Owned by Catherine Spain
Apr 10, 2023
6 min read

Overview

One-shot Wave Player supporting pitch shifting

Discussion

This module outputs wave data triggered via an input pin. 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. The input .trigger is a Boolean value which if set starts playback. Playback continues until the end of the file is reached and then it stops. Retrigger while being in the middle of the playback has no effect and will be ignored. The module supports multichannel such that, if the wave file has more channels than provided to the module argument then only channels up to output pin will be used. If the wave file has less channels than output pin channels, then the remaining output channels will be muted.

Optional argument MUTMOD can be used to mute output before changing file in run time.

Optional argument UNMUTEMOD can be used to un-mute output after file is processed in run time.

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

typedef struct _ModuleWaveOneShotPlayerFFSFract32 { 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) 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 NCOFracBits; // Number of least-significant bits for the *fractional* part of the NCO word (word size: 32) 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 triggerPrev; // State trigger signal to determine falling edge INT32 triggerLatched; // State trigger denoting player is active 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 INT32 NCOIntBits; // Number of most-significant bits for the *integer* part of the NCO word (word size: 32). By default: 20 bits FLOAT32 formatF; // Integer value of left-shift by NCOFracBits. Determines the precision of the linear interpolation. FLOAT32 formatI; // Integer value of left-shift by NCOIntBits. Determines the maximum playback rate and the maximum size of a wave file in samples. 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. } ModuleWaveOneShotPlayerFFSFract32Class;

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

 

normRate

float

const

0

1

Unrestricted

 

maxRate

float

const

0

2

Unrestricted

 

NCOFracBits

int

const

0

12

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

 

triggerPrev

int

state

0

0

Unrestricted

 

triggerLatched

int

state

0

0

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

 

NCOIntBits

int

derived

1

20

Unrestricted

 

formatF

float

derived

1

0

Unrestricted

 

formatI

float

derived

1

0

Unrestricted

 

pinID

uint

const

1

1

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: trigger

Description: Boolean trigger signal

Data type: int

Channel range: 1

Block size range: 1

Sample rate range: Unrestricted

Complex support: Real

 

Name: fsInstance

Description: AWE file system instance pointer

Data type: int

Channel range: Unrestricted

Block size range: 1

Sample rate range: Unrestricted

Complex support: Real

 

Name: fRatio

Description: Specifies sample rate ratio

Data type: float

Channel range: 1

Block size range: 1

Sample rate range: Unrestricted

Complex support: Real

Output Pins

Name: audio

Description: output data

Data type: fract32

 

Name: isPlaying

Description: playing state

Data type: int

MATLAB Usage

File Name: wave_oneshot_player_ffs_fract32_module.m