Implement the native OpenNOW Switch UI

.github/workflows/host-tests.yml

@@ -41,7 +41,8 @@ jobs:
         run: |
           sudo apt-get update -qq
           sudo apt-get install -y --no-install-recommends \
-            g++ cmake ninja-build libsdl2-dev libgl1-mesa-dev libcurl4-openssl-dev xvfb xauth
+            g++ cmake ninja-build pkg-config python3 imagemagick libjansson-dev \
+            libsdl2-dev libgl1-mesa-dev libcurl4-openssl-dev xvfb xauth
 
       - name: Build native UI layout test
         run: |

README.md

@@ -87,6 +87,10 @@ Install and setup guidance lives in the
 [OpenNOW documentation](https://opennow.zortos.me). Nintendo Switch installation
 requires custom firmware and Homebrew Menu.
 
+> [!IMPORTANT]
+> Overclock the Switch for the best streaming performance. At stock clocks the
+> stream hovers between 45 and 50 FPS instead of a steady 60 FPS.
+
 > [!NOTE]
 > The application currently retains the inherited `SwitchNOW.nro` filename and
 > `sdmc:/switch/SwitchNOW/` data directory for compatibility. Renaming either

app/src/StreamView.cpp

@@ -31,12 +31,12 @@ StreamView::StreamView(
     const std::vector<opennow::IceServerInfo>& ice_servers,
     const opennow::GfnClient& client,
     const opennow::AuthSession& auth,
-    const std::string& game_title)
+    const std::string& game_title,
+    const opennow::StreamSettings& stream_settings)
     : client_(client)
     , auth_(auth)
     , cloud_session_id_(session_id)
     , game_title_(game_title) {
-    const auto stream_settings = opennow::LoadStreamSettings();
     debug_diagnostics_ = stream_settings.debug_diagnostics;
     stats_overlay_enabled_ = stream_settings.stats_overlay_enabled;
     stream_codec_ = stream_settings.codec;
@@ -66,7 +66,8 @@ StreamView::StreamView(
         session_id,
         media_ip,
         media_port,
-        ice_servers);
+        ice_servers,
+        stream_settings);
     session_->start();
     network_monitor_.start();
     RefreshNetworkInfo(stream_started_at_);
@@ -82,6 +83,7 @@ StreamView::StreamView(
 }
 
 StreamView::~StreamView() {
+    RecordLifecycleEvent("destroy");
     network_monitor_.request_stop();
     opennow::SetSensitiveInputLoggingSuppressed(false);
     std::fill(nte_credentials_.password.begin(), nte_credentials_.password.end(), '\0');
@@ -123,6 +125,7 @@ void StreamView::onFocusLost() {
 void StreamView::ExitStream() {
     if (exit_requested_)
         return;
+    RecordLifecycleEvent("exit");
     exit_requested_ = true;
     network_monitor_.request_stop();
     if (session_)
@@ -139,6 +142,30 @@ void StreamView::ExitStream() {
     }
 }
 
+void StreamView::RecordLifecycleEvent(const char* event) {
+    if (!debug_diagnostics_ || !session_)
+        return;
+
+    const auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
+        std::chrono::steady_clock::now() - stream_started_at_).count();
+    const auto network = network_monitor_.snapshot();
+    const auto health = session_->get_transport_health();
+    const auto video = session_->get_video_performance();
+    session_->record_ui_event(
+        std::string("stream_lifecycle event=") + event +
+        " reason=" + std::to_string(static_cast<int>(stream_end_reason_)) +
+        " elapsedMs=" + std::to_string(elapsed) +
+        " internetConnected=" + std::to_string(network.internet_connected) +
+        " peerCompleted=" + std::to_string(health.peer_completed) +
+        " peerTerminal=" + std::to_string(static_cast<int>(health.peer_terminal)) +
+        " signalingConnected=" + std::to_string(health.signaling_connected) +
+        " videoStarted=" + std::to_string(health.video_started) +
+        " accessUnitIdleMs=" + std::to_string(health.video_idle.count()) +
+        " accessUnits=" + std::to_string(video.access_units) +
+        " decodedFrames=" + std::to_string(video.decoded_frames) +
+        " presentedFrames=" + std::to_string(video.presented_frames));
+}
+
 void StreamView::StopCloudSessionAsync() {
     if (cloud_stop_requested_ || cloud_session_id_.empty())
         return;
@@ -414,7 +441,8 @@ brls::View* StreamView::create(
     const std::vector<opennow::IceServerInfo>& ice_servers,
     const opennow::GfnClient& client,
     const opennow::AuthSession& auth,
-    const std::string& game_title) {
+    const std::string& game_title,
+    const opennow::StreamSettings& settings) {
     return new StreamView(signaling_url, jwt_token, session_id, media_ip, media_port,
-                          ice_servers, client, auth, game_title);
+                          ice_servers, client, auth, game_title, settings);
 }

app/src/StreamView.hpp

@@ -8,6 +8,8 @@
 #include "nte_credentials.hpp"
 #include "stream_end_policy.hpp"
 #include "stream_overlay_policy.hpp"
+#include "stream_overlay_view.hpp"
+#include "stream_settings.hpp"
 #include "webrtc_session.hpp"
 
 #include <array>
@@ -33,7 +35,8 @@ class StreamView : public brls::Box {
         const std::vector<opennow::IceServerInfo>& ice_servers,
         const opennow::GfnClient& client,
         const opennow::AuthSession& auth,
-        const std::string& game_title);
+        const std::string& game_title,
+        const opennow::StreamSettings& settings);
     ~StreamView() override;
 
     void draw(NVGcontext* vg, float x, float y, float width, float height, brls::Style style, brls::FrameContext* ctx) override;
@@ -49,11 +52,13 @@ class StreamView : public brls::Box {
         const std::vector<opennow::IceServerInfo>& ice_servers,
         const opennow::GfnClient& client,
         const opennow::AuthSession& auth,
-        const std::string& game_title);
+        const std::string& game_title,
+        const opennow::StreamSettings& settings);
 
 private:
     void ExitStream();
     void StopCloudSessionAsync();
+    void RecordLifecycleEvent(const char* event);
     void DrawDebugOverlay(NVGcontext* vg, float x, float y, float width);
     void DrawPreparingStream(NVGcontext* vg, float x, float y, float width, float height);
     void UpdatePerformanceCounter();
@@ -141,6 +146,9 @@ class StreamView : public brls::Box {
     bool debug_diagnostics_ = false;
     bool stats_overlay_enabled_ = false;
     bool stream_overlay_visible_ = false;
+    std::unique_ptr<opennow::StreamOverlayView> stream_overlay_view_;
+    std::chrono::steady_clock::time_point stream_overlay_next_sample_ {};
+    std::int64_t stream_overlay_elapsed_seconds_ = -1;
     bool stream_overlay_b_was_down_ = false;
     bool overlay_chord_latched_ = false;
     opennow::input::OverlayChordState overlay_chord_state_;