Module cybergrape::saf_raw

This module places unsafe SAF rust bindings in the crate under their own namespace.

Constants

• ASPECT_RATIO_OPTIONS_ASPECT_RATIO_2_1
  < ASPECT_RATIO_2_1 - 2:1
• ASPECT_RATIO_OPTIONS_ASPECT_RATIO_4_3
  < ASPECT_RATIO_4_3 - 4:3
• ASPECT_RATIO_OPTIONS_ASPECT_RATIO_16_9
  < ASPECT_RATIO_16_9 - 16:9
• CH_ORDER_CH_ACN
  < Ambisonic Channel Numbering (ACN)
• CH_ORDER_CH_FUMA
  < (Legacy) Furse-Malham/B-format (WXYZ)
• CODEC_STATUS_CODEC_STATUS_INITIALISED
  < Codec is initialised and ready to process input audio.
• CODEC_STATUS_CODEC_STATUS_INITIALISING
  < Codec is currently being initialised, input audio should not be processed.
• CODEC_STATUS_CODEC_STATUS_NOT_INITIALISED
  < Codec has not yet been initialised, or the codec configuration has changed. Input audio should not be processed.
• HFOV_OPTIONS_HFOV_60
  < 60 degrees
• HFOV_OPTIONS_HFOV_90
  < 90 degrees
• HFOV_OPTIONS_HFOV_180
  < 180 degrees
• HFOV_OPTIONS_HFOV_360
  < 360 degrees
• INTERP_MODES_INTERP_TRI
  < Triangular interpolation
• INTERP_MODES_INTERP_TRI_PS
  < Triangular interpolation (with phase-simplification)
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_5PX
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_7PX
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_8PX
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_9PX
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_10PX
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_11PX
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_11PX_7_4
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_13PX
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_22P2_9_10_3
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_22PX
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_AALTO_APAJA
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_AALTO_LR
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_AALTO_MCC
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_AALTO_MCC_SUBSET
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_DEFAULT
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_DTU_AVIL
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_SPH_COV_9
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_SPH_COV_16
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_SPH_COV_25
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_SPH_COV_49
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_SPH_COV_64
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_STEREO
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_4
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_12
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_24
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_36
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_48
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_60
• LOUDSPEAKER_ARRAY_PRESETS_LOUDSPEAKER_ARRAY_PRESET_ZYLIA_LAB
• MAX_NUM_CHANNELS
• MAX_NUM_INPUTS
• MAX_NUM_OUTPUTS
• MAX_NUM_SH_SIGNALS
• MAX_SH_ORDER
• MIC_PRESETS_MIC_PRESET_DTU_MIC
• MIC_PRESETS_MIC_PRESET_EIGENMIKE32
• MIC_PRESETS_MIC_PRESET_IDEAL
• MIC_PRESETS_MIC_PRESET_ZYLIA
• NORM_TYPES_NORM_FUMA
  < (Legacy) Furse-Malham scaling
• NORM_TYPES_NORM_N3D
  < orthonormalised (N3D)
• NORM_TYPES_NORM_SN3D
  < Schmidt semi-normalisation (SN3D)
• NUM_CH_ORDERINGS
• NUM_NORM_TYPES
• NUM_STATIC_BEAM_TYPES
• PROC_STATUS_PROC_STATUS_NOT_ONGOING
  < Codec is not processing input audio, and may be reinitialised if needed.
• PROC_STATUS_PROC_STATUS_ONGOING
  < Codec is processing input audio, and should not be reinitialised at this time.
• PROGRESSBARTEXT_CHAR_LENGTH
• SH_ORDERS_SH_ORDER_EIGHTH
  < Eighth-order (81 channels)
• SH_ORDERS_SH_ORDER_FIFTH
  < Fifth-order (36 channels)
• SH_ORDERS_SH_ORDER_FIRST
  < First-order (4 channels)
• SH_ORDERS_SH_ORDER_FOURTH
  < Fourth-order (25 channels)
• SH_ORDERS_SH_ORDER_NINTH
  < Ninth-order (100 channels)
• SH_ORDERS_SH_ORDER_SECOND
  < Second-order (9 channels)
• SH_ORDERS_SH_ORDER_SEVENTH
  < Seventh-order (64 channels)
• SH_ORDERS_SH_ORDER_SIXTH
  < Sixth-order (49 channels)
• SH_ORDERS_SH_ORDER_TENTH
  < Tenth-order (121 channels)
