Document toolboxDocument toolbox

SourceIntProperties

Overview

Source buffer holding 1 wire of integer data

Discussion

The source module has an internal buffer holding 1 output wire's worth of integer data. The module continuously copies the data from the internal value buffer to the output wire. Since this is a source module, you must specify the number of channels, blockSize, and sample rate of the output pin

Additionally, this module makes the wire information available as internal variables. Block size, channel number, sample rate and signal complexity can be accessed in MATLAB code, source code, or in a layout using the ParamGet module.

Type Definition

typedef struct _ModuleSourceIntProperties { ModuleInstanceDescriptor instance; // Common Audio Weaver module instance structure INT32 BlockSize; // Block Size INT32 NumChannels; // Number of Channels INT32 SampleRate; // Sample Rate INT32 IsComplex; // Is Complex INT32* value; // Array of interleaved audio data } ModuleSourceIntPropertiesClass;

Variables

Properties

Name

Type

Usage

isHidden

Default value

Range

Units

BlockSize

int

const

0

16

Unrestricted

 

NumChannels

int

const

0

2

Unrestricted

 

SampleRate

int

const

0

48000

Unrestricted

 

IsComplex

int

const

0

0

Unrestricted

 

value

int*

parameter

0

[16 x 2]

Unrestricted

 

Pins

Output Pins

Name: out

Description: output data

Data type: int

MATLAB Usage

File Name: source_int_properties_module.m

M=source_int_properties_module(NAME, NUMCHANNELS, BLOCKSIZE, SAMPLERATE, ISCOMPLEX) Creates a source module that allows you to inject integer data into the audio processing layout. Arguments: NAME - name of the module. NUMCHANNELS - number of interleaved channels in each output pin. By default, NUMCHANNELS = 1; BLOCKSIZE - number of samples per output channel. By default, BLOCKSIZE = 32. SAMPLERATE - sample rate of the output signal, in Hz. By default, SAMPLERATE = 48000. ISCOMPLEX - Boolean indicating whether the source module holds complex data. By default ISCOMPEX = 0 (real).

Â