Add `librespot_options` option

[DarkMatterMatt]

This PR adds support for adding arbitrary additional librespot options. It's completely opt-in and does not change any existing behaviour

Some users may wish to change librespot settings, and many won't have the time to fluff around cloning repos and adding options to suit their use case. This is a minimal effort way to enable advanced users to use any option in while using the addon.

See the librespot documentation for more information about other options

---

To test this option:

1. Enable debug logging; we'll check that the settings are being correctly set by reading the logs
2. Change the value in the config, e.g. --volume-ctrl fixed --normalisation-pregain -9
3. Save changes & restart the addon
4. View the logs, see sample output below

Sample output

[2024-04-06T12:31:32Z INFO  librespot] librespot 0.4.2 UNKNOWN (Built on 2024-04-01, Build ID: YwHEteUz, Profile: release)
[2024-04-06T12:31:32Z TRACE librespot] Command line argument(s):
[2024-04-06T12:31:32Z TRACE librespot] 		bitrate "320"
[2024-04-06T12:31:32Z TRACE librespot] 		name "Home Assistant"
[2024-04-06T12:31:32Z TRACE librespot] 		disable-audio-cache
[2024-04-06T12:31:32Z TRACE librespot] 		verbose
[2024-04-06T12:31:32Z TRACE librespot] 		volume-ctrl "fixed"
[2024-04-06T12:31:32Z TRACE librespot] 		normalisation-pregain "-9"
[2024-04-06T12:31:32Z DEBUG librespot_discovery::server] Zeroconf server listening on 0.0.0.0:43321

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[DarkMatterMatt]

.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[DarkMatterMatt]

.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[coderabbitai[bot]]

Walkthrough

The recent updates introduce a new configuration option, librespot_options, across several components of the HomeAssistant Spotify Connect integration. This feature enhances user control by allowing additional parameters for the librespot library, thereby improving customization and functionality. The changes span documentation, configuration files, script enhancements, and translations, all aimed at providing a richer user experience and better integration with Spotify services.

Changes

Files	Change Summary
spotify/DOCS.md, spotify/config.yaml	Added librespot_options: a new configuration option for specifying additional librespot parameters.
spotify/rootfs/etc/services.d/spotifyd/run	Introduced librespot_options variable for command-line options, enhancing daemon configurability.
spotify/translations/en.yaml	Added new entry for librespot_options with name and description for better user guidance.

Poem

🐰 In the garden of code, with hops and leaps,
New options bloom where the Spotify peeps.
A sprinkle of librespot, a dash of delight,
Now HomeAssistant sings through the night!
With every new config, our joy's on display,
Hopping high with tunes, let's dance and play! 🎶

---

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

• 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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.