immersitech_sound_manager.h

Go to the documentation of this file.

#pragma once
 
 
#ifndef IMMERSITECH_LIBRARY_H_
#define IMMERSITECH_LIBRARY_H_
 
#if HAVE_VISIBILITY
#define IMMERSITECH_SOUND_MANAGER_API __attribute__((__visibility__("default")))
#elif defined _WIN32
#define IMMERSITECH_SOUND_MANAGER_API __declspec(dllexport)
#else
#define IMMERSITECH_SOUND_MANAGER_API
#endif
 
typedef struct immersitech_position {
    int x;
    int y;
    int z;
} immersitech_position;
 
typedef struct immersitech_heading {
    int azimuth_heading;
    int elevation_heading;
} immersitech_heading;
 
typedef enum immersitech_audio_controls {
    IMM_CONTROL_START,                      
    IMM_CONTROL_STEREO_BYPASS_ENABLE,       
    IMM_CONTROL_MUTE_ENABLE,                
    IMM_CONTROL_ANC_ENABLE,                 
    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                         
}immersitech_audio_controls;
 
typedef enum immersitech_device_types {
    IMM_DEVICE_START,                       
    IMM_DEVICE_HEADPHONE,                   
    IMM_DEVICE_SPEAKER,                     
    IMM_DEVICE_END                          
}immersitech_device_types;
 
typedef enum immersitech_participant_types {
    IMM_PARTICIPANT_START,                  
    IMM_PARTICIPANT_REGULAR,                
    IMM_PARTICIPANT_SOURCE_ONLY,            
    IMM_PARTICIPANT_LISTENER_ONLY,          
    IMM_PARTICIPANT_END                     
}immersitech_participant_types;
 
typedef enum immersitech_output_format {
    IMM_OUTPUT_FORMAT_START,                
    IMM_OUTPUT_FORMAT_MONO,                 
    IMM_OUTPUT_FORMAT_STEREO_INTERLEAVED,   
    IMM_OUTPUT_FORMAT_STEREO_BLOCK,         
    IMM_OUTPUT_FORMAT_END                   
}immersitech_output_format;
 
typedef enum immersitech_error_codes {
    IMM_ERROR_START = -10001,               
    IMM_ERROR_NONE,                         
    IMM_ERROR_ENGINE_NULL,                  
    IMM_ERROR_DATA_NULL,                    
    IMM_ERROR_DATA_LENGTH,                  
    IMM_ERROR_NUM_CHANNELS,                 
    IMM_ERROR_SAMPLE_RATE,                  
    IMM_ERROR_OUTPUT_TYPE,                  
    IMM_ERROR_IMPULSE_LENGTH,               
    IMM_ERROR_INVALID_ROOM_ID,              
    IMM_ERROR_INVALID_PARTICIPANT_ID,       
    IMM_ERROR_INVALID_CONTROL,              
    IMM_ERROR_INVALID_VALUE,                
    IMM_ERROR_INVALID_HEADING,              
    IMM_ERROR_NO_INPUT_AUDIO,               
    IMM_ERROR_CONFERENCE_EMPTY,             
    IMM_ERROR_PARTICIPANT_TYPE,             
    IMM_ERROR_LIBRARY_ALREADY_INITIALIZED,  
    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_END                           
}immersitech_error_codes;
 
#define IMM_VERSION_BUFFER_LENGTH 11
 
typedef void* Immersitech_Conference;
 
#ifdef __cplusplus
extern "C" {
#endif
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_get_version(char *character_buffer, int buffer_len);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_initialize_library(const char* license_file_name, int sampling_rate, int num_frames_per_buffer, immersitech_output_format output_format, int impulse_length);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_destroy_library();
 
    IMMERSITECH_SOUND_MANAGER_API Immersitech_Conference imm_create_conference();
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_destroy_conference(Immersitech_Conference conference);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_add_participant(Immersitech_Conference conference, int sampling_rate, int num_channels, immersitech_participant_types participant_type, int* new_id);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_remove_participant(Immersitech_Conference conference, int participant_ID);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_input_audio(Immersitech_Conference conference, short* audio_data, int number_frames, int participant_ID);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_output_audio(Immersitech_Conference conference, int participant_ID, short* output);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_edit_participant_position(Immersitech_Conference conference, int participant_ID, immersitech_position position, immersitech_heading heading);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_get_participant_position(Immersitech_Conference conference, int participant_ID, immersitech_position* position, immersitech_heading* heading);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_edit_participant_state(Immersitech_Conference conference, int participant_ID, immersitech_audio_controls control_to_edit, int value);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_get_participant_state(Immersitech_Conference conference, int participant_ID, immersitech_audio_controls control_to_edit, int* value);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_get_participant_spherical(Immersitech_Conference conference, int listener_ID, int source_ID, int* azimuth, int* elevation, int* distance);
 
    IMMERSITECH_SOUND_MANAGER_API immersitech_error_codes imm_flush_data(Immersitech_Conference conference, int participant_id);
 
#ifdef __cplusplus
}
#endif
 
#endif // IMMERSITECH_LIBRARY_H_