le_audio_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	LE_AUDIO_DTMF_MAX_LEN   100
#define	LE_AUDIO_DTMF_MAX_BYTES   101

Typedefs
typedef struct le_audio_Stream *	le_audio_StreamRef_t
typedef struct le_audio_Connector *	le_audio_ConnectorRef_t
typedef struct le_audio_DtmfDetectorHandler *	le_audio_DtmfDetectorHandlerRef_t
typedef void(*	le_audio_DtmfDetectorHandlerFunc_t )(le_audio_StreamRef_t streamRef, char dtmf, void *contextPtr)

Enumerations
enum	le_audio_Profile_t {   LE_AUDIO_HANDSFREE, LE_AUDIO_HANDSET, LE_AUDIO_HEADSET, LE_AUDIO_TTY,   LE_AUDIO_USB }
enum	le_audio_Companding_t { LE_AUDIO_COMPANDING_ALAW, LE_AUDIO_COMPANDING_ULAW, LE_AUDIO_COMPANDING_NONE }
enum	le_audio_I2SChannel_t {   LE_AUDIO_I2S_LEFT, LE_AUDIO_I2S_RIGHT, LE_AUDIO_I2S_MONO, LE_AUDIO_I2S_STEREO,   LE_AUDIO_I2S_REVERSE }

