copy sound detector and listener for LGPE

Author: kichithewolf

SerialPrograms/CMakeLists.txt

@@ -1375,6 +1375,8 @@ file(GLOB MAIN_SOURCES
     Source/PokemonLA/Resources/PokemonLA_WeatherAndTimeIcons.h
     Source/PokemonLGPE/Commands/PokemonLGPE_DateSpam.cpp
     Source/PokemonLGPE/Commands/PokemonLGPE_DateSpam.h
+    Source/PokemonLGPE/Inference/Sounds/PokemonLGPE_ShinySoundDetector.cpp
+    Source/PokemonLGPE/Inference/Sounds/PokemonLGPE_ShinySoundDetector.h
     Source/PokemonLGPE/Inference/PokemonLGPE_ShinySymbolDetector.cpp
     Source/PokemonLGPE/Inference/PokemonLGPE_ShinySymbolDetector.h
     Source/PokemonLGPE/Programs/Farming/PokemonLGPE_DailyItemFarmer.cpp
@@ -1385,6 +1387,8 @@ file(GLOB MAIN_SOURCES
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_FossilRevival.h
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_GiftReset.cpp
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_GiftReset.h
+    Source/PokemonLGPE/Programs/TestPrograms/PokemonLGPE_SoundListener.cpp
+    Source/PokemonLGPE/Programs/TestPrograms/PokemonLGPE_SoundListener.h
     Source/PokemonLGPE/Programs/PokemonLGPE_GameEntry.cpp
     Source/PokemonLGPE/Programs/PokemonLGPE_GameEntry.h
     Source/PokemonLGPE/PokemonLGPE_Panels.cpp

SerialPrograms/SerialPrograms.pro

@@ -674,11 +674,13 @@ SOURCES += \
     Source/PokemonLA/Resources/PokemonLA_PokemonSprites.cpp \
     Source/PokemonLA/Resources/PokemonLA_WeatherAndTimeIcons.cpp \
     Source/PokemonLGPE/Commands/PokemonLGPE_DateSpam.cpp \
+    Source/PokemonLGPE/Inference/Sounds/PokemonLGPE_ShinySoundDetector.cpp \
     Source/PokemonLGPE/Inference/PokemonLGPE_ShinySymbolDetector.cpp \
     Source/PokemonLGPE/Programs/Farming/PokemonLGPE_DailyItemFarmer.cpp \
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_AlolanTrade.cpp \
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_FossilRevival.cpp \
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_GiftReset.cpp \
+    Source/PokemonLGPE/Programs/TestPrograms/PokemonLGPE_SoundListener.cpp \
     Source/PokemonLGPE/Programs/PokemonLGPE_GameEntry.cpp \
     Source/PokemonLGPE/PokemonLGPE_Panels.cpp \
     Source/PokemonLGPE/PokemonLGPE_Settings.cpp \
@@ -1869,11 +1871,13 @@ HEADERS += \
     Source/PokemonLA/Resources/PokemonLA_PokemonSprites.h \
     Source/PokemonLA/Resources/PokemonLA_WeatherAndTimeIcons.h \
     Source/PokemonLGPE/Commands/PokemonLGPE_DateSpam.h \
+    Source/PokemonLGPE/Inference/Sounds/PokemonLGPE_ShinySoundDetector.h \
     Source/PokemonLGPE/Inference/PokemonLGPE_ShinySymbolDetector.h \
     Source/PokemonLGPE/Programs/Farming/PokemonLGPE_DailyItemFarmer.h \
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_AlolanTrade.h \
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_FossilRevival.h \
     Source/PokemonLGPE/Programs/ShinyHunting/PokemonLGPE_GiftReset.h \
+    Source/PokemonLGPE/Programs/TestPrograms/PokemonLGPE_SoundListener.h \
     Source/PokemonLGPE/Programs/PokemonLGPE_GameEntry.h \
     Source/PokemonLGPE/PokemonLGPE_Panels.h \
     Source/PokemonLGPE/PokemonLGPE_Settings.h \

SerialPrograms/Source/PokemonLGPE/Inference/Sounds/PokemonLGPE_ShinySoundDetector.cpp

@@ -0,0 +1,47 @@
+/*  Shiny Sound Detector
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#include "CommonTools/Audio/AudioTemplateCache.h"
+#include "CommonTools/Audio/SpectrogramMatcher.h"
+#include "NintendoSwitch/NintendoSwitch_ConsoleHandle.h"
+#include "PokemonLGPE/PokemonLGPE_Settings.h"
+#include "PokemonLGPE_ShinySoundDetector.h"
+
+namespace PokemonAutomation{
+namespace NintendoSwitch{
+namespace PokemonLGPE{
+
+
+ShinySoundDetector::ShinySoundDetector(Logger& logger, DetectedCallback detected_callback)
+    // Use a yellow as the detection color because the shiny animation is yellow.
+    : AudioPerSpectrumDetectorBase(
+        logger,
+        "ShinySoundDetector",
+        "Shiny sound",
+        COLOR_YELLOW,
+        detected_callback
+    )
+{}
+
+
+float ShinySoundDetector::get_score_threshold() const{
+    return (float)GameSettings::instance().SHINY_SOUND_THRESHOLD;
+}
+
+std::unique_ptr<SpectrogramMatcher> ShinySoundDetector::build_spectrogram_matcher(size_t sample_rate){
+    return std::make_unique<SpectrogramMatcher>(
+        "Shiny Sound",
+        AudioTemplateCache::instance().get_throw("PokemonLGPE/ShinySound", sample_rate),
+        SpectrogramMatcher::Mode::SPIKE_CONV, sample_rate,
+        GameSettings::instance().SHINY_SOUND_LOW_FREQUENCY
+    );
+}
+
+
+
+}
+}
+}

SerialPrograms/Source/PokemonLGPE/Inference/Sounds/PokemonLGPE_ShinySoundDetector.h

@@ -0,0 +1,36 @@
+/*  Shiny Sound Detector
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#ifndef PokemonAutomation_PokemonLGPE_ShinySoundDetector_H
+#define PokemonAutomation_PokemonLGPE_ShinySoundDetector_H
+
+#include "CommonTools/Audio/AudioPerSpectrumDetectorBase.h"
+
+namespace PokemonAutomation{
+namespace NintendoSwitch{
+namespace PokemonLGPE{
+
+
+class ShinySoundDetector : public AudioPerSpectrumDetectorBase{
+public:
+    //  Warning: The callback will be called from the audio inference thread.
+    ShinySoundDetector(Logger& logger, DetectedCallback detected_callback);
+
+    // Implement AudioPerSpectrumDetectorBase::get_score_threshold()
+    virtual float get_score_threshold() const override;
+
+protected:
+    // Implement AudioPerSpectrumDetectorBase::build_spectrogram_matcher()
+    virtual std::unique_ptr<SpectrogramMatcher> build_spectrogram_matcher(size_t sample_rate) override;
+};
+
+
+
+
+}
+}
+}
+#endif

SerialPrograms/Source/PokemonLGPE/Programs/TestPrograms/PokemonLGPE_SoundListener.cpp

@@ -0,0 +1,97 @@
+/*  Sound Listener
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#include <float.h>
+#include <chrono>
+#include <map>
+#include <iostream>
+#include <fstream>
+#include <sstream>
+#include "Common/Cpp/Exceptions.h"
+#include "Common/Cpp/Containers/AlignedVector.tpp"
+#include "CommonFramework/AudioPipeline/AudioFeed.h"
+#include "CommonFramework/AudioPipeline/AudioTemplate.h"
+#include "CommonTools/Audio/AudioTemplateCache.h"
+#include "CommonTools/Audio/SpectrogramMatcher.h"
+#include "CommonTools/Async/InferenceSession.h"
+#include "Pokemon/Pokemon_Strings.h"
+#include "PokemonLGPE/Inference/Sounds/PokemonLGPE_ShinySoundDetector.h"
+#include "PokemonLGPE_SoundListener.h"
+
+
+namespace PokemonAutomation{
+namespace NintendoSwitch{
+namespace PokemonLGPE{
+    using namespace Pokemon;
+
+
+SoundListener_Descriptor::SoundListener_Descriptor()
+    : SingleSwitchProgramDescriptor(
+        "PokemonLGPE:SoundListener",
+        STRING_POKEMON + " LGPE", "Sound Listener",
+        "",
+        "Test sound detectors listening to audio stream.",
+        FeedbackType::REQUIRED, AllowCommandsWhenRunning::ENABLE_COMMANDS,
+        {ControllerFeature::NintendoSwitch_ProController}
+    )
+{}
+
+
+SoundListener::SoundListener()
+    : SOUND_TYPE("<b>Which Sound to Detect</b>",
+        {
+            {SoundType::SHINY, "shiny", "Shiny Sound"},
+        },
+        LockMode::LOCK_WHILE_RUNNING,
+        SoundType::SHINY
+    )
+    , STOP_ON_DETECTED_SOUND(
+        "<b>Stop on the detected sound</b><br>Stop program when the sound is detected.",
+        LockMode::LOCK_WHILE_RUNNING,
+        false
+    )
+{
+    PA_ADD_OPTION(SOUND_TYPE);
+    PA_ADD_OPTION(STOP_ON_DETECTED_SOUND);
+}
+
+void SoundListener::program(SingleSwitchProgramEnvironment& env, ProControllerContext& context){
+    std::cout << "Running audio test program." << std::endl;
+
+    std::shared_ptr<AudioInferenceCallback> detector;
+    auto action = [&](float error_coefficient) -> bool{
+        // This lambda function will be called when the sound is detected.
+        // Its return will determine whether to stop the program:
+        return STOP_ON_DETECTED_SOUND;
+    };
+
+    SoundType type = SOUND_TYPE;
+    switch (type){
+    case SoundType::SHINY:
+        detector = std::make_shared<ShinySoundDetector>(env.console, action);
+        break;
+    default:
+        throw InternalProgramError(
+            &env.logger(), PA_CURRENT_FUNCTION,
+            "Not such sound detector as sound type " + std::to_string((size_t)type)
+        );
+        return;
+    }
+
+    InferenceSession session(
+        context, env.console,
+        {{*detector, std::chrono::milliseconds(20)}}
+    );
+    context.wait_until_cancel();
+
+    std::cout << "Audio test program Sound listener finished." << std::endl;
+}
+
+
+
+}
+}
+}

SerialPrograms/Source/PokemonLGPE/Programs/TestPrograms/PokemonLGPE_SoundListener.h

@@ -0,0 +1,54 @@
+/*  Sound Listener
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *  
+ *  Debug program to test all kinds of sound detectors.
+ */
+
+#ifndef PokemonAutomation_PokemonLGPE_SoundListener_H
+#define PokemonAutomation_PokemonLGPE_SoundListener_H
+
+#include "Common/Cpp/Options/BooleanCheckBoxOption.h"
+#include "Common/Cpp/Options/EnumDropdownOption.h"
+#include "NintendoSwitch/NintendoSwitch_SingleSwitchProgram.h"
+//#include "NintendoSwitch/Options/NintendoSwitch_GoHomeWhenDoneOption.h"
+
+namespace PokemonAutomation{ 
+namespace NintendoSwitch{
+namespace PokemonLGPE{
+
+
+class SoundListener_Descriptor : public SingleSwitchProgramDescriptor{
+public:
+    SoundListener_Descriptor();
+};
+
+
+class SoundListener : public SingleSwitchProgramInstance{
+public:
+    SoundListener();
+
+    virtual void program(SingleSwitchProgramEnvironment& env, ProControllerContext& context) override;
+
+    virtual void start_program_border_check(
+        CancellableScope& scope,
+        VideoStream& stream,
+        FeedbackType feedback_type
+    ) override{}
+
+private:
+    enum class SoundType{
+        SHINY,
+    };
+
+    EnumDropdownOption<SoundType> SOUND_TYPE;
+    BooleanCheckBoxOption STOP_ON_DETECTED_SOUND;
+};
+
+
+
+
+}
+}
+}
+#endif