(8.D.2.6) IPCFifoIn

Overview

First half of the IPC FIFO module

Discussion

THIS MODULE IS DEPRECATED AND SHOULD NOT BE USED. PLEASE USE THE IPCBuffer MODULE INSTEAD

Type Definition

typedef struct _ModuleIPCFifoIn
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 bufferSize;                             // Number of samples buffer per channel. The size of the array is BUFFERSIZE*numChannels.
    INT32 pingPongFlag;                           // Ping/Pong Flag Used to Index Double Buffering
    INT32 bufferAddrOffset;                       // Holds shared heap offset address of IPCFifoIn buffer allocation
    FLOAT32* buffer;                              // Array holding state input.
} ModuleIPCFifoInClass;

Variables

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
bufferSize	int	const	0	128	Unrestricted	samples
pingPongFlag	int	state	0	1	Unrestricted
bufferAddrOffset	int	state	1	0	Unrestricted
buffer	float*	state	0	[1 x 128]	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 and Complex

MATLAB Usage

File Name: ipc_fifo_in_module.m

M=ipc_fifo_in_module(NAME, BUFFERSIZE)
 This module implements an IPC FIFO buffer which stores the input data into an
 internal buffer placed in shared memory. It must be used in conjunction with the
 ipc_fifo_out_module.m.  
 
 Arguments:
    NAME - name of the module.
    BUFFERSIZE - size of the internal buffer, in samples. When multiple
         channels are involved, this refers to the size of each channels'
         buffer.