Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DolphinQt/Mapping: Add setting to enable waiting for alternate mappings. #13320

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
57 changes: 37 additions & 20 deletions Source/Core/DolphinQt/Config/Mapping/MappingCommon.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@
namespace MappingCommon
{
constexpr auto INPUT_DETECT_INITIAL_TIME = std::chrono::seconds(3);
constexpr auto INPUT_DETECT_CONFIRMATION_TIME = std::chrono::milliseconds(0);
constexpr auto INPUT_DETECT_CONFIRMATION_TIME = std::chrono::milliseconds(750);
constexpr auto INPUT_DETECT_MAXIMUM_TIME = std::chrono::seconds(5);
// Ignore the mouse-click when queuing more buttons with "alternate mappings" enabled.
constexpr auto INPUT_DETECT_ENDING_IGNORE_TIME = std::chrono::milliseconds(50);

class MappingProcessor : public QWidget
{
Expand Down Expand Up @@ -50,7 +52,7 @@ class MappingProcessor : public QWidget
button->StartMapping();

std::vector device_strings{default_device.ToString()};
if (m_parent->IsMappingAllDevices())
if (m_parent->IsCreateOtherDeviceMappingsEnabled())
device_strings = g_controller_interface.GetAllDeviceStrings();

m_input_detector = std::make_unique<ciface::Core::InputDetector>();
Expand All @@ -63,33 +65,39 @@ class MappingProcessor : public QWidget
if (!m_input_detector)
return;

m_input_detector->Update(INPUT_DETECT_INITIAL_TIME, INPUT_DETECT_CONFIRMATION_TIME,
const auto confirmation_time =
INPUT_DETECT_CONFIRMATION_TIME * (m_parent->IsWaitForAlternateMappingsEnabled() ? 1 : 0);

m_input_detector->Update(INPUT_DETECT_INITIAL_TIME, confirmation_time,
INPUT_DETECT_MAXIMUM_TIME);

if (m_input_detector->IsComplete())
{
auto detections = m_input_detector->TakeResults();
ciface::MappingCommon::RemoveSpuriousTriggerCombinations(&detections);

// No inputs detected. Cancel this and any other queued mappings.
if (detections.empty())
{
if (!FinalizeMapping(m_input_detector->TakeResults()))
CancelMapping();
return;
}
}
}

const auto& default_device = m_parent->GetController()->GetDefaultDevice();
auto& button = m_clicked_mapping_buttons.front();
auto* const control_reference = button->GetControlReference();
bool FinalizeMapping(ciface::Core::InputDetector::Results detections)
{
if (!ciface::MappingCommon::ContainsCompleteDetection(detections))
return false;

control_reference->SetExpression(
BuildExpression(detections, default_device, ciface::MappingCommon::Quote::On));
m_parent->Save();
ciface::MappingCommon::RemoveSpuriousTriggerCombinations(&detections);

m_parent->GetController()->UpdateSingleControlReference(g_controller_interface,
control_reference);
UnQueueInputDetection(button);
}
const auto& default_device = m_parent->GetController()->GetDefaultDevice();
auto& button = m_clicked_mapping_buttons.front();
auto* const control_reference = button->GetControlReference();

control_reference->SetExpression(
BuildExpression(detections, default_device, ciface::MappingCommon::Quote::On));
m_parent->Save();

m_parent->GetController()->UpdateSingleControlReference(g_controller_interface,
control_reference);
UnQueueInputDetection(button);
return true;
}

void UpdateInputDetectionStartTimer()
Expand Down Expand Up @@ -121,6 +129,15 @@ class MappingProcessor : public QWidget

button->setText(QStringLiteral("[ ... ]"));
m_clicked_mapping_buttons.push_back(button);

if (m_input_detector)
{
// Ignore the mouse-click that queued this new detection and finalize the current mapping.
auto results = m_input_detector->TakeResults();
ciface::MappingCommon::RemoveDetectionsAfterTimePoint(
&results, ciface::Core::DeviceContainer::Clock::now() - INPUT_DETECT_ENDING_IGNORE_TIME);
FinalizeMapping(std::move(results));
}
UpdateInputDetectionStartTimer();
}

Expand Down
19 changes: 14 additions & 5 deletions Source/Core/DolphinQt/Config/Mapping/MappingWindow.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,15 @@ void MappingWindow::CreateDevicesLayout()
const auto refresh_action = new QAction(tr("Refresh"), options);
connect(refresh_action, &QAction::triggered, this, &MappingWindow::RefreshDevices);

m_all_devices_action = new QAction(tr("Create mappings for other devices"), options);
m_all_devices_action->setCheckable(true);
m_other_device_mappings = new QAction(tr("Create Mappings for Other Devices"), options);
m_other_device_mappings->setCheckable(true);

m_wait_for_alternate_mappings = new QAction(tr("Wait for Alternate Input Mappings"), options);
m_wait_for_alternate_mappings->setCheckable(true);

options->addAction(refresh_action);
options->addAction(m_all_devices_action);
options->addAction(m_other_device_mappings);
options->addAction(m_wait_for_alternate_mappings);
options->setDefaultAction(refresh_action);

m_devices_combo->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Fixed);
Expand Down Expand Up @@ -354,9 +358,14 @@ void MappingWindow::OnSelectDevice(int)
m_controller->UpdateReferences(g_controller_interface);
}

bool MappingWindow::IsMappingAllDevices() const
bool MappingWindow::IsCreateOtherDeviceMappingsEnabled() const
{
return m_other_device_mappings->isChecked();
}

bool MappingWindow::IsWaitForAlternateMappingsEnabled() const
{
return m_all_devices_action->isChecked();
return m_wait_for_alternate_mappings->isChecked();
}

