fix: mic mute

[JarbasAl]

Summary by CodeRabbit

• New Features

  • Improved microphone mute state management during audio playback and stop events.
  • Added informative logging to report microphone mute status after mute, unmute, and toggle actions.

• Bug Fixes

  • Prevented unnecessary stop actions when not recording, ensuring smoother operation during stop events.

[coderabbitai]

Walkthrough

The update modifies the microphone mute state management in the OVOSDinkumVoiceService class. A new instance variable _tmp_muted is introduced to temporarily store the mute state during audio output events. The event handler for 'mycroft.stop' is now unified under _handle_stop_recording, with the previous _handle_stop method removed. Logging is added to mute/unmute/toggle handlers and to audio output start/end handlers to report mute state changes. The stop recording handler now checks if recording is active before proceeding. These changes collectively refine event handling and mute state consistency.

Changes

File(s)	Change Summary
ovos_dinkum_listener/service.py	Added _tmp_muted instance variable; removed _handle_stop; unified 'mycroft.stop' event handling under _handle_stop_recording; added and updated logging in mute/unmute/toggle/audio start/end handlers; improved mute state restoration logic; added early return in stop recording handler if not recording.

Poem

In the warren, mics now know
When to hush and when to show,
With logs that tell us every state,
And muted whispers never late.
The stop is smarter, bunnies cheer,
For clearer sound is finally here!
🐰🎤

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @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]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a6fe35b and 45bce06.

📒 Files selected for processing (1)

• ovos_dinkum_listener/service.py (5 hunks)

🧰 Additional context used

🪛 GitHub Actions: Run UnitTests

ovos_dinkum_listener/service.py

[warning] 481-481: DeprecationWarning: reference self.status.state instead

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: install (3.11)
• GitHub Check: install (3.10)

🔇 Additional comments (7)

ovos_dinkum_listener/service.py (7)

183-183: Good addition of temporary mute state tracking.

Adding the _tmp_muted instance variable provides a clear way to preserve the microphone state during audio output events, which will help maintain consistency in mute state management.

---

402-402: Unified stop handling with recording stop functionality.

Replacing the _handle_stop handler with _handle_stop_recording for the 'mycroft.stop' event streamlines the codebase by consolidating related functionality under a single method.

---

791-791: Improved mute state visibility.

Adding logging when the microphone is muted provides better observability of the system state during operation.

---

799-799: Improved toggle mute state logging.

Adding logging for the mute toggle action helps with debugging and understanding the system state.

---

839-841: Enhanced audio output start mute state management.

Storing the current mute state before applying muting during audio output is a good practice that ensures the system can return to its previous state. The added debug logging also improves visibility.

---

846-848: Robust audio output end mute state restoration.

The implementation correctly restores the previous mute state after audio output ends and resets the temporary variable. The fallback to False when _tmp_muted is None ensures consistent behavior.

---

891-893: Improved stop recording handler with state verification.

Adding an early return when not in recording state prevents unnecessary operations and potential side effects when stopping recording is not applicable.