Reduce dependency on ConsoleHandle in infra.

Mysticial · Mysticial · commit e77a26683494 · 2025-01-14T22:27:23.000-08:00
diff --git a/SerialPrograms/Source/CommonFramework/Exceptions/OperationFailedException.h b/SerialPrograms/Source/CommonFramework/Exceptions/OperationFailedException.h
@@ -7,7 +7,7 @@
 #ifndef PokemonAutomation_OperationFailedException_H
 #define PokemonAutomation_OperationFailedException_H
 
-#include "CommonFramework/Tools/ConsoleHandle.h"
+#include "CommonFramework/VideoPipeline/VideoStream.h"
 #include "ScreenshotException.h"
 
 namespace PokemonAutomation{
diff --git a/SerialPrograms/Source/CommonFramework/Exceptions/ProgramFinishedException.cpp b/SerialPrograms/Source/CommonFramework/Exceptions/ProgramFinishedException.cpp
@@ -6,8 +6,6 @@
 
 #include "CommonFramework/ImageTypes/ImageRGB32.h"
 #include "CommonFramework/Notifications/ProgramNotifications.h"
-#include "CommonFramework/Tools/ProgramEnvironment.h"
-#include "CommonFramework/Tools/ConsoleHandle.h"
 #include "ProgramFinishedException.h"
 
 namespace PokemonAutomation{
diff --git a/SerialPrograms/Source/CommonFramework/Exceptions/ProgramFinishedException.h b/SerialPrograms/Source/CommonFramework/Exceptions/ProgramFinishedException.h
@@ -17,7 +17,6 @@ class ImageRGB32;
 class EventNotificationOption;
 struct ProgramInfo;
 class ProgramEnvironment;
-class ConsoleHandle;
 
 
 
diff --git a/SerialPrograms/Source/CommonFramework/Exceptions/ScreenshotException.cpp b/SerialPrograms/Source/CommonFramework/Exceptions/ScreenshotException.cpp
@@ -8,7 +8,7 @@
 #include "CommonFramework/ErrorReports/ErrorReports.h"
 #include "CommonFramework/Notifications/ProgramNotifications.h"
 #include "CommonFramework/VideoPipeline/VideoFeed.h"
-#include "CommonFramework/Tools/ConsoleHandle.h"
+#include "CommonFramework/VideoPipeline/VideoStream.h"
 #include "CommonFramework/Tools/ProgramEnvironment.h"
 #include "ScreenshotException.h"
 
diff --git a/SerialPrograms/Source/CommonFramework/Exceptions/ScreenshotException.h b/SerialPrograms/Source/CommonFramework/Exceptions/ScreenshotException.h
@@ -15,7 +15,7 @@ namespace PokemonAutomation{
 class ImageViewRGB32;
 class ImageRGB32;
 class EventNotificationOption;
-struct VideoStream;
+class VideoStream;
 struct ProgramInfo;
 class ProgramEnvironment;
 
diff --git a/SerialPrograms/Source/CommonFramework/Inference/AudioPerSpectrumDetectorBase.cpp b/SerialPrograms/Source/CommonFramework/Inference/AudioPerSpectrumDetectorBase.cpp
@@ -10,7 +10,6 @@
 #include "Common/Cpp/Exceptions.h"
 #include "CommonFramework/AudioPipeline/AudioFeed.h"
 #include "CommonFramework/Inference/SpectrogramMatcher.h"
-#include "CommonFramework/Tools/ConsoleHandle.h"
 #include "AudioPerSpectrumDetectorBase.h"
 
 #include <iostream>
@@ -21,13 +20,16 @@ namespace PokemonAutomation{
 
 
 AudioPerSpectrumDetectorBase::AudioPerSpectrumDetectorBase(
-    std::string label, std::string audio_name, Color detection_color,
-    ConsoleHandle& console, DetectedCallback detected_callback
+    Logger& logger,
+    std::string label,
+    std::string audio_name,
+    Color detection_color,
+    DetectedCallback detected_callback
 )
     : AudioInferenceCallback(std::move(label))
     , m_audio_name(std::move(audio_name))
     , m_detection_color(detection_color)
-    , m_console(console)
+    , m_logger(logger)
     , m_detected_callback(std::move(detected_callback))
     , m_start_timestamp(current_time())
     , m_spectrums_processed(0)
@@ -47,14 +49,14 @@ void AudioPerSpectrumDetectorBase::throw_if_no_sound(std::chrono::milliseconds m
     if (m_spectrums_processed > 0){
         return;
     }
-    throw UserSetupError(m_console, "No sound detected.");
+    throw UserSetupError(m_logger, "No sound detected.");
 }
 
 void AudioPerSpectrumDetectorBase::log_results(){
     if (m_last_timestamp != WallClock::min()){
-        m_console.log(m_audio_name + " detected! Error Coefficient = " + tostr_default(m_lowest_error), COLOR_BLUE);
+        m_logger.log(m_audio_name + " detected! Error Coefficient = " + tostr_default(m_lowest_error), COLOR_BLUE);
     }else{
-        m_console.log(m_audio_name + " not detected. Error Coefficient = " + tostr_default(m_lowest_error), COLOR_PURPLE);
+        m_logger.log(m_audio_name + " not detected. Error Coefficient = " + tostr_default(m_lowest_error), COLOR_PURPLE);
     }
 
 #if 0
@@ -66,7 +68,7 @@ void AudioPerSpectrumDetectorBase::log_results(){
         for (const auto& error : m_errors){
             ss << "[" << error.first << ":" << error.second << "]";
         }
-//        m_console.log(ss.str(), COLOR_RED);
+//        m_logger.log(ss.str(), COLOR_RED);
         cout << ss.str() << endl;
     }
  #endif
@@ -95,7 +97,7 @@ bool AudioPerSpectrumDetectorBase::process_spectrums(
     const size_t sample_rate = new_spectrums[0].sample_rate;
     // Lazy intialization of the spectrogram matcher.
     if (m_matcher == nullptr || m_matcher->sample_rate() != sample_rate){
-        m_console.log("Loading spectrogram...");
+        m_logger.log("Loading spectrogram...");
         m_matcher = build_spectrogram_matcher(sample_rate);
     }
 
@@ -156,7 +158,7 @@ bool AudioPerSpectrumDetectorBase::process_spectrums(
 
             std::ostringstream os;
             os << m_audio_name << " found, score " << matcher_score << "/" << threshold << ", scale: " << m_matcher->lastMatchedScale();
-            m_console.log(os.str(), COLOR_BLUE);
+            m_logger.log(os.str(), COLOR_BLUE);
             audio_feed.add_overlay(curStamp+1-m_matcher->numMatchedWindows(), curStamp+1, m_detection_color);
 
             // Since the target audio is found, no need to check detection on the rest of the spectrums in `new_spectrums`.
diff --git a/SerialPrograms/Source/CommonFramework/Inference/AudioPerSpectrumDetectorBase.h b/SerialPrograms/Source/CommonFramework/Inference/AudioPerSpectrumDetectorBase.h
@@ -36,7 +36,7 @@
 
 namespace PokemonAutomation{
 
-class ConsoleHandle;
+class Logger;
 class SpectrogramMatcher;
 
 // A virtual base class for audio detectors to match an audio template starting at each incoming
@@ -56,8 +56,11 @@ class AudioPerSpectrumDetectorBase : public AudioInferenceCallback{
     // function. If it returns true, the inference session will stop (by returning true from 
     // AudioPerSpectrumDetectorBase::process_spectrums()).
     AudioPerSpectrumDetectorBase(
-        std::string label, std::string audio_name, Color detection_color,
-        ConsoleHandle& console, DetectedCallback detected_callback
+        Logger& logger,
+        std::string label,
+        std::string audio_name,
+        Color detection_color,
+        DetectedCallback detected_callback
     );
 
     virtual ~AudioPerSpectrumDetectorBase();
@@ -93,7 +96,7 @@ class AudioPerSpectrumDetectorBase : public AudioInferenceCallback{
     // Color of the box to visualize the detection in the audio spectrogram UI.
     Color m_detection_color;
     
-    ConsoleHandle& m_console;
+    Logger& m_logger;
     // Callback function to determine whether to stop the inference session when the target audio
     // is detected.
     DetectedCallback m_detected_callback;
diff --git a/SerialPrograms/Source/CommonFramework/Tools/BlackBorderCheck.cpp b/SerialPrograms/Source/CommonFramework/Tools/BlackBorderCheck.cpp
@@ -5,7 +5,7 @@
  */
 
 #include "Common/Cpp/Exceptions.h"
-#include "CommonFramework/ImageTypes/ImageRGB32.h"
+//#include "CommonFramework/ImageTypes/ImageRGB32.h"
 #include "CommonFramework/VideoPipeline/VideoFeed.h"
 #include "CommonFramework/VideoPipeline/VideoOverlayScopes.h"
 #include "CommonFramework/Tools/ConsoleHandle.h"
@@ -15,26 +15,26 @@
 namespace PokemonAutomation{
 
 
-void start_program_video_check(ConsoleHandle& console, FeedbackType feedback){
+void start_program_video_check(VideoStream& stream, FeedbackType feedback){
     if (feedback == FeedbackType::NONE){
         return;
     }
 
-    VideoSnapshot screen = console.video().snapshot();
+    VideoSnapshot screen = stream.video.snapshot();
 
     if (!screen){
         if (feedback == FeedbackType::REQUIRED || feedback == FeedbackType::VIDEO_AUDIO){
-            throw UserSetupError(console, "This program requires video feedback. Please make sure the video is working.");
+            throw UserSetupError(stream.logger, "This program requires video feedback. Please make sure the video is working.");
         }
         return;
     }
 
     BlackBorderDetector detector;
-    VideoOverlaySet set(console);
+    VideoOverlaySet set(stream.overlay);
     detector.make_overlays(set);
 
     if (detector.detect(screen)){
-        throw UserSetupError(console, "Black border detected! Please set your screen size to 100% in the TV Settings on your Nintendo Switch.");
+        throw UserSetupError(stream.logger, "Black border detected! Please set your screen size to 100% in the TV Settings on your Nintendo Switch.");
     }
 }
 void start_program_video_check(FixedLimitVector<ConsoleHandle>& consoles, FeedbackType feedback){
diff --git a/SerialPrograms/Source/CommonFramework/Tools/BlackBorderCheck.h b/SerialPrograms/Source/CommonFramework/Tools/BlackBorderCheck.h
@@ -12,10 +12,11 @@
 
 namespace PokemonAutomation{
 
+class VideoStream;
 class ConsoleHandle;
 
 
-void start_program_video_check(ConsoleHandle& console, FeedbackType feedback);
+void start_program_video_check(VideoStream& stream, FeedbackType feedback);
 void start_program_video_check(FixedLimitVector<ConsoleHandle>& consoles, FeedbackType feedback);
 
 
diff --git a/SerialPrograms/Source/CommonFramework/Tools/ConsoleHandle.cpp b/SerialPrograms/Source/CommonFramework/Tools/ConsoleHandle.cpp
@@ -36,7 +36,7 @@ ConsoleHandle::ConsoleHandle(
     AudioFeed& audio,
     const StreamHistorySession& history
 )
-    : VideoStream(logger, audio, video, history)
+    : VideoStream({logger, audio, video, history, overlay})
     , m_index(index)
 //    , m_logger(logger)
     , m_botbase(botbase)
diff --git a/SerialPrograms/Source/CommonFramework/Tools/ErrorDumper.cpp b/SerialPrograms/Source/CommonFramework/Tools/ErrorDumper.cpp
@@ -16,7 +16,6 @@
 #include "CommonFramework/ErrorReports/ErrorReports.h"
 #include "CommonFramework/VideoPipeline/VideoFeed.h"
 //#include "CommonFramework/VideoPipeline/VideoOverlay.h"
-#include "ConsoleHandle.h"
 #include "ErrorDumper.h"
 //#include "ProgramEnvironment.h"
 namespace PokemonAutomation{
@@ -68,15 +67,15 @@ void dump_image(
 
 void dump_image_and_throw_recoverable_exception(
     const ProgramInfo& program_info,
-    ConsoleHandle& console,
+    VideoStream& stream,
     const std::string& error_name,
     const std::string& error_message,
     const ImageViewRGB32& screenshot
 ){
     OperationFailedException::fire(
         ErrorReport::SEND_ERROR_REPORT,
         error_message,
-        console
+        stream
     );
 }
 
diff --git a/SerialPrograms/Source/CommonFramework/Tools/ErrorDumper.h b/SerialPrograms/Source/CommonFramework/Tools/ErrorDumper.h
@@ -14,7 +14,7 @@ namespace PokemonAutomation{
 
 class VideoFeed;
 class StreamHistorySession;
-class ConsoleHandle;
+class VideoStream;
 class EventNotificationOption;
 class ImageViewRGB32;
 class Logger;
@@ -44,30 +44,13 @@ void dump_image(
     const std::string& label
 );
 
-#if 0
-// dump a screenshot to ./ErrorDumps/ folder and throw an OperationFailedException.
-// Also send image as telemetry if user allows.
-// notification_error: the notification option used to set whether user wants to receive notifiction for
-//   recoverable error.
-// error_name: the error name, used as the image name and show up on video overlay log. Typical format example:
-//   "NoHatchEnd", "NoYCommFound".
-// error_message: the exception mesage.
-[[noreturn]] void dump_image_and_throw_recoverable_exception(
-    ProgramEnvironment& env,
-    ConsoleHandle& console,
-    EventNotificationOption& notification_error,
-    const std::string& error_name,
-    const std::string& error_message
-);
-#endif
-
 // dump a screenshot to ./ErrorDumps/ folder and throw an OperationFailedException.
 // error_name: the error name, used as the image name and show up on video overlay log. Typical format example:
 //   "NoHatchEnd", "NoYCommFound".
 // error_message: the exception mesage.
 [[noreturn]] void dump_image_and_throw_recoverable_exception(
     const ProgramInfo& program_info,
-    ConsoleHandle& console,
+    VideoStream& stream,
     const std::string& error_name,
     const std::string& error_message,
     const ImageViewRGB32& screenshot = ImageViewRGB32()
diff --git a/SerialPrograms/Source/CommonFramework/Tools/MultiConsoleErrors.cpp b/SerialPrograms/Source/CommonFramework/Tools/MultiConsoleErrors.cpp
@@ -5,20 +5,19 @@
  */
 
 #include "CommonFramework/Exceptions/OperationFailedException.h"
-#include "CommonFramework/Tools/ConsoleHandle.h"
 #include "MultiConsoleErrors.h"
 
 namespace PokemonAutomation{
 
 
 
-void MultiConsoleErrorState::report_unrecoverable_error(ConsoleHandle& console, std::string msg){
-    console.log(msg, COLOR_RED);
+void MultiConsoleErrorState::report_unrecoverable_error(VideoStream& stream, std::string msg){
+    stream.logger.log(msg, COLOR_RED);
     bool expected = false;
     if (m_unrecoverable_error.compare_exchange_strong(expected, true)){
         m_message = msg;
     }
-    OperationFailedException::fire(ErrorReport::NO_ERROR_REPORT, std::move(msg), console);
+    OperationFailedException::fire(ErrorReport::NO_ERROR_REPORT, std::move(msg), stream);
 }
 void MultiConsoleErrorState::check_unrecoverable_error(Logger& logger){
     if (m_unrecoverable_error.load(std::memory_order_acquire)){
diff --git a/SerialPrograms/Source/CommonFramework/Tools/MultiConsoleErrors.h b/SerialPrograms/Source/CommonFramework/Tools/MultiConsoleErrors.h
@@ -13,12 +13,12 @@
 namespace PokemonAutomation{
 
 class Logger;
-class ConsoleHandle;
+class VideoStream;
 
 
 class MultiConsoleErrorState{
 public:
-    void report_unrecoverable_error(ConsoleHandle& console, std::string msg);
+    void report_unrecoverable_error(VideoStream& stream, std::string msg);
     void check_unrecoverable_error(Logger& logger);
 
 private:
diff --git a/SerialPrograms/Source/CommonFramework/Tools/VideoResolutionCheck.cpp b/SerialPrograms/Source/CommonFramework/Tools/VideoResolutionCheck.cpp
@@ -7,7 +7,6 @@
 #include "Common/Cpp/Exceptions.h"
 #include "CommonFramework/ImageTypes/ImageViewRGB32.h"
 #include "CommonFramework/VideoPipeline/VideoFeed.h"
-#include "CommonFramework/Tools/ConsoleHandle.h"
 #include "VideoResolutionCheck.h"
 
 namespace PokemonAutomation{
@@ -25,8 +24,8 @@ void assert_16_9_720p_min(Logger& logger, const ImageViewRGB32& frame){
         throw UserSetupError(logger, "Video aspect ratio must be 16:9.");
     }
 }
-void assert_16_9_720p_min(Logger& logger, ConsoleHandle& console){
-    assert_16_9_720p_min(logger, console.video().snapshot());
+void assert_16_9_720p_min(Logger& logger, VideoFeed& video){
+    assert_16_9_720p_min(logger, video.snapshot());
 }
 
 void assert_16_9_1080p_min(Logger& logger, const ImageViewRGB32& frame){
@@ -41,8 +40,8 @@ void assert_16_9_1080p_min(Logger& logger, const ImageViewRGB32& frame){
         throw UserSetupError(logger, "Video aspect ratio must be 16:9.");
     }
 }
-void assert_16_9_1080p_min(Logger& logger, ConsoleHandle& console){
-    assert_16_9_1080p_min(logger, console.video().snapshot());
+void assert_16_9_1080p_min(Logger& logger, VideoFeed& video){
+    assert_16_9_1080p_min(logger, video.snapshot());
 }
 
 
diff --git a/SerialPrograms/Source/CommonFramework/Tools/VideoResolutionCheck.h b/SerialPrograms/Source/CommonFramework/Tools/VideoResolutionCheck.h
@@ -11,14 +11,14 @@ namespace PokemonAutomation{
 
 class Logger;
 class ImageViewRGB32;
-class ConsoleHandle;
+class VideoFeed;
 
 
 void assert_16_9_720p_min(Logger& logger, const ImageViewRGB32& frame);
-void assert_16_9_720p_min(Logger& logger, ConsoleHandle& console);
+void assert_16_9_720p_min(Logger& logger, VideoFeed& video);
 
 void assert_16_9_1080p_min(Logger& logger, const ImageViewRGB32& frame);
-void assert_16_9_1080p_min(Logger& logger, ConsoleHandle& console);
+void assert_16_9_1080p_min(Logger& logger, VideoFeed& video);
 
 
 
diff --git a/SerialPrograms/Source/CommonFramework/VideoPipeline/VideoStream.h b/SerialPrograms/Source/CommonFramework/VideoPipeline/VideoStream.h
@@ -13,13 +13,16 @@ class Logger;
 class AudioFeed;
 class VideoFeed;
 class StreamHistorySession;
+class VideoOverlay;
 
 
-struct VideoStream{
+class VideoStream{
+public:
     Logger& logger;
     AudioFeed& audio;
     VideoFeed& video;
     const StreamHistorySession& video_history;
+    VideoOverlay& overlay;
 };
 
 
diff --git a/SerialPrograms/Source/PokemonBDSP/Inference/Sounds/PokemonBDSP_ShinySoundDetector.cpp b/SerialPrograms/Source/PokemonBDSP/Inference/Sounds/PokemonBDSP_ShinySoundDetector.cpp
@@ -17,7 +17,13 @@ namespace PokemonBDSP{
 
 ShinySoundDetector::ShinySoundDetector(ConsoleHandle& console, DetectedCallback detected_callback)
     // Use a yellow as the detection color because the shiny animation is yellow.
-    : AudioPerSpectrumDetectorBase("ShinySoundDetector", "Shiny sound", COLOR_YELLOW, console, detected_callback)
+    : AudioPerSpectrumDetectorBase(
+        console,
+        "ShinySoundDetector",
+        "Shiny sound",
+        COLOR_YELLOW,
+        detected_callback
+    )
 {}
 
 
diff --git a/SerialPrograms/Source/PokemonLA/Inference/Sounds/PokemonLA_AlphaMusicDetector.cpp b/SerialPrograms/Source/PokemonLA/Inference/Sounds/PokemonLA_AlphaMusicDetector.cpp
diff --git a/SerialPrograms/Source/PokemonLA/Inference/Sounds/PokemonLA_AlphaRoarDetector.cpp b/SerialPrograms/Source/PokemonLA/Inference/Sounds/PokemonLA_AlphaRoarDetector.cpp
diff --git a/SerialPrograms/Source/PokemonLA/Inference/Sounds/PokemonLA_ItemDropSoundDetector.cpp b/SerialPrograms/Source/PokemonLA/Inference/Sounds/PokemonLA_ItemDropSoundDetector.cpp
diff --git a/SerialPrograms/Source/PokemonLA/Inference/Sounds/PokemonLA_ShinySoundDetector.cpp b/SerialPrograms/Source/PokemonLA/Inference/Sounds/PokemonLA_ShinySoundDetector.cpp
diff --git a/SerialPrograms/Source/PokemonSV/Inference/Battles/PokemonSV_ShinySoundDetector.cpp b/SerialPrograms/Source/PokemonSV/Inference/Battles/PokemonSV_ShinySoundDetector.cpp
diff --git a/SerialPrograms/Source/PokemonSV/Inference/Overworld/PokemonSV_LetsGoKillDetector.cpp b/SerialPrograms/Source/PokemonSV/Inference/Overworld/PokemonSV_LetsGoKillDetector.cpp
diff --git a/SerialPrograms/Source/PokemonSV/Inference/Overworld/PokemonSV_LetsGoKillDetector.h b/SerialPrograms/Source/PokemonSV/Inference/Overworld/PokemonSV_LetsGoKillDetector.h
diff --git a/SerialPrograms/Source/PokemonSwSh/Inference/Sounds/PokemonSwSh_BerryTreeRustlingSoundDetector.cpp b/SerialPrograms/Source/PokemonSwSh/Inference/Sounds/PokemonSwSh_BerryTreeRustlingSoundDetector.cpp

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ ConsoleHandle::ConsoleHandle(`
`36`	`36`	`AudioFeed& audio,`
`37`	`37`	`const StreamHistorySession& history`
`38`	`38`	`)`
`39`		`- : VideoStream(logger, audio, video, history)`
	`39`	`+ : VideoStream({logger, audio, video, history, overlay})`
`40`	`40`	`, m_index(index)`
`41`	`41`	`// , m_logger(logger)`
`42`	`42`	`, m_botbase(botbase)`