Merge branch 'display-genres' into display-genres-master-update

Author: KUHLwasStolen

docs/config.md

@@ -52,6 +52,7 @@ All configuration files should be placed inside the application's configuration
 | `liked_icon`                      | the icon to indicate the liked state of a song                                                                                                         | `♥`                                                         |
 | `border_type`                     | the type of the application's borders                                                                                                                  | `Plain`                                                     |
 | `progress_bar_type`               | the type of the playback progress bar                                                                                                                  | `Rectangle`                                                 |
+| `genre_num`                       | the amount of genres to display at `{genres}`                                                                                                          | `2`                                                         |
 | `cover_img_width`                 | the width of the cover image (`image` feature only)                                                                                                    | `5`                                                         |
 | `cover_img_length`                | the length of the cover image (`image` feature only)                                                                                                   | `9`                                                         |
 | `cover_img_scale`                 | the scale of the cover image (`image` feature only)                                                                                                    | `1.0`                                                       |

examples/app.toml

@@ -2,7 +2,7 @@ theme = "default"
 login_redirect_uri = "http://127.0.0.1:8989/login"
 client_port = 8080
 tracks_playback_limit = 50
-playback_format = "{status} {track} • {artists}\n{album}\n{metadata}"
+playback_format = "{status} {track} • {artists}\n{album} • {genres}\n{metadata}"
 playback_metadata_fields = ["repeat", "shuffle", "volume", "device"]
 notify_format = { summary = "{track} • {artists}", body = "{album}" }
 notify_timeout_in_secs = 0
@@ -18,6 +18,7 @@ default_device = "spotify-player"
 play_icon = "▶"
 pause_icon = "▌▌"
 liked_icon = "♥"
+genre_num = 2
 cover_img_length = 9
 cover_img_width = 5
 cover_img_pixels = 16

spotify_player/src/client/mod.rs

@@ -1635,6 +1635,38 @@ impl AppClient {
             track_or_episode.clone()
         };
 
