Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to 1.38, fix race condition in GetBeatmapFromBeatSaver #55

Merged
merged 2 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions MultiplayerCore/Beatmaps/BeatSaverPreviewMediaData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ public BeatSaverPreviewMediaData(BeatSaver beatsaver, string levelHash)
return _beatmap;
}

public async Task<Sprite> GetCoverSpriteAsync(CancellationToken cancellationToken)
public async Task<Sprite> GetCoverSpriteAsync()
{
if (CoverImagesprite != null) return CoverImagesprite;

var bm = await GetBeatsaverBeatmap();
if (bm == null) return null!;

byte[]? coverBytes = await bm.LatestVersion.DownloadCoverImage(cancellationToken);
byte[]? coverBytes = await bm.LatestVersion.DownloadCoverImage();
if (coverBytes == null || coverBytes.Length == 0) return null!;

Texture2D texture = new Texture2D(2, 2);
Expand All @@ -45,7 +45,15 @@ public async Task<Sprite> GetCoverSpriteAsync(CancellationToken cancellationToke
return CoverImagesprite;
}

public Task<AudioClip> GetPreviewAudioClip(CancellationToken cancellationToken)
public void UnloadCoverSprite()
{
if (CoverImagesprite == null) return;
Object.Destroy(CoverImagesprite.texture);
Object.Destroy(CoverImagesprite);
CoverImagesprite = null;
}

public Task<AudioClip> GetPreviewAudioClip()
{
// TODO: something with preview url
//var bm = await GetBeatsaverBeatmap();
Expand Down
2 changes: 1 addition & 1 deletion MultiplayerCore/Beatmaps/LocalBeatmapLevel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ public LocalBeatmapLevel(string hash, BeatmapLevel localBeatmapLevel)
}

public override Task<Sprite> TryGetCoverSpriteAsync(CancellationToken cancellationToken)
=> _localBeatmapLevel.previewMediaData.GetCoverSpriteAsync(cancellationToken);
=> _localBeatmapLevel.previewMediaData.GetCoverSpriteAsync();
}
}
51 changes: 32 additions & 19 deletions MultiplayerCore/Beatmaps/Providers/MpBeatmapLevelProvider.cs
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
using System.Collections.Generic;
using System.Diagnostics.Tracing;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.Windows.Forms;
using BeatSaverSharp;
using MultiplayerCore.Beatmaps.Abstractions;
using MultiplayerCore.Beatmaps.Packets;
using SiraUtil.Logging;
using SiraUtil.Zenject;

namespace MultiplayerCore.Beatmaps.Providers
{
public class MpBeatmapLevelProvider
{
private readonly BeatSaver _beatsaver;
private readonly SiraLog _logger;
private readonly Dictionary<string, MpBeatmap> _hashToNetworkMaps = new();
private readonly Dictionary<string, MpBeatmap> _hashToBeatsaverMaps = new();
private readonly ConcurrentDictionary<string, Task<MpBeatmap?>> _hashToBeatsaverMaps = new();

internal MpBeatmapLevelProvider(
UBinder<Plugin, BeatSaver> beatsaver)
UBinder<Plugin, BeatSaver> beatsaver,
SiraLog logger)
{
_beatsaver = beatsaver.Value;
_logger = logger;
}

/// <summary>
Expand All @@ -44,23 +47,33 @@ internal MpBeatmapLevelProvider(
return new LocalBeatmapLevel(levelHash, localBeatmapLevel);
}

/// <summary>
/// Gets an <see cref="MpBeatmap"/> for the specified level hash from BeatSaver.
/// </summary>
/// <param name="levelHash">The hash of the level to get</param>
/// <returns>An <see cref="MpBeatmap"/> with a matching level hash, or null if none was found.</returns>
public async Task<MpBeatmap?> GetBeatmapFromBeatSaver(string levelHash)
/// <summary>
/// Gets an <see cref="MpBeatmap"/> for the specified level hash from BeatSaver.
/// </summary>
/// <param name="levelHash">The hash of the level to get</param>
/// <returns>An <see cref="MpBeatmap"/> with a matching level hash, or null if none was found.</returns>
public async Task<MpBeatmap?> GetBeatmapFromBeatSaver(string levelHash)
{
if (_hashToBeatsaverMaps.TryGetValue(levelHash, out var map)) return map;
var beatmap = await _beatsaver.BeatmapByHash(levelHash);
if (beatmap != null)
if (!_hashToBeatsaverMaps.TryGetValue(levelHash, out var map))
{
map = new BeatSaverBeatmapLevel(levelHash, beatmap);
_hashToBeatsaverMaps.Add(levelHash, map);
return map;
}
map = Task.Run(async () =>
{
var beatmap = await _beatsaver.BeatmapByHash(levelHash);
if (beatmap != null)
{
MpBeatmap bmap = new BeatSaverBeatmapLevel(levelHash, beatmap);
return bmap;
}

return null;
});

_hashToBeatsaverMaps[levelHash] = map;
}

return null;
var bmap = await map;
if (bmap == null) _hashToBeatsaverMaps.TryRemove(levelHash, out _); // Ensure we remove null bmaps
return bmap;
}

public BeatSaverPreviewMediaData MakeBeatSaverPreviewMediaData(string levelHash) => new BeatSaverPreviewMediaData(_beatsaver, levelHash);
Expand Down
7 changes: 6 additions & 1 deletion MultiplayerCore/MultiplayerCore.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<OutputType>Library</OutputType>
<AppDesignerFolder>Properties</AppDesignerFolder>
<AssemblyName>MultiplayerCore</AssemblyName>
<AssemblyVersion>1.5.2</AssemblyVersion>
<AssemblyVersion>1.5.3</AssemblyVersion>
<TargetFramework>net472</TargetFramework>
<DebugSymbols>true</DebugSymbols>
<DebugType>portable</DebugType>
Expand Down Expand Up @@ -134,6 +134,11 @@
<Private>False</Private>
<SpecificVersion>False</SpecificVersion>
</Reference>
<Reference Include="Networking.NetworkPlayerEntitlementsChecker" Publicize="true">
<HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\Networking.NetworkPlayerEntitlementsChecker.dll</HintPath>
<Private>False</Private>
<SpecificVersion>False</SpecificVersion>
</Reference>
<Reference Include="SegmentedControl">
<HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\SegmentedControl.dll</HintPath>
<Private>False</Private>
Expand Down
6 changes: 3 additions & 3 deletions MultiplayerCore/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
"id": "MultiplayerCore",
"name": "MultiplayerCore",
"author": "Goobwabber",
"version": "1.5.2",
"version": "1.5.3",
"description": "Adds custom songs to Beat Saber Multiplayer.",
"gameVersion": "1.37.5",
"gameVersion": "1.38.0",
"dependsOn": {
"BSIPA": "^4.3.3",
"SongCore": "^3.13.0",
"SongCore": "^3.14.0",
"BeatSaverSharp": "^3.4.5",
"SiraUtil": "^3.1.12",
"BeatSaberMarkupLanguage": "^1.12.0",
Expand Down