voice.h

Go to the documentation of this file.

 
#ifndef __TBOX_VOICE_H__
#define __TBOX_VOICE_H__
 
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C"
{
#endif


#define TBOX_RIL_PHONE_NUMBER_MAX 32U
#define TBOX_RIL_ECALL_MSD_MAX 140U

typedef enum
{
    TBOX_CALL_UNKNOWN  = 0, 
    TBOX_CALL_DIALING  = 1, 
    TBOX_CALL_ALERTING = 2, 
    TBOX_CALL_INCOMING = 3, 
    TBOX_CALL_ACTIVE   = 4, 
    TBOX_CALL_HELD     = 5, 
    TBOX_CALL_ENDED    = 6, 
    TBOX_CALL_WAITING  = 7, 
} tbox_call_status_t;

typedef enum
{
    TBOX_CALL_VOICE     = 0, 
    TBOX_CALL_EMERGENCY = 1, 
} tbox_call_type_t;

typedef enum
{
    TBOX_ECALL_AUTOMATIC = 0, 
    TBOX_ECALL_MANUAL    = 1, 
} tbox_ecall_trigger_t;

typedef enum
{
    TBOX_ECALL_TEST        = 0, 
    TBOX_ECALL_EMERGENCY   = 1, 
    TBOX_ECALL_RECONFIGURE = 2, 
} tbox_ecall_variant_t;

typedef enum
{
    TBOX_ECALL_TEST_NUMBER = 0, 
    TBOX_ECALL_TEST_URI    = 1, 
} tbox_ecall_number_type_t;

typedef enum
{
    TBOX_VOICE_SLOT_1   = 0, 
    TBOX_VOICE_SLOT_2   = 1, 
    TBOX_VOICE_EMBEDDED = 2, 
    TBOX_VOICE_REMOTE   = 3, 
} tbox_voice_slot_t;

typedef enum
{
    TBOX_VOICE_AUDIO_CODEC = 0, 
    TBOX_VOICE_AUDIO_RTP   = 1, 
} tbox_voice_audio_mode_t;

typedef enum
{
    TBOX_ECALL_UNKNOWN                = 0,  
    TBOX_ECALL_STARTING               = 1,  
    TBOX_ECALL_SENDING_MSD            = 2,  
    TBOX_ECALL_MSD_ACKNOWLEDGED       = 3,  
    TBOX_ECALL_DIALING                = 4,  
    TBOX_ECALL_ALERTING               = 5,  
    TBOX_ECALL_ACTIVE                 = 6,  
    TBOX_ECALL_DISCONNECTED           = 7,  
    TBOX_ECALL_FAILED                 = 8,  
    TBOX_ECALL_CALLBACK               = 9,  
    TBOX_ECALL_LLACK_RECEIVED         = 10, 
    TBOX_ECALL_CLEARDOWN_RECEIVED     = 11, 
    TBOX_ECALL_MSD_NOT_ACKNOWLEDGED   = 12, 
    TBOX_ECALL_UPDATE_MSD             = 13, 
    TBOX_ECALL_IN_BAND_TRANSFER       = 14, 
    TBOX_ECALL_SRVCC                  = 15, 
    TBOX_ECALL_ONLY_DEREGISTRATION    = 16, 
    TBOX_ECALL_MAY_DEREGISTER         = 17, 
    TBOX_ECALL_CALLBACK_UPDATE_MSD    = 18, 
    TBOX_ECALL_SENDING_START_IN_VOICE = 19, 
    TBOX_ECALL_T2_TIMEOUT             = 20, 
    TBOX_ECALL_T5_TIMEOUT             = 21, 
    TBOX_ECALL_T6_TIMEOUT             = 22, 
    TBOX_ECALL_T7_TIMEOUT             = 23, 
    TBOX_ECALL_REDIAL_TIMEOUT         = 24, 
    TBOX_ECALL_AUTO_ANSWER_TIMEOUT    = 25, 
    TBOX_ECALL_START_SUCCEEDED        = 26, 
    TBOX_ECALL_START_FAILED           = 27, 
    TBOX_ECALL_START_NO_RETRY         = 28, 
} tbox_ecall_status_t;

typedef struct
{
    tbox_call_type_t  type;                              
    tbox_voice_slot_t slot;                              
    char              number[TBOX_RIL_PHONE_NUMBER_MAX]; 
} tbox_voice_dial_request_t;

typedef struct
{
    uint32_t           id;                                
    tbox_call_status_t status;                            
    char               number[TBOX_RIL_PHONE_NUMBER_MAX]; 
} tbox_call_event_t;

typedef struct
{
    tbox_ecall_trigger_t trigger;    
    tbox_ecall_variant_t variant;    
    const uint8_t*       msd;        
    size_t               msd_length; 
} tbox_ecall_request_t;

typedef struct
{
    uint32_t            call_id; 
    tbox_ecall_status_t status;  
} tbox_ecall_event_t;

typedef enum
{
    TBOX_VOICE_EVENT_CALL  = 1, 
    TBOX_VOICE_EVENT_ECALL = 2, 
} tbox_voice_event_type_t;

typedef struct
{
    tbox_voice_event_type_t type; 
    union
    {
        tbox_call_event_t  call;  
        tbox_ecall_event_t ecall; 
    } data;                       
} tbox_voice_event_t;

typedef void (*tbox_voice_callback_t)(const tbox_voice_event_t* event, void* context);

int tbox_voice_register_callback(tbox_voice_callback_t callback, void* context);

int tbox_voice_unregister_callback(void);

int tbox_voice_dial(const tbox_voice_dial_request_t* request, uint32_t* call_id);

int tbox_voice_answer(uint32_t call_id);

int tbox_voice_hangup(uint32_t call_id);

int tbox_voice_switch_active(void);

int tbox_voice_send_dtmf(char digit);

int tbox_voice_set_volume(uint32_t volume);

int tbox_voice_get_volume(uint32_t* volume);

int tbox_voice_set_audio_mode(tbox_voice_audio_mode_t mode);

int tbox_voice_get_audio_mode(tbox_voice_audio_mode_t* mode);

int tbox_voice_get_call(uint32_t call_id, tbox_call_event_t* call, size_t* length);

int tbox_voice_start_ecall(const tbox_ecall_request_t* request);

int tbox_voice_set_ecall_test_number(tbox_ecall_number_type_t type, const char* number);

int tbox_voice_set_ecall_msd(uint32_t call_id, const uint8_t* data, size_t length);

 
#ifdef __cplusplus
}
#endif
 
#endif /* __TBOX_VOICE_H__ */