+        // retrieve current artist for genres if not in cache
+        let curr_artist = match &curr_item {
+            rspotify::model::PlayableItem::Track(full_track) => {
+                let cached = state
+                    .data
+                    .read()
+                    .caches
+                    .genres
+                    .contains_key(&full_track.artists[0].name);
+
+                if cached {
+                    None
+                } else {
+                    match &full_track.artists[0].id {
+                        Some(id) => self.spotify.artist(id.clone()).await.ok(),
+                        None => None,
+                    }
+                }
+            }
+            rspotify::model::PlayableItem::Episode(_) => None,
+        };
+
+        if let Some(artist) = curr_artist {
+            if !artist.genres.is_empty() {
+                state.data.write().caches.genres.insert(
+                    artist.name,
+                    artist.genres,
+                    *TTL_CACHE_DURATION,
+                );
+            }
+        }
+
         let url = match curr_item {
             rspotify::model::PlayableItem::Track(ref track) => {
                 crate::utils::get_track_album_image_url(track)

spotify_player/src/config/mod.rs

@@ -89,6 +89,8 @@ pub struct AppConfig {
 
     pub layout: LayoutConfig,
 
+    pub genre_num: u8,
+
     #[cfg(feature = "image")]
     pub cover_img_length: usize,
     #[cfg(feature = "image")]
@@ -204,6 +206,7 @@ pub struct LibraryLayoutConfig {
     pub album_percent: u16,
 }
 
+#[allow(dead_code)]
 #[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
 #[serde(from = "StreamingTypeOrBool")]
 pub enum StreamingType {
@@ -221,6 +224,7 @@ enum RawStreamingType {
     Never,
 }
 
+#[allow(dead_code)]
 #[derive(Deserialize)]
 #[serde(untagged)]
 enum StreamingTypeOrBool {
@@ -267,7 +271,7 @@ impl Default for AppConfig {
             tracks_playback_limit: 50,
 
             playback_format: String::from(
-                "{status} {track} • {artists} {liked}\n{album}\n{metadata}",
+                "{status} {track} • {artists} {liked}\n{album} • {genres}\n{metadata}",
             ),
             playback_metadata_fields: vec![
                 "repeat".to_string(),
@@ -301,6 +305,8 @@ impl Default for AppConfig {
 
             layout: LayoutConfig::default(),
 
+            genre_num: 2,
+
             #[cfg(feature = "image")]
             cover_img_length: 9,
             #[cfg(feature = "image")]

spotify_player/src/config/theme.rs

@@ -68,6 +68,7 @@ struct ComponentStyle {
     playback_track: Option<Style>,
     playback_artists: Option<Style>,
     playback_album: Option<Style>,
+    playback_genres: Option<Style>,
     playback_metadata: Option<Style>,
     playback_progress_bar: Option<Style>,
     playback_progress_bar_unfilled: Option<Style>,
@@ -253,6 +254,18 @@ impl Theme {
             .style(&self.palette)
     }
 
+    pub fn playback_genres(&self) -> style::Style {
+        self.component_style
+            .playback_genres
+            .as_ref()
+            .unwrap_or(
+                &Style::default()
+                    .fg(StyleColor::BrightBlack)
+                    .modifiers([StyleModifier::Italic]),
+            )
+            .style(&self.palette)
+    }
+
     pub fn playback_metadata(&self) -> style::Style {
         self.component_style
             .playback_metadata

spotify_player/src/state/data.rs

@@ -50,6 +50,7 @@ pub struct MemoryCaches {
     pub context: ttl_cache::TtlCache<String, Context>,
     pub search: ttl_cache::TtlCache<String, SearchResults>,
     pub lyrics: ttl_cache::TtlCache<String, Option<Lyrics>>,
+    pub genres: ttl_cache::TtlCache<String, Vec<String>>,
     #[cfg(feature = "image")]
     pub images: ttl_cache::TtlCache<String, image::DynamicImage>,
 }
@@ -67,6 +68,7 @@ impl MemoryCaches {
             context: ttl_cache::TtlCache::new(64),
             search: ttl_cache::TtlCache::new(64),
             lyrics: ttl_cache::TtlCache::new(64),
+            genres: ttl_cache::TtlCache::new(64),
             #[cfg(feature = "image")]
             images: ttl_cache::TtlCache::new(64),
         }

spotify_player/src/state/ui/mod.rs

@@ -128,7 +128,7 @@ fn fuzzy_search_items<'a, T: std::fmt::Display>(items: &'a [T], query: &str) ->
         .iter()
         .filter_map(|t| {
             matcher
-                .fuzzy(&t.to_string(), &query, false)
+                .fuzzy(&t.to_string(), query, false)
                 .map(|(score, _)| (t, score))
         })
         .collect::<Vec<_>>();

spotify_player/src/ui/playback.rs

@@ -286,6 +286,18 @@ fn construct_playback_text(
                     ui.theme.playback_album(),
                 ),
             },
+            "{genres}" => match playable {
+                rspotify::model::PlayableItem::Track(full_track) => {
+                    let genre = match data.caches.genres.get(&full_track.artists[0].name) {
+                        Some(genres) => &format_genres(genres, configs.app_config.genre_num),
+                        None => "no genre",
+                    };
+                    (to_bidi_string(genre), ui.theme.playback_genres())
+                }
+                rspotify::model::PlayableItem::Episode(_) => {
+                    (to_bidi_string("no genre"), ui.theme.playback_genres())
+                }
+            },
             "{metadata}" => {
                 let repeat_value = if playback.fake_track_repeat_state {
                     "track (fake)".to_string()
@@ -457,3 +469,30 @@ fn split_rect_for_playback_window(rect: Rect) -> (Rect, Rect) {
         }
     }
 }
+
+/// formats genres depending on the number of genres and `genre_num`
+///
+/// Examples for `genre_num = 2`
+/// - 1 genre: "genre1"
+/// - 2 genres: "genre1, genre2"
+/// - \>= 3 genres: "genre1, genre2, ..."
+fn format_genres(genres: &[String], genre_num: u8) -> String {
+    let mut genre_str = String::with_capacity(64);
+
+    if genre_num > 0 {
+        for i in 0..genres.len() {
+            genre_str.push_str(&genres[i]);
+
+            if i + 1 != genres.len() {
+                genre_str.push_str(", ");
+
+                if i + 1 >= genre_num as usize {
+                    genre_str.push_str("...");
+                    break;
+                }
+            }
+        }
+    }
+
+    genre_str
+}