Maestro Audio Framework v 1.7
NXP Semiconductors
|
Data Structures | |
struct | LVM_MemoryRegion_st |
struct | LVM_MemoryTable_st |
struct | LVM_ContextTable_st |
struct | LVM_BPMModuleStats_st |
Macros | |
#define | LVM_NULL (void *)0 |
NULL pointer. | |
#define | LVM_TRUE 1 |
Boolean True. | |
#define | LVM_FALSE 0 |
Boolean False. | |
#define | LVM_MAXINT_8 127 |
Maximum positive integer size. | |
#define | LVM_MAXINT_16 32767 |
Maximum signed int 16 bits number. | |
#define | LVM_MAXUINT_16 65535U |
Maximum un-signed int 16 bits number. | |
#define | LVM_MAXINT_32 2147483647 |
Maximum signed int 32 bits number. | |
#define | LVM_MAXUINT_32 4294967295U |
Maximum un-signed int 32 bits number. | |
#define | LVM_MININT_32 0x80000000U |
Minimum signed int 32 bit number in 2's complement form. | |
#define | LVM_MAXENUM 2147483647 |
Maximum value for enumerator. | |
#define | LVM_MODULEID_MASK 0xFF00 |
Mask to extract the calling module ID from callbackId. | |
#define | LVM_EVENTID_MASK 0x00FF |
Mask to extract the callback event from callbackId. | |
#define | LVM_MEMREGION_PERSISTENT_SLOW_DATA 0 |
Offset to the instance memory region. | |
#define | LVM_MEMREGION_PERSISTENT_FAST_DATA 1 |
Offset to the persistent data memory region. | |
#define | LVM_MEMREGION_PERSISTENT_FAST_COEF 2 |
Offset to the persistent coefficient memory region. | |
#define | LVM_MEMREGION_TEMPORARY_FAST 3 |
Offset to temporary memory region. | |
#define | LVM_NR_MEMORY_REGIONS 4 |
Number of memory regions. | |
#define | LVM_MODE_LVWIREFORMAT_LENGTH (4) |
Number of bytes to encode LVM_Mode_en in LVWireFormat. | |
#define | LVM_CONFIG_LVWIREFORMAT_LENGTH (4) |
Number of bytes to encode LVM_Config_en in LVWireFormat. | |
#define | LVM_FS_LVWIREFORMAT_LENGTH (4) |
Number of bytes to encode LVM_Fs_en sample Rate in LVWireFormat. | |
#define | LVM_CHANNELTYPE_LVWIREFORMAT_LENGTH (4) |
Number of bytes to encode LVM_ChannelType_en in LVWireFormat. | |
#define | LVM_CHAR_LVWIREFORMAT_LENGTH (1) |
Number of bytes to encode ASCII character in LVWireFormat. | |
#define | LVM_INT8_LVWIREFORMAT_LENGTH (1) |
Number of bytes to encode Signed 8-bit word in LVWireFormat. | |
#define | LVM_UINT8_LVWIREFORMAT_LENGTH (1) |
Number of bytes to encode Unsigned 8-bit word in LVWireFormat. | |
#define | LVM_INT16_LVWIREFORMAT_LENGTH (2) |
Number of bytes to encode Signed 16-bit word in LVWireFormat. | |
#define | LVM_UINT16_LVWIREFORMAT_LENGTH (2) |
Number of bytes to encode Unsigned 16-bit word in LVWireFormat. | |
#define | LVM_INT32_LVWIREFORMAT_LENGTH (4) |
Number of bytes to encode Signed 32-bit word in LVWireFormat. | |
#define | LVM_UINT32_LVWIREFORMAT_LENGTH (4) |
Number of bytes to encode Unsigned 32-bit word in LVWireFormat. | |
#define | LVM_PRINTF_FORMAT_SPECIFIER_INT32 "li" |
#define | LVM_PRINTF_FORMAT_SPECIFIER_UINT32 "lu" |
Typedefs | |
typedef char | LVM_CHAR |
ASCII character. | |
typedef char | LVM_INT8 |
Signed 8-bit word. | |
typedef unsigned char | LVM_UINT8 |
Unsigned 8-bit word. | |
typedef short | LVM_INT16 |
Signed 16-bit word. | |
typedef unsigned short | LVM_UINT16 |
Unsigned 16-bit word. | |
typedef long | LVM_INT32 |
Signed 32-bit word. | |
typedef unsigned long | LVM_UINT32 |
Unsigned 32-bit word. | |
typedef float | LVM_FLOAT |
Single Precision floating point type. | |
typedef double | LVM_DOUBLE |
Double Precision floating point type. | |
typedef LVM_INT32(* | LVM_Callback) (void *pCallbackData, void *pGeneralPurpose, LVM_INT16 GeneralPurpose) |
General purpose callback function. | |
Header file defining the standard LifeVibes types for use in the application layer interface of all LifeVibes modules
typedef LVM_INT32(* LVM_Callback) (void *pCallbackData, void *pGeneralPurpose, LVM_INT16 GeneralPurpose) |
pCallbackData | Pointer to the callback data structure |
pGeneralPurpose | General purpose pointer (e.g. to a data structure needed in the callback) |
PresetLength | General purpose variable (e.g. to be used as callback ID) |
enum LVM_Mode_en |
The LVM_Mode_en enumerated type is used to set the operating mode of a particular feature inside the LifeVibes modules. The feature can be separately set to enable the feature processing (i.e., ON) or to disable all feature processing modules (i.e., OFF).
Enumerator | |
---|---|
LVM_MODE_OFF | LVM module disabled. |
LVM_MODE_ON | LVM module enabled. |
LVM_MODE_MUTE | LVM module muted. |
enum LVM_Format_en |
enum LVM_SpeakerType_en |
enum LVM_WordLength_en |
enum LVM_Fs_en |
The LVM product supports the sample rates specified in LVM_Fs_en. The input and output sample rates are always the same.
enum LVM_Fs_HDAudio_en |
The LVM product supports the sample rates specified in LVM_Fs_HDAudio_en. The input and output sample rates are always the same.
enum LVM_PcmFormat_en |
The LVM_PcmFormat_en enumerated type identifies the different PCM formats that can be configured
Enumerator | |
---|---|
LVM_PCMFORMAT_16_BIT | PCM signed Q0.15. |
LVM_PCMFORMAT_32_BIT | PCM signed Q0.31. |
LVM_PCMFORMAT_8_24_BIT | PCM signed Q7.24. |
LVM_PCMFORMAT_COUNT | Max PCM Format count. |
enum LVM_ResetType_en |
The enumerated type is used to select the reset mode for the module. LVM_RESET_SOFT is used to select a soft reset (or partial reset) and LVM_RESET_HARD is used to select a hard reset (full re-initialization).
Enumerator | |||||||
---|---|---|---|---|---|---|---|
LVM_RESET_SOFT | Reset type for LVM where a partial reset of the module should be performed.
| ||||||
LVM_RESET_HARD | Reset type for LVM where a full reset of the module should be performed. |
enum LVM_MemoryTypes_en |
The LVM_MemoryTypes_en enumerated type identifies the memory region types so that they can be correctly placed in memory by the calling application. The module initially has no permanent memory storage and makes no use of persistent memory allocation internally. The calling application must allocate memory for the module to use.
Four memory regions are required:
This collection of memory regions forms the module instance.
Typically the memory is allocated by the application dynamically; however, it can be allocated statically if required. The sizes of the memory regions can be found by running the GetMemoryTable functions on a simulator and noting the returned values. Alternatively contact NXP who can provide the figures. It is possible that these memory sizes will change between release versions of the library and hence the dynamic memory allocation method is preferred where possible. On some target platforms the placement of memory regions is critical for achieving optimal performance of the module.
enum LVM_Config_en |
Sets mod of Configuration
enum LVM_ChannelType_en |
enum LVM_Tunability_en |