Ryujinx/Ryujinx.Audio/Renderer/Device/VirtualDevice.cs

//
// Copyright (c) 2019-2021 Ryujinx
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//

using System.Diagnostics;

namespace Ryujinx.Audio.Renderer.Device
{
    /// <summary>
    /// Represents a virtual device used by IAudioDevice.
    /// </summary>
    public class VirtualDevice
    {
        /// <summary>
        /// All the defined virtual devices.
        /// </summary>
        public static readonly VirtualDevice[] Devices = new VirtualDevice[5]
        {
            new VirtualDevice("AudioStereoJackOutput", 2, true),
            new VirtualDevice("AudioBuiltInSpeakerOutput", 2, false),
            new VirtualDevice("AudioTvOutput", 6, false),
            new VirtualDevice("AudioUsbDeviceOutput", 2, true),
            new VirtualDevice("AudioExternalOutput", 6, true),
        };

        /// <summary>
        /// The name of the <see cref="VirtualDevice"/>.
        /// </summary>
        public string Name { get; }

        /// <summary>
        /// The count of channels supported by the <see cref="VirtualDevice"/>.
        /// </summary>
        public uint ChannelCount { get; }

        /// <summary>
        /// The system master volume of the <see cref="VirtualDevice"/>.
        /// </summary>
        public float MasterVolume { get; private set; }

        /// <summary>
        /// Define if the <see cref="VirtualDevice"/> is provided by an external interface.
        /// </summary>
        public bool IsExternalOutput { get; }

        /// <summary>
        /// Create a new <see cref="VirtualDevice"/> instance.
        /// </summary>
        /// <param name="name">The name of the <see cref="VirtualDevice"/>.</param>
        /// <param name="channelCount">The count of channels supported by the <see cref="VirtualDevice"/>.</param>
        /// <param name="isExternalOutput">Indicate if the <see cref="VirtualDevice"/> is provided by an external interface.</param>
        private VirtualDevice(string name, uint channelCount, bool isExternalOutput)
        {
            Name = name;
            ChannelCount = channelCount;
            IsExternalOutput = isExternalOutput;
        }

        /// <summary>
        /// Update the master volume of the <see cref="VirtualDevice"/>.
        /// </summary>
        /// <param name="volume">The new master volume.</param>
        public void UpdateMasterVolume(float volume)
        {
            Debug.Assert(volume >= 0.0f && volume <= 1.0f);

            MasterVolume = volume;
        }

        /// <summary>
        /// Check if the <see cref="VirtualDevice"/> is a usb device.
        /// </summary>
        /// <returns>Returns true if the <see cref="VirtualDevice"/> is a usb device.</returns>
        public bool IsUsbDevice()
        {
            return Name.Equals("AudioUsbDeviceOutput");
        }

        /// <summary>
        /// Get the output device name of the <see cref="VirtualDevice"/>.
        /// </summary>
        /// <returns>The output device name of the <see cref="VirtualDevice"/>.</returns>
        public string GetOutputDeviceName()
        {
            if (IsExternalOutput)
            {
                return "AudioExternalOutput";
            }

            return Name;
        }
    }
}