Skip to content

Fix SoundPlayer handling of partial reads on streams #82612

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 2, 2023
Merged

Fix SoundPlayer handling of partial reads on streams #82612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
216778b
Fix SoundPlayer handling of partial reads on streams
stephentoub Feb 24, 2023
c7d9cc4
Merge branch 'dotnet:main' into fixsoundplayerreads
stephentoub Feb 25, 2023
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
15 changes: 14 additions & 1 deletion src/libraries/System.Windows.Extensions/src/System/Media/SoundPlayer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,20 @@ private void LoadStream(bool loadSync)
int streamLen = (int)_stream.Length;
_currentPos = 0;
_streamData = new byte[streamLen];
_stream.Read(_streamData, 0, streamLen);
#if NET7_0_OR_GREATER
_stream.ReadExactly(_streamData);
#else
Copy link
Contributor

@carlossanlop carlossanlop Mar 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we backport this?

Copy link
Member Author

@stephentoub stephentoub Mar 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as #82621 (comment)

int totalRead = 0;
while (totalRead < streamLen)
{
int bytesRead = _stream.Read(_streamData, totalRead, streamLen - totalRead);
if (bytesRead <= 0)
{
throw new EndOfStreamException();
}
totalRead += bytesRead;
}
#endif
IsLoadCompleted = true;
OnLoadCompleted(new AsyncCompletedEventArgs(null, false, null));
}
Expand Down
16 changes: 16 additions & 0 deletions src/libraries/System.Windows.Extensions/tests/System/Media/SoundPlayerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,22 @@ public void PlayLooping_NullStream_Success()
player.PlayLooping();
}

[ConditionalTheory(typeof(PlatformDetection), nameof(PlatformDetection.IsSoundPlaySupported))]
[MemberData(nameof(Play_String_TestData))]
[OuterLoop]
public void PlaySync_TrickledData_Success(string sourceLocation)
{
using var player = new SoundPlayer();
player.Stream = new TrickleStream(File.ReadAllBytes(sourceLocation.Replace("file://", "")));
player.PlaySync();
}

private sealed class TrickleStream : MemoryStream
{
public TrickleStream(byte[] bytes) : base(bytes) { }
public override int Read(byte[] buffer, int offset, int count) => base.Read(buffer, offset, Math.Min(count, 1));
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsSoundPlaySupported))]
[OuterLoop]
public void PlaySync_NullStream_Success()
Expand Down