Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Enumerations | Functions
hpi.h File Reference
#include <linux/types.h>

Go to the source code of this file.

Data Structures

struct  hpi_format
 
struct  hpi_anc_frame
 
struct  hpi_async_event
 

Macros

#define HPI_BUILD_KERNEL_MODE
 
#define HPI_CAPABILITY_NONE   (0)
 
#define HPI_CAPABILITY_MPEG_LAYER3   (1)
 
#define HPI_CAPABILITY_MAX   1
 
#define HPI_MIXER_GET_CONTROL_MULTIPLE_CHANGED   (0)
 
#define HPI_MIXER_GET_CONTROL_MULTIPLE_RESET   (1)
 
#define HPI_UNITS_PER_dB   100
 
#define HPI_GAIN_OFF   (-100 * HPI_UNITS_PER_dB)
 
#define HPI_BITMASK_ALL_CHANNELS   (0xFFFFFFFF)
 
#define HPI_METER_MINIMUM   (-150 * HPI_UNITS_PER_dB)
 
#define HPI_PAD_CHANNEL_NAME_LEN   16
 
#define HPI_PAD_ARTIST_LEN   64
 
#define HPI_PAD_TITLE_LEN   64
 
#define HPI_PAD_COMMENT_LEN   256
 
#define HPI_PAD_PROGRAM_TYPE_INVALID   0xffff
 
#define HPI_MAX_ADAPTERS   20
 
#define HPI_MAX_STREAMS   16
 
#define HPI_MAX_CHANNELS   2 /* per stream */
 
#define HPI_MAX_NODES   8 /* per mixer ? */
 
#define HPI_MAX_CONTROLS   4 /* per node ? */
 
#define HPI_MAX_ANC_BYTES_PER_FRAME   (64)
 
#define HPI_STRING_LEN   16
 
#define HPI_MIN_NETWORK_ADAPTER_IDX   100
 
#define HPI_OSTREAM_VELOCITY_UNITS   4096
 
#define HPI_OSTREAM_TIMESCALE_UNITS   10000
 
#define HPI_OSTREAM_TIMESCALE_PASSTHROUGH   99999
 
#define hpi_volume_get_range   hpi_volume_query_range
 

Enumerations

enum  HPI_FORMATS {
  HPI_FORMAT_MIXER_NATIVE = 0, HPI_FORMAT_PCM8_UNSIGNED = 1, HPI_FORMAT_PCM16_SIGNED = 2, HPI_FORMAT_MPEG_L1 = 3,
  HPI_FORMAT_MPEG_L2 = 4, HPI_FORMAT_MPEG_L3 = 5, HPI_FORMAT_DOLBY_AC2 = 6, HPI_FORMAT_DOLBY_AC3 = 7,
  HPI_FORMAT_PCM16_BIGENDIAN = 8, HPI_FORMAT_AA_TAGIT1_HITS = 9, HPI_FORMAT_AA_TAGIT1_INSERTS = 10, HPI_FORMAT_PCM32_SIGNED = 11,
  HPI_FORMAT_RAW_BITSTREAM = 12, HPI_FORMAT_AA_TAGIT1_HITS_EX1 = 13, HPI_FORMAT_PCM32_FLOAT = 14, HPI_FORMAT_PCM24_SIGNED = 15,
  HPI_FORMAT_OEM1 = 16, HPI_FORMAT_OEM2 = 17, HPI_FORMAT_UNDEFINED = 0xffff
}
 
enum  HPI_STREAM_STATES {
  HPI_STATE_STOPPED = 1, HPI_STATE_PLAYING = 2, HPI_STATE_RECORDING = 3, HPI_STATE_DRAINED = 4,
  HPI_STATE_SINEGEN = 5, HPI_STATE_WAIT = 6
}
 
enum  HPI_SOURCENODES {
  HPI_SOURCENODE_NONE = 100, HPI_SOURCENODE_OSTREAM = 101, HPI_SOURCENODE_LINEIN = 102, HPI_SOURCENODE_AESEBU_IN = 103,
  HPI_SOURCENODE_TUNER = 104, HPI_SOURCENODE_RF = 105, HPI_SOURCENODE_CLOCK_SOURCE = 106, HPI_SOURCENODE_RAW_BITSTREAM = 107,
  HPI_SOURCENODE_MICROPHONE = 108, HPI_SOURCENODE_COBRANET = 109, HPI_SOURCENODE_ANALOG = 110, HPI_SOURCENODE_ADAPTER = 111,
  HPI_SOURCENODE_RTP_DESTINATION = 112, HPI_SOURCENODE_INTERNAL = 113, HPI_SOURCENODE_LAST_INDEX = 113
}
 
enum  HPI_DESTNODES {
  HPI_DESTNODE_NONE = 200, HPI_DESTNODE_ISTREAM = 201, HPI_DESTNODE_LINEOUT = 202, HPI_DESTNODE_AESEBU_OUT = 203,
  HPI_DESTNODE_RF = 204, HPI_DESTNODE_SPEAKER = 205, HPI_DESTNODE_COBRANET = 206, HPI_DESTNODE_ANALOG = 207,
  HPI_DESTNODE_RTP_SOURCE = 208, HPI_DESTNODE_LAST_INDEX = 208
}
 
enum  HPI_CONTROLS {
  HPI_CONTROL_GENERIC = 0, HPI_CONTROL_CONNECTION = 1, HPI_CONTROL_VOLUME = 2, HPI_CONTROL_METER = 3,
  HPI_CONTROL_MUTE = 4, HPI_CONTROL_MULTIPLEXER = 5, HPI_CONTROL_AESEBU_TRANSMITTER = 6, HPI_CONTROL_AESEBUTX = 6,
  HPI_CONTROL_AESEBU_RECEIVER = 7, HPI_CONTROL_AESEBURX = 7, HPI_CONTROL_LEVEL = 8, HPI_CONTROL_TUNER = 9,
  HPI_CONTROL_VOX = 11, HPI_CONTROL_CHANNEL_MODE = 15, HPI_CONTROL_BITSTREAM = 16, HPI_CONTROL_SAMPLECLOCK = 17,
  HPI_CONTROL_MICROPHONE = 18, HPI_CONTROL_PARAMETRIC_EQ = 19, HPI_CONTROL_EQUALIZER = 19, HPI_CONTROL_COMPANDER = 20,
  HPI_CONTROL_COBRANET = 21, HPI_CONTROL_TONEDETECTOR = 22, HPI_CONTROL_SILENCEDETECTOR = 23, HPI_CONTROL_PAD = 24,
  HPI_CONTROL_SRC = 25, HPI_CONTROL_UNIVERSAL = 26, HPI_CONTROL_LAST_INDEX = 26
}
 
enum  HPI_ADAPTER_PROPERTIES {
  HPI_ADAPTER_PROPERTY_ERRATA_1 = 1, 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_LOGTABBEG = 264, 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
}
 
enum  HPI_ADAPTER_MODE_CMDS { HPI_ADAPTER_MODE_SET = 0, HPI_ADAPTER_MODE_QUERY = 1 }
 
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
}
 
enum  HPI_MPEG_ANC_MODES { HPI_MPEG_ANC_HASENERGY = 0, HPI_MPEG_ANC_RAW = 1 }
 
enum  HPI_ISTREAM_MPEG_ANC_ALIGNS { HPI_MPEG_ANC_ALIGN_LEFT = 0, HPI_MPEG_ANC_ALIGN_RIGHT = 1 }
 
enum  HPI_MPEG_MODES { HPI_MPEG_MODE_DEFAULT = 0, HPI_MPEG_MODE_STEREO = 1, HPI_MPEG_MODE_JOINTSTEREO = 2, HPI_MPEG_MODE_DUALCHANNEL = 3 }
 
enum  HPI_MIXER_STORE_COMMAND {
  HPI_MIXER_STORE_SAVE = 1, HPI_MIXER_STORE_RESTORE = 2, HPI_MIXER_STORE_DELETE = 3, HPI_MIXER_STORE_ENABLE = 4,
  HPI_MIXER_STORE_DISABLE = 5, HPI_MIXER_STORE_SAVE_SINGLE = 6
}
 
enum  HPI_SWITCH_STATES { HPI_SWITCH_OFF = 0, HPI_SWITCH_ON = 1 }
 
enum  HPI_VOLUME_AUTOFADES { HPI_VOLUME_AUTOFADE_LOG = 2, HPI_VOLUME_AUTOFADE_LINEAR = 3 }
 
enum  HPI_AESEBU_FORMATS { HPI_AESEBU_FORMAT_AESEBU = 1, HPI_AESEBU_FORMAT_SPDIF = 2 }
 
enum  HPI_AESEBU_ERRORS {
  HPI_AESEBU_ERROR_NOT_LOCKED = 0x01, HPI_AESEBU_ERROR_POOR_QUALITY = 0x02, HPI_AESEBU_ERROR_PARITY_ERROR = 0x04, HPI_AESEBU_ERROR_BIPHASE_VIOLATION = 0x08,
  HPI_AESEBU_ERROR_VALIDITY = 0x10, HPI_AESEBU_ERROR_CRC = 0x20
}
 
enum  eHPI_RDS_type { HPI_RDS_DATATYPE_RDS = 0, HPI_RDS_DATATYPE_RBDS = 1 }
 
enum  HPI_TUNER_BAND {
  HPI_TUNER_BAND_AM = 1, HPI_TUNER_BAND_FM = 2, HPI_TUNER_BAND_TV_NTSC_M = 3, HPI_TUNER_BAND_TV = 3,
  HPI_TUNER_BAND_FM_STEREO = 4, HPI_TUNER_BAND_AUX = 5, HPI_TUNER_BAND_TV_PAL_BG = 6, HPI_TUNER_BAND_TV_PAL_I = 7,
  HPI_TUNER_BAND_TV_PAL_DK = 8, HPI_TUNER_BAND_TV_SECAM_L = 9, HPI_TUNER_BAND_LAST = 9
}
 
enum  HPI_TUNER_MODES { HPI_TUNER_MODE_RSS = 1, HPI_TUNER_MODE_RDS = 2 }
 
enum  HPI_TUNER_MODE_VALUES {
  HPI_TUNER_MODE_RSS_DISABLE = 0, HPI_TUNER_MODE_RSS_ENABLE = 1, HPI_TUNER_MODE_RDS_DISABLE = 0, HPI_TUNER_MODE_RDS_RDS = 1,
  HPI_TUNER_MODE_RDS_RBDS = 2
}
 
enum  HPI_TUNER_STATUS_BITS {
  HPI_TUNER_VIDEO_COLOR_PRESENT = 0x0001, HPI_TUNER_VIDEO_IS_60HZ = 0x0020, HPI_TUNER_VIDEO_HORZ_SYNC_MISSING = 0x0040, HPI_TUNER_VIDEO_STATUS_VALID = 0x0100,
  HPI_TUNER_DIGITAL = 0x0200, HPI_TUNER_MULTIPROGRAM = 0x0400, HPI_TUNER_PLL_LOCKED = 0x1000, HPI_TUNER_FM_STEREO = 0x2000
}
 
enum  HPI_CHANNEL_MODES {
  HPI_CHANNEL_MODE_NORMAL = 1, HPI_CHANNEL_MODE_SWAP = 2, HPI_CHANNEL_MODE_LEFT_TO_STEREO = 3, HPI_CHANNEL_MODE_RIGHT_TO_STEREO = 4,
  HPI_CHANNEL_MODE_STEREO_TO_LEFT = 5, HPI_CHANNEL_MODE_STEREO_TO_RIGHT = 6, HPI_CHANNEL_MODE_LAST = 6
}
 
enum  HPI_SAMPLECLOCK_SOURCES {
  HPI_SAMPLECLOCK_SOURCE_LOCAL = 1, HPI_SAMPLECLOCK_SOURCE_AESEBU_SYNC = 2, HPI_SAMPLECLOCK_SOURCE_WORD = 3, HPI_SAMPLECLOCK_SOURCE_WORD_HEADER = 4,
  HPI_SAMPLECLOCK_SOURCE_SMPTE = 5, HPI_SAMPLECLOCK_SOURCE_AESEBU_INPUT = 6, HPI_SAMPLECLOCK_SOURCE_NETWORK = 8, HPI_SAMPLECLOCK_SOURCE_PREV_MODULE = 10,
  HPI_SAMPLECLOCK_SOURCE_LAST = 10
}
 
enum  HPI_FILTER_TYPE {
  HPI_FILTER_TYPE_BYPASS = 0, HPI_FILTER_TYPE_LOWSHELF = 1, HPI_FILTER_TYPE_HIGHSHELF = 2, HPI_FILTER_TYPE_EQ_BAND = 3,
  HPI_FILTER_TYPE_LOWPASS = 4, HPI_FILTER_TYPE_HIGHPASS = 5, HPI_FILTER_TYPE_BANDPASS = 6, HPI_FILTER_TYPE_BANDSTOP = 7
}
 
enum  ASYNC_EVENT_SOURCES { HPI_ASYNC_EVENT_GPIO = 1, HPI_ASYNC_EVENT_SILENCE = 2, HPI_ASYNC_EVENT_TONE = 3 }
 
