AWEInstance.h

Go to the documentation of this file.

/*******************************************************************************
*
*               Audio Framework
*               ---------------
*
********************************************************************************
*     AWEInstance.h
********************************************************************************
*
*     Description:  Public API AWEInstance structure and functions
*
*     Copyright:    (c) 2007-2024 DSP Concepts, Inc. All rights reserved.
*                   3235 Kifer Road
*                   Santa Clara, CA 95054
*
*******************************************************************************/
 
#ifndef _AWECOREINSTANCE_H
#define _AWECOREINSTANCE_H
 
#include <stdlib.h>
#include <string.h>
#include <stddef.h>
 
#include "TargetProcessor.h" //Include the TargetProcessor header that includes another processor specific header file. 
#include "FlashFSInstance.h"
#include "Pin.h"
#include "ModuleDescriptorList.h"
 
#ifdef  __cplusplus
extern "C" {
#endif
 
#define AWE_PROFILING_DISABLE_BOTH_LAYOUT_MODULE            0u
#define AWE_PROFILING_ENABLE_BOTH_LAYOUT_MODULE             1u
#define AWE_PROFILING_ENABLE_ONLY_MODULE                    2u
#define AWE_PROFILING_ENABLE_ONLY_LAYOUT                    3u
 
#define AWE_MODULE_PROFILING_BIT_POS        0
#define AWE_MODULE_PROFILING_BIT_MASK       1
#define AWE_MODULE_PROFILING_AVERAGE        (0x0u << AWE_MODULE_PROFILING_BIT_POS)
#define AWE_MODULE_PROFILING_PEAK           (0x1u << AWE_MODULE_PROFILING_BIT_POS)
#define AWE_ACCURATE_PROFILING_BIT_POS      1
#define AWE_ACCURATE_PROFILING_BIT_MASK     2
#define AWE_ENABLE_ACCURATE_PROFILING       (0x0u << AWE_ACCURATE_PROFILING_BIT_POS)
#define AWE_DISABLE_ACCURATE_PROFILING      (0x1u << AWE_ACCURATE_PROFILING_BIT_POS)
 
#define AWE_CACHE_CALLBACK_TYPE_INVALIDATE  0
#define AWE_CACHE_CALLBACK_TYPE_WRITEBACK   1
 
#define MAX_TARGET_THREADS                        (32)   
 
 
/*------------------AWE LOGGING------------------*/
#include "AWELoggingDefs.h"
 
typedef void (*cbAweLogging_t)(struct _AWEInstance* pAWE, INT32 level, UINT32 type, void* payload, INT32 payloadSizeInBytes);
 
/*------------------AWE EVENTS ------------------*/
 
typedef INT32(*cbAweEventTrigger_t)(struct _AWEInstance* pAWE, INT32 eventType, UINT32 moduleObjId, void* payload, INT32 payloadSizeInBytes, void* userHandle);
 
typedef INT32(*cbAweEventRegister_t)(struct _AWEInstance* pAWE, INT32 eventType, UINT32 moduleObjId, INT32 payloadSizeInBytes, void** userHandle);
 
typedef INT32(*cbAweEventDeregister_t)(struct _AWEInstance* pAWE, INT32 eventType, UINT32 moduleObjId, void** userHandle);
 
typedef struct _AWEInstance
{
    UINT32 instanceId; 
    
    /*------------------HEAPS------------------*/
    UINT32 *pFastHeapA; 
 
    UINT32 *pFastHeapB;
 
    UINT32 *pSlowHeap;
 
    UINT32 fastHeapASize;
 
    UINT32 fastHeapBSize;
 
    UINT32 slowHeapSize;
 
    /*------------------AUDIO CALLBACKS------------------*/
    
    INT32 (*cbAudioStart)(struct _AWEInstance *PAWE); 
 
    INT32 (*cbAudioStop)(struct _AWEInstance *pAWE);
 
    /*------------------DESTROY CALLBACK------------------*/
 
    INT32 (*cbPostDestroy)(struct _AWEInstance *pAWE);
    
    /*------------------CACHE COHERENCE CALLBACK------------------*/
    
    INT32 (*cbCacheInvalidate)(struct _AWEInstance *pAWE, void *nStartingAddress, UINT32 lengthInWords, INT32 CacheCallbackType);
 
    /*------------------THREAD PRIORITY CALLBACK------------------*/
 
    INT32(*cbGetLayoutThreadPriority)(struct _AWEInstance* pAWE, INT32 layoutNum);
 
    /*------------------PACKET FORWARD CALLBACK------------------*/
 
    INT32(*cbAweForwardPacket)(struct _AWEInstance* pAWE, INT32 instanceID);
 
    /*------------------IO PINS------------------*/
    
    IOPinDescriptor *pInputPin;
 
    IOPinDescriptor *pOutputPin;
    
    /*------------------MODULES------------------*/
 
    UINT32 numModules;
 
    const ModClassModule **pModuleDescriptorTable;
 
    ModuleDescriptorList *moduleDescriptors;
 
    /*------------------PACKET BUFFERS------------------*/
 
    UINT32 *pPacketBuffer;
 
    UINT32 *pReplyBuffer;
 
    UINT32 packetBufferSize;
    
    UINT32 userVersion;
    
    float coreSpeed;
 
    float profileSpeed;
 
#ifdef __ADSP21000__ 
    const UINT32 *pName;
#else
    const char *pName;
#endif
 
    UINT32 numThreads;
    
    float sampleRate;
 
    UINT32 fundamentalBlockSize;
    
    AWEFlashFSInstance *pFlashFileSystem;
 
  /*------------------MULTI-INSTANCE SUPPORT------------------*/
    volatile UINT32 *pSharedHeap;
 
    UINT32 sharedHeapSize;
 
    UINT32 numProcessingInstances;
 
#ifdef AWEINSTANCE_FRAMEWORK
    AWEINSTANCE_FRAMEWORK
#else
    #ifdef BUILD64
    UINT32 _Reserved[596];
    #else
    UINT32 _Reserved[316];
    #endif
#endif
 
} AWEInstance;
 
typedef struct AWEBuildVersionInfo
{
    UINT32 tuningVer;                   
    char majorVer;                      
    UINT32 minorVer;                    
    UINT32 procVer;                     
    char hotFixVer;                     
    UINT32 buildNumber;                 
} AWEBuildVersionInfo_t;
 
 
/*------------------------------------------Initialization----------------------------------------------------*/
INT32 awe_init(AWEInstance *pAWE);
 
 
INT32 awe_initPin(IOPinDescriptor *pPin, UINT32 channels, const char *name);
 
 
void awe_initFlashFS(AWEInstance * pAWE, AWEFlashFSInstance * pAWEFlashFSInstance);
 
typedef INT32 packetProcessFunction(AWEInstance * pAWE);
 
 
/*------------------------------------------Packet----------------------------------------------------*/
INT32 awe_packetProcess(AWEInstance * pAWE);
 
INT32 awe_packetProcessMulti(AWEInstance * pAWE, BOOL isTuningInstance);
 
/*------------------------------------------Audio----------------------------------------------------*/
INT32 awe_audioPump(AWEInstance *pAWE, UINT32 layoutIndex);
 
INT32 awe_audioImportSamples(const AWEInstance *pAWE, const void *inSamples, INT32 inStride, INT32 channel, SampleType inType);
 
INT32 awe_audioExportSamples(const AWEInstance *pAWE,  void *outSamples, INT32 outStride, INT32 channel, SampleType outType);
 
INT32 awe_audioIsStarted(const AWEInstance *pAWE);
 
INT32 awe_audioIsStartedMulti(const AWEInstance* pAWE);
 
INT32 awe_audioGetPumpMask(AWEInstance *pAWE);
 
INT32 awe_audioIsReadyToPumpMulti(AWEInstance* pAWE, UINT32 instanceID);
 
UINT32 awe_audioStartPreemption(AWEInstance* pAWE, INT32 coreAffinity);
 
UINT32 awe_audioEndPreemption(AWEInstance* pAWE, UINT32 start_time, INT32 coreAffinity);
 
/*------------------------------------------Deferred Functions----------------------------------------------------*/
INT32 awe_deferredSetCall(AWEInstance * pAWE);
 
 
/*------------------------------------------Loader Functions----------------------------------------------------*/
INT32 awe_loadAWBfromArray(AWEInstance *pAWE, const UINT32 *pCommands, UINT32 arraySize, UINT32 *pPos);
 
INT32 awe_loadSubcanvasAWBfromArray(AWEInstance* pAWE, UINT32 SubcanvasModObjectID, const UINT32* pCommands, UINT32 arraySize, UINT32* pPos);
 
INT32 awe_loadAWBfromFile(AWEInstance *pAWE, const char *binaryFile, UINT32 *pPos);
 
INT32 awe_loadSubcanvasAWBfromFile(AWEInstance* pAWE, UINT32 SubcanvasModObjectID, const char* binaryFile, UINT32* pPos);
 
INT32 awe_loadAWBfromFlash(AWEInstance* pAWE, const char* binaryFile, UINT32* pPos);
 
INT32 awe_loadSubcanvasAWBfromFlash(AWEInstance* pAWE, UINT32 SubcanvasModObjectID, const char* binaryFile, UINT32* pPos);
 
 
/*------------------------------------------Layout Functions----------------------------------------------------*/
void awe_layoutGetChannelCount(const AWEInstance *pAWE, UINT32 pinIdx, UINT32 *inCount, UINT32 *outCount);
 
INT32 awe_layoutGetInputBlockSize(const AWEInstance *pAWE, UINT32 pinIdx, UINT32 *blockSize);
 
INT32 awe_layoutGetInputSampleRate(const AWEInstance *pAWE, UINT32 pinIdx, FLOAT32 *sampleRate);
 
INT32 awe_layoutIsValid(const AWEInstance *pAWE);
 
 
/*------------------------------------------Control Interface Functions----------------------------------------------------*/
 
INT32 awe_ctrlSetValue(AWEInstance *pAWE, UINT32 handle, const void *value, INT32 arrayOffset, UINT32 length);
 
INT32 awe_ctrlGetValue(AWEInstance *pAWE, UINT32 handle, void *value, INT32 arrayOffset, UINT32 length);
 
INT32 awe_ctrlSetStatus(AWEInstance *pAWE, UINT32 handle, UINT32 status);
 
INT32 awe_ctrlGetStatus(AWEInstance *pAWE, UINT32 handle, UINT32 *status);
 
INT32 awe_ctrlSetValueMask(AWEInstance *pAWE, UINT32 handle, const void *value, INT32 arrayOffset, UINT32 length, UINT32 mask);
 
INT32 awe_ctrlGetValueMask(AWEInstance *pAWE, UINT32 handle, void *value, INT32 arrayOffset, UINT32 length, UINT32 mask);
 
INT32 awe_ctrlGetModuleClass(AWEInstance *pAWE, UINT32 handle, UINT32 *pClassID);
 
INT32 awe_setProfilingStatus(AWEInstance *pAWE, UINT32 status);
 
INT32 awe_setProfilingOptions(AWEInstance* pAWE, UINT32 optionsMask, UINT32 profilingOptions);
 
INT32 awe_getProfilingOptions(AWEInstance* pAWE, UINT32 *profilingOptions);
 
INT32 awe_getAverageLayoutCycles(AWEInstance *pAWE, UINT32 layoutIdx, UINT32 * averageCycles);
 
void awe_setInstancesInfo(AWEInstance **pInstances, INT32 numAweInstancesOnCore);
 
INT32 awe_fwSetLayoutCoreAffinity(AWEInstance* pAWE, INT32 layoutNumber, INT32 coreAffinity);
 
INT32 awe_fwGetLayoutCoreAffinity(AWEInstance* pAWE, INT32 layoutNumber);
 
INT32 awe_getBuildVersionInfo(AWEBuildVersionInfo_t *pBuildVersionInfo);
 
INT32 awe_setInstanceStandaloneAWBLoad(AWEInstance* pAWE, INT32 status);
 
INT32 awe_registerLoggingCallback(AWEInstance* pAWE, cbAweLogging_t cbAweLogging, INT32 logLevel, UINT32 logTypeMask);
 
INT32 awe_registerEventCallbacks(AWEInstance* pAWE, cbAweEventTrigger_t cbAweEventTrigger, cbAweEventRegister_t cbAweEventRegister, cbAweEventDeregister_t cbAweEventDeregister);
 
INT32 awe_resetState(AWEInstance* pAWE);
    
#ifdef  __cplusplus
}
#endif
 
#endif  // _AWECOREINSTANCE_H