Kenji-NX/src/Ryujinx.HLE/HOS/Services/Am/AppletAE/AllSystemAppletProxiesService/SystemAppletProxy/ICommonStateGetter.cs

using Ryujinx.Common.Logging;
using Ryujinx.HLE.HOS.Ipc;
using Ryujinx.HLE.HOS.Kernel.Threading;
using Ryujinx.HLE.HOS.Services.Settings.Types;
using Ryujinx.HLE.HOS.Services.Vi.RootService.ApplicationDisplayService;
using Ryujinx.HLE.HOS.SystemState;
using Ryujinx.Horizon.Common;
using Ryujinx.Horizon.Sdk.Lbl;
using System;

namespace Ryujinx.HLE.HOS.Services.Am.AppletAE.AllSystemAppletProxiesService.SystemAppletProxy
{
    class ICommonStateGetter : DisposableIpcService
    {
        // Nintendo serves the VR goggle commands based on Title ID, apparently.
        private static ReadOnlySpan<ulong> _supportedVRGoggleTitles =>
        [
            0x0100CA001D972000, // Nintendo Classics: Virtual Boy NSO
            0x0100BFC01D976000  // Nintendo Classics: Virtual Boy NSO
        ];
        
        private int _resolutionWidth = 1280;
        private int _resolutionHeight = 720;
        
        private readonly ServiceCtx _context;

        private readonly Apm.ManagerServer _apmManagerServer;
        private readonly Apm.SystemManagerServer _apmSystemManagerServer;

        private bool _vrModeEnabled;
        private bool _vrMode3dEnabled;
#pragma warning disable CS0414, IDE0052 // Remove unread private member
        private bool _lcdBacklighOffEnabled;
        private bool _requestExitToLibraryAppletAtExecuteNextProgramEnabled;
#pragma warning restore CS0414, IDE0052
        private int _messageEventHandle;
        private int _displayResolutionChangedEventHandle;

        private readonly KEvent _acquiredSleepLockEvent;
        private int _acquiredSleepLockEventHandle;

        public ICommonStateGetter(ServiceCtx context)
        {
            _context = context;

            _apmManagerServer = new Apm.ManagerServer(context);
            _apmSystemManagerServer = new Apm.SystemManagerServer(context);

            _acquiredSleepLockEvent = new KEvent(context.Device.System.KernelContext);
        }

        [CommandCmif(0)]
        // GetEventHandle() -> handle<copy>
        public ResultCode GetEventHandle(ServiceCtx context)
        {
            KEvent messageEvent = context.Device.System.AppletState.MessageEvent;

            if (_messageEventHandle == 0)
            {
                if (context.Process.HandleTable.GenerateHandle(messageEvent.ReadableEvent, out _messageEventHandle) != Result.Success)
                {
                    throw new InvalidOperationException("Out of handles!");
                }
            }

            context.Response.HandleDesc = IpcHandleDesc.MakeCopy(_messageEventHandle);

            return ResultCode.Success;
        }

        [CommandCmif(1)]
        // ReceiveMessage() -> nn::am::AppletMessage
        public ResultCode ReceiveMessage(ServiceCtx context)
        {
            if (!context.Device.System.AppletState.Messages.TryDequeue(out AppletMessage message))
            {
                return ResultCode.NoMessages;
            }

            KEvent messageEvent = context.Device.System.AppletState.MessageEvent;

            // NOTE: Service checks if current states are different than the stored ones.
            //       Since we don't support any states for now, it's fine to check if there is still messages available.

            if (context.Device.System.AppletState.Messages.IsEmpty)
            {
                messageEvent.ReadableEvent.Clear();
            }
            else
            {
                messageEvent.ReadableEvent.Signal();
            }

            context.ResponseData.Write((int)message);

            return ResultCode.Success;
        }

        [CommandCmif(5)]
        // GetOperationMode() -> u8
        public ResultCode GetOperationMode(ServiceCtx context)
        {
            OperationMode mode = context.Device.System.State.DockedMode
                ? OperationMode.Docked
                : OperationMode.Handheld;

            context.ResponseData.Write((byte)mode);

            return ResultCode.Success;
        }

        [CommandCmif(6)]
        // GetPerformanceMode() -> nn::apm::PerformanceMode
        public ResultCode GetPerformanceMode(ServiceCtx context)
        {
            return (ResultCode)_apmManagerServer.GetPerformanceMode(context);
        }

        [CommandCmif(8)]
        // GetBootMode() -> u8
        public ResultCode GetBootMode(ServiceCtx context)
        {
            context.ResponseData.Write((byte)0); //Unknown value.

            Logger.Stub?.PrintStub(LogClass.ServiceAm);

            return ResultCode.Success;
        }