enum  HPI_ERROR_CODES {
  HPI_ERROR_INVALID_TYPE = 100, HPI_ERROR_INVALID_OBJ = 101, HPI_ERROR_INVALID_FUNC = 102, HPI_ERROR_INVALID_OBJ_INDEX = 103,
  HPI_ERROR_OBJ_NOT_OPEN = 104, HPI_ERROR_OBJ_ALREADY_OPEN = 105, HPI_ERROR_INVALID_RESOURCE = 106, HPI_ERROR_INVALID_RESPONSE = 108,
  HPI_ERROR_PROCESSING_MESSAGE = 109, HPI_ERROR_NETWORK_TIMEOUT = 110, HPI_ERROR_INVALID_HANDLE = 111, HPI_ERROR_UNIMPLEMENTED = 112,
  HPI_ERROR_NETWORK_TOO_MANY_CLIENTS = 113, HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL = 114, HPI_ERROR_RESPONSE_MISMATCH = 115, HPI_ERROR_CONTROL_CACHING = 116,
  HPI_ERROR_MESSAGE_BUFFER_TOO_SMALL = 117, HPI_ERROR_BAD_ADAPTER = 201, HPI_ERROR_BAD_ADAPTER_NUMBER = 202, HPI_ERROR_DUPLICATE_ADAPTER_NUMBER = 203,
  HPI_ERROR_DSP_BOOTLOAD = 204, HPI_ERROR_DSP_FILE_NOT_FOUND = 206, HPI_ERROR_DSP_HARDWARE = 207, HPI_ERROR_MEMORY_ALLOC = 208,
  HPI_ERROR_PLD_LOAD = 209, HPI_ERROR_DSP_FILE_FORMAT = 210, HPI_ERROR_DSP_FILE_ACCESS_DENIED = 211, HPI_ERROR_DSP_FILE_NO_HEADER = 212,
  HPI_ERROR_DSP_SECTION_NOT_FOUND = 214, HPI_ERROR_DSP_FILE_OTHER_ERROR = 215, HPI_ERROR_DSP_FILE_SHARING_VIOLATION = 216, HPI_ERROR_DSP_FILE_NULL_HEADER = 217,
  HPI_ERROR_BAD_CHECKSUM = 221, HPI_ERROR_BAD_SEQUENCE = 222, HPI_ERROR_FLASH_ERASE = 223, HPI_ERROR_FLASH_PROGRAM = 224,
  HPI_ERROR_FLASH_VERIFY = 225, HPI_ERROR_FLASH_TYPE = 226, HPI_ERROR_FLASH_START = 227, HPI_ERROR_FLASH_READ = 228,
  HPI_ERROR_FLASH_READ_NO_FILE = 229, HPI_ERROR_FLASH_SIZE = 230, HPI_ERROR_RESERVED_1 = 290, HPI_ERROR_INVALID_FORMAT = 301,
  HPI_ERROR_INVALID_SAMPLERATE = 302, HPI_ERROR_INVALID_CHANNELS = 303, HPI_ERROR_INVALID_BITRATE = 304, HPI_ERROR_INVALID_DATASIZE = 305,
  HPI_ERROR_INVALID_DATA_POINTER = 308, HPI_ERROR_INVALID_PACKET_ORDER = 309, HPI_ERROR_INVALID_OPERATION = 310, HPI_ERROR_INCOMPATIBLE_SAMPLERATE = 311,
  HPI_ERROR_BAD_ADAPTER_MODE = 312, HPI_ERROR_TOO_MANY_CAPABILITY_CHANGE_ATTEMPTS = 313, HPI_ERROR_NO_INTERADAPTER_GROUPS = 314, HPI_ERROR_NO_INTERDSP_GROUPS = 315,
  HPI_ERROR_WAIT_CANCELLED = 316, HPI_ERROR_INVALID_STRING = 317, HPI_ERROR_INVALID_NODE = 400, HPI_ERROR_INVALID_CONTROL = 401,
  HPI_ERROR_INVALID_CONTROL_VALUE = 402, HPI_ERROR_INVALID_CONTROL_ATTRIBUTE = 403, HPI_ERROR_CONTROL_DISABLED = 404, HPI_ERROR_CONTROL_I2C_MISSING_ACK = 405,
  HPI_ERROR_I2C_MISSING_ACK = 405, HPI_ERROR_CONTROL_NOT_READY = 407, HPI_ERROR_NVMEM_BUSY = 450, HPI_ERROR_NVMEM_FULL = 451,
  HPI_ERROR_NVMEM_FAIL = 452, HPI_ERROR_I2C_BAD_ADR = 460, HPI_ERROR_ENTITY_TYPE_MISMATCH = 470, HPI_ERROR_ENTITY_ITEM_COUNT = 471,
  HPI_ERROR_ENTITY_TYPE_INVALID = 472, HPI_ERROR_ENTITY_ROLE_INVALID = 473, HPI_ERROR_ENTITY_SIZE_MISMATCH = 474, HPI_ERROR_CUSTOM = 600,
  HPI_ERROR_MUTEX_TIMEOUT = 700, HPI_ERROR_BACKEND_BASE = 900, HPI_ERROR_DSP_COMMUNICATION = 900
}
 

Functions

u16 hpi_stream_estimate_buffer_size (struct hpi_format *pF, u32 host_polling_rate_in_milli_seconds, u32 *recommended_buffer_size)
 
u16 hpi_subsys_get_version_ex (u32 *pversion_ex)
 
u16 hpi_subsys_get_num_adapters (int *pn_num_adapters)
 
u16 hpi_subsys_get_adapter (int iterator, u32 *padapter_index, u16 *pw_adapter_type)
 
u16 hpi_adapter_open (u16 adapter_index)
 
u16 hpi_adapter_close (u16 adapter_index)
 
u16 hpi_adapter_get_info (u16 adapter_index, u16 *pw_num_outstreams, u16 *pw_num_instreams, u16 *pw_version, u32 *pserial_number, u16 *pw_adapter_type)
 
u16 hpi_adapter_get_module_by_index (u16 adapter_index, u16 module_index, u16 *pw_num_outputs, u16 *pw_num_inputs, u16 *pw_version, u32 *pserial_number, u16 *pw_module_type, u32 *ph_module)
 
u16 hpi_adapter_set_mode (u16 adapter_index, u32 adapter_mode)
 
u16 hpi_adapter_set_mode_ex (u16 adapter_index, u32 adapter_mode, u16 query_or_set)
 
u16 hpi_adapter_get_mode (u16 adapter_index, u32 *padapter_mode)
 
u16 hpi_adapter_get_assert2 (u16 adapter_index, u16 *p_assert_count, char *psz_assert, u32 *p_param1, u32 *p_param2, u32 *p_dsp_string_addr, u16 *p_processor_id)
 
u16 hpi_adapter_test_assert (u16 adapter_index, u16 assert_id)
 
u16 hpi_adapter_enable_capability (u16 adapter_index, u16 capability, u32 key)
 
u16 hpi_adapter_self_test (u16 adapter_index)
 
u16 hpi_adapter_debug_read (u16 adapter_index, u32 dsp_address, char *p_bytes, int *count_bytes)
 
u16 hpi_adapter_set_property (u16 adapter_index, u16 property, u16 paramter1, u16 paramter2)
 
u16 hpi_adapter_get_property (u16 adapter_index, u16 property, u16 *pw_paramter1, u16 *pw_paramter2)
 
u16 hpi_adapter_enumerate_property (u16 adapter_index, u16 index, u16 what_to_enumerate, u16 property_index, u32 *psetting)
 
u16 hpi_outstream_open (u16 adapter_index, u16 outstream_index, u32 *ph_outstream)
 
u16 hpi_outstream_close (u32 h_outstream)
 
u16 hpi_outstream_get_info_ex (u32 h_outstream, u16 *pw_state, u32 *pbuffer_size, u32 *pdata_to_play, u32 *psamples_played, u32 *pauxiliary_data_to_play)
 
u16 hpi_outstream_write_buf (u32 h_outstream, const u8 *pb_write_buf, u32 bytes_to_write, const struct hpi_format *p_format)
 
u16 hpi_outstream_start (u32 h_outstream)
 
u16 hpi_outstream_wait_start (u32 h_outstream)
 
u16 hpi_outstream_stop (u32 h_outstream)
 
u16 hpi_outstream_sinegen (u32 h_outstream)
 
u16 hpi_outstream_reset (u32 h_outstream)
 
u16 hpi_outstream_query_format (u32 h_outstream, struct hpi_format *p_format)
 
u16 hpi_outstream_set_format (u32 h_outstream, struct hpi_format *p_format)
 
u16 hpi_outstream_set_punch_in_out (u32 h_outstream, u32 punch_in_sample, u32 punch_out_sample)
 
u16 hpi_outstream_set_velocity (u32 h_outstream, short velocity)
 
u16 hpi_outstream_ancillary_reset (u32 h_outstream, u16 mode)
 
u16 hpi_outstream_ancillary_get_info (u32 h_outstream, u32 *pframes_available)
 
u16 hpi_outstream_ancillary_read (u32 h_outstream, struct hpi_anc_frame *p_anc_frame_buffer, u32 anc_frame_buffer_size_in_bytes, u32 number_of_ancillary_frames_to_read)
 
u16 hpi_outstream_set_time_scale (u32 h_outstream, u32 time_scaleX10000)
 
u16 hpi_outstream_host_buffer_allocate (u32 h_outstream, u32 size_in_bytes)
 
u16 hpi_outstream_host_buffer_free (u32 h_outstream)
 
u16 hpi_outstream_group_add (u32 h_outstream, u32 h_stream)
 
u16 hpi_outstream_group_get_map (u32 h_outstream, u32 *poutstream_map, u32 *pinstream_map)
 
u16 hpi_outstream_group_reset (u32 h_outstream)
 
u16 hpi_instream_open (u16 adapter_index, u16 instream_index, u32 *ph_instream)
 
u16 hpi_instream_close (u32 h_instream)
 
u16 hpi_instream_query_format (u32 h_instream, const struct hpi_format *p_format)
 
u16 hpi_instream_set_format (u32 h_instream, const struct hpi_format *p_format)
 
u16 hpi_instream_read_buf (u32 h_instream, u8 *pb_read_buf, u32 bytes_to_read)
 
u16 hpi_instream_start (u32 h_instream)
 
u16 hpi_instream_wait_start (u32 h_instream)
 
u16 hpi_instream_stop (u32 h_instream)
 
u16 hpi_instream_reset (u32 h_instream)
 
u16 hpi_instream_get_info_ex (u32 h_instream, u16 *pw_state, u32 *pbuffer_size, u32 *pdata_recorded, u32 *psamples_recorded, u32 *pauxiliary_data_recorded)
 
u16 hpi_instream_ancillary_reset (u32 h_instream, u16 bytes_per_frame, u16 mode, u16 alignment, u16 idle_bit)
 
u16 hpi_instream_ancillary_get_info (u32 h_instream, u32 *pframe_space)
 
u16 hpi_instream_ancillary_write (u32 h_instream, const struct hpi_anc_frame *p_anc_frame_buffer, u32 anc_frame_buffer_size_in_bytes, u32 number_of_ancillary_frames_to_write)
 
u16 hpi_instream_host_buffer_allocate (u32 h_instream, u32 size_in_bytes)
 
u16 hpi_instream_host_buffer_free (u32 h_instream)
 
u16 hpi_instream_group_add (u32 h_instream, u32 h_stream)
 
u16 hpi_instream_group_get_map (u32 h_instream, u32 *poutstream_map, u32 *pinstream_map)
 
u16 hpi_instream_group_reset (u32 h_instream)
 
u16 hpi_mixer_open (u16 adapter_index, u32 *ph_mixer)
 
u16 hpi_mixer_close (u32 h_mixer)
 
u16 hpi_mixer_get_control (u32 h_mixer, u16 src_node_type, u16 src_node_type_index, u16 dst_node_type, u16 dst_node_type_index, u16 control_type, u32 *ph_control)
 
u16 hpi_mixer_get_control_by_index (u32 h_mixer, u16 control_index, u16 *pw_src_node_type, u16 *pw_src_node_index, u16 *pw_dst_node_type, u16 *pw_dst_node_index, u16 *pw_control_type, u32 *ph_control)
 
u16 hpi_mixer_store (u32 h_mixer, enum HPI_MIXER_STORE_COMMAND command, u16 index)
 
u16 hpi_volume_set_gain (u32 h_control, short an_gain0_01dB[HPI_MAX_CHANNELS])
 
u16 hpi_volume_get_gain (u32 h_control, short an_gain0_01dB_out[HPI_MAX_CHANNELS])
 
u16 hpi_volume_set_mute (u32 h_control, u32 mute)
 
u16 hpi_volume_get_mute (u32 h_control, u32 *mute)
 
u16 hpi_volume_query_range (u32 h_control, short *min_gain_01dB, short *max_gain_01dB, short *step_gain_01dB)
 
u16 hpi_volume_query_channels (const u32 h_control, u32 *p_channels)
 
u16 hpi_volume_auto_fade (u32 h_control, short an_stop_gain0_01dB[HPI_MAX_CHANNELS], u32 duration_ms)
 
u16 hpi_volume_auto_fade_profile (u32 h_control, short an_stop_gain0_01dB[HPI_MAX_CHANNELS], u32 duration_ms, u16 profile)
 
u16 hpi_volume_query_auto_fade_profile (const u32 h_control, const u32 i, u16 *profile)
 
u16 hpi_level_query_range (u32 h_control, short *min_gain_01dB, short *max_gain_01dB, short *step_gain_01dB)
 
u16 hpi_level_set_gain (u32 h_control, short an_gain0_01dB[HPI_MAX_CHANNELS])
 
u16 hpi_level_get_gain (u32 h_control, short an_gain0_01dB_out[HPI_MAX_CHANNELS])
 
