Chart Editor all supported sound formats

Can now specify the extension of a music or sound file path. If none is passed, the default is used.
Also makes waveform data nullable.

Author: Lasercar

source/funkin/Paths.hx

@@ -41,13 +41,23 @@ class Paths implements ConsoleClass
     return parts[0];
   }
 
-  static function getPath(file:String, type:AssetType, library:Null<String>):String
+  public static function fixPathExtension(path:String, defaultExtension:String):String
+  {
+    return if (path.lastIndexOf(".") == -1) '${path}.$defaultExtension'; else path;
+  }
+
+  public static function normalizePath(path:String, ?defaultExtension:String):String
+  {
+    return if (defaultExtension == null) Path.normalize(path); else fixPathExtension(Path.normalize(path), defaultExtension);
+  }
+
+  public static function getPath(file:String, type:AssetType, ?library:String):String
   {
     if (library != null) return getLibraryPath(file, library);
 
     if (currentLevel != null)
     {
-      var levelPath:String = getLibraryPathForce(file, currentLevel);
+      var levelPath:String = getLibraryPath(file, currentLevel);
       if (Assets.exists(levelPath, type)) return levelPath;
     }
 
@@ -84,47 +94,74 @@ class Paths implements ConsoleClass
 
   public static function txt(key:String, ?library:String):String
   {
-    return getPath('data/$key.txt', TEXT, library);
+    return getPath(normalizePath('data/$key', 'txt'), TEXT, library);
   }
 
   public static function frag(key:String, ?library:String):String
   {
-    return getPath('shaders/$key.frag', TEXT, library);
+    return getPath(normalizePath('shaders/$key', 'frag'), TEXT, library);
   }
 
   public static function vert(key:String, ?library:String):String
   {
-    return getPath('shaders/$key.vert', TEXT, library);
+    return getPath(normalizePath('shaders/$key', 'vert'), TEXT, library);
   }
 
   public static function xml(key:String, ?library:String):String
   {
-    return getPath('data/$key.xml', TEXT, library);
+    return getPath(normalizePath('data/$key', 'xml'), TEXT, library);
   }
 
   public static function json(key:String, ?library:String):String
   {
-    return getPath('data/$key.json', TEXT, library);
+    return getPath(normalizePath('data/$key', 'json'), TEXT, library);
   }
 
-  public static function srt(key:String, ?library:String, ?directory:String = "data/"):String
+  public static function srt(key:String, ?library:String, ?directory:String = "data"):String
   {
-    return getPath('$directory$key.srt', TEXT, library);
+    return getPath(normalizePath('${directory}/$key', 'srt'), TEXT, library);
   }
 
-  public static function sound(key:String, ?library:String):String
+  public static function sound(key:String, ?library:String, ?directory:String = 'sounds', ?extension:String):String
   {
-    return getPath('sounds/$key.${Constants.EXT_SOUND}', SOUND, library);
+    var normalizedPath = Path.normalize((directory == '' ? '' : directory + '/') + key);
+    if (extension != null) return getPath(fixPathExtension(normalizedPath, extension), SOUND, library);
+
+    // Attempt to find the sound by looping through the supported file formats.
+    var path:String;
+    for (extension in Constants.EXT_SOUNDS)
+    {
+      // no need to check if its exists in MUSIC type, as Openfl/Lime AssetLibrary have the same returns for SOUND and MUSIC internally.
+      if (library != null)
+      {
+        path = getLibraryPath(fixPathExtension(normalizedPath, extension), library);
+        if (Assets.exists(path, SOUND)/* || Assets.exists(path, MUSIC)*/) return path;
+      }
+      else
+      {
+        if (currentLevel != null)
+        {
+          path = getLibraryPath(fixPathExtension(normalizedPath, extension), currentLevel);
+          if (Assets.exists(path, SOUND)/* || Assets.exists(path, MUSIC)*/) return path;
+        }
+
+        path = getLibraryPathForce(fixPathExtension(normalizedPath, extension), 'shared');
+        if (Assets.exists(path, SOUND)/* || Assets.exists(path, MUSIC)*/) return path;
+      }
+    }
+
+    if (library != null) return getLibraryPath(fixPathExtension(normalizedPath, Constants.EXT_SOUND), library);
+    else return getPreloadPath(fixPathExtension(normalizedPath, Constants.EXT_SOUND));
   }
 
-  public static function soundRandom(key:String, min:Int, max:Int, ?library:String):String
+  public static function soundRandom(key:String, min:Int, max:Int, ?library:String, ?extension:String):String
   {
-    return sound(key + FlxG.random.int(min, max), library);
+    return sound(key + FlxG.random.int(min, max), library, null, extension);
   }
 
-  public static function music(key:String, ?library:String):String
+  public static function music(key:String, ?library:String, ?extension:String):String
   {
-    return getPath('music/$key.${Constants.EXT_SOUND}', MUSIC, library);
+    return sound(key, library, 'music', extension);
   }
 
   public static function videos(key:String, ?library:String):String
@@ -139,24 +176,29 @@ class Paths implements ConsoleClass
     return getPath('videos/$key.${Constants.EXT_VIDEO}', BINARY, library ?? 'videos');
   }
 
