Merge pull request #21 from elazarit/main

Fix severe hidapi & GDI memory leaks, clean up C++/CLI disposal, Startup bug and add Cloud III & III S support

Author: auto94

Cloud2BatteryMonitorUI/MainForm.cpp

@@ -7,51 +7,84 @@ void main()
 {
 	Application::EnableVisualStyles();
 	Application::SetCompatibleTextRenderingDefault(false);
-	Cloud2BatteryMonitorUI::MainForm form;
 	Environment::CurrentDirectory = IO::Path::GetDirectoryName(Application::ExecutablePath);
+	Cloud2BatteryMonitorUI::MainForm form;
 	Application::Run(% form);
 }
 
 /**
- * Enumerates HID devices and returns the HID device info with the highest usage
+ * Enumerates HID devices and returns the HID device path according to logic
  *
- * @return hid_device_info* of the device with the correct vendor/product ID and the highest usage.
+ * @return string of the device path with the correct vendor/product ID and the highest usage / specific condition (like in iii 3s).
  */
-hid_device_info* getHeadsetDeviceInfo() 
+std::string getHeadsetDevicePath()
 {
 	struct hid_device_info* devices = NULL;
-	
 	int id_index = 0;
 	int num_supported_devices = sizeof(VENDORS_ARRAY) / sizeof(VENDORS_ARRAY[0]);
 
 	// Loop through the supported device vendor and product IDs until we find a device.
 	while (devices == NULL && id_index < num_supported_devices) {
 		devices = hid_enumerate((unsigned short)VENDORS_ARRAY[id_index], (unsigned short)PRODUCTS_ARRAY[id_index]);
-
 		id_index++;
 	}
 
-	struct hid_device_info* deviceInfo{};
+	if (devices == NULL) {
+		return ""; // Nothing found
+	}
+
+	std::string foundPath = "";
+
+	// Special case for hyperx cloud iii S
+	// the 'highest usage' method used below is not applicable here
+	for (struct hid_device_info* current = devices; current != nullptr && current->vendor_id == HEADSET_VENDOR_ID_HP && current->product_id == HEADSET_PRODUCT_ID_HP_CLOUD_III_S; current = current->next)
+	{
+		//looks like the correct condition is usage_page 448 and usage 1 combination
+		if (current->usage_page == 448 && current->usage == 1)
+		{
+			foundPath = current->path; // Copy the path
+			hid_free_enumeration(devices); // FREE THE MEMORY
+			return foundPath;              // Return early
+		}
+	}
+
+	// Special case for HyperX Cloud III Wireless
+	// the 'highest usage' method used below is not applicable here either
+	for (struct hid_device_info* current = devices; current != nullptr && current->vendor_id == HEADSET_VENDOR_ID_HP && (current->product_id == HEADSET_PRODUCT_ID_HP_CLOUD_III_REV4106 || current->product_id == HEADSET_PRODUCT_ID_HP_CLOUD_III_REV4109); current = current->next)
+	{
+		// From log: the correct interface is usage_page 65299 and usage 1
+		if (current->usage_page == 65299 && current->usage == 1)
+		{
+			foundPath = current->path;   // Copy the path
+			hid_free_enumeration(devices); // FREE THE MEMORY
+			return foundPath;            // Return early
+		}
+	}
 
 	int highest_usage = 0; //I think the highest usage device is the one that answers with battery level
 	int highest_usage_page = 0; //If all devices have the same usage, use the one with the highest usage page
-	for (struct hid_device_info* current = devices; current != nullptr; current = current->next) 
+
+	for (struct hid_device_info* current = devices; current != nullptr; current = current->next)
 	{
 		if (current->usage > highest_usage)
 		{
 			highest_usage = current->usage;
 			highest_usage_page = current->usage_page;
-			deviceInfo = current;
+			foundPath = current->path; // Keep track of the path
 		}
 		else if (current->usage == highest_usage && current->usage_page >= highest_usage_page)
 		{
 			highest_usage_page = current->usage_page;
-			deviceInfo = current;
+			foundPath = current->path; // Keep track of the path
 		}
 	}
 
-	return deviceInfo;
+	// FREE THE MEMORY before returning
+	hid_free_enumeration(devices);
+
+	return foundPath;
 }
