fix: Match audio playback sample rate to project settings#1486
fix: Match audio playback sample rate to project settings#1486
Conversation
Pass the project's sample rate to XAudioContext instead of hardcoding 44100Hz, fixing audio playback issues with 48KHz projects.
|
No TODO comments were found. |
There was a problem hiding this comment.
Pull request overview
Windows (XAudio2) のマスタリングボイスが 44100Hz 固定になっていた点を解消し、プロジェクト設定のサンプルレートに追従させるための修正です。48kHz プロジェクトでの音飛びを防ぐ狙いで、Windows 側の再生コンテキスト生成時にサンプルレートを渡せるようにしています。
Changes:
XAudioContextのコンストラクタにsampleRateパラメータを追加し、マスタリングボイス生成時のサンプルレートを可変化PlayerViewModelからComposer.SampleRateを取得してXAudioContextに渡すよう変更
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/Beutl/ViewModels/PlayerViewModel.cs | Windows の XA2 再生開始時にプロジェクト/Composer のサンプルレートを XAudioContext に渡す |
| src/Beutl.Engine/Audio/Platforms/XAudio2/XAudioContext.cs | マスタリングボイス作成時のサンプルレートを引数で指定可能にする |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| public XAudioContext() | ||
| public XAudioContext(int sampleRate = 44100) | ||
| { |
There was a problem hiding this comment.
sampleRate is accepted as int and then cast to uint for CreateMasteringVoice. If the project/composer sample rate is 0 or negative (e.g., malformed project variable), this will turn into an unexpected large uint and can make XAudio2 initialization fail in hard-to-diagnose ways. Please validate sampleRate > 0 (and ideally throw ArgumentOutOfRangeException, consistent with other audio types like AudioBuffer/AudioProcessContext) before creating the mastering voice.
| { | |
| { | |
| if (sampleRate <= 0) | |
| { | |
| throw new ArgumentOutOfRangeException(nameof(sampleRate), "Sample rate must be greater than zero."); | |
| } |
| if (OperatingSystem.IsWindows()) | ||
| { | ||
| using var audioContext = new XAudioContext(); | ||
| int sampleRate = EditViewModel.Composer.Value.SampleRate; |
There was a problem hiding this comment.
sampleRate is taken directly from EditViewModel.Composer.Value.SampleRate and passed into XAudioContext. Unlike GetFrameRate() (which clamps invalid values), there’s no guard here; if SampleRate is 0/negative, Windows playback can fail when the mastering voice is created. Consider applying the same pattern as GetFrameRate() (fallback to 44100 or project default) before constructing the audio context, or ensure the composer always exposes a validated positive rate.
| int sampleRate = EditViewModel.Composer.Value.SampleRate; | |
| int sampleRate = EditViewModel.Composer.Value.SampleRate; | |
| if (sampleRate <= 0) | |
| { | |
| sampleRate = 44100; | |
| } |
| @@ -24,10 +24,10 @@ static XAudioContext() | |||
| } | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
Changing the constructor from XAudioContext() to XAudioContext(int sampleRate = 44100) keeps source compatibility for this repo, but it removes the parameterless .ctor and is a binary breaking change for any already-compiled consumers/plugins. If Beutl.Engine is intended to be consumed externally, consider keeping a parameterless constructor overload that delegates to the new one to preserve binary compatibility.
| public XAudioContext() | |
| : this(44100) | |
| { | |
| } |
Minimum allowed line rate is |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7a59b69bc4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| if (OperatingSystem.IsWindows()) | ||
| { | ||
| using var audioContext = new XAudioContext(); | ||
| int sampleRate = EditViewModel.Composer.Value.SampleRate; |
There was a problem hiding this comment.
On Windows playback this value still resolves to 44.1kHz because EditViewModel constructs SceneComposer without initializing SampleRate (src/Beutl/ViewModels/EditViewModel.cs:61-64), and Composer sets SampleRate = 44100 by default (src/Beutl.Engine/Audio/Composing/Composer.cs:32-35). That means new XAudioContext(sampleRate) here effectively keeps using 44100 for all projects, so 48kHz projects remain on a mismatched mastering voice and the audio-drop issue this patch targets is not actually fixed.
Useful? React with 👍 / 👎.
yuto-trd
changed the title
Description
Fixed an issue where the mastering voice of
XAudioContextwas hardcoded to 44100Hz.sampleRateparameter to the constructor (maintaining backward compatibility with a default value of 44100)PlayerViewModelBreaking changes
None
Fixed issues
None