-  public static function voices(song:String, ?suffix:String = ''):String
+  public static function song(key:String, ?extension:String):String
   {
-    if (suffix == null) suffix = ''; // no suffix, for a sorta backwards compatibility with older-ish voice files
+    // For web platform that haven't loaded the library "songs" yet.
+    if (Assets.getLibrary("songs") != null) return sound(key, 'songs', '', extension);
+    else return getLibraryPathForce(normalizePath(key, extension ?? Constants.EXT_SOUND), 'songs');
+  }
 
-    return 'songs:assets/songs/${song.toLowerCase()}/Voices$suffix.${Constants.EXT_SOUND}';
+  public static function voices(song:String, ?suffix:String = '', ?extension:String):String
+  {
+    if (suffix == null) suffix = ''; // no suffix, for a sorta backwards compatibility with older-ish voice files
+    return Paths.song('${song.toLowerCase()}/Voices$suffix', extension);
   }
 
   /**
    * Gets the path to an `Inst.mp3/ogg` song instrumental from songs:assets/songs/`song`/
    * @param song name of the song to get instrumental for
    * @param suffix any suffix to add to end of song name, used for `-erect` variants usually
-   * @param withExtension if it should return with the audio file extension `.mp3` or `.ogg`.
+   * @param extension The audio file extension of the track. If empty, the default extension is passed.
    * @return String
    */
-  public static function inst(song:String, ?suffix:String = '', withExtension:Bool = true):String
+  public static function inst(song:String, ?suffix:String = '', ?extension:String):String
   {
-    var ext:String = withExtension ? '.${Constants.EXT_SOUND}' : '';
-    return 'songs:assets/songs/${song.toLowerCase()}/Inst$suffix$ext';
+    return Paths.song('${song.toLowerCase()}/Inst$suffix', extension);
   }
 
   public static function image(key:String, ?library:String):String

source/funkin/audio/FunkinSound.hx

@@ -57,16 +57,16 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
    * Waveform data for this sound.
    * This is lazily loaded, so it will be built the first time it is accessed.
    */
-  public var waveformData(get, never):WaveformData;
+  public var waveformData(get, never):Null<WaveformData>;
 
   var _waveformData:Null<WaveformData> = null;
 
-  function get_waveformData():WaveformData
+  function get_waveformData():Null<WaveformData>
   {
     if (_waveformData == null)
     {
       _waveformData = WaveformDataParser.interpretFlxSound(this);
-      if (_waveformData == null) throw 'Could not interpret waveform data!';
+      if (_waveformData == null) trace('Could not interpret waveform data!');
     }
     return _waveformData;
   }

source/funkin/audio/waveform/WaveformData.hx

@@ -195,6 +195,8 @@ class WaveformData
       var thatChannel = that.channel(channelIndex);
       var resultChannel = result.channel(channelIndex);
 
+      if (thatChannel == null) return this.clone();
+
       for (index in 0...this.length)
       {
         var thisMinSample = thisChannel.minSample(index);

source/funkin/data/song/importer/ChartManifestData.hx

@@ -1,5 +1,7 @@
 package funkin.data.song.importer;
 
+import haxe.io.Path;
+
 /**
  * A helper JSON blob found in `.fnfc` files.
  */
@@ -47,18 +49,32 @@ class ChartManifestData
     return '$songId-chart${variation == Constants.DEFAULT_VARIATION ? '' : '-$variation'}.${Constants.EXT_DATA}';
   }
 
-  public function getInstFileName(?variation:String):String
+  public function getInstFileName(?variation:String, fileEntries:Array<haxe.zip.Entry>):String
   {
     if (variation == null || variation == '') variation = Constants.DEFAULT_VARIATION;
 
-    return 'Inst${variation == Constants.DEFAULT_VARIATION ? '' : '-$variation'}.${Constants.EXT_SOUND}';
+    var instFile = fileEntries.filter(function(file:haxe.zip.Entry):Bool
+    {
+      return Path.withoutExtension(file.fileName) == 'Inst${variation == Constants.DEFAULT_VARIATION ? '' : '-$variation'}';
+    });
+
+    if (instFile[0] == null) return 'Inst${variation == Constants.DEFAULT_VARIATION ? '' : '-$variation'}.${Constants.EXT_SOUND}';
+    else
+      return instFile[0].fileName;
   }
 
