Add functionality to Connect and Disconnect audio Bluetooth devices

Author: PolarGoose

.editorconfig

@@ -7,6 +7,7 @@ insert_final_newline = true
 charset = utf-8
 indent_style = space
 indent_size = 4
+max_line_length = 150
 
 [*.{xml,wxs,csproj,yaml,props,config}]
 indent_size = 2

.github/workflows/continuous-integration-workflow.yaml

@@ -0,0 +1,17 @@
+on: push
+
+jobs:
+  build:
+    runs-on: windows-2022
+    steps:
+      - uses: actions/checkout@v4
+      - run: ./build.ps1
+      - uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          draft: true
+          files: build/Publish/*.zip
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Build artifacts
+          path: build/Publish/*.zip

.github/workflows/main.yaml

@@ -2,3 +2,4 @@
 .vs/
 /src/FodyWeavers.xsd
 /.idea
+launchSettings.json

.gitignore

@@ -9,8 +9,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Files", "Files", "{F4EA3749
 		.editorconfig = .editorconfig
 		.gitattributes = .gitattributes
 		.gitignore = .gitignore
-		.github\workflows\build.ps1 = .github\workflows\build.ps1
-		.github\workflows\continuous-integration-workflow.yaml = .github\workflows\continuous-integration-workflow.yaml
+		build.ps1 = build.ps1
+		.github\workflows\main.yaml = .github\workflows\main.yaml
 		README.md = README.md
 	EndProjectSection
 EndProject

BluetoothDevicePairing.sln

@@ -1,11 +1,10 @@
 # BluetoothDevicePairing
 Console utility to discover and pair Bluetooth and Bluetooth Low Energy devices.
-
-# Note on connecting to Bluetooth devices
-If you pair a device that is not already paired, the utility will also connect to it (this is the default behavior of Windows Bluetooth API)<br>
-However, the pairing will fail if a device is paired but not connected.<br>
-Unfortunately, it is impossible to simulate what the "Connect" button from Windows `Bluetooth and Other devices` dialog does.
-More details can be found here: [How to connect to a paired audio Bluetooth device](https://stackoverflow.com/questions/62502414/how-to-connect-to-a-paired-audio-bluetooth-device-using-windows-uwp-api). Specifically, [here](https://github.com/inthehand/32feet/issues/132#issuecomment-1019786324) I have described my failed attempts to implement this functionality.<br>
+The utility also allows to connect and disconnect from audio Bluetooth devices.
+* If you pair a device that is not already paired, the utility will also connect to it (this is the default behavior of Windows Bluetooth API)<br>
+* If you pair to an already paired audio Bluetooth device, the utility will connect to it.
+* Managing Bluetooth devices by mac is much faster than by name, because it doesn't require device discovery.
+* When managing Bluetooth devices by name, you can use the `--discovery-time` parameter to change the time spend on device discovery.
 
 # System requirements
 Windows 10 1809 (10.0.17763) or higher
@@ -47,6 +46,14 @@ BluetoothDevicePairing.exe unpair-by-name --name "MX Ergo" --type BluetoothLE
 ```
 BluetoothDevicePairing.exe list-adapters
 ```
+* Disconnect an audio device using its Mac address:
+```
+BluetoothDevicePairing.exe disconnect-bluetooth-audio-device-by-name --name WH-1000XM5
+```
+* Disconnect to an audio device using its name:
+```
+BluetoothDevicePairing.exe disconnect-bluetooth-audio-device-by-mac --mac 88:c9:e8:17:5e:0f
+```
 
 # Examples of scripts
 The BluetoothDevicePairing utility can be used in bat and PowerShell scripts.
@@ -70,11 +77,6 @@ if %ErrorLevel% NEQ 0 (
 )
 ```
 
-# How it works
-The program uses
-* [Windows.Devices.Enumeration API](https://docs.microsoft.com/en-us/uwp/api/Windows.Devices.Enumeration?redirectedfrom=MSDN&view=winrt-22000) to work with Bluetooth.
-* [Costura Fody](https://github.com/Fody/Costura) to create a single file executable.
-
 ### Device pairing by name
 To pair a device by name, the utility starts by discovering all available devices and tries to find a device with the required name. After a device is found, its Mac address is used to request pairing. The command will fail if there are several devices with the same name.
 
@@ -83,8 +85,9 @@ If the command fails, it returns the value `-1`. If it succeeds, it returns `0`.
 
 # Build
 * Use `Visual Studio 2022` to open the solution file and work with the code
-* Run `.github/workflows/build.ps1` to build a release (to run this script, `git.exe` should be in your PATH)
+* Run `build.ps1` to build a release (to run this script, `git.exe` should be in your PATH)
 
 # References
 * [Windows.Devices.Enumeration API usage examples](https://github.com/microsoft/Windows-universal-samples/tree/master/Samples/DeviceEnumerationAndPairing)
 * [Windows.Devices.Enumeration Namespace](https://docs.microsoft.com/en-us/uwp/api/Windows.Devices.Enumeration)
+* [ToothTray](https://github.com/m2jean/ToothTray/tree/master) - reference implementation of connecting to Bluetooth audio devices

README.md

@@ -40,29 +40,24 @@ Function ForceCopy($file, $dstFolder) {
     Copy-Item $buildResultExecutable -Destination $publishFolder -Force
 }
 
-Function Build($slnFile, $version) {
-    Info "Run 'dotnet build' command: `n slnFile=$slnFile `n version='$version'"
-
-    $Env:DOTNET_NOLOGO = "true"
-    $Env:DOTNET_CLI_TELEMETRY_OPTOUT = "true"
-    dotnet build `
-        --configuration Release `
-        /property:DebugType=None `
-        /property:Version=$version `
-        $slnFile
-    CheckReturnCodeOfPreviousCommand "'dotnet build' command failed"
-}
-
 Set-StrictMode -Version Latest
 $ErrorActionPreference = "Stop"
 
-$root = Resolve-Path "$PSScriptRoot/../.."
+$root = Resolve-Path "$PSScriptRoot"
 $buildRoot = "$root/build"
 $buildResultsFolder = "$buildRoot/Release/net472"
 $projectName = "BluetoothDevicePairing"
 $buildResultExecutable = "$buildResultsFolder/$projectName.exe"
 $publishFolder = "$buildRoot/Publish"
+$version = GetVersion
+
+Info "Run 'dotnet build'. version=$version"
+dotnet build `
+    --configuration Release `
+    /property:DebugType=None `
+    /property:Version=$version `
+    $root/BluetoothDevicePairing.sln
+CheckReturnCodeOfPreviousCommand "'dotnet build' command failed"
 
-Build -slnFile $root/$projectName.sln -version (GetVersion)
 ForceCopy $buildResultExecutable $publishFolder
-CreateZipArchive "$publishFolder/${projectName}.exe" "$publishFolder/${projectName}.zip"
+CreateZipArchive $publishFolder/BluetoothDevicePairing.exe $publishFolder/BluetoothDevicePairing.zip

.github/workflows/build.ps1 build.ps1.github/workflows/build.ps1 renamed to build.ps1

@@ -0,0 +1,47 @@
+using System;
+using System.Runtime.InteropServices;
+using Vanara.PInvoke;
+using static Vanara.PInvoke.CoreAudio;
+
+namespace BluetoothDevicePairing.Bluetooth.Devices.AudioDevices;
+
+internal sealed class AudioDevice
+{
+    private readonly IKsControl ksControl;
+
+    public string Name { get; }
+    private string Id { get; }
+    public Guid ContainerId { get; }
+    public bool IsConnected { get; }
+
+    public AudioDevice(IMMDevice device, IKsControl ksControl)
+    {
+        this.ksControl = ksControl;
+
+        Id = device.GetId();
+        IsConnected = device.GetState() == DEVICE_STATE.DEVICE_STATE_ACTIVE;
+
+        var propertyStore = device.OpenPropertyStore(STGM.STGM_READ);
+        Name = (string)propertyStore.GetValue(DeviceProperties.PKEY_Device_FriendlyName);
+        ContainerId = (Guid)propertyStore.GetValue(Ole32.PROPERTYKEY.System.Devices.ContainerId);
+    }
+
+    public void Connect()
+    {
+        Console.WriteLine($"Request to connect audio device '{Name}'");
+        GetKsProperty(KSPROPERTY_BTAUDIO.KSPROPERTY_ONESHOT_RECONNECT);
+    }
+
+    public void Disconnect()
+    {
+        Console.WriteLine($"Request to disconnect audio device '{Name}'");
+        GetKsProperty(KSPROPERTY_BTAUDIO.KSPROPERTY_ONESHOT_DISCONNECT);
+    }
+
+    private void GetKsProperty(KSPROPERTY_BTAUDIO btAudioProperty)
+    {
+        var ksProperty = new KsProperty(KsPropertyId.KSPROPSETID_BtAudio, btAudioProperty, KsPropertyKind.KSPROPERTY_TYPE_GET);
+        var dwReturned = 0;
+        ksControl.KsProperty(ksProperty, Marshal.SizeOf(ksProperty), IntPtr.Zero, 0, ref dwReturned);
+    }
+}

src/Bluetooth/Devices/AudioDevices/AudioDevice.cs

@@ -0,0 +1,94 @@
+using static Vanara.PInvoke.CoreAudio;
+using System;
+using Vanara.PInvoke;
+using System.Collections.Generic;
+
+namespace BluetoothDevicePairing.Bluetooth.Devices.AudioDevices;
+
+internal static class AudioDeviceEnumerator
+{
+    static readonly Dictionary<Guid, List<AudioDevice>> audioDevices = [];
+
+    static AudioDeviceEnumerator()
+    {
+        var audioEndpointsEnumerator = new IMMDeviceEnumerator();
+        foreach (var audioEndPoint in EnumerateAudioEndpoints(audioEndpointsEnumerator))
+        {
+            foreach (var connector in EnumerateConnectors(audioEndPoint))
+            {
+                var connectedToPart = connector.TryGetConnectedToPart();
+                if (connectedToPart is null)
+                {
+                    continue;
+                }
+
+                var connectedToDeviceId = (string)connectedToPart.GetTopologyObject().GetDeviceId();
+                if (!connectedToDeviceId.StartsWith(@"{2}.\\?\bth"))
+                {
+                    continue;
+                }
+
+                var connectedToDevice = audioEndpointsEnumerator.GetDevice(connectedToDeviceId);
+                var ksControl = Activate<IKsControl>(connectedToDevice);
+                AddToDevicesDictionary(new AudioDevice(audioEndPoint, ksControl));
+            }
+        }
+    }
+
+    public static IEnumerable<AudioDevice> GetAudioDevices(Guid containerId)
+    {
+        if (!audioDevices.TryGetValue(containerId, out var value))
+        {
+            return [];
+        }
+
+        return value;
+    }
+
+    private static void AddToDevicesDictionary(AudioDevice audioDevice)
+    {
+        if (!audioDevices.ContainsKey(audioDevice.ContainerId))
+        {
+            audioDevices[audioDevice.ContainerId] = [];
+        }
+
+        audioDevices[audioDevice.ContainerId].Add(audioDevice);
+    }
+
+    private static IEnumerable<IMMDevice> EnumerateAudioEndpoints(IMMDeviceEnumerator enumerator)
+    {
+        var deviceCollection = enumerator.EnumAudioEndpoints(EDataFlow.eAll, DEVICE_STATE.DEVICE_STATEMASK_ALL);
+        for (uint i = 0; i < deviceCollection.GetCount(); i++)
+        {
+            deviceCollection.Item(i, out var device);
+            yield return device;
+        }
+    }
+
+    private static IEnumerable<IConnector> EnumerateConnectors(IMMDevice audioEndPoint)
+    {
+        var topology = Activate<IDeviceTopology>(audioEndPoint);
+        for (uint i = 0; i < topology.GetConnectorCount(); i++)
+        {
+            yield return topology.GetConnector(i);
+        }
+    }
+
+    private static IPart TryGetConnectedToPart(this IConnector connector)
+    {
+        try
+        {
+            return (IPart)connector.GetConnectedTo();
+        }
+        catch (Exception)
+        {
+            return null;
+        }
+    }
+
+    private static T Activate<T>(IMMDevice device)
+    {
+        device.Activate(typeof(T).GUID, Ole32.CLSCTX.CLSCTX_ALL, null, out var itf);
+        return (T)itf;
+    }
+}

src/Bluetooth/Devices/AudioDevices/AudioDeviceEnumerator.cs

@@ -0,0 +1,66 @@
+using System.Runtime.InteropServices;
+using System.Security;
+using System;
+using Vanara.PInvoke;
+
+namespace BluetoothDevicePairing.Bluetooth.Devices.AudioDevices;
+
+public static class DeviceProperties
+{
+    // https://github.com/microsoft/win32metadata/blob/main/generation/WinSDK/RecompiledIdlHeaders/um/functiondiscoverykeys_devpkey.h#L62
+    public static Ole32.PROPERTYKEY PKEY_Device_FriendlyName = new(new("{a45c254e-df1c-4efd-8020-67d146a850e0}"), 14u);
+}
+
+public enum KsPropertyKind : uint
+{
+    KSPROPERTY_TYPE_GET = 0x00000001,
+    KSPROPERTY_TYPE_SET = 0x00000002,
+    KSPROPERTY_TYPE_TOPOLOGY = 0x10000000
+}
+
+public enum KSPROPERTY_BTAUDIO : uint
+{
+    KSPROPERTY_ONESHOT_RECONNECT = 0,
+    KSPROPERTY_ONESHOT_DISCONNECT = 1
+}
+
+public static class KsPropertyId
+{
+    public static readonly Guid KSPROPSETID_BtAudio = new("7fa06c40-b8f6-4c7e-8556-e8c33a12e54d");
+}
+
+[StructLayout(LayoutKind.Sequential)]
+public readonly struct KsProperty(Guid set, KSPROPERTY_BTAUDIO id, KsPropertyKind flags)
+{
+    public Guid Set { get; } = set;
+    public KSPROPERTY_BTAUDIO Id { get; } = id;
+    public KsPropertyKind Flags { get; } = flags;
+}
+
+[ComImport, SuppressUnmanagedCodeSecurity, Guid("28F54685-06FD-11D2-B27A-00A0C9223196"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
+public interface IKsControl
+{
+    [PreserveSig]
+    int KsProperty(
+      [In] ref KsProperty Property,
+      [In] int PropertyLength,
+      [In, Out] IntPtr PropertyData,
+      [In] int DataLength,
+      [In, Out] ref int BytesReturned);
+
+    [PreserveSig]
+    int KsMethod(
+      [In] ref KsProperty Method,
+      [In] int MethodLength,
+      [In, Out] IntPtr MethodData,
+      [In] int DataLength,
+      [In, Out] ref int BytesReturned);
+
+    [PreserveSig]
+    int KsEvent(
+      [In, Optional] ref KsProperty Event,
+      [In] int EventLength,
+      [In, Out] IntPtr EventData,
+      [In] int DataLength,
+      [In, Out] ref int BytesReturned);
+}