librespot icon indicating copy to clipboard operation
librespot copied to clipboard

Output Metadata

Open balbuze opened this issue 7 years ago • 23 comments

Hi! Not a bug ! Thank you for your great work ! I wrote a plugin for volumio2 using spotify-connect-web and an other new one using librespot. I managed multi users with 2 instances of librespot I added some script to check cache size and when limit is reached, purge oldest files in the cache. Now I would like to add metadata (track name and album art in volumio2. But I need some information on how to get this from librespot. my repo https://github.com/balbuze/volumio-plugins/tree/master/plugins/music_service/volspotconnect2

balbuze avatar Feb 19 '17 18:02 balbuze

From gitter :

@balbuze: when playing only track title is displayed in console. Is there a way to get other metadat such artist, album, album art ?

@plietar: Yes, that information is available. This has been requested many times but I'm not sure yet what is the best way to expose it [...] My thought was simply to write that information into a file on disk, and clients can just read it from there. inotify can be used by customers to detect changes Alternatively a named pipe could be used

@sashahilton00: +1 for named pipe. I actually wrote this feature a while back though I hhink I might have rebased will have a look for it and get back to you

@joerg-krause: Using a named pipe for the metadata sounds like a good idea. shairport-sync uses a pipe, too.

So my issue with named pipes is :

  • Updates only go to a single consumer, I'm not really sure what happens when multiple processes try to read it
  • You can only get updates, not read the current state
  • If there is no consumer then librespot might block when writing to it.

A simple file on the other hand wouldn't have these issues. Consumers can read it at any time, and use inotify to get updates it.

The downside is inotify is less portable (I believe macOS/BSDs have similar mechanisms), and more complicate to use. Clients which don't want that complexity can just read the file periodically.

plietar avatar Mar 06 '17 16:03 plietar

Hi, First of all, thank you to everyone who's put in so much work on this!

I've managed to get the metadata to display for a RPi system I'm working on with a VFD display(in a kludgy sort of way). I used @balbuze suggestion for logging the output of librespot and pulling the info out of that. In order to get the full metadata I modified the logging output of player.rs to output the track id in Hex which I could then convert to base62 with a php script which can then use it to look up the metadata from Spotify (my rust programming skills are virtually non-existent so this was the best way for me!).

I really like the idea to just use a file (perhaps called now_playing or something similar). It would only be necessary to put the Spotify trackid (preferably the base62 URI style version) and a timecode for when it started playing in the file, then any system could pick this up and use it to get the metadata from the API and to work out timings. It could also act as a flag to other systems that a Spotify track is currently playing. I think that if it was done as part of the player.rs then it should also be available in anything that uses librespot such as spotifyd.

I'm not really familiar with named pipes, would it be difficult to do both or have an option to choose either at startup?

postacey avatar Mar 06 '17 22:03 postacey

Any updates to metadata in a snippet out there?

tatoosh avatar Apr 16 '17 14:04 tatoosh

I switched console to file for my systemd service:

&>> sp.log or |& tee -a sp.log

and can now grab the player Track Title - anyone got a better solution?

INFO:librespot::player: Loading track "I'm the One" INFO:librespot::player: Track "I'm the One" loaded

tatoosh avatar May 02 '17 12:05 tatoosh

I made some test and use a bash script that contains

#!/bin/bash #here we send standard output to a file ./librespot -b 320 -c /tmp --name 'Volumio-pine64' --backend alsa --device plughw:0 >/tmp/infoli 2>&1 #we read the file and extract only track title cut -d: -f5 /tmp/infoli | cut -d" -f2 | tail -1

balbuze avatar May 02 '17 15:05 balbuze

Okay thanks for sharing snippet. Hope there will be more metadata in future.

tatoosh avatar May 02 '17 20:05 tatoosh

Just FYI, @balbuze & @tatoosh - as you seem to resort to parsing the log output for now. Here's a quick and dirty way of getting the (main) artist onto stderr.

diff --git a/src/player.rs b/src/player.rs
index 70f9779..43a19fd 100644
--- a/src/player.rs
+++ b/src/player.rs
@@ -11,7 +11,7 @@ use vorbis::{self, VorbisError};
 use audio_backend::Sink;
 use audio_decrypt::AudioDecrypt;
 use audio_file::AudioFile;
-use metadata::{FileFormat, Track};
+use metadata::{FileFormat, Track, Artist};
 use session::{Bitrate, Session};
 use mixer::AudioFilter;
 use util::{self, SpotifyId, Subfile};
@@ -341,8 +341,9 @@ impl PlayerInternal {
 
     fn load_track(&self, track_id: SpotifyId, position: i64) -> Option<Decoder> {
         let track = self.session.metadata().get::<Track>(track_id).wait().unwrap();
-
-        info!("Loading track \"{}\"", track.name);
+
+        let artist = self.session.metadata().get::<Artist>(track.artists[0]).wait().unwrap();
+        info!("Loading track \"{}\" by {}", track.name, artist.name);
 
         let track = match self.find_available_alternative(&track) {
             Some(track) => track,

seanrand avatar May 02 '17 23:05 seanrand

@seanrand thx

tatoosh avatar May 03 '17 06:05 tatoosh

I've looked into something like this as well and have found a different approach to provide more information in a similar manner. Instead of writing all the information to a log I'll only write the track id (base62 encoded track.id). This id can be used to call https://api.spotify.com/v1/tracks/ (eg https://api.spotify.com/v1/tracks/3n3Ppam7vgaVa1iaRUc9Lp) to get all the information as well as cover art.

If anybody is intrested in this change, take a look at https://github.com/ov3rk1ll/librespot/commit/eedaf1c17b8718eda2d8c7eef6f569dfa0e343e2.

ov3rk1ll avatar May 04 '17 12:05 ov3rk1ll

@ov3rk1ll Have you seen the news at https://developer.spotify.com/news-stories/2017/01/27/removing-unauthenticated-calls-to-the-web-api/ that Spotify will soon require most calls to their endpoints to be authenticated? This will include /tracks and will make stuff like this more painful.

kingosticks avatar May 04 '17 12:05 kingosticks

@kingosticks I've not seen that but it's good to know. Depending on where this ID will be used it might not be too hard to authenticate a user but it'll make using my approach harder.

I don't know enough about the architecture of librespot yet to tell it would be possible to somehow share the existing authentication to pull this information.

ov3rk1ll avatar May 04 '17 12:05 ov3rk1ll

If you are still thinking about this, then an option is to expose the metadata like Shairport does: https://github.com/mikebrady/shairport-sync#metadata

With the metadata exposed you could also let the listener take care of volume adjustments, which might reduce volume change lag and improve quality.

ejurgensen avatar Sep 07 '17 21:09 ejurgensen

Hi all,

Chiming in to add my support for metadata for use with forked-daapd, amongst other things.

chimpy avatar Sep 12 '17 23:09 chimpy

@ov3rk1ll I found your solution elegant. Reading the spotify doc https://developer.spotify.com/migration-guide-for-unauthenticated-web-api-calls/ it seems we are in this case : "If your app is hosted (i.e. the code is not exposed to the client) and doesn’t need to perform requests on behalf of a user, then client credentials is a good fit." or maybe I misunderstand. I'm compiling your a version of librespot including your code. I the author of the plugin for volumio and I really want to include metadata un the webUI... https://volumio.org/

balbuze avatar Sep 29 '17 19:09 balbuze

Oh I see Oauth is required to get this infos... more complicated...

balbuze avatar Sep 29 '17 20:09 balbuze

You can get the necessary token through librespot. No need to ask the user for credentials. Then use that token against the web API. Which now supports basic Connect features, too. E.g. It can tell you what track was currently playing on which device etc.

michaelherger avatar Sep 29 '17 20:09 michaelherger

Oh, I was wrong. It's not part of the librespot executable. But I implemented it in my Spotty helper for the Squeezebox (https://github.com/michaelherger/spotty/blob/master/src/main.rs)

michaelherger avatar Sep 29 '17 20:09 michaelherger

Thanks for the answers. But I tested several weeks ago and the token sent for librespot was not usable using spotify webapi. I need to retest U guess

balbuze avatar Sep 29 '17 20:09 balbuze

I see! I'll have a look tomorrow!

balbuze avatar Sep 29 '17 20:09 balbuze

For your information, I already provide artist and title to Kodi through a named pipe, like so: https://github.com/LibreELEC/LibreELEC.tv/blob/master/packages/addons/service/librespot/patches/librespot-02_kodi_hooks.patch https://github.com/LibreELEC/LibreELEC.tv/blob/master/packages/addons/service/librespot/source/default.py#L39..L73 https://github.com/LibreELEC/LibreELEC.tv/blob/master/packages/addons/service/librespot/source/bin/librespot.onstart The named pipe is created before librespot is started.

Of course, the named pipe could be handled in librespot, but my Rust is too poor.

awiouy avatar Sep 29 '17 20:09 awiouy

@michaelherger thanks for the link. Do you get album art with this ? @awiouy thanks. Same question about album picture ?

balbuze avatar Sep 30 '17 08:09 balbuze

You'd get a URL for the album art IIRC. Or all the information you need to get it. Check the web API.

michaelherger avatar Sep 30 '17 09:09 michaelherger

@plietar: maybe use gRPC for that? https://grpc.io/ https://github.com/stepancheg/grpc-rust/

selfisekai avatar Jul 01 '18 08:07 selfisekai