In-client protocol debugger

Optional (of course). Thanks to an idea @Amrsatrio had.

Author: mos9527

CMakeLists.txt

@@ -87,12 +87,18 @@ if (MDR_BUILD_WITH_ASAN)
 endif ()
 
 option(MDR_DEBUG "Build with debug flags enabled (also always on for Debug builds)" OFF)
+option(MDR_DEBUG_TRAPS "Break into the debugger when MDR operations fail in Debug builds" OFF)
+option(MDR_CLIENT_DEBUGGER "Build the ImGui packet debugger in all configurations" OFF)
+set(MDR_CLIENT_DEBUGGER_TARGET OFF)
+if (MDR_CLIENT_DEBUGGER OR CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_CONFIGURATION_TYPES)
+    set(MDR_CLIENT_DEBUGGER_TARGET ON)
+endif ()
 if (CMAKE_BUILD_TYPE STREQUAL "Debug")
     set(MDR_DEBUG ON)
 endif ()
 add_compile_definitions(
     $<$<OR:$<BOOL:${MDR_DEBUG}>,$<CONFIG:Debug>>:MDR_DEBUG>
-    $<$<CONFIG:Debug>:MDR_DEBUG_TRAPS>
+    $<$<AND:$<BOOL:${MDR_DEBUG_TRAPS}>,$<CONFIG:Debug>>:MDR_DEBUG_TRAPS>
 )
 if (MDR_DEBUG)
     message(STATUS "Debugging features *ON*. Enjoy the logs.")

client/CMakeLists.txt

@@ -1,5 +1,35 @@
 set(CLIENT_VERSION "2.0.0")
 
+set(CLIENT_DEBUGGER_GENERATED_SOURCES
+    "${CMAKE_CURRENT_SOURCE_DIR}/Generated/ProtocolV1T1Debugger.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/Generated/ProtocolV1T2Debugger.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/Generated/ProtocolV2T1Debugger.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/Generated/ProtocolV2T2Debugger.cpp"
+)
+
+if (MDR_CLIENT_DEBUGGER_TARGET AND COMMAND mdr_add_codegen)
+    mdr_add_codegen(OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/Generated/ProtocolV1T1Debugger.cpp"
+        TOOL      tooling_DebuggerCodegen
+        INPUT     "${CMAKE_SOURCE_DIR}/libmdr/include/mdr/ProtocolV1T1.hpp"
+        NAMESPACE "mdr::v1::t1"
+        INCLUDE   "mdr/ProtocolV1T1.hpp")
+    mdr_add_codegen(OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/Generated/ProtocolV1T2Debugger.cpp"
+        TOOL      tooling_DebuggerCodegen
+        INPUT     "${CMAKE_SOURCE_DIR}/libmdr/include/mdr/ProtocolV1T2.hpp"
+        NAMESPACE "mdr::v1::t2"
+        INCLUDE   "mdr/ProtocolV1T2.hpp")
+    mdr_add_codegen(OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/Generated/ProtocolV2T1Debugger.cpp"
+        TOOL      tooling_DebuggerCodegen
+        INPUT     "${CMAKE_SOURCE_DIR}/libmdr/include/mdr/ProtocolV2T1.hpp"
+        NAMESPACE "mdr::v2::t1"
+        INCLUDE   "mdr/ProtocolV2T1.hpp")
+    mdr_add_codegen(OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/Generated/ProtocolV2T2Debugger.cpp"
+        TOOL      tooling_DebuggerCodegen
+        INPUT     "${CMAKE_SOURCE_DIR}/libmdr/include/mdr/ProtocolV2T2.hpp"
+        NAMESPACE "mdr::v2::t2"
+        INCLUDE   "mdr/ProtocolV2T2.hpp")
+endif ()
+
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${SOURCES} ${INCLUDES})
 
 if (MDR_PLATFORM_OS STREQUAL "WIN32")
@@ -23,6 +53,7 @@ target_sources(
         PRIVATE
         SDLMain.cpp
         Client.cpp
+        PacketObserver.cpp
         PayloadRecorder.cpp
         Fonts/PlexSansIcon.c
 )
