Record Keyboard Controller

Common/Cpp/Json/JsonObject.h

@@ -18,6 +18,13 @@ class JsonObject{
     JsonObject() = default;
     JsonObject(JsonObject&& x) = default;
     JsonObject& operator=(JsonObject&& x) = default;
+
+    bool operator==(const JsonObject& x){ // TODO: implement == properly. For JsonValue as well.
+        return dump() == x.dump();
+    }
+    bool operator!=(const JsonObject& x){
+        return !(*this == *this);
+    }
 private:
     //  Private to avoid accidental copying.
     JsonObject(const JsonObject& x);

Common/Cpp/StringTools.cpp

@@ -6,6 +6,7 @@
 
 #include <stdint.h>
 #include <stdexcept>
+#include <vector>
 #include "StringTools.h"
 
 namespace PokemonAutomation{
@@ -48,6 +49,21 @@ size_t to_size_t(const std::string& str){
     }
 }
 
+std::vector<std::string> split(const std::string& str, const std::string& delimiter) {
+    std::vector<std::string> tokens;
+    size_t start = 0;
+    size_t end = str.find(delimiter);
+
+    while (end != std::string::npos) {
+        tokens.push_back(str.substr(start, end - start));
+        start = end + delimiter.length();
+        end = str.find(delimiter, start);
+    }
+
+    tokens.push_back(str.substr(start));
+    return tokens;
+}
+
 
 }
 }

Common/Cpp/StringTools.h

@@ -21,6 +21,8 @@ std::string strip(const std::string& str);
 // Parse str to size_t. Return SIZE_MAX if parsing fails
 size_t to_size_t(const std::string& str);
 
+std::vector<std::string> split(const std::string& str, const std::string& delimiter);
+
 }
 }
 #endif

Common/Qt/Options/BoxFloatWidget.cpp

@@ -7,6 +7,7 @@
 #include <QHBoxLayout>
 #include <QVBoxLayout>
 #include <QLabel>
+#include "Common/Cpp/StringTools.h"
 #include "BoxFloatWidget.h"
 
 //#include <iostream>