Functions
void	le_audio_ConnectService (void)
void	le_audio_DisconnectService (void)
le_audio_StreamRef_t	le_audio_OpenMic (void)
le_audio_StreamRef_t	le_audio_OpenSpeaker (void)
le_audio_StreamRef_t	le_audio_OpenUsbRx (void)
le_audio_StreamRef_t	le_audio_OpenUsbTx (void)
le_audio_StreamRef_t	le_audio_OpenPcmRx (uint32_t timeslot)
le_audio_StreamRef_t	le_audio_OpenPcmTx (uint32_t timeslot)
le_audio_StreamRef_t	le_audio_OpenI2sRx (le_audio_I2SChannel_t mode)
le_audio_StreamRef_t	le_audio_OpenI2sTx (le_audio_I2SChannel_t mode)
le_audio_StreamRef_t	le_audio_OpenFilePlayback (int fd)
le_audio_StreamRef_t	le_audio_OpenFileRecording (int fd)
le_audio_StreamRef_t	le_audio_OpenModemVoiceRx (void)
le_audio_StreamRef_t	le_audio_OpenModemVoiceTx (void)
le_result_t	le_audio_GetFormat (le_audio_StreamRef_t streamRef, char *formatPtr, size_t formatPtrNumElements)
void	le_audio_Close (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_SetGain (le_audio_StreamRef_t streamRef, uint32_t gain)
le_result_t	le_audio_GetGain (le_audio_StreamRef_t streamRef, uint32_t *gainPtr)
le_result_t	le_audio_Mute (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_Unmute (le_audio_StreamRef_t streamRef)
le_audio_ConnectorRef_t	le_audio_CreateConnector (void)
void	le_audio_DeleteConnector (le_audio_ConnectorRef_t connectorRef)
le_result_t	le_audio_Connect (le_audio_ConnectorRef_t connectorRef, le_audio_StreamRef_t streamRef)
void	le_audio_Disconnect (le_audio_ConnectorRef_t connectorRef, le_audio_StreamRef_t streamRef)
le_audio_DtmfDetectorHandlerRef_t	le_audio_AddDtmfDetectorHandler (le_audio_StreamRef_t streamRef, le_audio_DtmfDetectorHandlerFunc_t handlerPtr, void *contextPtr)
void	le_audio_RemoveDtmfDetectorHandler (le_audio_DtmfDetectorHandlerRef_t addHandlerRef)
le_result_t	le_audio_EnableNoiseSuppressor (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_DisableNoiseSuppressor (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_EnableEchoCanceller (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_DisableEchoCanceller (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_EnableFirFilter (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_DisableFirFilter (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_EnableIirFilter (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_DisableIirFilter (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_EnableAutomaticGainControl (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_DisableAutomaticGainControl (le_audio_StreamRef_t streamRef)
le_result_t	le_audio_SetProfile (le_audio_Profile_t profile)
le_result_t	le_audio_GetProfile (le_audio_Profile_t *profilePtr)
le_result_t	le_audio_SetPcmSamplingRate (uint32_t rate)
le_result_t	le_audio_SetPcmSamplingResolution (uint32_t bitsPerSample)
le_result_t	le_audio_SetPcmCompanding (le_audio_Companding_t companding)
uint32_t	le_audio_GetPcmSamplingRate (void)
uint32_t	le_audio_GetPcmSamplingResolution (void)
le_audio_Companding_t	le_audio_GetPcmCompanding (void)
uint32_t	le_audio_GetDefaultPcmTimeSlot (void)
le_audio_I2SChannel_t	le_audio_GetDefaultI2sMode (void)

Detailed Description

Legato Audio include file.

Copyright (C) Sierra Wireless, Inc. 2014. Use of this work is subject to license.

Macro Definition Documentation

#define LE_AUDIO_DTMF_MAX_LEN   100

Maximum DTMF string length.

Typedef Documentation

typedef struct le_audio_Connector* le_audio_ConnectorRef_t

Reference type for Audio Connector

typedef void(* le_audio_DtmfDetectorHandlerFunc_t)(le_audio_StreamRef_t streamRef, char dtmf, void *contextPtr)

Handler for DTMF decoding.

Parameters

streamRef	The audio stream reference.
dtmf	Detected DTMF.
contextPtr

typedef struct le_audio_DtmfDetectorHandler* le_audio_DtmfDetectorHandlerRef_t

Reference type for le_audio_DtmfDetectorHandler handler ADD/REMOVE functions

typedef struct le_audio_Stream* le_audio_StreamRef_t

Reference type for Audio Stream

Enumeration Type Documentation

enum le_audio_Companding_t

Companding.

Enumerator
LE_AUDIO_COMPANDING_ALAW	A-law PCM (i.e. Europe and most of the rest of the world).
LE_AUDIO_COMPANDING_ULAW	MU-law PCM (i.e. North America and Japan).
LE_AUDIO_COMPANDING_NONE	Linear PCM.

enum le_audio_I2SChannel_t

I2S channel mode.

Enumerator
LE_AUDIO_I2S_LEFT	Left channel.
LE_AUDIO_I2S_RIGHT	Right channel.
LE_AUDIO_I2S_MONO	Mono mode.
LE_AUDIO_I2S_STEREO	Stereo mode.
LE_AUDIO_I2S_REVERSE	Reverse mode (left & right reversed).

enum le_audio_Profile_t

Audio profiles.

Enumerator
LE_AUDIO_HANDSFREE	Handsfree profile.
LE_AUDIO_HANDSET	Handset profile.
LE_AUDIO_HEADSET	Headset profile.
LE_AUDIO_TTY	Teletypewriter profile (for hearing impaired use cases).
LE_AUDIO_USB	USB profile.

Function Documentation

le_audio_DtmfDetectorHandlerRef_t le_audio_AddDtmfDetectorHandler	(	le_audio_StreamRef_t	streamRef,
		le_audio_DtmfDetectorHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

le_audio_DtmfDetectorHandler handler ADD function

Parameters

[in]	streamRef	The audio stream reference.
[in]	handlerPtr
[in]	contextPtr

void le_audio_Close

(

le_audio_StreamRef_t

streamRef

)

Close an audio stream. If several users own the stream reference, the interface closes only after the last user closes the audio stream.

Note

If the caller is passing a bad reference into this function, it is a fatal error, the function will not return.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_Connect	(	le_audio_ConnectorRef_t	connectorRef,
		le_audio_StreamRef_t	streamRef
	)

Connect an audio stream to the connector reference.

Returns

LE_FAULT Function failed.

LE_BUSY Insufficient DSP resources available.

LE_BAD_PARAMETER Connector and/or the audio stream references are invalid.

LE_OK Function succeeded.

Note

If the caller is passing a bad reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	connectorRef	Connector reference.
[in]	streamRef	Audio stream reference.

void le_audio_ConnectService

(

void

)

Connect the client to the service

le_audio_ConnectorRef_t le_audio_CreateConnector

(

void

)

Create an audio connector reference.

Returns

Reference to the audio connector, NULL if the function fails.

void le_audio_DeleteConnector

(

le_audio_ConnectorRef_t

connectorRef

)

Delete an audio connector reference.

Note

If the caller is passing a bad reference into this function, it is a fatal error, the function will not return.

Parameters

[in]

connectorRef

Connector reference.

le_result_t le_audio_DisableAutomaticGainControl

(

le_audio_StreamRef_t

streamRef

)

This function must be called to disable the automatic gain control on the selected audio stream.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_DisableEchoCanceller

(

le_audio_StreamRef_t

streamRef

)

This function must be called to disable the Echo Canceller.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_DisableFirFilter

(

le_audio_StreamRef_t

streamRef

)

This function must be called to disable the FIR (Finite Impulse Response) filter.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_DisableIirFilter

(

le_audio_StreamRef_t

streamRef

)

This function must be called to disable the IIR (Infinite Impulse Response) filter.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_DisableNoiseSuppressor

(

le_audio_StreamRef_t

streamRef

)

This function must be called to disable the Noise Suppressor.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

void le_audio_Disconnect	(	le_audio_ConnectorRef_t	connectorRef,
		le_audio_StreamRef_t	streamRef
	)

Disconnect an audio stream from the connector reference.

Note

If the caller is passing a bad reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	connectorRef	Connector reference.
[in]	streamRef	Audio stream reference.

void le_audio_DisconnectService

(

void

)

Disconnect the client from the service

le_result_t le_audio_EnableAutomaticGainControl

(

le_audio_StreamRef_t

streamRef

)

This function must be called to enable the automatic gain control on the selected audio stream.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_EnableEchoCanceller

(

le_audio_StreamRef_t

streamRef

)

This function must be called to enable the Echo Canceller.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_EnableFirFilter

(

le_audio_StreamRef_t

streamRef

)

This function must be called to enable the FIR (Finite Impulse Response) filter.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_EnableIirFilter

(

le_audio_StreamRef_t

streamRef

)

This function must be called to enable the IIR (Infinite Impulse Response) filter.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_result_t le_audio_EnableNoiseSuppressor

(

le_audio_StreamRef_t

streamRef

)

This function must be called to enable the Noise Suppressor.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Note

The process exits, if an invalid audio stream reference is given.

Parameters

[in]

streamRef

Audio stream reference.

le_audio_I2SChannel_t le_audio_GetDefaultI2sMode

(

void

)

Get the default I2S channel mode used on the current platform.

Returns

the I2S channel mode.

uint32_t le_audio_GetDefaultPcmTimeSlot

(

void

)

Get the default PCM time slot used on the current platform.

Returns

the time slot number.

le_result_t le_audio_GetFormat	(	le_audio_StreamRef_t	streamRef,
		char *	formatPtr,
		size_t	formatPtrNumElements
	)

Get the audio format of an input or output stream.

Returns

LE_FAULT Function failed.

LE_OK The function succeeded.

Note

The process exits, if an invalid audio stream reference is given or if the formatPtr pointer is NULL.

Parameters

[in]	streamRef	The audio stream reference.
[out]	formatPtr	The name of the audio encoding as used by the Real-Time Protocol (RTP), specified by the IANA organisation.
[in]	formatPtrNumElements

le_result_t le_audio_GetGain	(	le_audio_StreamRef_t	streamRef,
		uint32_t *	gainPtr
	)

Get the Gain value of an input or output stream.

Returns

LE_FAULT Function failed.

LE_BAD_PARAMETER Audio stream reference is invalid.

LE_OK Function succeeded.

Note

The hardware may or may not support the full 0-100 resolution, and if you want to see what was actually set call le_audio_GetGain() after le_audio_SetGain() to get the real value.

If the caller is passing a bad reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	streamRef	Audio stream reference.
[out]	gainPtr	Gain value [0..100] (0 means 'muted', 100 is the maximum gain value)

le_audio_Companding_t le_audio_GetPcmCompanding

(

void

)

Retrieve the PCM Companding.

Returns

The PCM companding.

uint32_t le_audio_GetPcmSamplingRate

(

void

)

Retrieve the PCM Sampling Rate.

Returns

The sampling rate in Hz.

uint32_t le_audio_GetPcmSamplingResolution

(

void

)

Retrieve the PCM Sampling Resolution.

Returns

The sampling resolution (bits/sample).

le_result_t le_audio_GetProfile

(

le_audio_Profile_t *

profilePtr

)

This function must be called to get the audio profile in use.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Parameters

[out]

profilePtr

The audio profile.

le_result_t le_audio_Mute

(

le_audio_StreamRef_t

streamRef

)

Mute an audio stream.

Returns

LE_FAULT Function failed.

LE_BAD_PARAMETER Audio stream reference is invalid.

LE_OK Function succeeded.

Note

If the caller is passing a bad reference into this function, it is a fatal error, the function will not return.

Parameters

[in]

streamRef

The audio stream reference.

le_audio_StreamRef_t le_audio_OpenFilePlayback

(

int

fd

)

Open the audio stream for file playback.

Returns

Reference to the audio stream, NULL if the function fails.

Parameters

[in]

fd

The file descriptor.

le_audio_StreamRef_t le_audio_OpenFileRecording

(

int

fd

)

Open the audio stream for file recording.

Returns

Reference to the audio stream, NULL if the function fails.

Parameters

[in]

fd

The file descriptor.

le_audio_StreamRef_t le_audio_OpenI2sRx

(

le_audio_I2SChannel_t

mode

)

Open the received audio stream of the I2S interface.

Returns

Reference to the input audio stream, NULL if the function fails.

Parameters

[in]

mode

The channel mode.

le_audio_StreamRef_t le_audio_OpenI2sTx

(

le_audio_I2SChannel_t

mode

)

Open the transmitted audio stream of the I2S interface.

Returns

Reference to the output audio stream, NULL if the function fails.

Parameters

[in]

mode

The channel mode.

le_audio_StreamRef_t le_audio_OpenMic

(

void

)

Open the Microphone.

Returns

Reference to the input audio stream, NULL if the function fails.

le_audio_StreamRef_t le_audio_OpenModemVoiceRx

(

void

)

Open the received audio stream of a voice call.

Returns

Reference to the input audio stream, NULL if the function fails.

le_audio_StreamRef_t le_audio_OpenModemVoiceTx

(

void

)

Open the transmitted audio stream of a voice call.

Returns

Reference to the output audio stream, NULL if the function fails.

le_audio_StreamRef_t le_audio_OpenPcmRx

(

uint32_t

timeslot

)

Open the received audio stream of the PCM interface.

Returns

Reference to the input audio stream, NULL if the function fails.

Parameters

[in]

timeslot

The time slot number.

le_audio_StreamRef_t le_audio_OpenPcmTx

(

uint32_t

timeslot

)

Open the transmitted audio stream of the PCM interface.

Returns

Reference to the output audio stream, NULL if the function fails.

Parameters

[in]

timeslot

The time slot number.

le_audio_StreamRef_t le_audio_OpenSpeaker

(

void

)

Open the Speakerphone.

Returns

Reference to the output audio stream, NULL if the function fails.

le_audio_StreamRef_t le_audio_OpenUsbRx

(

void

)

Open the received audio stream of an USB audio class.

Returns

Reference to the input audio stream, NULL if the function fails.

le_audio_StreamRef_t le_audio_OpenUsbTx

(

void

)

Open the transmitted audio stream of an USB audio class.

Returns

Reference to the output audio stream, NULL if the function fails.

void le_audio_RemoveDtmfDetectorHandler

(

le_audio_DtmfDetectorHandlerRef_t

addHandlerRef

)

le_audio_DtmfDetectorHandler handler REMOVE function

Parameters

[in]

addHandlerRef

le_result_t le_audio_SetGain	(	le_audio_StreamRef_t	streamRef,
		uint32_t	gain
	)

Set the Gain value of an input or output stream.

Returns

LE_FAULT Function failed.

LE_BAD_PARAMETER Audio stream reference is invalid.

LE_OUT_OF_RANGE Gain parameter is not between 0 and 100

LE_OK Function succeeded.

Note

The hardware may or may not support the full 0-100 resolution, and if you want to see what was actually set call le_audio_GetGain() after le_audio_SetGain() to get the real value.

If the caller is passing a bad reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	streamRef	Audio stream reference.
[in]	gain	Gain value [0..100] (0 means 'muted', 100 is the maximum gain value)

le_result_t le_audio_SetPcmCompanding

(

le_audio_Companding_t

companding

)

Configure the PCM Companding.

Returns

LE_FAULT Function failed.

LE_OUT_OF_RANGE Your platform does not support the setting's value.

LE_BUSY The PCM interface is already active.

LE_OK Function succeeded.

Parameters

[in]

companding

Companding.

le_result_t le_audio_SetPcmSamplingRate

(

uint32_t

rate

)

Configure the PCM Sampling Rate.

Returns

LE_FAULT Function failed.

LE_OUT_OF_RANGE Your platform does not support the setting's value.

LE_BUSY The PCM interface is already active.

LE_OK Function succeeded.

Parameters

[in]

rate

Sampling rate in Hz.

le_result_t le_audio_SetPcmSamplingResolution

(

uint32_t

bitsPerSample

)

Configure the PCM Sampling Resolution.

Returns

LE_FAULT Function failed.

LE_OUT_OF_RANGE Your platform does not support the setting's value.

LE_BUSY The PCM interface is already active.

LE_OK Function succeeded.

Parameters

[in]

bitsPerSample

Sampling resolution (bits/sample).

le_result_t le_audio_SetProfile

(

le_audio_Profile_t

profile

)

This function must be called to set the audio profile.

Returns

LE_FAULT Function failed.

LE_OK Function succeeded.

Parameters

[in]

profile

The audio profile.

le_result_t le_audio_Unmute

(

le_audio_StreamRef_t

streamRef

)

Unmute an audio stream.

Returns

LE_FAULT Function failed.

LE_BAD_PARAMETER Audio stream reference is invalid.

LE_OK Function succeeded.

Note

If the caller is passing a bad reference into this function, it is a fatal error, the function will not return.

Parameters

[in]

streamRef

Audio stream reference.