@@ -79,6 +110,29 @@ target_include_directories(ImGuiSDL3 PUBLIC
         .
 )
 
+if (MDR_CLIENT_DEBUGGER_TARGET)
+    add_library(Client_Debugger STATIC
+        Debugger.cpp
+        Debugger.hpp
+        DebuggerDetails.hpp
+        ${CLIENT_DEBUGGER_GENERATED_SOURCES}
+    )
+    target_link_libraries(Client_Debugger PUBLIC mdr ImGuiSDL3)
+    target_include_directories(Client_Debugger PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}")
+endif ()
+
+if (MDR_CLIENT_DEBUGGER_TARGET)
+    set(CLIENT_DEBUGGER_ENABLED
+        $<OR:$<BOOL:${MDR_CLIENT_DEBUGGER}>,$<CONFIG:Debug>>
+    )
+    target_link_libraries(SonyHeadphonesClient PRIVATE
+        $<${CLIENT_DEBUGGER_ENABLED}:Client_Debugger>
+    )
+    target_compile_definitions(SonyHeadphonesClient PRIVATE
+        $<${CLIENT_DEBUGGER_ENABLED}:MDR_CLIENT_DEBUGGER>
+    )
+endif ()
+
 set(CLIENT_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}")
 add_subdirectory(Platform)
 

client/Client.cpp

@@ -18,11 +18,17 @@
 #include <mdr/Protocol.hpp>
 #include "Fonts/PlexSansIcon.h"
 #include "MaterialYouTheme.hpp"
+#include "PacketObserver.hpp"
 #include "Platform/Platform.hpp"
-#include "PayloadRecorder.hpp"
+#ifdef MDR_CLIENT_DEBUGGER
+#include "Debugger.hpp"
+#endif
 
 MDRHeadphones* gDevice;
 mdr::String gHeadphonesError;
+#ifdef MDR_CLIENT_DEBUGGER
+bool gDebuggerOpen{};
+#endif
 
 template <typename T>
 T MDRStruct()
@@ -373,7 +379,11 @@ void CloseDevice()
 {
     if (!gDevice)
         return;
+#ifdef MDR_CLIENT_DEBUGGER
+    gDebuggerOpen = false;
+#endif
     gHeadphonesError = GetText(MDR_TEXT_LAST_ERROR);
+    clientPacketObserverDetach();
     mdrHeadphonesDestroy(gDevice);
     gDevice = nullptr;
 }
@@ -893,7 +903,7 @@ void DrawDeviceConnecting()
             DisconnectWithModal();
             return;
         }
-        clientPayloadRecorderAttach(gDevice);
+        clientPacketObserverAttach(gDevice);
         if (mdrHeadphonesRequestInit(gDevice) != MDR_RESULT_OK)
             DisconnectWithModal();
 
@@ -970,6 +980,10 @@ void DrawDeviceControlsHeader()
                     }
                 }
             }
+#ifdef MDR_CLIENT_DEBUGGER
+            ImGui::Separator();
+            ImGui::MenuItem("Protocol Debugger", nullptr, &gDebuggerOpen);
+#endif
             ImGui::EndMenu();
         }
         if (!gDevice)
@@ -1012,7 +1026,7 @@ void DrawDeviceControlsHeader()
             ImVec2 size = ImGui::CalcTextSize(s);
             badgeRegionX += size.x + padding.x * 2, badgeRegionY = std::max(badgeRegionY, size.y);
         }
-        ImGui::SameLine(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - badgeRegionX);
+        ImGui::SameLine(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - badgeRegionX - padding.x * 2);
         float rounding = style.FrameRounding;
         float offsetY = padding.y / 2;
         for (auto& [s, border, text] : badges)
@@ -1801,6 +1815,10 @@ void DrawApp()
         }
     }
     ImGui::End();
+#ifdef MDR_CLIENT_DEBUGGER
+    if (gDebuggerOpen || ImGui::IsPopupOpen("Command Playground"))
+        clientDebuggerDraw(&gDebuggerOpen);
+#endif
 }
 
 bool clientShouldExit()