        [CommandCmif(9)]
        // GetCurrentFocusState() -> u8
        public ResultCode GetCurrentFocusState(ServiceCtx context)
        {
            context.ResponseData.Write((byte)context.Device.System.AppletState.FocusState);

            return ResultCode.Success;
        }

        [CommandCmif(10)]
        // RequestToAcquireSleepLock()
        public ResultCode RequestToAcquireSleepLock(ServiceCtx context)
        {
            Logger.Stub?.PrintStub(LogClass.ServiceAm);

            return ResultCode.Success;
        }

        [CommandCmif(13)]
        // GetAcquiredSleepLockEvent() -> handle<copy>
        public ResultCode GetAcquiredSleepLockEvent(ServiceCtx context)
        {
            if (_acquiredSleepLockEventHandle == 0)
            {
                if (context.Process.HandleTable.GenerateHandle(_acquiredSleepLockEvent.ReadableEvent, out _acquiredSleepLockEventHandle) != Result.Success)
                {
                    throw new InvalidOperationException("Out of handles!");
                }
            }

            context.Response.HandleDesc = IpcHandleDesc.MakeCopy(_acquiredSleepLockEventHandle);

            Logger.Stub?.PrintStub(LogClass.ServiceAm);

            return ResultCode.Success;
        }

        [CommandCmif(30)]
        // GetHomeButtonReaderLockAccessor() -> nn::am::service::ILockAccessor
        public ResultCode GetHomeButtonReaderLockAccessor(ServiceCtx context)
        {
            // We currently do not have any home button functionality, so it's fine to stub this for now.
            // Similar to using GetReaderLockAccessorEx() with inval=0.
            Logger.Stub?.PrintStub(LogClass.ServiceAm);
            MakeObject(context, new ILockAccessor(context));
            return ResultCode.Success;
        }

        [CommandCmif(31)] // 2.0.0 +
        // GetReaderLockAccessorEx(uint unknown) -> nn::am::service::ILockAccessor
        public ResultCode GetReaderLockAccessorEx(ServiceCtx context)
        {
            uint unknown = context.RequestData.ReadUInt32();
            Logger.Stub?.PrintStub(LogClass.ServiceAm, new { unknown });
            if (unknown < 0 || unknown > 3)
            {
                throw new ArgumentOutOfRangeException(nameof(unknown));
            }
            
            MakeObject(context, new ILockAccessor(context));
            return ResultCode.Success;
        }

        [CommandCmif(32)] // 2.0.0+
        // GetWriterLockAccessorEx(uint unknown) -> nn::am::service::ILockAccessor
        public ResultCode GetWriterLockAccessorEx(ServiceCtx context)
        {
            uint unknown = context.RequestData.ReadUInt32();
            Logger.Stub?.PrintStub(LogClass.ServiceAm, new { unknown });
            if (unknown < 0 || unknown > 3)
            {
                throw new ArgumentOutOfRangeException(nameof(unknown));
            }
            
            MakeObject(context, new ILockAccessor(context));
            return ResultCode.Success;
        }

        [CommandCmif(50)] // 3.0.0+
        // IsVrModeEnabled() -> b8
        public ResultCode IsVrModeEnabled(ServiceCtx context)
        {
            context.ResponseData.Write(_vrModeEnabled);

            return ResultCode.Success;
        }

        [CommandCmif(51)] // 3.0.0+
        // SetVrModeEnabled(b8)
        public ResultCode SetVrModeEnabled(ServiceCtx context)
        {
            bool vrModeEnabled = context.RequestData.ReadBoolean();

            UpdateVrMode(vrModeEnabled);

            return ResultCode.Success;
        }

        [CommandCmif(52)] // 4.0.0+
        // SetLcdBacklighOffEnabled(b8)
        public ResultCode SetLcdBacklighOffEnabled(ServiceCtx context)
        {
            // NOTE: Service sets a private field here, maybe this field is used somewhere else to turn off the backlight.
            //       Since we don't support the backlight feature, it's fine to stub it.

            _lcdBacklighOffEnabled = context.RequestData.ReadBoolean();

            Logger.Stub?.PrintStub(LogClass.ServiceAm);

            return ResultCode.Success;
        }

        [CommandCmif(53)] // 7.0.0+
        // BeginVrModeEx()
        public ResultCode BeginVrModeEx(ServiceCtx context)
        {
            UpdateVrMode(true);

            return ResultCode.Success;
        }

