Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
/* Pokemon Home Box Spaces Reader
*
* From: https://github.com/PokemonAutomation/
*
*/

#include <charconv>
#include <string>
#include "Common/Cpp/Strings/StringTools.h"
#include "Common/Cpp/TestRunners/UnitTestDatabase.h"
#include "CommonFramework/ImageTools/ImageBoxes.h"
#include "CommonFramework/VideoPipeline/VideoOverlayScopes.h"
#include "CommonTools/OCR/OCR_Routines.h"
#include "Tests/ImageUnitTest.h"
#include "PokemonHome_PageViewDetector.h"
#include "PokemonHome_BoxSpacesReader.h"

namespace PokemonAutomation{
namespace NintendoSwitch{
namespace PokemonHome{
namespace{

const ImageFloatBox PAGE_TITLE(0.177, 0.102, 0.158, 0.042);

}

void BoxSpacesReader::make_overlays(VideoOverlaySet& items) const{
PageViewDetector(m_color).make_overlays(items);
items.add(m_color, PAGE_TITLE);
}

std::optional<size_t> BoxSpacesReader::read_page_number(const ImageViewRGB32& screen) const{
if (!PageViewDetector().detect(screen)){
return std::nullopt;
}
const ImageViewRGB32 title = extract_box_reference(screen, PAGE_TITLE);
if (!title){
return std::nullopt;
}

constexpr size_t OCR_HEIGHT = 64;
const ImageRGB32 scaled = title.scale_to(title.width() * OCR_HEIGHT / title.height(), OCR_HEIGHT);
const std::string text = StringTools::strip(OCR::ocr_read(Language::English, scaled));

// Read the trailing fraction. The label before it depends on the game language.
const size_t slash = text.rfind('/');
if (slash == std::string::npos || slash == 0){
return std::nullopt;
}
const size_t before_number = text.find_last_not_of("0123456789", slash - 1);
const size_t number_start = before_number == std::string::npos ? 0 : before_number + 1;
const char* end = text.data() + text.size();
size_t page = 0;
const auto [page_end, page_error] = std::from_chars(text.data() + number_start, text.data() + slash, page);
if (page_error != std::errc{} || page_end != text.data() + slash){
return std::nullopt;
}

size_t total = 0;
const auto [total_end, total_error] = std::from_chars(text.data() + slash + 1, end, total);
if (total_error != std::errc{} || total_end != end || page == 0 || page > total || total > 10){
return std::nullopt;
}
return page;
}

class Test_BoxSpacesReader : public ImageUnitTest{
public:
Test_BoxSpacesReader(const std::string& image, std::optional<size_t> expected)
: ImageUnitTest("PokemonHome::BoxSpacesReader - " + image, {image})
, m_expected(expected)
{
m_memory += PADDLE_OCR_SINGLE_LINE_MEMORY_ESTIMATE;
}

virtual UnitTestResult run_on_images(
Logger& logger, CancellableScope& scope,
const std::vector<ImageRGB32>& images
) const override{
const auto result = BoxSpacesReader().read_page_number(images[0]);
if (result == m_expected){
return true;
}
return "Expected page " + (m_expected ? std::to_string(*m_expected) : "none")
+ ", read " + (result ? std::to_string(*result) : "none");
}

private:
std::optional<size_t> m_expected;
};

void add_tests_BoxSpacesReader(UnitTestDatabase& database){
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page04_Box118_Normal_Grid_R4C3_Frame01.png", 4);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page04_Box117_Normal_Grid_R4C2_Frame01.png", 4);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page04_Box105_Normal_Grid_R2C2_Frame01.png", 4);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page03_Box069_Normal_Grid_R1C2_Frame01.png", 3);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page03_Box071_Normal_Grid_R1C4_Frame01.png", 3);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page02_Box041_Normal_Grid_R1C4_Frame01.png", 2);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page02_Box059_Normal_Grid_R4C4_Frame01.png", 2);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page02_Box059_Normal_Grid_R4C4_Frame02.png", 2);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page01_Box029_Normal_Grid_R4C4_Frame01.png", 1);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page01_Box028_Normal_Grid_R4C3_Frame01.png", 1);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page01_Normal_Back_Frame01.png", 1);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page01_Box027_Normal_Grid_R4C2_Frame01.png", 1);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page10_Box285_Normal_Grid_R2C2_Frame01.png", 10);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page10_Box285_Normal_Grid_R2C2_Frame02.png", 10);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page10_Box285_Normal_Grid_R2C2_Frame03.png", 10);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page10_Box285_Normal_Grid_R2C2_Frame04.png", 10);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page10_Box285_Relocate_Grid_R2C2_Frame01.png", 10);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page10_Box287_Relocate_Grid_R2C4_Frame01.png", 10);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page10_Box281_Relocate_Grid_R1C4_Frame01.png", 10);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page01_Box011_Relocate_Grid_R1C4_Frame01.png", 1);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page01_Box011_Relocate_Grid_R1C4_Frame02.png", 1);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page02_Box047_Relocate_Grid_R2C4_Frame01.png", 2);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page02_Box059_Relocate_Grid_R4C4_Frame01.png", 2);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page02_Box059_Relocate_Grid_R4C4_Frame02.png", 2);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page03_Box086_Relocate_Grid_R4C1_Frame01.png", 3);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page03_Relocate_Back_Frame01.png", 3);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page03_Relocate_Back_Frame02.png", 3);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page03_Relocate_Back_Frame03.png", 3);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page03_Multi_Back_Frame01.png", 3);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page04_Box109_Multi_Grid_R3C0_Frame01.png", 4);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page04_Box097_Multi_Grid_R1C0_Frame01.png", 4);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box128_Multi_Grid_R1C1_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box129_Multi_Grid_R1C2_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box129_Multi_Grid_R1C2_Frame02.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box130_Multi_Grid_R1C3_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box136_Multi_Grid_R2C3_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box136_Multi_Grid_R2C3_Frame02.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Box166_Multi_Grid_R2C3_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Box172_Multi_Grid_R3C3_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Box178_Multi_Grid_R4C3_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Box179_Multi_Grid_R4C4_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box209_Multi_Grid_R4C4_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Multi_Back_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box196_Multi_Grid_R2C3_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box195_Multi_Grid_R2C2_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box226_Multi_Grid_R2C3_Frame01.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box256_Multi_Grid_R2C3_Frame01.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box262_Multi_Grid_R3C3_Frame01.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box262_Multi_Grid_R3C3_Frame02.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box262_Multi_Grid_R3C3_Frame03.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box262_Normal_Grid_R3C3_Frame01.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box262_Multi_Grid_R3C3_Frame04.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box260_Normal_Grid_R3C1_Frame01.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box254_Normal_Grid_R2C1_Frame01.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page09_Box247_Normal_Grid_R1C0_Frame01.png", 9);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box223_Normal_Grid_R2C0_Frame01.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box193_Normal_Grid_R2C0_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box199_Normal_Grid_R3C0_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box235_Relocate_Grid_R4C0_Frame01.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box235_Relocate_Grid_R4C0_Frame02.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box235_Relocate_Grid_R4C0_Frame03.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box235_Relocate_Grid_R4C0_Frame04.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box235_Relocate_Grid_R4C0_Frame05.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box236_Relocate_Grid_R4C1_Frame01.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Box238_Relocate_Grid_R4C3_Frame01.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Relocate_Back_Frame01.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page08_Relocate_Back_Frame02.png", 8);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box208_Relocate_Grid_R4C3_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box195_Relocate_Grid_R2C2_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box189_Relocate_Grid_R1C2_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box187_Relocate_Grid_R1C0_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Box163_Relocate_Grid_R2C0_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Relocate_Back_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Box175_Relocate_Grid_R4C0_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Box178_Relocate_Grid_R4C3_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box148_Multi_Grid_R4C3_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box142_Multi_Grid_R3C3_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box134_Multi_Grid_R2C1_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box134_Multi_Grid_R2C1_Frame02.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page04_Box119_Multi_Grid_R4C4_Frame01.png", 4);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box150_Normal_Grid_R4C5_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box138_Normal_Grid_R2C5_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page05_Box132_Normal_Grid_R1C5_Frame01.png", 5);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page06_Box162_Normal_Grid_R1C5_Frame01.png", 6);
database.add<Test_BoxSpacesReader>("PokemonHome/PageView/Page07_Box192_Normal_Grid_R1C5_Frame01.png", 7);
database.add<Test_BoxSpacesReader>("PokemonHome/BoxView/BoxView-1.png", std::nullopt);
database.add<Test_BoxSpacesReader>("PokemonHome/BoxView/SelectionArrow_Normal_BoxName_01.png", std::nullopt);
database.add<Test_BoxSpacesReader>("PokemonHome/SummaryScreen/annihilape_Regular.png", std::nullopt);
}

}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/* Pokemon Home Box Spaces Reader
*
* From: https://github.com/PokemonAutomation/
*
*/

#ifndef PokemonAutomation_PokemonHome_BoxSpacesReader_H
#define PokemonAutomation_PokemonHome_BoxSpacesReader_H

#include <cstddef>
#include <optional>
#include "Common/Cpp/Color.h"

namespace PokemonAutomation{
class ImageViewRGB32;
class UnitTestDatabase;
class VideoOverlaySet;
namespace NintendoSwitch{
namespace PokemonHome{

class BoxSpacesReader{
public:
BoxSpacesReader(Color color = COLOR_RED) : m_color(color) {}

void make_overlays(VideoOverlaySet& items) const;

// Read the one-based page number from the Box Space title.
// Returns no value when the page number is unavailable.
std::optional<size_t> read_page_number(const ImageViewRGB32& screen) const;

private:
Color m_color;
};

void add_tests_BoxSpacesReader(UnitTestDatabase& database);

}
}
}
#endif
Loading
Loading