-  public function getVocalsFileName(charId:String, ?variation:String):String
+  public function getVocalsFileName(charId:String, ?variation:String, fileEntries:Array<haxe.zip.Entry>):String
   {
     if (variation == null || variation == '') variation = Constants.DEFAULT_VARIATION;
 
-    return 'Voices-$charId${variation == Constants.DEFAULT_VARIATION ? '' : '-$variation'}.${Constants.EXT_SOUND}';
+    var vocalFile = fileEntries.filter(function(file:haxe.zip.Entry):Bool
+    {
+      return Path.withoutExtension(file.fileName) == 'Voices-$charId${variation == Constants.DEFAULT_VARIATION ? '' : '-$variation'}';
+    });
+
+    if (vocalFile[0] == null) return 'Voices-$charId${variation == Constants.DEFAULT_VARIATION ? '' : '-$variation'}.${Constants.EXT_SOUND}';
+    else
+      return vocalFile[0].fileName;
   }
 
   /**

source/funkin/ui/debug/charting/ChartEditorState.hx

@@ -148,9 +148,6 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
   public static final CHART_EDITOR_TOOLBOX_FREEPLAY_LAYOUT:String = Paths.ui('chart-editor/toolbox/freeplay');
   public static final CHART_EDITOR_TOOLBOX_PLAYTEST_PROPERTIES_LAYOUT:String = Paths.ui('chart-editor/toolbox/playtest-properties');
 
-  // Validation
-  public static final SUPPORTED_MUSIC_FORMATS:Array<String> = #if sys ['ogg'] #else ['mp3'] #end;
-
   // Layout
 
   /**

source/funkin/ui/debug/charting/dialogs/ChartEditorUploadVocalsDialog.hx

@@ -109,7 +109,7 @@ class ChartEditorUploadVocalsDialog extends ChartEditorBaseDialog
 
       vocalsEntry.onClick = function(_event)
       {
-        Dialogs.openBinaryFile('Open $charName Vocals', [{label: 'Audio File (.ogg)', extension: 'ogg'}], function(selectedFile)
+        Dialogs.openBinaryFile('Open $charName Vocals', FileUtil.FILE_EXTENSION_INFO_AUDIO, function(selectedFile)
         {
           if (selectedFile != null && selectedFile.bytes != null)
           {

source/funkin/ui/debug/charting/handlers/ChartEditorAudioHandler.hx

@@ -13,6 +13,7 @@ import funkin.audio.waveform.WaveformSprite;
 import flixel.util.FlxColor;
 import haxe.io.Bytes;
 import haxe.io.Path;
+import lime.media.AudioBuffer;
 
 /**
  * Functions for loading audio for the chart editor.
@@ -69,6 +70,7 @@ class ChartEditorAudioHandler
    */
   public static function loadVocalsFromBytes(state:ChartEditorState, bytes:Bytes, charId:String, instId:String = '', wipeFirst:Bool = false):Bool
   {
+    if (AudioBuffer.getCodec(bytes) == null) return false;
     var trackId:String = '${charId}${instId == '' ? '' : '-${instId}'}';
     if (wipeFirst) wipeVocalData(state);
     state.audioVocalTrackData.set(trackId, bytes);
@@ -119,6 +121,7 @@ class ChartEditorAudioHandler
    */
   public static function loadInstFromBytes(state:ChartEditorState, bytes:Bytes, instId:String = '', wipeFirst:Bool = false):Bool
   {
+    if (AudioBuffer.getCodec(bytes) == null) return false;
     if (instId == '') instId = 'default';
     if (wipeFirst) wipeInstrumentalData(state);
     state.audioInstTrackData.set(instId, bytes);
@@ -339,26 +342,14 @@ class ChartEditorAudioHandler
     var instTrackIds = state.audioInstTrackData.keys().array();
     for (key in instTrackIds)
     {
-      if (key == 'default')
-      {
-        var data:Null<Bytes> = state.audioInstTrackData.get('default');
-        if (data == null)
-        {
-          trace(' WARNING '.warning() + ' Failed to access inst track ($key)');
-          continue;
-        }
-        zipEntries.push(FileUtil.makeZIPEntryFromBytes('Inst.ogg', data));
-      }
-      else
+      var data:Null<Bytes> = state.audioInstTrackData.get(key);
+      if (data == null)
       {
-        var data:Null<Bytes> = state.audioInstTrackData.get(key);
-        if (data == null)
-        {
-          trace(' WARNING '.warning() + ' Failed to access inst track ($key)');
-          continue;
-        }
-        zipEntries.push(FileUtil.makeZIPEntryFromBytes('Inst-${key}.ogg', data));
+        trace(' WARNING '.warning() + ' Failed to access inst track ($key)');
+        continue;
       }
+      var extension = AudioBuffer.getCodec(data).toFormat();
+      zipEntries.push(FileUtil.makeZIPEntryFromBytes(key == 'default' ? 'Inst.${extension}' : 'Inst-${key}.${extension}', data));
     }
 
     return zipEntries;
@@ -382,7 +373,8 @@ class ChartEditorAudioHandler
         trace(' WARNING '.warning() + ' Failed to access vocal track ($key)');
         continue;
       }
-      zipEntries.push(FileUtil.makeZIPEntryFromBytes('Voices-${key}.ogg', data));
+      var extension = AudioBuffer.getCodec(data).toFormat();
+      zipEntries.push(FileUtil.makeZIPEntryFromBytes('Voices-${key}.${extension}', data));
     }
 
     return zipEntries;

