A collection of common operations related to Spatialization of Audio More...

Collaboration diagram for BGC.Audio.Spatial:

Static Public Member Functions
static int	NearestValidOffset (double offset)

static IBGCStream	GetFilter (double angle)

Static Private Member Functions
static string	GetFilterFilename (int position)

Private Attributes
const string	HRTFDirectory = "HRTF"

Detailed Description

A collection of common operations related to Spatialization of Audio

Definition at line 11 of file Spatial.cs.

Member Function Documentation

◆ GetFilter()

static IBGCStream BGC.Audio.Spatial.GetFilter ( double angle )

inlinestatic

Definition at line 26 of file Spatial.cs.

References BGC.Audio.WaveEncoding.LoadBGCStream().

Referenced by BGC.Audio.BGCStreamExtensions.Spatialize().

         {
             int position = NearestValidOffset(angle);
 
             string path = GetFilterFilename(position);
 
             bool loadSuccess = WaveEncoding.LoadBGCStream(
                 filepath: path,
                 stream: out IBGCStream filter);
 
             if (!loadSuccess)
             {
                 Debug.LogError($"Failed to load impulse response function from path {path}");
                 return null;
             }
 
             return filter;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFilterFilename()

static string BGC.Audio.Spatial.GetFilterFilename ( int position )

inlinestaticprivate

Definition at line 45 of file Spatial.cs.

References BGC.IO.DataManagement.PathForDataFile().

         {
             string filePrefix;
 
             if (position == 0)
             {
                 filePrefix = "0";
             }
             else
             {
                 string directionPrefix = (position > 0) ? "pos" : "neg";
 
                 position = Math.Abs(position);
 
                 int decimalPlace = position % 10;
                 int integralPlace = position / 10;
 
                 filePrefix = $"{directionPrefix}{integralPlace}p{decimalPlace}";
             }
 
             return DataManagement.PathForDataFile(HRTFDirectory, $"{filePrefix}_impulse.wav");
         }

Here is the call graph for this function:

◆ NearestValidOffset()

static int BGC.Audio.Spatial.NearestValidOffset ( double offset )

inlinestatic

Definition at line 15 of file Spatial.cs.

References BGC.Mathematics.GeneralMath.Clamp().

         {
             if (offset < -90.0 || offset > 90.0)
             {
                 Debug.LogError($"Spatialization offset ({offset})is outside of bounds [-90.0,90.0].  Clamping.");
                 offset = GeneralMath.Clamp(offset, -90.0, 90.0);
             }
 
             return (int)Math.Round(10.0 * offset);
         }