immersitech.h

Go to the documentation of this file.

#pragma once
 
 
#ifndef IMMERSITECH_LIBRARY_H_
#define IMMERSITECH_LIBRARY_H_
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
#if HAVE_VISIBILITY
#define IMMERSITECH_API __attribute__((__visibility__("default")))
#elif defined _WIN32
#define IMMERSITECH_API __declspec(dllexport)
#else
#define IMMERSITECH_API
#endif
 
typedef struct imm_position {
    int x;
    int y;
    int z;
} imm_position;
 
typedef struct imm_heading {
    int azimuth_heading;
    int elevation_heading;
} imm_heading;
 
typedef struct imm_seat {
    int id;
    imm_position position;
    imm_heading heading;
} imm_seat;
 
typedef enum imm_audio_control {
    IMM_CONTROL_START,                      
    IMM_CONTROL_STEREO_BYPASS_ENABLE,       
    IMM_CONTROL_MUTE_ENABLE,                
    IMM_CONTROL_ANC_ENABLE,                 
    IMM_CONTROL_ANC_MIX,                    
    IMM_CONTROL_AGC_ENABLE,                 
    IMM_CONTROL_AUTO_EQ_ENABLE,             
    IMM_CONTROL_MIXING_3D_ENABLE,           
    IMM_CONTROL_MIXING_3D_ATTENUATION,      
    IMM_CONTROL_MIXING_3D_MAX_DISTANCE,     
    IMM_CONTROL_MIXING_3D_REVERB_ENABLE,    
    IMM_CONTROL_DEVICE,                     
    IMM_CONTROL_HALF_SPAN_ANGLE,            
    IMM_CONTROL_MASTER_GAIN,                
    IMM_CONTROL_WHISPER_ROOM,               
    IMM_CONTROL_SIDEBAR_ROOM,               
    IMM_CONTROL_END                         
}imm_audio_control;
 
typedef enum imm_device_type {
    IMM_DEVICE_START,                       
    IMM_DEVICE_HEADPHONE,                   
    IMM_DEVICE_SPEAKER,                     
    IMM_DEVICE_END                          
}imm_device_type;
 
typedef enum imm_participant_type {
    IMM_PARTICIPANT_START,                  
    IMM_PARTICIPANT_REGULAR,                
    IMM_PARTICIPANT_SOURCE_ONLY,            
    IMM_PARTICIPANT_LISTENER_ONLY,          
    IMM_PARTICIPANT_END                     
}imm_participant_type;
 
typedef enum imm_error_code {
    IMM_ERROR_START = -10001,               
    IMM_ERROR_NONE,                         
    IMM_ERROR_HANDLE_NULL,                  
    IMM_ERROR_DATA_NULL,                    
    IMM_ERROR_DATA_LENGTH,                  
    IMM_ERROR_NUM_CHANNELS,                 
    IMM_ERROR_SAMPLE_RATE,                  
    IMM_ERROR_SPATIAL_QUALITY,              
    IMM_ERROR_INVALID_ROOM_ID,              
    IMM_ERROR_INVALID_PARTICIPANT_ID,       
    IMM_ERROR_INVALID_CONTROL,              
    IMM_ERROR_INVALID_VALUE,                
    IMM_ERROR_INVALID_HEADING,              
    IMM_ERROR_INVALID_JSON_FILE,            
    IMM_ERROR_NO_INPUT_AUDIO,               
    IMM_ERROR_PARTICIPANT_TYPE,             
    IMM_ERROR_LIBRARY_NOT_YET_INITIALIZED,  
    IMM_ERROR_LICENSE_DATE_EXPIRED,         
    IMM_ERROR_LICENSE_VERSION_MISMATCH,     
    IMM_ERROR_LICENSE_TAMPERED,             
    IMM_ERROR_LICENSE_MISSING,              
    IMM_ERROR_FILE_DOES_NOT_EXIST,          
    IMM_ERROR_MISSING_OR_INVALID_PARAMETER, 
    IMM_ERROR_END                           
}imm_error_code;
 
typedef struct imm_library_configuration {
    int output_sampling_rate;
    int output_number_frames;
    int output_number_channels;
    bool interleaved;
    int spatial_quality;
} imm_library_configuration;
 
typedef struct imm_participant_configuration {
    int input_sampling_rate;
    int input_number_channels;
    imm_participant_type type;
} imm_participant_configuration;
 
typedef void* imm_handle;
 
