Mirror of MioMioOS/mio-plugin-music for plugin review
Go to file
徐翔宇 d5934b06b0 v2.1.0: Atoll-style MediaRemoteAdapter — bypass 15.4+ entitlement gate
Ports the MediaRemoteAdapter pattern from Atoll
(github.com/Ebullioscopic/Atoll). On macOS 15.4+, Apple gated
MRMediaRemoteGetNowPlayingInfo behind a private entitlement, which made
our previous MediaRemoteSource return empty dicts and forced us onto
slow-path AppleScript polling. This commit bundles Jonas van den Berg's
MediaRemoteAdapter.framework (BSD-3-Clause) plus mediaremote-adapter.pl
and runs them as a subprocess — the framework links against Apple's MR
in a way that skips the caller-side entitlement check, so we get the
full now-playing payload (title, artist, album, duration, elapsed,
isPlaying, artwork, bundleIdentifier) pushed to us in real time.

Bundle additions (~500KB total):
- Resources/MediaRemoteAdapter.framework (universal x86_64 + arm64 + arm64e)
- Resources/mediaremote-adapter.pl
- LICENSE-THIRD-PARTY.md with full BSD-3-Clause attribution

New source: MediaRemoteAdapterSource.swift
- Spawns /usr/bin/perl with minimal env (PATH + LANG only).
- FileHandle.readabilityHandler ingests newline-delimited JSON stream
  from stdout, parses via Codable AdapterStreamPayload, merges diffs
  into persistent MediaRemoteInfo so playbackRate-only payloads don't
  erase title/artist.
- Artwork base64 decoded via Data default strategy.
- Crash handling: SIGTERM → 500ms → SIGKILL on stop. Auto-restart with
  exponential backoff (1s/2s/4s), circuit-breaker after 3 crashes
  within 60s → fall back to legacy chain.
- Transport controls (togglePlay/next/prev/seek) via short-lived one-shot
  `perl adapter.pl send N` subprocesses. send codes: 2=toggle, 4=next,
  5=prev. seek takes microseconds.

NowPlayingState wiring:
- New sticky kind `.mediaRemoteAdapter`, highest priority.
- `applyAdapterUpdate(_:)` publishes directly (no router pass).
- `routeSources` short-circuits when adapter is sticky + has data —
  subprocess pushes fresh data on every change, polling would be pure
  waste.
- `adaptivePollInterval()` returns 30s for adapter (safety net only).
- `isCandidateLive` + `tryFetch` treat adapter as push-only (returns nil
  from pull-fetch so the sticky fast-path falls through to parallel
  probing if subprocess is dead).
- `stop()` terminates the subprocess cleanly.
- Transport controls route to adapter.sendCommand() / adapter.seek()
  when it's the sticky source.

Build:
- build.sh copies Resources/ into Contents/Resources with preserved
  exec bits on the framework binary + Perl script.
- `codesign --force --deep --sign -` re-signs the whole tree ad-hoc
  so the nested framework inherits our identity and Gatekeeper loads
  it without complaint.
- Bundle grew from 48KB → 1.6MB (zipped 564KB). Acceptable for the
  latency win: Apple Music track switches now visible <100ms vs prior
  800ms adaptive-poll worst case.

Security audit (done before bundling):
- Perl script: strict + warnings, whitelisted function names, no
  shell-out, no network I/O, params passed to framework via ENV
  (no string concat). Safe.
- Framework: ad-hoc signed (Identifier com.vandenbe.MediaRemoteAdapter).
  --deep re-sign with our identity replaces the original ad-hoc cert so
  signature validation passes locally and in Gatekeeper.
- Subprocess runs with PATH=/usr/bin:/bin + LANG only. No inherited
  secrets.
- Explicit Process arguments array — no shell interpolation.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-20 15:19:40 +08:00
Resources v2.1.0: Atoll-style MediaRemoteAdapter — bypass 15.4+ entitlement gate 2026-04-20 15:19:40 +08:00
Sources v2.1.0: Atoll-style MediaRemoteAdapter — bypass 15.4+ entitlement gate 2026-04-20 15:19:40 +08:00
.gitignore v2.0.1: compact UI + AppleScript timeouts 2026-04-19 11:09:29 +08:00
build.sh v2.1.0: Atoll-style MediaRemoteAdapter — bypass 15.4+ entitlement gate 2026-04-20 15:19:40 +08:00
Info.plist v2.1.0: Atoll-style MediaRemoteAdapter — bypass 15.4+ entitlement gate 2026-04-20 15:19:40 +08:00
LICENSE-THIRD-PARTY.md v2.1.0: Atoll-style MediaRemoteAdapter — bypass 15.4+ entitlement gate 2026-04-20 15:19:40 +08:00
README.md v2.0.0: full rewrite with multi-source NowPlaying 2026-04-19 02:27:21 +08:00
README.zh-CN.md docs: add README.md and README.zh-CN.md 2026-04-12 01:09:21 +08:00

Music Player Plugin for MioIsland

v2.0.0 — full rewrite. Real Now Playing info from Spotify, Apple Music, Google Chrome (YouTube / SoundCloud / 网页版音乐), with playback controls, draggable seek bar, album art color tint, and a pseudo-spectrum in the header icon. Replaces the v1.0.0 shell that only wired up MediaRemote.