u16 hpi_meter_query_channels (const u32 h_meter, u32 *p_channels)
 
u16 hpi_meter_get_peak (u32 h_control, short an_peak0_01dB_out[HPI_MAX_CHANNELS])
 
u16 hpi_meter_get_rms (u32 h_control, short an_peak0_01dB_out[HPI_MAX_CHANNELS])
 
u16 hpi_meter_set_peak_ballistics (u32 h_control, u16 attack, u16 decay)
 
u16 hpi_meter_set_rms_ballistics (u32 h_control, u16 attack, u16 decay)
 
u16 hpi_meter_get_peak_ballistics (u32 h_control, u16 *attack, u16 *decay)
 
u16 hpi_meter_get_rms_ballistics (u32 h_control, u16 *attack, u16 *decay)
 
u16 hpi_channel_mode_query_mode (const u32 h_mode, const u32 index, u16 *pw_mode)
 
u16 hpi_channel_mode_set (u32 h_control, u16 mode)
 
u16 hpi_channel_mode_get (u32 h_control, u16 *mode)
 
u16 hpi_tuner_query_band (const u32 h_tuner, const u32 index, u16 *pw_band)
 
u16 hpi_tuner_set_band (u32 h_control, u16 band)
 
u16 hpi_tuner_get_band (u32 h_control, u16 *pw_band)
 
u16 hpi_tuner_query_frequency (const u32 h_tuner, const u32 index, const u16 band, u32 *pfreq)
 
u16 hpi_tuner_set_frequency (u32 h_control, u32 freq_ink_hz)
 
u16 hpi_tuner_get_frequency (u32 h_control, u32 *pw_freq_ink_hz)
 
u16 hpi_tuner_get_rf_level (u32 h_control, short *pw_level)
 
u16 hpi_tuner_get_raw_rf_level (u32 h_control, short *pw_level)
 
u16 hpi_tuner_query_gain (const u32 h_tuner, const u32 index, u16 *pw_gain)
 
u16 hpi_tuner_set_gain (u32 h_control, short gain)
 
u16 hpi_tuner_get_gain (u32 h_control, short *pn_gain)
 
u16 hpi_tuner_get_status (u32 h_control, u16 *pw_status_mask, u16 *pw_status)
 
u16 hpi_tuner_set_mode (u32 h_control, u32 mode, u32 value)
 
u16 hpi_tuner_get_mode (u32 h_control, u32 mode, u32 *pn_value)
 
u16 hpi_tuner_get_rds (u32 h_control, char *p_rds_data)
 
u16 hpi_tuner_query_deemphasis (const u32 h_tuner, const u32 index, const u16 band, u32 *pdeemphasis)
 
u16 hpi_tuner_set_deemphasis (u32 h_control, u32 deemphasis)
 
u16 hpi_tuner_get_deemphasis (u32 h_control, u32 *pdeemphasis)
 
u16 hpi_tuner_query_program (const u32 h_tuner, u32 *pbitmap_program)
 
u16 hpi_tuner_set_program (u32 h_control, u32 program)
 
u16 hpi_tuner_get_program (u32 h_control, u32 *pprogram)
 
u16 hpi_tuner_get_hd_radio_dsp_version (u32 h_control, char *psz_dsp_version, const u32 string_size)
 
u16 hpi_tuner_get_hd_radio_sdk_version (u32 h_control, char *psz_sdk_version, const u32 string_size)
 
u16 hpi_tuner_get_hd_radio_signal_quality (u32 h_control, u32 *pquality)
 
u16 hpi_tuner_get_hd_radio_signal_blend (u32 h_control, u32 *pblend)
 
u16 hpi_tuner_set_hd_radio_signal_blend (u32 h_control, const u32 blend)
 
u16 hpi_pad_get_channel_name (u32 h_control, char *psz_string, const u32 string_length)
 
u16 hpi_pad_get_artist (u32 h_control, char *psz_string, const u32 string_length)
 
u16 hpi_pad_get_title (u32 h_control, char *psz_string, const u32 string_length)
 
u16 hpi_pad_get_comment (u32 h_control, char *psz_string, const u32 string_length)
 
u16 hpi_pad_get_program_type (u32 h_control, u32 *ppTY)
 
u16 hpi_pad_get_rdsPI (u32 h_control, u32 *ppI)
 
u16 hpi_pad_get_program_type_string (u32 h_control, const u32 data_type, const u32 pTY, char *psz_string, const u32 string_length)
 
u16 hpi_aesebu_receiver_query_format (const u32 h_aes_rx, const u32 index, u16 *pw_format)
 
u16 hpi_aesebu_receiver_set_format (u32 h_control, u16 source)
 
u16 hpi_aesebu_receiver_get_format (u32 h_control, u16 *pw_source)
 
u16 hpi_aesebu_receiver_get_sample_rate (u32 h_control, u32 *psample_rate)
 
u16 hpi_aesebu_receiver_get_user_data (u32 h_control, u16 index, u16 *pw_data)
 
u16 hpi_aesebu_receiver_get_channel_status (u32 h_control, u16 index, u16 *pw_data)
 
u16 hpi_aesebu_receiver_get_error_status (u32 h_control, u16 *pw_error_data)
 
u16 hpi_aesebu_transmitter_set_sample_rate (u32 h_control, u32 sample_rate)
 
u16 hpi_aesebu_transmitter_set_user_data (u32 h_control, u16 index, u16 data)
 
u16 hpi_aesebu_transmitter_set_channel_status (u32 h_control, u16 index, u16 data)
 
u16 hpi_aesebu_transmitter_get_channel_status (u32 h_control, u16 index, u16 *pw_data)
 
u16 hpi_aesebu_transmitter_query_format (const u32 h_aes_tx, const u32 index, u16 *pw_format)
 
u16 hpi_aesebu_transmitter_set_format (u32 h_control, u16 output_format)
 
u16 hpi_aesebu_transmitter_get_format (u32 h_control, u16 *pw_output_format)
 
u16 hpi_multiplexer_set_source (u32 h_control, u16 source_node_type, u16 source_node_index)
 
u16 hpi_multiplexer_get_source (u32 h_control, u16 *source_node_type, u16 *source_node_index)
 
u16 hpi_multiplexer_query_source (u32 h_control, u16 index, u16 *source_node_type, u16 *source_node_index)
 
u16 hpi_vox_set_threshold (u32 h_control, short an_gain0_01dB)
 
u16 hpi_vox_get_threshold (u32 h_control, short *an_gain0_01dB)
 
u16 hpi_bitstream_set_clock_edge (u32 h_control, u16 edge_type)
 
u16 hpi_bitstream_set_data_polarity (u32 h_control, u16 polarity)
 
u16 hpi_bitstream_get_activity (u32 h_control, u16 *pw_clk_activity, u16 *pw_data_activity)
 
u16 hpi_sample_clock_query_source (const u32 h_clock, const u32 index, u16 *pw_source)
 
u16 hpi_sample_clock_set_source (u32 h_control, u16 source)
 
u16 hpi_sample_clock_get_source (u32 h_control, u16 *pw_source)
 
u16 hpi_sample_clock_query_source_index (const u32 h_clock, const u32 index, const u32 source, u16 *pw_source_index)
 
u16 hpi_sample_clock_set_source_index (u32 h_control, u16 source_index)
 
u16 hpi_sample_clock_get_source_index (u32 h_control, u16 *pw_source_index)
 
u16 hpi_sample_clock_get_sample_rate (u32 h_control, u32 *psample_rate)
 
u16 hpi_sample_clock_query_local_rate (const u32 h_clock, const u32 index, u32 *psource)
 
u16 hpi_sample_clock_set_local_rate (u32 h_control, u32 sample_rate)
 
u16 hpi_sample_clock_get_local_rate (u32 h_control, u32 *psample_rate)
 
u16 hpi_sample_clock_set_auto (u32 h_control, u32 enable)
 
u16 hpi_sample_clock_get_auto (u32 h_control, u32 *penable)
 
u16 hpi_sample_clock_set_local_rate_lock (u32 h_control, u32 lock)
 
u16 hpi_sample_clock_get_local_rate_lock (u32 h_control, u32 *plock)
 
u16 hpi_microphone_set_phantom_power (u32 h_control, u16 on_off)
 
u16 hpi_microphone_get_phantom_power (u32 h_control, u16 *pw_on_off)
 
u16 hpi_parametric_eq_get_info (u32 h_control, u16 *pw_number_of_bands, u16 *pw_enabled)
 
u16 hpi_parametric_eq_set_state (u32 h_control, u16 on_off)
 
u16 hpi_parametric_eq_set_band (u32 h_control, u16 index, u16 type, u32 frequency_hz, short q100, short gain0_01dB)
 
u16 hpi_parametric_eq_get_band (u32 h_control, u16 index, u16 *pn_type, u32 *pfrequency_hz, short *pnQ100, short *pn_gain0_01dB)
 
u16 hpi_parametric_eq_get_coeffs (u32 h_control, u16 index, short coeffs[5])
 
u16 hpi_compander_set_enable (u32 h_control, u32 on)
 
u16 hpi_compander_get_enable (u32 h_control, u32 *pon)
 
u16 hpi_compander_set_makeup_gain (u32 h_control, short makeup_gain0_01dB)
 
u16 hpi_compander_get_makeup_gain (u32 h_control, short *pn_makeup_gain0_01dB)
 
u16 hpi_compander_set_attack_time_constant (u32 h_control, u32 index, u32 attack)
 
u16 hpi_compander_get_attack_time_constant (u32 h_control, u32 index, u32 *pw_attack)
 
u16 hpi_compander_set_decay_time_constant (u32 h_control, u32 index, u32 decay)
 
u16 hpi_compander_get_decay_time_constant (u32 h_control, u32 index, u32 *pw_decay)
 
u16 hpi_compander_set_threshold (u32 h_control, u32 index, short threshold0_01dB)
 
u16 hpi_compander_get_threshold (u32 h_control, u32 index, short *pn_threshold0_01dB)
 
u16 hpi_compander_set_ratio (u32 h_control, u32 index, u32 ratio100)
 
u16 hpi_compander_get_ratio (u32 h_control, u32 index, u32 *pw_ratio100)
 
u16 hpi_cobranet_hmi_write (u32 h_control, u32 hmi_address, u32 byte_count, u8 *pb_data)
 
u16 hpi_cobranet_hmi_read (u32 h_control, u32 hmi_address, u32 max_byte_count, u32 *pbyte_count, u8 *pb_data)
 
u16 hpi_cobranet_hmi_get_status (u32 h_control, u32 *pstatus, u32 *preadable_size, u32 *pwriteable_size)
 
u16 hpi_cobranet_get_ip_address (u32 h_control, u32 *pdw_ip_address)
 
u16 hpi_cobranet_set_ip_address (u32 h_control, u32 dw_ip_address)
 
u16 hpi_cobranet_get_static_ip_address (u32 h_control, u32 *pdw_ip_address)
 
u16 hpi_cobranet_set_static_ip_address (u32 h_control, u32 dw_ip_address)
 
u16 hpi_cobranet_get_macaddress (u32 h_control, u32 *p_mac_msbs, u32 *p_mac_lsbs)
 
u16 hpi_tone_detector_get_state (u32 hC, u32 *state)
 
u16 hpi_tone_detector_set_enable (u32 hC, u32 enable)
 
u16 hpi_tone_detector_get_enable (u32 hC, u32 *enable)
 
u16 hpi_tone_detector_set_event_enable (u32 hC, u32 event_enable)
 
u16 hpi_tone_detector_get_event_enable (u32 hC, u32 *event_enable)
 
u16 hpi_tone_detector_set_threshold (u32 hC, int threshold)
 
u16 hpi_tone_detector_get_threshold (u32 hC, int *threshold)
 
u16 hpi_tone_detector_get_frequency (u32 hC, u32 index, u32 *frequency)
 
u16 hpi_silence_detector_get_state (u32 hC, u32 *state)
 
u16 hpi_silence_detector_set_enable (u32 hC, u32 enable)
 
u16 hpi_silence_detector_get_enable (u32 hC, u32 *enable)
 
u16 hpi_silence_detector_set_event_enable (u32 hC, u32 event_enable)
 
u16 hpi_silence_detector_get_event_enable (u32 hC, u32 *event_enable)
 
u16 hpi_silence_detector_set_delay (u32 hC, u32 delay)
 
u16 hpi_silence_detector_get_delay (u32 hC, u32 *delay)
 
u16 hpi_silence_detector_set_threshold (u32 hC, int threshold)
 
u16 hpi_silence_detector_get_threshold (u32 hC, int *threshold)
 
u16 hpi_format_create (struct hpi_format *p_format, u16 channels, u16 format, u32 sample_rate, u32 bit_rate, u32 attributes)
 

Detailed Description

AudioScience Hardware Programming Interface (HPI) public API definition.

The HPI is a low-level hardware abstraction layer to all AudioScience digital audio adapters

(C) Copyright AudioScience Inc. 1998-2010

Definition in file hpi.h.

Macro Definition Documentation

#define HPI_BITMASK_ALL_CHANNELS   (0xFFFFFFFF)

channel mask specifying all channels

Definition at line 666 of file hpi.h.

#define HPI_BUILD_KERNEL_MODE

Definition at line 35 of file hpi.h.

#define HPI_CAPABILITY_MAX   1

Definition at line 561 of file hpi.h.

#define HPI_CAPABILITY_MPEG_LAYER3   (1)

Definition at line 557 of file hpi.h.

#define HPI_CAPABILITY_NONE   (0)

Definition at line 556 of file hpi.h.

#define HPI_GAIN_OFF   (-100 * HPI_UNITS_PER_dB)

turns volume control OFF or MUTE

Definition at line 661 of file hpi.h.

#define HPI_METER_MINIMUM   (-150 * HPI_UNITS_PER_dB)

value returned for no signal

Definition at line 671 of file hpi.h.

#define HPI_MIXER_GET_CONTROL_MULTIPLE_CHANGED   (0)

Definition at line 616 of file hpi.h.

#define HPI_MIXER_GET_CONTROL_MULTIPLE_RESET   (1)

Definition at line 617 of file hpi.h.

#define HPI_UNITS_PER_dB   100

volumes units are 100ths of a dB

Definition at line 657 of file hpi.h.

#define hpi_volume_get_range   hpi_volume_query_range

Definition at line 1357 of file hpi.h.

Enumeration Type Documentation

Async Event sources

Enumerator:
HPI_ASYNC_EVENT_GPIO 

GPIO event.

HPI_ASYNC_EVENT_SILENCE 

silence event detected.

HPI_ASYNC_EVENT_TONE 

tone event detected.

Definition at line 868 of file hpi.h.

Data types for PTY string translation.

Enumerator:
HPI_RDS_DATATYPE_RDS 

RDS bitstream.

HPI_RDS_DATATYPE_RBDS 

RBDS bitstream.

Definition at line 734 of file hpi.h.

Adapter mode commands

Used in wQueryOrSet parameter of HPI_AdapterSetModeEx().

Enumerator:
HPI_ADAPTER_MODE_SET 

Set the mode to the given parameter

HPI_ADAPTER_MODE_QUERY 

Return 0 or error depending whether mode is valid, but don't set the mode

Definition at line 454 of file hpi.h.

Adapter Modes

These are used by HPI_AdapterSetModeEx()

Warning
- more than 16 possible modes breaks a bitmask in the Windows WAVE DLL
Enumerator:
HPI_ADAPTER_MODE_4OSTREAM 
4 outstream mode.
  • ASI6114: 1 instream
  • ASI6044: 4 instreams
  • ASI6012: 1 instream
  • ASI6102: no instreams
  • ASI6022, ASI6122: 2 instreams
  • ASI5111, ASI5101: 2 instreams
  • ASI652x, ASI662x: 2 instreams
  • ASI654x, ASI664x: 4 instreams
HPI_ADAPTER_MODE_6OSTREAM 
6 outstream mode.
  • ASI6012: 1 instream,
  • ASI6022, ASI6122: 2 instreams
  • ASI652x, ASI662x: 4 instreams
HPI_ADAPTER_MODE_8OSTREAM 
8 outstream mode.
  • ASI6114: 8 instreams
  • ASI6118: 8 instreams
  • ASI6585: 8 instreams
HPI_ADAPTER_MODE_16OSTREAM 
16 outstream mode.
  • ASI6416 16 instreams
  • ASI6518, ASI6618 16 instreams
  • ASI6118 16 mono out and in streams
HPI_ADAPTER_MODE_1OSTREAM 
one outstream mode.
  • ASI5111 1 outstream, 1 instream
HPI_ADAPTER_MODE_1 

ASI504X mode 1. 12 outstream, 4 instream 0 to 48kHz sample rates (see ASI504X datasheet for more info).

HPI_ADAPTER_MODE_2 

ASI504X mode 2. 4 outstreams, 4 instreams at 0 to 192kHz sample rates (see ASI504X datasheet for more info).

HPI_ADAPTER_MODE_3 

ASI504X mode 3. 4 outstreams, 4 instreams at 0 to 192kHz sample rates (see ASI504X datasheet for more info).

HPI_ADAPTER_MODE_MULTICHANNEL 

ASI504X multichannel mode. 2 outstreams -> 4 line outs = 1 to 8 channel streams), 4 lineins -> 1 instream (1 to 8 channel streams) at 0-48kHz. For more info see the SSX Specification.

HPI_ADAPTER_MODE_12OSTREAM 
12 outstream mode.
  • ASI6514, ASI6614: 2 instreams
  • ASI6540,ASI6544: 8 instreams
  • ASI6640,ASI6644: 8 instreams
HPI_ADAPTER_MODE_9OSTREAM 
9 outstream mode.
  • ASI6044: 8 instreams
HPI_ADAPTER_MODE_MONO 
mono mode.
  • ASI6416: 16 outstreams/instreams
  • ASI5402: 2 outstreams/instreams
HPI_ADAPTER_MODE_LOW_LATENCY 
Low latency mode.
  • ASI6416/ASI6316: 1 16 channel outstream and instream

Definition at line 469 of file hpi.h.

Adapter properties

These are used in HPI_AdapterSetProperty() and HPI_AdapterGetProperty()

Enumerator:
HPI_ADAPTER_PROPERTY_ERRATA_1 
HPI_ADAPTER_PROPERTY_GROUPING 
Adapter grouping property

Indicates whether the adapter supports the grouping API (for ASIO and SSX2)

HPI_ADAPTER_PROPERTY_ENABLE_SSX2 
Driver SSX2 property

Tells the kernel driver to turn on SSX2 stream mapping. This feature is not used by the DSP. In fact the call is completely processed by the driver and is not passed on to the DSP at all.

HPI_ADAPTER_PROPERTY_SSX2_SETTING 
Adapter SSX2 property

Indicates the state of the adapter's SSX2 setting. This setting is stored in non-volatile memory on the adapter. A typical call sequence would be to use HPI_ADAPTER_PROPERTY_SSX2_SETTING to set SSX2 on the adapter and then to reload the driver. The driver would query HPI_ADAPTER_PROPERTY_SSX2_SETTING during startup and if SSX2 is set, it would then call HPI_ADAPTER_PROPERTY_ENABLE_SSX2 to enable SSX2 stream mapping within the kernel level of the driver.

HPI_ADAPTER_PROPERTY_IRQ_RATE 
Enables/disables PCI(e) IRQ.

A setting of 0 indicates that no interrupts are being generated. A DSP boot this property is set to 0. Setting to a non-zero value specifies the number of frames of audio that should be processed between interrupts. This property should be set to multiple of the mixer interval as read back from the HPI_ADAPTER_PROPERTY_INTERVAL property.

HPI_ADAPTER_PROPERTY_READONLYBASE 

Base number for readonly properties

HPI_ADAPTER_PROPERTY_LATENCY 
Readonly adapter latency property.

This property returns in the input and output latency in samples. Property 1 is the estimated input latency in samples, while Property 2 is that output latency in samples.

HPI_ADAPTER_PROPERTY_GRANULARITY 
Readonly adapter granularity property.

The granulariy is the smallest size chunk of stereo samples that is processed by the adapter. This property returns the record granularity in samples in Property 1. Property 2 returns the play granularity.

HPI_ADAPTER_PROPERTY_CURCHANNELS 
Readonly adapter number of current channels property.

Property 1 is the number of record channels per record device. Property 2 is the number of play channels per playback device.

HPI_ADAPTER_PROPERTY_SOFTWARE_VERSION 
Readonly adapter software version.

The SOFTWARE_VERSION property returns the version of the software running on the adapter as Major.Minor.Release. Property 1 contains Major in bits 15..8 and Minor in bits 7..0. Property 2 contains Release in bits 7..0.

HPI_ADAPTER_PROPERTY_MAC_ADDRESS_MSB 
Readonly adapter MAC address MSBs.

The MAC_ADDRESS_MSB property returns the most significant 32 bits of the MAC address. Property 1 contains bits 47..32 of the MAC address. Property 2 contains bits 31..16 of the MAC address.

HPI_ADAPTER_PROPERTY_MAC_ADDRESS_LSB 
Readonly adapter MAC address LSBs

The MAC_ADDRESS_LSB property returns the least significant 16 bits of the MAC address. Property 1 contains bits 15..0 of the MAC address.

HPI_ADAPTER_PROPERTY_EXTENDED_ADAPTER_TYPE 
Readonly extended adapter type number

The EXTENDED_ADAPTER_TYPE property returns the 4 digits of an extended adapter type, i.e ASI8920-0022, 0022 is the extended type. The digits are returned as ASCII characters rather than the hex digits that are returned for the main type Property 1 returns the 1st two (left most) digits, i.e "00" in the example above, the upper byte being the left most digit. Property 2 returns the 2nd two digits, i.e "22" in the example above

HPI_ADAPTER_PROPERTY_LOGTABLEN 

Readonly debug log buffer information

HPI_ADAPTER_PROPERTY_LOGTABBEG 
HPI_ADAPTER_PROPERTY_IP_ADDRESS 
Readonly adapter IP address

For 192.168.1.101 Property 1 returns the 1st two (left most) digits, i.e 192*256 + 168 in the example above, the upper byte being the left most digit. Property 2 returns the 2nd two digits, i.e 1*256 + 101 in the example above,

HPI_ADAPTER_PROPERTY_BUFFER_UPDATE_COUNT 
Readonly adapter buffer processed count. Returns a buffer processed count

that is incremented every time all buffers for all streams are updated. This is useful for checking completion of all stream operations across the adapter when using grouped streams.

HPI_ADAPTER_PROPERTY_INTERVAL 
Readonly mixer and stream intervals

These intervals are measured in mixer frames. To convert to time, divide by the adapter samplerate.

The mixer interval is the number of frames processed in one mixer iteration. The stream update interval is the interval at which streams check for and process data, and BBM host buffer counters are updated.

Property 1 is the mixer interval in mixer frames. Property 2 is the stream update interval in mixer frames.

HPI_ADAPTER_PROPERTY_CAPS1 
Adapter capabilities 1

Property 1 - adapter can do multichannel (SSX1) Property 2 - adapter can do stream grouping (supports SSX2)

HPI_ADAPTER_PROPERTY_CAPS2 
Adapter capabilities 2

Property 1 - adapter can do samplerate conversion (MRX) Property 2 - adapter can do timestretch (TSX)

HPI_ADAPTER_PROPERTY_SYNC_HEADER_CONNECTIONS 

Readonly adapter sync header connection count.

HPI_ADAPTER_PROPERTY_SUPPORTS_SSX2 
Readonly supports SSX2 property.

Indicates the adapter supports SSX2 in some mode setting. The return value is true (1) or false (0). If the current adapter mode is MONO SSX2 is disabled, even though this property will return true.

HPI_ADAPTER_PROPERTY_SUPPORTS_IRQ 
Readonly supports PCI(e) IRQ.

Indicates that the adapter in it's current mode supports interrupts across the host bus. Note, this does not imply that interrupts are enabled. Instead it indicates that they can be enabled.

HPI_ADAPTER_PROPERTY_SUPPORTS_FW_UPDATE 
Readonly supports firmware updating.

Indicates that the adapter implements an interface to update firmware on the adapter.

HPI_ADAPTER_PROPERTY_FIRMWARE_ID 
Readonly Firmware IDs

Identifiy firmware independent of individual adapter type. May be used as a filter for firmware update images. Property 1 = Bootloader ID Property 2 = Main program ID

Definition at line 283 of file hpi.h.

AES/EBU error status bits

Returned by HPI_Aesebu_Receiver_GetErrorStatus()

Enumerator:
HPI_AESEBU_ERROR_NOT_LOCKED 

bit0: 1 when PLL is not locked

HPI_AESEBU_ERROR_POOR_QUALITY 

bit1: 1 when signal quality is poor

HPI_AESEBU_ERROR_PARITY_ERROR 

bit2: 1 when there is a parity error

HPI_AESEBU_ERROR_BIPHASE_VIOLATION 

bit3: 1 when there is a bi-phase coding violation

HPI_AESEBU_ERROR_VALIDITY 

bit4: 1 when the validity bit is high

HPI_AESEBU_ERROR_CRC 

bit5: 1 when the CRC error bit is high

Definition at line 701 of file hpi.h.

The physical encoding format of the AESEBU I/O.

Used in HPI_Aesebu_Transmitter_SetFormat(), HPI_Aesebu_Receiver_SetFormat() along with related Get and Query functions

Enumerator:
HPI_AESEBU_FORMAT_AESEBU 

AES/EBU physical format - AES/EBU balanced "professional"

HPI_AESEBU_FORMAT_SPDIF 

AES/EBU physical format - S/PDIF unbalanced "consumer"

Definition at line 689 of file hpi.h.

Channel Modes

Used for HPI_ChannelModeSet/Get()

Enumerator:
HPI_CHANNEL_MODE_NORMAL 

Left channel out = left channel in, Right channel out = right channel in.

HPI_CHANNEL_MODE_SWAP 

Left channel out = right channel in, Right channel out = left channel in.

HPI_CHANNEL_MODE_LEFT_TO_STEREO 

Left channel out = left channel in, Right channel out = left channel in.

HPI_CHANNEL_MODE_RIGHT_TO_STEREO 

Left channel out = right channel in, Right channel out = right channel in.

HPI_CHANNEL_MODE_STEREO_TO_LEFT 

Left channel out = (left channel in + right channel in)/2, Right channel out = mute.

HPI_CHANNEL_MODE_STEREO_TO_RIGHT 

Left channel out = mute, Right channel out = (right channel in + left channel in)/2.

HPI_CHANNEL_MODE_LAST 

Definition at line 806 of file hpi.h.

Mixer control types

Enumerator:
HPI_CONTROL_GENERIC 

generic control.

HPI_CONTROL_CONNECTION 

A connection between nodes.

HPI_CONTROL_VOLUME 

volume control - works in dB_fs.

