AWECore.h

Go to the documentation of this file.

/*******************************************************************************
*
*               Audio Framework
*               ---------------
*
********************************************************************************
*     AWECore.h
********************************************************************************
*
*     Description:  AudioWeaver Framework main header file
*
*     Copyright:    (c) 2019 DSP Concepts, Inc. All rights reserved.
*                   3235 Kifer Road
*                   Santa Clara, CA 95054
*
*******************************************************************************/

#ifndef _FRAMEWORK_H
//Do nothing if Framework.h was previously included.

#ifndef _AWECORE_H
#define _AWECORE_H

#include <stdlib.h>
#include <string.h>
#include <stddef.h>

#include "TargetProcessor.h" //Include the TargetProcessor header that includes another processor specific header file. 

#ifdef  __cplusplus
extern "C" {
#endif

#define WORDSOF(x) (sizeof(x) / sizeof(INT32)) 

#ifndef NUMOF
#define NUMOF(x) (sizeof(x) / sizeof(*x)) 
#endif

#define AWE_UNUSED_VARIABLE(x) ((void)(x))

typedef struct IOPinDescriptor
{
    UINT32 _Reserved[82];
    
} IOPinDescriptor;

typedef struct AWEFlashFSInstance
{
    UINT32 flashSizeInBytes;

    UINT32 flashErasableBlockSizeInBytes;

    UINT32 flashStartOffsetInBytes;

    UINT32 flashEraseTimeInMs;

    BOOL (*cbInit)(void);

    BOOL (*cbEraseSector)(UINT32 nStartingAddress, UINT32 nNumberOfSectors);

    BOOL (*cbFlashWrite)(UINT32 nFlashAddress, UINT32 * pBuffer, UINT32 nDWordsToWrite);

    BOOL (*cbFlashRead)(UINT32 nFlashAddress, UINT32 * pBuffer, UINT32 nDWordsToRead);

    UINT32 _Reserved[62];

} AWEFlashFSInstance;

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);


    /*------------------IO PINS------------------*/
    
    IOPinDescriptor *pInputPin;

    IOPinDescriptor *pOutputPin;
    
    /*------------------MODULES------------------*/

    UINT32 numModules;

    const void *pModuleDescriptorTable;
    
    /*------------------PACKET BUFFERS------------------*/

    UINT32 *pPacketBuffer;

    UINT32 *pReplyBuffer;

    UINT32 packetBufferSize;
    
    UINT32 userVersion;
    
    float coreSpeed;

    float profileSpeed;

/*The name of the AWE Instance that will be displayed in Server. Can be any string of XYZ length?*/
#ifdef __ADSP21000__ 

    const UINT32 *pName;
#else

    const char *pName;
#endif

    UINT32 numThreads;
    
    float sampleRate;

    UINT32 fundamentalBlockSize;

    AWEFlashFSInstance *pFlashFileSystem;

    UINT32 _Reserved[48];

} AWEInstance;


typedef enum _SampleType
{
    Sample16bit,

    Sample24bit_low,

    Sample24bit_high,

    Sample32bit
} SampleType;


/*------------------------------------------Initialization----------------------------------------------------*/
INT32 awe_init(AWEInstance *pAWE);


INT32 awe_initPin(IOPinDescriptor *pPin, UINT32 channels, const char *name);

void awe_initFlashFS(AWEInstance * pAWE, AWEFlashFSInstance * pAWEFlashFSInstance);


/*------------------------------------------Packet----------------------------------------------------*/
INT32 awe_packetProcess(AWEInstance * pAWE);


/*------------------------------------------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_audioGetPumpMask(const AWEInstance *pAWE);


/*------------------------------------------Deferred Functions----------------------------------------------------*/
INT32 awe_deferredSetCall(AWEInstance * pAWE);


/*------------------------------------------Loader Functions----------------------------------------------------*/
INT32 awe_loadAWBfromArray(AWEInstance *pAWE, const UINT32 *pCommands, UINT32 arraySize, 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_ctrlGetValue(const AWEInstance *pAWE, UINT32 handle, const void *value, INT32 arrayOffset, UINT32 length);

INT32 awe_ctrlSetValue(const AWEInstance *pAWE, UINT32 handle, void *value, INT32 arrayOffset, UINT32 length);

INT32 awe_ctrlSetStatus(const AWEInstance *pAWE, UINT32 handle, UINT32 status);

INT32 awe_ctrlGetStatus(const AWEInstance *pAWE, UINT32 handle, UINT32 *status);

INT32 awe_ctrlSetValueMask(const AWEInstance *pAWE, UINT32 handle, const void *value, INT32 arrayOffset, UINT32 length, UINT32 mask);

INT32 awe_ctrlGetValueMask(const AWEInstance *pAWE, UINT32 handle, void *value, INT32 arrayOffset, UINT32 length, UINT32 mask);

INT32 awe_ctrlGetModuleClass(const AWEInstance *pAWE, UINT32 handle, UINT32 *pClassID);



#ifdef  __cplusplus
}
#endif

#endif  // _AWECORE_H

#endif // _FRAMEWORK_H