taf_audio_common.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */
#ifndef TAF_AUDIO_COMMON_H_INCLUDE_GUARD
#define TAF_AUDIO_COMMON_H_INCLUDE_GUARD


#include "legato.h"

#define IFGEN_TAF_AUDIO_PROTOCOL_ID "f57414d573e5db3c9de28d2cfb55097d"
#define IFGEN_TAF_AUDIO_MSG_SIZE 124



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_AUDIO_DTMF_MAXLEN 100

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_AUDIO_NO_FD -1

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_audio_Stream* taf_audio_StreamRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_audio_Connector* taf_audio_ConnectorRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_AUDIO_MEDIA_ENDED = 0,
    TAF_AUDIO_MEDIA_NO_MORE_SAMPLES = 1,
    TAF_AUDIO_MEDIA_ERROR = 2,
    TAF_AUDIO_MEDIA_MAX = 3
}
taf_audio_MediaEvent_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_audio_MediaHandler* taf_audio_MediaHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_audio_DtmfDetectorHandler* taf_audio_DtmfDetectorHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_AUDIO_WAVE = 0,
    TAF_AUDIO_AMR = 1,
    TAF_AUDIO_FORMAT_MAX = 2
}
taf_audio_Format_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_AUDIO_AMR_NONE = 0,
    TAF_AUDIO_AMR_NB_4_75_KBPS = 1,
    TAF_AUDIO_AMR_NB_5_15_KBPS = 2,
    TAF_AUDIO_AMR_NB_5_9_KBPS = 3,
    TAF_AUDIO_AMR_NB_6_7_KBPS = 4,
    TAF_AUDIO_AMR_NB_7_4_KBPS = 5,
    TAF_AUDIO_AMR_NB_7_95_KBPS = 6,
    TAF_AUDIO_AMR_NB_10_2_KBPS = 7,
    TAF_AUDIO_AMR_NB_12_2_KBPS = 8,
    TAF_AUDIO_AMR_WB_6_6_KBPS = 9,
    TAF_AUDIO_AMR_WB_8_85_KBPS = 10,
    TAF_AUDIO_AMR_WB_12_65_KBPS = 11,
    TAF_AUDIO_AMR_WB_14_25_KBPS = 12,
    TAF_AUDIO_AMR_WB_15_85_KBPS = 13,
    TAF_AUDIO_AMR_WB_18_25_KBPS = 14,
    TAF_AUDIO_AMR_WB_19_85_KBPS = 15,
    TAF_AUDIO_AMR_WB_23_05_KBPS = 16,
    TAF_AUDIO_AMR_WB_23_85_KBPS = 17
}
taf_audio_AmrMode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_AUDIO_I2S_LEFT = 0,
    TAF_AUDIO_I2S_RIGHT = 1,
    TAF_AUDIO_I2S_MONO = 2,
    TAF_AUDIO_I2S_STEREO = 3,
    TAF_AUDIO_I2S_REVERSE = 4
}
taf_audio_I2SChannel_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_audio_MediaHandlerFunc_t)
(
        taf_audio_StreamRef_t streamRef,
        taf_audio_MediaEvent_t event,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_audio_DtmfDetectorHandlerFunc_t)
(
        taf_audio_StreamRef_t streamRef,
        char dtmf,
        void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_audio_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_audio_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_audio_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_audio_Close
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t sRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_ConnectorRef_t ifgen_taf_audio_CreateConnector
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_audio_DeleteConnector
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_ConnectorRef_t connRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_Connect
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_ConnectorRef_t connRef,
        taf_audio_StreamRef_t sRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_audio_Disconnect
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_ConnectorRef_t connRef,
        taf_audio_StreamRef_t sRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenSpeaker
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenMic
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenModemVoiceRx
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t slotId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenModemVoiceTx
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t slotId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_PlayDtmf
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        const char* LE_NONNULL dtmf,
        uint32_t duration,
        uint32_t pause
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_Mute
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_Unmute
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPlayer
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_PlayFile
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        int fd
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenRecorder
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_RecordFile
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        int fd
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_MediaHandlerRef_t ifgen_taf_audio_AddMediaHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        taf_audio_MediaHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_audio_RemoveMediaHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_MediaHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_DtmfDetectorHandlerRef_t ifgen_taf_audio_AddDtmfDetectorHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        taf_audio_DtmfDetectorHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_audio_RemoveDtmfDetectorHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_DtmfDetectorHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_Stop
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_SetGain
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        int32_t gain
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_GetGain
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        int32_t* gainPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_EnableNoiseSuppressor
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_EnableEchoCanceller
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_DisableNoiseSuppressor
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_DisableEchoCanceller
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_IsEchoCancellerEnabled
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        bool* statusPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_IsNoiseSuppressorEnabled
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        bool* statusPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenI2sRx
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_I2SChannel_t mode
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenI2sTx
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_I2SChannel_t mode
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPcmRx
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t timeslot
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_audio_StreamRef_t ifgen_taf_audio_OpenPcmTx
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t timeslot
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_SetSamplePcmSamplingRate
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        uint32_t rate
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_GetSamplePcmSamplingRate
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        uint32_t* ratePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_SetSamplePcmChannelNumber
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        uint32_t nbChannel
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_GetSamplePcmChannelNumber
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        uint32_t* nbChannelPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_SetEncodingFormat
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        taf_audio_Format_t format
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_audio_GetEncodingFormat
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_audio_StreamRef_t streamRef,
        taf_audio_Format_t* formatPtr
);

#endif // TAF_AUDIO_COMMON_H_INCLUDE_GUARD