IOS/USB: Emulate Wii Speak #12567

noahpistilli · 2024-02-07T02:59:32Z

This PR emulates the Wii Speak through passthrough of a real microphone. The register code was derived from this code by degasus, however I suspect there are some inaccuracies.

In its current state the audio that is being passed through is incredibly choppy and delayed, along with an echo effect. I didn't encounter it this badly when I was working with OpenAL, however I switched to cubeb for better compatibility.

Timings are also inaccurate which could be contributing to this issue. Regardless, this allows for the Wii Speak Channel 2.0 to function.

lioncash · 2024-02-07T17:58:22Z

Source/Core/Core/IOS/USB/Emulated/Microphone.h

+  static constexpr u32 SAMPLING_RATE = 8000;
+  static constexpr u32 BUFFER_SIZE = SAMPLING_RATE / 2;
+
+  s16* stream_buffer;


Should this be a unique_ptr? This doesn't seem to actually get freed

I thought I deleted it in the destructor, I guess not. unique_ptr would be better though.

Can't a buffer allocated on the stack (for instance, using a std::array) be used if the size is hardcoded/known in advance? Which seems to be the case here.

sepalani

Here is a quick review regarding the code. I'm going to test this PR later this week.

sepalani · 2024-02-12T17:53:22Z

Source/Core/Core/IOS/USB/Emulated/WiiSpeak.h

+#include <thread>
+
+#include "Common/CommonTypes.h"
+#include "Common/Event.h"
+#include "Common/WorkQueueThread.h"
+#include "Core/HW/Memmap.h"
+#include "Core/IOS/USB/Common.h"
+#include "Core/IOS/USB/Emulated/Microphone.h"
+#include "Core/System.h"


Are all these includes necessary? <thread> and "Common/WorkQueueThread.h" don't seem used here.

sepalani · 2024-02-12T17:58:33Z

Source/Core/Core/IOS/USB/Emulated/WiiSpeak.h

+  u8 m_active_interface = 0;
+  bool m_device_attached = false;
+  bool init = false;
+  std::unique_ptr<Microphone> m_microphone;


Can't the Microphone class be forward declared so its header file doesn't need to be included?

sepalani · 2024-02-12T18:01:38Z

Source/Core/Core/IOS/USB/Emulated/WiiSpeak.cpp

+#include "Core/HW/Memmap.h"
+#include "Core/System.h"


Aren't these two headers already included?

sepalani · 2024-02-12T18:09:30Z

Source/Core/Core/IOS/USB/Emulated/WiiSpeak.cpp

+  m_vid = 0x57E;
+  m_pid = 0x0308;
+  m_id = (u64(m_vid) << 32 | u64(m_pid) << 16 | u64(9) << 8 | u64(1));
+  m_device_descriptor =
+      DeviceDescriptor{0x12, 0x1, 0x200, 0, 0, 0, 0x10, 0x57E, 0x0308, 0x0214, 0x1, 0x2, 0x0, 0x1};
+  m_config_descriptor.emplace_back(ConfigDescriptor{0x9, 0x2, 0x0030, 0x1, 0x1, 0x0, 0x80, 0x32});
+  m_interface_descriptor.emplace_back(
+      InterfaceDescriptor{0x9, 0x4, 0x0, 0x0, 0x0, 0xFF, 0xFF, 0xFF, 0x0});
+  m_interface_descriptor.emplace_back(
+      InterfaceDescriptor{0x9, 0x4, 0x0, 0x01, 0x03, 0xFF, 0xFF, 0xFF, 0x0});
+  m_endpoint_descriptor.emplace_back(EndpointDescriptor{0x7, 0x5, 0x81, 0x1, 0x0020, 0x1});
+  m_endpoint_descriptor.emplace_back(EndpointDescriptor{0x7, 0x5, 0x2, 0x2, 0x0020, 0});
+  m_endpoint_descriptor.emplace_back(EndpointDescriptor{0x7, 0x5, 0x3, 0x1, 0x0040, 1});


