2019-01-26 20:15:19 +08:00
|
|
|
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
|
|
// See the LICENCE file in the repository root for full licence text.
|
|
|
|
|
|
|
|
using System;
|
2019-03-06 13:14:41 +08:00
|
|
|
using System.Linq;
|
2019-12-09 18:41:31 +08:00
|
|
|
using osu.Framework.Audio;
|
|
|
|
using osu.Framework.Bindables;
|
2019-01-26 20:15:19 +08:00
|
|
|
using osu.Game.Beatmaps;
|
2019-12-09 18:58:51 +08:00
|
|
|
using osu.Game.Configuration;
|
2019-01-26 20:15:19 +08:00
|
|
|
using osu.Game.Rulesets.Objects;
|
2020-09-29 13:09:51 +08:00
|
|
|
using osu.Game.Rulesets.UI;
|
2019-01-26 20:15:19 +08:00
|
|
|
|
|
|
|
namespace osu.Game.Rulesets.Mods
|
|
|
|
{
|
2021-02-01 00:43:16 +08:00
|
|
|
public abstract class ModTimeRamp : Mod, IUpdatableByPlayfield, IApplicableToBeatmap, IApplicableToRate
|
2019-01-26 20:15:19 +08:00
|
|
|
{
|
2019-08-01 11:35:17 +08:00
|
|
|
/// <summary>
|
|
|
|
/// The point in the beatmap at which the final ramping rate should be reached.
|
|
|
|
/// </summary>
|
2021-02-01 03:18:12 +08:00
|
|
|
public const double FINAL_RATE_PROGRESS = 0.75f;
|
2019-08-01 11:35:17 +08:00
|
|
|
|
2022-09-09 15:39:22 +08:00
|
|
|
public override double ScoreMultiplier => 0.5;
|
|
|
|
|
2020-01-27 07:56:18 +08:00
|
|
|
[SettingSource("Initial rate", "The starting speed of the track")]
|
|
|
|
public abstract BindableNumber<double> InitialRate { get; }
|
|
|
|
|
2019-12-09 18:58:51 +08:00
|
|
|
[SettingSource("Final rate", "The final speed to ramp to")]
|
|
|
|
public abstract BindableNumber<double> FinalRate { get; }
|
2019-01-26 20:15:19 +08:00
|
|
|
|
2020-06-13 23:32:43 +08:00
|
|
|
[SettingSource("Adjust pitch", "Should pitch be adjusted with speed")]
|
2020-06-13 22:16:27 +08:00
|
|
|
public abstract BindableBool AdjustPitch { get; }
|
|
|
|
|
2022-05-05 19:37:38 +08:00
|
|
|
public override bool ValidForMultiplayerAsFreeMod => false;
|
2022-03-17 08:40:40 +08:00
|
|
|
|
2022-03-01 21:12:06 +08:00
|
|
|
public override Type[] IncompatibleMods => new[] { typeof(ModRateAdjust), typeof(ModAdaptiveSpeed) };
|
2021-02-24 02:10:03 +08:00
|
|
|
|
2020-03-24 00:54:08 +08:00
|
|
|
public override string SettingDescription => $"{InitialRate.Value:N2}x to {FinalRate.Value:N2}x";
|
2020-03-19 11:43:26 +08:00
|
|
|
|
2019-03-06 13:14:41 +08:00
|
|
|
private double finalRateTime;
|
|
|
|
private double beginRampTime;
|
|
|
|
|
2022-09-26 03:49:22 +08:00
|
|
|
public BindableNumber<double> SpeedChange { get; } = new BindableDouble(1)
|
2019-01-26 20:15:19 +08:00
|
|
|
{
|
2019-12-09 18:41:31 +08:00
|
|
|
Precision = 0.01,
|
|
|
|
};
|
2019-03-06 13:14:41 +08:00
|
|
|
|
2022-07-03 22:19:35 +08:00
|
|
|
private IAdjustableAudioComponent? track;
|
2019-03-12 17:15:18 +08:00
|
|
|
|
2019-12-12 22:33:18 +08:00
|
|
|
protected ModTimeRamp()
|
2019-12-12 16:28:31 +08:00
|
|
|
{
|
|
|
|
// for preview purpose at song select. eventually we'll want to be able to update every frame.
|
2022-06-24 20:25:23 +08:00
|
|
|
FinalRate.BindValueChanged(_ => applyRateAdjustment(double.PositiveInfinity), true);
|
2020-06-15 00:48:49 +08:00
|
|
|
AdjustPitch.BindValueChanged(applyPitchAdjustment);
|
2019-12-12 16:28:31 +08:00
|
|
|
}
|
|
|
|
|
2022-05-10 23:01:15 +08:00
|
|
|
public void ApplyToTrack(IAdjustableAudioComponent track)
|
2019-12-09 18:41:31 +08:00
|
|
|
{
|
2020-08-05 20:10:38 +08:00
|
|
|
this.track = track;
|
2020-06-13 22:16:27 +08:00
|
|
|
|
2019-12-12 16:45:11 +08:00
|
|
|
FinalRate.TriggerChange();
|
2020-06-13 23:32:43 +08:00
|
|
|
AdjustPitch.TriggerChange();
|
2019-01-26 20:15:19 +08:00
|
|
|
}
|
|
|
|
|
2022-05-10 23:01:36 +08:00
|
|
|
public void ApplyToSample(IAdjustableAudioComponent sample)
|
2020-06-16 21:58:23 +08:00
|
|
|
{
|
|
|
|
sample.AddAdjustment(AdjustableProperty.Frequency, SpeedChange);
|
|
|
|
}
|
|
|
|
|
2019-08-01 11:35:17 +08:00
|
|
|
public virtual void ApplyToBeatmap(IBeatmap beatmap)
|
2019-01-26 20:15:19 +08:00
|
|
|
{
|
2019-12-09 18:58:51 +08:00
|
|
|
SpeedChange.SetDefault();
|
|
|
|
|
2021-02-01 03:34:56 +08:00
|
|
|
double firstObjectStart = beatmap.HitObjects.FirstOrDefault()?.StartTime ?? 0;
|
|
|
|
double lastObjectEnd = beatmap.HitObjects.LastOrDefault()?.GetEndTime() ?? 0;
|
|
|
|
|
|
|
|
beginRampTime = firstObjectStart;
|
|
|
|
finalRateTime = firstObjectStart + FINAL_RATE_PROGRESS * (lastObjectEnd - firstObjectStart);
|
2019-01-26 20:15:19 +08:00
|
|
|
}
|
|
|
|
|
2021-02-01 00:43:16 +08:00
|
|
|
public double ApplyToRate(double time, double rate = 1)
|
|
|
|
{
|
|
|
|
double amount = (time - beginRampTime) / Math.Max(1, finalRateTime - beginRampTime);
|
|
|
|
double ramp = InitialRate.Value + (FinalRate.Value - InitialRate.Value) * Math.Clamp(amount, 0, 1);
|
2021-02-08 02:02:09 +08:00
|
|
|
|
|
|
|
// round the end result to match the bindable SpeedChange's precision, in case this is called externally.
|
|
|
|
return rate * Math.Round(ramp, 2);
|
2021-02-01 00:43:16 +08:00
|
|
|
}
|
|
|
|
|
2019-01-26 20:15:19 +08:00
|
|
|
public virtual void Update(Playfield playfield)
|
|
|
|
{
|
2022-05-10 22:54:34 +08:00
|
|
|
applyRateAdjustment(playfield.Clock.CurrentTime);
|
2019-03-12 17:15:18 +08:00
|
|
|
}
|
|
|
|
|
2019-03-14 11:29:16 +08:00
|
|
|
/// <summary>
|
2021-02-01 00:43:16 +08:00
|
|
|
/// Adjust the rate along the specified ramp.
|
2019-03-14 11:29:16 +08:00
|
|
|
/// </summary>
|
2021-02-01 00:43:16 +08:00
|
|
|
private void applyRateAdjustment(double time) => SpeedChange.Value = ApplyToRate(time);
|
2020-06-13 22:16:27 +08:00
|
|
|
|
2020-06-15 00:50:07 +08:00
|
|
|
private void applyPitchAdjustment(ValueChangedEvent<bool> adjustPitchSetting)
|
2020-06-13 22:16:27 +08:00
|
|
|
{
|
|
|
|
// remove existing old adjustment
|
2020-08-12 00:41:21 +08:00
|
|
|
track?.RemoveAdjustment(adjustmentForPitchSetting(adjustPitchSetting.OldValue), SpeedChange);
|
2020-06-13 22:16:27 +08:00
|
|
|
|
2020-08-12 00:41:21 +08:00
|
|
|
track?.AddAdjustment(adjustmentForPitchSetting(adjustPitchSetting.NewValue), SpeedChange);
|
2020-06-13 22:16:27 +08:00
|
|
|
}
|
2020-06-13 23:32:43 +08:00
|
|
|
|
2020-06-15 00:50:07 +08:00
|
|
|
private AdjustableProperty adjustmentForPitchSetting(bool adjustPitchSettingValue)
|
|
|
|
=> adjustPitchSettingValue ? AdjustableProperty.Frequency : AdjustableProperty.Tempo;
|
2019-01-26 20:15:19 +08:00
|
|
|
}
|
2019-03-06 13:14:41 +08:00
|
|
|
}
|