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

feat:binary handlers #5

Merged
merged 2 commits into from
Oct 30, 2024
Merged

feat:binary handlers #5

merged 2 commits into from
Oct 30, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Oct 30, 2024

companion to JarbasHiveMind/hivemind-websocket-client#33 and https://github.com/JarbasHiveMind/HiveMind-core/pull/100 and JarbasHiveMind/hivemind-audio-binary-protocol#1

Summary by CodeRabbit

  • New Features

    • Introduced enhanced Text-to-Speech (TTS) handling capabilities, allowing for the processing and playback of received TTS audio.
    • Added a preference option for TTS message replies, improving flexibility in audio response formats.
  • Improvements

    • Updated logging for clarity regarding audio processing events.
    • Specified version constraints for dependencies to ensure compatibility and stability.

Copy link
Contributor

coderabbitai bot commented Oct 30, 2024

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 6 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 004ad9b and b1fd708.

Walkthrough

The changes introduce a new class TTSHandler within the hivemind_mic_sat module, which extends BinaryDataCallbacks. This class includes a method handle_receive_tts for processing TTS binary data, logging its receipt, saving it to a temporary WAV file, and playing the audio. The constructor of HiveMindMicrophoneClient is modified to accept a prefer_b64 parameter, affecting the type of message reply for TTS requests. Additionally, logging messages and the run method have been updated to enhance TTS handling capabilities.

Changes

File Change Summary
hivemind_mic_sat/init.py Added class TTSHandler extending BinaryDataCallbacks. Added method handle_receive_tts. Updated __init__ method of HiveMindMicrophoneClient to accept prefer_b64 parameter. Updated handle_speak method to modify reply types and logging. Updated run method to log listener loop start.
requirements.txt Updated version constraints for hivemind_bus_client to >=0.1.0,<1.0.0 and for ovos-plugin-manager to <1.0.0.

Poem

🐰 In the hive where voices play,
A new handler hops in today.
With TTS tunes, it sings so bright,
Logging joy, a pure delight!
WAV files dance, the bunnies cheer,
For every sound, we hold so dear! 🎶


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 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.

@github-actions github-actions bot added feature and removed feature labels Oct 30, 2024
Copy link
Contributor

@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: 1

🧹 Outside diff range and nitpick comments (3)
hivemind_mic_sat/__init__.py (3)

31-33: Add docstring to document the prefer_b64 parameter.

The new parameter should be documented to explain its purpose and impact.

 def __init__(self, prefer_b64=False):
+    """Initialize HiveMindMicrophoneClient.
+    
+    Args:
+        prefer_b64 (bool): If True, TTS responses will use base64 encoding.
+                          If False, binary synthesis will be used.
+    """
     self.prefer_b64 = prefer_b64
     self.hm_bus = HiveMessageBusClient(bin_callbacks=TTSHandler())

87-92: Enhance logging for better debugging.

The speak handling logic should log which mode is being used.

     if self.prefer_b64:
+        LOG.debug("Using base64 audio encoding for TTS")
         m = message.reply("speak:b64_audio", message.data)
     else:
+        LOG.debug("Using binary synthesis for TTS")
         m = message.reply("speak:synth", message.data)
     self.hm_bus.emit(HiveMessage(HiveMessageType.BUS, payload=m))
-    LOG.debug("Requested TTS audio")
+    LOG.debug(f"Requested TTS audio for: {message.data.get('utterance', 'unknown text')}")

116-116: Enhance startup logging message.

The startup log could include more diagnostic information.

-    LOG.info("Listener Loop Started")
+    LOG.info(f"Listener Loop Started (VAD: {self.vad.__class__.__name__}, "
+             f"Microphone: {self.mic.__class__.__name__}, "
+             f"Sample Rate: {self.mic.sample_rate}Hz)")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 122c0ac and 004ad9b.

📒 Files selected for processing (1)
  • hivemind_mic_sat/init.py (4 hunks)
🔇 Additional comments (2)
hivemind_mic_sat/__init__.py (2)

6-6: LGTM: Import changes are appropriate.

The addition of BinaryDataCallbacks import is necessary for the new TTSHandler implementation.


31-33: Verify integration with related PRs.

This PR is part of a larger change set across multiple repositories. Please ensure the binary handling changes are consistent with:

  • hivemind-websocket-client/pull/33
  • HiveMind-core/pull/100
  • hivemind-listener/pull/1

Also applies to: 87-92

hivemind_mic_sat/__init__.py Show resolved Hide resolved
@JarbasAl JarbasAl merged commit 107c3ee into dev Oct 30, 2024
1 of 2 checks passed
@JarbasAl JarbasAl deleted the feat/bin branch October 30, 2024 14:12
@github-actions github-actions bot added feature and removed feature labels Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant