code cleanup; fix audio streaming

1 files changed, 67 insertions, 29 deletions

diff --git a/source/stmdsp/stmdsp.hpp b/source/stmdsp/stmdsp.hpp
index 76ca94e..64f5aff 100644
--- a/source/stmdsp/stmdsp.hpp
+++ b/source/stmdsp/stmdsp.hpp
@@ -15,33 +15,83 @@
 #include <serial/serial.h>
 
 #include <cstdint>
-#include <list>
+#include <forward_list>
 #include <memory>
+#include <mutex>
 #include <string>
 #include <tuple>
 
 namespace stmdsp
 {
+    /**
+     * The largest possible size of an ADC or DAC sample buffer, as a sample count.
+     * Maximum byte size would be `SAMPLES_MAX * sizeof(XXXsample_t)`.
+     */
     constexpr unsigned int SAMPLES_MAX = 4096;
 
+    /**
+     * ADC samples on all platforms are stored as 16-bit unsigned integers.
+     */
+    using adcsample_t = uint16_t;
+    /**
+     * DAC samples on all platforms are stored as 16-bit unsigned integers.
+     */
+    using dacsample_t = uint16_t;
+
+    /**
+     * List of all available platforms.
+     * Note that some platforms in this list may not have complete support.
+     */
+    enum class platform {
+        Unknown,
+        H7, /* Some feature support */
+        L4, /* Complete feature support */
+        G4  /* Unsupported, but planned */
+    };
+
+    /**
+     * Run status states, valued to match what the stmdsp firmware reports.
+     */
     enum class RunStatus : char {
-        Idle = '1',
-        Running,
-        Recovering
+        Idle = '1', /* Device ready for commands or execution. */
+        Running,    /* Device currently executing its algorithm. */
+        Recovering  /* Device recovering from fault caused by algorithm. */
     };
 
+    /**
+     * Error messages that are reported by the firmware.
+     */
     enum class Error : char {
         None = 0,
-        BadParam,
-        BadParamSize,
-        BadUserCodeLoad,
-        BadUserCodeSize,
-        NotIdle,
-        ConversionAborted
+        BadParam,         /* An invalid parameter was passed for a command. */
+        BadParamSize,     /* An invaild param. size was given for a command. */
+        BadUserCodeLoad,  /* Device failed to load the given algorithm. */
+        BadUserCodeSize,  /* The given algorithm is too large for the device. */
+        NotIdle,          /* An idle-only command was received while not Idle. */
+        ConversionAborted /* A conversion was aborted due to a fault. */
     };
 
+    /**
+     * Provides functionality to scan the system for stmdsp devices.
+     * A list of devices is returned, though the GUI only interacts with one
+     * device at a time.
+     */
     class scanner
     {
+    public:
+        /**
+         * Scans for connected devices, returning a list of ports with
+         * connected stmdsp devices.
+         */
+        const std::forward_list<std::string>& scan();
+
+        /**
+         * Retrieves the results of the last scan().
+         */
+        const std::forward_list<std::string>& devices() const noexcept {
+            return m_available_devices;
+        }
+
     private:
         constexpr static const char *STMDSP_USB_ID =
 #ifndef STMDSP_WIN32
@@ -50,24 +100,7 @@ namespace stmdsp
             "USB\\VID_0483&PID_5740";
 #endif
 
-    public:
-        std::list<std::string>& scan();
-        auto& devices() {
-            return m_available_devices;
-        }
-
-    private:
-        std::list<std::string> m_available_devices;
-    };
-
-    using adcsample_t = uint16_t;
-    using dacsample_t = uint16_t;
-
-    enum class platform {
-        Unknown,
-        H7, /* Behind in feature support */
-        L4, /* Complete feature support */
-        G4  /* Currently unsupported */
+        std::forward_list<std::string> m_available_devices;
     };
 
     class device
@@ -96,7 +129,7 @@ namespace stmdsp
         std::vector<adcsample_t> continuous_read();
         std::vector<adcsample_t> continuous_read_input();
 
-        void siggen_upload(dacsample_t *buffer, unsigned int size);
+        bool siggen_upload(dacsample_t *buffer, unsigned int size);
         void siggen_start();
         void siggen_stop();
 
@@ -116,6 +149,11 @@ namespace stmdsp
         unsigned int m_sample_rate = 0;
         bool m_is_siggening = false;
         bool m_is_running = false;
+
+        std::mutex m_lock;
+
+        bool try_command(std::basic_string<uint8_t> data);
+        bool try_read(std::basic_string<uint8_t> cmd, uint8_t *dest, unsigned int dest_size);
     };
 }