Add MPRIS support by paulfariello · Pull Request #1596 · librespot-org/librespot

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)

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-01T07:04:24Z

+    .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

Do we need it configurable? I'm not so sure if we want that...

Either we want it configurable or we should choose a sensible default value other than 0 (which prevent position to be updated).

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


+        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.

roderickvd · 2025-10-06T19:06:25Z

@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.

Thanks! I saw you processed quite a bit of comments after, so ping me when you feel you're ready for another round of review.

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

What'd be the negatives? 😄 No honestly. It seems like an improvement to me, but let me know if I should be aware of any downsides.

roderickvd · 2025-10-06T19:06:48Z

Don't forget to add a changelog entry.

paulfariello · 2025-10-08T08:10:31Z

Don't forget to add a changelog entry.

Done in 0a5c3aa

paulfariello · 2025-10-08T08:11:40Z

@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.

Thanks! I saw you processed quite a bit of comments after, so ping me when you feel you're ready for another round of review.

AFAICT I've rework everything raised by comment. Should be ok for a last review.

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

What'd be the negatives? 😄 No honestly. It seems like an improvement to me, but let me know if I should be aware of any downsides.

If you don't see any negatives then let's go with that :)

paulfariello · 2025-10-18T11:52:43Z

Small reminder that everything seems ready for last review here

roderickvd · 2025-10-18T17:15:47Z

👍 I’m away for a few days before I can review, but if anyone wants to beat me to it…

roderickvd

Almost there I think!
Sorry for the late response.

roderickvd · 2025-11-07T17:59:04Z

It's getting pretty large. I know it's tedious but if you'd have time to split it up into sub-modules then that'd be great.

roderickvd · 2025-11-07T17:59:46Z

    Stopped {
-        play_request_id: u64,
-        track_id: SpotifyUri,
+        play_request_id: Option<u64>,


Please tag in the changelog that this is a breaking change.

roderickvd · 2025-11-07T18:02:21Z

    "sync",
    "process",
 ] }
+time = { version = "0.3", features = ["formatting"] }


Only used for MPRIS, so to be made optional.

roderickvd · 2025-11-07T18:10:42Z

        "Knee width (dB) of the dynamic limiter from 0.0 to 10.0. Defaults to 5.0.",
        "KNEE",
    )
