package funkin.ui.debug.charting.handlers; import flixel.system.FlxAssets.FlxSoundAsset; import flixel.sound.FlxSound; import funkin.audio.VoicesGroup; import funkin.audio.FunkinSound; import funkin.play.character.BaseCharacter.CharacterType; import funkin.util.FileUtil; import funkin.util.assets.SoundUtil; import funkin.util.TimerUtil; import funkin.audio.waveform.WaveformData; import funkin.audio.waveform.WaveformDataParser; import funkin.audio.waveform.WaveformSprite; import flixel.util.FlxColor; import haxe.io.Bytes; import haxe.io.Path; import openfl.utils.Assets; /** * Functions for loading audio for the chart editor. * Handlers split up the functionality of the Chart Editor into different classes based on focus to limit the amount of code in each class. */ @:nullSafety @:access(funkin.ui.debug.charting.ChartEditorState) class ChartEditorAudioHandler { /** * Loads and stores byte data for a vocal track from an absolute file path * * @param path The absolute path to the audio file. * @param charId The character this vocal track will be for. * @param instId The instrumental this vocal track will be for. * @return Success or failure. */ public static function loadVocalsFromPath(state:ChartEditorState, path:Path, charId:String, instId:String = '', wipeFirst:Bool = false):Bool { #if sys var fileBytes:Bytes = sys.io.File.getBytes(path.toString()); return loadVocalsFromBytes(state, fileBytes, charId, instId, wipeFirst); #else trace("[WARN] This platform can't load audio from a file path, you'll need to fetch the bytes some other way."); return false; #end } /** * Loads and stores byte data for a vocal track from an asset * * @param path The path to the asset. Use `Paths` to build this. * @param charId The character this vocal track will be for. * @param instId The instrumental this vocal track will be for. * @return Success or failure. */ public static function loadVocalsFromAsset(state:ChartEditorState, path:String, charId:String, instId:String = '', wipeFirst:Bool = false):Bool { var trackData:Null = Assets.getBytes(path); if (trackData != null) { return loadVocalsFromBytes(state, trackData, charId, instId, wipeFirst); } return false; } /** * Loads and stores byte data for a vocal track * * @param bytes The audio byte data. * @param charId The character this vocal track will be for. * @param instId The instrumental this vocal track will be for. * @param wipeFirst Whether to wipe the existing vocal data before loading. */ public static function loadVocalsFromBytes(state:ChartEditorState, bytes:Bytes, charId:String, instId:String = '', wipeFirst:Bool = false):Bool { var trackId:String = '${charId}${instId == '' ? '' : '-${instId}'}'; if (wipeFirst) wipeVocalData(state); state.audioVocalTrackData.set(trackId, bytes); return true; } /** * Loads and stores byte data for an instrumental track from an absolute file path * * @param path The absolute path to the audio file. * @param instId The instrumental this vocal track will be for. * @return Success or failure. */ public static function loadInstFromPath(state:ChartEditorState, path:Path, instId:String = '', wipeFirst:Bool = false):Bool { #if sys var fileBytes:Bytes = sys.io.File.getBytes(path.toString()); return loadInstFromBytes(state, fileBytes, instId, wipeFirst); #else trace("[WARN] This platform can't load audio from a file path, you'll need to fetch the bytes some other way."); return false; #end } /** * Loads and stores byte data for an instrumental track from an asset * * @param path The path to the asset. Use `Paths` to build this. * @param instId The instrumental this vocal track will be for. * @return Success or failure. */ public static function loadInstFromAsset(state:ChartEditorState, path:String, instId:String = '', wipeFirst:Bool = false):Bool { var trackData:Null = Assets.getBytes(path); if (trackData != null) { return loadInstFromBytes(state, trackData, instId, wipeFirst); } return false; } /** * Loads and stores byte data for a vocal track * * @param bytes The audio byte data. * @param charId The character this vocal track will be for. * @param instId The instrumental this vocal track will be for. */ public static function loadInstFromBytes(state:ChartEditorState, bytes:Bytes, instId:String = '', wipeFirst:Bool = false):Bool { if (instId == '') instId = 'default'; if (wipeFirst) wipeInstrumentalData(state); state.audioInstTrackData.set(instId, bytes); return true; } public static function switchToInstrumental(state:ChartEditorState, instId:String = '', playerId:String, opponentId:String):Bool { var perfA:Float = TimerUtil.start(); var result:Bool = playInstrumental(state, instId); if (!result) return false; var perfB:Float = TimerUtil.start(); stopExistingVocals(state); var perfC:Float = TimerUtil.start(); result = playVocals(state, BF, playerId, instId); var perfD:Float = TimerUtil.start(); // if (!result) return false; result = playVocals(state, DAD, opponentId, instId); // if (!result) return false; var perfE:Float = TimerUtil.start(); state.hardRefreshOffsetsToolbox(); var perfF:Float = TimerUtil.start(); state.hardRefreshFreeplayToolbox(); var perfG:Float = TimerUtil.start(); trace('Switched to instrumental in ${TimerUtil.seconds(perfA, perfB)}.'); trace('Stopped existing vocals in ${TimerUtil.seconds(perfB, perfC)}.'); trace('Played BF vocals in ${TimerUtil.seconds(perfC, perfD)}.'); trace('Played DAD vocals in ${TimerUtil.seconds(perfD, perfE)}.'); trace('Hard refreshed offsets toolbox in ${TimerUtil.seconds(perfE, perfF)}.'); trace('Hard refreshed freeplay toolbox in ${TimerUtil.seconds(perfF, perfG)}.'); return true; } /** * Tell the Chart Editor to select a specific instrumental track, that is already loaded. */ public static function playInstrumental(state:ChartEditorState, instId:String = ''):Bool { if (instId == '') instId = 'default'; var instTrackData:Null = state.audioInstTrackData.get(instId); var perfStart:Float = TimerUtil.start(); var instTrack:Null = SoundUtil.buildSoundFromBytes(instTrackData); trace('Built instrumental track in ${TimerUtil.seconds(perfStart)} seconds.'); if (instTrack == null) return false; stopExistingInstrumental(state); state.audioInstTrack = instTrack; state.postLoadInstrumental(); // Workaround for a bug where FlxG.sound.music.update() was being called twice. FlxG.sound.list.remove(instTrack); return true; } public static function stopExistingInstrumental(state:ChartEditorState):Void { if (state.audioInstTrack != null) { state.audioInstTrack.stop(); state.audioInstTrack.destroy(); state.audioInstTrack = null; } } /** * Tell the Chart Editor to select a specific vocal track, that is already loaded. */ public static function playVocals(state:ChartEditorState, charType:CharacterType, charId:String, instId:String = ''):Bool { var trackId:String = '${charId}${instId == '' ? '' : '-${instId}'}'; var vocalTrackData:Null = state.audioVocalTrackData.get(trackId); var perfStart:Float = TimerUtil.start(); var vocalTrack:Null = SoundUtil.buildSoundFromBytes(vocalTrackData); trace('Built vocal track in ${TimerUtil.seconds(perfStart)}.'); if (state.audioVocalTrackGroup == null) state.audioVocalTrackGroup = new VoicesGroup(); if (vocalTrack != null) { switch (charType) { case BF: state.audioVocalTrackGroup.addPlayerVoice(vocalTrack); var perfStart:Float = TimerUtil.start(); var waveformData:Null = vocalTrack.waveformData; trace('Interpreted waveform data in ${TimerUtil.seconds(perfStart)}.'); if (waveformData != null) { var duration:Float = Conductor.instance.getStepTimeInMs(16) * 0.001; var waveformSprite:WaveformSprite = new WaveformSprite(waveformData, VERTICAL, FlxColor.WHITE); waveformSprite.x = 840; waveformSprite.y = Math.max(state.gridTiledSprite?.y ?? 0.0, ChartEditorState.GRID_INITIAL_Y_POS - ChartEditorState.GRID_TOP_PAD); waveformSprite.height = (ChartEditorState.GRID_SIZE) * 16; waveformSprite.width = (ChartEditorState.GRID_SIZE) * 2; waveformSprite.time = 0; waveformSprite.duration = duration; state.audioWaveforms.add(waveformSprite); } else { trace('[WARN] Failed to parse waveform data for vocal track.'); } state.audioVocalTrackGroup.playerVoicesOffset = state.currentVocalOffsetPlayer; return true; case DAD: state.audioVocalTrackGroup.addOpponentVoice(vocalTrack); var perfStart:Float = TimerUtil.start(); var waveformData:Null = vocalTrack.waveformData; trace('Interpreted waveform data in ${TimerUtil.seconds(perfStart)}.'); if (waveformData != null) { var duration:Float = Conductor.instance.getStepTimeInMs(16) * 0.001; var waveformSprite:WaveformSprite = new WaveformSprite(waveformData, VERTICAL, FlxColor.WHITE); waveformSprite.x = 360; waveformSprite.y = Math.max(state.gridTiledSprite?.y ?? 0.0, ChartEditorState.GRID_INITIAL_Y_POS - ChartEditorState.GRID_TOP_PAD); waveformSprite.height = (ChartEditorState.GRID_SIZE) * 16; waveformSprite.width = (ChartEditorState.GRID_SIZE) * 2; waveformSprite.time = 0; waveformSprite.duration = duration; state.audioWaveforms.add(waveformSprite); } else { trace('[WARN] Failed to parse waveform data for vocal track.'); } state.audioVocalTrackGroup.opponentVoicesOffset = state.currentVocalOffsetOpponent; return true; case OTHER: state.audioVocalTrackGroup.add(vocalTrack); // TODO: Add offset for other characters. return true; default: // Do nothing. } } return false; } public static function stopExistingVocals(state:ChartEditorState):Void { state.audioVocalTrackGroup.clear(); if (state.audioWaveforms != null) { state.audioWaveforms.clear(); } } /** * Play a sound effect. * Automatically cleans up after itself and recycles previous FlxSound instances if available, for performance. * @param path The path to the sound effect. Use `Paths` to build this. */ public static function playSound(_state:ChartEditorState, path:String, volume:Float = 1.0):Void { var asset:Null = FlxG.sound.cache(path); if (asset == null) { trace('WARN: Failed to play sound $path, asset not found.'); return; } var snd:FunkinSound = FunkinSound.load(asset); snd.autoDestroy = true; snd.play(true); snd.volume = volume; } public static function wipeInstrumentalData(state:ChartEditorState):Void { state.audioInstTrackData.clear(); stopExistingInstrumental(state); } public static function wipeVocalData(state:ChartEditorState):Void { state.audioVocalTrackData.clear(); stopExistingVocals(state); } /** * Create a list of ZIP file entries from the current loaded instrumental tracks in the chart eidtor. * @param state The chart editor state. * @return `Array` */ public static function makeZIPEntriesFromInstrumentals(state:ChartEditorState):Array { var zipEntries = []; var instTrackIds = state.audioInstTrackData.keys().array(); for (key in instTrackIds) { if (key == 'default') { var data:Null = state.audioInstTrackData.get('default'); if (data == null) { trace('[WARN] Failed to access inst track ($key)'); continue; } zipEntries.push(FileUtil.makeZIPEntryFromBytes('Inst.ogg', data)); } else { var data:Null = state.audioInstTrackData.get(key); if (data == null) { trace('[WARN] Failed to access inst track ($key)'); continue; } zipEntries.push(FileUtil.makeZIPEntryFromBytes('Inst-${key}.ogg', data)); } } return zipEntries; } /** * Create a list of ZIP file entries from the current loaded vocal tracks in the chart eidtor. * @param state The chart editor state. * @return `Array` */ public static function makeZIPEntriesFromVocals(state:ChartEditorState):Array { var zipEntries = []; var vocalTrackIds = state.audioVocalTrackData.keys().array(); for (key in state.audioVocalTrackData.keys()) { var data:Null = state.audioVocalTrackData.get(key); if (data == null) { trace('[WARN] Failed to access vocal track ($key)'); continue; } zipEntries.push(FileUtil.makeZIPEntryFromBytes('Voices-${key}.ogg', data)); } return zipEntries; } }