Also see Post on AIMP Forum.
What's this?
The repo provides AIMP-Floating-Lyrics-Plugin translations.
As I'm from China, I only know about Chinese and English. If you are interested, you can help translate this plugin to other languages.
Here I present my hand-made plugin: AIMP Floating Lyrics Player and Editor Plugin, as a software developer, this is my hobby project. If you have found any issue, it would be a great help to tell me :)! It has these features:
- It plays synchronized lyrics file(currently only supports ".lrc" file format with UTF-8 or ASCII encoding) for your song, it reads from your local lrc file alongside with your song file, or if your song file has synchronized lyrics embedded(like ID3v2 tag supported by AIMP), it will also play it;
- For playing lyrics, you can style text color, text size, text shadow and more, I have written a preference window to configure these(and more configurations will be brought in the future updates);
- For playing lyrics, currently I designed 2 playing styles, one is to fade in fade out lyrics text, another style is to scroll lyrics horizontally;
- You can make or edit your own ".lrc" file, just right click the playing lyrics window, choose "Make / Edit Lyrics". Or in AIMP playlist, right click playlist item(aka, songs in your library), choose "Send to - Lyrics Editor".
- About the lyrics editor, when it opens, it will fill basic information automatically if it finds that, otherwise, you need to input information yourself.
- Some hint to use the lyrics editor: Currently I exposed 3 hotkeys to inert/replace/delete timestamp on active line, they are bound with F7/F8/F9 keys globally by default. You can always change these hotkeys in AIMP's "Hotkeys" configuration, but remember, local hotkeys won't work, because the lyrics editor is not recognized by AIMP as local window. The inserted or replaced timestamp is always the timestamp that AIMP is current playing at, so ideally you just play the song once and inserted timestamps all by yourself. There are also some handy buttons there, you can hover on them to see brief descriptions.
*Tip: you can set lyrics playing window's background color to a totally transparent value, which looks fancy, but it will make context menu harder to open, if you really can't fetch context menu at that time, go to AIMP's "preferences - Floating Lyrics", you can open plugin's preference window there.
Plugin' file name looks like "aimp_floating_lyrics_x86_64_net[DOTNET_RUNTIME_VERSION]_ver_[VERSION].aimppack" since this version.
Be sure to install corresponding version of dotnet runtime(DOTNET_RUNTIME_VERSION) first (You only need to install one of the files listed below):
.NET 8.0 Desktop Runtime (
DOTNET_RUNTIME_VERSION = net8.0):
- for AIMP x64: https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.29-windows-x64-installer
- for AIMP x86: https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.29-windows-x86-installer
.NET 10.0 Desktop Runtime (
DOTNET_RUNTIME_VERSION = net10.0):
Plugin files are released as .aimppack format, you can easily install them with AIMP's built-in install button.
-
Download and install ".NET 8.0 Desktop Runtime":
-
Download and install "Visual C++ Redistributable 2012" from https://www.microsoft.com/en-us/download/details.aspx?id=30679, make sure to pick x86 or x64, which depends on AIMP x86 or x64 your are using. (a known issue listed below also mentions this runtime package, if you are not sure, I recommend you just download and install it);
You no longer need to install VC++ 2012 since v1.2.4, plugin has already included necessary files.
- Unzip "aimp_floating_lyrics_x[86_or_64]_ver_[VERSION].zip" and drop extracted "aimp_floating_lyrics" folder to "[your-AIMP-x86-or-x64-installation-folder]/Plugins";
- Finally, open AIMP and check "Floating Lyrics" menu item in AIMP's main menu to show lyrics player window and let's roll!
1. If AIMP complains about an external exception when opening preference window, that's because my plugin is importing "msvcr110.dll" to make sure .net UI is compatible with AIMP's Delphi UI,
when that happens, make sure to download and install "Visual C++ Redistributable 2012" here: https://www.microsoft.com/en-us/download/details.aspx?id=30679, plugin should work properly then.
You no longer need to install VC++ 2012 since v1.2.4, plugin has already included necessary files.
- In some cases, AIMP might disable the plugin so you won't be able to use the plugin in AIMP, you can follow these steps to fix:
i. Make sure to close AIMP instance before proceed;
ii. Open "AIMP.ini" file within "[your-AIMP-installation-directory]/Profile" directory, search and delete these lines (it may differ from your file, but should look similar):[Plugins] aimp_floating_lyrics.dll=0 [Plugins.CachedInfo] aimp_floating_lyrics.dll=0|||||1552900961iii. If this still does not work, you can try to delete whole
[aimp_floating_lyrics_plugin]section in "AIMP.ini" file, this will reset all configurations of my plugin.
Try launching AIMP after that, plugin should work now.
Since this version, plugin will be mainly dispatched as
.aimppackformats, to get plugin files without installation, rename it to.zip.
- Feat: Add a preference to control non-synchronized lyrics playing behavior, user can choose to stack such lyrics vertically(default behavior) or horizontally, play with current play style(old behavior), or even do not show them at all (Suggested by many people including Soolo, Kenji Wolfgang)
- Fix: Under karaoke mode, some font text gets incorrectly truncated at the edge, e.g. character
g's tail gets truncated on some fonts - Fix: Incorrect theme color under AIMP 6
- Optimize: Lyrics Editor now reads non-synchronized lyrics
- Optimize: Add a gatekeeper layer which prevents plugin from crashing if corresponding .NET Desktop Runtime is not installed or plugin confliction occurs, a notification will be displayed at that time, which is friendly for new users
- Add(CI): As .NET 8 will soon reach its end-of-support date, plugin files targeting .NET 10 is added since this release. It is recommended to install .NET Desktop Runtime 10 and use corresponding plugin files
- Optimize: Dispose webview process completely if user closes lyrics playing window
- Other minor optimizations
- Feat(#7): Allow "Fade Animation Max Duration" preference of One Line Fade-In-Out play style able to be set down to 0, at that time, lyrics player acts like movie subtitle player (Suggested by @The-Fae-Sorceress)
- Feat: Add a preference to disable lyrics playing window always showing on top (Suggested by Kenji Wolfgang on AIMP forum)
- Fix: Letter spacing animation of One Line Fade-In-Out play style will not play the first line after user seeks playback
- Other minor optimizations
- Feat: Add Karaoke Mode alongside these features
- Ability to style karaoke inactive parts' font color, shadow color and text stroke color, corresponding configurations appear on preference window when karaoke mode is enabled
- Ability to change karaoke transition area width. If set to 0%, there is no transition area, which many people may prefer
- Karaoke mode supports all 3 play styles
- Feat: Add an preference which enables outer text stroke, which in my opinion looks better than inner text stroke(the old one)
- Limitation(s):
- In karaoke mode, outer text stroke is always enabled
- Outer text stroke does not support hollow text, i.e. if setting font color to a transparent value, text stroke inner part will not be transparent
- Limitation(s):
- Feat: Enhance text shadow settings, add shadow implementation preference:
- The default text shadow implementation does not look well when text stroke is enabled, so "stroke shadow" is introduced in this version, which looks better when text stroke is enabled
- The default value of shadow implementation preference is "Automatic", which enables "stroke shadow" only when text stroke is enabled and is recommended
- For advanced users, you can choose to enable one or both of them.
- Limitation(s):
- In karaoke mode, only "stroke" shadow implementation can be enabled, this preference has no effect under karaoke mode
- Feat: Allow negative value for letter spacing preference, because some font family is spotted to be very loose even if letter spacing is 0
- Optimize: Letter spacing animation in one line fade-in-out play style
- Feat: when user sets transparency of background color to a very small value, mouse hovers on lyrics floating window will make background less transparent, because transparent floating window is not transparent for mouse clicks(as Artem previously points out), which may confuse users. If you don't want this feature, just enable "click-through" preference.
- Fix an issue that Two-Line play style may not play the lyrics line whose preceding line duration is too small (bug reported by Soolo)
- Fix an issue that lyrics scroll window will not re-appear if user switches song quickly
- Fix Two-Line play style will not clean up stage if switching to a song without lyrics (bug reported by Soolo)
- Fix an issue that Two-Line play style may not play first lyrics line if its starting time is too small
- Make lyrics scroll window fades in/fades out if window is about to change visibility
- Implement Two-Line play style, which plays lyrics in two-line
- Optimize One-Line play style: when playback pauses/resumes, animations will also pause/resume
- Optimize animations when user starts/restarts/seeks/stops playback
- Add
Fade Durationpreferences for both One-Line and Two-Line play styles (note that they did not share same preferences) - Optimize overall stability
- Optimize plugin's low native C++ layer to have better memory management
- Drop the necessity of installing VC++ 2012 runtime
- Optimize "edge feather width" preference implementation to prevent lyrics from being blocked by it
- Support playing non-synchronized lyrics in
.txt/.lrcfiles or embedded tag (suggested by Artem) - Fix .NET string formatting behaves inconsistently across different systems with different regional formats (bug reported by Soolo)
- Fix(#6): At the edge of playing lyrics, shadow effect may be blocked by an invisible area, this happens because lyrics playing area is not set to full width of owner window
- Fix inconsistent .NET
System.Convertbehavior among Windows OS with different regional format (Thanks for Soolo reporting the issue!) - Fix some memory leak issues as Artem points out (Thank you AIMP creator!), and with the help of CRT Library, some native C++ code is refactored in this update to get away such issue as much as possible
- optimize(#6 related): Add lyrics window edge feather effect and a corresponding preference to set feather width
- Add a hotkey that allows to toggle lyrics window click-through behavior
- Make preference window layout responsive, alongside some minor adjustments
- Fix an issue happens when user toggles/restarts playing song, window would blink once when "Hide if No Lyrics" preference is enabled
- Other minor fixes and optimizations
- Fix an issue when "Hide if No Lyrics" preference is enabled, there is a chance lyrics window not showing even if playing song has lyrics
- Optimize option dialog implementation to embrace AIMP's Automatically Localization feature
- Add some localization entries
- Add a preference, when enabled, floating lyrics window will not appear on taskbar
- Add a preference, when enabled, floating lyrics window will be hidden when no lyrics are found
- Add text stroke preference, which means outlined/hollow text is supported now
- Font family picker now respects AIMP's language: font family name now displays as AIMP language if possible
- Preference window's size is remembered now in case some user's screen is too small
- Other minor bug fixes and optimizations, and modified some localization entries
- Migrate plugin's floating lyrics window implementation to Edge Webview2 to achieve better animation performance.
- Add letter spacing preference as web platform supports them out of the box.
- Add an experimental preference that allows you to animate letter spacing under "Fade In Out Play Style", which looks fancy.
- Other minor bug fixes and optimizations, and modified some localization entries.
- Support multi-language lrc file as 17hapi on AIMP forum suggests
- Change default font family to make UI look better
- Optimize lang files entries, enhance Chinese translations
- Re-write preference window user interface to make it have a modern look
- Add an option to enable/disable click-through lyrics playing window(note that when background is set to a transparent color, the click-through feature is always enabled)
- Fix an issue causing context menu's text and icon blurry
- Other minor stability optimizations and adjustments
- Now supports both AIMP 5 x86 and x64! Make sure to download corresponding zip file and install corresponding runtime packages (see "How to Install & Use" section below)
- Fix an issue causing lyrics editor to crash when user clears "offset" input
- Add option panel in AIMP's preference window, provides functionality to open plugin's preference window or reset lyrics playing window's position there
- Optimize code originally porting from .NET Framework to ensure better compatibility with .NET 8.0
- Update project dependencies: WPF.UI from 4.0.3 to 4.2.0; my dotnet-lrc-parser 0.3.0 to 0.3.1(minor changes concerning .NET 8.0)
- Other stability optimizations and adjustments
Original Release