source/funkin/ui/debug/charting/handlers/ChartEditorDialogHandler.hx

@@ -532,7 +532,7 @@ class ChartEditorDialogHandler
 
     instrumentalBox.onClick = function(_)
     {
-      Dialogs.openBinaryFile('Open Instrumental', [{label: 'Audio File (.ogg)', extension: 'ogg'}], function(selectedFile:SelectedFileInfo)
+      Dialogs.openBinaryFile('Open Instrumental', FileUtil.FILE_EXTENSION_INFO_AUDIO, function(selectedFile:SelectedFileInfo)
       {
         if (selectedFile != null && selectedFile.bytes != null)
         {
@@ -567,17 +567,8 @@ class ChartEditorDialogHandler
       }
       else
       {
-        var message:String = if (!ChartEditorState.SUPPORTED_MUSIC_FORMATS.contains(path.ext ?? ''))
-        {
-          'File format (${path.ext}) not supported for instrumental track (${path.file}.${path.ext})';
-        }
-        else
-        {
-          'Failed to load instrumental track (${path.file}.${path.ext}) for variation (${state.selectedVariation})';
-        }
-
         // Tell the user the load was successful.
-        state.error('Failed to Load Instrumental', message);
+        state.error('Failed to Load Instrumental', 'Failed to load instrumental track (${path.file}.${path.ext}) for variation (${state.selectedVariation})');
       }
     };
 

source/funkin/ui/debug/charting/handlers/ChartEditorImportExportHandler.hx

@@ -305,16 +305,15 @@ class ChartEditorImportExportHandler
       if (variMetadata == null) continue;
 
       var instId:String = variMetadata?.playData?.characters?.instrumental ?? '';
-
-      var instFileName:String = manifest.getInstFileName(instId);
+      var instFileName:String = manifest.getInstFileName(instId, fileEntries);
       var instFileBytes:Bytes = mappedFileEntries.get(instFileName)?.data ?? throw 'Could not locate instrumental ($instFileName).';
       if (!ChartEditorAudioHandler.loadInstFromBytes(state, instFileBytes, instId)) throw 'Could not load instrumental ($instFileName).';
 
       var playerCharId:String = variMetadata?.playData?.characters?.player ?? Constants.DEFAULT_CHARACTER;
       var playerVoiceList:Array<String> = variMetadata?.playData.characters?.playerVocals ?? [playerCharId];
       for (voice in playerVoiceList)
       {
-        var playerVocalsFileName:String = manifest.getVocalsFileName(voice, variation);
+        var playerVocalsFileName:String = manifest.getVocalsFileName(voice, variation, fileEntries);
         var playerVocalsFileBytes:Null<Bytes> = mappedFileEntries.get(playerVocalsFileName)?.data;
         if (playerVocalsFileBytes == null)
         {
@@ -332,7 +331,7 @@ class ChartEditorImportExportHandler
       var opponentVoiceList:Array<String> = variMetadata?.playData.characters?.opponentVocals ?? [opponentCharId];
       for (voice in opponentVoiceList)
       {
-        var opponentVocalsFileName:String = manifest.getVocalsFileName(voice, variation);
+        var opponentVocalsFileName:String = manifest.getVocalsFileName(voice, variation, fileEntries);
         var opponentVocalsFileBytes:Null<Bytes> = mappedFileEntries.get(opponentVocalsFileName)?.data;
         if (opponentVocalsFileBytes == null)
         {