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 the target Flash device, 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.
...
1 - indicates pitch ratio is more than max supported 2 - indicates wave file has more than max supported
Type Definition
Code Block |
---|
typedef struct _ModuleWaveOneShotPlayerFlash { 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 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 maxWaveChannels; // Maximum number of channels a wave file can have FLOAT32 maxRatio; // Maximum pitch factor supported. Anything from fRatio pin above this clipped to maxRatio INT32 waveLength; // Number of samples in currently loaded file INT32 fsInstance; // AWE flash file system instance pointer FLOAT32 fIndex; // Current 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 fsValid; // Boolean which indicates if the Flash File System is valid. INT32 waveBuffer; // State variable holds the start ofset of the wave file in flash file system. 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 void * localWaveBuffer; // Internal pointer used only on Windows or Linux, which holds entire wave data } ModuleWaveOneShotPlayerFlashClass; |
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 | |
interpMode | int | const | 0 | 2 | Unrestricted | |
normRate | float | const | 0 | 1 | Unrestricted | |
maxRate | float | const | 0 | 2 | Unrestricted | |
maxWaveChannels | int | const | 0 | 10 | Unrestricted | |
maxRatio | float | const | 0 | 10 | Unrestricted | |
waveLength | int | derived | 0 | 0 | Unrestricted | |
fsInstance | int | state | 0 | 0 | Unrestricted | |
fIndex | 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 | |
fsValid | int | state | 1 | 0 | Unrestricted | |
waveBuffer | int | state | 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 | |
localWaveBuffer | void * | state | 1 | Unrestricted |
Pins
Input Pins
Name: trigger
Description: Boolean trigger signal
...
Sample rate range: Unrestricted
Complex support: Real
Output Pins
Name: audio
Description: output data
...
Description: playing state
Data type: int
Scratch Pins
Channel count: 10
Block size: 2565
Sample rate: 48000
MATLAB Usage
File Name: wave_oneshot_player_flash_module.m