add support for synced lyrics (#635)

Author: aome510

.dir-locals.el

@@ -2,5 +2,5 @@
 ;;; For more information see (info "(emacs) Directory Variables")
 
 ((rustic-mode . ((eglot-workspace-configuration
-                  . (:rust-analyzer (:cargo (:features ["lyric-finder" "image" "notify"])
+                  . (:rust-analyzer (:cargo (:features ["image" "notify"])
                                      :check (:command "clippy")))))))

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   RUST_BACKTRACE: 1
-  RUST_FEATURES: "rodio-backend,lyric-finder,media-control,image,notify"
+  RUST_FEATURES: "rodio-backend,media-control,image,notify"
 
 jobs:
   rust-ci:

Cargo.lock

@@ -1,7 +1,7 @@
 FROM rust as builder
 WORKDIR app
 COPY . .
-RUN cargo build --release --bin spotify_player --no-default-features --features lyric-finder
+RUN cargo build --release --bin spotify_player --no-default-features
 
 FROM gcr.io/distroless/cc
 # Create `./config` and `./cache` folders using WORKDIR commands.

Dockerfile

@@ -231,6 +231,7 @@ To define application's component styles, the user can specify any of the below
 - `selection`
 - `secondary_row`
 - `like`
+- `lyrics_played`
 
 A field in `component_style` is a struct with three **optional** fields: `fg` (foreground), `bg` (background) and `modifiers` (terminal effects):
 
@@ -261,7 +262,9 @@ current_playing = { fg = "Green", modifiers = ["Bold"] }
 page_desc = { fg = "Cyan", modifiers = ["Bold"] }
 playlist_desc = { fg = "BrightBlack", modifiers = ["Dim"] }
 table_header = { fg = "Blue" }
-selection = { modifiers = ["Bold", "Reversed"] }
+secondary_row = {}
+like = {]
+lyrics_played = { modifiers = ["Dim"] }
 ```
 
 ## Keymaps

README.md

@@ -20,9 +20,9 @@
 
 ![Search page example](https://user-images.githubusercontent.com/40011582/140253653-5b156a8f-538b-4e68-9d52-0a379477574f.png)
 
-## Lyric page
+## Lyrics page
 
-![Lyric page example](https://user-images.githubusercontent.com/40011582/169437044-420cf0e2-5d75-4022-bd9f-34540f1fe230.png)
+![Lyrics page example](https://user-images.githubusercontent.com/40011582/169437044-420cf0e2-5d75-4022-bd9f-34540f1fe230.png)
 
 ## Command help popup
 

docs/config.md

@@ -19,6 +19,7 @@ librespot-connect = { version = "0.6.0", optional = true }
 librespot-core = "0.6.0"
 librespot-oauth = "0.6.0"
 librespot-playback = { version = "0.6.0", optional = true }
+librespot-metadata = "0.6.0"
 log = "0.4.22"
 chrono = "0.4.38"
 reqwest = { version = "0.12.9", features = ["json"] }
@@ -38,7 +39,6 @@ async-trait = "0.1.83"
 parking_lot = "0.12.3"
 tracing = "0.1.41"
 tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
-lyric_finder = { version = "0.1.8", path = "../lyric_finder", optional = true }
 backtrace = "0.3.74"
 souvlaki = { version = "0.7.3", optional = true }
 viuer = { version = "0.9.1", optional = true }
@@ -85,7 +85,6 @@ rodiojack-backend = ["streaming", "librespot-playback/rodiojack-backend"]
 sdl-backend = ["streaming", "librespot-playback/sdl-backend"]
 gstreamer-backend = ["streaming", "librespot-playback/gstreamer-backend"]
 streaming = ["librespot-playback", "librespot-connect"]
-lyric-finder = ["lyric_finder"]
 media-control = ["souvlaki", "winit", "windows"]
 image = ["viuer", "dep:image"]
 sixel = ["image", "viuer/sixel"]

examples/README.md

@@ -46,8 +46,7 @@ fn get_id_or_name(args: &ArgMatches) -> IdOrName {
     }
 }
 
-#[allow(clippy::unnecessary_wraps)] // we need this to match the other functions return type
-fn handle_get_subcommand(args: &ArgMatches) -> Result<Request> {
+fn handle_get_subcommand(args: &ArgMatches) -> Request {
     let (cmd, args) = args.subcommand().expect("playback subcommand is required");
 
     let request = match cmd {
@@ -69,7 +68,7 @@ fn handle_get_subcommand(args: &ArgMatches) -> Result<Request> {
         _ => unreachable!(),
     };
 
-    Ok(request)
+    request
 }
 
 fn handle_playback_subcommand(args: &ArgMatches) -> Result<Request> {
@@ -202,7 +201,7 @@ pub fn handle_cli_subcommand(cmd: &str, args: &ArgMatches) -> Result<()> {
 
     // construct a socket request based on the CLI command and its arguments
     let request = match cmd {
-        "get" => handle_get_subcommand(args)?,
+        "get" => handle_get_subcommand(args),
         "playback" => handle_playback_subcommand(args)?,
         "playlist" => handle_playlist_subcommand(args)?,
         "connect" => Request::Connect(get_id_or_name(args)),

spotify_player/Cargo.toml

@@ -1,12 +1,12 @@
 use anyhow::Context;
+use rspotify::model::Id;
 use tracing::Instrument;
 
 use crate::{
     config,
     state::{ContextId, ContextPageType, ContextPageUIState, PageState, PlayableId, SharedState},
 };
 
-#[cfg(feature = "lyric-finder")]
 use crate::utils::map_join;
 
 use super::ClientRequest;
@@ -167,25 +167,24 @@ fn handle_page_change_event(
             }
         }
 
-        #[cfg(feature = "lyric-finder")]
-        PageState::Lyric {
+        PageState::Lyrics {
+            track_uri,
             track,
             artists,
-            scroll_offset,
         } => {
             if let Some(rspotify::model::PlayableItem::Track(current_track)) =
                 state.player.read().currently_playing()
             {
                 if current_track.name != *track {
-                    tracing::info!("Current playing track \"{}\" is different from the track \"{track}\" shown up in the lyric page. Updating the track and fetching its lyric...", current_track.name);
-                    track.clone_from(&current_track.name);
-                    *artists = map_join(&current_track.artists, |a| &a.name, ", ");
-                    *scroll_offset = 0;
-
-                    client_pub.send(ClientRequest::GetLyric {
-                        track: track.clone(),
-                        artists: artists.clone(),
-                    })?;
+                    if let Some(id) = &current_track.id {
+                        tracing::info!("Currently playing track \"{}\" is different from the track \"{track}\" shown up in the lyrics page. Fetching new track's lyrics...", current_track.name);
+                        track.clone_from(&current_track.name);
+                        *artists = map_join(&current_track.artists, |a| &a.name, ", ");
+                        *track_uri = id.uri();
+                        client_pub.send(ClientRequest::GetLyrics {
+                            track_id: id.clone_static(),
+                        })?;
+                    }
                 }
             }
         }