sound4.bigvoice.cl.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __unix__
    #include <sys/types.h>
    #define BIGVOICE_DECL       __attribute__ ((visibility ("default")))
#elif defined(_WIN32) || defined(WIN32)
    #include <windows.h>
    #ifdef BUILDING_BIGVOICE_DLL
        #define BIGVOICE_DECL   __declspec(dllexport)
    #else
        #define BIGVOICE_DECL   __declspec(dllimport)
    #endif
    #ifdef _MSC_VER
        #pragma warning(disable : 4996)
    #endif
#elif defined(__APPLE__)
    #include <sys/types.h>
    #define BIGVOICE_DECL       __attribute__ ((visibility ("default")))
#endif
#include <stdint.h>
 
#define BIGVOICE_HAS_WEBSERVER 1
#define BIGVOICE_HAS_CLOUDBUS 1
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
// --------------------------------------------------------------
#define BIGVOICE_AUDIOFRAME_COUNT      12
#define BIGVOICE_CHANNEL_COUNT          1
#define BIGVOICE_AUDIO_INPUT_COUNT      1
#define BIGVOICE_AUDIO_OUTPUT_COUNT     1
#define BIGVOICE_SAMPLE_RATE            48000
 
struct SOUND4_ProcessInfo {
    size_t struct_size;         
    const char *name;           
    const char *prefix;         
    const char *shortname;      
    const char *version;        
};
 
BIGVOICE_DECL const struct SOUND4_ProcessInfo* SOUND4_GetProcessInfo();
 
BIGVOICE_DECL const char *bigvoice_GetVersion();
 
BIGVOICE_DECL unsigned int bigvoice_GetChunkSizeInFrames();
 
BIGVOICE_DECL unsigned int* bigvoice_GetPossibleChunkSizeInFrames();
 
BIGVOICE_DECL unsigned int bigvoice_GetChannelCount();
 
BIGVOICE_DECL unsigned int bigvoice_GetAudioInputCount();
 
BIGVOICE_DECL unsigned int bigvoice_GetAudioOutputCount();
 
BIGVOICE_DECL unsigned int bigvoice_GetSampleRate();
 
enum bigvoice_LogSeverity {
    none     = 0,      
    fatal    = 1,      
    error    = 2,      
    warning  = 3,      
    info     = 4,      
    verbose  = 5,      
    verbose2 = 6,      
    verbose3 = 7,      
    verbose4 = 8,      
    verbose5 = 9,      
};
 
typedef void (*bigvoice_loggerfn) (enum bigvoice_LogSeverity, const char *);
 
BIGVOICE_DECL void bigvoice_SetLoggerCallback( bigvoice_loggerfn logger );
 
BIGVOICE_DECL void bigvoice_SetLogSeverity( enum bigvoice_LogSeverity severity );
 
// --------------------------------------------------------------
// --------------------------------------------------------------
struct bigvoice_CInstance;
 
struct bigvoice_CParameters;
 
BIGVOICE_DECL struct bigvoice_CParameters *bigvoice_NewParameters();
 
BIGVOICE_DECL void bigvoice_FreeParameters(struct bigvoice_CParameters *params);
 
BIGVOICE_DECL void bigvoice_SetParameter(struct bigvoice_CParameters *params, const char *name, const char *value);
 
BIGVOICE_DECL const char *bigvoice_GetParameter(struct bigvoice_CParameters *params, const char *name);
 
BIGVOICE_DECL void bigvoice_FreeParameterValue(const char *value);
 
BIGVOICE_DECL struct bigvoice_CInstance *bigvoice_InitProcess(
        const char *LoginKey,
        const char *RadioName,
        const char *Access_Key_ID,
        const char *Access_Key_Secret,
        const char *save_path
    );
 
BIGVOICE_DECL struct bigvoice_CInstance *bigvoice_InitProcess2(
        const char *LoginKey,
        const char *RadioName,
        const char *Access_Key_ID,
        const char *Access_Key_Secret,
        const char *save_path,
        const struct bigvoice_CParameters *parameters
    );
 
BIGVOICE_DECL struct bigvoice_CInstance *bigvoice_InitProcess3(
        const char *LoginKey,
        const char *RadioName,
        const char *Access_Key_ID,
        const char *Access_Key_Secret,
        const char *save_path,
        const struct bigvoice_CParameters *parameters,
        unsigned int frames_per_chunk
    );
 