void MappingWindow::RefreshDevices()
Expand Down
6 changes: 4 additions & 2 deletions Source/Core/DolphinQt/Config/Mapping/MappingWindow.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ class MappingWindow final : public QDialog

int GetPort() const;
ControllerEmu::EmulatedController* GetController() const;
bool IsMappingAllDevices() const;
bool IsCreateOtherDeviceMappingsEnabled() const;
bool IsWaitForAlternateMappingsEnabled() const;
void ShowExtensionMotionTabs(bool show);
void ActivateExtensionTab();

Expand Down Expand Up @@ -103,7 +104,8 @@ class MappingWindow final : public QDialog
QGroupBox* m_devices_box;
QHBoxLayout* m_devices_layout;
QComboBox* m_devices_combo;
QAction* m_all_devices_action;
QAction* m_other_device_mappings;
QAction* m_wait_for_alternate_mappings;

// Profiles
QGroupBox* m_profiles_box;
Expand Down
6 changes: 3 additions & 3 deletions Source/Core/InputCommon/ControllerInterface/CoreDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ void InputDetector::Update(std::chrono::milliseconds initial_wait,
Detection new_detection;
new_detection.device = device_state.device;
new_detection.input = input_state.input;
new_detection.press_time = Clock::now();
new_detection.press_time = now;
new_detection.smoothness = smoothness;

// We found an input. Add it to our detections.
Expand All @@ -516,12 +516,12 @@ bool InputDetector::IsComplete() const
return !m_state;
}

auto InputDetector::GetResults() const -> const std::vector<Detection>&
auto InputDetector::GetResults() const -> const Results&
{
return m_detections;
}

auto InputDetector::TakeResults() -> std::vector<Detection>
auto InputDetector::TakeResults() -> Results
{
return std::move(m_detections);
}
Expand Down
7 changes: 4 additions & 3 deletions Source/Core/InputCommon/ControllerInterface/CoreDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ class InputDetector
{
public:
using Detection = DeviceContainer::InputDetection;
using Results = std::vector<Detection>;

InputDetector();
~InputDetector();
Expand All @@ -259,16 +260,16 @@ class InputDetector
std::chrono::milliseconds maximum_wait);
bool IsComplete() const;

const std::vector<Detection>& GetResults() const;
const Results& GetResults() const;

// move-return'd to prevent copying.
std::vector<Detection> TakeResults();
Results TakeResults();

private:
struct Impl;

Clock::time_point m_start_time;
std::vector<Detection> m_detections;
Results m_detections;
std::unique_ptr<Impl> m_state;
};

Expand Down
27 changes: 21 additions & 6 deletions Source/Core/InputCommon/ControllerInterface/MappingCommon.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,10 @@ std::string GetExpressionForControl(const std::string& control_name,
return expr;
}

std::string
BuildExpression(const std::vector<ciface::Core::DeviceContainer::InputDetection>& detections,
const ciface::Core::DeviceQualifier& default_device, Quote quote)
std::string BuildExpression(const Core::InputDetector::Results& detections,
const ciface::Core::DeviceQualifier& default_device, Quote quote)
{
std::vector<const ciface::Core::DeviceContainer::InputDetection*> pressed_inputs;
std::vector<const Core::InputDetector::Detection*> pressed_inputs;

std::vector<std::string> alternations;

Expand Down Expand Up @@ -135,8 +134,7 @@ BuildExpression(const std::vector<ciface::Core::DeviceContainer::InputDetection>
return fmt::to_string(fmt::join(alternations, "|"));
}

void RemoveSpuriousTriggerCombinations(
std::vector<ciface::Core::DeviceContainer::InputDetection>* detections)
void RemoveSpuriousTriggerCombinations(Core::InputDetector::Results* detections)
{
const auto is_spurious = [&](const auto& detection) {
return std::ranges::any_of(*detections, [&](const auto& d) {
Expand All @@ -149,4 +147,21 @@ void RemoveSpuriousTriggerCombinations(
std::erase_if(*detections, is_spurious);
}

void RemoveDetectionsAfterTimePoint(Core::InputDetector::Results* results,
Core::DeviceContainer::Clock::time_point after)
{
const auto is_after_time = [&](const Core::InputDetector::Detection& detection) {
return detection.release_time.value_or(after) >= after;
};

std::erase_if(*results, is_after_time);
}

bool ContainsCompleteDetection(const Core::InputDetector::Results& results)
{
return std::ranges::any_of(results, [](const Core::InputDetector::Detection& detection) {
return detection.release_time.has_value();
});
}

} // namespace ciface::MappingCommon
13 changes: 8 additions & 5 deletions Source/Core/InputCommon/ControllerInterface/MappingCommon.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,16 @@ enum class Quote
};

std::string GetExpressionForControl(const std::string& control_name,
const ciface::Core::DeviceQualifier& control_device,
const ciface::Core::DeviceQualifier& default_device,
const Core::DeviceQualifier& control_device,
const Core::DeviceQualifier& default_device,
Quote quote = Quote::On);

std::string BuildExpression(const std::vector<ciface::Core::DeviceContainer::InputDetection>&,
const ciface::Core::DeviceQualifier& default_device, Quote quote);
std::string BuildExpression(const Core::InputDetector::Results&,
const Core::DeviceQualifier& default_device, Quote quote);

void RemoveSpuriousTriggerCombinations(std::vector<ciface::Core::DeviceContainer::InputDetection>*);
void RemoveSpuriousTriggerCombinations(Core::InputDetector::Results*);
void RemoveDetectionsAfterTimePoint(Core::InputDetector::Results*,
Core::DeviceContainer::Clock::time_point after);
bool ContainsCompleteDetection(const Core::InputDetector::Results&);

} // namespace ciface::MappingCommon