Fix pitch shifter phase wrapping#228
Merged
sudip-mondal-2002 merged 3 commits intoMay 26, 2026
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughPitchShifter's phase normalization is refactored to replace unbounded while-loop wrapping with O(1) std::fmod-based wrapping. A ChangesPhase Wrapping Optimization
🎯 2 (Simple) | ⏱️ ~8 minutes Suggested labels: Suggested reviewers:
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Code Coverage Report 📊Line Coverage: 81.3% ✅ Coverage meets threshold: 81.3% >= 60% Full Coverage Summary |
Contributor
PR Preview RemovedThe GitHub Pages preview for this PR has been removed because the PR was closed. |
Owner
|
@donglrd shouldn't we have some test coverage? |
Contributor
Author
|
Added a regression test for the pitch shifter phase wrapping path. It exercises an extreme positive shift/fine-tune case, processes a full buffer, and asserts the output remains finite with signal energy. Validated locally:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
tests/test_effects.cpp (1)
1343-1347: ⚡ Quick winHarden the regression setup so extreme params are guaranteed active.
Set params after
reset()(or assert values after reset) so this test can’t silently stop exercising the extreme-wrap path if reset behavior changes.Proposed tweak
TEST(pitch_shifter_extreme_shift_wraps_phase_without_instability) { PitchShifter ps; ps.set_sample_rate(48000); + ps.reset(); ps.params()[0].value = 120.0f; ps.params()[1].value = 500.0f; ps.params()[2].value = 1.0f; - ps.reset(); + + ASSERT_NEAR(ps.params()[0].value, 120.0f, 1e-6f); + ASSERT_NEAR(ps.params()[1].value, 500.0f, 1e-6f); + ASSERT_NEAR(ps.params()[2].value, 1.0f, 1e-6f);🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@tests/test_effects.cpp` around lines 1343 - 1347, Move the parameter assignments so they occur after calling ps.reset() (or alternatively add assertions that ps.params()[i].value equals the intended values immediately after reset) to ensure the extreme values are active regardless of reset behavior; specifically modify the test to call ps.reset() first and then set ps.params()[0].value = 120.0f, ps.params()[1].value = 500.0f, ps.params()[2].value = 1.0f (or assert those values after ps.reset()) so the extreme-wrap path is enforced reliably.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@tests/test_effects.cpp`:
- Around line 1343-1347: Move the parameter assignments so they occur after
calling ps.reset() (or alternatively add assertions that ps.params()[i].value
equals the intended values immediately after reset) to ensure the extreme values
are active regardless of reset behavior; specifically modify the test to call
ps.reset() first and then set ps.params()[0].value = 120.0f,
ps.params()[1].value = 500.0f, ps.params()[2].value = 1.0f (or assert those
values after ps.reset()) so the extreme-wrap path is enforced reliably.
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
tests/test_effects.cpp (1)
1368-1383: ⚡ Quick winExtend this regression to include the sample-rate-change trigger path.
This test covers extreme phase stepping well, but the reported repro also includes runtime sample-rate changes. Adding a second pass after changing sample rate will lock in that path too.
Proposed test extension
TEST(pitch_shifter_extreme_shift_wraps_phase_without_instability) { PitchShifter ps; ps.set_sample_rate(48000); ps.params()[0].value = 120.0f; ps.params()[1].value = 500.0f; ps.params()[2].value = 1.0f; ps.reset(); std::vector<float> buf(4096); fill_sine(buf.data(), static_cast<int>(buf.size()), 440.0f, 48000); ps.process(buf.data(), static_cast<int>(buf.size())); ASSERT_TRUE(buffer_is_finite(buf.data(), static_cast<int>(buf.size()))); ASSERT_GT(rms(buf.data(), static_cast<int>(buf.size())), 0.001f); + + ps.set_sample_rate(96000); + ps.reset(); + fill_sine(buf.data(), static_cast<int>(buf.size()), 440.0f, 96000); + ps.process(buf.data(), static_cast<int>(buf.size())); + ASSERT_TRUE(buffer_is_finite(buf.data(), static_cast<int>(buf.size()))); + ASSERT_GT(rms(buf.data(), static_cast<int>(buf.size())), 0.001f); }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@tests/test_effects.cpp` around lines 1368 - 1383, The test pitch_shifter_extreme_shift_wraps_phase_without_instability needs to exercise the sample-rate-change trigger path too: after the first process pass, call ps.set_sample_rate(...) with a different rate (e.g., 44100), call ps.reset() if appropriate, then run a second ps.process(...) on the same buffer and assert finiteness and non-zero rms again; update the TEST (and use the same PitchShifter instance and functions set_sample_rate, reset, process, buffer_is_finite, rms) so the regression includes the runtime sample-rate change path.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@tests/test_effects.cpp`:
- Around line 1368-1383: The test
pitch_shifter_extreme_shift_wraps_phase_without_instability needs to exercise
the sample-rate-change trigger path too: after the first process pass, call
ps.set_sample_rate(...) with a different rate (e.g., 44100), call ps.reset() if
appropriate, then run a second ps.process(...) on the same buffer and assert
finiteness and non-zero rms again; update the TEST (and use the same
PitchShifter instance and functions set_sample_rate, reset, process,
buffer_is_finite, rms) so the regression includes the runtime sample-rate change
path.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
whileloops inPitchShifter::process()with a constant-time wrapperread_linear()so phase normalization stays consistentFixes #218
Testing
git diff --check HEAD~1 HEADcmake --build build --target amplitron-tests -j10./build/amplitron-tests --gtest_filter='*pitch_shifter*'(274 passed, 0 failed)Summary by CodeRabbit