[Update 1.2.5] Floating Lyrics Player and Editor Plugin

[Artem]

If you are willing to share a debug version, it would be much appreciated! 

https://disk.yandex.ru/d/rkuyG5XKbUOZ5Q

Can I also know what windows 10 version you are using(use "winver" command)?

22H2 (19045.6456)

[PaperFolding]

Video: https://skrinshoter.ru/vbpWx3anUDr

Thank you, the issue is caused because different regional decimal format we are using from our operating system. A bug fix release will be distributed shortly. Thank you for your time!

[PaperFolding]

https://disk.yandex.ru/d/rkuyG5XKbUOZ5Q

22H2 (19045.6456)

Sorry for bothering, I used this debug version of AIMP, but it neither pops me the exception dialog while exiting, nor there is any log file generated, you can see the video: https://drive.google.com/file/d/1D2zwg3vagMITw87QGeizwKBrkOOb0lCn/view?usp=sharing 
Is there any special steps I need to take to somehow log memory leak information?

Another question is about plugin API call, 
so do I have to call `.AddRef`/`.Release` explicitly for each `IUnknown` instance created/queried?
Please see this piece of code in my plugin, it is used to get menu item by ID, (please ignore C++/CLI ^ handles and grammars, they are only managed code), basically it calls `IAIMPServiceMenuManager::GetByID` under the hood, when  `IAIMPMenuItem` instance obtained successfully, I wrap it to my `AimpMenuItem` managed class instance and deliver it back to managed code to be used later.
At this time, I don't want the `IAIMPMenuItem` instance to be garbage collected or something, so I did not call `->Release` on it, in my option, calling `Release` on an `IUnknown` instance will destroy the instance, am I right or am I wrong? And must I call `.Release` at some point, like when application exiting? Can you try to explain to me? (This may sound stupid to you, apologize for my little knowledge about COM and delphi)

```cpp
#define RELEASE_IUNKNOWN(obj) if (obj != nullptr) { obj->Release(); obj = nullptr; }

    IMenuItem^ AimpServiceMenuManager::GetByID(String^ menuId) {
        IAIMPServiceMenuManager* service = nullptr;
        IAIMPString* _menuId = nullptr;
        try {
            service = this->GetService();
            IAIMPMenuItem* menu = nullptr;
            _menuId = AimpConverter::ToAimpString(menuId);
            if (service->GetByID(_menuId, &menu) == S_OK && menu != nullptr) {
                return gcnew AimpMenuItem(menu);  // wrap IAIMPMenuItem instance to my `AimpMenuItem` managed class and deliver it to managed code for use later
            }
            return nullptr;
        } finally {
            RELEASE_IUNKNOWN(_menuId);
            RELEASE_IUNKNOWN(service);
        }
    }
```

[DarkDrawKill]

Another question is about plugin API call,
so do I have to call `.AddRef`/`.Release` explicitly for each `IUnknown` instance created/queried?
Please see this piece of code in my plugin, it is used to get menu item by ID, (please ignore C++/CLI ^ handles and grammars, they are only managed code), basically it calls `IAIMPServiceMenuManager::GetByID` under the hood, when  `IAIMPMenuItem` instance obtained successfully, I wrap it to my `AimpMenuItem` managed class instance and deliver it back to managed code to be used later.
At this time, I don't want the `IAIMPMenuItem` instance to be garbage collected or something, so I did not call `->Release` on it, in my option, calling `Release` on an `IUnknown` instance will destroy the instance, am I right or am I wrong? And must I call `.Release` at some point, like when application exiting? Can you try to explain to me? (This may sound stupid to you, apologize for my little knowledge about COM and delphi)

When you call .Release method it decrements counter value. If value == 0 object destroys itself

Code: [Select]

    virtual DWORD __unknwncall Release(void)
    {
        DWORD reference_count = --counter;
        if (reference_count == 0)
            delete this;
        return reference_count;
    }

You must call .Release whenever u release a raw pointer

Code: [Select]

class MyObject: public IUnknown
{
    IUnknown* ptr; // a raw pointer

public:
    MyObject(IUnknown* ptr): ptr(ptr) {}
    virtual ~MyObject()
    {
        if (ptr) ptr->Release; // release raw pointer here
                                       // 'cause object doesnt own it anymore
    }
};

COM says u must call .AddRef only if u copy a raw pointer

Code: [Select]

    IUnknown* service = ...
    ...
    service->AddRef(); // u copy the raw pointer
                                // to MyObject object
    MyObject* obj = new MyObject(service);
    MyObject->AddRef(); // also increase the
                                    // counter of the created object
    ...

A common mistake is increasing parameter object's counter

Code: [Select]

    virtual HRESULT Initialize(IAIMPCore* core)
    {
        core->AddRef(); // Mistake - Memory leak
        ...
    }

Remember C++ is not C with classes so if u dont want to make memory leaks, implement RAII idiom (or use COM smart pointer in WIN32 header)

P.S. smart pointers dont work with IAIMPUIForm cause it shadows .Release() method to .Release(BOOL)
   

[PaperFolding]

DarkDrawKill

Thank you for explanation, and I've also read COM doc carefully. In my example, the pointer to `IAIMPMenuItem` indeed needs to call `Release` in the finally block. It's my fault to treat this way too simple.

[Soolo]

v1.2.3
Preferences for Window not working


And this:

First, the transparent float window is not transparent for mouse clicks.
Here is a small video that illustrates the issue: https://disk.yandex.ru/i/CHWmk4a8lNkp2w
I'm trying to select a song to play but fail because the mouse pointer clicks are transferred to an invisible (transparent) lyrics window.

