AWE Core OS 8.B.19 Documentation
Data Fields
AWEOSConfigParameters Struct Reference

AWEOSConfigParameters. More...

#include <Include/AWECoreOS.h>

Data Fields

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

Detailed Description

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.

Examples
HelloWorld.c, LayoutControl.c, Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

Field Documentation

◆ pFastHeapA

UINT32* AWEOSConfigParameters::pFastHeapA

Pointer to fast heap A.

Allocated and assigned in aweOS_init by default

Examples
LayoutControl.c, and Libtester.c.

◆ pFastHeapB

UINT32* AWEOSConfigParameters::pFastHeapB

Pointer to fast heap B.

Allocated and assigned in aweOS_init by default

Examples
LayoutControl.c, and Libtester.c.

◆ pSlowHeap

UINT32* AWEOSConfigParameters::pSlowHeap

Pointer to slow heap.

Allocated and assigned in aweOS_init by default

Examples
LayoutControl.c, and Libtester.c.

◆ fastHeapASize

UINT32 AWEOSConfigParameters::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

Examples
LayoutControl.c, and Libtester.c.

◆ fastHeapBSize

UINT32 AWEOSConfigParameters::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

Examples
LayoutControl.c, and Libtester.c.

◆ slowHeapSize

UINT32 AWEOSConfigParameters::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

Examples
LayoutControl.c, and Libtester.c.

◆ cbAudioStart

INT32(* AWEOSConfigParameters::cbAudioStart) (AWEOSInstance *pAWEOS)

Pointer to user created callback function for audio start commands.

Default NULL

Examples
Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

◆ cbAudioStop

INT32(* AWEOSConfigParameters::cbAudioStop) (AWEOSInstance *pAWEOS)

Pointer to user created callback function for audio stop commands.

Default NULL

Examples
Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

◆ pPacketBuffer

UINT32* AWEOSConfigParameters::pPacketBuffer

Pointer to packet buffer.

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

◆ pReplyBuffer

UINT32* AWEOSConfigParameters::pReplyBuffer

Pointer to reply packet buffer.

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

◆ packetBufferSize

UINT32 AWEOSConfigParameters::packetBufferSize

Size of packet buffers.

Default 264 32-bit words. Normally unchanged from default

◆ userVersion

UINT32 AWEOSConfigParameters::userVersion

User specified version number.

Default 1

◆ coreSpeed

float AWEOSConfigParameters::coreSpeed

Processor clock speed in Hz.

Default 1 GHz

Examples
Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

◆ profileSpeed

float AWEOSConfigParameters::profileSpeed

Application profiling speed in Hz.

Default 10 MHz. Normally unchanged from default

Examples
Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

◆ pName

const char* AWEOSConfigParameters::pName

Name of target.

Max size 8 chars. Default "aweOS"

Examples
HelloWorld.c, Libtester.c, and Multi-Instance.c.

◆ numThreads

UINT32 AWEOSConfigParameters::numThreads

Maximum number of supported sublayouts.

Default 4. Max value is 31

Examples
Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

◆ sampleRate

float AWEOSConfigParameters::sampleRate

Sample rate of audio device.

Default 48000.0

Examples
Libtester.c, and RTAudio-alsa.c.

◆ fundamentalBlockSize

UINT32 AWEOSConfigParameters::fundamentalBlockSize

Fundamental block size of audio driver.

Default 32

Examples
Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

◆ inChannels

UINT32 AWEOSConfigParameters::inChannels

Number of input channels of audio device.

Default 2

Examples
Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

◆ outChannels

UINT32 AWEOSConfigParameters::outChannels

Number of output channels of audio device.

Default 2

Examples
Libtester.c, Multi-Instance.c, and RTAudio-alsa.c.

◆ instanceId

INT32 AWEOSConfigParameters::instanceId

ID number of instance.

Default 0. Modify only in multi-instance applications

Examples
Multi-Instance.c, and RTAudio-alsa.c.

The documentation for this struct was generated from the following file: