AWECoreOS 8.A.4 User's Guide
|
Go to the documentation of this file.
26 #include "StandardDefs.h"
30 #include <sys/types.h>
31 #include <sys/socket.h>
32 #include <netinet/in.h>
36 #include <semaphore.h>
50 #define TUNING_LOG_ERROR 1
52 #define TUNING_LOG_INFO 2
54 #define TUNING_LOG_DATA 3
58 typedef enum {ERROR, INPUT_OVERRUN, OUTPUT_OVERRUN}
STATUS;
73 #define AUDIO_RECORDING_NOTIFICATION_ERRORS (1 << 0)
75 #define AUDIO_RECORDING_NOTIFICATION_XRUNS (1 << 1)
77 #define AUDIO_RECORDING_NOTIFICATION_ALL (AUDIO_RECORDING_NOTIFICATION_ERRORS | AUDIO_RECORDING_NOTIFICATION_XRUNS)
519 INT32
aweOS_wavFileOpen(
const char *file, FLOAT32 *sampleRate, UINT32 *numChannels, UINT32 *sampleSize, UINT32 *numSamples, FILE ** fp);
532 INT32
aweOS_wavFileCreate(
const char *file, FLOAT32 sampleRate, UINT32 numChannels, UINT32 sampleSize, FILE ** fp);
567 #endif // AWECOREOS_H_
STATUS notificationStatus
type of notification being reported
Definition: AWECoreOS.h:63
INT32 aweOS_getAverageLayoutCycles(AWEOSInstance *pAWEOS, UINT32 idx, UINT32 *averageCycles)
Get the average cycles of a running layout, in units of cycles at profileSpeed.
INT32 tuningVer
Tuning version.
Definition: AWECoreOS.h:84
UINT32 fundamentalBlockSize
Fundamental block size of audio driver.
Definition: AWECoreOS.h:125
const char * textVer
String of form: "AWECoreOS Version 8.A.1.1 -- Build Number 1234".
Definition: AWECoreOS.h:89
UINT32 * pPacketBuffer
Pointer to packet buffer.
Definition: AWECoreOS.h:116
void aweOS_tuningSocketClose(AWEOSInstance *pAWEOS)
Close a running integrated TCP tuning socket.
INT32 aweOS_ctrlGetValueMask(const AWEOSInstance *pAWEOS, UINT32 handle, void *value, INT32 arrayOffset, UINT32 length, UINT32 mask)
Get a scalar or array value(s) of a module variable by handle with mask.
INT32 instanceId
ID number of instance.
Definition: AWECoreOS.h:128
INT32 aweOS_ctrlGetStatus(const AWEOSInstance *pAWEOS, UINT32 handle, UINT32 *status)
Get the status of a module.
A list of all AWE Server Commands.
INT32 aweOS_audioImportSamples(AWEOSInstance *pAWEOS, void *inSamples, INT32 inStride, INT32 channel, SampleType inType)
Import samples from an audio buffer to a specific channel of the AWEOSInstance's input pin.
Versioning structure returned by aweOS_getVersion.
Definition: AWECoreOS.h:82
INT32 aweOS_layoutGetChannelCount(const AWEOSInstance *pAWEOS, UINT32 *inCount, UINT32 *outCount)
Returns the number of input and output channels in the loaded layout.
float sampleRate
Sample rate of audio device.
Definition: AWECoreOS.h:124
void(* recordNotificationCallbackFunction)(AWEOSAudioRecordNotification_t *)
Audio recording notification callback type.
Definition: AWECoreOS.h:70
INT32 procVer
Processor specific version.
Definition: AWECoreOS.h:87
INT32 aweOS_audioRecordingDisable(AWEOSInstance *pAWEOS)
Disable recording of input and output audio of AWEOSInstance.
INT32 aweOS_ctrlGetValue(const AWEOSInstance *pAWEOS, UINT32 handle, void *value, INT32 arrayOffset, UINT32 length)
Get a scalar or array value(s) of a module parameter by handle.
UINT32 numThreads
Maximum number of supported sublayouts.
Definition: AWECoreOS.h:123
Audio recording notification callback argument structure.
Definition: AWECoreOS.h:62
INT32 aweOS_setProfilingStatus(AWEOSInstance *pAWEOS, UINT32 enable)
Enable or disable the profiling ability of the AWE Core OS Instance.
const char * pName
Name of target.
Definition: AWECoreOS.h:122
FLOAT32 xrunTime
time in seconds of xrun in recording - 0 if error
Definition: AWECoreOS.h:66
char majorVer
Major API version (single letter)
Definition: AWECoreOS.h:85
INT32 aweOS_wavFileWrite(FILE *fp, void *samples, UINT32 numSamples, UINT32 sampleSize)
Write audio data to .wav file created using aweOS_wavFileCreate.
struct AWEOSAudioRecordNotification AWEOSAudioRecordNotification_t
Audio recording notification callback argument structure.
void aweOS_getVersion(AWEOSVersionInfo_t *versionInfo)
Get the version information of the AWE Core OS library.
UINT32 fastHeapBSize
Size of fast heap B in 32-bit words.
Definition: AWECoreOS.h:112
INT32 aweOS_ctrlSetValue(const AWEOSInstance *pAWEOS, UINT32 handle, void *value, INT32 arrayOffset, UINT32 length)
Set a scalar or array value(s) of a module parameter by handle.
INT32 aweOS_ctrlGetModuleClass(const AWEOSInstance *pAWEOS, UINT32 handle, UINT32 *pClassID)
Get a module's object class from its handle.
UINT32 inChannels
Number of input channels of audio device.
Definition: AWECoreOS.h:126
INT32 aweOS_wavFileCreate(const char *file, FLOAT32 sampleRate, UINT32 numChannels, UINT32 sampleSize, FILE **fp)
Create a .wav file and populate the header with the passed in arguments.
A list of all possible Audio Weaver errors and their IDs.
INT32 aweOS_wavFileRead(FILE *fp, void *samples, UINT32 numSamples, UINT32 sampleSize)
Read audio data from .wav file opened using aweOS_wavFileOpen.
void AWEOSInstance
The AWE Core OS Instance instance type.
Definition: AWECoreOS.h:95
INT32 aweOS_audioRecordingRegisterNotificationCallback(AWEOSInstance *pAWEOS, recordNotificationCallbackFunction recordNotificationCallback, UINT32 recordNotificationMask)
Register a callback function for audio recording event notificiations.
INT32 aweOS_getParamDefaults(AWEOSConfigParameters *aweParams)
Populates an AWEOSConfigParameters structure with defaults.
UINT32 * pFastHeapB
Pointer to fast heap B.
Definition: AWECoreOS.h:109
float profileSpeed
Application profiling speed in Hz.
Definition: AWECoreOS.h:121
STATUS
Audio recording notification status type.
Definition: AWECoreOS.h:58
INT32 aweOS_layoutGetBlockSize(const AWEOSInstance *pAWEOS, UINT32 *blockSize)
Returns the block size of the loaded layout.
INT32 aweOS_tuningSocketOpen(AWEOSInstance **pAWEOS, INT32 portNo, UINT32 numInstances)
Initialize and open an integrated TCP/IP tuning interface socket.
UINT32 * pSlowHeap
Pointer to slow heap.
Definition: AWECoreOS.h:110
INT32 aweOS_ctrlSetStatus(const AWEOSInstance *pAWEOS, UINT32 handle, UINT32 *status)
Set the status of a module.
UINT32 packetBufferSize
Size of packet buffers.
Definition: AWECoreOS.h:118
INT32 aweOS_audioExportSamples(AWEOSInstance *pAWEOS, void *outSamples, INT32 outStride, INT32 channel, SampleType outType)
Export samples to a user buffer from a specific channel of the AWEOSInstance's output pin.
UINT32 xruns
total xruns on recording stream - 0 if error
Definition: AWECoreOS.h:65
INT32 aweOS_tuningPacketProcess(AWEOSInstance *pAWEOS)
Process the packet buffer in the AWEOSInstance.
INT32 aweOS_layoutIsValid(const AWEOSInstance *pAWEOS)
Determines if a layout is loaded and valid.
INT32(* cbAudioStop)(AWEOSInstance *pAWEOS)
Pointer to user created callback function for audio stop commands.
Definition: AWECoreOS.h:115
INT32 aweOS_tuningLoggingEnable(AWEOSInstance *pAWEOS, char *path, char *baseName, UINT32 verbosity)
Enable logging of the tuning packets sent and received by the AWEOSInstance.
INT32 aweOS_ctrlSetValueMask(const AWEOSInstance *pAWEOS, UINT32 handle, void *value, INT32 arrayOffset, UINT32 length, UINT32 mask)
Set a scalar or array value(s) of a module variable by handle with mask.
INT32 buildNumber
Library build number.
Definition: AWECoreOS.h:88
INT32 aweOS_init(AWEOSInstance **pAWEOS, const AWEOSConfigParameters *aweParams, const void *pModuleDescriptorTable, UINT32 moduleDescriptorTableSize)
Initialize the AWEOSInstance with the specified configuration parameters.
UINT32 outChannels
Number of output channels of audio device.
Definition: AWECoreOS.h:127
AWEOSConfigParameters.
Definition: AWECoreOS.h:106
INT32 aweOS_loadAWBFromArray(AWEOSInstance *pAWEOS, const UINT32 *pArray, UINT32 arraySize, UINT32 *pErrorOffset)
Executes packet commands from an in-memory array.
UINT32 userVersion
User specified version number.
Definition: AWECoreOS.h:119
INT32 aweOS_destroy(AWEOSInstance *pAWEOS)
Destroys the AWEOSInstance and closes all associated threads.
struct AWEOSConfigParameters AWEOSConfigParameters
AWEOSConfigParameters.
const char * aweOS_errorToString(INT32 errorCode)
Convert an error code (INT32) to its corresponding error string.
INT32 aweOS_layoutGetSampleRate(const AWEOSInstance *pAWEOS, FLOAT32 *sampleRate)
Returns the sample rate of the loaded layout.
INT32 aweOS_wavFileOpen(const char *file, FLOAT32 *sampleRate, UINT32 *numChannels, UINT32 *sampleSize, UINT32 *numSamples, FILE **fp)
Open a .wav file and populate the user arguments with the header information in the file.
UINT32 slowHeapSize
Size of slow heap in 32-bit words.
Definition: AWECoreOS.h:113
INT32 aweOS_audioPumpAll(AWEOSInstance *pAWEOS)
Pump one fundamental block size of audio through the loaded layout and all of its sublayouts.
UINT32 * pFastHeapA
Pointer to fast heap A.
Definition: AWECoreOS.h:108
UINT32 fastHeapASize
Size of fast heap A in 32-bit words.
Definition: AWECoreOS.h:111
INT32 aweOS_audioRecordingEnable(AWEOSInstance *pAWEOS, char *path, char *baseName, UINT32 bufferLength, SampleType sampleType)
Enables recording of all input and output audio of AWEOSInstance.
INT32(* cbAudioStart)(AWEOSInstance *pAWEOS)
Pointer to user created callback function for audio start commands.
Definition: AWECoreOS.h:114
INT32 minorVer
Minor API version.
Definition: AWECoreOS.h:86
INT32 aweOS_wavFileClose(FILE *fp)
Close the.wav file opened using aweOS_wavFileOpen or aweOS_wavFileCreate.
INT32 aweOS_loadAWBFile(AWEOSInstance *pAWEOS, const char *binaryFile, UINT32 *pErrorOffset)
Executes packet commands from an AWB file on the filesystem.
INT32 error
error value - 0 if xrun
Definition: AWECoreOS.h:64
struct AWEOSVersionInfo AWEOSVersionInfo_t
Versioning structure returned by aweOS_getVersion.
float coreSpeed
Processor clock speed in Hz.
Definition: AWECoreOS.h:120
UINT32 * pReplyBuffer
Pointer to reply packet buffer.
Definition: AWECoreOS.h:117
INT32 aweOS_audioIsStarted(const AWEOSInstance *pAWEOS)
Check if this instance has received an Audio Start command.