hyprnote icon indicating copy to clipboard operation
hyprnote copied to clipboard

feat: use vad

Open quake opened this issue 9 months ago • 1 comments

try to resolve https://github.com/fastrepl/hyprnote/issues/857

Since the crate voice_activity_detector has already nicely wrapped silero based vad, I thought we could just use it, and I tried to write this PR, it introduces changes to the chunker crate and related components, replacing the old Predictor-based approach with a new vad implementation for processing audio streams. unit test test_chunker to generate the wav file that sounds good.

Summary by CodeRabbit

  • New Features

    • Integrated voice activity detection (VAD) for audio chunking, replacing the previous RMS-based method.
    • Improved speech detection accuracy in local speech-to-text processing.
  • Refactor

    • Simplified the audio chunking interface to use a dedicated voice activity detector.
    • Removed legacy predictor-based logic and related error handling.
  • Chores

    • Updated dependencies to include the new voice activity detector.

quake avatar May 22 '25 12:05 quake

Walkthrough

The changes replace the previous RMS-based and pluggable predictor-based audio chunking logic with a new approach that uses the voice_activity_detector crate for voice activity detection (VAD). All related error handling and predictor abstractions are removed, and the chunking logic is refactored to use VAD for silence detection and chunk segmentation.

Changes

File(s) Change Summary
Cargo.toml, plugins/local-stt/Cargo.toml Added voice_activity_detector dependency to the workspace and local-stt plugin.
crates/chunker/Cargo.toml Removed hypr-vad dependency; added voice_activity_detector as dependency.
crates/chunker/src/error.rs, crates/chunker/src/predictor.rs Deleted error handling and predictor trait/implementations related to previous chunking logic.
crates/chunker/src/lib.rs Removed generic predictor interface; updated chunking to use VoiceActivityDetector. Updated tests accordingly.
crates/chunker/src/stream.rs Refactored ChunkStream to use VAD for silence detection and chunking; removed predictor-based logic and related generics. Added VAD-based filtering helper.
plugins/local-stt/src/server.rs Replaced RMS-based chunker with VAD-based chunker in the WebSocket audio stream handler.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Chunker
    participant VAD

    Client->>Server: Send audio stream
    Server->>Chunker: Pass audio stream
    Chunker->>VAD: Analyze audio samples for speech
    VAD-->>Chunker: Speech/silence labels
    Chunker->>Server: Return speech-only chunks
    Server-->>Client: Stream transcription results

Assessment against linked issues

Objective Addressed Explanation
Use Silero-based VAD for chunking, removing RMS/pluggable predictor logic (#857)
Ensure chunker splits based on silence and strips silence as much as possible (#857, #662)
Maintain max chunk length constraint (e.g., 30 sec, ideally ~12 sec) (#857)
Integrate with dataset/tests for chunker validation (#857)

Poem

A rabbit hopped into the code,
RMS and predictors off he strode.
With VAD in paw, he chunked with glee,
Silence trimmed, as clean as can be!
Now speech flows smooth, no empty sound—
In every hop, great chunks are found!
🐇🎶

[!NOTE]

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Learn more here.

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

coderabbitai[bot] avatar May 22 '25 12:05 coderabbitai[bot]

Sorry - we did a bad job at reviewing and accepting contributions. Blame me :( Won't happen again.

#1200

yujonglee avatar Jul 24 '25 00:07 yujonglee