foobar2000

Releases of OpenLyrics

1.8 current version, released on: 2023-10-28

Behaviour changes:
  • Searches that are 'skipped' now still search local sources
    • This means that you'll still see lyrics for tracks matching the
      skip filter if they were already available from a local source.
    • For example if you already have (or explicitly search for) lyrics
      saved to file for a track whose genre is 'Instrumental' (which
      matches the default skip filter) then those will still show up.
  • Change the default search filter to consider multi-value genre tags

Bug fixes:
  • Fixed the default search skip filter never skipping anything
  • Fix the parsing of line breaks in lyrics from genius.com

1.7 released on: 2023-10-18

New features:
  • Add support for album art or a custom image file as the panel background
  • Add support for gradients to the background colour preferences
  • Add support for showing already-passed lyric lines in a different colour
  • Add configuration for horizontal and vertical text alignment
  • Add (experimental) support for showing the panel in an external window
  • Add a source for metal-archives.com
  • Add a 'skip filter', a titleformat-based way to skip auto-search
  • Show the active sort order in column headers of the manual search window

Behaviour changes:
  • Stop asking users to submit metrics after a pre-defined date
  • Automatically display search result in all lyric panels, not just one
  • Remove support for horizontal scrolling
  • Move preferences for searching onto their own page, named accordingly
  • Add a preferences page for each source with source-specific options
  • Show a different 'no lyrics' message based on the reason they're missing
    • For example tracks marked instrumental will show one message, while
      tracks that are not instrumental, but that repeatedly fail searches
      will show a different message
    • This does not apply retroactively: Tracks that were previously marked
      instrumental will still show as having failed too many searches.
      Marking those tracks instrumental one more time will fix this.
  • Skip auto-searching remote sources when the track has no metadata tags

Bug fixes:
  • Fix retrieval failing from some sources when no 'album' tag is present
  • Fix crash when deleting lyrics from tags via the playlist context menu
  • Fix crash when playing tracks that have no tag metadata at all
  • Fix LRC offset tags being ignored if they contained a space
  • Fix a potential crash when opening preferences, caused by corrupt config
  • Avoid sometimes creating difficult-to-delete folders when saving to file
  • Fix a case where NetEase sometimes returns garbage results unnecessarily

1.6 released on: 2023-04-13

Bug fixes:
  • Fix crash on startup when running on fb2k v2, beta 31 or earlier

1.5 released on: 2023-04-03

New features:
  • Add basic support for network music streams
  • Allow subdirectories (with '\') in the 'file name format' save setting
  • Add support for continuously scrolling synced lyrics
  • Allow configuring line scroll time and highlight fade time separately
  • Add dark mode support to the preferences pages and some dialogs
  • Add support for asking users to submit once-off usage metrics

Behaviour changes:
  • Bulk searches now add to the search queue instead of creating a new one
  • Avoid saving lyrics if they're loaded from a local source during search
  • Restrict the scroll time setting to increments of 20ms

Bug fixes:
  • The lyric editor now respects fb2k's configured 'Default' font
  • Fix failing to load lyrics from meta tags in some situations
  • Fix lyrics being mangled when loaded from UTF-16-encoded text

Internal changes:
  • Update foobar2k SDK to version 20221116

1.4 released on: 2022-11-19

Bug fixes:
  • Fix always opening lyrics in explorer instead of the default file browser
  • Fix LRC line-merge options reordering lines when saving unsynced lyrics
  • Fix manual search always failing if no track is playing
  • Fix bulk search not saving lyrics when auto-save is disabled
  • Fix 'Remove all blank lines' skipping lines with certain blank characters

1.3 released on: 2022-10-13

New features:
  • Add 'Search manually' to the playlist context menu
  • Add 'Edit lyrics' to the playlist context menu
  • Add 'Mark as instrumental' to the playlist context menu
  • Add 64-bit build configuration

Behaviour changes:
  • Move the playlist context menu entries into the OpenLyrics submenu
  • Improve clarity of the confirmation text for 'Mark as instrumental'
  • Delay lyric search when results aren't visible (e.g fb2k is minimised)
  • Change preferences nomenclature from 'ID3 tags' to 'Metadata tags'
  • Re-word preferences for local files from 'save' to 'storage' folder
  • Add a status bar description for the 'Remove timestamps' auto-edit

Bug fixes:
  • Fix accidentally deleting newlines from genius, azlyrics & darklyrics
  • Fix the AZLyrics source not returning lyrics available on the site
  • Fix 'Invalid path syntax' error when saving lyrics to network share
  • Fix manual search results sometimes not showing up in the result list
  • Fix 'Collapse multiple instances of the same line' option being ignored
  • Fix ColumnsUI warning that the openlyrics panel is visible on creation
  • Fix the QQMusic source reliably failing to find any lyrics

Internal changes:
  • Update ColumnsUI SDK to version 7.0.0 beta 2
  • Update foobar2k SDK to version 20220810
  • Replace the internal HTML parser for MIT license compatibility

1.2 released on: 2022-05-28

Bugfix release for bugs introduced in v1.1:
- Add some additional info to the debug logs for searching & saving
- Fix failing to load the last line of lyrics
- Fix empty lines being ignored by the editor

1.1 released on: 2022-05-21

New features:
  • Add an auto-edit for deleting the currently-loaded lyrics
  • Add an auto-edit for removing timestamps from synced lyrics
  • Support concurrently highlighting multiple lines with identical times
  • Add an option to enable additional debug logging

Behaviour changes:
  • Rename the 'ID3 tags' source to 'Metadata tags'
  • The 'Metadata tags' source is now enabled by default
  • Change the default save tag for better compatibility with other players
  • Auto-edits that edit timestamps are now disabled for unsynced lyrics
  • Search auto-skip now also updates its metadata after searching
  • 'Mark as instrumental' now forces an auto-skip instead of creating lyrics
  • Make the input field order for manual search consistent with the results

Bug fixes:
  • No longer automatically add a space to synced & empty lyric lines
  • Fix the editor failing to parse tags from synced lyrics for offsetting
  • Fix some sources failing to search for tags with non-ASCII characters

Note: Changes to config defaults *will not* affect existing users, only
new users who have not used foo_openlyrics previously. If existing users
want to use the updated defaults, they will need to apply those changes
manually.

1.0 released on: 2022-02-18

New features:
  • Allow manual offset of the automatic scroll with mouse drag or wheel
  • Support loading lyrics encoded as something other than UTF-8

Behaviour changes:
  • Skip the anti-flood delay when only local sources are bulk-searched
  • Make the Musixmatch token text field hidden by default
  • Significantly improve Musixmatch error logging
  • Support more than exactly 2 decimal places in timestamps

Bug fixes:
  • Fix a freeze when closing the lyric panel while a search/editor is open
  • Fix the auto-search skip continuing to happen after lyrics are found
  • Fix mishandling of timestamps that include an hour as [hh:mm:ss.xx]

0.10 released on: 2021-10-31

New features:
  • Add a bulk search option to the playlist context menu
  • Allow sorting the manual search result list by any column
  • Allow applying lyrics from manual search without closing the dialog
  • Avoid auto-searching a track after a while if it keeps failing
  • Support applying a manual search result by double-clicking it

Behaviour changes:
  • Remember modified column widths in the manual search table UI
  • Stop automatically sanitising custom save directory to a valid path
  • Make auto-searches case-insensitive when matching track metadata

Bug fixes:
  • Fix ColumnsUI config export complaints of corrupted file
  • Fix vertical alignment of lyrics being slightly off (too high)

0.9 released on: 2021-08-30

New features:
  • Add an auto-edit to 'fix' the capitalisation of each lyric line
  • Add config to apply some auto-edits to lyrics from the internet
  • Add an auto-edit to fix slightly-malformed LRC timestamps
  • Add an option to disable collapsing of duplicate timestamped lines
  • Add an option to only save unsynced lyrics

Behaviour changes:
  • Change search to consider only the first instance of duplicate tags
  • Revert edit behaviour back to always auto-save (regardless of config)
  • Reduce the number of results requested when searching QQMusic
  • Add slightly more information to the musixmatch token help dialog
  • Stop silently fixing & loading slightly-malformed timestamps
  • Auto-search can now find lyrics when the source provides no album
  • Automatically highlight the first manual search result
  • Manual searches now query sources in parallel

Bug fixes:
  • Fix the text alignment bounds when using manual scrolling
  • Fix Musixmatch sometimes erroneously returning empty lyrics
  • Fix accepting (and displaying) empty lyrics from local files
  • Fix lyrics being re-saved when loaded from another local source
  • Fix lyrics not saving to tags if there was already a lyric tag

0.8 released on: 2021-07-25

New features:
  • Add a source for Musixmatch
  • Add an auto-edit to fix HTML-encoded characters (e.g > to >)
  • Add an option to entirely disable auto-saving downloaded lyrics
  • Add a manual save button to the lyric panel context menu
  • Add a manual/custom lyric search dialog which searches all sources
  • Add the option to disable automatic scroll and drag/mousewheel instead

Behaviour changes:
  • Change trailing bracket removal to also apply to artists & albums
  • Change edits to only auto-save if allowed by the auto-save config
  • Change the darklyrics search to check the track name not number
  • Change the default enabled sources to include QQMusic and NetEase

Bug fixes:
  • Fix search sometimes ignoring the 'exclude trailing brackets' setting
  • Fix hiding the first lines of lyrics when they look like '[text:text]'

0.7 released on: 2021-07-04

Features added:
  • Add a source for QQ Music
  • Add a source for darklyrics.com
  • Add an auto-edit for removing duplicate blank lines
  • Open the lyric editor when the panel is double-clicked

Behaviour changes:
  • Auto-trim leading & trailing whitespace in lyrics from online sources
  • Rename the 'Save to file' option to 'Save to text file' for clarity

Bug fixes:
  • Fix parsing LRC-tag-like lines as tags when in the middle of the text
  • Fix the editor's keyboard focus not starting on the actual text

0.6 released on: 2021-05-23

Features added:
  • Add a context menu option to view saved lyrics for a track at any time
  • Add support for horizontal lyrics scrolling
  • Add a context menu with some very basic lyric 'auto-edits'
  • Add an option to exclude trailing brackets in titles when searching
  • Add support for the LRC 'offset' tag in timestamped lyrics
  • Add the ability to remove an 'offset' tag, updating timestamps instead
  • Add the ability to sync a line by adding/modifying an 'offset' tag

Behaviour changes:
  • Change 'Open file location' button to disabled when there are no lyrics
  • Disable editor playback controls when not playing the edited track
  • Select the current line when opening the editor with synced lyrics
  • Trim surrounding whitespace from track metadata for internet searches

Bug fixes:
  • Fix the panel not updating when it should if playback is paused
  • Fix a degradation in scroll smoothness introduced in v0.5
  • Fix a potential crash when closing fb2k while the editor is open
  • Fix the editor pause/play button showing the wrong state during playback

0.5 released on: 2021-04-25

Features additions:
  • Add support for ColumnsUI
  • Add a preferences page for the font & colours used for the panel
  • Add a preferences page with configuration for lyric saving
  • Add the option to only auto-save synced lyrics
  • Add support for smoothly scrolling between lines of synced lyrics
  • Add wrapping for lines that do not fit into the available space

Behaviour changes:
  • Change search to check the save location even if not configured to do so
  • Change save to not overwrite existing tags/files when auto-saving

Bug fixes:
  • Fix the source list selection clearing when an item is (de)activated
  • Fix the editor sometimes adding an extra blank line above the lyrics
  • Fix the panel continuing to show lyrics after playback stops
  • Fix failing to show lyrics if the panel is created during playback

Misc:
  • Remove the option to not save any lyrics at all

0.4 released on: 2021-04-11

  • Add support for saving lyrics to ID3 tags
  • Add support for configuring which ID3 tags are searched or saved to
  • Add status-bar descriptions for lyric panel context menu entries
  • Add an line showing which source is currently being searched
  • Change lyric loading to not auto-reload whenever any lyrics file changes
  • Fix the release process producing incompatible *.fb2k-component archives
  • Fix config reset resetting to the last-saved value rather than the default
  • Fix a save format preview format error when playback is stopped
  • Some internal restructuring to better support future features