Add stream history for real this time. (still buggy though)

Author: Mysticial

SerialPrograms/CMakeLists.txt

@@ -512,8 +512,11 @@ file(GLOB MAIN_SOURCES
     Source/CommonFramework/Recording/StreamHistorySession.cpp
     Source/CommonFramework/Recording/StreamHistorySession.h
     Source/CommonFramework/Recording/StreamHistoryTracker_Null.h
+    Source/CommonFramework/Recording/StreamHistoryTracker_ParallelStreams.h
     Source/CommonFramework/Recording/StreamHistoryTracker_RecordOnTheFly.h
     Source/CommonFramework/Recording/StreamHistoryTracker_SaveFrames.h
+    Source/CommonFramework/Recording/StreamRecorder.cpp
+    Source/CommonFramework/Recording/StreamRecorder.h
     Source/CommonFramework/Resources/SpriteDatabase.cpp
     Source/CommonFramework/Resources/SpriteDatabase.h
     Source/CommonFramework/SetupSettings.cpp

SerialPrograms/SerialPrograms.pro

@@ -272,6 +272,7 @@ SOURCES += \
     Source/CommonFramework/PersistentSettings.cpp \
     Source/CommonFramework/ProgramSession.cpp \
     Source/CommonFramework/Recording/StreamHistorySession.cpp \
+    Source/CommonFramework/Recording/StreamRecorder.cpp \
     Source/CommonFramework/Resources/SpriteDatabase.cpp \
     Source/CommonFramework/SetupSettings.cpp \
     Source/CommonFramework/Tools/BlackBorderCheck.cpp \
@@ -1365,6 +1366,7 @@ HEADERS += \
     Source/CommonFramework/Recording/StreamHistorySession.h \
     Source/CommonFramework/Recording/StreamHistoryTracker_RecordOnTheFly.h \
     Source/CommonFramework/Recording/StreamHistoryTracker_SaveFrames.h \
+    Source/CommonFramework/Recording/StreamRecorder.h \
     Source/CommonFramework/Resources/SpriteDatabase.h \
     Source/CommonFramework/SetupSettings.h \
     Source/CommonFramework/Tools/BlackBorderCheck.h \

SerialPrograms/Source/CommonFramework/AudioPipeline/AudioStream.h

@@ -7,6 +7,7 @@
 #ifndef PokemonAutomation_AudioPipeline_AudioSourceReader_H
 #define PokemonAutomation_AudioPipeline_AudioSourceReader_H
 
+#include "Common/Cpp/Time.h"
 #include "Common/Cpp/StreamConverters.h"
 #include "Common/Cpp/Containers/AlignedVector.h"
 #include "AudioInfo.h"

SerialPrograms/Source/CommonFramework/ErrorReports/ErrorReports.cpp

@@ -57,7 +57,7 @@ ErrorReportOption::ErrorReportOption()
         true
     )
     , VIDEO(
-        "<b>Include Video:</b><br>Include a video leading up to the error. (if possible)",
+        "<b>Include Video:</b><br>Include a video leading up to the error. (if available)",
         LockMode::UNLOCK_WHILE_RUNNING,
         true
     )
@@ -80,9 +80,7 @@ ErrorReportOption::ErrorReportOption()
     PA_ADD_STATIC(DESCRIPTION);
     PA_ADD_OPTION(SEND_MODE);
     PA_ADD_OPTION(SCREENSHOT);