• SH_ORDERS_SH_ORDER_THIRD
  < Third-order (16 channels)
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_5PX
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_7PX
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_8PX
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_9PX
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_10PX
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_11PX
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_11PX_7_4
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_13PX
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_22P2_9_10_3
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_22PX
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_AALTO_APAJA
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_AALTO_LR
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_AALTO_MCC
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_AALTO_MCC_SUBSET
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_DEFAULT
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_DTU_AVIL
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_MONO
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_SPH_COV_9
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_SPH_COV_16
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_SPH_COV_25
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_SPH_COV_49
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_SPH_COV_64
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_STEREO
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_T_DESIGN_4
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_T_DESIGN_12
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_T_DESIGN_24
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_T_DESIGN_36
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_T_DESIGN_48
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_T_DESIGN_60
• SOURCE_CONFIG_PRESETS_SOURCE_CONFIG_PRESET_ZYLIA_LAB
• STATIC_BEAM_TYPES_STATIC_BEAM_TYPE_CARDIOID
  < cardioid
• STATIC_BEAM_TYPES_STATIC_BEAM_TYPE_HYPERCARDIOID
  < hyper-cardioid
• STATIC_BEAM_TYPES_STATIC_BEAM_TYPE_MAX_EV
  < hyper-cardioid with max_rE weighting

Functions

• binauraliserNF_create^⚠
  Creates an instance of the binauraliser
• binauraliserNF_destroy^⚠
  Destroys an instance of the binauraliser
• binauraliserNF_getFarfieldHeadroom^⚠
  Returns the scaling factor to give the far field threshold headroom (useful for UI range limits)
• binauraliserNF_getFarfieldThresh_m^⚠
  Returns the distance considered to be the far field (beyond which no near field filtering is applied), in METERS
• binauraliserNF_getNearfieldLimit_m^⚠
  Returns the minimum distance possible for near field filter, in METERS
• binauraliserNF_getSourceDist_m^⚠
  Returns the source elevation for a given index, in METERS
• binauraliserNF_init^⚠
  Initialises an instance of binauraliser with default settings
• binauraliserNF_initCodec^⚠
  Intialises the codec variables, based on current global/user parameters
• binauraliserNF_process^⚠
  Binauralises the input signals at the user specified directions
• binauraliserNF_processFD^⚠
  Alternate version of binauraliserNF_process() that performs frequency-domain DVF filtering. Not used but kept for posterity.
