Add MPRIS support

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - [core] Add `SpotifyUri` type to represent more types of URI than `SpotifyId` can
+- [dbus/mpris] Add dbus/mpris support to allow controlling player
 
 ### Changed
 

Cargo.toml

@@ -37,7 +37,7 @@ repository = "https://github.com/librespot-org/librespot"
 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.
@@ -133,6 +133,10 @@ with-dns-sd = ["librespot-discovery/with-dns-sd"]
 # 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"
@@ -181,7 +185,10 @@ tokio = { version = "1", features = [
     "sync",
     "process",
 ] }
+time = { version = "0.3", features = ["formatting"] }
 url = "2.2"
+zbus = { version = "5", default-features = false, features = ["tokio"], optional = true }
+zvariant = { version = "5", default-features = false, optional = true }
 
 [package.metadata.deb]
 maintainer = "Librespot Organization <[email protected]>"

connect/src/spirc.rs

@@ -126,6 +126,7 @@ enum SpircCommand {
     RepeatTrack(bool),
     Disconnect { pause: bool },
     SetPosition(u32),
+    SeekOffset(i32),
     SetVolume(u16),
     Activate,
     Load(LoadRequest),
@@ -139,6 +140,7 @@ const VOLUME_UPDATE_DELAY: Duration = Duration::from_millis(500);
 const UPDATE_STATE_DELAY: Duration = Duration::from_millis(200);
 
 /// The spotify connect handle
+#[derive(Clone)]
 pub struct Spirc {
     commands: mpsc::UnboundedSender<SpircCommand>,
 }
@@ -384,6 +386,13 @@ impl Spirc {
         Ok(self.commands.send(SpircCommand::Load(command))?)
     }
 
+    /// Seek to given offset.
+    ///
+    /// Does nothing if we are not the active device.
+    pub fn seek_offset(&self, offset_ms: i32) -> Result<(), Error> {
+        Ok(self.commands.send(SpircCommand::SeekOffset(offset_ms))?)
+    }
+
     /// Disconnects the current device and pauses the playback according the value.
     ///
     /// Does nothing if we are not the active device.
@@ -650,6 +659,7 @@ impl SpircTask {
             SpircCommand::Repeat(repeat) => self.handle_repeat_context(repeat)?,
             SpircCommand::RepeatTrack(repeat) => self.handle_repeat_track(repeat),
             SpircCommand::SetPosition(position) => self.handle_seek(position),
+            SpircCommand::SeekOffset(offset) => self.handle_seek_offset(offset),
             SpircCommand::SetVolume(volume) => self.set_volume(volume),
             SpircCommand::Load(command) => self.handle_load(command, None).await?,
         };
@@ -1460,6 +1470,25 @@ impl SpircTask {
         };
     }
 