HPI_CONTROL_METER 

peak meter control.

HPI_CONTROL_MUTE 
HPI_CONTROL_MULTIPLEXER 

multiplexer control.

HPI_CONTROL_AESEBU_TRANSMITTER 

AES/EBU transmitter control

HPI_CONTROL_AESEBUTX 
HPI_CONTROL_AESEBU_RECEIVER 

AES/EBU receiver control.

HPI_CONTROL_AESEBURX 
HPI_CONTROL_LEVEL 

level/trim control - works in d_bu.

HPI_CONTROL_TUNER 

tuner control.

HPI_CONTROL_VOX 

vox control.

HPI_CONTROL_CHANNEL_MODE 

channel mode control.

HPI_CONTROL_BITSTREAM 

bitstream control.

HPI_CONTROL_SAMPLECLOCK 

sample clock control.

HPI_CONTROL_MICROPHONE 

microphone control.

HPI_CONTROL_PARAMETRIC_EQ 

parametric EQ control.

HPI_CONTROL_EQUALIZER 
HPI_CONTROL_COMPANDER 

compander control.

HPI_CONTROL_COBRANET 

cobranet control.

HPI_CONTROL_TONEDETECTOR 

tone detector control.

HPI_CONTROL_SILENCEDETECTOR 

silence detector control.

HPI_CONTROL_PAD 

tuner PAD control.

HPI_CONTROL_SRC 

samplerate converter control.

HPI_CONTROL_UNIVERSAL 

universal control.

HPI_CONTROL_LAST_INDEX 

highest control type ID

Definition at line 236 of file hpi.h.

Destination node types

Enumerator:
HPI_DESTNODE_NONE 

This define can be used instead of 0 to indicate that there is no valid destination node. A control that exists on a source node can be searched for using a destination node value of either 0, or HPI_DESTNODE_NONE

HPI_DESTNODE_ISTREAM 

In Stream (Record) node.

HPI_DESTNODE_LINEOUT 

line out node.

HPI_DESTNODE_AESEBU_OUT 

AES/EBU output node.

HPI_DESTNODE_RF 

RF output node.

HPI_DESTNODE_SPEAKER 

speaker output node.

HPI_DESTNODE_COBRANET 

Cobranet output node - Audio samples from the device are sent out on the Cobranet network.

HPI_DESTNODE_ANALOG 

analog output node.

HPI_DESTNODE_RTP_SOURCE 

RTP stream output node - This node is a source for packets of RTP audio samples that are sent to other devices.

HPI_DESTNODE_LAST_INDEX 

largest ID

Definition at line 208 of file hpi.h.

HPI Error codes

Almost all HPI functions return an error code A return value of zero means there was no error. Otherwise one of these error codes is returned. Error codes can be converted to a descriptive string using HPI_GetErrorText()

Note
When a new error code is added HPI_GetErrorText() MUST be updated.
Codes 1-100 are reserved for driver use
Enumerator:
HPI_ERROR_INVALID_TYPE 

Message type does not exist.

HPI_ERROR_INVALID_OBJ 

Object type does not exist.

HPI_ERROR_INVALID_FUNC 

Function does not exist.

HPI_ERROR_INVALID_OBJ_INDEX 

The specified object does not exist.

HPI_ERROR_OBJ_NOT_OPEN 

Trying to access an object that has not been opened yet.

HPI_ERROR_OBJ_ALREADY_OPEN 

Trying to open an already open object.

HPI_ERROR_INVALID_RESOURCE 

PCI, ISA resource not valid.

HPI_ERROR_INVALID_RESPONSE 

Default response was never updated with actual error code.

HPI_ERROR_PROCESSING_MESSAGE 

wSize field of response was not updated, indicating that the message was not processed.

HPI_ERROR_NETWORK_TIMEOUT 

The network did not respond in a timely manner.

HPI_ERROR_INVALID_HANDLE 
HPI_ERROR_UNIMPLEMENTED 

A function or attribute has not been implemented yet.

HPI_ERROR_NETWORK_TOO_MANY_CLIENTS 

There are too many clients attempting to access a network resource.

HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL 

Response buffer passed to HPI_Message was smaller than returned response. wSpecificError field of hpi response contains the required size.

HPI_ERROR_RESPONSE_MISMATCH 

The returned response did not match the sent message

HPI_ERROR_CONTROL_CACHING 

A control setting that should have been cached was not.

HPI_ERROR_MESSAGE_BUFFER_TOO_SMALL 

A message buffer in the path to the adapter was smaller than the message size. wSpecificError field of hpi response contains the actual size.

HPI_ERROR_BAD_ADAPTER 

Bad adpater.

HPI_ERROR_BAD_ADAPTER_NUMBER 

Adapter number out of range or not set properly.

HPI_ERROR_DUPLICATE_ADAPTER_NUMBER 

2 adapters with the same adapter number.

HPI_ERROR_DSP_BOOTLOAD 

DSP code failed to bootload. Usually a DSP memory test failure.

HPI_ERROR_DSP_FILE_NOT_FOUND 

Couldn't find or open the DSP code file.

HPI_ERROR_DSP_HARDWARE 

Internal DSP hardware error.

HPI_ERROR_MEMORY_ALLOC 

Could not allocate memory

HPI_ERROR_PLD_LOAD 

Failed to correctly load/config PLD. (unused)

HPI_ERROR_DSP_FILE_FORMAT 

Unexpected end of file, block length too big etc.

HPI_ERROR_DSP_FILE_ACCESS_DENIED 

Found but could not open DSP code file.

HPI_ERROR_DSP_FILE_NO_HEADER 

First DSP code section header not found in DSP file.

HPI_ERROR_DSP_SECTION_NOT_FOUND 

DSP code for adapter family not found.

HPI_ERROR_DSP_FILE_OTHER_ERROR 

Other OS specific error opening DSP file.

HPI_ERROR_DSP_FILE_SHARING_VIOLATION 

Sharing violation opening DSP code file.

HPI_ERROR_DSP_FILE_NULL_HEADER 

DSP code section header had size == 0.

HPI_ERROR_BAD_CHECKSUM 

Flash has bad checksum

HPI_ERROR_BAD_SEQUENCE 
HPI_ERROR_FLASH_ERASE 
HPI_ERROR_FLASH_PROGRAM 
HPI_ERROR_FLASH_VERIFY 
HPI_ERROR_FLASH_TYPE 
HPI_ERROR_FLASH_START 
HPI_ERROR_FLASH_READ 
HPI_ERROR_FLASH_READ_NO_FILE 
HPI_ERROR_FLASH_SIZE 
HPI_ERROR_RESERVED_1 

Reserved for OEMs.

HPI_ERROR_INVALID_FORMAT 

Invalid compression format.

HPI_ERROR_INVALID_SAMPLERATE 

Invalid format samplerate

HPI_ERROR_INVALID_CHANNELS 

Invalid format number of channels.

HPI_ERROR_INVALID_BITRATE 

Invalid format bitrate.

HPI_ERROR_INVALID_DATASIZE 

Invalid datasize used for stream read/write.

HPI_ERROR_INVALID_DATA_POINTER 

Null data pointer used for stream read/write.

HPI_ERROR_INVALID_PACKET_ORDER 

Packet ordering error for stream read/write.

HPI_ERROR_INVALID_OPERATION 

Object can't do requested operation in its current state, eg set format, change rec mux state while recording.

HPI_ERROR_INCOMPATIBLE_SAMPLERATE 

Where a SRG is shared amongst streams, an incompatible samplerate is one that is different to any currently active stream.

HPI_ERROR_BAD_ADAPTER_MODE 

Adapter mode is illegal.

HPI_ERROR_TOO_MANY_CAPABILITY_CHANGE_ATTEMPTS 

There have been too many attempts to set the adapter's capabilities (using bad keys), the card should be returned to ASI if further capabilities updates are required

HPI_ERROR_NO_INTERADAPTER_GROUPS 

Streams on different adapters cannot be grouped.

HPI_ERROR_NO_INTERDSP_GROUPS 

Streams on different DSPs cannot be grouped.

HPI_ERROR_WAIT_CANCELLED 

Stream wait cancelled before threshold reached.

HPI_ERROR_INVALID_STRING 

A character string is invalid.

HPI_ERROR_INVALID_NODE 

Invalid mixer node for this adapter.

HPI_ERROR_INVALID_CONTROL 

Invalid control.

HPI_ERROR_INVALID_CONTROL_VALUE 

Invalid control value was passed.

HPI_ERROR_INVALID_CONTROL_ATTRIBUTE 

Control attribute not supported by this control.

HPI_ERROR_CONTROL_DISABLED 

Control is disabled.

HPI_ERROR_CONTROL_I2C_MISSING_ACK 

I2C transaction failed due to a missing ACK.

HPI_ERROR_I2C_MISSING_ACK 
HPI_ERROR_CONTROL_NOT_READY 

Control is busy, or coming out of reset and cannot be accessed at this time.

HPI_ERROR_NVMEM_BUSY 

Non volatile memory

HPI_ERROR_NVMEM_FULL 
HPI_ERROR_NVMEM_FAIL 
HPI_ERROR_I2C_BAD_ADR 

I2C

HPI_ERROR_ENTITY_TYPE_MISMATCH 

Entity type did not match requested type

HPI_ERROR_ENTITY_ITEM_COUNT 

Entity item count did not match requested count

HPI_ERROR_ENTITY_TYPE_INVALID 

Entity type is not one of the valid types

HPI_ERROR_ENTITY_ROLE_INVALID 

Entity role is not one of the valid roles

HPI_ERROR_ENTITY_SIZE_MISMATCH 

Entity size doesn't match target size

HPI_ERROR_CUSTOM 

custom error to use for debugging

HPI_ERROR_MUTEX_TIMEOUT 

hpioct32.c can't obtain mutex

HPI_ERROR_BACKEND_BASE 

Backend errors used to be greater than this.

Deprecated:
Now, all backends return only errors defined here in hpi.h
HPI_ERROR_DSP_COMMUNICATION 

Communication with DSP failed

Definition at line 885 of file hpi.h.

Equalizer filter types. Used by HPI_ParametricEq_SetBand()

Enumerator:
HPI_FILTER_TYPE_BYPASS 

filter is turned off

HPI_FILTER_TYPE_LOWSHELF 

EQ low shelf

HPI_FILTER_TYPE_HIGHSHELF 

EQ high shelf

HPI_FILTER_TYPE_EQ_BAND 

EQ gain

HPI_FILTER_TYPE_LOWPASS 

standard low pass

HPI_FILTER_TYPE_HIGHPASS 

standard high pass

HPI_FILTER_TYPE_BANDPASS 

standard band pass

HPI_FILTER_TYPE_BANDSTOP 

standard band stop/notch

Definition at line 852 of file hpi.h.

Audio format types

Enumerator:
HPI_FORMAT_MIXER_NATIVE 

Used internally on adapter.

HPI_FORMAT_PCM8_UNSIGNED 

8-bit unsigned PCM. Windows equivalent is WAVE_FORMAT_PCM.

HPI_FORMAT_PCM16_SIGNED 

16-bit signed PCM. Windows equivalent is WAVE_FORMAT_PCM.

HPI_FORMAT_MPEG_L1 

MPEG-1 Layer-1.

HPI_FORMAT_MPEG_L2 
MPEG-1 Layer-2.

Windows equivalent is WAVE_FORMAT_MPEG.

The following table shows what combinations of mode and bitrate are possible:

Bitrate (kbs)

Mono

Stereo,
Joint Stereo or
Dual Channel

32X_
40__
48X_
56X_
64XX
80X_
96XX
112XX
128XX
160XX
192XX
224_X
256-X
320-X
384_X
HPI_FORMAT_MPEG_L3 
MPEG-1 Layer-3.

Windows equivalent is WAVE_FORMAT_MPEG.

The following table shows what combinations of mode and bitrate are possible:

Bitrate (kbs)

Mono
Stereo @ 8,
11.025 and
12kHz*

Mono
Stereo @ 16,
22.050 and
24kHz*

Mono
Stereo @ 32,
44.1 and
48kHz

16XX_
24XX_
32XXX
40XXX
48XXX
56XXX
64XXX
80_XX
96_XX
112_XX
128_XX
144_X_
160_XX
192__X
224__X
256-_X
320-_X

* Available on the ASI6000 series only

HPI_FORMAT_DOLBY_AC2 

Dolby AC-2.

HPI_FORMAT_DOLBY_AC3 

Dolbt AC-3.

HPI_FORMAT_PCM16_BIGENDIAN 

16-bit PCM big-endian.

HPI_FORMAT_AA_TAGIT1_HITS 

TAGIT-1 algorithm - hits.

HPI_FORMAT_AA_TAGIT1_INSERTS 

TAGIT-1 algorithm - inserts.

HPI_FORMAT_PCM32_SIGNED 
32-bit signed PCM. Windows equivalent is WAVE_FORMAT_PCM.

Each sample is a 32bit word. The most significant 24 bits contain a 24-bit sample and the least significant 8 bits are set to 0.

HPI_FORMAT_RAW_BITSTREAM 

Raw bitstream - unknown format.

HPI_FORMAT_AA_TAGIT1_HITS_EX1 

TAGIT-1 algorithm hits - extended.

HPI_FORMAT_PCM32_FLOAT 
32-bit PCM as an IEEE float. Windows equivalent is WAVE_FORMAT_IEEE_FLOAT.

Each sample is a 32bit word in IEEE754 floating point format. The range is +1.0 to -1.0, which corresponds to digital fullscale.

