Add MPRIS support #1596

paulfariello · 2025-09-23T08:59:35Z

Taking back on @wisp3rwind work for adding MPRIS support #1341.

Rebased on recent dev branch
ensure cargo fmt and cargo clippy passes on each commit
fix a few todos
send signal when position changed
return error when MPRIS command are done in wrong context or internal fails
handle position
handle identity
choose biggest art url
ensure metadata are always up to date or at least not invalid
notify on various property change

Not sure about:

Sending current state of player for all new listener (59767ce)

src/mpris_event_handler.rs

- which is just a tokio::sync::mpsc sender, so this should be safe - prep for MPRIS support, which will use this to control playback

- preparation for MPRIS support - now that the data is there, also yield from player_event_handler

- preparation for MPRIS support

- following the spec at https://specifications.freedesktop.org/mpris-spec/latest/ - some properties/commands are not fully supported, yet

paulfariello · 2025-09-30T15:33:51Z

@roderickvd this PR can probably be considered ready. The only missing feature is to handle the track list. It can probably be done in another PR.

Right now, CI is failing but doesn't seems to be related to this specific PR.

Do you have an opinion concerning 59767ce which is a broader modification than just MPRIS support?

wisp3rwind

Thanks for moving this forward!

I've looked through the PR superficially; here are a few comments. I didn't really check the actual implementation of MPRIS commands.

wisp3rwind · 2025-10-01T06:52:04Z

playback/src/player.rs

+                        let _ = sender.send(PlayerEvent::Loading {
+                            play_request_id,
+                            track_id: track_id.clone(),
+                            position_ms: 0, // TODO


From a quick look at the code, it might be viable to store position_ms in PlayerState::Loading at the end of handle_command_load to have access here?

OTOH, it's probably fine to not do that work here: This event should be followed by PlayerEvent::Playing or PlayerEvent::Paused quickly, and arguably, the position is not that important while loading.

done in f5cf187

wisp3rwind · 2025-10-01T07:01:02Z

playback/src/player.rs

+                            track_id: track_id.clone(),
+                        });
+                    }
+                    _ => (),


What about PlayerState::Stopped? It seems somewhat important, since it's the initial state of the Player; unfortunately, the data to fill in the missing fields of PlayerEvent::Stopped is not available in that case. Could it be filled with some dummy/clearly invalid values?¹ Or maybe it's not so important after all, since the initial state of the MPRIS task will also correspond to a stopped state?

Footnotes

In that case, maybe also map PlayerState::Invalid to PlayerEvent::Stopped? ↩

done in 4f55158

wisp3rwind · 2025-10-01T07:01:37Z

playback/src/player.rs


