Fix sound effect issue after sleep or hibernation

[Jack251970]

When system resumes, we need to recreate Sound instance so that it can play sound normally.

From: https://stackoverflow.com/questions/64805186/mediaplayer-doesnt-play-after-computer-sleeps

Resolve #3278.

Tested.

[github-actions]

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors and Warnings	Count
❌ forbidden-pattern	24
⚠️ non-alpha-in-dictionary	19

See ❌ Event descriptions for more information.

Forbidden patterns 🙅 (1)

In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.

These forbidden patterns matched content:

s.b. workaround(s)

\bwork[- ]arounds?\b

If the flagged items are 🤯 false positives

If items relate to a ...

• binary file (or some other file you wouldn't want to check at all).

  Please add a file path to the excludes.txt file matching the containing file.

  File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

  ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

• well-formed pattern.

  If you can write a pattern that would match it,
  try adding it to the patterns.txt file.

  Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

  Note that patterns can't match multiline strings.

[gitstream-cm]

🥷 Code experts: onesounds

Jack251970, onesounds have most 👩‍💻 activity in the files.
Jack251970, onesounds have most 🧠 knowledge in the files.

See details

Flow.Launcher/MainWindow.xaml.cs

Activity based on git-commit:

	Jack251970	onesounds
MAY	19 additions & 14 deletions
APR	69 additions & 45 deletions	5 additions & 1 deletions
MAR	1141 additions & 1076 deletions	327 additions & 141 deletions
FEB	1 additions & 1 deletions	8 additions & 4 deletions
JAN
DEC	5 additions & 10 deletions

Knowledge based on git-blame:
Jack251970: 65%
onesounds: 15%

To learn more about /:\ gitStream - Visit our Docs

[gitstream-cm]

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

[Copilot]

Pull Request Overview

This PR addresses the issue of sound effects failing to play after system sleep or hibernation by reinitializing the sound components upon a system resume event.

• Added a subscription to SystemEvents.PowerModeChanged, triggering reinitialization of the sound effects.
• Enhanced cleanup by disposing or closing sound objects and unsubscribing from the event during disposal.

Comments suppressed due to low confidence (2)

Flow.Launcher/MainWindow.xaml.cs:562

• [nitpick] Consider using Path.Combine(AppContext.BaseDirectory, "Resources", "open.wav") to construct the file path, which enhances readability and reliability.

animationSoundWMP.Open(new Uri(AppContext.BaseDirectory + "Resources\open.wav"));

Flow.Launcher/MainWindow.xaml.cs:567

• [nitpick] Consider using Path.Combine(AppContext.BaseDirectory, "Resources", "open.wav") to construct the file path, which enhances readability and reliability.

animationSoundWPF = new SoundPlayer(AppContext.BaseDirectory + "Resources\open.wav");

[coderabbitai]

📝 Walkthrough

Walkthrough

The update adds handling for system power mode changes in the main window logic. When the system resumes from sleep or hibernation, sound effects are reinitialized to address an issue where sounds fail to play after waking. Event subscription and resource management logic were introduced to support this behavior.

Changes

File(s)	Change Summary
Flow.Launcher/MainWindow.xaml.cs	Subscribed to SystemEvents.PowerModeChanged event, added handler to reinitialize sound effects on resume, improved sound resource cleanup before reinitialization, and made minor whitespace adjustments.

Sequence Diagram(s)

sequenceDiagram
    participant System
    participant MainWindow
    participant SoundPlayer

    System->>MainWindow: PowerModeChanged(Resume)
    MainWindow->>MainWindow: SystemEvents_PowerModeChanged()
    MainWindow->>MainWindow: InitSoundEffects()
    MainWindow->>SoundPlayer: Close or Dispose existing sound resources
    MainWindow->>SoundPlayer: Create new sound player instances

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Fix sound effects not playing after system resumes from sleep/hibernation (#3278)	✅

Suggested reviewers

• jjw24

Poem

When laptops nap and softly wake,
Some sounds might vanish, never to break.
But now with code both sharp and keen,
The music returns, crisp and clean!
No more silence after sleep’s delight—
Flow Launcher’s sounds are back, just right.
🐇🎶

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 63aabd5 and 71b6cb2.

📒 Files selected for processing (1)

• Flow.Launcher/MainWindow.xaml.cs (10 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

Flow.Launcher/MainWindow.xaml.cs (2)

Flow.Launcher/App.xaml.cs (2)

• Dispose (320-360)
• Dispose (362-367)

Flow.Launcher/ViewModel/MainViewModel.cs (2)

• Dispose (1898-1913)
• Dispose (1915-1920)

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

• GitHub Check: gitStream workflow automation
• GitHub Check: gitStream.cm
• GitHub Check: gitStream.cm
• GitHub Check: build

🔇 Additional comments (6)

Flow.Launcher/MainWindow.xaml.cs (6)

25-25: Added necessary namespace import for SystemEvents.

Good addition of the Microsoft.Win32 namespace which is required for accessing the SystemEvents class used to monitor power mode changes.

---

92-93: Good implementation of event subscription.

Properly subscribes to the SystemEvents.PowerModeChanged event in the constructor, which will allow the application to detect when the system resumes from sleep or hibernation.

---

546-554: Well-implemented event handler for system power state changes.

The event handler correctly checks for PowerModes.Resume and reinitializes sound effects when the system wakes up from sleep or hibernation. The comment with the Stack Overflow reference is helpful for future developers to understand the rationale behind this implementation.

---

560-560: Good resource management for WMP player.

Using the null-conditional operator to safely close the existing MediaPlayer instance before creating a new one prevents potential resource leaks.

---

566-568: Proper resource cleanup and initialization for WPF player.

Correctly disposes the existing SoundPlayer instance before creating and loading a new one, ensuring clean resource management.

---

1181-1183: Complete resource cleanup in Dispose method.

Excellent addition of proper resource cleanup in the Dispose method:

1. Closing the MediaPlayer
2. Disposing the SoundPlayer
3. Unsubscribing from the SystemEvents.PowerModeChanged event

This prevents memory leaks and follows the proper IDisposable pattern.

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

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.

[Jack251970]

@jjw24 I would like to include this bug fix PR in 1.20.0 milestone.