[PaperFolding]

v1.2.3
Preferences for Window not working


And this:

Thank you for your feedback.
Could you please provide these information?
1. Windows version you are using(use `winver`) command; 
2. Your system locale(display language); 
3. 64-bit or 32-bit system?
4. 64-bit or 32-bit AIMP?
5. If possible, hardware information? 
6. Open "[your-AIMP-installation-folder]/Profile/AIMP.ini" file, search for "[aimp_floating_lyrics_plugin]" section, if it exists, can you share contents in this section? 
7. After doing a clean-installation, then open floating lyrics window for the first time, a half-transparent white window should be displayed at the center of the screen, did you see that window? Also, the default text color is white, so I'd like to ask if you have black text all the time? (This may be a bug on some system that does not support hardware acceleration, you can also try enabling/disabling hardware acceleration on edge browser and see if the issue is gone)

I'm on a business trip this week, I'll try to re-produce your issue after I reach home tomorrow, thank you! 

[Soolo]

Code: [Select]

Windows 10 Pro x64
22H2
09.‎09.‎2024
19045.6456
Russian

Code: [Select]

AMD Ryzen 3 2200G with Radeon Vega Graphics       3.50 GHz
16,0 GB
224 GB SSD Patriot Burst Elite 240GB, 932 GB HDD TOSHIBA HDWD110, 466 GB HDD SAMSUNG HD503HI
AMD Radeon(TM) Vega 8 Graphics (2 GB)

Code: [Select]

[aimp_floating_lyrics_plugin]
LyricsWindowOpened=0
PlayStyle=1
MultiLineScroll.InactiveLineOpacity=0
FadeInOutPlayer.LetterSpacingAnimationSpeed=0
TextShadowEnabled=0
TextShadow=#FF000000,2,2,5
TextStrokeEnabled=0
TextStroke=1,#FFFFFFFF
FontFamily=Segoe UI,Segoe UI
FontSize=50
FontColor=#FFA2FF00
FontWeight=400
LetterSpacing=0
BackgroundColor=#A0FFFFFF
LyricsWindowClickThrough=0
LyricsWindowHideWhenNoLyrics=0
LyricsWindowAlwaysHideTaskbar=0
ShowLog=0
LyricsWindowRect=457,488,1000,120
AIMP and plugin clean installation doesn't help

[PaperFolding]

Code: [Select]

Windows 10 Pro x64
22H2
09.‎09.‎2024
19045.6456
Russian

Code: [Select]

AMD Ryzen 3 2200G with Radeon Vega Graphics       3.50 GHz
16,0 GB
224 GB SSD Patriot Burst Elite 240GB, 932 GB HDD TOSHIBA HDWD110, 466 GB HDD SAMSUNG HD503HI
AMD Radeon(TM) Vega 8 Graphics (2 GB)

Code: [Select]

[aimp_floating_lyrics_plugin]
LyricsWindowOpened=0
PlayStyle=1
MultiLineScroll.InactiveLineOpacity=0
FadeInOutPlayer.LetterSpacingAnimationSpeed=0
TextShadowEnabled=0
TextShadow=#FF000000,2,2,5
TextStrokeEnabled=0
TextStroke=1,#FFFFFFFF
FontFamily=Segoe UI,Segoe UI
FontSize=50
FontColor=#FFA2FF00
FontWeight=400
LetterSpacing=0
BackgroundColor=#A0FFFFFF
LyricsWindowClickThrough=0
LyricsWindowHideWhenNoLyrics=0
LyricsWindowAlwaysHideTaskbar=0
ShowLog=0
LyricsWindowRect=457,488,1000,120
AIMP and plugin clean installation doesn't help

Does edge browser work normally on your system? After you enable/disable hardware acceleration, does edge browser also work normally?
Also, you can try upgrading your graphic card driver to latest stable version.

[Soolo]

Does edge browser work normally on your system? After you enable/disable hardware acceleration, does edge browser also work normally?

Yes

Also, you can try upgrading your graphic card driver to latest stable version.

I will not update drivers or reinstall Windows.

[PaperFolding]

Yes
I will not update drivers or reinstall Windows.

No need to re-install windows or upgrade driver now.
Quick yes-no questions:
After a clean installation and enable floating lyrics window: 
1. Is floating window's background half-transparent white? 
2. Try playing a song with lyrics, is text color white by default? 
I'll try uploading a new debug release tomorrow if you are willing to test, thank you for your time :)
I must apologize for those issues happens on your system, I'm downloading your os image now, hopefully I can re-produce your issue in virtual environment.

[Soolo]

No need to re-install windows or upgrade driver now.
Quick yes-no questions:
After a clean installation and enable floating lyrics window: 
1. Is floating window's background half-transparent white? 
2. Try playing a song with lyrics, is text color white by default? 
I'll try uploading a new debug release tomorrow if you are willing to test, thank you for your time
I must apologize for those issues happens on your system, I'm downloading your os image now, hopefully I can re-produce your issue in virtual environment.

1. Fully transparent
2. Black

[PaperFolding]

1. Fully transparent
2. Black

Finally figured out the issue today, .NET string formatting also behaves differently under systems with different regional format, which leads to comma floating values(like "0,8") being incorrectly delivered to webview2 CSS styles. 
Instead of setting `InvariantCulture` everywhere, plugin can just set `InvariantCulture` globally, which solves such issue once and for all. 
A patch version alongside some new features will be dispatched this weekend. 
And, I must thank you again for pointing out the issue :) 
Have a nice day!