Merge pull request #337 from FunkinCrew/input-offsets

Input offsets

.vscode/launch.json

@@ -7,6 +7,12 @@
       "type": "lime",
       "request": "launch"
     },
+    {
+      "name": "Debug",
+      "type": "lime",
+      "request": "launch",
+      "preLaunchTask": null
+    },
     {
       // Launch in browser
       "name": "HTML5 Debug",

.vscode/tasks.json

@@ -1,13 +1,13 @@
 {
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"type": "lime",
-			"command": "test",
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
-		}
-	]
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "lime",
+      "command": "test",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
 }

source/funkin/Conductor.hx

@@ -5,6 +5,9 @@ import flixel.util.FlxSignal;
 import flixel.math.FlxMath;
 import funkin.data.song.SongData.SongTimeChange;
 import funkin.data.song.SongDataUtils;
+import funkin.save.Save;
+import haxe.Timer;
+import flixel.sound.FlxSound;
 
 /**
  * A core class which handles musical timing throughout the game,
@@ -89,6 +92,9 @@ class Conductor
    */
   public var songPosition(default, null):Float = 0;
 
+  var prevTimestamp:Float = 0;
+  var prevTime:Float = 0;
+
   /**
    * Beats per minute of the current song at the current time.
    */
@@ -233,8 +239,41 @@ class Conductor
 
   /**
    * An offset set by the user to compensate for input lag.
+   * No matter if you're using a local conductor or not, this always loads
+   * to/from the save file
    */
-  public var inputOffset:Float = 0;
+  public var inputOffset(get, set):Int;
+
+  /**
+   * An offset set by the user to compensate for audio/visual lag
+   * No matter if you're using a local conductor or not, this always loads
+   * to/from the save file
+   */
+  public var audioVisualOffset(get, set):Int;
+
+  function get_inputOffset():Int
+  {
+    return Save.instance.options.inputOffset;
+  }
+
+  function set_inputOffset(value:Int):Int
+  {
+    Save.instance.options.inputOffset = value;
+    Save.instance.flush();
+    return Save.instance.options.inputOffset;
+  }
+
+  function get_audioVisualOffset():Int
+  {
+    return Save.instance.options.audioVisualOffset;
+  }
+
+  function set_audioVisualOffset(value:Int):Int
+  {
+    Save.instance.options.audioVisualOffset = value;
+    Save.instance.flush();
+    return Save.instance.options.audioVisualOffset;
+  }
 
   /**
    * The number of beats in a measure. May be fractional depending on the time signature.
@@ -353,16 +392,19 @@ class Conductor
    * BPM, current step, etc. will be re-calculated based on the song position.
    *
    * @param	songPosition The current position in the song in milliseconds.
-   *        Leave blank to use the `FlxG.sound.music` position.
+   *        Leave blank to use the FlxG.sound.music position.
+   * @param applyOffsets If it should apply the instrumentalOffset + formatOffset + audioVisualOffset
    */
