screensaver: Adds a screensaver.

Author: abaire

CMakeLists.txt

@@ -31,6 +31,7 @@ add_executable(${PROJECT_NAME}
   Includes/menu.cpp
   Includes/networkManager.cpp
   Includes/renderer.cpp
+  Includes/screensaver.cpp
   Includes/settingsMenu.cpp
   Includes/sntpClient.cpp
   Includes/subAppRouter.cpp

Includes/config.cpp

@@ -211,14 +211,29 @@ void from_json(nlohmann::json const& j, homescreenConfig& o) {
   }
 }
 
+void to_json(nlohmann::json& j, screensaverConfig const& o) {
+  j = nlohmann::json{ { "enabled", o.getEnabled() },
+                      { "timeout_millis", o.getTimeoutMillis() } };
+}
+
+void from_json(nlohmann::json const& j, screensaverConfig& o) {
+  if (j.contains("enabled") && j["enabled"].is_boolean()) {
+    o.setEnabled(j["enabled"]);
+  }
+  if (j.contains("timeout_millis")) {
+    o.setTimeoutMillis(j["timeout_millis"]);
+  }
+}
+
 void to_json(nlohmann::json& j, Settings const& o) {
   j = nlohmann::json{ { "ftp", nlohmann::json(o.ftp) },
                       { "mount", nlohmann::json(o.mount) },
 #ifdef NXDK
                       { "network", nlohmann::json(o.net) },
 #endif
                       { "logging", nlohmann::json(o.logging) },
-                      { "homescreenConfig", nlohmann::json(o.homescreen) } };
+                      { "homescreen", nlohmann::json(o.homescreen) },
+                      { "screensaver", nlohmann::json(o.screensaver) } };
 }
 
 void from_json(nlohmann::json const& j, Settings& o) {
@@ -242,6 +257,9 @@ void from_json(nlohmann::json const& j, Settings& o) {
   if (j.contains("homescreen")) {
     o.homescreen = j["homescreen"].get<homescreenConfig>();
   }
+  if (j.contains("screensaver")) {
+    o.screensaver = j["screensaver"].get<screensaverConfig>();
+  }
 }
 
 Config::Config() {

Includes/config.hpp

@@ -131,6 +131,22 @@ class homescreenConfig {
 void to_json(nlohmann::json& j, homescreenConfig const& o);
 void from_json(nlohmann::json const& j, homescreenConfig& o);
 
+class screensaverConfig {
+  bool enabled{ true };
+  unsigned int timeoutMillis{ 5 * 60 * 1000 };
+
+public:
+  screensaverConfig() = default;
+
+  bool getEnabled() const { return enabled; }
+  unsigned int getTimeoutMillis() const { return timeoutMillis; }
+
+  void setEnabled(bool val) { enabled = val; }
+  void setTimeoutMillis(unsigned int val) { timeoutMillis = val; }
+};
+void to_json(nlohmann::json& j, screensaverConfig const& o);
+void from_json(nlohmann::json const& j, screensaverConfig& o);
+
 class Settings {
 public:
   Settings() = default;
@@ -142,6 +158,7 @@ class Settings {
   mountConfig mount;
   loggingConfig logging;
   homescreenConfig homescreen;
+  screensaverConfig screensaver;
 };
 void to_json(nlohmann::json& j, Settings const& o);
 void from_json(nlohmann::json const& j, Settings& o);

Includes/screensaver.cpp

@@ -0,0 +1,31 @@
+#include "screensaver.h"
+#include "timing.h"
+
+Screensaver::Screensaver(Renderer& r, bool enabled, unsigned int timeoutMillis) :
+    renderer(r), timeoutMillis(timeoutMillis), isEnabled(enabled) {
+  lastInputTime = std::chrono::steady_clock::now();
+}
+
+void Screensaver::render() {
+  if (!isEnabled) {
+    return;
+  }
+  auto millisElapsed = millisSince(lastInputTime);
+  if (millisElapsed >= timeoutMillis) {
+    isActive = true;
+  }
+
+  if (!isActive) {
+    return;
+  }
+  renderer.setDrawColor(0, 0, 0, 200);
+
+  SDL_FRect screen = { 0, 0, static_cast<float>(renderer.getWidth()),
+                       static_cast<float>(renderer.getHeight()) };
+  renderer.fillRectangle(screen);
+}
+
+void Screensaver::notifyInput() {
+  lastInputTime = std::chrono::steady_clock::now();
+  isActive = false;
+}

Includes/screensaver.h

@@ -0,0 +1,24 @@
+#ifndef NEVOLUTIONX_SCREENSAVER_H
+#define NEVOLUTIONX_SCREENSAVER_H
+
+#include <chrono>
+#include "renderer.h"
+
+class Screensaver {
+public:
+  Screensaver(Renderer& r, bool enable, unsigned int timeoutMillis);
+
+  void render();
+
+  // Checks to see if the screensaver should consume an input event and stop rendering.
+  void notifyInput();
+
+private:
+  Renderer& renderer;
+  unsigned int timeoutMillis;
+  bool isEnabled{ true };
+  bool isActive{ false };
+  std::chrono::steady_clock::time_point lastInputTime;
+};
+
+#endif // NEVOLUTIONX_SCREENSAVER_H

Makefile

@@ -17,6 +17,7 @@ SRCS += \
 	$(INCDIR)/networkManager.cpp \
 	$(INCDIR)/networking.cpp \
 	$(INCDIR)/renderer.cpp \
+	$(INCDIR)/screensaver.cpp \
 	$(INCDIR)/settingsMenu.cpp \
 	$(INCDIR)/sntpClient.cpp \
 	$(INCDIR)/subAppRouter.cpp \

main.cpp

@@ -9,6 +9,7 @@
 #include "menu.hpp"
 #include "networkManager.h"
 #include "renderer.h"
+#include "screensaver.h"
 #include "sntpClient.h"
 #include "subAppRouter.h"
 #include "subsystems.h"
@@ -119,6 +120,10 @@ int main(void) {
   ftpServer* ftpServerInstance = nullptr;
   std::shared_ptr<sntpClient> sntpClientInstance;
 
+  auto const& screensaverSettings = config.settings.screensaver;
+  Screensaver screensaver(r, screensaverSettings.getEnabled(),
+                          screensaverSettings.getTimeoutMillis());
+
   auto lastFrameStart = std::chrono::steady_clock::now();
   while (running) {
     auto frameStart = std::chrono::steady_clock::now();
@@ -161,6 +166,7 @@ int main(void) {
     }
 
     InfoLog::renderOverlay(r, f);
+    screensaver.render();
 
     r.flip();
 
@@ -174,10 +180,13 @@ int main(void) {
         SDL_GameControllerClose(controllers[event.cdevice.which]);
         controllers.erase(event.cdevice.which);
       } else if (event.type == SDL_CONTROLLERBUTTONDOWN) {
+        screensaver.notifyInput();
         router.handleButtonDown(event.cbutton);
       } else if (event.type == SDL_CONTROLLERBUTTONUP) {
+        screensaver.notifyInput();
         router.handleButtonUp(event.cbutton);
       } else if (event.type == SDL_CONTROLLERAXISMOTION) {
+        screensaver.notifyInput();
         router.handleAxisMotion(event.caxis);
       }
     }

sampleconfig.json

@@ -38,6 +38,11 @@
         {
             "show_fps": false,
             "show_ip": true
+        },
+        "screensaver":
+        {
+            "enabled": true,
+            "timeout_millis": 300000
         }
     },
     "menu":