encore: add in some new settings, expose some other settings, rework upscaling management (more in line with how melonds is handled)

encore/build_release.bat

@@ -2,6 +2,6 @@ rmdir /s /q build
 mkdir build
 cd build
 cmake ..\encore -DCMAKE_BUILD_TYPE=Release -DENABLE_LTO=ON -DCMAKE_C_COMPILER=cl ^
- -DCMAKE_CXX_COMPILER=cl -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded 
+ -DCMAKE_CXX_COMPILER=cl -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded -DENABLE_VULKAN=OFF -G Ninja
 ninja
 cd ..

encore/encore

@@ -1 +1 @@
-Subproject commit 438249f25aefd2d750aa0d7a45f4bb35da047a3e
+Subproject commit c34960de8689d778ecbb24c425dfa8b1c928fa42

src/BizHawk.Emulation.Cores/Consoles/Nintendo/3DS/Encore.IEmulator.cs

@@ -53,7 +53,8 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 
 		private void OnVideoRefresh()
 		{
-			_core.Encore_GetVideoDimensions(_context, out _encoreVideoProvider.Width, out _encoreVideoProvider.Height);
+			_core.Encore_GetVideoVirtualDimensions(_context, out _encoreVideoProvider.VW, out _encoreVideoProvider.VH);
+			_core.Encore_GetVideoBufferDimensions(_context, out _encoreVideoProvider.BW, out _encoreVideoProvider.BH);
 			_encoreVideoProvider.VideoDirty = true;
 
 			_core.Encore_GetTouchScreenLayout(_context, out var x, out var y, out var width, out var height, out var rotated, out var enabled);

src/BizHawk.Emulation.Cores/Consoles/Nintendo/3DS/Encore.ISettable.cs

@@ -19,11 +19,15 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 		private bool GetBooleanSettingCallback(string label) => label switch
 		{
 			"use_cpu_jit" => _syncSettings.UseCpuJit,
+			"async_shader_compilation" => !DeterministicEmulation && _syncSettings.AsyncShaderCompilation,
 			"use_hw_shader" => _syncSettings.UseHwShader,
 			"shaders_accurate_mul" => _syncSettings.ShadersAccurateMul,
 			"use_shader_jit" => _syncSettings.UseShaderJit,
 			"use_virtual_sd" => _syncSettings.UseVirtualSd,
 			"is_new_3ds" => _syncSettings.IsNew3ds,
+			"lle_applets" => _syncSettings.LleApplets,
+			"plugin_loader" => _syncSettings.PluginLoaderEnabled,
+			"allow_plugin_loader" => _syncSettings.AllowPluginLoader,
 			"filter_mode" => _settings.FilterMode,
 			"swap_screen" => _settings.SwapScreen,
 			"upright_screen" => _settings.UprightScreen,
@@ -36,10 +40,12 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 		private ulong GetIntegerSettingCallback(string label) => label switch
 		{
 			"cpu_clock_percentage" => (ulong)_syncSettings.CpuClockPercentage,
-			"graphics_api" => (ulong)EncoreSyncSettings.EGraphicsApi.OpenGL,//_supportsOpenGL43 ? (ulong)_syncSettings.GraphicsApi : (ulong)EncoreSyncSettings.EGraphicsApi.Software,
+			"graphics_api" => (ulong)EncoreSyncSettings.EGraphicsApi.OpenGL,/*_supportsOpenGL43 ? (ulong)_syncSettings.GraphicsApi : (ulong)EncoreSyncSettings.EGraphicsApi.Software,*/
 			"region_value" => (ulong)_syncSettings.RegionValue,
 			"init_clock" => _syncSettings.UseRealTime && !DeterministicEmulation ? 0UL : 1UL,
 			"init_time" => (ulong)(_syncSettings.InitialTime - _epoch).TotalSeconds,
+			"init_ticks_type" => _syncSettings.RandomInitTicks && !DeterministicEmulation ? 0UL : 01UL,
+			"init_ticks_override" => (ulong)_syncSettings.InitTickCount,
 			"birthmonth" => (ulong)_syncSettings.CFGBirthdayMonth,
 			"birthday" => (ulong)_syncSettings.CFGBirthdayDay,
 			"language" => (ulong)_syncSettings.CFGSystemLanguage,
@@ -47,6 +53,7 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			"playcoins" => _syncSettings.PTMPlayCoins,
 			"resolution_factor" => (ulong)_settings.ResolutionFactor,
 			"texture_filter" => (ulong)_settings.TextureFilter,
+			"texture_sampling" => (ulong)_settings.TextureSampling,
 			"mono_render_option" => (ulong)_settings.MonoRenderOption,
 			"render_3d" => (ulong)_settings.StereoRenderOption,
 			"factor_3d" => (ulong)_settings.Factor3D,
@@ -60,7 +67,6 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			"custom_bottom_right" => (ulong)_settings.CustomLayoutBottomScreenRectangle.Right,
 			"custom_bottom_bottom" => (ulong)_settings.CustomLayoutBottomScreenRectangle.Bottom,
 			"custom_second_layer_opacity" => (ulong)_settings.CustomLayoutSecondLayerOpacity,
-			"window_scale_factor" => (ulong)_settings.WindowFactor,
 			_ => throw new InvalidOperationException()
 		};
 
@@ -118,22 +124,15 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			[Range(1, 10)]
 			[TypeConverter(typeof(ConstrainedIntConverter))]
 			public int ResolutionFactor { get; set; }
-			
-			[DisplayName("Window Scale Factor")]
-			[Description("Scale factor for the window.")]
-			[DefaultValue(1)]
-			[Range(1, 10)]
-			[TypeConverter(typeof(ConstrainedIntConverter))]
-			public int WindowFactor { get; set; }
 
 			public enum ETextureFilter
 			{
 				None = 0,
 				Anime4K = 1,
 				Bicubic = 2,
-				NearestNeighbor = 3,
-				ScaleForce = 4,
-				xBRZ = 5
+				ScaleForce = 3,
+				xBRZ = 4,
+				MMPX = 5,
 			}
 
 			[DisplayName("Texture Filter")]
@@ -141,6 +140,18 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			[DefaultValue(ETextureFilter.None)]
 			public ETextureFilter TextureFilter { get; set; }
 
+			public enum ETextureSampling
+			{
+				GameControlled = 0,
+				NearestNeighbor = 1,
+				Linear = 2,
+			}
+
+			[DisplayName("Texture Sampling")]
+			[Description("")]
+			[DefaultValue(ETextureSampling.GameControlled)]
+			public ETextureSampling TextureSampling { get; set; }
+
 			public enum EMonoRenderOption
 			{
 				LeftEye,
@@ -244,6 +255,11 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 		[CoreSettings]
 		public class EncoreSyncSettings
 		{
+			[DisplayName("Use Temp User Folder For Movies")]
+			[Description("WARNING: Setting this to false means your current user folder will be used, if the folder is not prepared correctly your movie will desync!")]
+			[DefaultValue(true)]
+			public bool TempUserFolder { get; set; }
+
 			[DisplayName("Use CPU JIT")]
 			[Description("Whether to use the Just-In-Time (JIT) compiler for CPU emulation")]
 			[DefaultValue(true)]
@@ -258,17 +274,26 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			[TypeConverter(typeof(ConstrainedIntConverter))]
 			public int CpuClockPercentage { get; set; }
 
+			/// <summary>
+			/// TOOD: Vulkan support
+			/// </summary>
 			public enum EGraphicsApi
 			{
-				Software,
-				OpenGL
+				Software = 0,
+				OpenGL = 1,
 			}
 
 			[DisplayName("Graphics API")]
-			[Description("Whether to render using OpenGL or Software. Forced to software if OpenGL 4.3+ is not available.")]
+			[Description("Whether to render using OpenGL or Software. Forced to software if OpenGL 4.3+ is not available.\n" +
+				"NOTE: Set the 'Display Method' in Config -> Display to OpenGL for optimal OpenGL rendering performance.")]
 			[DefaultValue(EGraphicsApi.OpenGL)]
 			public EGraphicsApi GraphicsApi { get; set; }
 
+			[DisplayName("Async Shader Compilation")]
+			[Description("Compile shaders in background threads to avoid shader compilation stutters. Ignored (set to false) when recording a movie.")]
+			[DefaultValue(true)]
+			public bool AsyncShaderCompilation { get; set; }
+
 			[DisplayName("Use HW Shader")]
 			[Description("Whether to use hardware shaders to emulate 3DS shaders")]
 			[DefaultValue(true)]
@@ -301,6 +326,11 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			[DefaultValue(true)]
 			public bool IsNew3ds { get; set; }
 
+			[DisplayName("LLE Applets")]
+			[Description("Whether to use LLE system applets, if installed.")]
+			[DefaultValue(false)]
+			public bool LleApplets { get; set; }
+
 			public enum ERegionValue
 			{
 				Autodetect = -1,
@@ -328,7 +358,27 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			[DefaultValue(typeof(DateTime), "2010-01-01")]
 			[TypeConverter(typeof(BizDateTimeConverter))]
 			public DateTime InitialTime { get; set; }
-			
+
+			[DisplayName("Random Initial Ticks")]
+			[Description("If true, the initial system tick count will be randomized. Ignored (set to false) when recording a movie.")]
+			[DefaultValue(true)]
+			public bool RandomInitTicks { get; set; }
+
+			[DisplayName("Initial Tick Count")]
+			[Description("The system ticks count to use when Encore starts, if not randomized.")]
+			[DefaultValue(typeof(long), "0")]
+			public long InitTickCount { get; set; }
+
+			[DisplayName("Enable 3GX Plugin Loader")]
+			[Description("")]
+			[DefaultValue(false)]
+			public bool PluginLoaderEnabled { get; set; }
+
+			[DisplayName("Allow Games To Change Plugin Loader State")]
+			[Description("")]
+			[DefaultValue(true)]
+			public bool AllowPluginLoader { get; set; }
+
 			[DisplayName("CFG Username")]
 			[Description("The system username that Encore will use during emulation")]
 			[DefaultValue("ENCORE")]
@@ -396,9 +446,9 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			[Description("The system sound output mode that Encore will use during emulation")]
 			[DefaultValue(ECFGSoundOutputMode.Stereo)]
 			public ECFGSoundOutputMode CFGSoundOutputMode { get; set; }
-			
-			[DisplayName("CFG Sound Output Mode")]
-			[Description("The system sound output mode that Encore will use during emulation")]
+
+			[DisplayName("PTM Play Coins")]
+			[Description("")]
 			[DefaultValue(typeof(ushort), "42")]
 			public ushort PTMPlayCoins { get; set; }
 

src/BizHawk.Emulation.Cores/Consoles/Nintendo/3DS/Encore.IVideoProvider.cs

@@ -6,8 +6,10 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 {
 	public class EncoreVideoProvider : IVideoProvider
 	{
-		internal int Width = 400;
-		internal int Height = 480;
+		internal int VW = 400;
+		internal int VH = 480;
+		internal int BW = 400;
+		internal int BH = 480;
 		internal bool VideoDirty;
 
 		protected readonly LibEncore _core;
@@ -20,10 +22,10 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 		}
 
 		// ReSharper disable ConvertToAutoPropertyWhenPossible
-		public int VirtualWidth => Width;
-		public int VirtualHeight => Height;
-		public int BufferWidth => Width;
-		public int BufferHeight => Height;
+		public int VirtualWidth => VW;
+		public int VirtualHeight => VH;
+		public int BufferWidth => BW;
+		public int BufferHeight => BH;
 		public int VsyncNumerator => 268111856;
 		public int VsyncDenominator => 4481136;
 		public int BackgroundColor => 0;
@@ -34,9 +36,9 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 		{
 			if (VideoDirty)
 			{
-				if (_vbuf.Length < Width * Height)
+				if (_vbuf.Length < BW * BH)
 				{
-					_vbuf = new int[Width * Height];
+					_vbuf = new int[BW * BH];
 				}
 
 				_core.Encore_ReadFrameBuffer(_context, _vbuf);

src/BizHawk.Emulation.Cores/Consoles/Nintendo/3DS/Encore.cs

@@ -61,7 +61,7 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			_syncSettings = lp.SyncSettings ?? new();
 
 			DeterministicEmulation = lp.DeterministicEmulationRequested;
-			_userPath = lp.Comm.CoreFileProvider.GetUserPath(SystemId, temp: DeterministicEmulation) + Path.DirectorySeparatorChar;
+			_userPath = lp.Comm.CoreFileProvider.GetUserPath(SystemId, temp: DeterministicEmulation && _syncSettings.TempUserFolder) + Path.DirectorySeparatorChar;
 			_userPath = _userPath.Replace('\\', '/'); // Encore doesn't like backslashes in the user folder, for whatever reason
 
 			_configCallbackInterface.GetBoolean = GetBooleanSettingCallback;
@@ -74,7 +74,7 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			if (!_supportsOpenGL43/* && _syncSettings.GraphicsApi == EncoreSyncSettings.EGraphicsApi.OpenGL*/)
 			{
 				throw new("OpenGL 4.3 is required, but it is not supported on this machine");
-//				lp.Comm.Notify("OpenGL 4.3 is not supported on this machine, falling back to software renderer", null);
+				//lp.Comm.Notify("OpenGL 4.3 is not supported on this machine, falling back to software renderer", null);
 			}
 
 			_glCallbackInterface.RequestGLContext = RequestGLContextCallback;
@@ -155,7 +155,7 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 			if (!_core.Encore_LoadROM(_context, romPath, errorMessage, errorMessage.Length))
 			{
 				Dispose();
-				throw new($"{Encoding.UTF8.GetString(errorMessage).TrimEnd()}");
+				throw new($"{Encoding.UTF8.GetString(errorMessage).TrimEnd('\0')}");
 			}
 
 			InitMemoryDomains();

src/BizHawk.Emulation.Cores/Consoles/Nintendo/3DS/LibEncore.cs

@@ -122,7 +122,10 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.N3DS
 		public abstract void Encore_Reset(IntPtr context);
 
 		[BizImport(cc)]
-		public abstract void Encore_GetVideoDimensions(IntPtr context, out int width, out int height);
+		public abstract void Encore_GetVideoVirtualDimensions(IntPtr context, out int width, out int height);
+
+		[BizImport(cc)]
+		public abstract void Encore_GetVideoBufferDimensions(IntPtr context, out int width, out int height);
 
 		[BizImport(cc)]
 		public abstract int Encore_GetGLTexture(IntPtr context);