AWEOSConfigParameters

AWEOSConfigParameters. More...

#include <Include/AWECoreOS.h>

Public Attributes

	Name
UINT32 *	pFastHeapA Pointer to fast heap A.
UINT32 *	pFastHeapB Pointer to fast heap B.
UINT32 *	pSlowHeap Pointer to slow heap.
UINT32	fastHeapASize Size of fast heap A in 32-bit words.
UINT32	fastHeapBSize Size of fast heap B in 32-bit words.
UINT32	slowHeapSize Size of slow heap in 32-bit words.
INT32()(AWEOSInstance pAWEOS)	cbAudioStart Pointer to user created callback function for audio start commands.
INT32()(AWEOSInstance pAWEOS)	cbAudioStop Pointer to user created callback function for audio stop commands.
UINT32 *	pPacketBuffer Pointer to packet buffer.
UINT32 *	pReplyBuffer Pointer to reply packet buffer.
UINT32	packetBufferSize Size of packet buffers.
UINT32	userVersion User specified version number.
float	coreSpeed Processor clock speed in Hz.
float	profileSpeed Application profiling speed in Hz.
const char *	pName Name of target.
UINT32	numThreads Maximum number of supported sublayouts.
float	sampleRate Sample rate of audio device.
UINT32	fundamentalBlockSize Fundamental block size of audio driver.
UINT32	inChannels Number of input channels of audio device.
UINT32	outChannels Number of output channels of audio device.
INT32	instanceId ID number of instance.

Detailed Description

struct AWEOSConfigParameters;

AWEOSConfigParameters.

The AWE Core OS Configuration Parameter Structure This structure will hold the config parameters for the AWE Core OS instance. A user must create one of these per AWEOSInstance, and either populate it in manually, or call the aweOS_getParamDefaults to populate it with defaults. Once the structure has been configured, it is passed in to the aweOS_init function with an AWEOSInstance, and the instance is initialized with the given configuration parameters. The heap pointers, pPacketBuffer and pReplyBuffer will be assigned to NULL when calling aweOS_getParamDefaults. If they are not overwritten by user, then memory is allocated in aweOS_init. Internally allocated heap sizes can be controlled via the heapSize configuration parameters.

Public Attributes Documentation

variable pFastHeapA

UINT32 * pFastHeapA;

Pointer to fast heap A.

Allocated and assigned in aweOS_init by default

variable pFastHeapB

UINT32 * pFastHeapB;

Pointer to fast heap B.

Allocated and assigned in aweOS_init by default

variable pSlowHeap

UINT32 * pSlowHeap;

Pointer to slow heap.

Allocated and assigned in aweOS_init by default

variable fastHeapASize

UINT32 fastHeapASize;

Size of fast heap A in 32-bit words.

Default 5000000. If specified without corresponding heap ptr also specified, aweOS_init will allocate a heap of this size

variable fastHeapBSize

UINT32 fastHeapBSize;

Size of fast heap B in 32-bit words.

Default 5000000. If specified without corresponding heap ptr also specified, aweOS_init will allocate a heap of this size

variable slowHeapSize

UINT32 slowHeapSize;

Size of slow heap in 32-bit words.

Default 5000000. If specified without corresponding heap ptr also specified, aweOS_init will allocate a heap of this size

variable cbAudioStart

INT32(*)(AWEOSInstance *pAWEOS) cbAudioStart;

Pointer to user created callback function for audio start commands.

Default NULL

variable cbAudioStop

INT32(*)(AWEOSInstance *pAWEOS) cbAudioStop;

Pointer to user created callback function for audio stop commands.

Default NULL

variable pPacketBuffer

UINT32 * pPacketBuffer;

Pointer to packet buffer.

Only modify if not using built-in tuning interface aweOS_tuningSocketOpen. Default NULL

variable pReplyBuffer

UINT32 * pReplyBuffer;

Pointer to reply packet buffer.

Only modify if not using built-in tuning interface aweOS_tuningSocketOpen. Default NULL

variable packetBufferSize

UINT32 packetBufferSize;

Size of packet buffers.

Default 264 32-bit words. Increasing up to 4105 can improve tuning interface performance

variable userVersion

UINT32 userVersion;

User specified version number.

Default 1

variable coreSpeed

float coreSpeed;

Processor clock speed in Hz.

Default 1 GHz

variable profileSpeed

float profileSpeed;

Application profiling speed in Hz.

Default 10 MHz. Normally unchanged from default

variable pName

const char * pName;

Name of target.

Max size 8 chars. Default "aweOS"

variable numThreads

UINT32 numThreads;

Maximum number of supported sublayouts.

Default 4. Max value is 31

variable sampleRate

float sampleRate;

Sample rate of audio device.

Default 48000.0

variable fundamentalBlockSize

UINT32 fundamentalBlockSize;

Fundamental block size of audio driver.

Default 32

variable inChannels

UINT32 inChannels;

Number of input channels of audio device.

Default 2

variable outChannels

UINT32 outChannels;

Number of output channels of audio device.

Default 2

variable instanceId

INT32 instanceId;

ID number of instance.

Default 0. Modify only in multi-instance applications

Updated on 2026-02-10 at 15:44:47 -0500