-    if (PreloadSettings::instance().DEVELOPER_MODE){
-        PA_ADD_OPTION(VIDEO);
-    }
+    PA_ADD_OPTION(VIDEO);
     PA_ADD_OPTION(LOGS);
     PA_ADD_OPTION(DUMPS);
     if (PreloadSettings::instance().DEVELOPER_MODE){
@@ -179,7 +177,7 @@ SendableErrorReport::SendableErrorReport(std::string directory)
         const std::string* image_name = obj.get_string("Screenshot");
         if (image_name){
             try{
-                m_image_owner = ImageRGB32(*image_name);
+                m_image_owner = ImageRGB32(m_directory + *image_name);
                 m_image = m_image_owner;
             }catch (FileException&){}
         }
@@ -238,9 +236,8 @@ void SendableErrorReport::save(Logger* logger) const{
         report["Messages"] = std::move(messages);
     }
     if (m_image){
-        std::string image_name = m_directory + "Screenshot.png";
-        if (m_image.save(image_name)){
-            report["Screenshot"] = std::move(image_name);
+        if (m_image.save(m_directory + "Screenshot.png")){
+            report["Screenshot"] = "Screenshot.png";
         }
     }
     if (!m_video_name.empty()){

SerialPrograms/Source/CommonFramework/GlobalSettingsPanel.cpp

@@ -52,11 +52,18 @@ ResolutionOption::ResolutionOption(
 }
 
 StreamHistoryOption::StreamHistoryOption()
-    : GroupOption("Stream History", LockMode::LOCK_WHILE_RUNNING, true, false)
+    : GroupOption(
+        "Stream History",
+        LockMode::LOCK_WHILE_RUNNING,
+        true,
+        IS_BETA_VERSION
+    )
     , DESCRIPTION(
-        "Keep a record of this many seconds of video+audio. This will allow video capture for unexpected events.<br>"
-        "<font color=\"red\">Warning (Developer Only): The current implementation is inefficient and requires "
-        "10 GB of ram to store just 30 seconds of video. This feature is still a work-in-progress."
+        "Keep a record of this many seconds of video+audio. This will allow "
+        "video capture for unexpected events.<br>"
+        "<font color=\"orange\">Warning: The current implementation is inefficient "
+        "and may write a lot of data to disk. "
+        "This feature is still a work-in-progress."
         "</font>"
     )
     , VIDEO_HISTORY_SECONDS(
@@ -285,10 +292,10 @@ GlobalSettings::GlobalSettings()
 #if QT_VERSION_MAJOR == 5
     PA_ADD_OPTION(ENABLE_FRAME_SCREENSHOTS);
 #endif
-#if QT_VERSION_MAJOR >= 6
-    if (PreloadSettings::instance().DEVELOPER_MODE){
-        PA_ADD_OPTION(STREAM_HISTORY);
-    }
+#if (QT_VERSION_MAJOR == 6) && (QT_VERSION_MINOR >= 8)
+    PA_ADD_OPTION(STREAM_HISTORY);
+#else
+    STREAM_HISTORY.set_enabled(false);
 #endif
 
     PA_ADD_OPTION(AUTO_RESET_AUDIO_SECONDS);

SerialPrograms/Source/CommonFramework/Globals.cpp

@@ -25,7 +25,7 @@ namespace PokemonAutomation{
 const bool IS_BETA_VERSION = true;
 const int PROGRAM_VERSION_MAJOR = 0;
 const int PROGRAM_VERSION_MINOR = 50;
-const int PROGRAM_VERSION_PATCH = 9;
+const int PROGRAM_VERSION_PATCH = 10;
 
 const std::string PROGRAM_VERSION_BASE =
     "v" + std::to_string(PROGRAM_VERSION_MAJOR) +
@@ -68,6 +68,10 @@ const std::string COMPILER_VERSION = "Unknown Compiler";
 #endif
 
 
+
+const size_t LOG_HISTORY_LINES = 2000;
+
+
 namespace{
 
 QString get_application_base_dir_path(){

SerialPrograms/Source/CommonFramework/Globals.h

@@ -33,6 +33,8 @@ extern const std::string COMPILER_VERSION;
 
 const auto SERIAL_REFRESH_RATE = std::chrono::milliseconds(1000);
 
+extern const size_t LOG_HISTORY_LINES;
+
 // Folder path (end with "/") to hold program setting files.
 const std::string& SETTINGS_PATH();
 

SerialPrograms/Source/CommonFramework/Logging/FileWindowLogger.cpp

@@ -7,7 +7,7 @@
 #include <QCoreApplication>
 #include <QMenuBar>
 #include <QDir>
-#include <CommonFramework/Globals.h>
+#include "CommonFramework/Globals.h"
 #include "CommonFramework/Windows/DpiScaler.h"
 #include "CommonFramework/Windows/WindowTracker.h"
 #include "FileWindowLogger.h"
@@ -46,7 +46,7 @@ FileWindowLogger::~FileWindowLogger(){
 }
 FileWindowLogger::FileWindowLogger(const std::string& path)
     : m_file(QString::fromStdString(path))
-    , m_max_queue_size(10000)
+    , m_max_queue_size(LOG_HISTORY_LINES)
     , m_stopping(false)
     , m_thread(&FileWindowLogger::thread_loop, this)
 {

SerialPrograms/Source/CommonFramework/Recording/StreamHistorySession.cpp

@@ -11,8 +11,9 @@
 #include "CommonFramework/VideoPipeline/Backends/VideoFrameQt.h"
 
 #if (QT_VERSION_MAJOR == 6) && (QT_VERSION_MINOR >= 8)
-#include "StreamHistoryTracker_SaveFrames.h"
+//#include "StreamHistoryTracker_SaveFrames.h"
 //#include "StreamHistoryTracker_RecordOnTheFly.h"
+#include "StreamHistoryTracker_ParallelStreams.h"
 #else
 #include "StreamHistoryTracker_Null.h"
 #endif
@@ -61,7 +62,7 @@ void StreamHistorySession::start(AudioChannelFormat format){
 
 class HistorySaverThread : public QThread{
 public:
-    HistorySaverThread(Logger& logger, const StreamHistoryTracker& tracker, const std::string& filename)
+    HistorySaverThread(Logger& logger, StreamHistoryTracker& tracker, const std::string& filename)
         : m_logger(logger)
         , m_tracker(tracker)
         , m_filename(filename)
@@ -78,12 +79,13 @@ class HistorySaverThread : public QThread{
         return m_success;
     }
     virtual void run() override{
-        m_success = m_tracker.save(m_logger, m_filename);
+//        m_success = m_tracker.save(m_logger, m_filename);
+        m_success = m_tracker.save(m_filename);
     }
 
 private:
     Logger& m_logger;
-    const StreamHistoryTracker& m_tracker;
+    StreamHistoryTracker& m_tracker;
     const std::string& m_filename;
     bool m_success = false;
 };
@@ -143,19 +145,19 @@ void StreamHistorySession::initialize(){
     switch (data.m_audio_format){
     case AudioChannelFormat::NONE:
         expected_samples_per_frame = 0;
-        data.m_current.reset(new StreamHistoryTracker(0, 0, data.m_window));
+        data.m_current.reset(new StreamHistoryTracker(data.m_logger, 0, 0, data.m_window));
         return;
     case AudioChannelFormat::MONO_48000:
-        data.m_current.reset(new StreamHistoryTracker(1, 48000, data.m_window));
+        data.m_current.reset(new StreamHistoryTracker(data.m_logger, 1, 48000, data.m_window));
         return;
     case AudioChannelFormat::DUAL_44100:
-        data.m_current.reset(new StreamHistoryTracker(1, 44100, data.m_window));
+        data.m_current.reset(new StreamHistoryTracker(data.m_logger, 1, 44100, data.m_window));
         return;
     case AudioChannelFormat::DUAL_48000:
     case AudioChannelFormat::MONO_96000:
     case AudioChannelFormat::INTERLEAVE_LR_96000:
     case AudioChannelFormat::INTERLEAVE_RL_96000:
-        data.m_current.reset(new StreamHistoryTracker(2, 48000, data.m_window));
+        data.m_current.reset(new StreamHistoryTracker(data.m_logger, 2, 48000, data.m_window));
         return;
     default:
         throw InternalProgramError(

SerialPrograms/Source/CommonFramework/Recording/StreamHistoryTracker_Null.h

@@ -19,14 +19,17 @@ namespace PokemonAutomation{
 class StreamHistoryTracker{
 public:
     StreamHistoryTracker(
+        Logger& logger,
         size_t audio_samples_per_frame,
         size_t audio_frames_per_second,
         std::chrono::seconds window
-    ){}
+    )
+        : m_logger(logger)
+    {}
     void set_window(std::chrono::seconds window){}
 
-    bool save(Logger& logger, const std::string& filename) const{
-        logger.log("Cannot save stream history: Not implemented.", COLOR_RED);
+    bool save(const std::string& filename) const{
+        m_logger.log("Cannot save stream history: Not implemented.", COLOR_RED);
         return false;
     }
 
@@ -35,6 +38,7 @@ class StreamHistoryTracker{
     void on_frame(std::shared_ptr<VideoFrame> frame){}
 
 private:
+    Logger& m_logger;
 };