HPI_FORMAT_PCM24_SIGNED 

24-bit PCM signed. Windows equivalent is WAVE_FORMAT_PCM.

HPI_FORMAT_OEM1 

OEM format 1 - private.

HPI_FORMAT_OEM2 

OEM format 2 - private.

HPI_FORMAT_UNDEFINED 

Undefined format.

Definition at line 45 of file hpi.h.

Ancillary Data Alignment

Enumerator:
HPI_MPEG_ANC_ALIGN_LEFT 

data is packed against the end of data, then padded to the end of frame

HPI_MPEG_ANC_ALIGN_RIGHT 

data is packed against the end of the frame

Definition at line 584 of file hpi.h.

Commands used by HPI_MixerStore()

Enumerator:
HPI_MIXER_STORE_SAVE 

Save all mixer control settings.

HPI_MIXER_STORE_RESTORE 

Restore all controls from saved.

HPI_MIXER_STORE_DELETE 

Delete saved control settings.

HPI_MIXER_STORE_ENABLE 

Enable auto storage of some control settings.

HPI_MIXER_STORE_DISABLE 

Disable auto storage of some control settings.

HPI_MIXER_STORE_SAVE_SINGLE 

Unimplemented - save the attributes of a single control.

Definition at line 623 of file hpi.h.

MPEG Ancillary Data modes

The mode for the ancillary data insertion or extraction to operate in.

Enumerator:
HPI_MPEG_ANC_HASENERGY 

the MPEG frames have energy information stored in them (5 bytes per stereo frame, 3 per mono)

HPI_MPEG_ANC_RAW 

the entire ancillary data field is taken up by data from the Anc data buffer On encode, the encoder will insert the energy bytes before filling the remainder of the ancillary data space with data from the ancillary data buffer.

Definition at line 571 of file hpi.h.

MPEG modes

MPEG modes - can be used optionally for HPI_FormatCreate() parameter dwAttributes.

Using any mode setting other than HPI_MPEG_MODE_DEFAULT with single channel format will return an error.

Enumerator:
HPI_MPEG_MODE_DEFAULT 
Causes the MPEG-1 Layer II bitstream to be recorded

in single_channel mode when the number of channels is 1 and in stereo when the number of channels is 2.

HPI_MPEG_MODE_STEREO 

Standard stereo without joint-stereo compression

HPI_MPEG_MODE_JOINTSTEREO 

Joint stereo

HPI_MPEG_MODE_DUALCHANNEL 

Left and Right channels are completely independent

Definition at line 599 of file hpi.h.

SampleClock source values

Enumerator:
HPI_SAMPLECLOCK_SOURCE_LOCAL 

The sampleclock output is derived from its local samplerate generator. The local samplerate may be set using HPI_SampleClock_SetLocalRate().

HPI_SAMPLECLOCK_SOURCE_AESEBU_SYNC 

The adapter is clocked from a dedicated AES/EBU SampleClock input.

HPI_SAMPLECLOCK_SOURCE_WORD 

From external wordclock connector

HPI_SAMPLECLOCK_SOURCE_WORD_HEADER 

Board-to-board header

HPI_SAMPLECLOCK_SOURCE_SMPTE 

FUTURE - SMPTE clock.

HPI_SAMPLECLOCK_SOURCE_AESEBU_INPUT 

One of the aesebu inputs

HPI_SAMPLECLOCK_SOURCE_NETWORK 

From a network interface e.g. Cobranet or Livewire at either 48 or 96kHz

HPI_SAMPLECLOCK_SOURCE_PREV_MODULE 

From previous adjacent module (ASI2416 only)

HPI_SAMPLECLOCK_SOURCE_LAST 

Update this if you add a new clock source.

Definition at line 827 of file hpi.h.

Source node types

Enumerator:
HPI_SOURCENODE_NONE 

This define can be used instead of 0 to indicate that there is no valid source node. A control that exists on a destination node can be searched for using a source node value of either 0, or HPI_SOURCENODE_NONE

HPI_SOURCENODE_OSTREAM 

Out Stream (Play) node.

HPI_SOURCENODE_LINEIN 

Line in node - could be analog, AES/EBU or network.

HPI_SOURCENODE_AESEBU_IN 

AES/EBU input node.

HPI_SOURCENODE_TUNER 

tuner node.

HPI_SOURCENODE_RF 

RF input node.

HPI_SOURCENODE_CLOCK_SOURCE 

clock source node.

HPI_SOURCENODE_RAW_BITSTREAM 

raw bitstream node.

HPI_SOURCENODE_MICROPHONE 

microphone node.

HPI_SOURCENODE_COBRANET 

Cobranet input node - Audio samples come from the Cobranet network and into the device.

HPI_SOURCENODE_ANALOG 

analog input node.

HPI_SOURCENODE_ADAPTER 

adapter node.

HPI_SOURCENODE_RTP_DESTINATION 

RTP stream input node - This node is a destination for packets of RTP audio samples from other devices.

HPI_SOURCENODE_INTERNAL 

node internal to the device.

HPI_SOURCENODE_LAST_INDEX 

largest ID

Definition at line 174 of file hpi.h.

Stream States

Enumerator:
HPI_STATE_STOPPED 

State stopped - stream is stopped.

HPI_STATE_PLAYING 

State playing - stream is playing audio.

HPI_STATE_RECORDING 

State recording - stream is recording.

HPI_STATE_DRAINED 

State drained - playing stream ran out of data to play.

HPI_STATE_SINEGEN 

State generate sine - to be implemented.

HPI_STATE_WAIT 

State wait - used for inter-card sync to mean waiting for all cards to be ready.

Definition at line 155 of file hpi.h.

Used by mixer plugin enable functions

E.g. HPI_ParametricEq_SetState()

Enumerator:
HPI_SWITCH_OFF 

turn the mixer plugin on.

HPI_SWITCH_ON 

turn the mixer plugin off.

Definition at line 647 of file hpi.h.

Tuner bands

Used for HPI_Tuner_SetBand(),HPI_Tuner_GetBand()

Enumerator:
HPI_TUNER_BAND_AM 

AM band

HPI_TUNER_BAND_FM 

FM band (mono)

HPI_TUNER_BAND_TV_NTSC_M 

NTSC-M TV band

HPI_TUNER_BAND_TV 
HPI_TUNER_BAND_FM_STEREO 

FM band (stereo)

HPI_TUNER_BAND_AUX 

auxiliary input

HPI_TUNER_BAND_TV_PAL_BG 

PAL-B/G TV band

HPI_TUNER_BAND_TV_PAL_I 

PAL-I TV band

HPI_TUNER_BAND_TV_PAL_DK 

PAL-D/K TV band

HPI_TUNER_BAND_TV_SECAM_L 

SECAM-L TV band

HPI_TUNER_BAND_LAST 

the index of the last tuner band.

Definition at line 744 of file hpi.h.

Tuner mode attribute values

Used by HPI_Tuner_SetMode(), HPI_Tuner_GetMode()

Enumerator:
HPI_TUNER_MODE_RSS_DISABLE 

RSS disable

HPI_TUNER_MODE_RSS_ENABLE 

RSS enable

HPI_TUNER_MODE_RDS_DISABLE 

RDS - disabled

HPI_TUNER_MODE_RDS_RDS 

RDS - RDS mode

HPI_TUNER_MODE_RDS_RBDS 

RDS - RBDS mode

Definition at line 774 of file hpi.h.

Tuner mode attributes

Used by HPI_Tuner_SetMode(), HPI_Tuner_GetMode()

Enumerator:
HPI_TUNER_MODE_RSS 

control RSS

HPI_TUNER_MODE_RDS 

control RBDS/RDS

Definition at line 764 of file hpi.h.

Tuner Status Bits

These bitfield values are returned by a call to HPI_Tuner_GetStatus(). Multiple fields are returned from a single call.

Enumerator:
HPI_TUNER_VIDEO_COLOR_PRESENT 

video color is present.

HPI_TUNER_VIDEO_IS_60HZ 

60 hz video detected.

HPI_TUNER_VIDEO_HORZ_SYNC_MISSING 

video HSYNC is missing.

HPI_TUNER_VIDEO_STATUS_VALID 

video status is valid.

HPI_TUNER_DIGITAL 

tuner reports digital programming.

HPI_TUNER_MULTIPROGRAM 

tuner reports multiple programs.

HPI_TUNER_PLL_LOCKED 

the tuner's PLL is locked.

HPI_TUNER_FM_STEREO 

tuner reports back FM stereo.

Definition at line 791 of file hpi.h.

autofade profiles

Enumerator:
HPI_VOLUME_AUTOFADE_LOG 

log fade - dB attenuation changes linearly over time

HPI_VOLUME_AUTOFADE_LINEAR 

linear fade - amplitude changes linearly

Definition at line 676 of file hpi.h.

Function Documentation

u16 hpi_adapter_close ( u16  adapter_index)

Definition at line 148 of file hpifunc.c.

u16 hpi_adapter_debug_read ( u16  adapter_index,
u32  dsp_address,
char p_bytes,
int count_bytes 
)
u16 hpi_adapter_enable_capability ( u16  adapter_index,
u16  capability,
u32  key 
)
u16 hpi_adapter_enumerate_property ( u16  adapter_index,
u16  index,
u16  what_to_enumerate,
u16  property_index,
u32 psetting 
)

Definition at line 277 of file hpifunc.c.

u16 hpi_adapter_get_assert2 ( u16  adapter_index,
u16 p_assert_count,
char psz_assert,
u32 p_param1,
u32 p_param2,
u32 p_dsp_string_addr,
u16 p_processor_id 
)
u16 hpi_adapter_get_info ( u16  adapter_index,
u16 pw_num_outstreams,
u16 pw_num_instreams,
u16 pw_version,
u32 pserial_number,
u16 pw_adapter_type 
)

Definition at line 195 of file hpifunc.c.

u16 hpi_adapter_get_mode ( u16  adapter_index,
u32 padapter_mode 
)

Definition at line 182 of file hpifunc.c.

u16 hpi_adapter_get_module_by_index ( u16  adapter_index,
u16  module_index,
u16 pw_num_outputs,
u16 pw_num_inputs,
u16 pw_version,
u32 pserial_number,
u16 pw_module_type,
u32 ph_module 
)

Definition at line 215 of file hpifunc.c.

u16 hpi_adapter_get_property ( u16  adapter_index,
u16  property,
u16 pw_paramter1,
u16 pw_paramter2 
)

Definition at line 256 of file hpifunc.c.

u16 hpi_adapter_open ( u16  adapter_index)

Definition at line 134 of file hpifunc.c.

u16 hpi_adapter_self_test ( u16  adapter_index)
u16 hpi_adapter_set_mode ( u16  adapter_index,
u32  adapter_mode 
)

Definition at line 161 of file hpifunc.c.

u16 hpi_adapter_set_mode_ex ( u16  adapter_index,
u32  adapter_mode,
u16  query_or_set 
)

Definition at line 167 of file hpifunc.c.

u16 hpi_adapter_set_property ( u16  adapter_index,
u16  property,
u16  paramter1,
u16  paramter2 
)

Definition at line 239 of file hpifunc.c.

u16 hpi_adapter_test_assert ( u16  adapter_index,
u16  assert_id 
)
u16 hpi_aesebu_receiver_get_channel_status ( u32  h_control,
u16  index,
u16 pw_data 
)

Definition at line 1521 of file hpifunc.c.

u16 hpi_aesebu_receiver_get_error_status ( u32  h_control,
u16 pw_error_data 
)

Definition at line 1540 of file hpifunc.c.

u16 hpi_aesebu_receiver_get_format ( u32  h_control,
u16 pw_source 
)

Definition at line 1485 of file hpifunc.c.

u16 hpi_aesebu_receiver_get_sample_rate ( u32  h_control,
u32 psample_rate 
)

Definition at line 1497 of file hpifunc.c.

u16 hpi_aesebu_receiver_get_user_data ( u32  h_control,
u16  index,
u16 pw_data 
)

Definition at line 1503 of file hpifunc.c.

u16 hpi_aesebu_receiver_query_format ( const u32  h_aes_rx,
const u32  index,
u16 pw_format 
)

Definition at line 1468 of file hpifunc.c.

u16 hpi_aesebu_receiver_set_format ( u32  h_control,
u16  source 
)

Definition at line 1479 of file hpifunc.c.

u16 hpi_aesebu_transmitter_get_channel_status ( u32  h_control,
u16  index,
u16 pw_data 
)

Definition at line 1571 of file hpifunc.c.

u16 hpi_aesebu_transmitter_get_format ( u32  h_control,
u16 pw_output_format 
)

Definition at line 1594 of file hpifunc.c.

u16 hpi_aesebu_transmitter_query_format ( const u32  h_aes_tx,
const u32  index,
u16 pw_format 
)

Definition at line 1577 of file hpifunc.c.

u16 hpi_aesebu_transmitter_set_channel_status ( u32  h_control,
u16  index,
u16  data 
)

Definition at line 1564 of file hpifunc.c.

u16 hpi_aesebu_transmitter_set_format ( u32  h_control,
u16  output_format 
)

Definition at line 1588 of file hpifunc.c.

u16 hpi_aesebu_transmitter_set_sample_rate ( u32  h_control,
u32  sample_rate 
)

Definition at line 1552 of file hpifunc.c.

u16 hpi_aesebu_transmitter_set_user_data ( u32  h_control,
u16  index,
u16  data 
)

Definition at line 1558 of file hpifunc.c.

