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

Fix(Spectrogram): Prevent misalignment of Spectrogram at start and end of sample #3904

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ValeHaas
Copy link

@ValeHaas ValeHaas commented Oct 7, 2024

Short description

For Short audio files the spectrogram is only aligned towards the beginning and end of a file. This becomes especially apparent when zooming into the audio/spectrogram.

Resolves #3535

Implementation details

  • Add 2 empty frequencies to the beginning of the spectrogram for alignment: This was experimental and I am unsure what the theoretical explanation of it working would be. Perhaps someone can explain or come up with an idea?
  • Add 0 padding to the end of spectrogram if some data was left out due to window and file length mismatch.

Recommended improvements:

  • Check why 2 seems to be the magic number for front alignment.
  • Somehow add calculations for those first 2 frequencies.
  • Optimize function calls to reduce duplicates.

How to test it

  1. Take a short audio file (<20 sec, even better <10s) with pronounced beats / cuts in the the audio, e.g. this heartbeat: heartbeat.zip

  2. Load it into the examples/audio folder

  3. Change the spectrogram example to this code: spectrogram.js.txt

  4. Zoom in to the ends of the spectrogram

  5. So far, the beats do not align, with this pull request they do.

Screenshots

Before

Screenshot 2024-09-26 131353
Spectrogram aligns in center

Screenshot 2024-09-26 131423
Spectrogram is "late" towards the end of the file.

Screenshot 2024-09-26 131448
Spectrogram is "early" towards the beginning of the file.

After

Screenshot 2024-10-07 174114
Spectrogram is aligned in the end

Screenshot 2024-10-07 174106
Spectrogram is aligned in the beginning

Checklist

  • This PR is covered by e2e tests
    • The umd.cy.js tests fail, but do not seem to be affected by this code change. All others pass
  • It introduces no breaking API changes

Summary by CodeRabbit

  • Bug Fixes
    • Improved spectrogram frequency data handling to ensure accurate representation across different audio input scenarios
    • Enhanced robustness of frequency extraction process for audio channels with varying data lengths

Add 0 padding to the end of spectrogram if some data was left out due to window and file length mismatch
Copy link

coderabbitai bot commented Oct 7, 2024

Walkthrough

The changes enhance the getFrequencies method in the SpectrogramPlugin class to improve frequency data extraction robustness. The modifications focus on handling scenarios where audio data might not perfectly align with the FFT window size. The method now initializes channel frequency arrays with zero-filled Uint8Array instances and adds logic to process remaining audio samples that don't completely fill the expected buffer.

Changes

File Change Summary
src/plugins/spectrogram.ts Updated getFrequencies method to initialize channelFreq with zero-filled arrays and handle partial audio sample processing

Poem

🎵 In spectrogram's digital dance,
Frequencies leap with zero's stance,
Samples partial, windows tight,
Code adapts with rabbit's might!
Frequency mapping, now complete 🐰🎶

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ValeHaas ValeHaas changed the title IMPROVE: Prevent misalignment of spectrogram at start and end of sample. FIX: Prevent misalignment of spectrogram at start and end of sample. Oct 7, 2024
@ValeHaas ValeHaas changed the title FIX: Prevent misalignment of spectrogram at start and end of sample. FIX: Prevent misalignment of [Spectrogram] at start and end of sample. Oct 7, 2024
@ValeHaas
Copy link
Author

I can't seem to figure out, why the first two sample need to be added to the visualization.

I'd appreciate any input on why they seem to be missing.

This is all that's holding me back, since I don't want to push this and breaking the visualization.

@katspaugh
Copy link
Owner

Tbh I don’t know either. The plugin was contributed a long time ago by someone else and I barely touched it since.

@ValeHaas ValeHaas marked this pull request as ready for review January 20, 2025 16:17
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/plugins/spectrogram.ts (1)

622-644: LGTM! Consider refactoring duplicated dB conversion logic.

The zero-padding implementation correctly handles the case where the audio length isn't a multiple of the FFT window size. This is a standard approach in signal processing.

Consider extracting the dB conversion logic into a separate method to avoid code duplication. Here's a suggested refactor:

+ private convertToDB(spectrum: Float32Array, array: Uint8Array): void {
+   for (let j = 0; j < this.fftSamples / 2; j++) {
+     let valueDB = 20 * Math.log10(spectrum[j])
+     if (valueDB < -this.rangeDB) {
+       array[j] = 0
+     } else if (valueDB > -this.gainDB) {
+       array[j] = 255
+     } else {
+       array[j] = (valueDB + this.gainDB) / this.rangeDB * 255 + 256
+     }
+   }
+ }

  // Then replace both occurrences with:
- for (let j = 0; j < fftSamples / 2; j++) {
-   let valueDB = 20 * Math.log10(spectrum[j])
-   if (valueDB < -this.rangeDB) {
-     array[j] = 0
-   } else if (valueDB > -this.gainDB) {
-     array[j] = 255
-   } else {
-     array[j] = (valueDB + this.gainDB) / this.rangeDB * 255 + 256
-   }
- }
+ this.convertToDB(spectrum, array)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d2939c2 and 8527d3e.

📒 Files selected for processing (1)
  • src/plugins/spectrogram.ts (2 hunks)
🔇 Additional comments (1)
src/plugins/spectrogram.ts (1)

595-597: Investigate the root cause for requiring exactly two empty frequencies.

While adding two empty frequency arrays fixes the alignment issue, the choice seems arbitrary. Understanding why exactly two frequencies are needed would help ensure this is the correct solution.

Consider:

  1. Analyzing the FFT window size and overlap to determine if the padding requirement is related to these parameters.
  2. Investigating if this is related to the phase alignment of the FFT windows.
  3. Documenting the findings to justify this specific implementation.

@katspaugh
Copy link
Owner

katspaugh commented Jan 20, 2025

@ValeHaas thanks! Have you had a chance to test it with the latest scaling options added? Btw please run lint and prettier.

@Dabolus @jeffpyke @jonom could you please take a look at this PR?

@katspaugh katspaugh changed the title FIX: Prevent misalignment of [Spectrogram] at start and end of sample. Fix(Spectrogram): Prevent misalignment of Spectrogram at start and end of sample Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants