AudioScience HPI Version_4.24.1
|
Modules | |
Adapter and Module types/product ids | |
Enumerations | |
enum | HPI_ADAPTER_PROPERTIES { , HPI_ADAPTER_PROPERTY_GROUPING = 2, HPI_ADAPTER_PROPERTY_ENABLE_SSX2 = 3, HPI_ADAPTER_PROPERTY_SSX2_SETTING = 4, HPI_ADAPTER_PROPERTY_IRQ_RATE = 5, HPI_ADAPTER_PROPERTY_READONLYBASE = 256, HPI_ADAPTER_PROPERTY_LATENCY = 256, HPI_ADAPTER_PROPERTY_GRANULARITY = 257, HPI_ADAPTER_PROPERTY_CURCHANNELS = 258, HPI_ADAPTER_PROPERTY_SOFTWARE_VERSION = 259, HPI_ADAPTER_PROPERTY_MAC_ADDRESS_MSB = 260, HPI_ADAPTER_PROPERTY_MAC_ADDRESS_LSB = 261, HPI_ADAPTER_PROPERTY_EXTENDED_ADAPTER_TYPE = 262, HPI_ADAPTER_PROPERTY_LOGTABLEN = 263 , HPI_ADAPTER_PROPERTY_IP_ADDRESS = 265, HPI_ADAPTER_PROPERTY_BUFFER_UPDATE_COUNT = 266, HPI_ADAPTER_PROPERTY_INTERVAL = 267, HPI_ADAPTER_PROPERTY_CAPS1 = 268, HPI_ADAPTER_PROPERTY_CAPS2 = 269, HPI_ADAPTER_PROPERTY_SYNC_HEADER_CONNECTIONS = 270, HPI_ADAPTER_PROPERTY_SUPPORTS_SSX2 = 271, HPI_ADAPTER_PROPERTY_SUPPORTS_IRQ = 272, HPI_ADAPTER_PROPERTY_SUPPORTS_FW_UPDATE = 273, HPI_ADAPTER_PROPERTY_FIRMWARE_ID = 274, HPI_ADAPTER_PROPERTY_OUTSTREAM_FORMATS_SUPPORTED = 275, HPI_ADAPTER_PROPERTY_INSTREAM_FORMATS_SUPPORTED = 276, HPI_ADAPTER_PROPERTY_STREAM_HOST_BUFFER_REQUIRED = 277 } |
Adapter properties These are used in HPI_AdapterSetProperty() and HPI_AdapterGetProperty() More... | |
enum | HPI_ADAPTER_MODE_CMDS { HPI_ADAPTER_MODE_SET = 0, HPI_ADAPTER_MODE_QUERY = 1 } |
Adapter mode commands. More... | |
enum | HPI_ADAPTER_MODES { HPI_ADAPTER_MODE_4OSTREAM = 1, HPI_ADAPTER_MODE_6OSTREAM = 2, HPI_ADAPTER_MODE_8OSTREAM = 3, HPI_ADAPTER_MODE_16OSTREAM = 4, HPI_ADAPTER_MODE_1OSTREAM = 5, HPI_ADAPTER_MODE_1 = 6, HPI_ADAPTER_MODE_2 = 7, HPI_ADAPTER_MODE_3 = 8, HPI_ADAPTER_MODE_MULTICHANNEL = 9, HPI_ADAPTER_MODE_12OSTREAM = 10, HPI_ADAPTER_MODE_9OSTREAM = 11, HPI_ADAPTER_MODE_MONO = 12, HPI_ADAPTER_MODE_LOW_LATENCY = 13, HPI_ADAPTER_MODE_24OSTREAM = 14, HPI_ADAPTER_MODE_32OSTREAM = 15 } |
Adapter Modes These are used by HPI_AdapterSetModeEx() More... | |
Functions | |
hpi_err_t | HPI_AdapterOpen (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex) |
Opens an adapter for use. | |
hpi_err_t | HPI_AdapterClose (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex) |
Closes the adapter associated with the wAdapterIndex. | |
hpi_err_t | HPI_AdapterSetMode (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint32_t dwAdapterMode) |
Sets the operating mode of an adapter. | |
hpi_err_t | HPI_AdapterSetModeEx (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint32_t dwAdapterMode, uint16_t wQueryOrSet) |
Adapter set mode extended. | |
hpi_err_t | HPI_AdapterGetMode (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint32_t *pdwAdapterMode) |
Read the current adapter mode setting. | |
hpi_err_t | HPI_AdapterGetInfo (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t *pwNumOutStreams, uint16_t *pwNumInStreams, uint16_t *pwVersion, uint32_t *pdwSerialNumber, uint16_t *pwAdapterType) |
Obtains information about the specified adapter, including the number of output streams and number of input streams, version, serial number and it's type. | |
hpi_err_t | HPI_AdapterGetModuleByIndex (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wModuleIndex, uint16_t *pwNumOutputs, uint16_t *pwNumInputs, uint16_t *pwVersion, uint32_t *pdwSerialNumber, uint16_t *pwModuleType, hpi_handle_t *phModule) |
Obtains information about the specified module on an adapter, including the number of outputs and number of inputs, version, serial number and type. | |
hpi_err_t | HPI_AdapterGetAssert2 (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t *pAssertCount, char *pszAssert, uint32_t *pParam1, uint32_t *pParam2, uint32_t *pDspStringAddr, uint16_t *pProcessorId) |
hpi_err_t | HPI_AdapterTestAssert (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wAssertId) |
This function tests that asserts are working correctly on the selected adapter. | |
hpi_err_t | HPI_AdapterSetProperty (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wProperty, uint16_t wParameter1, uint16_t wParameter2) |
Set an adapter property to a value. | |
hpi_err_t | HPI_AdapterGetProperty (const hpi_hsubsys_t *phSubSys, uint16_t wAdapterIndex, uint16_t wProperty, uint16_t *pwParameter1, uint16_t *pwParameter2) |
Gets the value of an adapter property. |
Adapter properties These are used in HPI_AdapterSetProperty() and HPI_AdapterGetProperty()
Adapter mode commands.
Used in wQueryOrSet parameter of HPI_AdapterSetModeEx().
enum HPI_ADAPTER_MODES |
Adapter Modes These are used by HPI_AdapterSetModeEx()
hpi_err_t HPI_AdapterOpen | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex | ||
) |
Opens an adapter for use.
The adapter is specified by wAdapterIndex which corresponds to the adapter index on the adapter hardware (typically set using jumpers or switch).
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Index of the adapter to be opened. For PCI adapters this ranges from 0-15. Network adapter indicies start at 1000. |
hpi_err_t HPI_AdapterClose | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex | ||
) |
Closes the adapter associated with the wAdapterIndex.
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Index of the adapter to be opened. For PCI adapters this ranges from 0-15. Network adapter indicies start at 1000. |
hpi_err_t HPI_AdapterSetMode | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint32_t | dwAdapterMode | ||
) |
Sets the operating mode of an adapter.
The adapter must be restarted for the mode to take effect. Under Windows this means that the computer must be rebooted.
HPI_ERROR_BAD_ADAPTER_MODE | if an unsupported mode is set |
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Index of adapter to set mode on. |
dwAdapterMode | One of the HPI_ADAPTER_MODES |
References HPI_ADAPTER_MODE_SET, and HPI_AdapterSetModeEx().
hpi_err_t HPI_AdapterSetModeEx | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint32_t | dwAdapterMode, | ||
uint16_t | wQueryOrSet | ||
) |
Adapter set mode extended.
This updated version of HPI_AdapterSetMode() allows querying supported modes.
When wQueryOrSet=HPI_ADAPTER_MODE_QUERY doesn't set the mode, but the return value reflects whether the mode is valid for the adapter.
When wQueryOrSet=HPI_ADAPTER_MODE_SET, the mode of the adapter is changed if valid.
The adapter must be restarted for the mode to take affect. Under Windows this means that the computer must be rebooted.
0 | the adapter supports the given mode - no error |
HPI_ERROR_BAD_ADAPTER_MODE | if an unsupported mode is set or queried |
HPI_ERROR_XXX | code if an error occurs. |
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Index of adapter to set mode on. |
dwAdapterMode | One of the HPI_ADAPTER_MODES |
wQueryOrSet | set or query the mode |
Referenced by HPI_AdapterSetMode().
hpi_err_t HPI_AdapterGetMode | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint32_t * | pdwAdapterMode | ||
) |
Read the current adapter mode setting.
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Index of adapter to get mode from. |
pdwAdapterMode | The returned adapter mode. Will be one of - HPI_ADAPTER_MODES. |
hpi_err_t HPI_AdapterGetInfo | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint16_t * | pwNumOutStreams, | ||
uint16_t * | pwNumInStreams, | ||
uint16_t * | pwVersion, | ||
uint32_t * | pdwSerialNumber, | ||
uint16_t * | pwAdapterType | ||
) |
Obtains information about the specified adapter, including the number of output streams and number of input streams, version, serial number and it's type.
The adapter is assumed to have one mixer.
phSubSys | Vestigial subsys handle (unused), may be set to NULL | |||||||||||||||
wAdapterIndex | Index of adapter to read adapter information from. | |||||||||||||||
pwNumOutStreams | Number of output streams (play) on the adapter. | |||||||||||||||
pwNumInStreams | Number of input streams (record) on the adapter. | |||||||||||||||
pwVersion | Adapter hardware and DSP software version information. The 16bit word contains the following information:
| |||||||||||||||
pdwSerialNumber | Adapter serial number. Starts at 1 and goes up. | |||||||||||||||
pwAdapterType | Adapter ID code, defined in HPI.H. Examples are HPI_ADAPTER_ASI6114 (0x6114). |
hpi_err_t HPI_AdapterGetModuleByIndex | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint16_t | wModuleIndex, | ||
uint16_t * | pwNumOutputs, | ||
uint16_t * | pwNumInputs, | ||
uint16_t * | pwVersion, | ||
uint32_t * | pdwSerialNumber, | ||
uint16_t * | pwModuleType, | ||
hpi_handle_t * | phModule | ||
) |
Obtains information about the specified module on an adapter, including the number of outputs and number of inputs, version, serial number and type.
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Index of adapter to read from. |
wModuleIndex | Index of module to return information for. Iterate from 0 until an error is returned to get info about all modules |
pwNumOutputs | Number of outputs on the module. |
pwNumInputs | Number of inputs on the module. |
pwVersion | Module hardware and DSP software version information. See HPI_AdapterGetInfo() |
pdwSerialNumber | Adapter serial number. Starts at 1 and goes up. |
pwModuleType | Module ID code, defined in HPI.H If a module position is empty, this parameter==0. If a module position contains an unidentified module this parameter==0xFFFF. |
phModule | A handle to the module. This parameter is reserved for future use. |
hpi_err_t HPI_AdapterGetAssert2 | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint16_t * | pAssertCount, | ||
char * | pszAssert, | ||
uint32_t * | pParam1, | ||
uint32_t * | pParam2, | ||
uint32_t * | pDspStringAddr, | ||
uint16_t * | pProcessorId | ||
) |
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Adapter index |
pAssertCount | Number of queued asserts including current one |
pszAssert | Pointer to 16 byte message buffer |
pParam1 | First assert parameter value |
pParam2 | Second assert parameter value |
pDspStringAddr | DSP address of full assert string |
pProcessorId | Id of processor on which assert happened |
hpi_err_t HPI_AdapterTestAssert | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint16_t | wAssertId | ||
) |
This function tests that asserts are working correctly on the selected adapter.
The message processing code on the target adapter generates an assert when this function is called and that assert can then be read back using the HPI_AdapterGetAssert() function.
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Index of adapter to generate the assert. |
wAssertId | An assert id number that is returned as the line number in HPI_AdapterGetAssert(). |
hpi_err_t HPI_AdapterSetProperty | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint16_t | wProperty, | ||
uint16_t | wParameter1, | ||
uint16_t | wParameter2 | ||
) |
Set an adapter property to a value.
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Adapter index. |
wProperty | Which of the HPI_ADAPTER_PROPERTIES to set |
wParameter1 | Adapter property parameter 1. |
wParameter2 | Adapter property parameter 2. |
hpi_err_t HPI_AdapterGetProperty | ( | const hpi_hsubsys_t * | phSubSys, |
uint16_t | wAdapterIndex, | ||
uint16_t | wProperty, | ||
uint16_t * | pwParameter1, | ||
uint16_t * | pwParameter2 | ||
) |
Gets the value of an adapter property.
phSubSys | Vestigial subsys handle (unused), may be set to NULL |
wAdapterIndex | Adapter index. |
wProperty | One of HPI_ADAPTER_PROPERTIES to get. |
pwParameter1 | Returned adapter property parameter 1. |
pwParameter2 | Returned adapter property parameter 2. |