osu/osu.Game/Beatmaps/BeatmapInfo.cs

208 lines
7.1 KiB
C#
Raw Normal View History

// 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.
2018-04-13 09:19:50 +00:00
using System;
using System.Collections.Generic;
2018-04-13 09:19:50 +00:00
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
using Newtonsoft.Json;
2021-04-18 01:52:25 +00:00
using osu.Framework.Localisation;
using osu.Framework.Testing;
2018-04-13 09:19:50 +00:00
using osu.Game.Database;
using osu.Game.Rulesets;
using osu.Game.Scoring;
2018-04-13 09:19:50 +00:00
namespace osu.Game.Beatmaps
{
[ExcludeFromDynamicCompile]
2018-04-13 09:19:50 +00:00
[Serializable]
public class BeatmapInfo : IEquatable<BeatmapInfo>, IHasPrimaryKey, IBeatmapInfo
2018-04-13 09:19:50 +00:00
{
public int ID { get; set; }
public int BeatmapVersion;
private int? onlineBeatmapID;
[JsonProperty("id")]
public int? OnlineBeatmapID
{
get => onlineBeatmapID;
set => onlineBeatmapID = value > 0 ? value : null;
2018-04-13 09:19:50 +00:00
}
2018-11-30 09:06:48 +00:00
[JsonIgnore]
2018-04-13 09:19:50 +00:00
public int BeatmapSetInfoID { get; set; }
public BeatmapSetOnlineStatus Status { get; set; } = BeatmapSetOnlineStatus.None;
2018-04-13 09:19:50 +00:00
[Required]
public BeatmapSetInfo BeatmapSet { get; set; }
public BeatmapMetadata Metadata { get; set; }
[JsonIgnore]
public int BaseDifficultyID { get; set; }
public BeatmapDifficulty BaseDifficulty { get; set; }
[NotMapped]
public BeatmapMetrics Metrics { get; set; }
[NotMapped]
public BeatmapOnlineInfo OnlineInfo { get; set; }
2020-02-19 16:58:10 +00:00
[NotMapped]
public int? MaxCombo { get; set; }
2019-07-07 17:25:36 +00:00
/// <summary>
2019-07-09 14:31:15 +00:00
/// The playable length in milliseconds of this beatmap.
2019-07-07 17:25:36 +00:00
/// </summary>
public double Length { get; set; }
2019-07-08 07:43:35 +00:00
/// <summary>
/// The most common BPM of this beatmap.
/// </summary>
public double BPM { get; set; }
2018-04-13 09:19:50 +00:00
public string Path { get; set; }
[JsonProperty("file_sha2")]
public string Hash { get; set; }
[JsonIgnore]
public bool Hidden { get; set; }
/// <summary>
/// MD5 is kept for legacy support (matching against replays, osu-web-10 etc.).
/// </summary>
[JsonProperty("file_md5")]
public string MD5Hash { get; set; }
// General
2019-11-21 09:21:49 +00:00
public double AudioLeadIn { get; set; }
public float StackLeniency { get; set; } = 0.7f;
2018-04-13 09:19:50 +00:00
public bool SpecialStyle { get; set; }
public int RulesetID { get; set; }
public RulesetInfo Ruleset { get; set; }
public bool LetterboxInBreaks { get; set; }
public bool WidescreenStoryboard { get; set; }
2020-07-20 10:36:42 +00:00
public bool EpilepsyWarning { get; set; }
/// <summary>
/// Whether or not sound samples should change rate when playing with speed-changing mods.
/// TODO: only read/write supported for now, requires implementation in gameplay.
/// </summary>
public bool SamplesMatchPlaybackRate { get; set; }
public CountdownType Countdown { get; set; } = CountdownType.Normal;
/// <summary>
/// The number of beats to move the countdown backwards (compared to its default location).
/// </summary>
public int CountdownOffset { get; set; }
2018-04-13 09:19:50 +00:00
// Editor
// This bookmarks stuff is necessary because DB doesn't know how to store int[]
[JsonIgnore]
public string StoredBookmarks
{
2020-10-16 09:52:29 +00:00
get => string.Join(',', Bookmarks);
2018-04-13 09:19:50 +00:00
set
{
if (string.IsNullOrEmpty(value))
{
2019-11-28 13:41:29 +00:00
Bookmarks = Array.Empty<int>();
2018-04-13 09:19:50 +00:00
return;
}
Bookmarks = value.Split(',').Select(v =>
{
bool result = int.TryParse(v, out int val);
2018-04-13 09:19:50 +00:00
return new { result, val };
}).Where(p => p.result).Select(p => p.val).ToArray();
}
}
[NotMapped]
2019-11-28 13:41:29 +00:00
public int[] Bookmarks { get; set; } = Array.Empty<int>();
2018-04-13 09:19:50 +00:00
public double DistanceSpacing { get; set; }
public int BeatDivisor { get; set; }
public int GridSize { get; set; }
public double TimelineZoom { get; set; }
// Metadata
public string Version { get; set; }
2021-04-18 12:57:25 +00:00
private string versionString => string.IsNullOrEmpty(Version) ? string.Empty : $"[{Version}]";
2021-04-18 01:52:25 +00:00
2018-04-13 09:19:50 +00:00
[JsonProperty("difficulty_rating")]
public double StarDifficulty { get; set; }
/// <summary>
/// Currently only populated for beatmap deletion. Use <see cref="ScoreManager"/> to query scores.
/// </summary>
public List<ScoreInfo> Scores { get; set; }
[JsonIgnore]
public DifficultyRating DifficultyRating => BeatmapDifficultyCache.GetDifficultyRating(StarDifficulty);
public string[] SearchableTerms => new[]
{
Version
}.Concat(Metadata?.SearchableTerms ?? Enumerable.Empty<string>()).Where(s => !string.IsNullOrEmpty(s)).ToArray();
2021-04-18 12:57:25 +00:00
public override string ToString() => $"{Metadata ?? BeatmapSet?.Metadata} {versionString}".Trim();
2021-04-18 01:52:25 +00:00
public RomanisableString ToRomanisableString()
{
2021-04-18 02:00:17 +00:00
var metadata = (Metadata ?? BeatmapSet?.Metadata)?.ToRomanisableString() ?? new RomanisableString(null, null);
2021-04-18 12:57:25 +00:00
return new RomanisableString($"{metadata.GetPreferred(true)} {versionString}".Trim(), $"{metadata.GetPreferred(false)} {versionString}".Trim());
}
2018-04-13 09:19:50 +00:00
public bool Equals(BeatmapInfo other)
{
if (ID == 0 || other?.ID == 0)
// one of the two BeatmapInfos we are comparing isn't sourced from a database.
// fall back to reference equality.
return ReferenceEquals(this, other);
return ID == other?.ID;
}
public bool AudioEquals(BeatmapInfo other) => other != null && BeatmapSet != null && other.BeatmapSet != null &&
BeatmapSet.Hash == other.BeatmapSet.Hash &&
(Metadata ?? BeatmapSet.Metadata).AudioFile == (other.Metadata ?? other.BeatmapSet.Metadata).AudioFile;
public bool BackgroundEquals(BeatmapInfo other) => other != null && BeatmapSet != null && other.BeatmapSet != null &&
BeatmapSet.Hash == other.BeatmapSet.Hash &&
(Metadata ?? BeatmapSet.Metadata).BackgroundFile == (other.Metadata ?? other.BeatmapSet.Metadata).BackgroundFile;
/// <summary>
/// Returns a shallow-clone of this <see cref="BeatmapInfo"/>.
/// </summary>
public BeatmapInfo Clone() => (BeatmapInfo)MemberwiseClone();
#region Implementation of IHasOnlineID
2021-10-01 08:06:09 +00:00
public int? OnlineID => OnlineBeatmapID;
#endregion
#region Implementation of IBeatmapInfo
public string DifficultyName => Version;
IBeatmapMetadataInfo IBeatmapInfo.Metadata => Metadata;
public IBeatmapDifficultyInfo Difficulty => BaseDifficulty;
IRulesetInfo IBeatmapInfo.Ruleset => Ruleset;
public double StarRating => StarDifficulty;
#endregion
2018-04-13 09:19:50 +00:00
}
}