Support audiograms

Readme.md

@@ -225,7 +225,7 @@ There are many sample tables in the database, and all appear to be linked by the
 |---|---|
 `account_owner_samples` | ❌
 `allergy_record_samples` | ❌
-`binary_samples` | ✅
+`binary_samples` | ✅ (Heartbeat series, audiograms)
 `category_samples` | ✅
 `clinical_note_record_samples` | ❌
 `clinical_record_samples` | ❌
@@ -309,6 +309,17 @@ The meaning of the last seven bytes is currently unknown.
 Most of these values are zeroes, but occasionally there are values like `0xa770270`, `0x57ef26`, `0xd7ab25`, `0xd65b15`, or `0x573e26`.
 These values have no apparent meaning, and can occur with both `true` or `false` for `isPrecededByGap`.
 
+### Audiograms
+
+Stored `HKAudiogramSample`s can also be queried.
+
+```swift
+let samples: [HKAudiogramSample] = try db.audiograms(from: start, to: end)
+```
+
+Like heartbeat series data, the binary data associated with each sample is stored in `binary_samples`.
+The `payload` column consists of an array of `HKAudiogramSensitivityPoint`s, encoded with an `NSKeyedArchiver`.
+
 ### Workouts
 
 Workouts can be queried from the database similar to other samples:

Sources/HealthDB/Database/HKDatabaseStore.swift

@@ -4,6 +4,8 @@ import CoreLocation
 import HealthKit
 import HealthKitExtensions
 
+typealias ObjectData = (dataId: Int, startDate: Date, endDate: Date, uuid: UUID, device: HKDevice?, metadata: [String : Any])
+
 public final class HKDatabaseStore {
 
     private let fileUrl: URL
@@ -103,7 +105,7 @@ public final class HKDatabaseStore {
     /**
      Extract common object properties from a row.
      */
-    private func objectData(from row: Row) throws -> (dataId: Int, startDate: Date, endDate: Date, uuid: UUID, device: HKDevice?, metadata: [String : Any]) {
+    private func objectData(from row: Row) throws -> ObjectData {
         let dataId = row[samples.table[samples.dataId]]
         let startDate = Date(timeIntervalSinceReferenceDate: row[samples.table[samples.startDate]])
         let endDate = Date(timeIntervalSinceReferenceDate: row[samples.table[samples.endDate]])
@@ -1077,7 +1079,25 @@ public final class HKDatabaseStore {
 
     // MARK: Heartbeat Series
 
+    /**
+     Query for heartbeat series samples within a date interval.
+     */
     public func heartBeatSeries(from start: Date = .distantPast, to end: Date = .distantFuture) throws -> [HeartbeatSeries] {
+        try binarySamples(type: SampleType.Other.heartbeatSeries.rawValue, from: start, to: end)
+    }
+
+    // MARK: Audiograms
+
+    /**
+     Query for audiogram samples within a date interval.
+     */
+    public func audiograms(from start: Date = .distantPast, to end: Date = .distantFuture) throws -> [HKAudiogramSample] {
+        try binarySamples(type: SampleType.Other.audiogram.rawValue, from: start, to: end)
+    }
+
+    // MARK: Binary samples
+
+    private func binarySamples<T: BinarySample>(type: Int, from start: Date, to end: Date) throws -> [T] {
         let query = samples.table
             .select(samples.table[*],
                     objects.table[objects.provenance],
@@ -1087,25 +1107,15 @@ public final class HKDatabaseStore {
                   on: samples.table[samples.dataId] == objects.table[objects.dataId])
             .join(.leftOuter, binarySamples.table,
                   on: samples.table[samples.dataId] == binarySamples.table[binarySamples.dataId])
-            .filter(samples.table[samples.dataType] == SampleType.Other.heartbeatSeries.rawValue &&
+            .filter(samples.table[samples.dataType] == type &&
                     samples.table[samples.startDate] <= end.timeIntervalSinceReferenceDate &&
                     samples.table[samples.endDate] >= start.timeIntervalSinceReferenceDate)
-
         return try database.prepare(query).compactMap { row in
             let object = try objectData(from: row)
             guard let data = try binarySamples.payload(for: object.dataId, in: database) else {
                 return nil
             }
-            guard let samples = HeartbeatSeries.samples(from: data) else {
-                return nil
-            }
-            return .init(
-                samples: samples,
-                startDate: object.startDate,
-                endDate: object.endDate,
-                uuid: object.uuid,
-                metadata: object.metadata.withoutUUID(),
-                device: object.device)
+            return T.from(object: object, data: data)
         }
     }
 

Sources/HealthDB/Database/HealthDatabase+Series.swift

@@ -28,4 +28,21 @@ extension HealthDatabase {
             .map(T.init(quantitySample:))
     }
 
+    // MARK: Heartbeat Series
+
+    /**
+     Query for heartbeat series samples within a date interval.
+     */
+    public func heartBeatSeries(from start: Date = .distantPast, to end: Date = .distantFuture) throws -> [HeartbeatSeries] {
+        try store.heartBeatSeries(from: start, to: end)
+    }
+
+    // MARK: Audiograms
+
+    /**
+     Query for audiogram samples within a date interval.
+     */
+    public func audiograms(from start: Date = .distantPast, to end: Date = .distantFuture) throws -> [HKAudiogramSample] {
+        try store.audiograms(from: start, to: end)
+    }
 }

Sources/HealthDB/Model/Audiogram/HKAudiogram+BinarySample.swift

@@ -0,0 +1,22 @@
+import Foundation
+import HealthKit
+
+extension HKAudiogramSample: BinarySample {
+
+    static func from(object: ObjectData, data: Data) -> Self? {
+        let points: [HKAudiogramSensitivityPoint]
+        do {
+            let decoder = try NSKeyedUnarchiver(forReadingFrom: data)
+            decoder.requiresSecureCoding = false
+
+            guard let values = decoder.decodeObject(of: NSArray.self, forKey: NSKeyedArchiveRootObjectKey) as? [HKAudiogramSensitivityPoint] else {
+                return nil
+            }
+            points = values
+        } catch {
+            return nil
+        }
+
+        return .init(sensitivityPoints: points, start: object.startDate, end: object.endDate, metadata: object.metadata)
+    }
+}

Sources/HealthDB/Model/BinarySample.swift

@@ -0,0 +1,6 @@
+import Foundation
+
+protocol BinarySample {
+
+    static func from(object: ObjectData, data: Data) -> Self?
+}

Sources/HealthDB/Model/HeartbeatSamples/HeartbeatSeries.swift

@@ -60,3 +60,18 @@ extension HeartbeatSeries {
     }
 }
 
+extension HeartbeatSeries: BinarySample {
+
+    static func from(object: ObjectData, data: Data) -> HeartbeatSeries? {
+        guard let samples = HeartbeatSeries.samples(from: data) else {
+            return nil
+        }
+        return .init(
+            samples: samples,
+            startDate: object.startDate,
+            endDate: object.endDate,
+            uuid: object.uuid,
+            metadata: object.metadata.withoutUUID(),
+            device: object.device)
+    }
+}