u16 hpi_bitstream_get_activity ( u32  h_control,
u16 pw_clk_activity,
u16 pw_data_activity 
)

Definition at line 1618 of file hpifunc.c.

u16 hpi_bitstream_set_clock_edge ( u32  h_control,
u16  edge_type 
)

Definition at line 1606 of file hpifunc.c.

u16 hpi_bitstream_set_data_polarity ( u32  h_control,
u16  polarity 
)

Definition at line 1612 of file hpifunc.c.

u16 hpi_channel_mode_get ( u32  h_control,
u16 mode 
)

Definition at line 1653 of file hpifunc.c.

u16 hpi_channel_mode_query_mode ( const u32  h_mode,
const u32  index,
u16 pw_mode 
)

Definition at line 1636 of file hpifunc.c.

u16 hpi_channel_mode_set ( u32  h_control,
u16  mode 
)

Definition at line 1647 of file hpifunc.c.

u16 hpi_cobranet_get_ip_address ( u32  h_control,
u32 pdw_ip_address 
)

Definition at line 1753 of file hpifunc.c.

u16 hpi_cobranet_get_macaddress ( u32  h_control,
u32 p_mac_msbs,
u32 p_mac_lsbs 
)

Definition at line 1826 of file hpifunc.c.

u16 hpi_cobranet_get_static_ip_address ( u32  h_control,
u32 pdw_ip_address 
)

Definition at line 1790 of file hpifunc.c.

u16 hpi_cobranet_hmi_get_status ( u32  h_control,
u32 pstatus,
u32 preadable_size,
u32 pwriteable_size 
)

Definition at line 1726 of file hpifunc.c.

u16 hpi_cobranet_hmi_read ( u32  h_control,
u32  hmi_address,
u32  max_byte_count,
u32 pbyte_count,
u8 pb_data 
)

Definition at line 1689 of file hpifunc.c.

u16 hpi_cobranet_hmi_write ( u32  h_control,
u32  hmi_address,
u32  byte_count,
u8 pb_data 
)

Definition at line 1663 of file hpifunc.c.

u16 hpi_cobranet_set_ip_address ( u32  h_control,
u32  dw_ip_address 
)

Definition at line 1774 of file hpifunc.c.

u16 hpi_cobranet_set_static_ip_address ( u32  h_control,
u32  dw_ip_address 
)

Definition at line 1810 of file hpifunc.c.

u16 hpi_compander_get_attack_time_constant ( u32  h_control,
u32  index,
u32 pw_attack 
)

Definition at line 1891 of file hpifunc.c.

u16 hpi_compander_get_decay_time_constant ( u32  h_control,
u32  index,
u32 pw_decay 
)

Definition at line 1905 of file hpifunc.c.

u16 hpi_compander_get_enable ( u32  h_control,
u32 pon 
)

Definition at line 1867 of file hpifunc.c.

u16 hpi_compander_get_makeup_gain ( u32  h_control,
short pn_makeup_gain0_01dB 
)

Definition at line 1878 of file hpifunc.c.

u16 hpi_compander_get_ratio ( u32  h_control,
u32  index,
u32 pw_ratio100 
)

Definition at line 1957 of file hpifunc.c.

u16 hpi_compander_get_threshold ( u32  h_control,
u32  index,
short pn_threshold0_01dB 
)

Definition at line 1932 of file hpifunc.c.

u16 hpi_compander_set_attack_time_constant ( u32  h_control,
u32  index,
u32  attack 
)

Definition at line 1884 of file hpifunc.c.

u16 hpi_compander_set_decay_time_constant ( u32  h_control,
u32  index,
u32  decay 
)

Definition at line 1898 of file hpifunc.c.

u16 hpi_compander_set_enable ( u32  h_control,
u32  on 
)

Definition at line 1861 of file hpifunc.c.

u16 hpi_compander_set_makeup_gain ( u32  h_control,
short  makeup_gain0_01dB 
)

Definition at line 1872 of file hpifunc.c.

u16 hpi_compander_set_ratio ( u32  h_control,
u32  index,
u32  ratio100 
)

Definition at line 1951 of file hpifunc.c.

u16 hpi_compander_set_threshold ( u32  h_control,
u32  index,
short  threshold0_01dB 
)

Definition at line 1913 of file hpifunc.c.

u16 hpi_format_create ( struct hpi_format p_format,
u16  channels,
u16  format,
u32  sample_rate,
u32  bit_rate,
u32  attributes 
)

Definition at line 283 of file hpifunc.c.

u16 hpi_instream_ancillary_get_info ( u32  h_instream,
u32 pframe_space 
)

Definition at line 1041 of file hpifunc.c.

u16 hpi_instream_ancillary_reset ( u32  h_instream,
u16  bytes_per_frame,
u16  mode,
u16  alignment,
u16  idle_bit 
)

Definition at line 1025 of file hpifunc.c.

u16 hpi_instream_ancillary_write ( u32  h_instream,
const struct hpi_anc_frame p_anc_frame_buffer,
u32  anc_frame_buffer_size_in_bytes,
u32  number_of_ancillary_frames_to_write 
)

Definition at line 1058 of file hpifunc.c.

u16 hpi_instream_close ( u32  h_instream)

Definition at line 864 of file hpifunc.c.

u16 hpi_instream_get_info_ex ( u32  h_instream,
u16 pw_state,
u32 pbuffer_size,
u32 pdata_recorded,
u32 psamples_recorded,
u32 pauxiliary_data_recorded 
)

Definition at line 998 of file hpifunc.c.

u16 hpi_instream_group_add ( u32  h_instream,
u32  h_stream 
)

Definition at line 1131 of file hpifunc.c.

u16 hpi_instream_group_get_map ( u32  h_instream,
u32 poutstream_map,
u32 pinstream_map 
)

Definition at line 1167 of file hpifunc.c.

u16 hpi_instream_group_reset ( u32  h_instream)

Definition at line 1187 of file hpifunc.c.

u16 hpi_instream_host_buffer_allocate ( u32  h_instream,
u32  size_in_bytes 
)

Definition at line 1081 of file hpifunc.c.

u16 hpi_instream_host_buffer_free ( u32  h_instream)

Definition at line 1117 of file hpifunc.c.

u16 hpi_instream_open ( u16  adapter_index,
u16  instream_index,
u32 ph_instream 
)

Definition at line 842 of file hpifunc.c.

u16 hpi_instream_query_format ( u32  h_instream,
const struct hpi_format p_format 
)

Definition at line 888 of file hpifunc.c.

u16 hpi_instream_read_buf ( u32  h_instream,
u8 pb_read_buf,
u32  bytes_to_read 
)

Definition at line 921 of file hpifunc.c.

u16 hpi_instream_reset ( u32  h_instream)

Definition at line 983 of file hpifunc.c.

u16 hpi_instream_set_format ( u32  h_instream,
const struct hpi_format p_format 
)

Definition at line 905 of file hpifunc.c.

u16 hpi_instream_start ( u32  h_instream)

Definition at line 938 of file hpifunc.c.

u16 hpi_instream_stop ( u32  h_instream)

Definition at line 968 of file hpifunc.c.

u16 hpi_instream_wait_start ( u32  h_instream)

Definition at line 953 of file hpifunc.c.

u16 hpi_level_get_gain ( u32  h_control,
short  an_gain0_01dB_out[HPI_MAX_CHANNELS] 
)

Definition at line 1997 of file hpifunc.c.

u16 hpi_level_query_range ( u32  h_control,
short min_gain_01dB,
short max_gain_01dB,
short step_gain_01dB 
)

Definition at line 1963 of file hpifunc.c.

u16 hpi_level_set_gain ( u32  h_control,
short  an_gain0_01dB[HPI_MAX_CHANNELS] 
)

Definition at line 1990 of file hpifunc.c.

u16 hpi_meter_get_peak ( u32  h_control,
short  an_peak0_01dB_out[HPI_MAX_CHANNELS] 
)

Definition at line 2010 of file hpifunc.c.

u16 hpi_meter_get_peak_ballistics ( u32  h_control,
u16 attack,
u16 decay 
)

Definition at line 2091 of file hpifunc.c.

u16 hpi_meter_get_rms ( u32  h_control,
short  an_peak0_01dB_out[HPI_MAX_CHANNELS] 
)

Definition at line 2036 of file hpifunc.c.

u16 hpi_meter_get_rms_ballistics ( u32  h_control,
u16 attack,
u16 decay 
)

Definition at line 2068 of file hpifunc.c.

u16 hpi_meter_query_channels ( const u32  h_meter,
u32 p_channels 
)

Definition at line 2004 of file hpifunc.c.

u16 hpi_meter_set_peak_ballistics ( u32  h_control,
u16  attack,
u16  decay 
)

Definition at line 2085 of file hpifunc.c.

u16 hpi_meter_set_rms_ballistics ( u32  h_control,
u16  attack,
u16  decay 
)

Definition at line 2062 of file hpifunc.c.

u16 hpi_microphone_get_phantom_power ( u32  h_control,
u16 pw_on_off 
)

Definition at line 2115 of file hpifunc.c.

u16 hpi_microphone_set_phantom_power ( u32  h_control,
u16  on_off 
)

Definition at line 2109 of file hpifunc.c.

u16 hpi_mixer_close ( u32  h_mixer)

Definition at line 1218 of file hpifunc.c.

u16 hpi_mixer_get_control ( u32  h_mixer,
u16  src_node_type,
u16  src_node_type_index,
u16  dst_node_type,
u16  dst_node_type_index,
u16  control_type,
u32 ph_control 
)

Definition at line 1231 of file hpifunc.c.

u16 hpi_mixer_get_control_by_index ( u32  h_mixer,
u16  control_index,
u16 pw_src_node_type,
u16 pw_src_node_index,
u16 pw_dst_node_type,
u16 pw_dst_node_index,
u16 pw_control_type,
u32 ph_control 
)

Definition at line 1258 of file hpifunc.c.

u16 hpi_mixer_open ( u16  adapter_index,
u32 ph_mixer 
)

Definition at line 1200 of file hpifunc.c.

u16 hpi_mixer_store ( u32  h_mixer,
enum HPI_MIXER_STORE_COMMAND  command,
u16  index 
)

Definition at line 1292 of file hpifunc.c.

u16 hpi_multiplexer_get_source ( u32  h_control,
u16 source_node_type,
u16 source_node_index 
)

Definition at line 2133 of file hpifunc.c.

u16 hpi_multiplexer_query_source ( u32  h_control,
u16  index,
u16 source_node_type,
u16 source_node_index 
)

Definition at line 2147 of file hpifunc.c.

u16 hpi_multiplexer_set_source ( u32  h_control,
u16  source_node_type,
u16  source_node_index 
)

Definition at line 2126 of file hpifunc.c.

u16 hpi_outstream_ancillary_get_info ( u32  h_outstream,
u32 pframes_available 
)

Definition at line 669 of file hpifunc.c.

u16 hpi_outstream_ancillary_read ( u32  h_outstream,
struct hpi_anc_frame p_anc_frame_buffer,
u32  anc_frame_buffer_size_in_bytes,
u32  number_of_ancillary_frames_to_read 
)

Definition at line 688 of file hpifunc.c.

u16 hpi_outstream_ancillary_reset ( u32  h_outstream,
u16  mode 
)

Definition at line 655 of file hpifunc.c.

u16 hpi_outstream_close ( u32  h_outstream)

Definition at line 445 of file hpifunc.c.

u16 hpi_outstream_get_info_ex ( u32  h_outstream,
u16 pw_state,
u32 pbuffer_size,
u32 pdata_to_play,
u32 psamples_played,
u32 pauxiliary_data_to_play 
)

Definition at line 470 of file hpifunc.c.

u16 hpi_outstream_group_add ( u32  h_outstream,
u32  h_stream 
)

Definition at line 776 of file hpifunc.c.

u16 hpi_outstream_group_get_map ( u32  h_outstream,
u32 poutstream_map,
u32 pinstream_map 
)

Definition at line 809 of file hpifunc.c.

u16 hpi_outstream_group_reset ( u32  h_outstream)

Definition at line 829 of file hpifunc.c.

u16 hpi_outstream_host_buffer_allocate ( u32  h_outstream,
u32  size_in_bytes 
)

Definition at line 728 of file hpifunc.c.

u16 hpi_outstream_host_buffer_free ( u32  h_outstream)

Definition at line 763 of file hpifunc.c.

u16 hpi_outstream_open ( u16  adapter_index,
u16  outstream_index,
u32 ph_outstream 
)

Definition at line 424 of file hpifunc.c.

u16 hpi_outstream_query_format ( u32  h_outstream,
struct hpi_format p_format 
)

Definition at line 586 of file hpifunc.c.

u16 hpi_outstream_reset ( u32  h_outstream)

Definition at line 572 of file hpifunc.c.

u16 hpi_outstream_set_format ( u32  h_outstream,
struct hpi_format p_format 
)

Definition at line 603 of file hpifunc.c.

u16 hpi_outstream_set_punch_in_out ( u32  h_outstream,
u32  punch_in_sample,
u32  punch_out_sample 
)

Definition at line 636 of file hpifunc.c.

u16 hpi_outstream_set_time_scale ( u32  h_outstream,
u32  time_scaleX10000 
)

Definition at line 711 of file hpifunc.c.

u16 hpi_outstream_set_velocity ( u32  h_outstream,
short  velocity 
)

Definition at line 620 of file hpifunc.c.

u16 hpi_outstream_sinegen ( u32  h_outstream)

Definition at line 558 of file hpifunc.c.