        [CommandCmif(54)] // 7.0.0+
        // EndVrModeEx()
        public ResultCode EndVrModeEx(ServiceCtx context)
        {
            UpdateVrMode(false);

            return ResultCode.Success;
        }

        private void UpdateVrMode(bool vrModeEnabled)
        {
            if (_vrModeEnabled == vrModeEnabled)
            {
                return;
            }

            _vrModeEnabled = vrModeEnabled;

            using LblApi lblApi = new();

            if (vrModeEnabled)
            {
                lblApi.EnableVrMode().AbortOnFailure();
            }
            else
            {
                lblApi.DisableVrMode().AbortOnFailure();
            }

            // TODO: It signals an internal event of ICommonStateGetter. We have to determine where this event is used.
        }

        [CommandCmif(60)] // 3.0.0+
        // GetDefaultDisplayResolution() -> (u32, u32)
        public ResultCode GetDefaultDisplayResolution(ServiceCtx context)
        {
            // NOTE: Original service calls IOperationModeManager::GetDefaultDisplayResolution of omm service.
            //       IOperationModeManager::GetDefaultDisplayResolution of omm service call IManagerDisplayService::GetDisplayResolution of vi service.
            (ulong width, ulong height) = AndroidSurfaceComposerClient.GetDisplayInfo(context);

            context.ResponseData.Write((uint)width);
            context.ResponseData.Write((uint)height);

            return ResultCode.Success;
        }

        [CommandCmif(61)] // 3.0.0+
        // GetDefaultDisplayResolutionChangeEvent() -> handle<copy>
        public ResultCode GetDefaultDisplayResolutionChangeEvent(ServiceCtx context)
        {
            // NOTE: Original service calls IOperationModeManager::GetDefaultDisplayResolutionChangeEvent of omm service.
            if (_displayResolutionChangedEventHandle == 0)
            {
                if (context.Process.HandleTable.GenerateHandle(context.Device.System.DisplayResolutionChangeEvent.ReadableEvent, out _displayResolutionChangedEventHandle) != Result.Success)
                {
                    throw new InvalidOperationException("Out of handles!");
                }
            }

            context.Response.HandleDesc = IpcHandleDesc.MakeCopy(_displayResolutionChangedEventHandle);

            Logger.Stub?.PrintStub(LogClass.ServiceAm);

            return ResultCode.Success;
        }

        [CommandCmif(62)] // 4.0.0+
        // GetHdcpAuthenticationState() -> s32 state
        public ResultCode GetHdcpAuthenticationState(ServiceCtx context)
        {
            context.ResponseData.Write(0);

            Logger.Stub?.PrintStub(LogClass.ServiceAm);

            return ResultCode.Success;
        }

        [CommandCmif(66)] // 6.0.0+
        // SetCpuBoostMode(u32 cpu_boost_mode)
        public ResultCode SetCpuBoostMode(ServiceCtx context)
        {
            uint cpuBoostMode = context.RequestData.ReadUInt32();

            if (cpuBoostMode > 1)
            {
                return ResultCode.InvalidParameters;
            }

            _apmSystemManagerServer.SetCpuBoostMode((Apm.CpuBoostMode)cpuBoostMode);

            // TODO: It signals an internal event of ICommonStateGetter. We have to determine where this event is used.

            return ResultCode.Success;
        }

        [CommandCmif(91)] // 7.0.0+
        // GetCurrentPerformanceConfiguration() -> nn::apm::PerformanceConfiguration
        public ResultCode GetCurrentPerformanceConfiguration(ServiceCtx context)
        {
            return (ResultCode)_apmSystemManagerServer.GetCurrentPerformanceConfiguration(context);
        }

        [CommandCmif(130)] // 21.0.0+
        // EnableStartupLogoDisappearedMessage()
        public ResultCode EnableStartupLogoDisappearedMessage(ServiceCtx context)
        {
            // NOTE: Service only delivers the message once the startup logo has actually
            //       disappeared. We never display one, so it is already deliverable. Callers
            //       gate their first frame on this message and hang without it.

            AppletStateMgr appletState = context.Device.System.AppletState;

            appletState.Messages.Enqueue(AppletMessage.StartupLogoDisappeared);
            appletState.MessageEvent.ReadableEvent.Signal();

            return ResultCode.Success;
        }

        [CommandCmif(300)] // 9.0.0+
        // GetSettingsPlatformRegion() -> u8
        public ResultCode GetSettingsPlatformRegion(ServiceCtx context)
        {
            PlatformRegion platformRegion = context.Device.System.State.DesiredRegionCode == (uint)RegionCode.China ? PlatformRegion.China : PlatformRegion.Global;
            
            // FIXME: Call set:sys GetPlatformRegion
            context.ResponseData.Write((byte)platformRegion);

            return ResultCode.Success;
        }

