Skip to main content

Minimal Squeezebox player for Lyrion Music Server

Project description

Squeezy

Minimal Squeezebox-compatible player for Lyrion Music Server (formerly Logitech Media Server). Advertises as a player on your network, receives streaming audio, and plays it back through your default audio output. Supports synchronized playback with other players.

Before you use this

If you can run a binary, use LocalPlayer instead. It's a Lyrion Music Server plugin that bundles squeezelite — a proper, mature, battle-tested C implementation. It installs in two clicks from the LMS plugin browser, handles every edge case, and just works. Nearly every protocol detail and edge case in squeezy was reverse-engineered from squeezelite's source. It is the gold standard and the direct inspiration for this project.

Squeezy exists for one narrow situation: you're on a machine where you can't run an unverified or unpackaged binary — a locked-down work laptop, a corporate machine with strict security policy, a CI environment — but you can run Python packages. That's how this project started: wanting to listen to music on a work laptop through Lyrion without having to file an IT ticket to run a compiled binary from the internet. pip install squeezy and it just works.

If that's not your situation, seriously — go use LocalPlayer. It's better in every way.


Note: This project was largely vibe-coded with Claude. It passes ~100 tests and works reliably day-to-day, but treat it accordingly.


Requirements

  • macOS, Linux, or Windows
  • Python 3.9+
  • ffmpeg

Install

Pick whichever method suits you. All three result in a squeezy command on your PATH.

Option 1: pipx (recommended)

# macOS
brew install ffmpeg pipx
pipx install squeezy

# Debian/Ubuntu
sudo apt install ffmpeg pipx
pipx install squeezy

Option 2: Homebrew tap (macOS only)

brew tap catcatcatcatcatcatcatcatcatcat/tap
brew install squeezy

This installs ffmpeg automatically as a dependency.

Option 3: From source

git clone https://github.com/catcatcatcatcatcatcatcatcatcat/squeezy.git
cd squeezy
python3 -m venv .venv
source .venv/bin/activate
pip install .

For development (run directly without installing):

./run.sh -n "My Speaker" -vv

Squeezy checks for updates on startup and will notify you when a new version is available.

Usage

# Auto-discover server on local network
squeezy

# Specify server and player name
squeezy -s 192.168.1.100 -n "Kitchen Speaker"

# Custom MAC address (for persistent player identity)
squeezy -m aa:bb:cc:dd:ee:ff

# List available audio output devices
squeezy -l

# Use a specific audio output (substring match, case-insensitive)
squeezy -d "HDMI" -n "Living Room"

# Verbose logging (connection, playback events, volume changes)
squeezy -v

# Debug logging (protocol-level detail: strm commands, STAT packets)
squeezy -vv

# Check installed version
squeezy --version

Your player will appear in the Lyrion Music Server web UI. Select it from the player dropdown to start streaming.

Project Structure

src/squeezy/
├── squeezy.py              # Main player orchestrator & audio pipeline
├── audio/
│   └── stream_decoder.py   # Thread-safe PCMBuffer
├── protocol/
│   ├── handler.py          # SlimProto message handlers (strm, audg, setd, etc.)
│   ├── slimproto.py        # Protocol constants & packet builders
│   └── lms_client.py       # LMS message operations
├── network/
│   ├── server_connection.py # TCP/UDP socket management & discovery
│   ├── lms_metadata.py     # LMS JSON-RPC track metadata queries
│   └── status_server.py    # Unix socket status server
└── config/
    ├── config.py           # XDG-compliant config persistence
    └── metadata.py         # ICY metadata & LAME gapless parsing

Contributing

See DEVELOPER.md for a full walkthrough of the repo structure, how to set up a dev environment, and how to cut a release.

How it works

Squeezy implements the SlimProto protocol to communicate with Lyrion Music Server:

  1. Discovers the server via UDP broadcast on port 3483
  2. Registers as a player via TCP (HELO packet)
  3. Receives stream commands from the server
  4. Fetches audio via HTTP, decodes with ffmpeg, outputs via miniaudio
  5. Reports playback status back to the server for sync coordination

Uninstall

# If installed via pipx
pipx uninstall squeezy

# If installed via Homebrew
brew uninstall squeezy
brew untap catcatcatcatcatcatcatcatcatcat/tap

Releasing (for maintainers)

See DEVELOPER.md for the full release process. The short version: bump version in pyproject.toml, tag, build, upload to PyPI, update the Homebrew tap.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

squeezy-0.5.2.tar.gz (58.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

squeezy-0.5.2-py3-none-any.whl (51.3 kB view details)

Uploaded Python 3

File details

Details for the file squeezy-0.5.2.tar.gz.

File metadata

  • Download URL: squeezy-0.5.2.tar.gz
  • Upload date:
  • Size: 58.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for squeezy-0.5.2.tar.gz
Algorithm Hash digest
SHA256 8ac61ee409fe2f95b8a8935483093fa770bcacc093b8428fa2bbfd66264ddf3b
MD5 e59cd61c0c6b218bc9b1a1823cb1fbe1
BLAKE2b-256 8661de649196c5b6992cb1f04237bc6f84d208d3c6801c8273a102243ff361a6

See more details on using hashes here.

File details

Details for the file squeezy-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: squeezy-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 51.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for squeezy-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7b7018d175a9a8650be11b2989427918d7bc385b873c8892f621904b6e0f5c98
MD5 589dcd7a7e86ba21144f5d5d77d16cb2
BLAKE2b-256 e772fb2fa4ac355355e5561d1212754ed43f6c20a67c83e9065a5a9ab267b134

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page