-  public function update(?songPos:Float):Void
+  public function update(?songPos:Float, applyOffsets:Bool = true, forceDispatch:Bool = false)
   {
     if (songPos == null)
     {
-      // Take into account instrumental and file format song offsets.
-      songPos = (FlxG.sound.music != null) ? (FlxG.sound.music.time + instrumentalOffset + formatOffset) : 0.0;
+      songPos = (FlxG.sound.music != null) ? FlxG.sound.music.time : 0.0;
     }
 
+    // Take into account instrumental and file format song offsets.
+    songPos += applyOffsets ? (instrumentalOffset + formatOffset + audioVisualOffset) : 0;
+
     var oldMeasure:Float = this.currentMeasure;
     var oldBeat:Float = this.currentBeat;
     var oldStep:Float = this.currentStep;
@@ -421,6 +463,35 @@ class Conductor
     {
       this.onMeasureHit.dispatch();
     }
+
+    // only update the timestamp if songPosition actually changed
+    // which it doesn't do every frame!
+    if (prevTime != this.songPosition)
+    {
+      // Update the timestamp for use in-between frames
+      prevTime = this.songPosition;
+      prevTimestamp = Std.int(Timer.stamp() * 1000);
+    }
+  }
+
+  /**
+   * Can be called in-between frames, usually for input related things
+   * that can potentially get processed on exact milliseconds/timestmaps.
+   * If you need song position, use `Conductor.instance.songPosition` instead
+   * for use in update() related functions.
+   * @param soundToCheck Which FlxSound object to check, defaults to FlxG.sound.music if no input
+   * @return Float
+   */
+  public function getTimeWithDiff(?soundToCheck:FlxSound):Float
+  {
+    if (soundToCheck == null) soundToCheck = FlxG.sound.music;
+    // trace(this.songPosition);
+
+    @:privateAccess
+    this.songPosition = soundToCheck._channel.position;
+    // return this.songPosition + (Std.int(Timer.stamp() * 1000) - prevTimestamp);
+    // trace("\t--> " + this.songPosition);
+    return this.songPosition;
   }
 
   /**
@@ -468,7 +539,7 @@ class Conductor
     }
 
     // Update currentStepTime
-    this.update(Conductor.instance.songPosition);
+    this.update(this.songPosition, false);
   }
 
   /**
@@ -587,7 +658,8 @@ class Conductor
   }
 
   /**
-   * Add variables of the current Conductor instance to the Flixel debugger.
+   * Adds Conductor fields to the Flixel debugger variable display.
+   * @param conductorToUse The conductor to use. Defaults to `Conductor.instance`.
    */
   public static function watchQuick(?target:Conductor):Void
   {

source/funkin/InitState.hx

@@ -16,14 +16,14 @@ import funkin.util.macro.MacroUtil;
 import funkin.util.WindowUtil;
 import funkin.play.PlayStatePlaylist;
 import openfl.display.BitmapData;
-import funkin.data.level.LevelRegistry;
+import funkin.data.story.level.LevelRegistry;
 import funkin.data.notestyle.NoteStyleRegistry;
 import funkin.data.event.SongEventRegistry;
 import funkin.data.stage.StageRegistry;
-import funkin.data.dialogue.ConversationRegistry;
-import funkin.data.dialogue.DialogueBoxRegistry;
-import funkin.data.dialogue.SpeakerRegistry;
-import funkin.data.freeplay.AlbumRegistry;
+import funkin.data.dialogue.conversation.ConversationRegistry;
+import funkin.data.dialogue.dialoguebox.DialogueBoxRegistry;
+import funkin.data.dialogue.speaker.SpeakerRegistry;
+import funkin.data.freeplay.album.AlbumRegistry;
 import funkin.data.song.SongRegistry;
 import funkin.play.character.CharacterData.CharacterDataParser;
 import funkin.modding.module.ModuleHandler;
@@ -304,7 +304,7 @@ class InitState extends FlxState
    */
   function startLevel(levelId:String, difficultyId:String = 'normal'):Void
   {
-    var currentLevel:funkin.ui.story.Level = funkin.data.level.LevelRegistry.instance.fetchEntry(levelId);
+    var currentLevel:funkin.ui.story.Level = funkin.data.story.level.LevelRegistry.instance.fetchEntry(levelId);
 
     if (currentLevel == null)
     {

source/funkin/data/DataParse.hx

@@ -120,7 +120,7 @@ class DataParse
     }
   }
 
-  public static function backdropData(json:Json, name:String):funkin.data.dialogue.ConversationData.BackdropData
+  public static function backdropData(json:Json, name:String):funkin.data.dialogue.conversation.ConversationData.BackdropData
   {
     switch (json.value)
     {
@@ -152,7 +152,7 @@ class DataParse
     }
   }
 
-  public static function outroData(json:Json, name:String):Null<funkin.data.dialogue.ConversationData.OutroData>
+  public static function outroData(json:Json, name:String):Null<funkin.data.dialogue.conversation.ConversationData.OutroData>
   {
     switch (json.value)
     {

source/funkin/data/dialogue/conversation/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Dialogue Conversation Data Schema Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0]
+Initial release.

source/funkin/data/dialogue/ConversationData.hx → source/funkin/data/dialogue/conversation/ConversationData.hx

@@ -1,4 +1,4 @@
-package funkin.data.dialogue;
+package funkin.data.dialogue.conversation;
 
 import funkin.data.animation.AnimationData;
 

source/funkin/data/dialogue/ConversationRegistry.hx → source/funkin/data/dialogue/conversation/ConversationRegistry.hx

@@ -1,7 +1,7 @@
-package funkin.data.dialogue;
+package funkin.data.dialogue.conversation;
 
 import funkin.play.cutscene.dialogue.Conversation;
-import funkin.data.dialogue.ConversationData;
+import funkin.data.dialogue.conversation.ConversationData;
 import funkin.play.cutscene.dialogue.ScriptedConversation;
 
 class ConversationRegistry extends BaseRegistry<Conversation, ConversationData>

source/funkin/data/dialogue/dialoguebox/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Dialogue Box Data Schema Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.0]
+### Added
+- Added an option to specify the font used by the dialogue box. Defaults to `Arial` if unspecified.
+
+## [1.0.0]
+Initial release.

source/funkin/data/dialogue/DialogueBoxData.hx → source/funkin/data/dialogue/dialoguebox/DialogueBoxData.hx

@@ -1,4 +1,4 @@
-package funkin.data.dialogue;
+package funkin.data.dialogue.dialoguebox;
 
 import funkin.data.animation.AnimationData;
 

source/funkin/data/dialogue/DialogueBoxRegistry.hx → source/funkin/data/dialogue/dialoguebox/DialogueBoxRegistry.hx

@@ -1,7 +1,7 @@
-package funkin.data.dialogue;
+package funkin.data.dialogue.dialoguebox;
 
 import funkin.play.cutscene.dialogue.DialogueBox;
-import funkin.data.dialogue.DialogueBoxData;
+import funkin.data.dialogue.dialoguebox.DialogueBoxData;
 import funkin.play.cutscene.dialogue.ScriptedDialogueBox;
 
 class DialogueBoxRegistry extends BaseRegistry<DialogueBox, DialogueBoxData>

source/funkin/data/dialogue/speaker/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Dialogue Speaker Data Schema Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0]
+Initial release.

