hle: service: mii: Rewrite service to properly support creation of random and default miis. #4292

bunnei · 2020-07-11T03:55:46Z

This change rewrites our Mii services implementation. We've pretty much removed the old implementation, which included code to handle the Mii database (which was incomplete/incorrect, and based on assumptions from ~2 years ago). With the rewrite, we focus just on the basics that games need, which are:

Proper default Mii data
The ability to correctly generate random Mii data

This fixes Mario Kart 8 Deluxe, as well as the Mii Fighter mode in Super Smash Bros. Ultimate (screenshots below). These changes require a dump of the Mii system archive, which is used for the actual Mii models.

Credit to Ryujinx team for the Mii lookup tables used for generating random data, as well as the table of default Mii's that matches hardware (credit and copyright info is also cited in the source).

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.cpp

@@ -0,0 +1,482 @@
+// Copyright 2018 yuzu emulator team


Change to 2020

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.cpp

+}
+
+u16 GenerateCrc16(const void* data, std::size_t size) {
+    int crc{};


Suggested change

int crc{};

s32 crc{};

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.cpp

+
+bool MiiManager::CheckAndResetUpdateCounter(SourceFlag source_flag, u64& current_update_counter) {
+    if ((source_flag & SourceFlag::Database) == SourceFlag::None) {
+        return {};


Suggested change

return {};

return false;

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.cpp

+
+bool MiiManager::IsFullDatabase() const {
+    // TODO(bunnei): We don't implement the Mii database, so it cannot be full
+    return {};


Suggested change

return {};

return false;

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.h

+
+    bool CheckAndResetUpdateCounter(SourceFlag source_flag, u64& current_update_counter);
+    bool IsFullDatabase() const;
+    u32 GetCount(SourceFlag source_flag);


Suggested change

u32 GetCount(SourceFlag source_flag);

u32 GetCount(SourceFlag source_flag) const;

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.cpp

+    return {};
+}
+
+u32 MiiManager::GetCount(SourceFlag source_flag) {


Suggested change

u32 MiiManager::GetCount(SourceFlag source_flag) {

u32 MiiManager::GetCount(SourceFlag source_flag) const {

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.cpp

+    return count;
+}
+
+ResultVal<MiiInfo> MiiManager::UpdateLatest(const MiiInfo& /*info*/, SourceFlag source_flag) {


Suggested change

ResultVal<MiiInfo> MiiManager::UpdateLatest(const MiiInfo& /*info*/, SourceFlag source_flag) {

ResultVal<MiiInfo> MiiManager::UpdateLatest([[maybe_unused]] const MiiInfo& /*info*/, SourceFlag source_flag) {

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.cpp

+    return MakeResult<std::vector<MiiInfoElement>>(result);
+}
+
+ResultCode MiiManager::GetIndex(const MiiInfo& /*info*/, u32& index) {


Suggested change

ResultCode MiiManager::GetIndex(const MiiInfo& /*info*/, u32& index) {

ResultCode MiiManager::GetIndex([[maybe_unused]] const MiiInfo& /*info*/, u32& index) {

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/manager.h

@@ -0,0 +1,331 @@
+// Copyright 2018 yuzu emulator team


Suggested change

// Copyright 2018 yuzu emulator team

// Copyright 2020 yuzu emulator team

ogniK5377 · 2020-07-11T06:00:16Z

src/core/hle/service/mii/mii.cpp

-        u32 read_size{};
-        ctx.WriteBuffer(SerializeArray(&MiiManager::GetInfo, offsets[1], size, read_size));
-        offsets[1] += read_size;
+        if (result->size()) {


Suggested change

if (result->size()) {

if (result->size() > 0) {

lioncash · 2020-07-11T09:33:18Z

src/core/hle/service/mii/manager.cpp

+}
+
+MiiInfo ConvertStoreDataToInfo(const MiiStoreData& data) {
+    MiiStoreBitFields bf{};


Suggested change

MiiStoreBitFields bf{};

MiiStoreBitFields bf;

Particularly given it's being memcpy'd into completely immediately on the next line.

lioncash · 2020-07-11T09:33:18Z

src/core/hle/service/mii/manager.cpp

+    std::vector<MiiInfoElement> result;
+
+    if ((source_flag & SourceFlag::Default) == SourceFlag::None) {
+        return MakeResult<std::vector<MiiInfoElement>>(result);


Suggested change

return MakeResult<std::vector<MiiInfoElement>>(result);

return MakeResult(std::move(result));

lioncash · 2020-07-11T09:33:18Z

src/core/hle/service/mii/manager.cpp

+        result.emplace_back(BuildDefault(index), Source::Default);
+    }
+
+    return MakeResult<std::vector<MiiInfoElement>>(result);


Suggested change

return MakeResult<std::vector<MiiInfoElement>>(result);

return MakeResult(std::move(result));

lioncash · 2020-07-11T09:33:18Z

src/core/hle/service/mii/raw_data.h

+
+namespace Service::Mii::RawData {
+
+static constexpr std::array<u8, 1728> DefaultMii{


These should be defined in a cpp file and be made extern const in the header, so that these don't copied entirely into every translation unit that may reference these identifiers.

Thog · 2020-07-11T10:01:45Z

Nice work on getting Mii support added.
When we were working on reversing Mii's for Ryujinx, we guessed a significant amount of the enums (names & properties) and structures, which seem to have been referenced here directly from Ryujinx code as well.

It would be appreciated if the appropriate license statements could be added to the top of those files as well.

Otherwise the code looks fine 👍

…ndom and default miis.

bunnei · 2020-07-12T01:40:56Z

@Thog thanks for taking a look. Yes, sorry, several of the enum definitions were from Ryujinx. However, these were largely unused, and considering we have not independently verified them, I have just gone ahead and removed these.

bunnei added the early-access-merge label Jul 11, 2020

ogniK5377 requested changes Jul 11, 2020

View changes

lioncash reviewed Jul 11, 2020

View changes

hle: service: mii: Rewrite service to properly support creation of ra…

Loading status checks…

e706501

…ndom and default miis.

bunnei force-pushed the bunnei:mii-rewrite branch from 677b88f to e706501 Jul 12, 2020

yuzu-emu / yuzu

hle: service: mii: Rewrite service to properly support creation of random and default miis. #4292

hle: service: mii: Rewrite service to properly support creation of random and default miis. #4292

bunnei commented Jul 11, 2020

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Thog commented Jul 11, 2020

bunnei commented Jul 12, 2020

	u32 GetCount(SourceFlag source_flag);
	u32 GetCount(SourceFlag source_flag) const;

	u32 MiiManager::GetCount(SourceFlag source_flag) {
	u32 MiiManager::GetCount(SourceFlag source_flag) const {

	ResultVal<MiiInfo> MiiManager::UpdateLatest(const MiiInfo& /info/, SourceFlag source_flag) {
	ResultVal<MiiInfo> MiiManager::UpdateLatest([[maybe_unused]] const MiiInfo& /info/, SourceFlag source_flag) {

	ResultCode MiiManager::GetIndex(const MiiInfo& /info/, u32& index) {
	ResultCode MiiManager::GetIndex([[maybe_unused]] const MiiInfo& /info/, u32& index) {

	// Copyright 2018 yuzu emulator team
	// Copyright 2020 yuzu emulator team

	return MakeResult<std::vector<MiiInfoElement>>(result);
	return MakeResult(std::move(result));


		namespace Service::Mii::RawData {

		static constexpr std::array<u8, 1728> DefaultMii{

yuzu-emu / yuzu

Sponsor yuzu-emu/yuzu

hle: service: mii: Rewrite service to properly support creation of random and default miis. #4292

hle: service: mii: Rewrite service to properly support creation of random and default miis. #4292

Conversation

bunnei commented Jul 11, 2020

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

ogniK5377 Jul 11, 2020 Contributor

This comment has been minimized.

lioncash Jul 11, 2020 Contributor

This comment has been minimized.

lioncash Jul 11, 2020 • edited Contributor

This comment has been minimized.

lioncash Jul 11, 2020 Contributor

This comment has been minimized.

lioncash Jul 11, 2020 Contributor

Thog commented Jul 11, 2020

bunnei commented Jul 12, 2020

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

ogniK5377 Jul 11, 2020
Contributor

lioncash Jul 11, 2020
Contributor

lioncash Jul 11, 2020 •

edited

Contributor

lioncash Jul 11, 2020
Contributor

lioncash Jul 11, 2020
Contributor