+
 /**
  * Sends a request to the given HID device, waits for the response and retrieves the battery level from it.
  *
@@ -97,6 +130,24 @@ int getBatteryLevel(hid_device* headsetDevice)
 
 			batteryByteInt = 3;
 		}
+		else if (wcsstr(productName, L"Cloud III S Wireless") != 0) {
+			// HP Cloud III S Wireless data
+			writeBuffer[0] = 0x0c;
+			writeBuffer[1] = 0x02;
+			writeBuffer[2] = 0x03;
+			writeBuffer[3] = 0x01;
+			writeBuffer[4] = 0x00;
+			writeBuffer[5] = 0x06;
+
+			batteryByteInt = 6;
+		}
+		else if (wcsstr(productName, L"Cloud III Wireless") != 0) {
+			// HP Cloud III Wireless data
+			writeBuffer[0] = 0x66;
+			writeBuffer[1] = 0x89;
+
+			batteryByteInt = 4;
+		}
 	}
 	else 
 	{
@@ -121,11 +172,16 @@ int getBatteryLevel(hid_device* headsetDevice)
 	}
 
 	int ret = hid_write(headsetDevice, writeBuffer, WRITE_BUFFER_SIZE);
-
+	const wchar_t* err = hid_error(headsetDevice);
 	unsigned char dataBuffer[DATA_BUFFER_SIZE] = { 0 };
 
 	hid_read_timeout(headsetDevice, dataBuffer, DATA_BUFFER_SIZE, 1000);
 
-	return dataBuffer[batteryByteInt];
+	//verify the battery level is not more then 100, as Cloud III S returns 0xff (255) at off state
+	unsigned char battery = dataBuffer[batteryByteInt];
+	if (battery > 100)
+		return 0;
+
+	return battery;
 }
 

Cloud2BatteryMonitorUI/MainForm.h

@@ -14,11 +14,14 @@ constexpr auto HEADSET_PRODUCT_ID_HP_CLOUD_II_B = 1686;
 constexpr auto HEADSET_PRODUCT_ID_HP_CLOUD_II_CORE = 2453;
 constexpr auto HEADSET_PRODUCT_ID_HP_CLOUD_ALPHA = 2445;
 constexpr auto HEADSET_PRODUCT_ID_HP_CLOUD_STINGER_II = 3475;
+constexpr auto HEADSET_PRODUCT_ID_HP_CLOUD_III_S = 1726;
+constexpr auto HEADSET_PRODUCT_ID_HP_CLOUD_III_REV4106 = 3229;
+constexpr auto HEADSET_PRODUCT_ID_HP_CLOUD_III_REV4109 = 1463;
 
-const int VENDORS_ARRAY[] = { HEADSET_VENDOR_ID_KINGSTON, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP};
-const int PRODUCTS_ARRAY[] = { HEADSET_PRODUCT_ID_KINGSTON_CLOUD_II, HEADSET_PRODUCT_ID_HP_CLOUD_II, HEADSET_PRODUCT_ID_HP_CLOUD_II_CORE, HEADSET_PRODUCT_ID_HP_CLOUD_ALPHA, HEADSET_PRODUCT_ID_HP_CLOUD_II_B, HEADSET_PRODUCT_ID_HP_CLOUD_STINGER_II};
+const int VENDORS_ARRAY[] = { HEADSET_VENDOR_ID_KINGSTON, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP, HEADSET_VENDOR_ID_HP};
+const int PRODUCTS_ARRAY[] = { HEADSET_PRODUCT_ID_KINGSTON_CLOUD_II, HEADSET_PRODUCT_ID_HP_CLOUD_II, HEADSET_PRODUCT_ID_HP_CLOUD_II_CORE, HEADSET_PRODUCT_ID_HP_CLOUD_ALPHA, HEADSET_PRODUCT_ID_HP_CLOUD_II_B, HEADSET_PRODUCT_ID_HP_CLOUD_STINGER_II, HEADSET_PRODUCT_ID_HP_CLOUD_III_S, HEADSET_PRODUCT_ID_HP_CLOUD_III_REV4106, HEADSET_PRODUCT_ID_HP_CLOUD_III_REV4109};
 
-hid_device_info* getHeadsetDeviceInfo();
+std::string getHeadsetDevicePath(); 
 int getBatteryLevel(hid_device*);
 
 
@@ -38,12 +41,19 @@ namespace Cloud2BatteryMonitorUI {
 	{
 	public:
 		System::Windows::Forms::Timer^ timerRefresh = gcnew System::Windows::Forms::Timer();
+
+		//a variable to hold offline icon permanently
+		System::Drawing::Icon^ defaultOfflineIcon;
+
 		MainForm(void)
 		{
 			InitializeComponent();
 			//
 			//TODO: Add the constructor code here
 			//
+			
+			//load the offline icon exactly once into memory
+			defaultOfflineIcon = System::Drawing::Icon::ExtractAssociatedIcon("icons\\headset_icon_light.ico");
 		}
 
 	protected:
@@ -56,7 +66,16 @@ namespace Cloud2BatteryMonitorUI {
 			{
 				delete components;
 			}
+
+			//dispose of the cached offline icon when the app closes
+			delete defaultOfflineIcon;
 		}
+	
+	//for cleaning the icon leak
+	private:
+			[System::Runtime::InteropServices::DllImportAttribute("user32.dll")]
+			static bool DestroyIcon(System::IntPtr handle);
+
 	private: System::Windows::Forms::Label^ lbStatus;
 	protected:
 	private: System::Windows::Forms::Label^ lbHeadsetInfoManu;
@@ -298,13 +317,12 @@ namespace Cloud2BatteryMonitorUI {
 
 	private: System::Void MainForm_Load(System::Object^ sender, System::EventArgs^ e) 
 	{
-		struct hid_device_info* cloud2DeviceInfo = getHeadsetDeviceInfo();
-
-
+		//gets the path as a string instead of hid_device_info* which caused memory leak every cycle
+		std::string devicePath = getHeadsetDevicePath();
 
-		if (cloud2DeviceInfo != NULL)
+		if (!devicePath.empty())
 		{
-			hid_device* headsetDevice = hid_open_path(cloud2DeviceInfo->path);
+			hid_device* headsetDevice = hid_open_path(devicePath.c_str());
 
 			if (headsetDevice != NULL) 
 			{
@@ -347,21 +365,25 @@ namespace Cloud2BatteryMonitorUI {
 				System::String^ batStr2 = gcnew System::String(to_string(batteryLevel).c_str());
 				System::String^ prodStr = gcnew System::String(productName);
 				RefreshTrayIcon(batStr2, prodStr);
+				
+				//close the connection only if it was opened.
+				hid_close(headsetDevice);
+
 			}
 			else 
 			{
 				this->iconSystemTray->Text = NO_DEVICE_STRING;
-				this->iconSystemTray->Icon = System::Drawing::Icon::ExtractAssociatedIcon("icons\\headset_icon_light.ico");
+				//use loaded offline icon
+				this->iconSystemTray->Icon = defaultOfflineIcon;
 				this->lbStatus->Text = "Could not connect to headset.";
 				this->btnRefresh->Visible = true;
 			}
-
-			hid_close(headsetDevice);
 		}
 		else 
 		{
 			this->iconSystemTray->Text = NO_DEVICE_STRING;
-			this->iconSystemTray->Icon = System::Drawing::Icon::ExtractAssociatedIcon("icons\\headset_icon_light.ico");
+			//use loaded offline icon
+			this->iconSystemTray->Icon = defaultOfflineIcon;
 			this->lbStatus->Text = "No headset device detected.";
 			this->btnRefresh->Visible = true;
 		}
@@ -419,27 +441,38 @@ namespace Cloud2BatteryMonitorUI {
 
 		if (battLvl > 0 && battLvl <= 100)
 		{
+			//a place to store the unmanaged handle
+			System::IntPtr hIcon;
+
 			if (settingsHelper->getBatIcon())
 			{
-				this->iconSystemTray->Icon = System::Drawing::Icon::FromHandle(RefreshTrayBattery(battLvl, settingsHelper));
+				//catch the handle from the Battery icon generator
+				hIcon = RefreshTrayBattery(battLvl, settingsHelper);
 			}
 			else
 			{
-				this->iconSystemTray->Icon = System::Drawing::Icon::FromHandle(RefreshTrayNumber(batteryLevel, settingsHelper));
+				//catch the handle from the Number icon generator
+				hIcon = RefreshTrayNumber(batteryLevel, settingsHelper);
 			}
 
+			//apply icon
+			this->iconSystemTray->Icon = System::Drawing::Icon::FromHandle(hIcon);
+
+			//destroy the unmanaged handle!
+			DestroyIcon(hIcon);
+
 			trayText += BATTERY_LEVEL_STRING + batteryLevel + "%";
 			this->iconSystemTray->Text = trayText;
 		}
 		else
 		{
 			trayText += BATTERY_LEVEL_STRING + "N/A";
 
-			this->iconSystemTray->Icon = System::Drawing::Icon::ExtractAssociatedIcon("icons\\headset_icon_light.ico");
+			//use loaded offline icon
+			this->iconSystemTray->Icon = defaultOfflineIcon;
 			this->iconSystemTray->Text = trayText;
 		}
 
-		delete trayText;
 		delete settingsHelper;
 	}
 
@@ -489,9 +522,11 @@ namespace Cloud2BatteryMonitorUI {
 		delete iconBrush;
 		delete iconFont;
 		delete iconGraphics;
-		delete strSize;
 
-		return textBitmap->GetHicon();
+		System::IntPtr hIcon = textBitmap->GetHicon(); // Extract the handle first
+		delete textBitmap; //dispose of the managed bitmap
+
+		return hIcon; //return the extracted handle
 	}
 
 	private: System::IntPtr RefreshTrayBattery(int battLvl, SettingsHelper* settingsHelper)
@@ -534,7 +569,10 @@ namespace Cloud2BatteryMonitorUI {
 		delete batGraphics;
 		delete batPen;
 
-		return batBitmap->GetHicon();
+		System::IntPtr hIcon = batBitmap->GetHicon(); // Extract the handle first
+		delete batBitmap; // Dispose of the managed bitmap
+
+		return hIcon; // Return the extracted handle
 	}
 
 	private: System::Void BtnRefresh_Click(System::Object^ sender, System::EventArgs^ e) 

Cloud2BatteryMonitorUI/SettingsHelper.cpp

@@ -32,7 +32,7 @@ void SettingsHelper::saveSettings()
         LONG key = RegOpenKeyExA(HKEY_CURRENT_USER, REG_KEY_PATH, 0, KEY_WRITE, &hkey);
         if (ERROR_SUCCESS == key) 
         {
-            key = RegSetValueExA(hkey, APP_NAME, 0, REG_SZ, (BYTE*)FP.c_str(), strlen(FP.c_str()));
+            key = RegSetValueExA(hkey, APP_NAME, 0, REG_SZ, (BYTE*)FP.c_str(), strlen(FP.c_str())+1);
         }
         RegCloseKey(hkey);
     }

Cloud2BatteryMonitorUI/icons/icon2.ico

@@ -0,0 +1,14 @@
+//{{NO_DEPENDENCIES}}
+// Microsoft Visual C++ generated include file.
+// Used by Cloud2BatteryMonitorUI1.rc
+
+// Next default values for new objects
+// 
+#ifdef APSTUDIO_INVOKED
+#ifndef APSTUDIO_READONLY_SYMBOLS
+#define _APS_NEXT_RESOURCE_VALUE        101
+#define _APS_NEXT_COMMAND_VALUE         40001
+#define _APS_NEXT_CONTROL_VALUE         1001
+#define _APS_NEXT_SYMED_VALUE           101
+#endif
+#endif

Cloud2BatteryMonitorUI/resource.h

@@ -15,6 +15,10 @@ The aim of the project is simple, to create a somewhat customizable battery moni
 
 **HP HyperX Cloud Stinger 2 Wireless**
 
+**HP HyperX Cloud III Wireless**
+
+**HP HyperX Cloud III S Wireless**
+
 If you would like a different Cloud Wireless headset supported, feel free to create an issue here on Github but beware that I will ask you for assistance (eg. Wireshark USB traffic recordings).
 
 ## Requirements
@@ -23,7 +27,7 @@ If you would like a different Cloud Wireless headset supported, feel free to cre
 
 ## How to install
 
-You can download [release v1.8 here](https://github.com/auto94/HyperX-Cloud-2-Battery-Monitor/releases/download/Release_v1.8/Cloud2BatteryMonitor_v1.8.zip) or select the latest release on the right side of this Github repository and download the zip. After the download is complete, extract the zip and run "Cloud2BatteryMonitorUI.exe". 
+You can download [release v2.1 here](https://github.com/elazarit/HyperX-Cloud-2-Battery-Monitor/releases/download/v2.1/HyperX-Cloud-2-Battery-Monitor-2.1.zip) or select the latest release on the right side of this Github repository and download the zip. After the download is complete, extract the zip and run "Cloud2BatteryMonitorUI.exe". 
 
 No installation is necessary.
 
@@ -89,6 +93,8 @@ A: Basically I used wireshark to find the data and responses which had the batte
 | HP | HyperX Cloud II Core Wireless | v1.4+ | Windows 10
 | HP | HyperX Cloud Alpha Wireless | v1.5+ | Unknown
 | HP | HyperX Cloud Stinger 2 Wireless | v1.8+ | Unknown
+| HP | HyperX Cloud III S Wireless | v2.0+ | Unknown
+| HP | HyperX Cloud III Wireless | v2.02+ | Unknown
 
 
 ## Special thanks