#ifdef __cplusplus
extern "C" {
#endif
 
    IMMERSITECH_API const char* imm_get_version();
 
    IMMERSITECH_API imm_handle imm_initialize_library(const char* license_file_name, const char* room_layout_file_name, const char* websocket_config_file_name, imm_library_configuration configuration, imm_error_code* error_code);
 
    IMMERSITECH_API imm_handle imm_initialize_library_from_memory(uint8_t* license_file_data, size_t license_file_data_size, const char* room_layout_file_name, const char* websocket_config_file_name, imm_library_configuration configuration, imm_error_code* error_code);
 
    IMMERSITECH_API imm_error_code imm_destroy_library(imm_handle handle);
 
    IMMERSITECH_API const char* imm_get_license_info(imm_handle handle);
 
    IMMERSITECH_API imm_library_configuration imm_get_library_configuration(imm_handle handle);
 
    IMMERSITECH_API imm_error_code imm_create_room(imm_handle handle, int room_id);
 
    IMMERSITECH_API imm_error_code imm_destroy_room(imm_handle handle, int room_id);
 
    IMMERSITECH_API imm_error_code imm_add_participant(imm_handle handle, int room_id, int participant_id, const char* participant_name, imm_participant_configuration config);
 
    IMMERSITECH_API imm_error_code imm_remove_participant(imm_handle handle, int room_id, int participant_id);
 
    IMMERSITECH_API imm_error_code imm_enable_logging(bool enable);
 
    IMMERSITECH_API imm_error_code imm_set_log_level(int level);
 
    IMMERSITECH_API const char* imm_get_json_all_room_layouts(imm_handle handle);
 
    IMMERSITECH_API imm_error_code imm_get_room_layout(imm_handle handle, int room_id, int* layout_id);
 
    IMMERSITECH_API imm_error_code imm_set_room_layout(imm_handle handle, int room_id, int layout_id);
 
    IMMERSITECH_API imm_error_code imm_add_event_manager(imm_handle handle, void* event_manager);
 
    IMMERSITECH_API imm_error_code imm_enable_websockets(imm_handle handle, bool enable);
 
    IMMERSITECH_API imm_error_code imm_send_custom_websocket_event(imm_handle handle, int room_id, const char* message);
 
    IMMERSITECH_API imm_error_code imm_get_room_count(imm_handle handle, int* room_count);
 
    IMMERSITECH_API imm_error_code imm_get_participant_count(imm_handle handle, int room_id, int* participant_count);
 
    IMMERSITECH_API imm_error_code imm_get_participant_name(imm_handle handle, int room_id, int participant_id, char* value, int value_length);
 
    IMMERSITECH_API imm_error_code imm_set_participant_name(imm_handle handle, int room_id, int participant_id, const char* participant_name);
 
    IMMERSITECH_API imm_error_code imm_set_all_participants_state(imm_handle handle, int room_id, imm_audio_control control_to_edit, int value);
 
    IMMERSITECH_API imm_error_code imm_set_participant_seat(imm_handle handle, int room_id, int participant_id, int seat_id);
 
    IMMERSITECH_API imm_error_code imm_get_participant_seat(imm_handle handle, int room_id, int participant_id, imm_seat* seat);
 
    IMMERSITECH_API imm_error_code imm_get_participant_configuration(imm_handle handle, int room_id, int participant_id, imm_participant_configuration* config);
 
    IMMERSITECH_API imm_error_code imm_input_audio_short(imm_handle handle, int room_id, int participant_id, const short* audio_data, int number_frames);
 
    IMMERSITECH_API imm_error_code imm_input_audio_float(imm_handle handle, int room_id, int participant_id, const float* audio_data, int number_frames);
 
    IMMERSITECH_API imm_error_code imm_input_audio_double(imm_handle handle, int room_id, int participant_id, const double* audio_data, int number_frames);
 
    IMMERSITECH_API imm_error_code imm_output_audio_short(imm_handle handle, int room_id, int participant_id, short* output);
 
    IMMERSITECH_API imm_error_code imm_output_audio_float(imm_handle handle, int room_id, int participant_id, float* output);
 
    IMMERSITECH_API imm_error_code imm_output_audio_double(imm_handle handle, int room_id, int participant_id, double* output);
 
    IMMERSITECH_API imm_error_code imm_set_participant_position(imm_handle handle, int room_id, int participant_id, imm_position position, imm_heading heading);
 
    IMMERSITECH_API imm_error_code imm_get_participant_position(imm_handle handle, int room_id, int participant_id, imm_position* position, imm_heading* heading);
 
    IMMERSITECH_API imm_error_code imm_set_participant_state(imm_handle handle, int room_id, int participant_id, imm_audio_control control_to_edit, int value);
 
    IMMERSITECH_API imm_error_code imm_get_participant_state(imm_handle handle, int room_id, int participant_id, imm_audio_control control, int* value);
 
    IMMERSITECH_API imm_error_code imm_get_participant_spherical(imm_handle handle, int room_id, int listener_id, int source_id, int* azimuth, int* elevation, int* distance);
 
    IMMERSITECH_API imm_error_code imm_flush_data(imm_handle handle, int room_id, int participant_id);
 
    IMMERSITECH_API const char* imm_audio_control_to_string(imm_audio_control control);
 
    IMMERSITECH_API imm_audio_control imm_string_to_audio_control(const char* control_string);
 
    IMMERSITECH_API int imm_string_to_participant_value(const char* value_string);
 
    IMMERSITECH_API const char* imm_error_code_to_string(imm_error_code error_code);
 
#ifdef __cplusplus
}
#endif
 
#endif // IMMERSITECH_LIBRARY_H_