Skip to content

Latest commit

 

History

History
129 lines (100 loc) · 5.49 KB

README.md

File metadata and controls

129 lines (100 loc) · 5.49 KB
Raw

Lyrics

Lyrics is a macOS Electron-based application for displaying the current line of lyrics of the song playing in Spotify.

It is a homage to a similar application that existed for Windows when I was a kid and which I loved. I don't remember its name anymore though. It might have been MiniLyrics, but a Google image search doesn't surface a UI setup with transparent background and click-through behavior which I remember having and may have just configured for myself.

Tasks

Set up a GitHub Actions workflow for generating the GIF and screencast

I might drop the GIF now that both GitHub Markdown preview and VS Code support videos. Though that would mean losing auto-play.

The video needs to be recorded based on an automated script to be reproducible. I will use faked synchronized lyrics for it so that I don't need to connect to Spotify from the agent.

Integrate the Electron auto-update service once GitHub Actions is set up

So I do not need to replace the app but can rely on it to auto-update on start if a new version has been cut.

Figure out automated publishing to GitHub Actions

I am manually using Electron Packager: https://github.com/electron/packager

bunx electron-packager . Lyrics --overwrite --ignore "(node_modules|.gitignore|bun.lockb|README.md)"

Run emulating startup initiated by the user:

open Lyrics-darwin-arm64/Lyrics.app

Run with the ability to see console statements:

./Lyrics-darwin-arm64/Lyrics.app/Contents/MacOS/Lyrics

Replace the installed Lyrics app in Applications with the built one:

rm -rf /Applications/Lyrics.app && cp -R ./Lyrics-darwin-arm64/Lyrics.app /Applications/Lyrics.app
  • overwrite is used to force a new build each run
  • ignore is used to ignore files not a part of the application bundle

The production builds require a working directory to be set to something because they default to /.

I set it to the user's home directory, create a Lyrics directory there and the lyrics directory and token.json files further go there.

Allow dragging the lyrics away or dismissing them for a song

This will require not making the window click-through, just transparent and cut to the exact size of the lyrics line so it fits snugly around it and can be dragged without stealing the pointer outside of the lyric line's hitzone.

Allow scrolling up or down while over the lyrics to adjust unsynchronized

The pace of the synchronized lyrics is linear now. With the ability to hold up or rush the pace, it will be possible to correc the timing issues with linear unsynchronized lyrics. Also consider saving the changes to manually synchronized lyrics for reuse.

Notes

  • The application cannot be supported on Windows due to lack of AppleScript (Windows has automations but the Spotify app doesn't have the same commands)
  • The text shadow/opacity ghost remains visible even after changing the text
    • This is some sort of an issue with Electron because it is for the most part fixable by reloading the page (vast majority of reloads clear the shadow)
    • Clearing the text before updating it did not help I tried both in a single executeJavaScript call and split clear and update
    • Hiding and showing the window did not help
    • Resizing the window to zero and back did not help
    • Reloading the window helps for the most part so I stuck with it
    • This is an issue for both HTML and SVG based text rendering!
    • This might seem as the OS compositor because sometimes it lingers even after the Electron process is killed but so far it has always be a stray process

Logs

  • Followed the Advanced Installation Instructions to add Electron without the need to scaffold by cloning a sample repository https://www.electronjs.org/docs/latest/tutorial/installation
  • Came up with a TLA + dynamic import based solution to work around the lack of ESM
  • Made the window always stay on top
  • Made the window frameless, non-minimizable and non-maximizable
  • Made the window transparent
  • Made the window click-through
  • Styled the text to be big, white, with a glow and an outline for legibility
  • Implemented logic for scraping Spotify ID for artist and title from Google
  • Implemented logic for pulling lyrics using the Spotify Lyrics API on GitHub (https://github.com/akashrchandran/spotify-lyrics-api)
  • Fixed most of the lingering shadow issue by reloading before every line change
  • Made the lyrics fade into view instead of flashing in aggressively
  • Swithced to SVG based rendering
    • Allows for the text fade without ugly unsupported CSS
    • Allows for an easy way to do a text outline
    • Still suffers from the shadow/opacity ghosting HTML based rendering did
  • Replaced track ID web search lookup with a Spotify AppleScript command
  • Rewrote to use the Spotify API directly instead of via the Heroku app
  • Upgraded to latest Electron and started using ESM and TLA
  • Implemented a re-authorization flow for obtaining the new token after a 401
  • Switched back to CSS based rendering for the more flexible approach (Not everything is supported vendorless, but it is getting better.)
  • Added a macOS Dock context menu with artist, song and token information
  • Made the Spotify web player window wait to show to prevent refresh flashes
  • Removed no longer used stuff now that the app uses the user's Home directory
  • Worked around the ghosting issue and capture a repro repository for it: https://github.com/TomasHubelbauer/electron-lingering-shadow-repro
  • Fixed the Lyrics app opening up Spotify unintentionally if it was closed