Rework Joy-Con Vibration Conversion

The guest -> host vibration conversion code was entirely broken as it didn't set the vibration `start`/`end` timestamps correctly for a cycle nor did it subtract from the `totalAmplitude` (`currentAmplitude` now) when it a cycle ended due to an incorrect `if` statement and contents. It would just end up saturating the amplitude as much as possible by adding more and more to `totalAmplitude` on every cycle while never subtracting which is entirely wrong and led to a very noticeable drop in amplitude when a vibration was repeated.

It's been entirely reworked to fix all the issues listed above and remove a lot of code that had no understandable purpose. More comments have also been added to the code to make it more readable with better variable and function naming alongside it.
This commit is contained in:
PixelyIon 2021-10-31 23:13:58 +05:30
parent df7608c2f7
commit 414c0104c3
3 changed files with 68 additions and 65 deletions

View File

@ -359,8 +359,8 @@ namespace skyline::input {
struct VibrationInfo { struct VibrationInfo {
jlong period; jlong period;
jint amplitude; jint amplitude;
jlong start; jlong start; //!< The timestamp to (re)start the vibration at
jlong end; jlong end; //!< The timestamp to end the vibration at
VibrationInfo(float frequency, float amplitude) VibrationInfo(float frequency, float amplitude)
: period(static_cast<jlong>(MsInSecond / frequency)), : period(static_cast<jlong>(MsInSecond / frequency)),
@ -369,22 +369,12 @@ namespace skyline::input {
}; };
template<size_t Size> template<size_t Size>
void VibrateDevice(const std::shared_ptr<JvmManager> &jvm, i8 index, std::array<VibrationInfo, Size> vibrations) { void VibrateDevice(const std::shared_ptr<JvmManager> &jvm, i8 deviceIndex, std::array<VibrationInfo, Size> vibrations) {
jlong totalTime{};
std::sort(vibrations.begin(), vibrations.end(), [](const VibrationInfo &a, const VibrationInfo &b) {
return a.period < b.period;
});
jlong totalPeriod{};
jint totalAmplitude{}; jint totalAmplitude{};
for (const auto &vibration : vibrations) { for (const auto &vibration : vibrations)
totalPeriod += vibration.period;
totalAmplitude += vibration.amplitude; totalAmplitude += vibration.amplitude;
} if (totalAmplitude == 0) {
jvm->ClearVibrationDevice(deviceIndex); // If a null vibration was submitted then we just clear vibrations on the device
// If this vibration is essentially null then we don't play rather clear any running vibrations
if (totalPeriod == 0 || totalAmplitude == 0) {
jvm->ClearVibrationDevice(index);
return; return;
} }
@ -393,47 +383,75 @@ namespace skyline::input {
std::array<jint, 50> amplitudes; std::array<jint, 50> amplitudes;
// We are essentially unrolling the bands into a linear sequence, due to the data not being always linearizable there will be inaccuracies at the ends unless there's a pattern that's repeatable which will happen when all band's frequencies are factors of each other // We are essentially unrolling the bands into a linear sequence, due to the data not being always linearizable there will be inaccuracies at the ends unless there's a pattern that's repeatable which will happen when all band's frequencies are factors of each other
size_t timingIndex{}; jint currentAmplitude{}; //!< The accumulated amplitude from adding up and subtracting the amplitude of individual bands
for (; timingIndex < timings.size(); timingIndex++) { jlong currentTime{}; //!< The accumulated time passed by adding up all the periods prior to the current vibration cycle
jlong time{}; size_t index{};
for (; index < timings.size(); index++) {
jlong cyclePeriod{}; //!< The length of this cycle, calculated as the largest period with the same amplitude
size_t bandStartCount{}; //!< The amount of bands that start their vibration cycles in this time slot
size_t startCycleCount{};
for (size_t vibrationIndex{}; vibrationIndex < vibrations.size(); vibrationIndex++) { for (size_t vibrationIndex{}; vibrationIndex < vibrations.size(); vibrationIndex++) {
auto &vibration{vibrations[vibrationIndex]}; // Iterate over every band to calculate the amplitude for this time slot
if (totalTime <= vibration.start) { VibrationInfo &vibration{vibrations[vibrationIndex]};
vibration.start = vibration.end + vibration.period; if (currentTime <= vibration.start) {
totalAmplitude += vibration.amplitude; // If the time to start has arrived then start the vibration
time = std::max(vibration.period, time);
startCycleCount++;
} else if (totalTime <= vibration.start) {
vibration.end = vibration.start + vibration.period; vibration.end = vibration.start + vibration.period;
totalAmplitude -= vibration.amplitude; currentAmplitude += vibration.amplitude;
time = std::max(vibration.period, time); auto vibrationPeriodLeft{vibration.end - currentTime};
cyclePeriod = cyclePeriod ? std::min(vibrationPeriodLeft, cyclePeriod) : vibrationPeriodLeft;
bandStartCount++;
} else if (currentTime <= vibration.end) {
// If the time to end the vibration has arrived then end it
vibration.start = vibration.end + vibration.period;
currentAmplitude -= vibration.amplitude;
auto vibrationPeriodLeft{vibration.start - currentTime};
cyclePeriod = cyclePeriod ? std::min(vibrationPeriodLeft, cyclePeriod) : vibrationPeriodLeft;
} }
} }
// If all bands start again at this point then we can end the pattern here as a loop to the front will be flawless if (index && bandStartCount == vibrations.size())
if (timingIndex && startCycleCount == vibrations.size()) break; // If all bands start again at this point then we can end the pattern here and just loop over the pattern
break;
timings[timingIndex] = time; currentTime += cyclePeriod;
totalTime += time; timings[index] = cyclePeriod;
amplitudes[timingIndex] = std::min(totalAmplitude, AmplitudeMax); amplitudes[index] = std::min(currentAmplitude, AmplitudeMax);
} }
jvm->VibrateDevice(index, span(timings.begin(), timings.begin() + timingIndex), span(amplitudes.begin(), amplitudes.begin() + timingIndex)); jvm->VibrateDevice(deviceIndex, span(timings.begin(), timings.begin() + index), span(amplitudes.begin(), amplitudes.begin() + index));
} }
void VibrateDevice(const std::shared_ptr<JvmManager> &jvm, i8 index, const NpadVibrationValue &value) { void VibrateDevice(const std::shared_ptr<JvmManager> &jvm, i8 index, const NpadVibrationValue &value) {
std::array<VibrationInfo, 2> vibrations{ std::array<VibrationInfo, 2> vibrations{
VibrationInfo{value.frequencyLow, value.amplitudeLow * (AmplitudeMax / 2)}, VibrationInfo{value.frequencyLow, value.amplitudeLow * (AmplitudeMax / 2)},
{value.frequencyHigh, value.amplitudeHigh * (AmplitudeMax / 2)}, VibrationInfo{value.frequencyHigh, value.amplitudeHigh * (AmplitudeMax / 2)},
}; };
VibrateDevice(jvm, index, vibrations); VibrateDevice(jvm, index, vibrations);
} }
void NpadDevice::Vibrate(bool isRight, const NpadVibrationValue &value) { void NpadDevice::Vibrate(const NpadVibrationValue &left, const NpadVibrationValue &right) {
if (vibrationLeft == left && vibrationRight && (*vibrationRight) == right)
return;
vibrationLeft = left;
vibrationRight = right;
if (partnerIndex == NpadDevice::NullIndex) {
std::array<VibrationInfo, 4> vibrations{
VibrationInfo{left.frequencyLow, left.amplitudeLow * (AmplitudeMax / 4)},
VibrationInfo{left.frequencyHigh, left.amplitudeHigh * (AmplitudeMax / 4)},
VibrationInfo{right.frequencyLow, right.amplitudeLow * (AmplitudeMax / 4)},
VibrationInfo{right.frequencyHigh, right.amplitudeHigh * (AmplitudeMax / 4)},
};
VibrateDevice(manager.state.jvm, index, vibrations);
} else {
VibrateDevice(manager.state.jvm, index, left);
VibrateDevice(manager.state.jvm, partnerIndex, right);
}
}
void NpadDevice::VibrateSingle(bool isRight, const NpadVibrationValue &value) {
if (isRight) { if (isRight) {
if (vibrationRight && (*vibrationRight) == value) if (vibrationRight && (*vibrationRight) == value)
return; return;
@ -449,25 +467,4 @@ namespace skyline::input {
else else
VibrateDevice(manager.state.jvm, index, value); VibrateDevice(manager.state.jvm, index, value);
} }
void NpadDevice::Vibrate(const NpadVibrationValue &left, const NpadVibrationValue &right) {
if (vibrationLeft == left && vibrationRight && (*vibrationRight) == right)
return;
vibrationLeft = left;
vibrationRight = right;
if (partnerIndex == NpadDevice::NullIndex) {
std::array<VibrationInfo, 4> vibrations{
VibrationInfo{left.frequencyLow, left.amplitudeLow * (AmplitudeMax / 4)},
{left.frequencyHigh, left.amplitudeHigh * (AmplitudeMax / 4)},
{right.frequencyLow, right.amplitudeLow * (AmplitudeMax / 4)},
{right.frequencyHigh, right.amplitudeHigh * (AmplitudeMax / 4)},
};
VibrateDevice(manager.state.jvm, index, vibrations);
} else {
VibrateDevice(manager.state.jvm, index, left);
VibrateDevice(manager.state.jvm, partnerIndex, right);
}
}
} }

View File

@ -114,7 +114,7 @@ namespace skyline::input {
private: private:
NpadManager &manager; //!< The manager responsible for managing this NpadDevice NpadManager &manager; //!< The manager responsible for managing this NpadDevice
NpadSection &section; //!< The section in HID shared memory for this controller NpadSection &section; //!< The section in HID shared memory for this controller
NpadControllerInfo *controllerInfo; //!< The NpadControllerInfo for this controller's type NpadControllerInfo *controllerInfo{}; //!< The NpadControllerInfo for this controller's type
u64 globalTimestamp{}; //!< An incrementing timestamp that's common across all sections u64 globalTimestamp{}; //!< An incrementing timestamp that's common across all sections
/** /**
@ -134,7 +134,7 @@ namespace skyline::input {
static constexpr i8 NullIndex{-1}; //!< The placeholder index value when there is no device present static constexpr i8 NullIndex{-1}; //!< The placeholder index value when there is no device present
i8 index{NullIndex}; //!< The index of the device assigned to this player i8 index{NullIndex}; //!< The index of the device assigned to this player
i8 partnerIndex{NullIndex}; //!< The index of a partner device, if present i8 partnerIndex{NullIndex}; //!< The index of a partner device, if present
NpadVibrationValue vibrationLeft; //!< Vibration for the left Joy-Con (Handheld/Pair), left LRA in a Pro-Controller or individual Joy-Cons NpadVibrationValue vibrationLeft{}; //!< Vibration for the left Joy-Con (Handheld/Pair), left LRA in a Pro-Controller or individual Joy-Cons
std::optional<NpadVibrationValue> vibrationRight; //!< Vibration for the right Joy-Con (Handheld/Pair) or right LRA in a Pro-Controller std::optional<NpadVibrationValue> vibrationRight; //!< Vibration for the right Joy-Con (Handheld/Pair) or right LRA in a Pro-Controller
NpadControllerType type{}; NpadControllerType type{};
NpadConnectionState connectionState{}; NpadConnectionState connectionState{};
@ -174,8 +174,14 @@ namespace skyline::input {
*/ */
void SetAxisValue(NpadAxisId axis, i32 value); void SetAxisValue(NpadAxisId axis, i32 value);
void Vibrate(bool isRight, const NpadVibrationValue &value); /**
* @brief Sets the vibration for both the Joy-Cons to the specified vibration values
*/
void Vibrate(const NpadVibrationValue &left, const NpadVibrationValue &right); void Vibrate(const NpadVibrationValue &left, const NpadVibrationValue &right);
/**
* @brief Sets the vibration for either the left or right Joy-Con to the specified vibration value
*/
void VibrateSingle(bool isRight, const NpadVibrationValue &value);
}; };
} }

View File

@ -148,7 +148,7 @@ namespace skyline::service::hid {
if (device.type == handle.GetType()) { if (device.type == handle.GetType()) {
const auto &value{request.Pop<NpadVibrationValue>()}; const auto &value{request.Pop<NpadVibrationValue>()};
state.logger->Debug("Vibration - Handle: 0x{:02X} (0b{:05b}), Vibration: {:.2f}@{:.2f}Hz, {:.2f}@{:.2f}Hz", static_cast<u8>(handle.id), static_cast<u8>(handle.type), value.amplitudeLow, value.frequencyLow, value.amplitudeHigh, value.frequencyHigh); state.logger->Debug("Vibration - Handle: 0x{:02X} (0b{:05b}), Vibration: {:.2f}@{:.2f}Hz, {:.2f}@{:.2f}Hz", static_cast<u8>(handle.id), static_cast<u8>(handle.type), value.amplitudeLow, value.frequencyLow, value.amplitudeHigh, value.frequencyHigh);
device.Vibrate(handle.isRight, value); device.VibrateSingle(handle.isRight, value);
} }
return {}; return {};
@ -172,7 +172,7 @@ namespace skyline::service::hid {
} else { } else {
const auto &value{values[i]}; const auto &value{values[i]};
state.logger->Debug("Vibration #{} - Handle: 0x{:02X} (0b{:05b}), Vibration: {:.2f}@{:.2f}Hz, {:.2f}@{:.2f}Hz", i, static_cast<u8>(handle.id), static_cast<u8>(handle.type), value.amplitudeLow, value.frequencyLow, value.amplitudeHigh, value.frequencyHigh); state.logger->Debug("Vibration #{} - Handle: 0x{:02X} (0b{:05b}), Vibration: {:.2f}@{:.2f}Hz, {:.2f}@{:.2f}Hz", i, static_cast<u8>(handle.id), static_cast<u8>(handle.type), value.amplitudeLow, value.frequencyLow, value.amplitudeHigh, value.frequencyHigh);
device.Vibrate(handle.isRight, value); device.VibrateSingle(handle.isRight, value);
} }
} }
} }