source/funkin/data/dialogue/SpeakerData.hx → source/funkin/data/dialogue/speaker/SpeakerData.hx

@@ -1,4 +1,4 @@
-package funkin.data.dialogue;
+package funkin.data.dialogue.speaker;
 
 import funkin.data.animation.AnimationData;
 

source/funkin/data/dialogue/SpeakerRegistry.hx → source/funkin/data/dialogue/speaker/SpeakerRegistry.hx

@@ -1,7 +1,7 @@
-package funkin.data.dialogue;
+package funkin.data.dialogue.speaker;
 
 import funkin.play.cutscene.dialogue.Speaker;
-import funkin.data.dialogue.SpeakerData;
+import funkin.data.dialogue.speaker.SpeakerData;
 import funkin.play.cutscene.dialogue.ScriptedSpeaker;
 
 class SpeakerRegistry extends BaseRegistry<Speaker, SpeakerData>

source/funkin/data/freeplay/AlbumData.hx → source/funkin/data/freeplay/album/AlbumData.hx

@@ -1,4 +1,4 @@
-package funkin.data.freeplay;
+package funkin.data.freeplay.album;
 
 import funkin.data.animation.AnimationData;
 

source/funkin/data/freeplay/AlbumRegistry.hx → source/funkin/data/freeplay/album/AlbumRegistry.hx

@@ -1,7 +1,7 @@
-package funkin.data.freeplay;
+package funkin.data.freeplay.album;
 
 import funkin.ui.freeplay.Album;
-import funkin.data.freeplay.AlbumData;
+import funkin.data.freeplay.album.AlbumData;
 import funkin.ui.freeplay.ScriptedAlbum;
 
 class AlbumRegistry extends BaseRegistry<Album, AlbumData>

source/funkin/data/freeplay/album/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Freeplay Album Data Schema Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0]
+Initial release.

source/funkin/data/song/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Song Chart Data Schema Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.2.2]
+### Added
+- Added `playData.previewStart` and `playData.previewEnd` fields to specify when in the song should the song's audio should be played as a preview in Freeplay.
+
+## [2.2.1]
+### Added
+- Added `playData.offsets` field to specify instrumental and vocal offsets.
+
+## [2.2.0]
+### Added
+- Added `playData.album` to specify the album art to display in Freeplay.
+- Added `playData.ratings` for difficulty ratings displayed in Freeplay.
+### Changed
+- Renamed `playData.noteSkin` to `playData.noteStyle`.
+
+## [2.1.0]
+### Changed
+- Rearranged the `playData` field.
+  - Refactored the `playableChars`
+### Removed
+- Removed the `variation` field.
+
+## [2.0.0]
+Full refactor of the chart format for improved structure.
+### Added
+- Added a semantic version field for migration tracking.
+
+## [1.0.0]
+Initial version from 2020.

source/funkin/data/stage/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Story Mode Level Data Schema Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1]
+### Added
+- Added the ability to specify a hexadecimal color in the `assetPath` field instead of a texture key.
+  - In this case, the `scale` property will be used to determine the size of the rectangle in pixels.
+
+## [1.0.0]
+Initial release.

source/funkin/data/stage/StageRegistry.hx

@@ -11,7 +11,7 @@ class StageRegistry extends BaseRegistry<Stage, StageData>
    * Handle breaking changes by incrementing this value
    * and adding migration to the `migrateStageData()` function.
    */
-  public static final STAGE_DATA_VERSION:thx.semver.Version = "1.0.1";
+  public static final STAGE_DATA_VERSION:thx.semver.Version = "1.0.0";
 
   public static final STAGE_DATA_VERSION_RULE:thx.semver.VersionRule = "1.0.x";