Added options for waveform amplitude and minimum size.

source/funkin/audio/waveform/WaveformSprite.hx

@@ -14,7 +14,6 @@ class WaveformSprite extends MeshRender
   static final DEFAULT_Y:Float = 0.0;
   static final DEFAULT_WIDTH:Float = 100.0;
   static final DEFAULT_HEIGHT:Float = 100.0;
-  static final DEFAULT_DURATION:Float = 5.0;
 
   /**
    * Set this to true to tell the waveform to rebuild itself.
@@ -29,9 +28,9 @@ class WaveformSprite extends MeshRender
    */
   public var forceUpdate:Bool = false;
 
-  public var waveformData:WaveformData;
+  public var waveformData(default, set):Null<WaveformData>;
 
-  function set_waveformData(value:WaveformData):WaveformData
+  function set_waveformData(value:Null<WaveformData>):Null<WaveformData>
   {
     if (waveformData == value) return value;
 
@@ -117,7 +116,21 @@ class WaveformSprite extends MeshRender
     return super.set_width(value);
   }
 
-  public function new(waveformData:WaveformData, ?orientation:WaveformOrientation, ?color:FlxColor, ?duration:Float)
+  /**
+   * The minimum size, in pixels, that a waveform will display with.
+   * Useful for preventing the waveform from becoming too small to see.
+   *
+   * NOTE: This is technically doubled since it's applied above and below the center of the waveform.
+   */
+  public var minWaveformSize:Int = 1;
+
+  /**
+   * A multiplier on the size of the waveform.
+   * Still capped at the width and height set for the sprite.
+   */
+  public var amplitude:Float = 1.0;
+
+  public function new(?waveformData:WaveformData, ?orientation:WaveformOrientation, ?color:FlxColor, ?duration:Float)
   {
     super(DEFAULT_X, DEFAULT_Y, DEFAULT_COLOR);
     this.waveformColor = color ?? DEFAULT_COLOR;
@@ -164,6 +177,8 @@ class WaveformSprite extends MeshRender
 
     this.clear();
 
+    if (waveformData == null) return;
+
     // Center point of the waveform. When horizontal this is half the height, when vertical this is half the width.
     var waveformCenterPos:Int = orientation == HORIZONTAL ? Std.int(this.height / 2) : Std.int(this.width / 2);
 
@@ -200,17 +215,28 @@ class WaveformSprite extends MeshRender
       {
         var pixelPos:Int = Std.int((i - startIndex) * pixelsPerIndex);
 
-        var isOutsideClipRectHorizontal:Bool = (clipRect != null) && (pixelPos < clipRect.x || pixelPos > (clipRect.x + clipRect.width));
+        var isOutsideClipRect:Bool = (clipRect != null) && if (orientation == HORIZONTAL)
-        var isOutsideClipRectVertical:Bool = (clipRect != null) && (pixelPos < clipRect.y || pixelPos > (clipRect.y + clipRect.height));
+        {
-        var isOutsideClipRect:Bool = orientation == HORIZONTAL ? isOutsideClipRectHorizontal : isOutsideClipRectVertical;
+          pixelPos < clipRect.x
+          || pixelPos > (clipRect.x + clipRect.width);
+        } else
+        {
+          pixelPos < clipRect.y || pixelPos > (clipRect.y + clipRect.height);
+        };
 
         // This index is outside the clipRect, so we can just skip rendering it. Fantastic!
         if (isOutsideClipRect) continue;
 
-        var vertexTopY:Int = Std.int(waveformCenterPos
+        var sampleMax:Float = Math.min(waveformData.channel(0).maxSampleMapped(i) * amplitude, 1.0);
-          - (waveformData.channel(0).maxSampleMapped(i) * (orientation == HORIZONTAL ? this.height : this.width) / 2));
+        var sampleMin:Float = Math.max(waveformData.channel(0).minSampleMapped(i) * amplitude, -1.0);
-        var vertexBottomY:Int = Std.int(waveformCenterPos
+        var sampleMaxSize:Float = sampleMax * (orientation == HORIZONTAL ? this.height : this.width) / 2;
-          + (-waveformData.channel(0).minSampleMapped(i) * (orientation == HORIZONTAL ? this.height : this.width) / 2));
+        if (sampleMaxSize < minWaveformSize) sampleMaxSize = minWaveformSize;
+        var sampleMinSize:Float = sampleMin * (orientation == HORIZONTAL ? this.height : this.width) / 2;
+        if (sampleMinSize > -minWaveformSize) sampleMinSize = -minWaveformSize;
+        var vertexTopY:Int = Std.int(waveformCenterPos - sampleMaxSize);
+        var vertexBottomY:Int = Std.int(waveformCenterPos - sampleMinSize);
+
+        if (vertexBottomY - vertexTopY < minWaveformSize) vertexTopY = vertexBottomY - minWaveformSize;
 
         var vertexTopIndex:Int = -1;
         var vertexBottomIndex:Int = -1;
@@ -271,22 +297,31 @@ class WaveformSprite extends MeshRender
       var waveformLengthPixels:Int = orientation == HORIZONTAL ? Std.int(this.width) : Std.int(this.height);
       for (i in 0...waveformLengthPixels)
       {
-        // Wrap Std.int around the whole range calculation, not just indexesPerPixel, otherwise you get weird issues with zooming.
-        var rangeStart:Int = Std.int(i * indexesPerPixel + startIndex);
-        var rangeEnd:Int = Std.int((i + 1) * indexesPerPixel + startIndex);
         var pixelPos:Int = i;
 
-        var isOutsideClipRectHorizontal:Bool = (clipRect != null) && (pixelPos < clipRect.x || pixelPos > (clipRect.x + clipRect.width));
+        var isOutsideClipRect:Bool = (clipRect != null) && if (orientation == HORIZONTAL)
-        var isOutsideClipRectVertical:Bool = (clipRect != null) && (pixelPos < clipRect.y || pixelPos > (clipRect.y + clipRect.height));
+        {
-        var isOutsideClipRect:Bool = orientation == HORIZONTAL ? isOutsideClipRectHorizontal : isOutsideClipRectVertical;
+          pixelPos < clipRect.x
-
+          || pixelPos > (clipRect.x + clipRect.width);
+        } else
+        {
+          pixelPos < clipRect.y || pixelPos > (clipRect.y + clipRect.height);
+        };
         // This index is outside the clipRect, so we can just skip rendering it. Fantastic!
         if (isOutsideClipRect) continue;
 
-        var vertexTopY:Int = Std.int(waveformCenterPos
+        // Wrap Std.int around the whole range calculation, not just indexesPerPixel, otherwise you get weird issues with zooming.
-          - (waveformData.channel(0).maxSampleRangeMapped(rangeStart, rangeEnd) * (orientation == HORIZONTAL ? this.height : this.width) / 2));
+        var rangeStart:Int = Std.int(i * indexesPerPixel + startIndex);
-        var vertexBottomY:Int = Std.int(waveformCenterPos
+        var rangeEnd:Int = Std.int((i + 1) * indexesPerPixel + startIndex);
-          + (-waveformData.channel(0).minSampleRangeMapped(rangeStart, rangeEnd) * (orientation == HORIZONTAL ? this.height : this.width) / 2));
+
+        var sampleMax:Float = Math.min(waveformData.channel(0).maxSampleRangeMapped(rangeStart, rangeEnd) * amplitude, 1.0);
+        var sampleMin:Float = Math.max(waveformData.channel(0).minSampleRangeMapped(rangeStart, rangeEnd) * amplitude, -1.0);
+        var sampleMaxSize:Float = sampleMax * (orientation == HORIZONTAL ? this.height : this.width) / 2;
+        if (sampleMaxSize < minWaveformSize) sampleMaxSize = minWaveformSize;
+        var sampleMinSize:Float = sampleMin * (orientation == HORIZONTAL ? this.height : this.width) / 2;
+        if (sampleMinSize > -minWaveformSize) sampleMinSize = -minWaveformSize;
+        var vertexTopY:Int = Std.int(waveformCenterPos - sampleMaxSize);
+        var vertexBottomY:Int = Std.int(waveformCenterPos - sampleMinSize);
 
         var vertexTopIndex:Int = -1;
         var vertexBottomIndex:Int = -1;

source/funkin/ui/debug/WaveformTestState.hx

@@ -33,19 +33,20 @@ class WaveformTestState extends MusicBeatState
     var testSprite = new FlxSprite(0, 0);
     testSprite.loadGraphic(Paths.image('funkay'));
     testSprite.updateHitbox();
-    testSprite.clipRect = new FlxRect(0, 0, FlxG.width * 9 / 16, FlxG.height);
+    testSprite.clipRect = new FlxRect(0, 0, FlxG.width, FlxG.height);
     add(testSprite);
 
     waveformAudio = FunkinSound.load(Paths.inst('bopeebo', '-erect'));
 
-    // waveformData = WaveformDataParser.parseWaveformData(Paths.json('waveform/dadbattle-erect/dadbattle-erect.waveform'));
     waveformData = WaveformDataParser.interpretFlxSound(waveformAudio);
 
-    waveformSprite = WaveformSprite.buildFromWaveformData(waveformData, HORIZONTAL, FlxColor.fromString("#ADD8E6"), 2.5);
+    waveformSprite = WaveformSprite.buildFromWaveformData(waveformData, HORIZONTAL, FlxColor.fromString("#ADD8E6"));
-    waveformSprite.width = FlxG.width;
+    waveformSprite.duration = 5.0 * 160;
+    waveformSprite.width = FlxG.width * 160;
     waveformSprite.height = FlxG.height; // / 2;
-    waveformSprite.clipRect = new FlxRect(0, 0, FlxG.width * 9 / 16, FlxG.height);
+    waveformSprite.amplitude = 2.0;
-    // waveformSprite.clipRect = new FlxRect(FlxG.width * 1 / 3, FlxG.height * 3 / 8, FlxG.width * 1 / 3, FlxG.height * 2 / 8);
+    waveformSprite.minWaveformSize = 25;
+    waveformSprite.clipRect = new FlxRect(0, 0, FlxG.width, FlxG.height);
     add(waveformSprite);
 
     // waveformSprite2 = WaveformSprite.buildFromWaveformData(waveformData2, HORIZONTAL, FlxColor.fromString("#FF0000"), 5.0);