+    .optopt(


Could we do without this feature flag? Because it seems pretty advanced. What would it matter to users of we did or did not drop it?

Removed option in favor of a 400ms default

- 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

…efault

andriyor · 2025-11-16T21:49:23Z

Just tested it on KDE
Medial player doesn't show title and control's

Official spotify client:

If it’s possible, I’d love to sponsor this work a bit

paulfariello · 2025-11-18T15:56:08Z

@andriyor could you check the following command on both dbus services (org.mpris.MediaPlayer2.librespot and the one used by official client).

dbus-send --print-reply --dest=REPLACE_WITH_DBUS_SERVICE --type=method_call --print-reply /org/mpris/MediaPlayer2 org.freedesktop.DBus.Properties.GetAll "string:REPLACE_WITH_DBUS_SERVICE"

If you don't know the official spotify client service name use the following command:

dbus-send --print-reply --dest=org.freedesktop.DBus /org/freedesktop/DBus org.freedesktop.DBus.ListNames

andriyor · 2025-11-18T19:40:42Z

spotify:

❯ dbus-send --print-reply \
  --dest=org.mpris.MediaPlayer2.spotify \  
  --type=method_call \
  /org/mpris/MediaPlayer2 \
  org.freedesktop.DBus.Properties.GetAll \
  string:"org.mpris.MediaPlayer2.Player"

method return time=1763494565.329229 sender=:1.305 -> destination=:1.308 serial=213 reply_serial=2
   array [
      dict entry(
         string "PlaybackStatus"
         variant             string "Playing"
      )
      dict entry(
         string "LoopStatus"
         variant             string "None"
      )
      dict entry(
         string "Rate"
         variant             double 1
      )
      dict entry(
         string "Shuffle"
         variant             boolean false
      )
      dict entry(
         string "Metadata"
         variant             array [
               dict entry(
                  string "mpris:trackid"
                  variant                      string "/com/spotify/track/4GKJALTXTwhZgLPp0usd5C"
               )
               dict entry(
                  string "mpris:length"
                  variant                      uint64 268906000
               )
               dict entry(
                  string "mpris:artUrl"
                  variant                      string "https://i.scdn.co/image/ab67616d0000b273b23737878e75582c2e255029"
               )
               dict entry(
                  string "xesam:album"
                  variant                      string "Skinty Fia"
               )
               dict entry(
                  string "xesam:albumArtist"
                  variant                      array [
                        string "Fontaines D.C."
                     ]
               )
               dict entry(
                  string "xesam:artist"
                  variant                      array [
                        string "Fontaines D.C."
                     ]
               )
               dict entry(
                  string "xesam:autoRating"
                  variant                      double 0.7
               )
               dict entry(
                  string "xesam:discNumber"
                  variant                      int32 1
               )
               dict entry(
                  string "xesam:title"
                  variant                      string "Roman Holiday"
               )
               dict entry(
                  string "xesam:trackNumber"
                  variant                      int32 6
               )
               dict entry(
                  string "xesam:url"
                  variant                      string "https://open.spotify.com/track/4GKJALTXTwhZgLPp0usd5C"
               )
            ]
      )
      dict entry(
         string "Volume"
         variant             double 0.53109
      )
      dict entry(
         string "Position"
         variant             int64 16842000
      )
      dict entry(
         string "MinimumRate"
         variant             double 1
      )
      dict entry(
         string "MaximumRate"
         variant             double 1
      )
      dict entry(
         string "CanGoNext"
         variant             boolean true
      )
      dict entry(
         string "CanGoPrevious"
         variant             boolean true
      )
      dict entry(
         string "CanPlay"
         variant             boolean true
      )
      dict entry(
         string "CanPause"
         variant             boolean true
      )
      dict entry(
         string "CanSeek"
         variant             boolean true
      )
      dict entry(
         string "CanControl"
         variant             boolean true
      )
   ]

~

librespot:

❯ dbus-send --print-reply \
  --dest=org.mpris.MediaPlayer2.librespot \
  --type=method_call \
  /org/mpris/MediaPlayer2 \
  org.freedesktop.DBus.Properties.GetAll \
  string:"org.mpris.MediaPlayer2.Player"

method return time=1763494469.425111 sender=:1.288 -> destination=:1.291 serial=58 reply_serial=2
   array [
      dict entry(
         string "MinimumRate"
         variant             double 1
      )
      dict entry(
         string "PlaybackStatus"
         variant             string "Playing"
      )
      dict entry(
         string "Position"
         variant             int64 76107000
      )
      dict entry(
         string "CanControl"
         variant             boolean true
      )
      dict entry(
         string "MaximumRate"
         variant             double 1
      )
      dict entry(
         string "Shuffle"
         variant             boolean false
      )
      dict entry(
         string "CanGoPrevious"
         variant             boolean true
      )
      dict entry(
         string "CanPause"
         variant             boolean true
      )
      dict entry(
         string "CanPlay"
         variant             boolean true
      )
      dict entry(
         string "Rate"
         variant             double 1
      )
      dict entry(
         string "LoopStatus"
         variant             string "None"
      )
      dict entry(
         string "CanGoNext"
         variant             boolean true
      )
      dict entry(
         string "CanSeek"
         variant             boolean true
      )
      dict entry(
         string "Metadata"
         variant             array [
               dict entry(
                  string "mpris:artUrl"
                  variant                      string "https://i.scdn.co/image/ab67616d0000b273b23737878e75582c2e255029"
               )
               dict entry(
                  string "mpris:length"
                  variant                      int64 268906000
               )
               dict entry(
                  string "mpris:trackId"
                  variant                      object path "/org/librespot/track/4GKJALTXTwhZgLPp0usd5C"
               )
               dict entry(
                  string "xesam:album"
                  variant                      string "Skinty Fia"
               )
               dict entry(
                  string "xesam:albumArtist"
                  variant                      array [
                        string "Fontaines D.C."
                     ]
               )
               dict entry(
                  string "xesam:artist"
                  variant                      array [
                        string "Fontaines D.C."
                     ]
               )
               dict entry(
                  string "xesam:contentCreated"
                  variant                      string "2022-04-22T00:00:00.000000000Z"
               )
               dict entry(
                  string "xesam:discNumber"
                  variant                      int32 1
               )
               dict entry(
                  string "xesam:trackNumber"
                  variant                      int32 6
               )
            ]
      )
      dict entry(
         string "Volume"
         variant             double 0.499992
      )
   ]

~ 
❯

I found that unofficial widget supports it:
https://github.com/ccatterina/plasmusic-toolbar

Jacob-Bishop · 2026-01-17T19:28:32Z

@paulfariello Thanks so much for your work on this. Do you have a sense of what it would take for someone to get this across the finish line?

paulfariello mentioned this pull request Sep 23, 2025

Draft: Add MPRIS support #1341

Closed

wisp3rwind reviewed Sep 23, 2025

View reviewed changes

Comment thread src/mpris_event_handler.rs Outdated

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

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

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

wisp3rwind reviewed Oct 1, 2025

View reviewed changes

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

paulfariello force-pushed the mpris branch from 0a5c3aa to 32ffb1a Compare October 8, 2025 09:18

roderickvd requested changes Nov 7, 2025

View reviewed changes

wisp3rwind and others added 7 commits November 13, 2025 16:25

Allow cloning SPIRC

8fe221e

- 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

d7951f1

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

add Spirc.seek_offset command

ae47002

- preparation for MPRIS support

add initial MPRIS support using zbus

8b78253

- 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

89f26cd

feat(mpris): Add set_volume handler

e49c287

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

c54b260

paulfariello added 24 commits November 13, 2025 16:32

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

019fa4c

feat(mpris): Notify when volume changed

4a26063

fix(mpris): Remove done todo

fc17df4

fix(mpris): Remove duplicated and commented function

930e611

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

a7d90e9

feat(mpris): Store metadata unserialized

05085b9

feat(mpris): Add debug logging

6b2d3c8

feat(mpris): Send biggest art url

48224fa

feat(mpris): Update track id on EndOfTrack

077f9ef

feat(player): Add position update option

18339b2

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

9d0b399

feat(mpris): Check track_id when setting position

82f4a5e

chore(mpris): Remove useless comment

2d199a3

feat(mpris): Add support for desktop entry

23659f9

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

f4f330f

feat(mpris): Signal when position changed

90e64b2

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

867f537

feat(player): Allow for stopped event without track_id

16d1c0f

feat(player): Rename position update interval option

f8d6c42

feat(mpris): Upgrade to zbus 5

721375d

feat(player): Add position_ms in Loading event

829ce15

feat(changelog): Add mpris changelog

3aaa31c

fixup! add initial MPRIS support using zbus

6ca0583

feat(player): Replace position update interval option with sensible d…

70c68f7

…efault

paulfariello force-pushed the mpris branch from 32ffb1a to 70c68f7 Compare November 13, 2025 16:24

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!

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

roderickvd commented Oct 6, 2025

Uh oh!

roderickvd commented Oct 6, 2025

Uh oh!

paulfariello commented Oct 8, 2025

Uh oh!

paulfariello commented Oct 8, 2025

Uh oh!

paulfariello commented Oct 18, 2025

Uh oh!

roderickvd commented Oct 18, 2025

Uh oh!

roderickvd 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

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!

andriyor commented Nov 16, 2025

Uh oh!

paulfariello commented Nov 18, 2025

Uh oh!

andriyor commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Jacob-Bishop commented Jan 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

paulfariello commented Sep 23, 2025 •

edited

Loading

paulfariello Oct 2, 2025 •

edited

Loading

andriyor commented Nov 18, 2025 •

edited

Loading