fix: rmpcd - correct song id in typedef, make all songs userdata (#994)

Author: mierak

rmpcd/src/lua/lualib/mpd/mod.rs

@@ -7,7 +7,10 @@ use rmpc_mpd::{
     mpd_client::MpdClient,
 };
 
-use crate::{async_client::AsyncClient, lua::lualib::mpd::types::Status};
+use crate::{
+    async_client::AsyncClient,
+    lua::lualib::mpd::types::{Song, Status},
+};
 
 mod c2c;
 mod playback;
@@ -68,7 +71,7 @@ pub fn create(lua: &Lua, client: &Arc<AsyncClient>) -> Result<Table> {
         let client = Arc::clone(&c);
         async move {
             match client.run(move |c| c.find_one(&[Filter::new(Tag::File, uri.as_str())])).await {
-                Ok(song) => lua.to_value(&song).into_lua_multi(&lua),
+                Ok(song) => song.map(Song::from).into_lua_multi(&lua),
                 Err(err) => {
                     tracing::error!(err = ?err, "Failed to get song by uri");
                     (Value::Nil, Some(err.to_string())).into_lua_multi(&lua)
@@ -82,7 +85,7 @@ pub fn create(lua: &Lua, client: &Arc<AsyncClient>) -> Result<Table> {
         let client = Arc::clone(&c);
         async move {
             match client.run(move |c| c.playlist_id(id)).await {
-                Ok(song) => lua.to_value(&song).into_lua_multi(&lua),
+                Ok(song) => song.map(Song::from).into_lua_multi(&lua),
                 Err(err) => {
                     tracing::error!(err = ?err, "Failed to get song by id");
                     (Value::Nil, Some(err.to_string())).into_lua_multi(&lua)
@@ -96,7 +99,7 @@ pub fn create(lua: &Lua, client: &Arc<AsyncClient>) -> Result<Table> {
         let client = Arc::clone(&c);
         async move {
             match client.run(move |c| c.get_current_song()).await {
-                Ok(song) => lua.to_value(&song).into_lua_multi(&lua),
+                Ok(song) => song.map(Song::from).into_lua_multi(&lua),
                 Err(err) => {
                     tracing::error!(err = ?err, "Failed to get current song");
                     (Value::Nil, Some(err.to_string())).into_lua_multi(&lua)

rmpcd/src/lua/lualib/mpd/types/song.rs

@@ -1,10 +1,11 @@
-use mlua::UserData;
+use mlua::{MetaMethod, UserData};
 use rmpc_mpd::commands::Song as MpdSong;
 
 use crate::lua::lualib::mpd::types::{MetadataTag, MetadataTagExt};
 
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct Song {
+    pub id: u32,
     pub file: String,
     pub duration: u128,
     pub artist: Option<MetadataTag>,
@@ -44,9 +45,67 @@ pub struct Song {
     pub musicbrainz_workid: Option<MetadataTag>,
 }
 
+impl From<MpdSong> for Song {
+    fn from(mut value: MpdSong) -> Self {
+        Self {
+            id: value.id,
+            file: value.file,
+            duration: value.duration.map(|d| d.as_millis()).unwrap_or_default(),
+            artist: value.metadata.remove("artist").to_metadata_tag(),
+            artistsort: value.metadata.remove("artistsort").to_metadata_tag(),
+            album: value.metadata.remove("album").to_metadata_tag(),
+            albumsort: value.metadata.remove("albumsort").to_metadata_tag(),
+            albumartist: value.metadata.remove("albumartist").to_metadata_tag(),
+            albumartistsort: value.metadata.remove("albumartistsort").to_metadata_tag(),
+            title: value.metadata.remove("title").to_metadata_tag(),
+            titlesort: value.metadata.remove("titlesort").to_metadata_tag(),
+            track: value.metadata.remove("track").to_metadata_tag(),
+            name: value.metadata.remove("name").to_metadata_tag(),
+            genre: value.metadata.remove("genre").to_metadata_tag(),
+            mood: value.metadata.remove("mood").to_metadata_tag(),
+            date: value.metadata.remove("date").to_metadata_tag(),
+            originaldate: value.metadata.remove("originaldate").to_metadata_tag(),
+            composer: value.metadata.remove("composer").to_metadata_tag(),
+            composersort: value.metadata.remove("composersort").to_metadata_tag(),
+            performer: value.metadata.remove("performer").to_metadata_tag(),
+            conductor: value.metadata.remove("conductor").to_metadata_tag(),
+            work: value.metadata.remove("work").to_metadata_tag(),
+            ensemble: value.metadata.remove("ensemble").to_metadata_tag(),
+            movement: value.metadata.remove("movement").to_metadata_tag(),
+            movementnumber: value.metadata.remove("movementnumber").to_metadata_tag(),
+            showmovement: value
+                .metadata
+                .remove("showmovement")
+                .and_then(|v| v.first().parse::<bool>().ok()),
+            location: value.metadata.remove("location").to_metadata_tag(),
+            grouping: value.metadata.remove("grouping").to_metadata_tag(),
+            comment: value.metadata.remove("comment").to_metadata_tag(),
+            disc: value.metadata.remove("disc").to_metadata_tag(),
+            label: value.metadata.remove("label").to_metadata_tag(),
+            musicbrainz_artistid: value.metadata.remove("musicbrainz_artistid").to_metadata_tag(),
+            musicbrainz_albumid: value.metadata.remove("musicbrainz_albumid").to_metadata_tag(),
+            musicbrainz_albumartistid: value
+                .metadata
+                .remove("musicbrainz_albumartistid")
+                .to_metadata_tag(),
+            musicbrainz_trackid: value.metadata.remove("musicbrainz_trackid").to_metadata_tag(),
+            musicbrainz_releasegroupid: value
+                .metadata
+                .remove("musicbrainz_releasegroupid")
+                .to_metadata_tag(),
+            musicbrainz_releasetrackid: value
+                .metadata
+                .remove("musicbrainz_releasetrackid")
+                .to_metadata_tag(),
+            musicbrainz_workid: value.metadata.remove("musicbrainz_workid").to_metadata_tag(),
+        }
+    }
+}
+
 impl From<&MpdSong> for Song {
     fn from(value: &MpdSong) -> Self {
         Self {
+            id: value.id,
             file: value.file.clone(),
             duration: value.duration.map(|d| d.as_millis()).unwrap_or_default(),
             artist: value.metadata.get("artist").to_metadata_tag(),
@@ -101,7 +160,12 @@ impl From<&MpdSong> for Song {
 }
 
 impl UserData for Song {
+    fn add_methods<M: mlua::UserDataMethods<Self>>(methods: &mut M) {
+        methods.add_meta_method(MetaMethod::ToString, |_, this, ()| Ok(format!("{this:?}")));
+    }
+
     fn add_fields<F: mlua::UserDataFields<Self>>(fields: &mut F) {
+        fields.add_field_method_get("id", |_, this| Ok(this.id));
         fields.add_field_method_get("file", |_, this| Ok(this.file.clone()));
         fields.add_field_method_get("duration", |_, this| Ok(this.duration));
         fields.add_field_method_get("artist", |_, this| Ok(this.artist.clone()));

rmpcd/src/lua/lualib/util.rs

@@ -6,9 +6,9 @@ use tracing::info;
 pub fn create(lua: &Lua) -> mlua::Result<Table> {
     let tbl = lua.create_table()?;
 
-    let dump_table = lua.create_function(|_, tbl: Table| {
+    let dump_table = lua.create_function(|_, val: Value| {
         let mut seen = HashSet::new();
-        info!("{}", dump(&mlua::Value::Table(tbl), 0, &mut seen));
+        info!("{}", dump(&val, 0, &mut seen));
         Ok(())
     })?;
 

rmpcd/src/lua/plugin/lua_plugin.rs

@@ -215,8 +215,8 @@ impl LuaPlugin {
             }
             PluginEvent::SongChange { old, new } => {
                 trace!(name, ON_SONG_CHANGE, "Running plugin callback");
-                let old = old.clone().into_lua(lua)?;
-                let new = new.clone().into_lua(lua)?;
+                let old = old.into_lua(lua)?;
+                let new = new.into_lua(lua)?;
 
                 let func: mlua::Function = state.get(ON_SONG_CHANGE)?;
 

rmpcd/src/lua/types/rmpcd.lua

@@ -11,7 +11,7 @@
 ---@class RmpcdPlugin<Args>
 ---@field subscribed_channels string[]|nil
 ---@field setup fun(self, args: Args)|nil
----@field song_change fun(self, old_song: Song|nil, new_song: Song|nil)|nil
+---@field song_change fun(self, old_song: QueuedSong|nil, new_song: QueuedSong|nil)|nil
 ---@field state_change fun(self, old_state: PlaybackState, new_state: PlaybackState)|nil
 ---@field message fun(self, channel: string, message: string)|nil
 ---@field idle_event fun(self, event: IdleEvent)|nil

rmpcd/src/lua/types/rmpcd/mpd/init.lua

@@ -28,8 +28,8 @@
 ---@field send_message fun(channel: string, message: string): (boolean, string|nil)
 ---@field read_messages fun(): (table<string, string[]>|nil, string|nil)
 ---@field get_song fun(uri: string): (Song|nil, nil|string)
----@field get_song_by_id fun(id: number): (Song|nil, nil|string)
----@field get_current_song fun(): (Song|nil, nil|string)
+---@field get_song_by_id fun(id: number): (QueuedSong|nil, nil|string)
+---@field get_current_song fun(): (QueuedSong|nil, nil|string)
 
 ---@alias ValueChange string e.g. "+5", "-10", "50"
 

rmpcd/src/lua/types/rmpcd/mpd/song.lua

@@ -37,6 +37,9 @@
 ---@field musicbrainz_release_track_id? MetadataValue
 ---@field musicbrainz_work_id? MetadataValue
 
+---@class QueuedSong: Song
+---@field id number
+
 ---@class MetadataValue
 ---Represents a tag that may contain one or many values.
 ---@field first fun(self: MetadataValue): string