sendspin 4.1.1__tar.gz

sendspin-4.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sendspin-4.1.1/PKG-INFO

@@ -0,0 +1,323 @@
+Metadata-Version: 2.4
+Name: sendspin
+Version: 4.1.1
+Summary: Synchronized audio player for Sendspin servers
+Author-email: Sendspin Protocol Authors <sendspin@openhomefoundation.org>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Sendspin-Protocol/sendspin
+Project-URL: Bug Tracker, https://github.com/Sendspin-Protocol/sendspin/issues
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiosendspin~=3.0
+Requires-Dist: aiosendspin-mpris~=2.1
+Requires-Dist: av>=14.0.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: qrcode>=8.0
+Requires-Dist: readchar>=4.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: sounddevice>=0.4.6
+Provides-Extra: test
+Requires-Dist: codespell==2.4.1; extra == "test"
+Requires-Dist: mypy==1.18.2; extra == "test"
+Requires-Dist: pre-commit==4.4.0; extra == "test"
+Requires-Dist: pre-commit-hooks==6.0.0; extra == "test"
+Requires-Dist: ruff==0.14.5; extra == "test"
+Dynamic: license-file
+
+# sendspin
+
+[![pypi_badge](https://img.shields.io/pypi/v/sendspin.svg)](https://pypi.python.org/pypi/sendspin)
+
+Connect to any [Sendspin](https://www.sendspin-audio.com) server and instantly turn your computer into an audio target that can participate in multi-room audio.
+
+Sendspin CLI includes three apps:
+
+- **`sendspin`** - Terminal client for interactive use
+- **`sendspin daemon`** - Background daemon for headless devices
+- **`sendspin serve`** - Host a Sendspin party to demo Sendspin
+
+<img width="1144" height="352" alt="image" src="https://github.com/user-attachments/assets/5a649bde-76f6-486f-b3aa-0af5e49e0ac7" />
+
+[![A project from the Open Home Foundation](https://www.openhomefoundation.org/badges/ohf-project.png)](https://www.openhomefoundation.org/)
+
+## Quick Start
+
+**Run directly with [uv](https://docs.astral.sh/uv/getting-started/installation/):**
+
+Start client
+
+```bash
+uvx sendspin
+```
+
+Host a Sendspin party
+
+```bash
+uvx sendspin serve --demo
+uvx sendspin serve /path/to/media.mp3
+uvx sendspin serve https://retro.dancewave.online/retrodance.mp3
+```
+
+## Installation
+
+**With uv:**
+```bash
+uv tool install sendspin
+```
+
+**Install as daemon (Linux):**
+```bash
+curl -fsSL https://raw.githubusercontent.com/Sendspin/sendspin-cli/refs/heads/main/scripts/systemd/install-systemd.sh | sudo bash
+```
+
+**With pip:**
+```bash
+pip install sendspin
+```
+
+<details>
+<summary>Install from source</summary>
+
+```bash
+git clone https://github.com/Sendspin-Protocol/sendspin.git
+cd sendspin
+pip install .
+```
+
+</details>
+
+**After installation, run:**
+```bash
+sendspin
+```
+
+The player will automatically connect to a Sendspin server on your local network and be available for playback.
+
+## Updating
+
+To update to the latest version of Sendspin:
+
+**If installed with uv:**
+```bash
+uv tool upgrade sendspin
+```
+
+**If installed with pip:**
+```bash
+pip install --upgrade sendspin
+```
+
+**If installed as systemd daemon:**
+
+The systemd daemon preserves your configuration during updates. Simply upgrade the package:
+
+```bash
+# Upgrade sendspin (the daemon installer uses uv by default)
+uv tool upgrade sendspin
+
+# Or if you installed with pip
+pip install --upgrade sendspin
+
+# Restart the service to use the new version
+sudo systemctl restart sendspin
+```
+
+Your client name, audio device selection, and other settings in `/etc/default/sendspin` are preserved during the update.
+
+> **Note:** You do **not** need to uninstall and reinstall when updating. Your configuration (client name, audio device, delay settings) is stored separately and will be preserved.
+
+## Configuration Options
+
+Sendspin stores settings in JSON configuration files that persist between sessions. All command-line arguments can also be set in the config file, with CLI arguments taking precedence over stored settings.
+
+### Configuration File
+
+Settings are stored in `~/.config/sendspin/`:
+- `settings-tui.json` - Settings for the interactive TUI client
+- `settings-daemon.json` - Settings for daemon mode
+- `settings-serve.json` - Settings for serve mode
+
+**Example configuration file (TUI/daemon):**
+```json
+{
+  "player_volume": 50,
+  "player_muted": false,
+  "static_delay_ms": -100.0,
+  "last_server_url": "ws://192.168.1.100:8927/sendspin",
+  "name": "Living Room",
+  "client_id": "sendspin-living-room",
+  "audio_device": "2",
+  "log_level": "INFO",
+  "listen_port": 8927,
+  "use_mpris": true
+}
+```
+
+**Example configuration file (serve):**
+```json
+{
+  "log_level": "INFO",
+  "listen_port": 8927,
+  "name": "My Sendspin Server",
+  "source": "/path/to/music.mp3",
+  "clients": ["ws://192.168.1.50:8927/sendspin", "ws://192.168.1.51:8927/sendspin"]
+}
+```
+
+**Available settings:**
+
+| Setting | Type | Mode | Description |
+|---------|------|------|-------------|
+| `player_volume` | integer (0-100) | TUI/daemon | Player output volume percentage |
+| `player_muted` | boolean | TUI/daemon | Whether the player is muted |
+| `static_delay_ms` | float | TUI/daemon | Extra playback delay in milliseconds |
+| `last_server_url` | string | TUI/daemon | Server URL (used as default for `--url`) |
+| `name` | string | All | Friendly name for client or server (`--name`) |
+| `client_id` | string | TUI/daemon | Unique client identifier (`--id`) |
+| `audio_device` | string | TUI/daemon | Audio device index or name prefix (`--audio-device`) |
+| `log_level` | string | All | Logging level: DEBUG, INFO, WARNING, ERROR, CRITICAL |
+| `listen_port` | integer | daemon/serve | Listen port (`--port`, default: 8927) |
+| `use_mpris` | boolean | TUI/daemon | Enable MPRIS integration (default: true) |
+| `source` | string | serve | Default audio source (file path or URL) |
+| `clients` | array | serve | Client URLs to connect to (`--client`) |
+
+Settings are automatically saved when changed through the TUI. You can also edit the JSON file directly while the client is not running.
+
+### Server Connection
+
+By default, the player automatically discovers Sendspin servers on your local network using mDNS. You can also connect directly to a specific server:
+
+```bash
+sendspin --url ws://192.168.1.100:8080/sendspin
+```
+
+**List available servers on the network:**
+```bash
+sendspin --list-servers
+```
+
+### Client Identification
+
+If you want to run multiple players on the **same computer**, you can specify unique identifiers:
+
+```bash
+sendspin --id my-client-1 --name "Kitchen"
+sendspin --id my-client-2 --name "Bedroom"
+```
+
+- `--id`: A unique identifier for this client (optional; defaults to `sendspin-<hostname>`, useful for running multiple instances on one computer)
+- `--name`: A friendly name displayed on the server (optional; defaults to hostname)
+
+### Audio Output Device Selection
+
+By default, the player uses your system's default audio output device. You can list available devices or select a specific device:
+
+**List available audio devices:**
+```bash
+sendspin --list-audio-devices
+```
+
+This displays all audio output devices with their IDs, channel configurations, and sample rates. The default device is marked.
+
+**Select a specific audio device by index:**
+```bash
+sendspin --audio-device 2
+```
+
+**Or by name prefix:**
+```bash
+sendspin --audio-device "MacBook"
+```
+
+This is particularly useful when running `sendspin daemon` on headless devices or when you want to route audio to a specific output.
+
+### Adjusting Playback Delay
+
+The player supports adjusting playback delay to compensate for audio hardware latency or achieve better synchronization across devices.
+
+```bash
+sendspin --static-delay-ms -100
+```
+
+> **Note:** Based on limited testing, the delay value is typically a negative number (e.g., `-100` or `-150`) to compensate for audio hardware buffering.
+
+### Daemon Mode
+
+To run the player as a background daemon without the interactive TUI (useful for headless devices or scripts):
+
+```bash
+sendspin daemon
+```
+
+The daemon runs in the background and logs status messages to stdout. It accepts the same connection and audio options as the TUI client:
+
+```bash
+sendspin daemon --name "Kitchen" --audio-device 2
+```
+
+### Debugging & Troubleshooting
+
+If you experience synchronization issues or audio glitches, you can enable detailed logging to help diagnose the problem:
+
+```bash
+sendspin --log-level DEBUG
+```
+
+This provides detailed information about time synchronization. The output can be helpful when reporting issues.
+
+## Limitations & Known Issues
+
+This player is highly experimental and has several known limitations:
+
+- **Format Support**: Currently fixed to uncompressed 44.1kHz 16-bit stereo PCM
+
+## Install as Daemon (systemd, Linux)
+
+For headless devices like Raspberry Pi, you can install `sendspin daemon` as a systemd service that starts automatically on boot.
+
+**Install:**
+```bash
+curl -fsSL https://raw.githubusercontent.com/Sendspin/sendspin-cli/refs/heads/main/scripts/systemd/install-systemd.sh | sudo bash
+```
+
+The installer will:
+- Check and offer to install dependencies (libportaudio2, uv)
+- Install sendspin via `uv tool install`
+- Prompt for client name and audio device selection
+- Create systemd service and configuration
+
+**Manage the service:**
+```bash
+sudo systemctl start sendspin    # Start the service
+sudo systemctl stop sendspin     # Stop the service
+sudo systemctl status sendspin   # Check status
+journalctl -u sendspin -f        # View logs
+```
+
+**Configuration:** Edit `/etc/default/sendspin` to change client name, audio device, or delay settings.
+
+**Uninstall:**
+```bash
+curl -fsSL https://raw.githubusercontent.com/Sendspin/sendspin-cli/refs/heads/main/scripts/systemd/uninstall-systemd.sh | sudo bash
+```
+
+## Sendspin Party
+
+The Sendspin client includes a mode to enable hosting a Sendspin Party. This will start a Sendspin server playing a specified audio file or URL in a loop, allowing nearby Sendspin clients to connect and listen together. It also hosts a web interface for easy playing and sharing. Fire up that home or office 🔥
+
+```bash
+# Demo mode
+sendspin serve --demo
+# Local file
+sendspin serve /path/to/media.mp3
+# Remote URL
+sendspin serve https://retro.dancewave.online/retrodance.mp3
+# Without pre-installing Sendspin
+uvx sendspin serve /path/to/media.mp3
+# Connect to specific clients
+sendspin serve --demo --client ws://192.168.1.50:8927/sendspin --client ws://192.168.1.51:8927/sendspin
+```