-            PlayerCommand::AddEventSender(sender) => self.event_senders.push(sender),
+            PlayerCommand::AddEventSender(sender) => {
+                // Send current player state to new event listener


Seems like a good idea to me 👍

wisp3rwind · 2025-10-01T07:04:24Z

src/main.rs

+    .optopt(
+        POSITION_UPDATE_SHORT,
+        POSITION_UPDATE,
+        "Update position interval in ms",


Maybe explain that this is about player events and thereby also MPRIS? I feel like without that context, it be quite unclear what the purpose of this option is?

Personally, I'd prefer the option to be --position-update-interval to make it really explicit, but it does become very long that way...

Done in 40ec0a3

wisp3rwind · 2025-10-01T07:08:48Z

src/main.rs


+        let position_update_interval = opt_str(POSITION_UPDATE).as_deref().map(|position_update| {
+            match position_update.parse::<u64>() {
+                Ok(value) => Duration::from_millis(value),


Maybe also add a lower bound here? Either by returning an error if lower, or maybe better by simply taking the value.min(MIN_INTERVAL)? (Not sure what value should be, a few ms at least?) Or at least require it to be nonzero?

Any idea, what sensible value should we use? 100ms seems quite sensible lower bound.

wisp3rwind · 2025-10-01T07:14:40Z

Cargo.toml

 edition = "2024"

 [features]
-default = ["native-tls", "rodio-backend", "with-libmdns"]
+default = ["native-tls", "rodio-backend", "with-libmdns", "with-mpris"]

 # TLS backends (mutually exclusive - compile-time checks in oauth/src/lib.rs)
 # Note: Feature validation is in oauth crate since it's compiled first in the dependency tree.
 # See COMPILING.md for more details on TLS backend selection.

 # native-tls: Uses the system's native TLS stack (OpenSSL on Linux, Secure Transport on macOS,
 # SChannel on Windows). This is the default as it's well-tested, widely compatible, and integrates
 # with system certificate stores. Choose this for maximum compatibility and when you want to use
 # system-managed certificates.
 native-tls = ["librespot-core/native-tls", "librespot-oauth/native-tls"]

 # rustls-tls: Uses the Rust-based rustls TLS implementation with certificate authority (CA)
 # verification. This provides a Rust TLS stack (with assembly optimizations). Choose this for
 # avoiding external  OpenSSL dependencies, reproducible builds, or when targeting platforms where
 # native TLS  dependencies are unavailable or problematic (musl, embedded, static linking).
 #
 # Two certificate store options are available:
 #
 # - rustls-tls-native-roots: Uses rustls with native system certificate stores (ca-certificates on
 # Linux, Security.framework on macOS, Windows certificate store on Windows). Best for most users as
 # it integrates with system-managed certificates and gets security updates through the OS.
 rustls-tls-native-roots = [
    "librespot-core/rustls-tls-native-roots",
    "librespot-oauth/rustls-tls-native-roots",
 ]
 # rustls-tls-webpki-roots: Uses rustls with Mozilla's compiled-in certificate store (webpki-roots).
 # Best for reproducible builds, containerized environments, or when you want certificate handling
 # to be independent of the host system.
 rustls-tls-webpki-roots = [
    "librespot-core/rustls-tls-webpki-roots",
    "librespot-oauth/rustls-tls-webpki-roots",
 ]

 # Audio backends - see README.md for audio backend selection guide
 # Cross-platform backends:

 # rodio-backend: Cross-platform audio backend using Rodio (default). Provides good cross-platform
 # compatibility with automatic backend selection. Uses ALSA on Linux, WASAPI on Windows, CoreAudio
 # on macOS.
 rodio-backend = ["librespot-playback/rodio-backend"]

 # rodiojack-backend: Rodio backend with JACK support for professional audio setups.
 rodiojack-backend = ["librespot-playback/rodiojack-backend"]

 # gstreamer-backend: Uses GStreamer multimedia framework for audio output.
 # Provides extensive audio processing capabilities.
 gstreamer-backend = ["librespot-playback/gstreamer-backend"]

 # portaudio-backend: Cross-platform audio I/O library backend.
 portaudio-backend = ["librespot-playback/portaudio-backend"]

 # sdl-backend: Simple DirectMedia Layer audio backend.
 sdl-backend = ["librespot-playback/sdl-backend"]

 # Platform-specific backends:

 # alsa-backend: Advanced Linux Sound Architecture backend (Linux only).
 # Provides low-latency audio output on Linux systems.
 alsa-backend = ["librespot-playback/alsa-backend"]

 # pulseaudio-backend: PulseAudio backend (Linux only).
 # Integrates with the PulseAudio sound server for advanced audio routing.
 pulseaudio-backend = ["librespot-playback/pulseaudio-backend"]

 # jackaudio-backend: JACK Audio Connection Kit backend.
 # Professional audio backend for low-latency, high-quality audio routing.
 jackaudio-backend = ["librespot-playback/jackaudio-backend"]

 # Network discovery backends - choose one for Spotify Connect device discovery
 # See COMPILING.md for dependencies and platform support.

 # with-libmdns: Pure-Rust mDNS implementation (default).
 # No external dependencies, works on all platforms. Choose this for simple deployments or when
 # avoiding system dependencies.
 with-libmdns = ["librespot-discovery/with-libmdns"]

 # with-avahi: Uses Avahi daemon for mDNS (Linux only).
 # Integrates with system's Avahi service for network discovery. Choose this when you want to
 # integrate with existing Avahi infrastructure or need advanced mDNS features. Requires
 # libavahi-client-dev.
 with-avahi = ["librespot-discovery/with-avahi"]

 # with-dns-sd: Uses DNS Service Discovery (cross-platform).
 # On macOS uses Bonjour, on Linux uses Avahi compatibility layer. Choose this for tight system
 # integration on macOS or when using Avahi's dns-sd compatibility mode on Linux.
 with-dns-sd = ["librespot-discovery/with-dns-sd"]

 # Audio processing features:

 # passthrough-decoder: Enables direct passthrough of Ogg Vorbis streams without decoding.
 # Useful for custom audio processing pipelines or when you want to handle audio decoding
 # externally. When enabled, audio is not decoded by librespot but passed through as raw Ogg Vorbis
 # data.
 passthrough-decoder = ["librespot-playback/passthrough-decoder"]

+# MPRIS: Allow external tool to have access to playback
+# status, metadata and to control the player.
+with-mpris = ["dep:zbus", "dep:zvariant"]
+
 [lib]
 name = "librespot"
 path = "src/lib.rs"

 [[bin]]
 name = "librespot"
 path = "src/main.rs"
 doc = false

 [workspace.dependencies]
 librespot-audio = { version = "0.7.1", path = "audio", default-features = false }
 librespot-connect = { version = "0.7.1", path = "connect", default-features = false }
 librespot-core = { version = "0.7.1", path = "core", default-features = false }
 librespot-discovery = { version = "0.7.1", path = "discovery", default-features = false }
 librespot-metadata = { version = "0.7.1", path = "metadata", default-features = false }
 librespot-oauth = { version = "0.7.1", path = "oauth", default-features = false }
 librespot-playback = { version = "0.7.1", path = "playback", default-features = false }
 librespot-protocol = { version = "0.7.1", path = "protocol", default-features = false }

 [dependencies]
 librespot-audio.workspace = true
 librespot-connect.workspace = true
 librespot-core.workspace = true
 librespot-discovery.workspace = true
 librespot-metadata.workspace = true
 librespot-oauth.workspace = true
 librespot-playback.workspace = true
 librespot-protocol.workspace = true

 data-encoding = "2.5"
 env_logger = { version = "0.11.2", default-features = false, features = [
    "color",
    "humantime",
    "auto-color",
 ] }
 futures-util = { version = "0.3", default-features = false }
 getopts = "0.2"
 log = "0.4"
 sha1 = "0.10"
 sysinfo = { version = "0.36", default-features = false, features = ["system"] }
 thiserror = "2"
 tokio = { version = "1", features = [
    "rt",
    "macros",
    "signal",
    "sync",
    "process",
 ] }
+time = { version = "0.3", features = ["formatting"] }
 url = "2.2"
+zbus = { version = "4", default-features = false, features = ["tokio"], optional = true }
+zvariant = { version = "4", default-features = false, optional = true }

 [package.metadata.deb]
 maintainer = "Librespot Organization <[email protected]>"


We should upgrade these to "5.x.y": That's also what discovery/Cargo.toml specifies for the with-avahi feature.

Maybe, that should be added to the global Cargo.toml as a workspace dependency which we reference here to be sure to unify versions? I'm don't really know how workspace deps work in the case of optional dependencies, so I'm not completely sure that this works out.

EDIT: Not sure what Github is doing here; this comment refers to zbus and zvariant.

Upgraded to 5 in 280cf1b

wisp3rwind · 2025-10-01T07:24:37Z

src/mpris_event_handler.rs

+                .pause()
+                .map_err(|err| zbus::fdo::Error::Failed(format!("{err}"))),
+            (Some(_), None) => {
+                zbus::fdo::Result::Err(zbus::fdo::Error::Failed(String::from("No track")))


Maybe import these globally as

use zbus::fdo::{Result as FdoResult, Error as FdoError};

to make this code a little more compact and readable?

Done in a7a65b0, aliasing to FdoResult seems to break zbus::interface macro.

paulfariello mentioned this pull request Sep 23, 2025

Draft: Add MPRIS support #1341

Closed

wisp3rwind reviewed Sep 23, 2025

View reviewed changes

src/mpris_event_handler.rs Outdated Show resolved Hide resolved

paulfariello force-pushed the mpris branch 4 times, most recently from 434aff3 to cae96c8 Compare September 23, 2025 10:34

paulfariello and others added 10 commits September 23, 2025 12:35

fix: fix clippy needless-borrow on discovery lib

3ec43ad

Allow cloning SPIRC

58e8a8e

- which is just a tokio::sync::mpsc sender, so this should be safe - prep for MPRIS support, which will use this to control playback

add release date to AudioItem

64995ab

- preparation for MPRIS support - now that the data is there, also yield from player_event_handler

add Spirc.seek_offset command

feb2dc6

- preparation for MPRIS support

add initial MPRIS support using zbus

01ac2e3

- following the spec at https://specifications.freedesktop.org/mpris-spec/latest/ - some properties/commands are not fully supported, yet

feat(mpris): serve identity based on configured name

15e2459

feat(mpris): Add set_volume handler

f1ee77f

feat(mpris): Retry with pid specific name on NameTaken error

2e55999

feat(player): Send current state of player for all new player listeners

59767ce

feat(mpris): Notify when volume changed

7710f6d

paulfariello force-pushed the mpris branch from cae96c8 to 7710f6d Compare September 23, 2025 10:35

paulfariello added 4 commits September 23, 2025 14:11

fix(mpris): Remove done todo

3fb0014

fix(mpris): Remove duplicated and commented function

51ec4c9

fix(mpris): Add comment concerning non-support of setting playback rate

a28e6b4

feat(mpris): Store metadata unserialized

f2985e0

paulfariello force-pushed the mpris branch from 7c931e3 to f2985e0 Compare September 25, 2025 11:41

paulfariello added 2 commits September 25, 2025 17:20

feat(mpris): Add debug logging

01f169e

feat(mpris): Send biggest art url

5e8fc7d

paulfariello force-pushed the mpris branch from f4a3b30 to 5e8fc7d Compare September 25, 2025 15:20

paulfariello added 5 commits September 25, 2025 17:22

feat(mpris): Update track id on EndOfTrack

97b88aa

feat(mpris): Return error when trying to play/pause in wrong context

f6481fd

feat(mpris): Signal when position changed

55c91bd

feat(player): Add position update option

2fff153

feat(mpris): Get position from player and provide it to MPRIS

b0e0393

feat(mpris): Check track_id when setting position

4c37f2b

paulfariello force-pushed the mpris branch from 7946bb8 to 4c37f2b Compare September 30, 2025 13:20

paulfariello added 2 commits September 30, 2025 15:24

chore(mpris): Remove useless comment

a368079

feat(mpris): Add support for desktop entry

274d001

paulfariello force-pushed the mpris branch from 7fc4159 to f6481fd Compare September 30, 2025 15:13

paulfariello changed the title ~~Draft: Add MPRIS support~~ Add MPRIS support Sep 30, 2025

paulfariello added 2 commits October 1, 2025 07:31

chore(mpris): alias zbus::fdo::{Error, Result} for readability

a7a65b0

feat(player): Allow for stopped event without track_id

4f55158

wisp3rwind reviewed Oct 1, 2025

View reviewed changes

feat(player): Rename position update interval option

40ec0a3

paulfariello force-pushed the mpris branch from 69d479d to 40ec0a3 Compare October 2, 2025 07:01

paulfariello added 2 commits October 2, 2025 09:33

feat(mpris): Upgrade to zbus 5

280cf1b

feat(player): Add position_ms in Loading event

f5cf187

Add MPRIS support #1596

Are you sure you want to change the base?

Add MPRIS support #1596

Uh oh!

Conversation

paulfariello commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

paulfariello commented Sep 30, 2025

Uh oh!

wisp3rwind left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Footnotes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

paulfariello Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wisp3rwind Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paulfariello commented Sep 23, 2025 •

edited

Loading

paulfariello Oct 2, 2025 •

edited

Loading

wisp3rwind Oct 1, 2025 •

edited

Loading