VR4RoboticArm2/VR4RoboticArm/Library/PackageCache/com.meta.xr.sdk.audio/Runtime/scripts/MetaXRAcousticSettings.cs

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * Licensed under the Oculus SDK License Agreement (the "License");
 * you may not use the Oculus SDK except in compliance with the License,
 * which is provided at the time of installation or download, or which
 * otherwise accompanies this software in either electronic or hard copy form.
 *
 * You may obtain a copy of the License at
 *
 * https://developer.oculus.com/licenses/oculussdk/
 *
 * Unless required by applicable law or agreed to in writing, the Oculus SDK
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/************************************************************************************
 * Filename    :   MetaXRAcousticSettings.cs
 * Content     :   Exposes acoustic settings MetaXRAudioUnity
 ***********************************************************************************/

using Meta.XR.Acoustics;
using UnityEngine;
using Native = MetaXRAcousticNativeInterface;

/// \brief This class exposes controls for the Meta XR Acoustics SDK at a project level
/// You can use this class to programmatically control the acoustics settings for the entire project at runtime. Note any changes made to this data struct will not be written do disk and thus not persist across game loads. Any settings that intended to persist across game loads should be done in the project settings window under the "Meta XR Acoustics" panel.
/// Use \ref MetaXRAcousticSettings.Instance to gain access to the singleton instance of the global project settings.
public class MetaXRAcousticSettings : ScriptableObject
{
    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
    static void OnBeforeSceneLoadRuntimeMethod()
    {
        Instance.ApplyAllSettings();
    }

    [Tooltip("This is the path inside your Unity project which will store all baked geometry files.")]
    internal const string AcousticFileRootDir = "StreamingAssets/Acoustics";

    [SerializeField]
    [Tooltip("Select which type of acoustic modeling system is used to generate reverb and reflections.")]
    private AcousticModel acousticModel = Meta.XR.Acoustics.AcousticModel.Automatic;

    /// \brief The reflections engine used during runtime
    /// \see Meta.XR.Acoustics.AcousticModel
    public AcousticModel AcousticModel
    {
        get => acousticModel;
        set
        {
            if (value != acousticModel)
            {
                acousticModel = value;
                Native.Interface.SetAcousticModel(value);
            }
        }
    }

    [SerializeField]
    [Tooltip("When enabled and using geometry, all spatailized AudioSources will diffract (propagate around corners and obstructions)")]
    private bool diffractionEnabled = true;

    /// \brief When enabled and using geometry, all spatailized AudioSources will diffract (propagate around corners and obstructions)
    internal bool DiffractionEnabled
    {
        get => diffractionEnabled;
        set
        {
            if (value != diffractionEnabled)
            {
                diffractionEnabled = value;
                Native.Interface.SetEnabled(EnableFlagInternal.DIFFRACTION, value);
            }
        }
    }
    [SerializeField]
    [Tooltip("Geometry will exclude children with these tags")]
    private string[] excludeTags = new string[0];

    /// \brief Geometry will exclude children with these tags
    internal string[] ExcludeTags { get => excludeTags; set => excludeTags = value; }

    [SerializeField]
    [Tooltip("When you bake an acoustic map, also bake all the acoustic geometry files")]
    private bool mapBakeWriteGeo = true;

    /// \brief When you bake an acoustic map, also bake all the acoustic geometry files
    [Tooltip("If enabled, acoustic geometry files will also be written when baking an acoustic map")]
    internal bool MapBakeWriteGeo
    {
        get => mapBakeWriteGeo;
        set => mapBakeWriteGeo = value;
    }

    /// Provide all current settings to the native DLL.
    internal void ApplyAllSettings()
    {
        Debug.Log("Applying Acoustic Propagation Settings: " +
            $"[acoustic model = {AcousticModel}], " +
            $"[diffraction = {DiffractionEnabled}], ");
        Native.Interface.SetAcousticModel(AcousticModel);
        Native.Interface.SetEnabled(EnableFlagInternal.DIFFRACTION, DiffractionEnabled);
    }

    private static MetaXRAcousticSettings instance;

    /// \brief The singleton instance of the project settings.
    /// This instance is project wide and will be automatically created on first access if needed. Any settings that are intended to persist across game loads should be done in the project settings window under the "Meta XR Acoustics" panel.
    /// See \ref MetaXRAcousticSettings for settings values.
    public static MetaXRAcousticSettings Instance
    {
        get
        {
            if (instance == null)
            {
                instance = Resources.Load<MetaXRAcousticSettings>("MetaXRAcousticSettings");

                // This can happen if the developer never input their App Id into the Unity Editor
                // and therefore never created the OculusPlatformSettings.asset file
                // Use a dummy object with defaults for the getters so we don't have a null pointer exception
                if (instance == null)
                {
                    instance = ScriptableObject.CreateInstance<MetaXRAcousticSettings>();

#if UNITY_EDITOR
                    // Only in the editor should we save it to disk
                    string properPath = System.IO.Path.Combine(UnityEngine.Application.dataPath, "Resources");
                    if (!System.IO.Directory.Exists(properPath))
                    {
                        UnityEditor.AssetDatabase.CreateFolder("Assets", "Resources");
                    }

                    string fullPath = System.IO.Path.Combine(
                        "Assets", "Resources", "MetaXRAcousticSettings.asset");
                    UnityEditor.AssetDatabase.CreateAsset(instance, fullPath);
#endif
                }
            }

            return instance;
        }
    }
}