+    fn handle_seek_offset(&mut self, offset_ms: i32) {
+        let position_ms = match self.play_status {
+            SpircPlayStatus::Stopped => return,
+            SpircPlayStatus::LoadingPause { position_ms }
+            | SpircPlayStatus::LoadingPlay { position_ms }
+            | SpircPlayStatus::Paused { position_ms, .. } => position_ms,
+            SpircPlayStatus::Playing {
+                nominal_start_time, ..
+            } => {
+                let now = self.now_ms();
+                (now - nominal_start_time) as u32
+            }
+        };
+
+        let position_ms = ((position_ms as i32) + offset_ms).max(0) as u32;
+
+        self.handle_seek(position_ms);
+    }
+
     fn handle_shuffle(&mut self, shuffle: bool) -> Result<(), Error> {
         self.player.emit_shuffle_changed_event(shuffle);
         self.connect_state.handle_shuffle(shuffle)

discovery/src/lib.rs

@@ -406,7 +406,7 @@ fn launch_libmdns(
             }
             .map_err(|e| DiscoveryError::DnsSdError(Box::new(e)))?;
 
-            let svc = responder.register(&DNS_SD_SERVICE_NAME, &name, port, &TXT_RECORD);
+            let svc = responder.register(DNS_SD_SERVICE_NAME, &name, port, &TXT_RECORD);
 
             let _ = shutdown_rx.blocking_recv();
 

metadata/src/audio/item.rs

@@ -45,6 +45,7 @@ pub enum UniqueFields {
     Track {
         artists: ArtistsWithRole,
         album: String,
+        album_date: Date,
         album_artists: Vec<String>,
         popularity: u8,
         number: u32,
@@ -80,6 +81,8 @@ impl AudioItem {
                 let uri_string = uri.to_uri()?;
                 let album = track.album.name;
 
+                let album_date = track.album.date;
+
                 let album_artists = track
                     .album
                     .artists
@@ -113,6 +116,7 @@ impl AudioItem {
                 let unique_fields = UniqueFields::Track {
                     artists: track.artists_with_role,
                     album,
+                    album_date,
                     album_artists,
                     popularity,
                     number,

playback/src/player.rs

@@ -142,8 +142,8 @@ pub enum PlayerEvent {
     },
     // Fired when the player is stopped (e.g. by issuing a "stop" command to the player).
     Stopped {
-        play_request_id: u64,
-        track_id: SpotifyUri,
+        play_request_id: Option<u64>,
+        track_id: Option<SpotifyUri>,
     },
     // The player is delayed by loading a track.
     Loading {
@@ -267,7 +267,8 @@ impl PlayerEvent {
                 play_request_id, ..
             }
             | Stopped {
-                play_request_id, ..
+                play_request_id: Some(play_request_id),
+                ..
             }
             | PositionCorrection {
                 play_request_id, ..
@@ -679,6 +680,7 @@ enum PlayerState {
         play_request_id: u64,
         start_playback: bool,
         loader: Pin<Box<dyn FusedFuture<Output = Result<PlayerLoadedTrackData, ()>> + Send>>,
+        position_ms: u32,
     },
     Paused {
         track_id: SpotifyUri,
@@ -1226,6 +1228,7 @@ impl Future for PlayerInternal {
                 ref track_id,
                 start_playback,
                 play_request_id,
+                ..
             } = self.state
             {
                 // The loader may be terminated if we are trying to load the same track
@@ -1541,8 +1544,8 @@ impl PlayerInternal {
 
                 self.ensure_sink_stopped(false);
                 self.send_event(PlayerEvent::Stopped {
-                    track_id,
-                    play_request_id,
+                    track_id: Some(track_id),
+                    play_request_id: Some(play_request_id),
                 });
                 self.state = PlayerState::Stopped;
             }
@@ -2020,6 +2023,7 @@ impl PlayerInternal {
             play_request_id,
             start_playback: play,
             loader,
+            position_ms,
         };
 
         Ok(())
@@ -2163,7 +2167,57 @@ impl PlayerInternal {
 
             PlayerCommand::SetSession(session) => self.session = session,
 
-            PlayerCommand::AddEventSender(sender) => self.event_senders.push(sender),
+            PlayerCommand::AddEventSender(sender) => {
+                // Send current player state to new event listener
+                match self.state {
+                    PlayerState::Loading {
+                        ref track_id,
+                        play_request_id,
+                        position_ms,
+                        ..
+                    } => {
+                        let _ = sender.send(PlayerEvent::Loading {
+                            play_request_id,
+                            track_id: track_id.clone(),
+                            position_ms,
+                        });
+                    }
+                    PlayerState::Paused {
+                        ref track_id,
+                        play_request_id,
+                        stream_position_ms,
+                        ..
+                    } => {
+                        let _ = sender.send(PlayerEvent::Paused {
+                            play_request_id,
+                            track_id: track_id.clone(),
+                            position_ms: stream_position_ms,
+                        });
+                    }
+                    PlayerState::Playing { ref audio_item, .. } => {
+                        let audio_item = Box::new(audio_item.clone());
+                        let _ = sender.send(PlayerEvent::TrackChanged { audio_item });
+                    }
+                    PlayerState::EndOfTrack {
+                        play_request_id,
+                        ref track_id,
+                        ..
+                    } => {
+                        let _ = sender.send(PlayerEvent::EndOfTrack {
+                            play_request_id,
+                            track_id: track_id.clone(),
+                        });
+                    }
+                    PlayerState::Invalid | PlayerState::Stopped => {
+                        let _ = sender.send(PlayerEvent::Stopped {
+                            play_request_id: None,
+                            track_id: None,
+                        });
+                    }
+                }
+
+                self.event_senders.push(sender);
+            }
 
             PlayerCommand::SetSinkEventCallback(callback) => self.sink_event_callback = callback,
 

src/main.rs

@@ -41,6 +41,11 @@ use url::Url;
 mod player_event_handler;
 use player_event_handler::{EventHandler, run_program_on_sink_events};
 
+#[cfg(feature = "with-mpris")]
+mod mpris_event_handler;
+#[cfg(feature = "with-mpris")]
+use mpris_event_handler::MprisEventHandler;
+
 fn device_id(name: &str) -> String {
     HEXLOWER.encode(&Sha1::digest(name.as_bytes()))
 }
@@ -270,6 +275,7 @@ async fn get_setup() -> Setup {
     #[cfg(feature = "passthrough-decoder")]
     const PASSTHROUGH: &str = "passthrough";
     const PASSWORD: &str = "password";
+    const POSITION_UPDATE_INTERVAL: &str = "position-update-interval";
     const PROXY: &str = "proxy";
     const QUIET: &str = "quiet";
     const SYSTEM_CACHE: &str = "system-cache";
@@ -315,6 +321,7 @@ async fn get_setup() -> Setup {
     #[cfg(feature = "passthrough-decoder")]
     const PASSTHROUGH_SHORT: &str = "P";
     const PASSWORD_SHORT: &str = "p";
+    const POSITION_UPDATE_INTERVAL_SHORT: &str = ""; // no short flag
     const EMIT_SINK_EVENTS_SHORT: &str = "Q";
     const QUIET_SHORT: &str = "q";
     const INITIAL_VOLUME_SHORT: &str = "R";
@@ -625,6 +632,12 @@ async fn get_setup() -> Setup {
         "Knee width (dB) of the dynamic limiter from 0.0 to 10.0. Defaults to 5.0.",
         "KNEE",
     )
+    .optopt(
+        POSITION_UPDATE_INTERVAL_SHORT,
+        POSITION_UPDATE_INTERVAL,
+        "Maximum interval in ms for player to send a position event. Defaults to no forced position update.",
+        "POSITION_UPDATE",
+    )
     .optopt(
         ZEROCONF_PORT_SHORT,
         ZEROCONF_PORT,
@@ -1800,6 +1813,22 @@ async fn get_setup() -> Setup {
             },
         };
 
+        let position_update_interval = opt_str(POSITION_UPDATE_INTERVAL).as_deref().map(
+            |position_update| match position_update.parse::<u64>() {
+                Ok(value) => Duration::from_millis(value),
+                _ => {
+                    invalid_error_msg(
+                        POSITION_UPDATE_INTERVAL,
+                        POSITION_UPDATE_INTERVAL_SHORT,
+                        position_update,
+                        "Integer value in ms",
+                        "None",
+                    );
+                    exit(1);
+                }
+            },
+        );
+
         #[cfg(feature = "passthrough-decoder")]
         let passthrough = opt_present(PASSTHROUGH);
         #[cfg(not(feature = "passthrough-decoder"))]
@@ -1818,7 +1847,7 @@ async fn get_setup() -> Setup {
             normalisation_release_cf,
             normalisation_knee_db,
             ditherer,
-            position_update_interval: None,
+            position_update_interval,
         }
     };
 
@@ -1991,6 +2020,14 @@ async fn main() {
         }
     }
 
+    #[cfg(feature = "with-mpris")]
+    let mpris = MprisEventHandler::spawn(player.clone(), &setup.connect_config.name, None)
+        .await
+        .unwrap_or_else(|e| {
+            error!("could not initialize MPRIS: {e}");
+            exit(1);
+        });
+
     loop {
         tokio::select! {
             credentials = async {
@@ -2044,6 +2081,10 @@ async fn main() {
                         exit(1);
                     }
                 };
+
+                #[cfg(feature = "with-mpris")]
+                mpris.set_spirc(spirc_.clone());
+
                 spirc = Some(spirc_);
                 spirc_task = Some(Box::pin(spirc_task_));
 
@@ -2089,6 +2130,9 @@ async fn main() {
 
     let mut shutdown_tasks = tokio::task::JoinSet::new();
 
+    #[cfg(feature = "with-mpris")]
+    shutdown_tasks.spawn(mpris.quit_and_join());
+
     // Shutdown spirc if necessary
     if let Some(spirc) = spirc {
         if let Err(e) = spirc.shutdown() {