From 8c392608fdbd979e0dc23d2e5a004fa06b009feb Mon Sep 17 00:00:00 2001
From: Alan Liddell <aliddell@chanzuckerberg.com>
Date: Mon, 2 Oct 2023 15:12:05 -0400
Subject: [PATCH] add canonical sample_type_as_string and bytes_of_type
 functions

---
 src/acquire-device-properties/CMakeLists.txt  |  1 +
 .../device/props/components.c                 | 97 +++++++++++++++++++
 .../device/props/components.h                 |  3 +
 tests/unit-tests.cpp                          |  4 +
 4 files changed, 105 insertions(+)
 create mode 100644 src/acquire-device-properties/device/props/components.c

diff --git a/src/acquire-device-properties/CMakeLists.txt b/src/acquire-device-properties/CMakeLists.txt
index 9bb2bb3..b632d76 100644
--- a/src/acquire-device-properties/CMakeLists.txt
+++ b/src/acquire-device-properties/CMakeLists.txt
@@ -2,6 +2,7 @@ set(tgt acquire-device-properties)
 add_library(${tgt} STATIC
         device/props/device.c
         device/props/storage.c
+        device/props/components.c
 )
 target_sources(${tgt} PUBLIC FILE_SET HEADERS
         BASE_DIRS "${CMAKE_CURRENT_LIST_DIR}"
diff --git a/src/acquire-device-properties/device/props/components.c b/src/acquire-device-properties/device/props/components.c
new file mode 100644
index 0000000..67c7ee2
--- /dev/null
+++ b/src/acquire-device-properties/device/props/components.c
@@ -0,0 +1,97 @@
+#include "components.h"
+
+#define countof(e) (sizeof(e) / sizeof(*(e)))
+
+const char*
+sample_type_as_string(enum SampleType type)
+{
+    // Note: This table needs to get updated whenever a SampleType gets
+    //       added. The unit test below should crash when an entry is
+    //       missing.
+
+    // clang-format off
+    const char* table[] = {
+#define XXX(name) [SampleType_##name] = #name
+        XXX(u8),
+        XXX(u16),
+        XXX(i8),
+        XXX(i16),
+        XXX(f32),
+        XXX(u10),
+        XXX(u12),
+        XXX(u14),
+#undef XXX
+    };
+    // clang-format on
+    if (type >= countof(table))
+        return "(unknown)";
+
+    return table[type];
+}
+
+size_t
+bytes_of_type(enum SampleType type)
+{
+    size_t table[SampleTypeCount]; // = { 1, 2, 1, 2, 4, 2, 2, 2 };
+
+    // clang-format off
+#define XXX(s, b) table[(s)] = (b)
+        XXX(SampleType_u8, 1);
+        XXX(SampleType_u16, 2);
+        XXX(SampleType_i8, 1);
+        XXX(SampleType_i16, 2);
+        XXX(SampleType_f32, 4);
+        XXX(SampleType_u10, 2);
+        XXX(SampleType_u12, 2);
+        XXX(SampleType_u14, 2);
+#undef XXX
+    // clang-format on
+    if (type >= countof(table))
+        return 0;
+
+    return table[type];
+}
+
+//
+//  UNIT TESTS
+//
+
+#ifndef NO_UNIT_TESTS
+#include "logger.h"
+
+#define L (aq_logger)
+#define LOG(...) L(0, __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
+#define ERR(...) L(1, __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
+#define CHECK(e)                                                               \
+    do {                                                                       \
+        if (!(e)) {                                                            \
+            ERR("Expression evaluated as false:\n\t%s", #e);                   \
+            goto Error;                                                        \
+        }                                                                      \
+    } while (0)
+
+int
+unit_test__sample_type_as_string__is_defined_for_all()
+{
+    for (int i = 0; i < SampleTypeCount; ++i) {
+        // Check this isn't returning "unknown" for known counts
+        CHECK(sample_type_as_string(i)[0] != '(');
+    }
+    return 1;
+Error:
+    return 0;
+}
+
+int
+unit_test__bytes_of_type__is_defined_for_all()
+{
+    for (int i = 0; i < SampleTypeCount; ++i) {
+        // Check this isn't returning 0 for known counts
+        CHECK(bytes_of_type(i) != 0);
+    }
+    return 1;
+Error:
+    return 0;
+}
+
+#endif // NO_UNIT_TESTS
\ No newline at end of file
diff --git a/src/acquire-device-properties/device/props/components.h b/src/acquire-device-properties/device/props/components.h
index f20425a..7b0ef82 100644
--- a/src/acquire-device-properties/device/props/components.h
+++ b/src/acquire-device-properties/device/props/components.h
@@ -141,6 +141,9 @@ extern "C"
         double x, y;
     };
 
+    const char* sample_type_as_string(enum SampleType type);
+    size_t bytes_of_type(enum SampleType type);
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/tests/unit-tests.cpp b/tests/unit-tests.cpp
index cc543f6..120dcdf 100644
--- a/tests/unit-tests.cpp
+++ b/tests/unit-tests.cpp
@@ -70,6 +70,8 @@ extern "C"
     int unit_test__storage_properties_set_chunking_props();
     int unit_test__device_state_as_string__is_defined_for_all();
     int unit_test__device_kind_as_string__is_defined_for_all();
+    int unit_test__sample_type_as_string__is_defined_for_all();
+    int unit_test__bytes_of_type__is_defined_for_all();
 }
 
 int
@@ -93,6 +95,8 @@ main()
         CASE(unit_test__storage_properties_set_chunking_props),
         CASE(unit_test__device_state_as_string__is_defined_for_all),
         CASE(unit_test__device_kind_as_string__is_defined_for_all),
+        CASE(unit_test__sample_type_as_string__is_defined_for_all),
+        CASE(unit_test__bytes_of_type__is_defined_for_all),
 #undef CASE
     };