AES/EBU Digital audio receiver controls
[Mixer and Controls]

The AESEBU receiver receives audio from a standard digital audio interface (AESEBU or SPDIF). More...

Enumerations
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 }
	AES/EBU error status bits. More...
Functions
HPI_ERR	HPI_AESEBU_Receiver_QueryFormat (const HPI_HSUBSYS *phSubSys, const HPI_HCONTROL hAesRx, const HW32 dwIndex, HW16 *pwFormat)
	query formats supported by this aesebu receiver Iterate dwIndex until an error is returned to get allowed values for aesebu format in *pwFormat
HPI_ERR	HPI_AESEBU_Receiver_SetFormat (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wFormat)
	Sets the physical format of the digital audio input to either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input.
HPI_ERR	HPI_AESEBU_Receiver_GetFormat (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 *pwFormat)
	Gets the physical format of the digital audio input : either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input.
HPI_ERR	HPI_AESEBU_Receiver_GetSampleRate (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *pdwSampleRate)
	Returns the sample rate of the incoming AES/EBU digital audio stream in *pdwSampleRate.
HPI_ERR	HPI_AESEBU_Receiver_GetUserData (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wIndex, HW16 *pwData)
	Get one of 4 userdata bytes from the AES/EBU stream.
HPI_ERR	HPI_AESEBU_Receiver_GetChannelStatus (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wIndex, HW16 *pwData)
	Get one of 24 channel status bytes from the AES/EBU stream.
HPI_ERR	HPI_AESEBU_Receiver_GetErrorStatus (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 *pwErrorData)
	Get error status from the AES/EBU stream.

---

Detailed Description

The AESEBU receiver receives audio from a standard digital audio interface (AESEBU or SPDIF).

As well as receiving the audio, status and user bits are extracted from the digital bitstream.

---

Enumeration Type Documentation

enum HPI_AESEBU_ERRORS

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

---

Function Documentation

HPI_ERR HPI_AESEBU_Receiver_QueryFormat (  const HPI_HSUBSYS *  phSubSys, const HPI_HCONTROL  hAesRx, const HW32  dwIndex, HW16 *  pwFormat )

query formats supported by this aesebu receiver Iterate dwIndex until an error is returned to get allowed values for aesebu format in *pwFormat Parameters: phSubSys  Pointer to HPI subsystem handle hAesRx  Control to query dwIndex  Index for possible attribute values pwFormat  aesebu format, one of the HPI_AESEBU_FORMATS

HPI_ERR HPI_AESEBU_Receiver_SetFormat (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW16  wFormat )

Sets the physical format of the digital audio input to either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input. Note that not all audio adpaters will have both kinds of inputs. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  Pointer to HPI subsystem handle hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER wFormat  One of the HPI_AESEBU_FORMATS

HPI_ERR HPI_AESEBU_Receiver_GetFormat (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW16 *  pwFormat )

Gets the physical format of the digital audio input : either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input. Note: Not all audio adapters will have both kinds of inputs. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  Pointer to HPI subsystem handle. hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER. pwFormat  current format, one of the HPI_AESEBU_FORMATS.

HPI_ERR HPI_AESEBU_Receiver_GetSampleRate (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32 *  pdwSampleRate )

Returns the sample rate of the incoming AES/EBU digital audio stream in *pdwSampleRate. This information is obtained from the channel status bits in the digital audio bitstream. Returns: 0 on success, or one of the HPI_ERROR_CODES. Return values: HPI_ERROR_INVALID_OPERATION  if PLL unlocked. Parameters: phSubSys  Pointer to HPI subsystem handle hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER pdwSampleRate  samplerate 0, 32000,44100 or 48000 (or x2, x4) returned

HPI_ERR HPI_AESEBU_Receiver_GetUserData (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW16  wIndex, HW16 *  pwData )

Get one of 4 userdata bytes from the AES/EBU stream. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  Pointer to HPI subsystem handle. hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER. wIndex  byte index ranges from 0..3. pwData  returned user data.

HPI_ERR HPI_AESEBU_Receiver_GetChannelStatus (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW16  wIndex, HW16 *  pwData )

Get one of 24 channel status bytes from the AES/EBU stream. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  Pointer to HPI subsystem handle. hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER. wIndex  byte index ranges from 0..23. pwData  returned channel status data.

HPI_ERR HPI_AESEBU_Receiver_GetErrorStatus (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW16 *  pwErrorData )

Get error status from the AES/EBU stream. Returns: 0 on success, or one of the HPI_ERROR_CODES. Parameters: phSubSys  Pointer to HPI subsystem handle. hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER. pwErrorData  returned error status bitfields defined by HPI_AESEBU_ERRORS.

---