Merge remote-tracking branch 'raffaem/master'

Author: GabriWar

README.md

@@ -1,5 +1,13 @@
 # waybar-mediaplayer
 
+## Retirement notice
+
+I don't use this project anymore and therefore  I'm archiving it.
+
+Feel free to fork it.
+
+## Introduction
+
 This is a mediaplayer for [waybar](https://github.com/Alexays/Waybar).
 
 Widget with album art and progress bar:
@@ -26,94 +34,98 @@ It features:
 5. Optional notification on song change
 6. Click to play/pause, scroll up/down to scroll up/down on the playlist
 
-# Requirements
+## Requirements
 
-`playerctl` must be installed.
+[playerctl](https://github.com/altdesktop/playerctl) must be installed.
 
 The default configuration use Nerd Fonts, so it requires waybar to use a Nerd Font.
 
-The default configuration use `feh` to open the album art image.
+The default configuration use [feh](https://github.com/derf/feh) to open the album art image.
 
-# Install
+## Install
 
-Create a virtual environment within which to run waybar. For example, using pyenv this would be:
-```
-pyenv virtualenv 3.12.0 waybar
-pyenv activate waybar
-```
+1. Create a virtual environment within which to run waybar. For example, using pyenv this would be:
 
-You can create a wrapper script to run waybar inside this virtual environment. For example, always using pyenv:
-```
-#!/usr/bin/env bash
-. ~/.pyenv/versions/waybar/bin/activate
-waybar
-```
+    ```
+    pyenv virtualenv 3.12.0 waybar
+    pyenv activate waybar
+    ```
 
-Run:
+1. Create a wrapper script to run waybar inside this virtual environment.
 
-```
-git clone https://github.com/raffaem/waybar-mediaplayer "$HOME/.config/waybar/waybar-mediaplayer"
-cd "$HOME/.config/waybar/waybar-mediaplayer"
-```
+    For example, always using pyenv, create the file `start_waybar` and put it in your PATH:
+    ```
+    #!/usr/bin/env bash
+    . ~/.pyenv/versions/waybar/bin/activate
+    waybar
+    ```
 
-Install the required python packages inside your virtual environment:
-```
-pip3 install -r requirements.txt
-```
+1. Clone this repo:
 
-You need to find the name of your player. To do so, run `playerctl --list-all` while your player is running.
+    ```
+    git clone https://github.com/raffaem/waybar-mediaplayer "$HOME/.config/waybar/waybar-mediaplayer"
+    cd "$HOME/.config/waybar/waybar-mediaplayer"
+    ```
 
-Open `"$HOME/.config/waybar/waybar-mediaplayer/src/config.json` and change `player_name` with the name of your player.
+1. Install the required python packages inside your virtual environment:
 
-Put the following in `$HOME/.config/waybar/config`:
+    ```
+    pip3 install -r requirements.txt
+    ```
 
-```
-"modules-left": ["image", "custom/mediaplayer"],
-```
+1. You need to find the name of your player. To do so, run `playerctl --list-all` while your player is running.
 
-```
-"image": {
-  "path": "/tmp/waybar-mediaplayer-art",
-  "size": 32,
-  "signal": 4,
-  "on-click": "feh --auto-zoom --borderless --title 'feh-float' /tmp/waybar-mediaplayer-art"
-},
-
-"custom/mediaplayer": {
-    "exec": "$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer monitor",
-    "return-type": "json",
-    "format": "{}",
-    "on-click": "$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer play-pause",
-    "on-scroll-up": "$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer next",
-    "on-scroll-down": "$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer previous",
-    "min-length": 20,
-    "max-length": 20
-},
-```
+1. Open `"$HOME/.config/waybar/waybar-mediaplayer/src/config.json` and change `player_name` with the name of your player.
 
-Put the following in `$HOME/.config/waybar/style.css`:
+1. Put the following in `$HOME/.config/waybar/config`:
 
-```
-#custom-mediaplayer
-{
-  font-size: 16px;
-  border-radius: 2%;
-}
-@import "./waybar-mediaplayer/src/style.css";
-```
+    ```
+    "modules-left": ["image", "custom/mediaplayer"],
+    ```
+
+    ```
+    "image": {
+      "path": "/tmp/waybar-mediaplayer-art",
+      "size": 32,
+      "signal": 4,
+      "on-click": "feh --auto-zoom --borderless --title 'feh-float' /tmp/waybar-mediaplayer-art"
+    },
+
+    "custom/mediaplayer": {
+        "exec": "$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer monitor",
+        "return-type": "json",
+        "format": "{}",
+        "on-click": "$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer play-pause",
+        "on-scroll-up": "$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer next",
+        "on-scroll-down": "$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer previous",
+        "min-length": 20,
+        "max-length": 20
+    },
+    ```
+
+    Put the following in `$HOME/.config/waybar/style.css`:
+
+    ```
+    #custom-mediaplayer
+    {
+      font-size: 16px;
+      border-radius: 2%;
+    }
+    @import "./waybar-mediaplayer/src/style.css";
+    ```
 
-Restart waybar.
+1. Start waybar using the wrapper script `start_waybar`.
 
 The mediaplayer should work. Click on the progress bar to start/stop playing, and scroll on it to change song.
 
-# Update
+## Update
 
 ```
 cd "$HOME/.config/waybar/waybar-mediaplayer"
 git pull
 ```
 
-# Personalization
+## Personalization
 
 To disable notifications, put `is_notification=false` in `config.json`.
 
@@ -123,29 +135,29 @@ In order for the album art to automatically update on song change, it's importan
 
 If you change the colors of the bar in `$HOME/.config/waybar/waybar-mediaplayer/src/config.json`, make sure to apply the changes by running `$HOME/.config/waybar/waybar-mediaplayer/src/mkstyle` and restart waybar.
 
-# Troubleshooting
+## Troubleshooting
 
-## Firefox users
+### Firefox users
 
 Although Firefox reports MPRIS metadata, the metadata it reports is not sufficient, as it doesn't report song's length. Please install the [Plasma Integration](https://addons.mozilla.org/en-US/firefox/addon/plasma-integration) add-on and use `plasma-browser-integration` as `player_name` in `$HOME/.config/waybar/waybar-mediaplayer/src/config.json`.
 
 To have album art, make sure to set `convert_to_jpeg` to `true` in `$HOME/.config/waybar/waybar-mediaplayer/src/config.json` (this option decreases performance, don't use it if not necessary).
 
-## Me progress bar doesn't work
+### Me progress bar doesn't work
 
 It's likely cause by the player not reporting song length or position back to us. Run `$HOME/.config/waybar/waybar-mediaplayer/src/mediaplayer -vvv` to debug.
 
-## Player reports its name with instance number
+### Player reports its name with instance number
 
 If the player reports an instance after its name, please provide only the player name without the instance number. For example, [kew](https://github.com/ravachol/kew) may report itself as `kew123456`, where `123456` is an instance number which will change with different runs of `kew`. In this case, we report only `kew` without the instance number. This software will check whether the reported player name _starts_ with the name you provide to bind the correct player.
 
-## Me title and tooltip are empty
+### Me title and tooltip are empty
 
 It's likely your song file doesn't contain metadata.
 
 Run `exiftool SONG.mp3` and check the `Title`, `Album` and `Artist` fields.
 
-## Me album art doesn't change on song change
+### Me album art doesn't change on song change
 
 Make sure that the `signal` in the `image` module in `$HOME/.config/waybar/config` matches the number provided by `image_signal` in `$HOME/.config/waybar/waybar-mediaplayer/src/config.json`.
 

src/mediaplayer

@@ -295,24 +295,23 @@ def download_lyrics(artist, title):
     lyrlogger.handlers.clear()
     lyrlogger.addHandler(logging.StreamHandler(stream))
     lyrlogger.setLevel(logging.INFO)
-    lt = syncedlyrics.search(
-        f"{artist} {title}",
-        providers=config["lyrics_providers"],
-    )
-    # This is the main logger
-    # logger.debug("GOT LYRICS")
-    # logger.debug("-"*10)
-    # logger.debug(lt)
-    # logger.debug("-"*10)
+    try:
+        lt = syncedlyrics.search(
+            f"{artist} {title}",
+            synced_only=True,
+            providers=config["lyrics_providers"],
+        )
+    except Exception:
+        logger.debug(
+            "ERROR: syncedlyrics.search threw an exception. Returning None.")
+        return None
     if lt is None:
-        lt = ""
+        logger.debug(
+            "ERROR: syncedlyrics.search returned None. Returning None.")
+        return None
     lt = lt.replace("\n", "")
     lt = lt.split("[")
     lt = ["["+x for x in lt if x]
-    # logger.debug("SPLITTING")
-    # logger.debug("-"*10)
-    # logger.debug(lt)
-    # logger.debug("-"*10)
     provider = stream.getvalue().split("on ")[1].strip()
     stream.close()
     SyncedLyrics = namedtuple("SyncedLyrics", ["lt", "provider"])
@@ -329,8 +328,9 @@ def get_new_lyrics(artist, title):
         "provider": None,
     }
     lyr = download_lyrics(artist, title)
-    if lyr.lt is None:
-        logger.debug("No lyrics, returning")
+    if lyr is None:
+        logger.debug("ERROR: download_lyrics returned None. Returning.")
+        lyrics = None
         return
     lyrics["provider"] = lyr.provider
     for i, line in enumerate(lyr.lt):
@@ -346,7 +346,8 @@ def get_new_lyrics(artist, title):
         try:
             secs = int(timing2[0]) * 60.0 + float(timing2[1])
         except ValueError:
-            logger.debug(f"ERROR: ValueError while converting timing2={timing2} to seconds")
+            logger.debug(f"ERROR: ValueError while converting timing2={
+                         timing2} to seconds")
             continue
         # get lyrics text
         text = m.group(2).strip()
@@ -462,10 +463,10 @@ def update_progressbar(manager, player):
         and metadata["length"] == last_metadata["length"]
         and lyrics_same
     )
-    # CHeck if we need to update
+    # Check if we need to update
     if same_song and \
-        not pbar_needs_update and \
-        not rot_needs_update:
+            not pbar_needs_update and \
+            not rot_needs_update:
         logger.debug(
             "Song is the same and neither the text "
             "nor the progressbar nor the lyrics needs an update. Returning"
@@ -478,10 +479,13 @@ def update_progressbar(manager, player):
     s = [metadata["title"], metadata["artist"], metadata["album"]]
     # -- Lyrics
     curr_line = None
+    text_len = None
     if lyrics:
-        ll = lyrics.get("max_len", 3)
-        s.append("-" * ll)
-        provider = lyrics.get("provider","")
+        cand = [len(x) for x in s]
+        cand.append(lyrics.get("max_len", 3))
+        text_len = max(cand)
+        s.append("-" * text_len)
+        provider = lyrics.get("provider", "")
         if provider is None:
             provider = "NO PROVIDER"
         s.append("["+provider+"]")
@@ -508,13 +512,18 @@ def update_progressbar(manager, player):
             if t == lyrics_ix:
                 curr_line = len(s) - 1
     # -- Tooltip
-    center_text(s, lyrics.get("max_len", None))
+    center_text(s, text_len)
     if curr_line:
         s[curr_line] = "<b>" + s[curr_line] + "</b>"
-    tooltip = f"<span variant='title-caps' font_weight='bold'>{s[0]}</span>\n"
-    tooltip += f"{s[1]}\n"
-    tooltip += f"<i>{s[2]}</i>\n"
-    tooltip += "\n".join(s[3:])
+    tooltip = f"<span variant='title-caps' font_weight='bold'>{s[0]}</span>"
+    tooltip += f"\n{s[1]}"
+    # Skip album in tooltip if we don't have it
+    s[2] = s[2].strip()
+    if s[2]:
+        tooltip += f"\n<i>{s[2]}</i>"
+    if len(s) >= 4 and s[3].strip():
+        tooltip += "\n"
+        tooltip += "\n".join(s[3:])
     write_output(widget_text, gen_class(perc), tooltip)
     # It's important to return True to keep the handler going
     last_metadata = metadata