BIGVOICE_DECL unsigned int bigvoice_GetProcessChunkFrames(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL int bigvoice_TerminateProcess(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL void bigvoice_ExitProcess(struct bigvoice_CInstance *instance);
 
#if BIGVOICE_HAS_CLOUDBUS
// --------------------------------------------------------------
struct bigvoice_CBus;
 
BIGVOICE_DECL struct bigvoice_CBus* bigvoice_NewBus();
 
BIGVOICE_DECL void bigvoice_FreeBus(struct bigvoice_CBus *bus);
 
BIGVOICE_DECL void bigvoice_SetInstanceBus(struct bigvoice_CParameters *params, struct bigvoice_CBus *bus);
 
 
#endif // BIGVOICE_HAS_CLOUDBUS
 
// --------------------------------------------------------------
//   Tracing (Windows only)
// --------------------------------------------------------------
#ifdef _WIN32
#ifndef TLG_HAVE_EVENT_SET_INFORMATION // TraceLoggingProvider.h has not been included
    struct _tlgProvider_t;
    typedef struct _tlgProvider_t const* TraceLoggingHProvider;
#endif // !TLG_HAVE_EVENT_SET_INFORMATION
// --------------------------------------------------------------
BIGVOICE_DECL void bigvoice_SetInstanceTracing(struct bigvoice_CParameters *params, TraceLoggingHProvider tracing_provider, GUID activity_guid);
 
BIGVOICE_DECL void bigvoice_SetInstanceTracingProcessActivity(struct bigvoice_CInstance *instance, GUID activity_guid);
 
#endif // _WIN32
 
// --------------------------------------------------------------
// --------------------------------------------------------------
 
// OS dependent filesystem path char type
#ifdef _WIN32
    typedef wchar_t fs_char;
#else // !_WIN32
    typedef char fs_char;
#endif // !_WIN32
 
typedef char * (*bigvoice_storage_reader) (const fs_char *filename, void* userdata);
 
typedef void (*bigvoice_storage_reader_free) (char *content, void* userdata);
 
typedef int (*bigvoice_storage_writer) (const fs_char *filename, const char *content, void* userdata);
 
typedef int (*bigvoice_storage_exists) (const fs_char *filename, void* userdata);
 
typedef fs_char** (*bigvoice_storage_getall) (void* userdata);
 
typedef void (*bigvoice_storage_getall_free) (fs_char**all, void* userdata);
 
typedef int (*bigvoice_storage_remove) (const fs_char *filename, void* userdata);
 
typedef int (*bigvoice_storage_rename) (const fs_char *from, const fs_char *to, void* userdata);
 
BIGVOICE_DECL void bigvoice_SetPresetManager(struct bigvoice_CParameters *params
    , bigvoice_storage_reader reader, bigvoice_storage_reader_free
    , bigvoice_storage_writer writer
    , bigvoice_storage_exists exists
    , bigvoice_storage_getall getall, bigvoice_storage_getall_free getall_free
    , bigvoice_storage_remove remove
    , bigvoice_storage_rename rename
    , int IsReadOnly
    , void* userdata
    );
 
enum bigvoice_PresetChange_Kind {
    change_kind_created = 1,    
    change_kind_modified   ,    
    change_kind_deleted    ,    
};
 
BIGVOICE_DECL void bigvoice_PresetManager_InformChange(struct bigvoice_CInstance *instance, const fs_char *relative_path, enum bigvoice_PresetChange_Kind change_kind);
 
// --------------------------------------------------------------
// --------------------------------------------------------------
 
BIGVOICE_DECL void bigvoice_SetMetadata(struct bigvoice_CInstance *instance, const char* key, const char* value);
 
BIGVOICE_DECL void bigvoice_SetMetadataMulti(struct bigvoice_CInstance *instance, const char** keyvalue);
 
BIGVOICE_DECL const char** bigvoice_GetMetadataInfos(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL void bigvoice_FreeMetadataInfos(struct bigvoice_CInstance *instance, const char** infos);
 
// --------------------------------------------------------------
// --------------------------------------------------------------
 
BIGVOICE_DECL void bigvoice_StartUpdateThread(struct bigvoice_CInstance *instance, unsigned int port);
 
BIGVOICE_DECL void bigvoice_StopUpdateThread(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL int bigvoice_WaitUpdateThreadReady(struct bigvoice_CInstance *instance, int milliseconds);
 
// --------------------------------------------------------------
// --------------------------------------------------------------
BIGVOICE_DECL void bigvoice_ProcessAudio(struct bigvoice_CInstance *instance, const float *input, float *output );
 
BIGVOICE_DECL void bigvoice_ProcessAudio_Planar(struct bigvoice_CInstance *instance
    , float const * const *input
    , float * const *output);
 
BIGVOICE_DECL float *bigvoice_GetBufferIn(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL float *bigvoice_GetBufferOut(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL unsigned int bigvoice_GetEstimatedDelay(struct bigvoice_CInstance *instance);
 
// --------------------------------------------------------------
// --------------------------------------------------------------
struct SOUND4_AuxiliaryOutputInfos {
    char *id;             
    char *description;    
    unsigned int sample_rate;   
    unsigned int channel_count; 
    const float *buffer;        
};
 
BIGVOICE_DECL struct SOUND4_AuxiliaryOutputInfos** bigvoice_GetAuxiliaryAudioOutputInfos(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL void bigvoice_FreeAuxiliaryAudioInfos(struct SOUND4_AuxiliaryOutputInfos** infos);
 
BIGVOICE_DECL int bigvoice_ActivateAuxiliaryAudioID(struct bigvoice_CInstance *instance, const char* id);
 
BIGVOICE_DECL unsigned int bigvoice_GetAuxiliaryAudioEstimatedDelay(struct bigvoice_CInstance *instance, const char* id);
 
// --------------------------------------------------------------
// --------------------------------------------------------------
    #ifdef _MSC_VER
        #define __BYTE_ORDER__  REG_DWORD
        #define __ORDER_LITTLE_ENDIAN__ REG_DWORD_LITTLE_ENDIAN
        #define __ORDER_BIG_ENDIAN__    REG_DWORD_BIG_ENDIAN
    #endif
 
enum bigvoice_SampleFormat {
    INVALID_FORMAT=0,       
    S16_LE,                 
    S16_BE,                 
    S24_LE,                 
    S24_BE,                 
    S32_LE,                 
    S32_BE,                 
    F32_LE,                 
    F32_BE,                 
 
    // Native definitions, only links to the physical ones
    #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
        S16_NATIVE=S16_LE,  
        S24_NATIVE=S24_LE,  
        S32_NATIVE=S32_LE,  
        F32_NATIVE=F32_LE,  
    #else
        S16_NATIVE=S16_BE,  
        S24_NATIVE=S24_BE,  
        S32_NATIVE=S32_BE,  
        F32_NATIVE=F32_BE,  
    #endif
};
 
BIGVOICE_DECL const char *bigvoice_GetFormatName(const enum bigvoice_SampleFormat fmt);
 
BIGVOICE_DECL enum bigvoice_SampleFormat bigvoice_GetFormatFromName(const char *name);
 
BIGVOICE_DECL unsigned int bigvoice_GetBytesFromFormat(const enum bigvoice_SampleFormat fmt);
 
 
BIGVOICE_DECL unsigned int bigvoice_GetMaxPacketFrame(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL unsigned int bigvoice_AddAudio(struct bigvoice_CInstance *instance, const uint8_t *payload, unsigned int nFrame, enum bigvoice_SampleFormat fmt );
 
BIGVOICE_DECL unsigned int bigvoice_AddPadAudio(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL unsigned int bigvoice_GetOutputCount(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL unsigned int bigvoice_GetAudio(struct bigvoice_CInstance *instance, uint8_t *payload, unsigned int max_nFrame, enum bigvoice_SampleFormat fmt );
 
// --------------------------------------------------------------
// --------------------------------------------------------------
BIGVOICE_DECL void bigvoice_AudioConvertFrom(const uint8_t *payload, float *output, size_t nSpl, enum bigvoice_SampleFormat fmt);
 
BIGVOICE_DECL void bigvoice_AudioConvertTo(const float *input, uint8_t *payload, size_t nSpl, enum bigvoice_SampleFormat fmt);
 
BIGVOICE_DECL void bigvoice_StereoToMono(const float *input, float *output, size_t nFrame);
 
BIGVOICE_DECL void bigvoice_MonoToStereo(const float *input, float *output, size_t nFrame);
 
BIGVOICE_DECL void bigvoice_StereoToMono_Planar(const float *inputL, const float *inputR, float *output, size_t nFrame);
 
BIGVOICE_DECL void bigvoice_MonoToStereo_Planar(const float *input, float *outputL, float *outputR, size_t nFrame);
 
BIGVOICE_DECL void bigvoice_AudioMonoFromLiveStereo(const uint8_t *payload, float *output);
 
BIGVOICE_DECL void bigvoice_AudioMonoToLiveStereo(const float *input, uint8_t *payload);
 
struct bigvoice_CAudioConverter;
 
enum bigvoice_ConverterTargetMode {
    ConverterTargetMode_AsInput = 0,    
    ConverterTargetMode_Mono,           
    ConverterTargetMode_Stereo,         
    ConverterTargetMode_StereoToMono,   
    ConverterTargetMode_MonoToStereo,   
};
 
BIGVOICE_DECL struct bigvoice_CAudioConverter* bigvoice_GetAudioConverter(enum bigvoice_SampleFormat fmt, size_t nFrame
    , size_t payl_ch, size_t payl_ch_offset
    , enum bigvoice_ConverterTargetMode target_mode);
 
BIGVOICE_DECL void bigvoice_FreeAudioConverter(struct bigvoice_CAudioConverter *converter);
 
BIGVOICE_DECL void bigvoice_AudioConverter_From(struct bigvoice_CAudioConverter *converter, const uint8_t *payload, float *output);
 
BIGVOICE_DECL void bigvoice_AudioConverter_To(struct bigvoice_CAudioConverter *converter, const float *input, uint8_t *payload);
 
// --------------------------------------------------------------
// --------------------------------------------------------------
struct bigvoice_CClientInstance;
 
BIGVOICE_DECL struct bigvoice_CClientInstance *bigvoice_NewClient(struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL void bigvoice_DeleteClient(struct bigvoice_CClientInstance *client);
 
BIGVOICE_DECL const char *bigvoice_ProcessJson(struct bigvoice_CClientInstance *client, const char *json_str, int *need_save);
 
BIGVOICE_DECL void bigvoice_FreeJsonAnswer(const char *json_str);
 
BIGVOICE_DECL int bigvoice_SaveState(struct bigvoice_CInstance *instance);
 
#if BIGVOICE_HAS_WEBSERVER
// --------------------------------------------------------------
// --------------------------------------------------------------
BIGVOICE_DECL uint64_t bigvoice_Webserver_tcp(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port);
 
// --------------------------------------------------------------
BIGVOICE_DECL uint64_t bigvoice_Webserver_tcp2(unsigned int listenport, unsigned int listenport_secure, const char *socket_ip, unsigned int socket_port, const struct bigvoice_CParameters *parameters);
 
BIGVOICE_DECL uint64_t bigvoice_Webserver(unsigned int listenport, unsigned int listenport_secure, struct bigvoice_CInstance *instance);
 
BIGVOICE_DECL int bigvoice_Webserver_Stop(uint64_t id, int timeout_ms);
 
BIGVOICE_DECL int bigvoice_Webserver_Status(uint64_t id);
 
BIGVOICE_DECL void bigvoice_Webserver_SetAppHealth(struct bigvoice_CInstance *instance, int httpcode, const char *contenttype, const char *content);
 
BIGVOICE_DECL void bigvoice_Webserver_GetAppHealth(struct bigvoice_CInstance *instance, int* httpcode, char** contenttype, char** content);
 
BIGVOICE_DECL void bigvoice_Webserver_FreeString(char *str);
 
#define SOUND4_INVALID_WEBSERVER_ID            ((uint64_t)-1)
 
#define SOUND4_WEBSERVER_HTTP_OK               (1<<0)
#define SOUND4_WEBSERVER_HTTPS_OK              (1<<1)
 
#endif // BIGVOICE_HAS_WEBSERVER
 
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus