0.6.0.100 - fix MIDI inputs, song-end/fail judgement, autoplay, refactored input binding, ... (#910)

- [Fix] Refine gameplay time point and fix related issues (after climbed to tower top in tower mode, 2 seconds after last note, 1 second after `#END`, 0 seconds after music ends)
- [Fix] Stop aligning branch end (except at end of song) in TJAP3 or OOS compatibility mode
- [Fix] Prevent branch judge point before last measure (or `#NEXTSONG`, or 4 beats before chart start)
- [Fix] Every player now has individual lives in Kanpeki mode
- [Enhancement] Make mid-song fail animation play per player, and stop chart right when all players have failed [WARNING: skinners might need to update `<skin>/Graphics/5_Game/9_End/ClearFailed/Script.lua`]
- [Enhancement] Missing end-of-play animation/sounds now fallbacks to red-pass (for Dan-i mode) or regular chart's animation/sounds
- [Fix] Non-keyboard devices could not use some menus due to `CKeyAssign.KeyIsPressed()` could only detect keyboard inputs (#908)
- [Feat] Reimplement MIDI input using managed-midi, using TJAPlayer3-f's implementation as reference (#612)
- [Enhancement] Remember up to 36 (from 10) input devices per device type (Keyboard and Mouse remain not remembered)
- [Fix] Ensure gameplay inputs are processed in event timestamp order
- [Fix] In training mode, prevent pausing or (un)set bookmark during playing when the keybind is also player's game input (#903)
- [Fix] Prevent wrong judgement window due to wrongly using "actual player index"
- [Fix] Autoplay could only properly hit 1 note per frame, could miss when game lags, and could not handle multi-hit note misses properly
- [Fix] Displayed score became less than real score when exceeding 256 score increases in a frame
- [Fix] Played song speed was old one when first playing after adjusting song speed in training mode
- [Fix] Crashes on selecting undefined difficulties (`LEVEL` before `COURSE`), again
- [Fix] Towers with missing or negative `LIFE:` immediately failed player while having 5 lives (unless using Pause -> Retry)
- [Fix] Kanpeki fail in tower chart at top floor could be judged as pass
- [Fix] Disable Kanpeki mode in training mode
- [Fix] Adlib and bomb were neither hit by autoplay nor missed and broke Dan-i condition monitoring
- [Fix] Bomb and fuze roll did not trigger hard gauges and Kanpeki mode failure
- [Fix] Tight (notelock) mode did not give BAD for empty hits since 0.6.0.93
- [Fix] Lyrics from `#LYRICS` appeared at wrong time in Dan-i mode
- [Fix] Make TJA `LYRICFILE:` alias of `LYRICS:`
- [Fix] Warn and ignore bad characters from TJA note data, for handling ill-formed comment (ignore if not digit nor letter)
- [Fix] `box.def` parsing trimmed too many characters for values and allow omitting of colon (`:`)
- [Fix] Calling `AddGraph()` in BG Lua Script twice with same filepath caused exception
- [Fix] All BG Lua script errors are now logged and shown on screen
- [Fix] Force big note firework for balloon's flying note
- [Fix] AI battle section progression bar was negative before chart start
- [Fix] Bad note position precision for extremely big/small SCROLL combined with small/big BPM values
- [Fix] Clearing fuzeroll lacked character animation
- [Fix] Roll redness fading out speed depended on framerate
- [Fix] Notes and bar lines now continue at end of song and stop when failed in tower/Dan-i/Kanpeki failure, instead of simply disappearing
- [Fix] Balloon's and fuze's remaining pop count was semi-transparent after non-balloon roll count fading out
- [Fix] Revert `#DIRECTION` behavior to TJAP3 (keep vertical scrolling of non-real `#SCROLL`), accidentally changed in v0.6.0.56
- [Fix] Characters now play clear-out + miss-down animation when failed mid-song
- [Fix] Bugs related to song end or mid-song failure animation
- [Fix] Wrong character animation played when finishing tower
- [Fix] Draw pop select menu on top, above fading in/out
- [Fix] Opened Kusudama is now shown when pause menu is open
- [Optimize] Minor optimizing for note-count-heavy charts:
- [Optimize] Pre-build name-to-index lookup dictionary for puchi charas
- [Optimize] Cache double-to-integer converted chip time
- [Optimize] Only update `chip.nLag` when the note is actually judged
- [Optimize] Make `enum NoteType` values same as channelNo to reduce conversions
- [Optimize] Skip chip post processing of TJA parsing if is for song enumeration
- [Optimize] Make `listBPM` an actual List instead of a Dictionary (due to legacy DTX parsing)
- [Optimize] Only query all input devices for gameplay once instead of `EPad.Max` (38) times
- [Optimize] Replace `OrderBy()` with in-place sort stabilized by index to eliminate temporary list
- [Optimize] song-end animation could load twice or unused sound resources by only (un)loading at (De)`Activate()`
- [Chore] Extract and use `NotesManager.GetChipGameType()`
- [Chore] Remove unused fields in `CChip`
- [Chore] Simplify input device querying
- [Chore] Merge `enum EInputDevice` into FDK's `enum InputDeviceType`
- [Chore] Simplify key assignment defining and accessing

Author: IepIweidieng

FDK/FDK.csproj

@@ -7,6 +7,7 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
   </PropertyGroup>
   <ItemGroup>
+    <PackageReference Include="managed-midi" Version="1.10.1" />
     <PackageReference Include="ReadJEnc" Version="1.3.1.2" />
     <PackageReference Include="Silk.NET.OpenGLES.Extensions.ImGui" Version="2.21.0" />
     <PackageReference Include="Silk.NET.Windowing" Version="2.21.0" />

FDK/src/00.Common/CConversion.cs

@@ -73,98 +73,85 @@ public static int StringToInt(string text, int defaultValue) {
 		return num;
 	}
 
-	public static int HexStringToInt(string strNum) {
-		if (strNum.Length < 2)
-			return -1;
-
-		int digit2 = HexChars.IndexOf(strNum[0]);
-		if (digit2 < 0)
-			return -1;
-
-		if (digit2 >= 16)
-			digit2 -= (16 - 10);        // A,B,C... -> 1,2,3...
-
-		int digit1 = HexChars.IndexOf(strNum[1]);
-		if (digit1 < 0)
-			return -1;
-
-		if (digit1 >= 16)
-			digit1 -= (16 - 10);
-
-		return digit2 * 16 + digit1;
-	}
-
-	public static int Base36StringToInt(string strNum) {
-		if (strNum.Length < 2)
-			return -1;
-
-		int digit2 = Base36Chars.IndexOf(strNum[0]);
-		if (digit2 < 0)
-			return -1;
-
-		if (digit2 >= 36)
-			digit2 -= (36 - 10);        // A,B,C... -> 1,2,3...
-
-		int digit1 = Base36Chars.IndexOf(strNum[1]);
-		if (digit1 < 0)
-			return -1;
-
-		if (digit1 >= 36)
-			digit1 -= (36 - 10);
-
-		return digit2 * 36 + digit1;
-	}
-
-	public static int ParseSectionNumber(string strNum) {
-		if (strNum.Length >= 3) {
-			int digit3 = Base36Chars.IndexOf(strNum[0]);
-			if (digit3 < 0)
-				return -1;
-
-			if (digit3 >= 36)                                   // 3桁目は36進数
-				digit3 -= (36 - 10);
-
-			int digit2 = HexChars.IndexOf(strNum[1]);  // 2桁目は10進数
-			if ((digit2 < 0) || (digit2 > 9))
-				return -1;
-
-			int digit1 = HexChars.IndexOf(strNum[2]);  // 1桁目も10進数
-			if ((digit1 >= 0) && (digit1 <= 9))
-				return digit3 * 100 + digit2 * 10 + digit1;
+	private static bool TryParseHexChar(char num, out int digit) {
+		digit = HexChars.IndexOf(num);
+		if (digit < 0)
+			return false;
+		// treat lower case as upper case
+		if (digit >= 0x10)
+			digit -= (0x10 - 10);
+		return true;
+	}
+
+	public static bool TryParseBase36Char(char num, out int digit) {
+		digit = Base36Chars.IndexOf(num);
+		if (digit < 0)
+			return false;
+		// treat lower case as upper case
+		if (digit >= 36)
+			digit -= (36 - 10);
+		return true;
+	}
+
+	public static int HexStringToInt(string strNum) =>
+		(strNum.Length >= 2
+			&& TryParseHexChar(strNum[0], out int digit2)
+			&& TryParseHexChar(strNum[1], out int digit1)
+		) ? digit2 * 0x10 + digit1
+		: -1;
+
+	public static int Base36StringToInt(string strNum) =>
+		(strNum.Length >= 2
+			&& TryParseBase36Char(strNum[0], out int digit2)
+			&& TryParseBase36Char(strNum[1], out int digit1)
+		) ? digit2 * 36 + digit1
+		: -1;
+
+	public static int ParseSectionNumber(string strNum) =>
+		(strNum.Length >= 3
+			&& TryParseBase36Char(strNum[0], out int digit3)
+			&& TryParseHexChar(strNum[1], out int digit2)
+			&& TryParseHexChar(strNum[2], out int digit1)
+		) ? digit3 * 100 + digit2 * 10 + digit1
+		: -1;
+
+	public static bool TryConvertToHexChar(int num, out char digit) {
+		if (num >= 0 && num < 0x10) {
+			digit = HexChars[num];
+			return true;
 		}
-		return -1;
+		digit = '\0';
+		return false;
 	}
 
-	public static string SectionNumberToString(int num) {
-		if ((num < 0) || (num >= 3600)) // 3600 == Z99 + 1
-			return "000";
-
-		int digit4 = num / 100;
-		int digit2 = (num % 100) / 10;
-		int digit1 = (num % 100) % 10;
-		char ch3 = Base36Chars[digit4];
-		char ch2 = HexChars[digit2];
-		char ch1 = HexChars[digit1];
-		return (ch3.ToString() + ch2.ToString() + ch1.ToString());
+	public static bool TryConvertToBase36Char(int num, out char digit) {
+		if (num >= 0 && num < 36) {
+			digit = Base36Chars[num];
+			return true;
+		}
+		digit = '\0';
+		return false;
 	}
 
-	public static string IntToHexString(int num) {
-		if ((num < 0) || (num >= 0x100))
-			return "00";
+	public static string SectionNumberToString(int num) =>
+		(TryConvertToBase36Char(num / 100, out char ch3)
+			&& TryConvertToHexChar((num % 100) / 10, out char ch2)
+			&& TryConvertToHexChar((num % 100) % 10, out char ch1)
+		) ? (ch3.ToString() + ch2.ToString() + ch1.ToString())
+		: "000";
 
-		char ch2 = HexChars[num / 0x10];
-		char ch1 = HexChars[num % 0x10];
-		return (ch2.ToString() + ch1.ToString());
-	}
+	public static string IntToHexString(int num) =>
+		(TryConvertToHexChar(num / 0x10, out char ch2)
+			&& TryConvertToHexChar(num % 0x10, out char ch1)
+		) ? (ch2.ToString() + ch1.ToString())
+		: "00";
 
-	public static string IntToBase36String(int num) {
-		if ((num < 0) || (num >= 36 * 36))
-			return "00";
 
-		char ch2 = Base36Chars[num / 36];
-		char ch1 = Base36Chars[num % 36];
-		return (ch2.ToString() + ch1.ToString());
-	}
+	public static string IntToBase36String(int num) =>
+		(TryConvertToBase36Char(num / 36, out char ch2)
+			&& TryConvertToBase36Char(num % 36, out char ch1)
+		) ? (ch2.ToString() + ch1.ToString())
+		: "00";
 
 	public static int[] StringToIntArray(string str) {
 		//0,1,2 ...の形式で書かれたstringをint配列に変換する。

FDK/src/02.Input/CInputButtonsBase.cs

@@ -14,14 +14,15 @@ public CInputButtonsBase(int nButtonStates) {
 
 	// メソッド
 
-	public void SetID(int nID) => this.ID = nID;
+	public virtual int GetVelocity(int index) => 0;
+	protected virtual void SetVelocity(int index, int velocity) { }
 
 	#region [ IInputDevice 実装 ]
 	//-----------------
-	public Silk.NET.Input.IInputDevice Device { get; protected set; }
+	public Silk.NET.Input.IInputDevice? Device { get; protected set; }
 	public InputDeviceType CurrentType { get; protected set; }
 	public string GUID { get; protected set; }
-	public int ID { get; protected set; }
+	public int ID { get; set; }
 	public string Name { get; protected set; }
 	public List<STInputEvent> InputEvents { get; protected set; }
 	public string strDeviceName { get; set; }
@@ -34,20 +35,20 @@ public void Polling() {
 		// for buffered input, the input buffer has already been filled.
 		for (int i = 0; i < ButtonStates.Length; i++) {
 			// Use the same timer used in gameplay to prevent desyncs between BGM/chart and input.
-			this.ProcessButtonState(i, SoundManager.PlayTimer.SystemTimeMs);
+			this.ProcessButtonState(i, SoundManager.PlayTimer.SystemTimeMs, this.GetVelocity(i));
 		}
 		// swap input buffer
 		(this.InputEvents, this.EventBuffer) = (this.EventBuffer, this.InputEvents);
 	}
 
-	protected void ProcessButtonState(int idxBtn, long msTimestamp) {
+	protected void ProcessButtonState(int idxBtn, long msTimestamp, int velocity = 0) {
 		if (ButtonStates[idxBtn].isPressed) {
 			if (ButtonStates[idxBtn].state >= 1) {
 				ButtonStates[idxBtn].state = 2;
 			} else {
 				ButtonStates[idxBtn].state = 1;
 				if (!this.useBufferInput) {
-					this.AddPressedEvent(idxBtn, msTimestamp);
+					this.AddPressedEvent(idxBtn, msTimestamp, velocity);
 				}
 			}
 		} else {
@@ -71,20 +72,21 @@ protected void AddReleasedEvent(int idxBtn, long msTImestamp)
 			nVelocity = 0,
 		});
 
-	protected void AddPressedEvent(int idxBtn, long msTimestamp)
+	protected void AddPressedEvent(int idxBtn, long msTimestamp, int velocity = 0)
 		=> this.EventBuffer.Add(new STInputEvent() {
 			nKey = idxBtn,
 			Pressed = true,
 			Released = false,
 			nTimeStamp = msTimestamp,
-			nVelocity = 0,
+			nVelocity = velocity,
 		});
 
-	protected void ButtonDown(int idxBtn) {
+	protected void ButtonDown(int idxBtn, int velocity = 0) {
 		if (this.useBufferInput && !this.ButtonStates[idxBtn].isPressed) {
-			this.AddPressedEvent(idxBtn, SoundManager.PlayTimer.msGetPreciseNowSoundTimerTime());
+			this.AddPressedEvent(idxBtn, SoundManager.PlayTimer.msGetPreciseNowSoundTimerTime(), velocity);
 		}
 		this.ButtonStates[idxBtn].isPressed = true;
+		this.SetVelocity(idxBtn, velocity);
 	}
 
 	protected void ButtonUp(int idxBtn) {
@@ -111,7 +113,7 @@ public bool KeyReleasing(int nButton) {
 
 	#region [ IDisposable 実装 ]
 	//-----------------
-	public void Dispose() {
+	public virtual void Dispose() {
 		if (!this.IsDisposed) {
 			this.InputEvents.Clear();
 			this.EventBuffer.Clear();
@@ -128,7 +130,7 @@ public void Dispose() {
 	//-----------------
 	public List<STInputEvent> EventBuffer;
 	public (bool isPressed, int state)[] ButtonStates { get; protected set; }
-	private bool IsDisposed;
+	protected bool IsDisposed;
 	//-----------------
 	#endregion
 }