Can't these be const member variables?

sepalani · 2024-02-12T18:24:25Z

Source/Core/Core/IOS/USB/Emulated/WiiSpeak.cpp

+  {
+  case USBHDR(DIR_DEVICE2HOST, TYPE_STANDARD, REC_INTERFACE, REQUEST_GET_INTERFACE):
+  {
+    std::array<u8, 1> data{1};


Can't this array be static const/constexpr ?

sepalani · 2024-02-12T18:37:34Z

Source/Core/Core/IOS/USB/Emulated/WiiSpeak.h

+  void GetRegister(std::unique_ptr<CtrlMessage>& cmd);
+  void SetRegister(std::unique_ptr<CtrlMessage>& cmd);


Can't these parameters be const& and GetRegister a const method?

sepalani · 2024-02-12T18:45:16Z

Source/Core/Core/IOS/USB/Emulated/Microphone.h

+#pragma once
+
+#include <mutex>
+#include <string>


This <string> include should be removed if not used in this header file.

sepalani · 2024-02-12T18:50:43Z

Source/Core/Core/IOS/USB/Emulated/Microphone.h

+  static constexpr u32 SAMPLING_RATE = 8000;
+  static constexpr u32 BUFFER_SIZE = SAMPLING_RATE / 2;
+
+  s16* stream_buffer;


Can't a buffer allocated on the stack (for instance, using a std::array) be used if the size is hardcoded/known in advance? Which seems to be the case here.

sepalani · 2024-02-12T18:53:08Z

Source/Core/Core/IOS/USB/Emulated/Microphone.cpp

+  m_work_queue.EmplaceItem([this, &sync_event] {
+    Common::ScopeGuard sync_event_guard([&sync_event] { sync_event.Set(); });
+#endif
+    stream_size = buff_size_samples * 500;


Can't stream_size and buff_size_samples be const?

sepalani · 2024-02-12T18:57:43Z

Source/Core/Core/IOS/USB/Emulated/Microphone.cpp

+    }
+
+    if (cubeb_stream_init(m_cubeb_ctx.get(), &m_cubeb_stream,
+                          "Dolphin Emulated GameCube Microphone", nullptr, &params, nullptr,


Is this referring to the GameCube's Microphone which used the memory card port? If it is a typo, referring to "Dolphin Emulated Wii Speak" seems reasonable to me.

sepalani

I tested it on two Dolphin portable builds with Monster Hunter Tri (it requires 2 players to be friends). The Wii Speak is detected but it doesn't detect sound and/or register my laptop microphone (which is odd as I don't have issues using it on Firefox).

I have PMIC symbols on some of my games including MH3 so I might be able to diagnose the issue. I'll do more testing and try to throw one or two of my Wii into the mix to see if there is any change.

BTW, I have faced an haisenbug with this build. I can't reproduce it with a debugger attached or using a debug build. It occurs when the game try to initialise or detect the Wii Speak, the second instance trying to do so crashes instantly. Sometimes, it doesn't happen which is very odd. It might be a clash when trying to acquire the microphone but I'm not sure.

sepalani · 2024-03-10T10:59:50Z

Source/Core/Core/IOS/USB/Host.cpp

+  auto wii_speak = std::make_unique<USB::WiiSpeak>(GetEmulationKernel(), "Wii Speak");
+  CheckAndAddDevice(std::move(wii_speak), new_devices, hooks, always_add_hooks);


You should add an option in Dolphin's config system to enable/disable emulated wii speak as users might want to disable it in some circumstances.

@noahpistilli

Based on @noahpistilli (Sketch) PR: dolphin-emu#12567 Fixed the Windows support and the haisenbug caused by uninitialized members. Config system integration finalized.

@noahpistilli

Based on @noahpistilli (Sketch) PR: dolphin-emu#12567 Fixed the Windows support and the haisenbug caused by uninitialized members. Config system integration finalized.

@noahpistilli