SG_Com.h

Go to the documentation of this file.

 
#ifndef SG_COM_H
#define SG_COM_H
 
#include "SG.h"

#define SG_COM_VERSION_NAME "5.2.0"
 
#ifdef __cplusplus
extern "C" {
#endif

    typedef enum {
        SG_COM_ERROR_OK, 
        SG_COM_ERROR_LOW_MEMORY, 
        SG_COM_ERROR_INVALID_LICENSE, 
        SG_COM_ERROR_INVALID_HANDLE, 
        SG_COM_ERROR_INVALID_PACKET, 
        SG_COM_ERROR_INVALID_PARAM, 
        SG_COM_ERROR_TICK_IN_PROGRESS, 
        SG_COM_ERROR_OUT_OF_ORDER_PACKET_DISCARDED, 
        SG_COM_ERROR_INPUT_OVERRUN, 
        SG_COM_ERROR_INPUT_UNDERRUN, 
        SG_COM_ERROR_EXCEPTION, 
        SG_COM_ERROR_NOT_IMPLEMENTED, 
        SG_COM_ERROR_UNDEFINED, 
        SG_COM_ERROR_LICENSE_CHECKOUT_FAILURE,  
        SG_COM_ERROR_CONTEXT_NOT_INITIALIZED, 
        SG_COM_ERROR_CONTEXT_ALREADY_INITIALIZED 
    } SG_COM_Error;

    typedef enum {
        SG_COM_STATUS_MODE_CHANGED, 
        SG_COM_STATUS_AUTO_MODE_CHANGED, 
        SG_COM_STATUS_EXPRESSION_CHANGED, 
        SG_COM_STATUS_VOICE_ACTIVITY_CHANGED, 
        SG_COM_STATUS_BREATH_CHANGED 
    } SG_COM_Status;

    typedef enum {
        SG_COM_MOD_SPEECH_MAG, 
        SG_COM_MOD_NONVERBAL_MAG, 
        SG_COM_MOD_NONVERBAL_SPEED, 
        SG_COM_MOD_BREATH_MAG,  
        SG_COM_MOD_BREATH_SPEED,  
        SG_COM_MOD_EXPRESSION_FREQ, 
        SG_COM_MOD_BLINK_FREQ, 
        SG_COM_MOD_DART_FREQ  
    } SG_COM_Modifier;

    typedef enum {
        SG_COM_ROLE_SPEAK, 
        SG_COM_ROLE_LISTEN 
    } SG_COM_Role;
    
    typedef enum {
        SG_COM_POSITIVE_MODE, 
        SG_COM_NEGATIVE_MODE, 
        SG_COM_EFFORT_MODE, 
        SG_COM_LAUGH_MODE, 
        SG_COM_ACKNOWLEDGE_MODE 
    } SG_COM_AutoMode;

    typedef struct SG_COM_PlayerConfig {
        sg_byte* character_file_in_memory; 
        sg_size character_file_bytes; 
        float buffer_sec; 
    } SG_COM_PlayerConfig;

    typedef struct SG_COM_Player* SG_COM_PlayerHandle;

    typedef struct SG_COM_Engine* SG_COM_EngineHandle;

    typedef void(*SG_COM_EngineBroadcastCallback) (
        SG_COM_EngineHandle engine_handle,
        char* packet,
        sg_size packet_bytes,
        void* custom_engine_data);

    typedef void(*SG_COM_EngineStatusCallback) (
        SG_COM_EngineHandle engine_handle,
        SG_COM_Status status,
        const char *message,
        void* custom_engine_data);

    typedef enum {
        SG_COM_ENGINE_CONFIG_NONE = 0,
        SG_COM_ENGINE_CONFIG_ENABLE_IDLE = 1,  
        SG_COM_ENGINE_CONFIG_FIXED_RANDOM_SEED = 2  
    } SG_COM_EngineConfigFlag;

    typedef struct SG_COM_EngineConfig {
        sg_byte* character_file_in_memory; 
        sg_size character_file_bytes; 
        SG_AudioSampleType audio_sample_type; 
        SG_AudioSampleRate audio_sample_rate; 
        SG_COM_PlayerHandle local_player; 
        SG_COM_EngineBroadcastCallback engine_broadcast_callback; 
        SG_COM_EngineStatusCallback engine_status_callback; 
        float buffer_sec; 
        SG_COM_EngineConfigFlag flag; 
        void *custom_engine_data; 
    } SG_COM_EngineConfig;

    SG_DYN const char *SG_COM_GetExceptionText(void);

 
    SG_DYN SG_COM_Error SG_COM_Initialize(SG_LoggingLevel logging_level, SG_LoggingCallback logging_callback, const char* license_data, const char* license_unique_id, const char* license_custom_data);

    SG_DYN SG_COM_Error SG_COM_Shutdown(void);

    SG_DYN const char* SG_COM_GetVersionString(void);

    SG_DYN unsigned int SG_COM_GetVersionNumber(void);

    SG_DYN SG_COM_Error SG_COM_CreateEngine(
        const SG_COM_EngineConfig *engine_config,
        SG_COM_EngineHandle *engine_handle
    );

    SG_DYN SG_COM_Error SG_COM_CreateAltEngine(
        const SG_COM_EngineConfig* engine_config,
        SG_COM_EngineHandle* engine_handle,
        const unsigned char* algorithms_file,
        unsigned int algorithms_file_size
    );

    SG_DYN SG_COM_Error SG_COM_DestroyEngine(
        SG_COM_EngineHandle engine_handle
    );

    SG_DYN SG_COM_Error SG_COM_InputAudio(
        SG_COM_EngineHandle engine_handle,
        const void* data,
        sg_size data_bytes
    );

    SG_DYN SG_COM_Error SG_COM_InputAuxData(
        SG_COM_EngineHandle engine_handle,
        const void* data,
        sg_size data_bytes
    );

    SG_DYN SG_COM_Error SG_COM_ProcessTick(
        SG_COM_EngineHandle engine_handle,
        int *processed_frames,
        int *remaining_frames
    );

    SG_DYN SG_COM_Error SG_COM_Reset(
        SG_COM_EngineHandle engine_handle
    );
    
    SG_DYN SG_COM_Error SG_COM_SetMode(
        SG_COM_EngineHandle engine_handle,
        const char* mode
    );
    
    SG_DYN SG_COM_Error SG_COM_SetDefaultMode(
        SG_COM_EngineHandle engine_handle,
        const char* mode
    );

    SG_DYN SG_COM_Error SG_COM_SetAutoMode(
        SG_COM_EngineHandle engine_handle,
        SG_COM_AutoMode auto_mode,
        const char* mode
    );
    
    SG_DYN SG_COM_Error SG_COM_UnsetAutoModes(
        SG_COM_EngineHandle engine_handle
    );
    
    SG_DYN SG_COM_Error SG_COM_ActivateAutoModes(
        SG_COM_EngineHandle engine_handle
    );  
    
    SG_DYN SG_COM_Error SG_COM_InsertExpression(
        SG_COM_EngineHandle engine_handle,
        const char* expression,
        sg_size duration_ms,
        float scale
    );  
    
    SG_DYN SG_COM_Error SG_COM_GetMode(
        SG_COM_EngineHandle engine_handle,
        char* mode,
        sg_size buffersize
    );

    SG_DYN SG_COM_Error SG_COM_GetModeList(
        SG_COM_EngineHandle engine_handle,
        char* mode_list,
        sg_size buffersize
    );

    SG_DYN SG_COM_Error SG_COM_SetRole(
        SG_COM_EngineHandle engine_handle,
        SG_COM_Role role
    );

    SG_DYN SG_COM_Error SG_COM_GetRole(
        SG_COM_EngineHandle engine_handle,
        SG_COM_Role *role
    );

    SG_DYN SG_COM_Error SG_COM_GetModifier(
        SG_COM_EngineHandle engine_handle,
        SG_COM_Modifier modifier,
        float *value
    );

    SG_DYN SG_COM_Error SG_COM_SetModifier(
        SG_COM_EngineHandle engine_handle,
        SG_COM_Modifier modifier,
        float value
    );

    SG_DYN SG_COM_Error SG_COM_CreatePlayer(
        const SG_COM_PlayerConfig *player_config,
        SG_COM_PlayerHandle *player_handle
    );

    SG_DYN SG_COM_Error SG_COM_DestroyPlayer(
        SG_COM_PlayerHandle player_handle
    );

    SG_DYN SG_COM_Error SG_COM_ReceivePacket(
        SG_COM_PlayerHandle player_handle,
        const char *packet,
        sg_size packet_bytes
    );

    SG_DYN SG_COM_Error SG_COM_GetAnimationNodes(
        SG_COM_PlayerHandle player_handle,
        SG_AnimationNode **animation_nodes,
        sg_size *num_animation_nodes
    );

    SG_DYN SG_COM_Error SG_COM_UpdateAnimation(
        SG_COM_PlayerHandle player_handle,
        double time_ms,
        double *current_time_ms
    );

    SG_DYN SG_COM_Error SG_COM_GetPlayableRange(
        SG_COM_PlayerHandle player_handle,
        double* min_time_ms,
        double* max_time_ms
    );
 
#ifdef __cplusplus
}
#endif
 
#endif // SG_ANIMATION_DLL_H