        [CommandCmif(610)] // 21.0.0+
        // UnknownCommand610(long unknown)
        public ResultCode UnknownCommand610(ServiceCtx context)
        {
            long unknown = context.RequestData.ReadInt64();
            Logger.Stub?.PrintStub(LogClass.ServiceAm, new { unknown });
            return ResultCode.Success;
        }

        [CommandCmif(900)] // 11.0.0+
        // SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled()
        public ResultCode SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled(ServiceCtx context)
        {
            // TODO : Find where the field is used.
            _requestExitToLibraryAppletAtExecuteNextProgramEnabled = true;

            return ResultCode.Success;
        }

        [CommandCmif(1000)] // 19.0.0+
        // BeginVrMode3d()
        public ResultCode BeginVrMode3d(ServiceCtx context)
        {
            // NOTE: Service also applies a stereo scale to the goggle display, which we don't
            //       model, so only the state is kept here.

            _vrMode3dEnabled = true;

            return ResultCode.Success;
        }

        [CommandCmif(1001)] // 19.0.0+
        // EndVrMode3d()
        public ResultCode EndVrMode3d(ServiceCtx context)
        {
            _vrMode3dEnabled = false;

            return ResultCode.Success;
        }

        [CommandCmif(1002)] // 19.0.0+
        // IsVrModeEnabled3d() -> b8
        public ResultCode IsVrModeEnabled3d(ServiceCtx context)
        {
            context.ResponseData.Write(_vrMode3dEnabled);

            return ResultCode.Success;
        }

        [CommandCmif(1003)] // 21.0.0+
        // GetVrLaboGoggleViewport() -> (s32 x, s32 y, s32 width, s32 height)
        public ResultCode GetVrLaboGoggleViewport(ServiceCtx context)
        {
            if (!IsVrLaboGoggleSupportedTitle(context))
            {
                return ResultCode.ObjectInvalid;
            }
            
            int VrDisplayCoordinateX = 0;
            int VrDisplayCoordinateY = 0;
            int VrDisplayWidth = _resolutionWidth;
            int VrDisplayHeight = _resolutionHeight;

            context.ResponseData.Write(VrDisplayCoordinateX);
            context.ResponseData.Write(VrDisplayCoordinateY);
            context.ResponseData.Write(VrDisplayWidth);
            context.ResponseData.Write(VrDisplayHeight);

            return ResultCode.Success;
        }

        [CommandCmif(1004)] // 21.0.0+
        // GetPanelPhysicalSizeForSpecificTitle() -> (f32 width, f32 height)
        public ResultCode GetPanelPhysicalSizeForSpecificTitle(ServiceCtx context)
        {
            if (!IsVrLaboGoggleSupportedTitle(context))
            {
                return ResultCode.ObjectInvalid;
            }
            
            // The switch provides micrometres, but the command reports millimetres.
            // 6.2 inch 16:9 panel.
            float PanelPhysicalWidthMicroMeters = 137250f;
            float PanelPhysicalHeightMicroMeters = 77200f;
            
            context.ResponseData.Write(PanelPhysicalWidthMicroMeters / 1000f);
            context.ResponseData.Write(PanelPhysicalHeightMicroMeters / 1000f);

            return ResultCode.Success;
        }

        [CommandCmif(1005)] // 21.0.0+
        // GetPanelResolutionForSpecificTitle() -> (s32 width, s32 height)
        public ResultCode GetPanelResolutionForSpecificTitle(ServiceCtx context)
        {
            if (!IsVrLaboGoggleSupportedTitle(context))
            {
                return ResultCode.ObjectInvalid;
            }
            
            context.ResponseData.Write(_resolutionWidth);
            context.ResponseData.Write(_resolutionHeight);

            return ResultCode.Success;
        }

        private static bool IsVrLaboGoggleSupportedTitle(ServiceCtx context)
        {
            ulong programId = context.Device.Processes.ActiveApplication.ProgramId;

            return _supportedVRGoggleTitles.Contains(programId);
        }

        protected override void Dispose(bool isDisposing)
        {
            if (isDisposing)
            {
                if (_acquiredSleepLockEventHandle != 0)
                {
                    _context.Process.HandleTable.CloseHandle(_acquiredSleepLockEventHandle);
                    _acquiredSleepLockEventHandle = 0;
                }
            }
        }
    }
}