config: rewrite Settings update API

yoursunny · yoursunny · commit e7d68e6c196a · 2025-01-07T06:07:36.000-05:00
diff --git a/examples/AsyncCam/AsyncCam.hpp b/examples/AsyncCam/AsyncCam.hpp
@@ -8,7 +8,6 @@
 #include <esp32cam.h>
 
 extern esp32cam::Resolution initialResolution;
-extern esp32cam::Resolution currentResolution;
 
 extern AsyncWebServer server;
 
diff --git a/examples/AsyncCam/AsyncCam.ino b/examples/AsyncCam/AsyncCam.ino
@@ -5,7 +5,6 @@ static const char* WIFI_SSID = "my-ssid";
 static const char* WIFI_PASS = "my-pass";
 
 esp32cam::Resolution initialResolution;
-esp32cam::Resolution currentResolution;
 
 AsyncWebServer server(80);
 
@@ -31,7 +30,6 @@ setup() {
     using namespace esp32cam;
 
     initialResolution = Resolution::find(1024, 768);
-    currentResolution = initialResolution;
 
     Config cfg;
     cfg.setPins(pins::AiThinker);
diff --git a/examples/AsyncCam/handlers.cpp b/examples/AsyncCam/handlers.cpp
@@ -6,15 +6,12 @@ static const char FRONTPAGE[] = R"EOT(
 <title>esp32cam AsyncCam example</title>
 <body>
 <h1>esp32cam AsyncCam example</h1>
-<form><p>
-Resolution
-<select id="resolution" required>%RESOLUTION_OPTIONS%</select>
-<input type="submit" value="change">
+<form id="update"><p>
+<select name="resolution" required>%resolution%</select>
+%hmirror%
+%vflip%
+<input type="submit" value="update">
 </p></form>
-<p id="toggles">
-<label><input type="checkbox" data-act="hmirror">hmirror</label>
-<label><input type="checkbox" data-act="vflip">vflip</label>
-</p>
 <p id="controls">
 <button data-act="mjpeg">show Motion JPEG stream</button>
 <button data-act="jpg">show still JPEG image</button>
@@ -32,36 +29,18 @@ async function fetchText(uri, init) {
 }
 
 const $display = document.querySelector("#display");
-const $resolution = document.querySelector("#resolution");
-
-$resolution.form.addEventListener("submit", async (evt) => {
+document.querySelector("#update").addEventListener("submit", async (evt) => {
   evt.preventDefault();
-  const [width, height] = $resolution.value.split("x");
   try {
-    await fetchText("/change-resolution.cgi", {
+    await fetchText("/update.cgi", {
       method: "POST",
-      body: new URLSearchParams({ width, height }),
+      body: new URLSearchParams(new FormData(evt.target)),
     });
   } catch (err) {
     $display.textContent = err.toString();
   }
 });
 
-for (const $ctrl of document.querySelectorAll("#toggles input[type=checkbox]")) {
-  $ctrl.addEventListener("change", async (evt) => {
-    evt.preventDefault();
-    const act = evt.target.getAttribute("data-act");
-    try {
-      await fetchText(`/set-${act}.cgi`, {
-        method: "POST",
-        body: new URLSearchParams({ enable: Number(evt.target.checked) }),
-      });
-    } catch (err) {
-      $display.textContent = err.toString();
-    }
-  });
-}
-
 for (const $ctrl of document.querySelectorAll("#controls button")) {
   $ctrl.addEventListener("click", (evt) => {
     evt.preventDefault();
@@ -83,78 +62,66 @@ for (const $ctrl of document.querySelectorAll("#controls button")) {
 )EOT";
 
 static String
-rewriteFrontpage(const String& var) {
+rewriteFrontpage(const esp32cam::Settings& settings, const String& var) {
   StreamString b;
-  if (var == "RESOLUTION_OPTIONS") {
+
+  if (var == "resolution") {
     for (const auto& r : esp32cam::Camera.listResolutions()) {
-      b.print("<option");
-      if (r == currentResolution) {
-        b.print(" selected");
-      }
-      if (r > initialResolution) {
-        b.print(" disabled");
-      }
-      b.print('>');
+      b.printf("<option value=\"%d\"%s>", r.as<int>(),
+               r > initialResolution      ? " disabled"
+               : r == settings.resolution ? " selected"
+                                          : "");
       b.print(r);
       b.print("</option>");
     }
   }
-  return b;
-}
 
-void
-addRequestHandlers() {
-  server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) {
-    request->send(200, "text/html", reinterpret_cast<const uint8_t*>(FRONTPAGE), sizeof(FRONTPAGE),
-                  rewriteFrontpage);
-  });
+#define SETTING_BOOL(MEM)                                                                          \
+  else if (var == #MEM) {                                                                          \
+    b.printf("<label><input type=\"checkbox\" name=\"" #MEM "\" value=\"1\"%s>" #MEM "</label>",   \
+             settings.MEM ? " checked" : "");                                                      \
+  }
 
-  server.on("/robots.txt", HTTP_GET, [](AsyncWebServerRequest* request) {
-    request->send(200, "text/plain", "User-Agent: *\nDisallow: /\n");
-  });
+  SETTING_BOOL(hmirror)
+  SETTING_BOOL(vflip)
 
-  server.on("/change-resolution.cgi", HTTP_POST, [](AsyncWebServerRequest* request) {
-    long width = request->arg("width").toInt();
-    long height = request->arg("height").toInt();
-    auto r = esp32cam::Camera.listResolutions().find(width, height);
-    if (!(r.isValid() && r.getWidth() == width && r.getHeight() == height)) {
-      request->send(404, "text/plain", "non-existent resolution\n");
-      return;
-    }
+#undef SETTING_BOOL
 
-    if (!esp32cam::Camera.changeResolution(r, 0)) {
-      Serial.printf("changeResolution(%ld,%ld) failure\n", width, height);
-      request->send(500, "text/plain", "changeResolution error\n");
-      return;
-    }
+  return b;
+}
 
-    currentResolution = r;
-    Serial.printf("changeResolution(%ld,%ld) success\n", width, height);
-    StreamString b;
-    b.print(currentResolution);
-    request->send(200, "text/plain", static_cast<String>(b));
-  });
+static void
+handleFrontpage(AsyncWebServerRequest* request) {
+  auto settings = esp32cam::Camera.status();
+  request->send(200, "text/html", reinterpret_cast<const uint8_t*>(FRONTPAGE), sizeof(FRONTPAGE),
+                [=](const String& var) { return rewriteFrontpage(settings, var); });
+}
 
-  server.on("/set-hmirror.cgi", HTTP_POST, [](AsyncWebServerRequest* request) {
-    long enable = request->arg("enable").toInt();
-    if (!esp32cam::Camera.update(esp32cam::SetHmirror(enable != 0))) {
-      request->send(500, "text/plain", "SetHmirror error\n");
-      return;
-    }
-    Serial.printf("SetHmirror(%ld) success\n", enable);
-    request->send(200, "text/plain", "SetHmirror success\n");
+static void
+handleUpdate(AsyncWebServerRequest* request) {
+  bool ok = esp32cam::Camera.update([=](esp32cam::Settings& settings) {
+    settings.resolution =
+      esp32cam::Resolution(static_cast<int>(request->arg("resolution").toInt()));
+    settings.hmirror = request->arg("hmirror").toInt() != 0;
+    settings.vflip = request->arg("vflip").toInt() != 0;
   });
 
-  server.on("/set-vflip.cgi", HTTP_POST, [](AsyncWebServerRequest* request) {
-    long enable = request->arg("enable").toInt();
-    if (!esp32cam::Camera.update(esp32cam::SetVflip(enable != 0))) {
-      request->send(500, "text/plain", "SetVflip error\n");
-      return;
-    }
-    Serial.printf("SetVflip(%ld) success\n", enable);
-    request->send(200, "text/plain", "SetVflip success\n");
+  if (!ok) {
+    request->send(500, "text/plain", "update settings error\n");
+    return;
+  }
+  request->send(204);
+}
+
+void
+addRequestHandlers() {
+  server.on("/robots.txt", HTTP_GET, [](AsyncWebServerRequest* request) {
+    request->send(200, "text/plain", "User-Agent: *\nDisallow: /\n");
   });
 
+  server.on("/", HTTP_GET, handleFrontpage);
+  server.on("/update.cgi", HTTP_POST, handleUpdate);
+
   server.on("/cam.jpg", esp32cam::asyncweb::handleStill);
   server.on("/cam.mjpeg", esp32cam::asyncweb::handleMjpeg);
 }
diff --git a/examples/WifiCam/WifiCam.ino b/examples/WifiCam/WifiCam.ino
@@ -12,6 +12,7 @@ void
 setup() {
   Serial.begin(115200);
   Serial.println();
+  esp32cam::setLogger(Serial);
   delay(1000);
 
   WiFi.persistent(false);
diff --git a/examples/WifiCam/handlers.cpp b/examples/WifiCam/handlers.cpp
@@ -115,11 +115,11 @@ addRequestHandlers() {
       return;
     }
 
-    if (!esp32cam::Camera.changeResolution(r)) {
-      Serial.printf("changeResolution(%ld,%ld) failure\n", width, height);
-      server.send(500, "text/plain", "changeResolution error\n");
+    if (!esp32cam::Camera.update([=](esp32cam::Settings& settings) { settings.resolution = r; },
+                                 500)) {
+      server.send(500, "text/plain", "update resolution error\n");
+      return;
     }
-    Serial.printf("changeResolution(%ld,%ld) success\n", width, height);
 
     if (format == "bmp") {
       serveStill(true);
diff --git a/src/esp32cam/camera.cpp b/src/esp32cam/camera.cpp
@@ -5,6 +5,10 @@
 
 namespace esp32cam {
 
+// extern ESP32CAM_SPECIALIZE_SENSOR_SETTING(framesize_t, framesize_t);
+
+// static SensorSetting<framesize_t, framesize_t> frameSize(ESP32CAM_SENSOR_OFFSETS(framesize));
+
 Print* LogOutput = nullptr;
 CameraClass Camera;
 
@@ -54,15 +58,6 @@ CameraClass::changeResolution(const Resolution& resolution, int sleepFor) {
   return true;
 }
 
-bool
-CameraClass::update(const SensorSetter& setter) {
-  sensor_t* sensor = esp_camera_sensor_get();
-  if (sensor == nullptr) {
-    return false;
-  }
-  return setter(sensor);
-}
-
 std::unique_ptr<Frame>
 CameraClass::capture() {
   camera_fb_t* fb = esp_camera_fb_get();
diff --git a/src/esp32cam/camera.hpp b/src/esp32cam/camera.hpp
@@ -3,7 +3,7 @@
 
 #include "config.hpp"
 #include "mjpeg.hpp"
-#include "setters.hpp"
+#include <functional>
 
 namespace esp32cam {
 
@@ -32,20 +32,41 @@ class CameraClass {
    * @pre Camera is enabled.
    * @param resolution new resolution; must be no higher than initial resolution.
    * @param sleepFor how long to wait for stabilization (millis).
+   * @deprecated Use @c update instead.
    */
   bool changeResolution(const Resolution& resolution, int sleepFor = 500);
 
   /**
-   * @brief Update camera configuration.
-   * @param setter See `setters.hpp`.
+   * @brief Retrieve runtime settings.
+   * @pre Camera is enabled.
+   */
+  Settings status() const;
+
+  /**
+   * @brief Update runtime settings.
+   * @param settings updated settings.
+   * @param sleepFor how long to wait for stabilization (millis).
+   * @pre Camera is enabled.
+   * @post Camera may be left in inconsistent state in case of failure.
+   * @return whether success.
+   */
+  bool update(const Settings& settings, int sleepFor = 0);
+
+  /**
+   * @brief Update runtime settings using modifier function.
+   * @param modifier function to modify settings.
+   * @param sleepFor how long to wait for stabilization (millis).
+   * @pre Camera is enabled.
+   * @post Camera may be left in inconsistent state in case of failure.
    * @return whether success.
-   *
-   * Example:
-   * @code
-   * bool ok = Camera.update(SetVflip(true));
-   * @endcode
    */
-  bool update(const SensorSetter& setter);
+  template<typename Fn>
+  std::enable_if_t<std::is_assignable_v<std::function<void(Settings&)>, Fn>, bool> //
+  update(const Fn& modifier, int sleepFor = 0) {
+    Settings settings = status();
+    modifier(settings);
+    return update(settings, sleepFor);
+  }
 
   /**
    * @brief Capture a frame of picture.
diff --git a/src/esp32cam/config.cpp b/src/esp32cam/config.cpp
@@ -1,4 +1,6 @@
 #include "config.hpp"
+#include "camera.hpp"
+#include "logger.hpp"
 
 #include <algorithm>
 #include <cstring>
@@ -90,4 +92,53 @@ Config::setJpeg(int quality) {
   return *this;
 }
 
+Settings
+CameraClass::status() const {
+  Settings result;
+  sensor_t* sensor = esp_camera_sensor_get();
+  if (sensor == nullptr) {
+    return result;
+  }
+
+  result.resolution = Resolution(sensor->status.framesize);
+  result.hmirror = sensor->status.hmirror != 0;
+  result.vflip = sensor->status.vflip != 0;
+  return result;
+}
+
+bool
+CameraClass::update(const Settings& settings, int sleepFor) {
+  sensor_t* sensor = esp_camera_sensor_get();
+  if (sensor == nullptr) {
+    return false;
+  }
+
+#define UPDATE(STATUS_MEM, SETTING_MEM, SETTER_TYP)                                                \
+  do {                                                                                             \
+    auto prev = sensor->status.STATUS_MEM;                                                         \
+    if (prev != static_cast<decltype(sensor->status.STATUS_MEM)>(settings.SETTING_MEM)) {          \
+      int res = sensor->set_##STATUS_MEM(sensor, static_cast<SETTER_TYP>(settings.SETTING_MEM));   \
+      ESP32CAM_LOG("update " #STATUS_MEM " %d => %d %s", static_cast<int>(prev),                   \
+                   static_cast<int>(settings.SETTING_MEM), res == 0 ? "success" : "failure");      \
+      if (res != 0) {                                                                              \
+        return false;                                                                              \
+      }                                                                                            \
+    }                                                                                              \
+  } while (false)
+
+#define UPDATE1(MEM) UPDATE(MEM, MEM, int)
+
+  UPDATE(framesize, resolution.as<framesize_t>(), framesize_t);
+  UPDATE1(hmirror);
+  UPDATE1(vflip);
+
+#undef UPDATE
+#undef UPDATE1
+
+  if (sleepFor > 0) {
+    delay(sleepFor);
+  }
+  return true;
+}
+
 } // namespace esp32cam
diff --git a/src/esp32cam/config.hpp b/src/esp32cam/config.hpp
@@ -52,6 +52,18 @@ class Config {
   friend class CameraClass;
 };
 
+/** @brief Camera runtime settings. */
+struct Settings {
+  /** @brief Picture resolution. */
+  Resolution resolution;
+
+  /** @brief Horizontal flip. */
+  bool hmirror = false;
+
+  /** @brief Vertical flip. */
+  bool vflip = false;
+};
+
 } // namespace esp32cam
 
 #endif // ESP32CAM_CONFIG_HPP
diff --git a/src/esp32cam/logger.hpp b/src/esp32cam/logger.hpp
diff --git a/src/esp32cam/setters.cpp b/src/esp32cam/setters.cpp
diff --git a/src/esp32cam/setters.hpp b/src/esp32cam/setters.hpp

Original file line number	Diff line number	Diff line change
`@@ -115,11 +115,11 @@ addRequestHandlers() {`
`115`	`115`	`return;`
`116`	`116`	`}`
`117`	`117`
`118`		`- if (!esp32cam::Camera.changeResolution(r)) {`
`119`		`- Serial.printf("changeResolution(%ld,%ld) failure\n", width, height);`
`120`		`- server.send(500, "text/plain", "changeResolution error\n");`
	`118`	`+ if (!esp32cam::Camera.update([=](esp32cam::Settings& settings) { settings.resolution = r; },`
	`119`	`+ 500)) {`
	`120`	`+ server.send(500, "text/plain", "update resolution error\n");`
	`121`	`+ return;`
`121`	`122`	`}`
`122`		`- Serial.printf("changeResolution(%ld,%ld) success\n", width, height);`
`123`	`123`
`124`	`124`	`if (format == "bmp") {`
`125`	`125`	`serveStill(true);`