@rian8337/osu-base 4.0.0-beta.74 → 4.0.0-beta.77

package/dist/index.js

@@ -130,6 +130,16 @@ class MathUtils {
     static millisecondsToBPM(milliseconds, delimiter = 4) {
         return 60000 / (milliseconds * delimiter);
     }
+    /**
+     * Calculates an S-shaped {@link https://en.wikipedia.org/wiki/Logistic_function logistic function}.
+     *
+     * @param exponent The exponent to calculate the function for.
+     * @param maxValue The maximum value returnable by the function.
+     * @returns The output of the logistic function calculated at `exponent`.
+     */
+    static logistic(exponent, maxValue = 1) {
+        return maxValue / (1 + Math.exp(exponent));
+    }
     /**
      * Calculates an S-shaped {@link https://en.wikipedia.org/wiki/Logistic_function logistic function}
      * with offset at `x`.
@@ -156,6 +166,26 @@ class MathUtils {
         x = this.reverseLerp(x, start, end);
         return x * x * (3 - 2 * x);
     }
+    /// <summary>
+    ///
+    /// </summary>
+    /// <param name="x">Value to calculate the function for</param>
+    /// <param name="mean">Value of x, for which return value will be the highest (=1)</param>
+    /// <param name="width">Range [mean - width, mean + width] where function will change values</param>
+    /// <returns>The output of the smoothstep bell curve function of <paramref name="x"/></returns>
+    /**
+     * Calculates a {@link https://en.wikipedia.org/wiki/Smoothstep smoothstep bell curve} function that returns 1 for `x = mean`,
+     * and smoothly reducing it's value to 0 over width.
+     *
+     * @param x The value to calculate the function for.
+     * @param mean The value of x, for which the return value will be the highest (=1).
+     * @param width Range `[mean - width, mean + width]` where the function will change values.
+     */
+    static smoothstepBellCurve(x, mean = 0.5, width = 0.5) {
+        x -= mean;
+        x = x > 0 ? width - x : width + x;
+        return this.smoothstep(x, 0, width);
+    }
     /**
      * Calculates the {@link https://en.wikipedia.org/wiki/Smoothstep#Variations smoothstep}
      * function at `x`.
@@ -11691,16 +11721,31 @@ class MapInfo {
 /**
  * Represents the "old" `ModNightCore`.
  *
- * This mod is used solely for osu!droid difficulty calculation of replays with version 3 or older. The reason behind this
- * is a bug that was patched in replay version 4, where all audio that did not have 44100Hz frequency would slow down.
+ * This `Mod` is used solely for difficulty calculation of replays with version 3 or older. The reason behind this is a
+ * bug that was patched in replay version 4, where all audio that did not have 44100Hz frequency would slow down or
+ * speed up depending on the frequency of the audio.
+ *
+ * The equation for the playback rate with respect to the audio frequency (in Hz) was:
+ *
+ * ```
+ * playback_rate = 44100 * 1.5 / audio_frequency
+ * ```
+ *
+ * For example, if the audio's frequency is 48000Hz, the audio would play at `44100 * 1.5 / 48000 = 1.378125` playback
+ * rate.
+ *
+ * This `Mod` assumes that the audio frequency is 48000Hz and applies the same equation to calculate the playback rate.
+ * The frequency was chosen after sampling many audio files that were affected by this bug, and it seemed that 48000Hz
+ * was the most common frequency used in those files.
  *
- * After some testing, it was discovered that such replays were played at 1.39x speed instead of 1.5x, which is
- * represented by this mod.
+ * Realistically, it is possible to obtain the audio frequency in the game during gameplay loading (and therefore would
+ * result in the correct playback rate), but this would require additional work and the current solution is deemed
+ * sufficient for the purpose it serves.
  */
 class ModOldNightCore extends ModNightCore {
     constructor() {
         super();
-        this.trackRateMultiplier.value = 1.39;
+        this.trackRateMultiplier.value = (44.1 * 1.5) / 48;
     }
     get droidScoreMultiplier() {
         return 1.12;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rian8337/osu-base",
-    "version": "4.0.0-beta.74",
+    "version": "4.0.0-beta.77",
     "description": "Base module for all osu! related modules.",
     "keywords": [
         "osu",
@@ -35,5 +35,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "00abc82040e820ccff8fcad7ee77d7e7d8031717"
+    "gitHead": "13ad454ea657dbd5821d0857c4da6dc7ab0fe965"
 }

package/typings/index.d.ts

@@ -4668,6 +4668,14 @@ declare abstract class MathUtils {
      * @returns The milliseconds value in BPM.
      */
     static millisecondsToBPM(milliseconds: number, delimiter?: number): number;
+    /**
+     * Calculates an S-shaped {@link https://en.wikipedia.org/wiki/Logistic_function logistic function}.
+     *
+     * @param exponent The exponent to calculate the function for.
+     * @param maxValue The maximum value returnable by the function.
+     * @returns The output of the logistic function calculated at `exponent`.
+     */
+    static logistic(exponent: number, maxValue?: number): number;
     /**
      * Calculates an S-shaped {@link https://en.wikipedia.org/wiki/Logistic_function logistic function}
      * with offset at `x`.
@@ -4689,6 +4697,15 @@ declare abstract class MathUtils {
      * @returns The output of the smoothstep function calculated at `x`.
      */
     static smoothstep(x: number, start: number, end: number): number;
+    /**
+     * Calculates a {@link https://en.wikipedia.org/wiki/Smoothstep smoothstep bell curve} function that returns 1 for `x = mean`,
+     * and smoothly reducing it's value to 0 over width.
+     *
+     * @param x The value to calculate the function for.
+     * @param mean The value of x, for which the return value will be the highest (=1).
+     * @param width Range `[mean - width, mean + width]` where the function will change values.
+     */
+    static smoothstepBellCurve(x: number, mean?: number, width?: number): number;
     /**
      * Calculates the {@link https://en.wikipedia.org/wiki/Smoothstep#Variations smoothstep}
      * function at `x`.
@@ -5175,11 +5192,26 @@ declare class ModNoFail extends Mod implements IModApplicableToDroid, IModApplic
 /**
  * Represents the "old" `ModNightCore`.
  *
- * This mod is used solely for osu!droid difficulty calculation of replays with version 3 or older. The reason behind this
- * is a bug that was patched in replay version 4, where all audio that did not have 44100Hz frequency would slow down.
+ * This `Mod` is used solely for difficulty calculation of replays with version 3 or older. The reason behind this is a
+ * bug that was patched in replay version 4, where all audio that did not have 44100Hz frequency would slow down or
+ * speed up depending on the frequency of the audio.
+ *
+ * The equation for the playback rate with respect to the audio frequency (in Hz) was:
+ *
+ * ```
+ * playback_rate = 44100 * 1.5 / audio_frequency
+ * ```
+ *
+ * For example, if the audio's frequency is 48000Hz, the audio would play at `44100 * 1.5 / 48000 = 1.378125` playback
+ * rate.
+ *
+ * This `Mod` assumes that the audio frequency is 48000Hz and applies the same equation to calculate the playback rate.
+ * The frequency was chosen after sampling many audio files that were affected by this bug, and it seemed that 48000Hz
+ * was the most common frequency used in those files.
  *
- * After some testing, it was discovered that such replays were played at 1.39x speed instead of 1.5x, which is
- * represented by this mod.
+ * Realistically, it is possible to obtain the audio frequency in the game during gameplay loading (and therefore would
+ * result in the correct playback rate), but this would require additional work and the current solution is deemed
+ * sufficient for the purpose it serves.
  */
 declare class ModOldNightCore extends ModNightCore {
     constructor();