• binauraliserNF_setInputConfigPreset^⚠
  Loads an input preset (see #SOURCE_CONFIG_PRESETS enum)
• binauraliserNF_setSourceDist_m^⚠
  Sets the panning distance for a specific channel index, in METERS
• binauraliser_create^⚠
  Creates an instance of the binauraliser
• binauraliser_destroy^⚠
  Destroys an instance of the binauraliser
• binauraliser_getCodecStatus^⚠
  Returns current codec status codec status (see #CODEC_STATUS enum)
• binauraliser_getDAWsamplerate^⚠
  Returns the DAW/Host sample rate
• binauraliser_getEnableHRIRsDiffuseEQ^⚠
  Returns the flag indicating whether the diffuse-field EQ applied to the HRTFs is enabled (1) or disabled (0).
• binauraliser_getEnableRotation^⚠
  Returns the flag value which dictates whether to enable/disable sound-field rotation (0: disabled, 1: enabled)
• binauraliser_getFlipPitch^⚠
  Returns a flag as to whether to “flip” the sign of the current ‘pitch’ angle (0: do not flip sign, 1: flip the sign)
• binauraliser_getFlipRoll^⚠
  Returns a flag as to whether to “flip” the sign of the current ‘roll’ angle (0: do not flip sign, 1: flip the sign)
• binauraliser_getFlipYaw^⚠
  Returns a flag as to whether to “flip” the sign of the current ‘yaw’ angle (0: do not flip sign, 1: flip the sign)
• binauraliser_getFrameSize^⚠
  Returns the processing framesize (i.e., number of samples processed with every _process() call )
• binauraliser_getHRIRAzi_deg^⚠
  Returns the HRIR/HRTF azimuth for a given index, in DEGREES
• binauraliser_getHRIRElev_deg^⚠
  Returns the HRIR/HRTF elevation for a given index, in DEGREES
• binauraliser_getHRIRlength^⚠
  Returns the length of HRIRs in time-domain samples
• binauraliser_getHRIRsamplerate^⚠
  Returns the HRIR sample rate
• binauraliser_getInterpMode^⚠
  NOT IMPLEMENTED YET
• binauraliser_getMaxNumSources^⚠
  Returns the maximum number of input sources supported by binauraliser
• binauraliser_getNDirs^⚠
  Returns the number of directions in the currently used HRIR set
• binauraliser_getNTriangles^⚠
  Returns the number of triangular groupings (faces) returned by the Convex Hull
• binauraliser_getNumEars^⚠
  Returns the number of ears possessed by the average homo sapien
• binauraliser_getNumSources^⚠
  Returns the number of inputs/sources in the current layout
• binauraliser_getPitch^⚠
  Returns the ‘pitch’ rotation angle, in DEGREES
• binauraliser_getProcessingDelay^⚠
  Returns the processing delay in samples (may be used for delay compensation purposes)
• binauraliser_getProgressBar0_1^⚠
  (Optional) Returns current intialisation/processing progress, between 0..1
• binauraliser_getProgressBarText^⚠
  (Optional) Returns current intialisation/processing progress text
• binauraliser_getRPYflag^⚠
  Returns a flag as to whether to use “yaw-pitch-roll” (0) or “roll-pitch-yaw” (1) rotation order.
• binauraliser_getRoll^⚠
  Returns the ‘roll’ rotation angle, in DEGREES
• binauraliser_getSofaFilePath^⚠
  Returns the file path for a .sofa file.
• binauraliser_getSourceAzi_deg^⚠
  Returns the source azimuth for a given index, in DEGREES
• binauraliser_getSourceElev_deg^⚠
  Returns the source elevation for a given index, in DEGREES
• binauraliser_getUseDefaultHRIRsflag^⚠
  Returns the value of a flag used to dictate whether the default HRIRs in the Spatial_Audio_Framework should be used (1), or a custom HRIR set loaded via a SOFA file (0).
• binauraliser_getYaw^⚠
  Returns the ‘yaw’ rotation angle, in DEGREES
• binauraliser_init^⚠
  Initialises an instance of binauraliser with default settings
• binauraliser_initCodec^⚠
  Intialises the codec variables, based on current global/user parameters
• binauraliser_process^⚠
  Binauralises the input signals at the user specified directions
• binauraliser_refreshSettings^⚠
  Sets all intialisation flags to 1; re-initialising all settings/variables as binauraliser is currently configured, at next available opportunity.
• binauraliser_setEnableHRIRsDiffuseEQ^⚠
  Enable (1) or disable (0) the diffuse-field EQ applied to the HRTFs
• binauraliser_setEnableRotation^⚠
  Sets the flag to enable/disable (1 or 0) rotation
• binauraliser_setFlipPitch^⚠
  Sets a flag as to whether to “flip” the sign of the current ‘pitch’ angle (0: do not flip sign, 1: flip the sign)
• binauraliser_setFlipRoll^⚠
  Sets a flag as to whether to “flip” the sign of the current ‘roll’ angle (0: do not flip sign, 1: flip the sign)
• binauraliser_setFlipYaw^⚠
  Sets a flag as to whether to “flip” the sign of the current ‘yaw’ angle (0: do not flip sign, 1: flip the sign)
• binauraliser_setInputConfigPreset^⚠
  Loads an input preset (see #SOURCE_CONFIG_PRESETS enum)
• binauraliser_setInterpMode^⚠
  NOT IMPLEMENTED YET
• binauraliser_setNumSources^⚠
  Sets the number of input channels/sources to binauralise
• binauraliser_setPitch^⚠
  Sets the ‘pitch’ rotation angle, in DEGREES
• binauraliser_setRPYflag^⚠
  Sets a flag as to whether to use “yaw-pitch-roll” (0) or “roll-pitch-yaw” (1) rotation order.
• binauraliser_setRoll^⚠
  Sets the ‘roll’ rotation angle, in DEGREES
• binauraliser_setSofaFilePath^⚠
  Sets the file path for a .sofa file, in order to employ a custom HRIR set for the decoding.
• binauraliser_setSourceAzi_deg^⚠
  Sets the panning azimuth for a specific channel index, in DEGREES
• binauraliser_setSourceElev_deg^⚠
  Sets the panning elevation for a specific channel index, in DEGREES
• binauraliser_setSourceGain^⚠
  Sets gain factor for an input source.
• binauraliser_setSourceSolo^⚠
  Set a source to solo.
• binauraliser_setUnSolo^⚠
  Unsolo / unmute all sources.
• binauraliser_setUseDefaultHRIRsflag^⚠
  Sets flag to dictate whether the default HRIRs in the Spatial_Audio_Framework should be used (1), or a custom HRIR set loaded via a SOFA file (0).
• binauraliser_setYaw^⚠
  Sets the ‘yaw’ rotation angle, in DEGREES

Type Aliases

• ASPECT_RATIO_OPTIONS
  Available aspect ratios
• CH_ORDER
  Available Ambisonic channel ordering conventions
• CODEC_STATUS
  Current status of the codec
• HFOV_OPTIONS
  Available horizontal field-of-view (FOV) options
• INTERP_MODES
  Available interpolation modes
• LOUDSPEAKER_ARRAY_PRESETS
  Available loudspeaker array presets
• MIC_PRESETS
  Available microphone array presets
• NORM_TYPES
  Available Ambisonic normalisation conventions
• PROC_STATUS
  Current status of the processing loop
• SH_ORDERS
  Available spherical harmonic (SH) input/output order options
• SOURCE_CONFIG_PRESETS
  Available source configurations presets to use for encoding/panning
• STATIC_BEAM_TYPES
  Available static beamforming approaches