@@ -24,21 +25,6 @@ ConfigWidget* BoxFloatOption::make_QtWidget(QWidget& parent){
 
 
 
-std::vector<std::string> split(const std::string& str, const std::string& delimiter) {
-    std::vector<std::string> tokens;
-    size_t start = 0;
-    size_t end = str.find(delimiter);
-
-    while (end != std::string::npos) {
-        tokens.push_back(str.substr(start, end - start));
-        start = end + delimiter.length();
-        end = str.find(delimiter, start);
-    }
-
-    tokens.push_back(str.substr(start));
-    return tokens;
-}
-
 
 
 BoxFloatWidget::~BoxFloatWidget(){
@@ -167,7 +153,7 @@ BoxFloatWidget::BoxFloatWidget(QWidget& parent, BoxFloatOption& value)
     connect(
         m_array, &QLineEdit::editingFinished,
         this, [this](){
-            std::vector<std::string> all_coords = split(m_array->text().toStdString(), ", ");
+            std::vector<std::string> all_coords = StringTools::split(m_array->text().toStdString(), ", ");
             if (all_coords.size() != 4){
                 return;
             }

SerialPrograms/CMakeLists.txt

@@ -701,6 +701,8 @@ file(GLOB MAIN_SOURCES
     Source/Controllers/JoystickTools.h
     Source/Controllers/KeyboardInput/GlobalQtKeyMap.cpp
     Source/Controllers/KeyboardInput/GlobalQtKeyMap.h
+    Source/Controllers/KeyboardInput/KeyboardEventHandler.cpp
+    Source/Controllers/KeyboardInput/KeyboardEventHandler.h
     Source/Controllers/KeyboardInput/KeyboardInput.cpp
     Source/Controllers/KeyboardInput/KeyboardInput.h
     Source/Controllers/KeyboardInput/KeyboardStateTracker.cpp
@@ -1119,6 +1121,8 @@ file(GLOB MAIN_SOURCES
     Source/NintendoSwitch/Programs/NintendoSwitch_PreventSleep.h
     Source/NintendoSwitch/Programs/NintendoSwitch_PushJoySticks.cpp
     Source/NintendoSwitch/Programs/NintendoSwitch_PushJoySticks.h
+    Source/NintendoSwitch/Programs/NintendoSwitch_RecordKeyboardController.cpp
+    Source/NintendoSwitch/Programs/NintendoSwitch_RecordKeyboardController.h
     Source/NintendoSwitch/Programs/NintendoSwitch_SnapshotDumper.cpp
     Source/NintendoSwitch/Programs/NintendoSwitch_SnapshotDumper.h
     Source/NintendoSwitch/Programs/NintendoSwitch_SwitchViewer.cpp

SerialPrograms/Source/Controllers/Controller.h

@@ -10,6 +10,7 @@
 #include "Common/Compiler.h"
 #include "Common/Cpp/AbstractLogger.h"
 #include "Common/Cpp/Time.h"
+#include "Controllers/KeyboardInput/KeyboardEventHandler.h"
 #include "Common/Cpp/CancellableScope.h"
 
 class QKeyEvent;
@@ -19,6 +20,7 @@ namespace PokemonAutomation{
 class RecursiveThrottler;
 enum class ControllerType;
 enum class ControllerPerformanceClass;
+enum class ControllerClass;
 
 
 
@@ -64,6 +66,7 @@ class AbstractController{
 
     virtual const char* name() = 0;
     virtual ControllerType controller_type() const = 0;
+    virtual ControllerClass controller_class() const = 0;
     virtual ControllerPerformanceClass performance_class() const = 0;
 
     //  If the controller is polled at a fixed interval, this is that interval.
@@ -203,6 +206,9 @@ class AbstractController{
     virtual void keyboard_release_all(){}
     virtual void keyboard_press(const QKeyEvent& event){}
     virtual void keyboard_release(const QKeyEvent& event){}
+
+    virtual void add_keyboard_listener(KeyboardEventHandler::KeyboardListener& keyboard_listener){};
+    virtual void remove_keyboard_listener(KeyboardEventHandler::KeyboardListener& keyboard_listener){};
 };
 
 
@@ -294,6 +300,7 @@ class ControllerContext final : public CancellableScope{
 };
 
 
+using AbstractControllerContext = ControllerContext<AbstractController>;
 
 using AbstractControllerContext = ControllerContext<AbstractController>;
 

SerialPrograms/Source/Controllers/ControllerTypeStrings.cpp

@@ -32,6 +32,16 @@ const EnumStringMap<ControllerType> CONTROLLER_TYPE_STRINGS{
     {ControllerType::NintendoSwitch2_RightJoycon,           "NS2: Right Joycon"},
 };
 
+const EnumStringMap<ControllerClass>& CONTROLLER_CLASS_STRINGS(){
+    static EnumStringMap<ControllerClass> database{
+        {ControllerClass::NONE,                                  "none"},
+        {ControllerClass::LEFT_JOYCON,                           "left-joycon"},
+        {ControllerClass::RIGHT_JOYCON,                          "right-joycon"},
+        {ControllerClass::PRO_CONTROLLER,                        "pro-controller"},
+    };
+    return database;
+}
+
 
 
 

SerialPrograms/Source/Controllers/ControllerTypeStrings.h

@@ -16,6 +16,7 @@ namespace PokemonAutomation{
 
 extern const EnumStringMap<ControllerInterface> CONTROLLER_INTERFACE_STRINGS;
 extern const EnumStringMap<ControllerType> CONTROLLER_TYPE_STRINGS;
+const EnumStringMap<ControllerClass>& CONTROLLER_CLASS_STRINGS();
 
 
 

SerialPrograms/Source/Controllers/ControllerTypes.h

@@ -44,6 +44,14 @@ enum class ControllerPerformanceClass{
     SysbotBase,
 };
 
+enum class ControllerClass{
+    NONE,
+    LEFT_JOYCON,
+    RIGHT_JOYCON,
+    PRO_CONTROLLER,
+    KEYBOARD,
+};
+
 
 
 

SerialPrograms/Source/Controllers/KeyboardInput/KeyboardEventHandler.cpp

@@ -0,0 +1,47 @@
+/*  Keyboard Event Handler
+ *
+ */
+#include "Common/Cpp/ListenerSet.h"
+#include "Common/Cpp/Containers/Pimpl.tpp"
+#include "Controllers/KeyboardInput/KeyboardInput.h"
+#include "KeyboardEventHandler.h"
+
+namespace PokemonAutomation{
+
+
+
+struct KeyboardEventHandler::Data{
+    ListenerSet<KeyboardListener> m_listeners;
+};
+
+KeyboardEventHandler::KeyboardEventHandler()
+    : m_data(CONSTRUCT_TOKEN)
+{}
+
+KeyboardEventHandler::~KeyboardEventHandler() = default;
+
+void KeyboardEventHandler::add_listener(KeyboardListener& listener){
+    auto scope = m_lifetime_sanitizer.check_scope();
+    Data& data = *m_data;
+    data.m_listeners.add(listener);
+}
+void KeyboardEventHandler::remove_listener(KeyboardListener& listener){
+    auto scope = m_lifetime_sanitizer.check_scope();
+    Data& data = *m_data;
+    data.m_listeners.remove(listener);
+}
+
+void KeyboardEventHandler::report_keyboard_command_sent(WallClock time_stamp, const ControllerState& state){
+    auto scope = m_lifetime_sanitizer.check_scope();
+    Data& data = *m_data;
+    data.m_listeners.run_method_unique(&KeyboardListener::on_keyboard_command_sent, time_stamp, state);
+}
+
+void KeyboardEventHandler::report_keyboard_command_stopped(WallClock time_stamp){
+    auto scope = m_lifetime_sanitizer.check_scope();
+    Data& data = *m_data;
+    data.m_listeners.run_method_unique(&KeyboardListener::on_keyboard_command_stopped, time_stamp);
+}
+
+
+}

SerialPrograms/Source/Controllers/KeyboardInput/KeyboardEventHandler.h

@@ -0,0 +1,46 @@
+/*  Keyboard Event Handler
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+
+#ifndef PokemonAutomation_Controllers_KeyboardEventHandler_H
+#define PokemonAutomation_Controllers_KeyboardEventHandler_H
+
+#include "Common/Cpp/Containers/Pimpl.h"
+#include "Common/Cpp/Time.h"
+#include "Common/Cpp/LifetimeSanitizer.h"
+
+namespace PokemonAutomation{
+
+class ControllerState;  // forward declaration to avoid circular dependency
+
+class KeyboardEventHandler{
+public:
+    KeyboardEventHandler();
+    virtual ~KeyboardEventHandler();
+
+    struct KeyboardListener{
+        virtual void on_keyboard_command_sent(WallClock time_stamp, const ControllerState& state) = 0;
+        virtual void on_keyboard_command_stopped(WallClock time_stamp) = 0;
+    };
+    void add_listener(KeyboardListener& listener);
+    void remove_listener(KeyboardListener& listener);
+
+protected:
+    //  Report that the keyboard state has changed. This will be pushed to
+    //  all listeners.
+    void report_keyboard_command_sent(WallClock time_stamp, const ControllerState& state);
+
+    void report_keyboard_command_stopped(WallClock time_stamp);
+
+private:
+    struct Data;
+    Pimpl<Data> m_data;
+
+    LifetimeSanitizer m_lifetime_sanitizer;
+};
+
+}
+#endif

SerialPrograms/Source/Controllers/KeyboardInput/KeyboardInput.h

@@ -11,9 +11,11 @@
 #include <thread>
 #include <condition_variable>
 #include <Qt>
+#include "Common/Cpp/Json/JsonObject.h"
 #include "Common/Cpp/Concurrency/SpinLock.h"
 #include "Controllers/Controller.h"
 #include "Controllers/KeyboardInput/GlobalQtKeyMap.h"
+#include "KeyboardEventHandler.h"
 #include "KeyboardStateTracker.h"
 
 class QKeyEvent;
@@ -36,6 +38,8 @@ class ControllerState{
     virtual bool operator!=(const ControllerState& x) const{ return !(*this == x); }
 
     virtual bool is_neutral() const = 0;
+
+    virtual JsonObject serialize_state() const {return JsonObject();};
 };
 
 
@@ -86,7 +90,7 @@ class KeyboardInputController{
 
 
 template <typename StateType, typename DeltaType>
-class KeyboardManager : public KeyboardInputController{
+class KeyboardManager : public KeyboardInputController, public KeyboardEventHandler{
 public:
     KeyboardManager(Logger& logger, AbstractController& controller)
         : KeyboardInputController(logger, true)
@@ -126,7 +130,9 @@ class KeyboardManager : public KeyboardInputController{
         if (m_controller == nullptr){
             return;
         }
+        WallClock time_stamp = current_time();
         m_controller->cancel_all_commands();
+        report_keyboard_command_stopped(time_stamp);
     }
     virtual void replace_on_next_command() override{
         WriteSpinLock lg(m_lock);

SerialPrograms/Source/Controllers/StandardHid/StandardHid_Keyboard_SerialPABotBase.h

@@ -53,6 +53,9 @@ class SerialPABotBase_Keyboard final :
     virtual ControllerType controller_type() const override{
         return ControllerType::HID_Keyboard;
     }
+    virtual ControllerClass controller_class() const override{
+        return ControllerClass::KEYBOARD;
+    }
     virtual ControllerPerformanceClass performance_class() const override{
         return ControllerPerformanceClass::SerialPABotBase_Wired;
     }

SerialPrograms/Source/NintendoSwitch/Commands/NintendoSwitch_Commands_PushButtons.cpp

@@ -118,6 +118,19 @@ void pbf_mash_button(JoyconContext& context, Button button, Milliseconds duratio
     ssf_mash1_button(context, button, duration);
 }
 
+void pbf_controller_state(
+    JoyconContext& context,
+    Button button,
+    uint8_t x, uint8_t y,
+    Milliseconds duration
+){
+    context->issue_full_controller_state(
+        &context,
+        button,
+        x, y,
+        duration
+    );
+}
 
 
 

SerialPrograms/Source/NintendoSwitch/Commands/NintendoSwitch_Commands_PushButtons.h

@@ -121,7 +121,12 @@ void pbf_press_button   (JoyconContext& context, Button button, Milliseconds hol
 void pbf_move_joystick  (JoyconContext& context, uint8_t x, uint8_t y, Milliseconds hold, Milliseconds release);
 void pbf_mash_button    (JoyconContext& context, Button button, Milliseconds duration);
 
-
+void pbf_controller_state(
+    JoyconContext& context,
+    Button button,
+    uint8_t x, uint8_t y,
+    Milliseconds duration
+);
 
 
 }