Merge pull request #80 from d4rken-org/compatibility_options

Improve compatibility options
2026-09-15 02:36:12 -04:00 · 2023-01-25 14:56:10 +01:00
parent 6e8693a6b0 6d9e7404a1
commit 5d44737199
9 changed files with 161 additions and 112 deletions
@@ -29,24 +29,40 @@ class BleScanner @Inject constructor(

    @SuppressLint("MissingPermission") fun scan(
        filters: Set<ScanFilter>,
-        scannerMode: ScannerMode,
-        compatMode: Boolean,
-    ): Flow<List<BleScanResult>> = callbackFlow {
-        log(TAG, VERBOSE) { "scan(filters=$filters, scannerMode=$scannerMode, compatMode=$compatMode)" }
-        if (compatMode) log(TAG, WARN) { "Using compatibilityMode!" }
+        scannerMode: ScannerMode = ScannerMode.BALANCED,
+        offloadFiltering: Boolean = true,
+        offloadBatching: Boolean = true,
+    ): Flow<Collection<BleScanResult>> = callbackFlow {
+        log(TAG) { "scan(filters=$filters, scannerMode=$scannerMode)" }

        val adapter = bluetoothManager.adapter ?: throw IllegalStateException("Bluetooth adapter unavailable")

-        val supportsOffloadFiltering = adapter.isOffloadedFilteringSupported.also {
+        val useOffloadedFiltering = adapter.isOffloadedFilteringSupported.also {
            log(TAG, if (it) DEBUG else WARN) { "isOffloadedFilteringSupported=$it" }
-        } && !compatMode
+        } && offloadFiltering
+        if (!offloadFiltering) log(TAG, WARN) { "Offloaded filtering is disabled!" }

-        val supportsOffloadBatching = adapter.isOffloadedScanBatchingSupported.also {
+        val useOffloadedBatching = adapter.isOffloadedScanBatchingSupported.also {
            log(TAG, if (it) DEBUG else WARN) { "isOffloadedScanBatchingSupported=$it" }
-        } && !compatMode
+        } && offloadBatching
+        if (!offloadBatching) log(TAG, WARN) { "Offloaded scan-batching is disabled!" }

        val scanner = bluetoothManager.scanner ?: throw IllegalStateException("BLE scanner unavailable")

+        val resultFilter: (Collection<ScanResult>) -> Collection<BleScanResult> = { results ->
+            results
+                .filter { result ->
+                    val passed = when {
+                        useOffloadedFiltering -> true
+                        filters.isEmpty() -> true
+                        else -> filters.any { it.matches(result) }
+                    }
+                    if (!passed) log(TAG, VERBOSE) { "Manually filtered $result" }
+                    passed
+                }
+                .map { BleScanResult.fromScanResult(it) }
+        }
+
        val callback = object : ScanCallback() {
            var lastScanAt = System.currentTimeMillis()
            override fun onScanResult(callbackType: Int, result: ScanResult) {
@@ -55,17 +71,8 @@ class BleScanner @Inject constructor(
                    lastScanAt = System.currentTimeMillis()
                    "onScanResult(delay=${delay}ms, callbackType=$callbackType, result=$result)"
                }
-                val toSend = if (
-                    supportsOffloadFiltering
-                    || filters.isEmpty()
-                    || filters.any { it.matchesSafe(result) }
-                ) {
-                    listOf(BleScanResult.fromScanResult(result))
-                } else {
-                    log(TAG, VERBOSE) { "Manual filtering: No match for $result" }
-                    emptyList()
-                }
-                trySend(toSend)
+
+                trySend(resultFilter(setOf(result)))
            }

            override fun onBatchScanResults(results: MutableList<ScanResult>) {
@@ -75,18 +82,7 @@ class BleScanner @Inject constructor(
                    "onBatchScanResults(delay=${delay}ms, results=$results)"
                }

-                val toSend = results
-                    .filter { result ->
-                        val passed = when {
-                            supportsOffloadFiltering -> true
-                            filters.isEmpty() -> true
-                            else -> filters.any { it.matches(result) }
-                        }
-                        if (!passed) log(TAG, VERBOSE) { "Manually filtered $result" }
-                        passed
-                    }
-                    .map { BleScanResult.fromScanResult(it) }
-                trySend(toSend)
+                trySend(resultFilter(results))
            }

            override fun onScanFailed(errorCode: Int) {
@@ -94,48 +90,60 @@ class BleScanner @Inject constructor(
            }
        }

-
-        val settings = ScanSettings.Builder().apply {
-            setScanMode(
-                when (scannerMode) {
-                    ScannerMode.LOW_POWER -> ScanSettings.SCAN_MODE_LOW_POWER
-                    ScannerMode.BALANCED -> ScanSettings.SCAN_MODE_BALANCED
-                    ScannerMode.LOW_LATENCY -> ScanSettings.SCAN_MODE_LOW_LATENCY
+        val scanSettings = ScanSettings.Builder().apply {
+            setCallbackType(ScanSettings.CALLBACK_TYPE_ALL_MATCHES)
+            when (scannerMode) {
+                ScannerMode.LOW_POWER -> {
+                    setScanMode(ScanSettings.SCAN_MODE_LOW_POWER)
+                    setMatchMode(ScanSettings.MATCH_MODE_STICKY)
+                    setNumOfMatches(ScanSettings.MATCH_NUM_FEW_ADVERTISEMENT)
+                }
+                ScannerMode.BALANCED -> {
+                    setScanMode(ScanSettings.SCAN_MODE_BALANCED)
+                    setMatchMode(ScanSettings.MATCH_MODE_STICKY)
+                    setNumOfMatches(ScanSettings.MATCH_NUM_FEW_ADVERTISEMENT)
+                }
+                ScannerMode.LOW_LATENCY -> {
+                    setScanMode(ScanSettings.SCAN_MODE_LOW_LATENCY)
+                    setMatchMode(ScanSettings.MATCH_MODE_AGGRESSIVE)
+                    setNumOfMatches(ScanSettings.MATCH_NUM_MAX_ADVERTISEMENT)
                }
-            )
-            if (supportsOffloadBatching) {
-                setReportDelay(
-                    when (scannerMode) {
-                        ScannerMode.LOW_POWER -> 2000L
-                        ScannerMode.BALANCED -> 1000L
-                        ScannerMode.LOW_LATENCY -> 500L
-                    }
-                )
            }
+
+            val delay = if (useOffloadedBatching) {
+                when (scannerMode) {
+                    ScannerMode.LOW_POWER -> 2000L
+                    ScannerMode.BALANCED -> 1000L
+                    ScannerMode.LOW_LATENCY -> 500L
+                }
+            } else {
+                0L // Anything > 0 enables batching
+            }
+            setReportDelay(delay)
        }.build()

-        log(TAG, VERBOSE) { "Settings created for offloaded filtering: $settings" }

        val flushJob = launch {
            log(TAG) { "Flush job launched" }
            while (isActive) {
-                // Can undercut the minimum setReportDelay(), e.g. 5000ms on a Pixel5@12
                log(TAG, VERBOSE) { "Flushing scan results." }
+                // Can undercut the minimum setReportDelay(), e.g. 5000ms on a Pixel5@12
                adapter.bluetoothLeScanner.flushPendingScanResults(callback)
                when (scannerMode) {
                    ScannerMode.LOW_POWER -> break
-                    ScannerMode.BALANCED -> delay(1000)
+                    ScannerMode.BALANCED -> delay(2000)
                    ScannerMode.LOW_LATENCY -> delay(500)
                }
            }
        }

-        scanner.startScan(
-            if (supportsOffloadFiltering) filters.toList() else listOf(ScanFilter.Builder().build()),
-            settings,
-            callback
-        )
-        log(TAG) { "BleScanner started (filters=$filters, settings=$settings)" }
+        log(TAG) { "startScan(filters=$filters, settings=$scanSettings, callback=$callback)" }
+        val filterList = when {
+            useOffloadedFiltering -> filters.toList()
+            else -> emptyList()
+        }
+
+        scanner.startScan(filterList, scanSettings, callback)

        awaitClose {
            flushJob.cancel()
@@ -12,7 +12,7 @@ class FakeBleData @Inject constructor(
    private val debugSettings: DebugSettings,
 ) {

-    fun maybeAddfakeData(originals: List<BleScanResult>): List<BleScanResult> {
+    fun maybeAddfakeData(originals: Collection<BleScanResult>): Collection<BleScanResult> {
        if (!debugSettings.showFakeData.value) return originals
        return originals + getFakeData()
    }
@@ -23,51 +23,28 @@ class GeneralSettings @Inject constructor(

    override val preferences: SharedPreferences = context.getSharedPreferences("settings_general", Context.MODE_PRIVATE)

-    val monitorMode = preferences.createFlowPreference(
-        "core.monitor.mode",
-        MonitorMode.AUTOMATIC,
-        moshi
-    )
+    val monitorMode = preferences.createFlowPreference("core.monitor.mode", MonitorMode.AUTOMATIC, moshi)
+    val scannerMode = preferences.createFlowPreference("core.scanner.mode", ScannerMode.BALANCED, moshi)

-    val scannerMode = preferences.createFlowPreference(
-        "core.scanner.mode",
-        ScannerMode.LOW_LATENCY,
-        moshi
-    )
+    val showAll = preferences.createFlowPreference("core.showall.enabled", false)

-    val compatibilityMode = preferences.createFlowPreference(
-        "core.compatibility.enabled",
-        false
-    )
+    val minimumSignalQuality = preferences.createFlowPreference("core.signal.minimum", 0.25f)

-    val showAll = preferences.createFlowPreference(
-        "core.showall.enabled",
-        false
-    )
+    val mainDeviceAddress = preferences.createFlowPreference<String?>("core.maindevice.address", null)
+    val mainDeviceModel = preferences.createFlowPreference("core.maindevice.model", PodDevice.Model.UNKNOWN, moshi)

-    val minimumSignalQuality = preferences.createFlowPreference(
-        "core.signal.minimum",
-        0.25f
-    )
-
-    val mainDeviceAddress = preferences.createFlowPreference<String?>(
-        "core.maindevice.address",
-        null
-    )
-
-    val mainDeviceModel = preferences.createFlowPreference<PodDevice.Model>(
-        "core.maindevice.model",
-        PodDevice.Model.UNKNOWN,
-        moshi
-    )
+    val isOffloadedFilteringDisabled =
+        preferences.createFlowPreference("core.compat.offloaded.filtering.disabled", false)
+    val isOffloadedBatchingDisabled = preferences.createFlowPreference("core.compat.offloaded.batching.disabled", false)

    override val preferenceDataStore: PreferenceDataStore = PreferenceStoreMapper(
        monitorMode,
        scannerMode,
-        compatibilityMode,
        showAll,
        minimumSignalQuality,
        mainDeviceAddress,
+        isOffloadedFilteringDisabled,
+        isOffloadedBatchingDisabled,
        debugSettings.isAutoReportingEnabled,
    )
 }
@@ -4,6 +4,7 @@ import android.bluetooth.le.ScanFilter
 import eu.darken.capod.common.bluetooth.BleScanResult
 import eu.darken.capod.common.bluetooth.BleScanner
 import eu.darken.capod.common.bluetooth.BluetoothManager2
+import eu.darken.capod.common.bluetooth.ScannerMode
 import eu.darken.capod.common.coroutine.AppScope
 import eu.darken.capod.common.debug.autoreport.DebugSettings
 import eu.darken.capod.common.debug.logging.Logging.Priority.VERBOSE
@@ -83,26 +84,40 @@ class PodMonitor @Inject constructor(
        .setupCommonEventHandlers(TAG) { "mainDevice" }
        .replayingShare(appScope)

+    private data class ScannerOptions(
+        val scannerMode: ScannerMode,
+        val showUnfiltered: Boolean,
+        val offloadedFilteringDisabled: Boolean,
+        val offloadedBatchingDisabled: Boolean
+    )
+
    private fun createBleScanner() = combine(
        generalSettings.scannerMode.flow,
-        generalSettings.compatibilityMode.flow,
-        debugSettings.showUnfiltered.flow
-    ) { scannerMode, compatMode, unfiltered ->
-        Triple(scannerMode, compatMode, unfiltered)
+        debugSettings.showUnfiltered.flow,
+        generalSettings.isOffloadedBatchingDisabled.flow,
+        generalSettings.isOffloadedFilteringDisabled.flow,
+    ) { scannermode, showUnfiltered, isOffloadedBatchingDisabled, isOffloadedFilteringDisabled ->
+        ScannerOptions(
+            scannerMode = scannermode,
+            showUnfiltered = showUnfiltered,
+            offloadedFilteringDisabled = isOffloadedFilteringDisabled,
+            offloadedBatchingDisabled = isOffloadedBatchingDisabled,
+        )
    }
-        .flatMapLatest { (mode, compat, unfiltered) ->
+        .flatMapLatest { options ->
            val filters = when {
-                unfiltered -> {
+                options.showUnfiltered -> {
                    log(TAG, WARN) { "Using unfiltered scan mode" }
-                    setOf(getUnfilteredFilter())
+                    setOf(ScanFilter.Builder().build())
                }
                else -> ProximityPairing.getBleScanFilter()
            }

            bleScanner.scan(
                filters = filters,
-                scannerMode = mode,
-                compatMode = compat,
+                scannerMode = options.scannerMode,
+                offloadFiltering = !options.offloadedFilteringDisabled,
+                offloadBatching = !options.offloadedBatchingDisabled
            ).map { preFilterAndMap(it) }
        }

@@ -134,7 +149,7 @@ class PodMonitor @Inject constructor(
        return pods
    }

-    private suspend fun preFilterAndMap(rawResults: List<BleScanResult>): List<PodFactory.Result> = rawResults
+    private suspend fun preFilterAndMap(rawResults: Collection<BleScanResult>): List<PodFactory.Result> = rawResults
        .groupBy { it.address }
        .values
        .map { sameAdrDevs ->
@@ -187,10 +202,6 @@ class PodMonitor @Inject constructor(
            .also { log(TAG) { "Cached mainDevice is $it" } }
    }

-    private fun getUnfilteredFilter(): ScanFilter {
-        return ScanFilter.Builder().build()
-    }
-
    companion object {
        private val TAG = logTag("Monitor", "PodMonitor")
    }
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="?attr/colorControlNormal">
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M6,4H18V5H21V7H18V9H21V11H18V13H21V15H18V17H21V19H18V20H6V19H3V17H6V15H3V13H6V11H3V9H6V7H3V5H6V4M11,15V18H12V15H11M13,15V18H14V15H13M15,15V18H16V15H15Z" />
+</vector>
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:tint="?attr/colorControlNormal"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M22.77 19.32L21.7 18.5C21.72 18.33 21.74 18.17 21.74 18S21.73 17.67 21.7 17.5L22.76 16.68C22.85 16.6 22.88 16.47 22.82 16.36L21.82 14.63C21.76 14.5 21.63 14.5 21.5 14.5L20.27 15C20 14.82 19.73 14.65 19.42 14.53L19.23 13.21C19.22 13.09 19.11 13 19 13H17C16.87 13 16.76 13.09 16.74 13.21L16.55 14.53C16.25 14.66 15.96 14.82 15.7 15L14.46 14.5C14.35 14.5 14.22 14.5 14.15 14.63L13.15 16.36C13.09 16.47 13.11 16.6 13.21 16.68L14.27 17.5C14.25 17.67 14.24 17.83 14.24 18S14.25 18.33 14.27 18.5L13.21 19.32C13.12 19.4 13.09 19.53 13.15 19.64L14.15 21.37C14.21 21.5 14.34 21.5 14.46 21.5L15.7 21C15.96 21.18 16.24 21.35 16.55 21.47L16.74 22.79C16.76 22.91 16.86 23 17 23H19C19.11 23 19.22 22.91 19.24 22.79L19.43 21.47C19.73 21.34 20 21.18 20.27 21L21.5 21.5C21.63 21.5 21.76 21.5 21.83 21.37L22.83 19.64C22.89 19.53 22.86 19.4 22.77 19.32M18 19.5C17.16 19.5 16.5 18.83 16.5 18S17.17 16.5 18 16.5 19.5 17.17 19.5 18 18.83 19.5 18 19.5M17.62 3.22C17.43 3.08 17.22 3 17 3H3C2.78 3 2.57 3.08 2.38 3.22C1.95 3.56 1.87 4.19 2.21 4.62L7 10.75V15.87C6.96 16.16 7.06 16.47 7.29 16.7L11.3 20.71C11.4 20.81 11.5 20.88 11.65 20.93C11.22 20 11 19 11 18C11 16.17 11.72 14.41 13 13.1V10.75L17.79 4.62C18.13 4.19 18.05 3.56 17.62 3.22M11 10.05V17.58L9 15.58V10.06L5.04 5H14.96L11 10.05Z" />
+</vector>
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:tint="?attr/colorControlNormal"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M5 5V19H7V21H3V3H7V5H5M20 7H7V9H20V7M20 11H7V13H20V11M20 15H7V17H20V15Z" />
+</vector>
@@ -33,6 +33,14 @@
    <string name="settings_reaction_label">Reactions</string>
    <string name="settings_reaction_description">React to events and behaviors.</string>
    <string name="settings_category_yourdevice_label">Your device</string>
+
+    <string name="settings_category_compatibility_options_title">Compatibility options</string>
+    <string name="settings_category_compatibility_options_description">Don\'t touch if everything works ;)</string>
+    <string name="settings_compat_offloaded_filtering_disabled_title">Disable hardware filtering</string>
+    <string name="settings_compat_offloaded_filtering_disabled_summary">Don\'t delegate data filtering to the system, instead get all data and filter within the app.</string>
+    <string name="settings_compat_offloaded_batching_disabled_title">Disable hardware batching</string>
+    <string name="settings_compat_offloaded_batching_disabled_summary">Don\'t let the system group collected BLE data before forwarding it to us.</string>
+
    <string name="settings_maindevice_address_label">Your device address</string>
    <string name="settings_maindevice_address_description">The address of your paired device. The app uses this to determine when it is connected to your phone.</string>
    <string name="settings_maindevice_address_none">None</string>
@@ -43,6 +51,7 @@
    <string name="settings_onepod_mode_label">One pod mode</string>
    <string name="settings_onepod_mode_description">Wearing both pods is not required, wearing a single pod is sufficient to trigger reactions.</string>

+
    <string name="notification_channel_device_status_label">Device status</string>

    <string name="debug_debuglog_size_label">Size</string>
@@ -14,12 +14,6 @@
        android:summary="@string/settings_scanner_mode_description"
        android:title="@string/settings_scanner_mode_label" />

-    <CheckBoxPreference
-        android:icon="@drawable/ic_baseline_ghost_24"
-        android:key="core.compatibility.enabled"
-        android:summary="@string/settings_compatibility_mode_description"
-        android:title="@string/settings_compatibility_mode_label" />
-
    <CheckBoxPreference
        android:icon="@drawable/ic_baseline_devices_other_24"
        android:key="core.showall.enabled"
@@ -49,6 +43,26 @@
            android:title="@string/settings_maindevice_model_label" />
    </PreferenceCategory>

+    <PreferenceCategory
+        android:singleLineTitle="false"
+        android:summary="@string/settings_category_compatibility_options_description"
+        android:title="@string/settings_category_compatibility_options_title"
+        app:icon="@drawable/ic_chip_24">
+
+        <CheckBoxPreference
+            android:icon="@drawable/ic_filter_cog_outline_24"
+            android:key="core.compat.offloaded.filtering.disabled"
+            android:summary="@string/settings_compat_offloaded_filtering_disabled_summary"
+            android:title="@string/settings_compat_offloaded_filtering_disabled_title" />
+
+        <CheckBoxPreference
+            android:icon="@drawable/ic_format_list_group_24"
+            android:key="core.compat.offloaded.batching.disabled"
+            android:summary="@string/settings_compat_offloaded_batching_disabled_summary"
+            android:title="@string/settings_compat_offloaded_batching_disabled_title" />
+
+    </PreferenceCategory>
+
    <PreferenceCategory android:title="@string/settings_category_other_label">
        <Preference
            android:fragment="eu.darken.capod.main.ui.settings.general.debug.DebugSettingsFragment"