Features

  • Multi-source playback tracking with sticky source priority:
    • MediaRemote (private framework, any app that registers with MPNowPlayingInfoCenter)
    • Spotify desktop (AppleScript)
    • Apple Music desktop (AppleScript)
    • Google Chrome tabs (JavaScript injection into <video> / <audio> elements)
  • Full playback controls — previous, play/pause, next, draggable seek bar
  • Album art color tint — extracts dominant color from artwork, uses it as a soft gradient background in the expanded view
  • Pseudo-spectrum in the Notch — three animated vertical bars in the header icon that pulse while music is playing
  • Bi-lingual — follows MioIsland's appLanguage preference (zh / en)
  • Graceful degradation:
    • Host too old (< v2.1.7) → shows upgrade banner instead of silently failing
    • Chinese music app running (QQ 音乐 / 网易云 / 酷狗) → shows "desktop not supported, try the web version" hint

Supported music apps

App Supported? How
Spotify desktop Full AppleScript + MediaRemote
Apple Music desktop Full AppleScript + MediaRemote
YouTube / YouTube Music in Chrome Full JS injection
SoundCloud in Chrome Full JS injection
Spotify Web Player in Chrome Full JS injection
网易云音乐 / QQ 音乐 / 酷狗 (网页版) in Chrome Full JS injection
网易云音乐 / QQ 音乐 新版桌面 app 🟡 Partial MediaRemote if the app registers (macOS < 15.4 ok; 15.4+ may silently drop)
酷狗桌面 app / 酷我 / 咪咕 / 其他国产 Not supported No MediaRemote, no AppleScript API
Any app using MPNowPlayingInfoCenter MediaRemote

macOS 15.4+ note: Apple restricted MRMediaRemoteGetNowPlayingInfo to apps with special entitlements. The plugin auto-falls back to AppleScript for Spotify / Apple Music, and to JS injection for Chrome-based sources.

Installation

Prerequisite: MioIsland host v2.1.7 or newer

This plugin uses AppleScript to talk to Spotify / Apple Music / Chrome. macOS requires the host app's Info.plist to declare NSAppleEventsUsageDescription for that. MioIsland added this key in v2.1.7 — older hosts will show an upgrade banner inside the plugin and skip AppleScript sources.

Upgrade the host:

brew upgrade codeisland

Or via MioIsland's in-app update (Sparkle will prompt automatically).

  1. Open MioIsland Settings → Plugins
  2. Click 打开插件市场 (Open Plugin Store) — opens https://miomio.chat
  3. Find Music Player v2.0.0 and click Install
  4. Copy the generated https://api.miomio.chat/api/i/... URL
  5. Paste into the Install from URL field and click Install
  6. Restart MioIsland (menu bar → quit → relaunch)

Manual installation

# Download the latest release from GitHub
curl -LO https://github.com/MioMioOS/mio-plugin-music/releases/latest/download/music-player.zip
unzip music-player.zip
mkdir -p ~/.config/codeisland/plugins/
cp -R music-player.bundle ~/.config/codeisland/plugins/
# Restart MioIsland

First-run permissions

When the plugin fetches track info for the first time, macOS will prompt:

"Mio Island" would like to control "Spotify".app.

Click OK. Do the same for Music.app and Google Chrome when they come up. These permissions are granted to the host app once and remembered forever — subsequent launches don't re-prompt.

If you accidentally clicked Don't Allow, fix it in: System Settings → Privacy & Security → Automation → toggle Mio Island on for each target app.

Chrome-specific setup

To get Chrome playback (YouTube, SoundCloud, etc.) working:

  1. Open Chrome
  2. Menu bar: View → Developer → Allow JavaScript from Apple Events
  3. Check the option (click if unchecked)

This is a one-time setting that lives in Chrome's preferences. Without it, AppleScript JS injection will silently return nothing for Chrome tabs.

Building from source

Requirements:

  • macOS 15.0+
  • Xcode 16+ Command Line Tools
  • Swift 5.10+
git clone https://github.com/MioMioOS/mio-plugin-music.git
cd mio-plugin-music
./build.sh              # → build/music-player.bundle + build/music-player.zip
./build.sh install      # (not implemented — copy manually)

Install the build output:

cp -R build/music-player.bundle ~/.config/codeisland/plugins/

Restart MioIsland.

Plugin architecture (v2.0.0)

Sources/
├── MioPlugin.swift              — plugin SDK protocol (DO NOT MODIFY)
├── MusicPlugin.swift            — principal class (activate / makeView / header slot)
├── NowPlayingState.swift        — @MainActor ObservableObject, source router
├── sources/
│   ├── MediaRemoteSource.swift  — dlopen private MediaRemote.framework
│   ├── SpotifyAppleScript.swift
│   ├── AppleMusicAppleScript.swift
│   └── ChromeWebSource.swift    — JS injection into <video> / <audio>
├── ui/
│   ├── ExpandedView.swift       — main 620×780 panel
│   ├── HeaderSlotView.swift     — 20×20 header icon + pseudo-spectrum
│   ├── AlbumArtColorExtractor.swift
│   └── SeekBar.swift
└── support/
    ├── ChineseAppDetector.swift — QQ / NetEase / Kugou detection
    ├── HostVersionCheck.swift   — host ≥ v2.1.7 gate
    └── Localization.swift       — zh / en strings

Source priority routing: sticky (last successful) → MediaRemote → Spotify → Apple Music → Chrome. First source that returns non-empty playback state wins. 3-second poll timer drives periodic refresh; Spotify and Music distributed notifications trigger immediate refresh for instant reaction.

Privacy

The plugin reads only:

  • System-level Now Playing metadata (MediaRemote)
  • Current track info from Spotify / Music / Chrome via AppleScript
  • Bundle IDs of running apps to detect which source is active

It does not read:

  • Your listening history
  • Anything outside the "currently playing" state
  • Anything from apps that are not music-related

Nothing is sent to any server. All processing happens locally.

License

MIT. See LICENSE.

Author

@xmqywx — part of the MioMioOS official plugin set.