u16 hpi_outstream_start ( u32  h_outstream)

Definition at line 516 of file hpifunc.c.

u16 hpi_outstream_stop ( u32  h_outstream)

Definition at line 544 of file hpifunc.c.

u16 hpi_outstream_wait_start ( u32  h_outstream)

Definition at line 530 of file hpifunc.c.

u16 hpi_outstream_write_buf ( u32  h_outstream,
const u8 pb_write_buf,
u32  bytes_to_write,
const struct hpi_format p_format 
)

Definition at line 497 of file hpifunc.c.

u16 hpi_pad_get_artist ( u32  h_control,
char psz_string,
const u32  string_length 
)

Definition at line 2712 of file hpifunc.c.

u16 hpi_pad_get_channel_name ( u32  h_control,
char psz_string,
const u32  string_length 
)

Definition at line 2705 of file hpifunc.c.

u16 hpi_pad_get_comment ( u32  h_control,
char psz_string,
const u32  string_length 
)

Definition at line 2724 of file hpifunc.c.

u16 hpi_pad_get_program_type ( u32  h_control,
u32 ppTY 
)

Definition at line 2731 of file hpifunc.c.

u16 hpi_pad_get_program_type_string ( u32  h_control,
const u32  data_type,
const u32  pTY,
char psz_string,
const u32  string_length 
)
u16 hpi_pad_get_rdsPI ( u32  h_control,
u32 ppI 
)

Definition at line 2736 of file hpifunc.c.

u16 hpi_pad_get_title ( u32  h_control,
char psz_string,
const u32  string_length 
)

Definition at line 2718 of file hpifunc.c.

u16 hpi_parametric_eq_get_band ( u32  h_control,
u16  index,
u16 pn_type,
u32 pfrequency_hz,
short pnQ100,
short pn_gain0_01dB 
)

Definition at line 2190 of file hpifunc.c.

u16 hpi_parametric_eq_get_coeffs ( u32  h_control,
u16  index,
short  coeffs[5] 
)

Definition at line 2239 of file hpifunc.c.

u16 hpi_parametric_eq_get_info ( u32  h_control,
u16 pw_number_of_bands,
u16 pw_enabled 
)

Definition at line 2168 of file hpifunc.c.

u16 hpi_parametric_eq_set_band ( u32  h_control,
u16  index,
u16  type,
u32  frequency_hz,
short  q100,
short  gain0_01dB 
)

Definition at line 2217 of file hpifunc.c.

u16 hpi_parametric_eq_set_state ( u32  h_control,
u16  on_off 
)

Definition at line 2184 of file hpifunc.c.

u16 hpi_sample_clock_get_auto ( u32  h_control,
u32 penable 
)

Definition at line 2369 of file hpifunc.c.

u16 hpi_sample_clock_get_local_rate ( u32  h_control,
u32 psample_rate 
)

Definition at line 2339 of file hpifunc.c.

u16 hpi_sample_clock_get_local_rate_lock ( u32  h_control,
u32 plock 
)

Definition at line 2381 of file hpifunc.c.

u16 hpi_sample_clock_get_sample_rate ( u32  h_control,
u32 psample_rate 
)

Definition at line 2351 of file hpifunc.c.

u16 hpi_sample_clock_get_source ( u32  h_control,
u16 pw_source 
)

Definition at line 2281 of file hpifunc.c.

u16 hpi_sample_clock_get_source_index ( u32  h_control,
u16 pw_source_index 
)

Definition at line 2311 of file hpifunc.c.

u16 hpi_sample_clock_query_local_rate ( const u32  h_clock,
const u32  index,
u32 psource 
)

Definition at line 2323 of file hpifunc.c.

u16 hpi_sample_clock_query_source ( const u32  h_clock,
const u32  index,
u16 pw_source 
)

Definition at line 2263 of file hpifunc.c.

u16 hpi_sample_clock_query_source_index ( const u32  h_clock,
const u32  index,
const u32  source,
u16 pw_source_index 
)

Definition at line 2293 of file hpifunc.c.

u16 hpi_sample_clock_set_auto ( u32  h_control,
u32  enable 
)

Definition at line 2363 of file hpifunc.c.

u16 hpi_sample_clock_set_local_rate ( u32  h_control,
u32  sample_rate 
)

Definition at line 2333 of file hpifunc.c.

u16 hpi_sample_clock_set_local_rate_lock ( u32  h_control,
u32  lock 
)

Definition at line 2375 of file hpifunc.c.

u16 hpi_sample_clock_set_source ( u32  h_control,
u16  source 
)

Definition at line 2275 of file hpifunc.c.

u16 hpi_sample_clock_set_source_index ( u32  h_control,
u16  source_index 
)

Definition at line 2305 of file hpifunc.c.

u16 hpi_silence_detector_get_delay ( u32  hC,
u32 delay 
)

Definition at line 2469 of file hpifunc.c.

u16 hpi_silence_detector_get_enable ( u32  hC,
u32 enable 
)

Definition at line 2446 of file hpifunc.c.

u16 hpi_silence_detector_get_event_enable ( u32  hC,
u32 event_enable 
)

Definition at line 2457 of file hpifunc.c.

u16 hpi_silence_detector_get_state ( u32  hC,
u32 state 
)

Definition at line 2434 of file hpifunc.c.

u16 hpi_silence_detector_get_threshold ( u32  hC,
int threshold 
)

Definition at line 2481 of file hpifunc.c.

u16 hpi_silence_detector_set_delay ( u32  hC,
u32  delay 
)

Definition at line 2463 of file hpifunc.c.

u16 hpi_silence_detector_set_enable ( u32  hC,
u32  enable 
)

Definition at line 2440 of file hpifunc.c.

u16 hpi_silence_detector_set_event_enable ( u32  hC,
u32  event_enable 
)

Definition at line 2451 of file hpifunc.c.

u16 hpi_silence_detector_set_threshold ( u32  hC,
int  threshold 
)

Definition at line 2475 of file hpifunc.c.

u16 hpi_stream_estimate_buffer_size ( struct hpi_format pF,
u32  host_polling_rate_in_milli_seconds,
u32 recommended_buffer_size 
)

Definition at line 378 of file hpifunc.c.

u16 hpi_subsys_get_adapter ( int  iterator,
u32 padapter_index,
u16 pw_adapter_type 
)

Definition at line 119 of file hpifunc.c.

u16 hpi_subsys_get_num_adapters ( int pn_num_adapters)

Definition at line 108 of file hpifunc.c.

u16 hpi_subsys_get_version_ex ( u32 pversion_ex)

Definition at line 96 of file hpifunc.c.

u16 hpi_tone_detector_get_enable ( u32  hC,
u32 enable 
)

Definition at line 2405 of file hpifunc.c.

u16 hpi_tone_detector_get_event_enable ( u32  hC,
u32 event_enable 
)

Definition at line 2416 of file hpifunc.c.

u16 hpi_tone_detector_get_frequency ( u32  hC,
u32  index,
u32 frequency 
)

Definition at line 2387 of file hpifunc.c.

u16 hpi_tone_detector_get_state ( u32  hC,
u32 state 
)

Definition at line 2393 of file hpifunc.c.

u16 hpi_tone_detector_get_threshold ( u32  hC,
int threshold 
)

Definition at line 2428 of file hpifunc.c.

u16 hpi_tone_detector_set_enable ( u32  hC,
u32  enable 
)

Definition at line 2399 of file hpifunc.c.

u16 hpi_tone_detector_set_event_enable ( u32  hC,
u32  event_enable 
)

Definition at line 2410 of file hpifunc.c.

u16 hpi_tone_detector_set_threshold ( u32  hC,
int  threshold 
)

Definition at line 2422 of file hpifunc.c.

u16 hpi_tuner_get_band ( u32  h_control,
u16 pw_band 
)

Definition at line 2502 of file hpifunc.c.

u16 hpi_tuner_get_deemphasis ( u32  h_control,
u32 pdeemphasis 
)

Definition at line 2602 of file hpifunc.c.

u16 hpi_tuner_get_frequency ( u32  h_control,
u32 pw_freq_ink_hz 
)

Definition at line 2525 of file hpifunc.c.

u16 hpi_tuner_get_gain ( u32  h_control,
short pn_gain 
)

Definition at line 2546 of file hpifunc.c.

u16 hpi_tuner_get_hd_radio_dsp_version ( u32  h_control,
char psz_dsp_version,
const u32  string_size 
)

Definition at line 2625 of file hpifunc.c.

u16 hpi_tuner_get_hd_radio_sdk_version ( u32  h_control,
char psz_sdk_version,
const u32  string_size 
)

Definition at line 2632 of file hpifunc.c.

u16 hpi_tuner_get_hd_radio_signal_blend ( u32  h_control,
u32 pblend 
)

Definition at line 2674 of file hpifunc.c.

u16 hpi_tuner_get_hd_radio_signal_quality ( u32  h_control,
u32 pquality 
)

Definition at line 2668 of file hpifunc.c.

u16 hpi_tuner_get_mode ( u32  h_control,
u32  mode,
u32 pn_value 
)

Definition at line 2662 of file hpifunc.c.

u16 hpi_tuner_get_program ( u32  h_control,
u32 pprogram 
)

Definition at line 2620 of file hpifunc.c.

u16 hpi_tuner_get_raw_rf_level ( u32  h_control,
short pw_level 
)

Definition at line 2573 of file hpifunc.c.

u16 hpi_tuner_get_rds ( u32  h_control,
char p_rds_data 
)

Definition at line 2686 of file hpifunc.c.

u16 hpi_tuner_get_rf_level ( u32  h_control,
short pw_level 
)

Definition at line 2557 of file hpifunc.c.

u16 hpi_tuner_get_status ( u32  h_control,
u16 pw_status_mask,
u16 pw_status 
)

Definition at line 2639 of file hpifunc.c.

u16 hpi_tuner_query_band ( const u32  h_tuner,
const u32  index,
u16 pw_band 
)

Definition at line 2487 of file hpifunc.c.

u16 hpi_tuner_query_deemphasis ( const u32  h_tuner,
const u32  index,
const u16  band,
u32 pdeemphasis 
)

Definition at line 2589 of file hpifunc.c.

u16 hpi_tuner_query_frequency ( const u32  h_tuner,
const u32  index,
const u16  band,
u32 pfreq 
)

Definition at line 2513 of file hpifunc.c.

u16 hpi_tuner_query_gain ( const u32  h_tuner,
const u32  index,
u16 pw_gain 
)

Definition at line 2531 of file hpifunc.c.

u16 hpi_tuner_query_program ( const u32  h_tuner,
u32 pbitmap_program 
)

Definition at line 2608 of file hpifunc.c.

u16 hpi_tuner_set_band ( u32  h_control,
u16  band 
)

Definition at line 2497 of file hpifunc.c.

u16 hpi_tuner_set_deemphasis ( u32  h_control,
u32  deemphasis 
)

Definition at line 2596 of file hpifunc.c.

u16 hpi_tuner_set_frequency ( u32  h_control,
u32  freq_ink_hz 
)

Definition at line 2519 of file hpifunc.c.

u16 hpi_tuner_set_gain ( u32  h_control,
short  gain 
)

Definition at line 2541 of file hpifunc.c.

u16 hpi_tuner_set_hd_radio_signal_blend ( u32  h_control,
const u32  blend 
)

Definition at line 2680 of file hpifunc.c.

u16 hpi_tuner_set_mode ( u32  h_control,
u32  mode,
u32  value 
)

Definition at line 2657 of file hpifunc.c.

u16 hpi_tuner_set_program ( u32  h_control,
u32  program 
)

Definition at line 2614 of file hpifunc.c.

u16 hpi_volume_auto_fade ( u32  h_control,
short  an_stop_gain0_01dB[HPI_MAX_CHANNELS],
u32  duration_ms 
)

Definition at line 2822 of file hpifunc.c.

u16 hpi_volume_auto_fade_profile ( u32  h_control,
short  an_stop_gain0_01dB[HPI_MAX_CHANNELS],
u32  duration_ms,
u16  profile 
)

Definition at line 2798 of file hpifunc.c.

u16 hpi_volume_get_gain ( u32  h_control,
short  an_gain0_01dB_out[HPI_MAX_CHANNELS] 
)

Definition at line 2754 of file hpifunc.c.

u16 hpi_volume_get_mute ( u32  h_control,
u32 mute 
)

Definition at line 2766 of file hpifunc.c.

u16 hpi_volume_query_auto_fade_profile ( const u32  h_control,
const u32  i,
u16 profile 
)

Definition at line 2829 of file hpifunc.c.

u16 hpi_volume_query_channels ( const u32  h_control,
u32 p_channels 
)

Definition at line 2741 of file hpifunc.c.

u16 hpi_volume_query_range ( u32  h_control,
short min_gain_01dB,
short max_gain_01dB,
short step_gain_01dB 
)

Definition at line 2771 of file hpifunc.c.

u16 hpi_volume_set_gain ( u32  h_control,
short  an_gain0_01dB[HPI_MAX_CHANNELS] 
)

Definition at line 2747 of file hpifunc.c.

u16 hpi_volume_set_mute ( u32  h_control,
u32  mute 
)

Definition at line 2761 of file hpifunc.c.

u16 hpi_vox_get_threshold ( u32  h_control,
short an_gain0_01dB 
)

Definition at line 2856 of file hpifunc.c.

u16 hpi_vox_set_threshold ( u32  h_control,
short  an_gain0_01dB 
)

Definition at line 2839 of file hpifunc.c.