Merge pull request #105 from kevinhartman/hid

Digital user input and HID module implementation for PAD
This commit is contained in:
bunnei 2014-09-12 17:44:25 -04:00
commit cbdf4d4c8e
12 changed files with 405 additions and 39 deletions

View File

@ -8,18 +8,55 @@
#include "citra/emu_window/emu_window_glfw.h"
static void OnKeyEvent(GLFWwindow* win, int key, int action) {
// TODO(bunnei): ImplementMe
static const std::pair<int, HID_User::PadState> default_key_map[] = {
{ GLFW_KEY_A, HID_User::PAD_A },
{ GLFW_KEY_B, HID_User::PAD_B },
{ GLFW_KEY_BACKSLASH, HID_User::PAD_SELECT },
{ GLFW_KEY_ENTER, HID_User::PAD_START },
{ GLFW_KEY_RIGHT, HID_User::PAD_RIGHT },
{ GLFW_KEY_LEFT, HID_User::PAD_LEFT },
{ GLFW_KEY_UP, HID_User::PAD_UP },
{ GLFW_KEY_DOWN, HID_User::PAD_DOWN },
{ GLFW_KEY_R, HID_User::PAD_R },
{ GLFW_KEY_L, HID_User::PAD_L },
{ GLFW_KEY_X, HID_User::PAD_X },
{ GLFW_KEY_Y, HID_User::PAD_Y },
{ GLFW_KEY_H, HID_User::PAD_CIRCLE_RIGHT },
{ GLFW_KEY_F, HID_User::PAD_CIRCLE_LEFT },
{ GLFW_KEY_T, HID_User::PAD_CIRCLE_UP },
{ GLFW_KEY_G, HID_User::PAD_CIRCLE_DOWN },
};
/// Called by GLFW when a key event occurs
void EmuWindow_GLFW::OnKeyEvent(GLFWwindow* win, int key, int scancode, int action, int mods) {
if (!VideoCore::g_emu_window) {
return;
}
static void OnWindowSizeEvent(GLFWwindow* win, int width, int height) {
EmuWindow_GLFW* emu_window = (EmuWindow_GLFW*)glfwGetWindowUserPointer(win);
emu_window->SetClientAreaWidth(width);
emu_window->SetClientAreaHeight(height);
int keyboard_id = ((EmuWindow_GLFW*)VideoCore::g_emu_window)->keyboard_id;
if (action == GLFW_PRESS) {
EmuWindow::KeyPressed({key, keyboard_id});
}
if (action == GLFW_RELEASE) {
EmuWindow::KeyReleased({key, keyboard_id});
}
HID_User::PadUpdateComplete();
}
/// EmuWindow_GLFW constructor
EmuWindow_GLFW::EmuWindow_GLFW() {
// Register a new ID for the default keyboard
keyboard_id = KeyMap::NewDeviceId();
// Set default key mappings for keyboard
for (auto mapping : default_key_map) {
KeyMap::SetKeyMapping({mapping.first, keyboard_id}, mapping.second);
}
// Initialize the window
if(glfwInit() != GL_TRUE) {
printf("Failed to initialize GLFW! Exiting...");
@ -45,8 +82,7 @@ EmuWindow_GLFW::EmuWindow_GLFW() {
// Setup callbacks
glfwSetWindowUserPointer(m_render_window, this);
//glfwSetKeyCallback(m_render_window, OnKeyEvent);
//glfwSetWindowSizeCallback(m_render_window, OnWindowSizeEvent);
glfwSetKeyCallback(m_render_window, OnKeyEvent);
DoneCurrent();
}

View File

@ -25,8 +25,9 @@ public:
/// Releases (dunno if this is the "right" word) the GLFW context from the caller thread
void DoneCurrent();
GLFWwindow* m_render_window; ///< Internal GLFW render window
static void OnKeyEvent(GLFWwindow* win, int key, int scancode, int action, int mods);
private:
GLFWwindow* m_render_window; ///< Internal GLFW render window
int keyboard_id; ///< Device id of keyboard for use with KeyMap
};

View File

@ -109,8 +109,35 @@ EmuThread& GRenderWindow::GetEmuThread()
return emu_thread;
}
static const std::pair<int, HID_User::PadState> default_key_map[] = {
{ Qt::Key_A, HID_User::PAD_A },
{ Qt::Key_B, HID_User::PAD_B },
{ Qt::Key_Backslash, HID_User::PAD_SELECT },
{ Qt::Key_Enter, HID_User::PAD_START },
{ Qt::Key_Right, HID_User::PAD_RIGHT },
{ Qt::Key_Left, HID_User::PAD_LEFT },
{ Qt::Key_Up, HID_User::PAD_UP },
{ Qt::Key_Down, HID_User::PAD_DOWN },
{ Qt::Key_R, HID_User::PAD_R },
{ Qt::Key_L, HID_User::PAD_L },
{ Qt::Key_X, HID_User::PAD_X },
{ Qt::Key_Y, HID_User::PAD_Y },
{ Qt::Key_H, HID_User::PAD_CIRCLE_RIGHT },
{ Qt::Key_F, HID_User::PAD_CIRCLE_LEFT },
{ Qt::Key_T, HID_User::PAD_CIRCLE_UP },
{ Qt::Key_G, HID_User::PAD_CIRCLE_DOWN },
};
GRenderWindow::GRenderWindow(QWidget* parent) : QWidget(parent), emu_thread(this)
{
// Register a new ID for the default keyboard
keyboard_id = KeyMap::NewDeviceId();
// Set default key mappings for keyboard
for (auto mapping : default_key_map) {
KeyMap::SetKeyMapping({mapping.first, keyboard_id}, mapping.second);
}
// TODO: One of these flags might be interesting: WA_OpaquePaintEvent, WA_NoBackground, WA_DontShowOnScreen, WA_DeleteOnClose
QGLFormat fmt;
fmt.setProfile(QGLFormat::CoreProfile);
@ -209,27 +236,13 @@ QByteArray GRenderWindow::saveGeometry()
void GRenderWindow::keyPressEvent(QKeyEvent* event)
{
/*
bool key_processed = false;
for (unsigned int channel = 0; channel < 4 && controller_interface(); ++channel)
if (controller_interface()->SetControllerStatus(channel, event->key(), input_common::GCController::PRESSED))
key_processed = true;
if (!key_processed)
QWidget::keyPressEvent(event);
*/
EmuWindow::KeyPressed({event->key(), keyboard_id});
HID_User::PadUpdateComplete();
}
void GRenderWindow::keyReleaseEvent(QKeyEvent* event)
{
/*
bool key_processed = false;
for (unsigned int channel = 0; channel < 4 && controller_interface(); ++channel)
if (controller_interface()->SetControllerStatus(channel, event->key(), input_common::GCController::RELEASED))
key_processed = true;
if (!key_processed)
QWidget::keyPressEvent(event);
*/
EmuWindow::KeyReleased({event->key(), keyboard_id});
HID_User::PadUpdateComplete();
}

View File

@ -116,4 +116,6 @@ private:
EmuThread emu_thread;
QByteArray geometry;
int keyboard_id;
};

View File

@ -4,10 +4,12 @@ configure_file("${CMAKE_CURRENT_SOURCE_DIR}/scm_rev.cpp.in" "${CMAKE_CURRENT_SOU
set(SRCS
break_points.cpp
console_listener.cpp
emu_window.cpp
extended_trace.cpp
file_search.cpp
file_util.cpp
hash.cpp
key_map.cpp
log_manager.cpp
math_util.cpp
mem_arena.cpp
@ -39,6 +41,7 @@ set(HEADERS
file_search.h
file_util.h
hash.h
key_map.h
linear_disk_cache.h
log.h
log_manager.h

17
src/common/emu_window.cpp Normal file
View File

@ -0,0 +1,17 @@
// Copyright 2014 Citra Emulator Project
// Licensed under GPLv2
// Refer to the license.txt file included.
#include "emu_window.h"
void EmuWindow::KeyPressed(KeyMap::HostDeviceKey key) {
HID_User::PadState mapped_key = KeyMap::GetPadKey(key);
HID_User::PadButtonPress(mapped_key);
}
void EmuWindow::KeyReleased(KeyMap::HostDeviceKey key) {
HID_User::PadState mapped_key = KeyMap::GetPadKey(key);
HID_User::PadButtonRelease(mapped_key);
}

View File

@ -7,6 +7,8 @@
#include "common/common.h"
#include "common/scm_rev.h"
#include "common/key_map.h"
// Abstraction class used to provide an interface between emulation code and the frontend (e.g. SDL,
// QGLWidget, GLFW, etc...)
class EmuWindow
@ -32,6 +34,12 @@ public:
/// Releases (dunno if this is the "right" word) the GLFW context from the caller thread
virtual void DoneCurrent() = 0;
/// Signals a key press action to the HID module
static void KeyPressed(KeyMap::HostDeviceKey key);
/// Signals a key release action to the HID module
static void KeyReleased(KeyMap::HostDeviceKey key);
Config GetConfig() const {
return m_config;
}

25
src/common/key_map.cpp Normal file
View File

@ -0,0 +1,25 @@
// Copyright 2014 Citra Emulator Project
// Licensed under GPLv2
// Refer to the license.txt file included.
#include "key_map.h"
#include <map>
namespace KeyMap {
static std::map<HostDeviceKey, HID_User::PadState> key_map;
static int next_device_id = 0;
int NewDeviceId() {
return next_device_id++;
}
void SetKeyMapping(HostDeviceKey key, HID_User::PadState padState) {
key_map[key].hex = padState.hex;
}
HID_User::PadState GetPadKey(HostDeviceKey key) {
return key_map[key];
}
}

45
src/common/key_map.h Normal file
View File

@ -0,0 +1,45 @@
// Copyright 2014 Citra Emulator Project
// Licensed under GPLv2
// Refer to the license.txt file included.
#pragma once
#include "core/hle/service/hid.h"
namespace KeyMap {
/**
* Represents a key for a specific host device.
*/
struct HostDeviceKey {
int key_code;
int device_id; ///< Uniquely identifies a host device
bool operator < (const HostDeviceKey &other) const {
if (device_id == other.device_id) {
return key_code < other.key_code;
}
return device_id < other.device_id;
}
bool operator == (const HostDeviceKey &other) const {
return device_id == other.device_id && key_code == other.key_code;
}
};
/**
* Generates a new device id, which uniquely identifies a host device within KeyMap.
*/
int NewDeviceId();
/**
* Maps a device-specific key to a PadState.
*/
void SetKeyMapping(HostDeviceKey key, HID_User::PadState padState);
/**
* Gets the PadState that's mapped to the provided device-specific key.
*/
HID_User::PadState GetPadKey(HostDeviceKey key);
}

View File

@ -14,7 +14,128 @@
namespace HID_User {
Handle g_shared_mem = 0; ///< Handle to shared memory region designated to HID_User service
// Handle to shared memory region designated to HID_User service
static Handle shared_mem = 0;
// Event handles
static Handle event_pad_or_touch_1 = 0;
static Handle event_pad_or_touch_2 = 0;
static Handle event_accelerometer = 0;
static Handle event_gyroscope = 0;
static Handle event_debug_pad = 0;
// Next Pad state update information
static PadState next_state = {{0}};
static u32 next_index = 0;
static s16 next_circle_x = 0;
static s16 next_circle_y = 0;
/**
* Gets a pointer to the PadData structure inside HID shared memory
*/
static inline PadData* GetPadData() {
if (0 == shared_mem)
return nullptr;
return reinterpret_cast<PadData*>(Kernel::GetSharedMemoryPointer(shared_mem, 0));
}
/**
* Circle Pad from keys.
*
* This is implemented as "pushed all the way to an edge (max) or centered (0)".
*
* Indicate the circle pad is pushed completely to the edge in 1 of 8 directions.
*/
void UpdateNextCirclePadState() {
static const s16 max_value = 0x9C;
next_circle_x = next_state.circle_left ? -max_value : 0x0;
next_circle_x += next_state.circle_right ? max_value : 0x0;
next_circle_y = next_state.circle_down ? -max_value : 0x0;
next_circle_y += next_state.circle_up ? max_value : 0x0;
}
/**
* Sets a Pad state (button or button combo) as pressed
*/
void PadButtonPress(PadState pad_state) {
next_state.hex |= pad_state.hex;
UpdateNextCirclePadState();
}
/**
* Sets a Pad state (button or button combo) as released
*/
void PadButtonRelease(PadState pad_state) {
next_state.hex &= ~pad_state.hex;
UpdateNextCirclePadState();
}
/**
* Called after all Pad changes to be included in this update have been made,
* including both Pad key changes and analog circle Pad changes.
*/
void PadUpdateComplete() {
PadData* pad_data = GetPadData();
// Update PadData struct
pad_data->current_state.hex = next_state.hex;
pad_data->index = next_index;
next_index = (next_index + 1) % pad_data->entries.size();
// Get the previous Pad state
u32 last_entry_index = (pad_data->index - 1) % pad_data->entries.size();
PadState old_state = pad_data->entries[last_entry_index].current_state;
// Compute bitmask with 1s for bits different from the old state
PadState changed;
changed.hex = (next_state.hex ^ old_state.hex);
// Compute what was added
PadState additions;
additions.hex = changed.hex & next_state.hex;
// Compute what was removed
PadState removals;
removals.hex = changed.hex & old_state.hex;
// Get the current Pad entry
PadDataEntry* current_pad_entry = &pad_data->entries[pad_data->index];
// Update entry properties
current_pad_entry->current_state.hex = next_state.hex;
current_pad_entry->delta_additions.hex = additions.hex;
current_pad_entry->delta_removals.hex = removals.hex;
// Set circle Pad
current_pad_entry->circle_pad_x = next_circle_x;
current_pad_entry->circle_pad_y = next_circle_y;
// If we just updated index 0, provide a new timestamp
if (pad_data->index == 0) {
pad_data->index_reset_ticks_previous = pad_data->index_reset_ticks;
pad_data->index_reset_ticks = (s64)Core::g_app_core->GetTicks();
}
// Signal both handles when there's an update to Pad or touch
Kernel::SignalEvent(event_pad_or_touch_1);
Kernel::SignalEvent(event_pad_or_touch_2);
}
// TODO(peachum):
// Add a method for setting analog input from joystick device for the circle Pad.
//
// This method should:
// * Be called after both PadButton<Press, Release>().
// * Be called before PadUpdateComplete()
// * Set current PadEntry.circle_pad_<axis> using analog data
// * Set PadData.raw_circle_pad_data
// * Set PadData.current_state.circle_right = 1 if current PadEntry.circle_pad_x >= 41
// * Set PadData.current_state.circle_up = 1 if current PadEntry.circle_pad_y >= 41
// * Set PadData.current_state.circle_left = 1 if current PadEntry.circle_pad_x <= -41
// * Set PadData.current_state.circle_right = 1 if current PadEntry.circle_pad_y <= -41
/**
* HID_User::GetIPCHandles service function
@ -34,12 +155,12 @@ void GetIPCHandles(Service::Interface* self) {
u32* cmd_buff = Service::GetCommandBuffer();
cmd_buff[1] = 0; // No error
cmd_buff[3] = g_shared_mem;
cmd_buff[4] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventA");
cmd_buff[5] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventB");
cmd_buff[6] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventC");
cmd_buff[7] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventGyroscope");
cmd_buff[8] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventD");
cmd_buff[3] = shared_mem;
cmd_buff[4] = event_pad_or_touch_1;
cmd_buff[5] = event_pad_or_touch_2;
cmd_buff[6] = event_accelerometer;
cmd_buff[7] = event_gyroscope;
cmd_buff[8] = event_debug_pad;
DEBUG_LOG(KERNEL, "called");
}
@ -57,11 +178,19 @@ const Interface::FunctionInfo FunctionTable[] = {
{0x00170000, nullptr, "GetSoundVolume"},
};
////////////////////////////////////////////////////////////////////////////////////////////////////
// Interface class
Interface::Interface() {
g_shared_mem = Kernel::CreateSharedMemory("HID_User:SharedMem"); // Create shared memory object
shared_mem = Kernel::CreateSharedMemory("HID_User:SharedMem"); // Create shared memory object
// Create event handles
event_pad_or_touch_1 = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventPadOrTouch1");
event_pad_or_touch_2 = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventPadOrTouch2");
event_accelerometer = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventAccelerometer");
event_gyroscope = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventGyroscope");
event_debug_pad = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventDebugPad");
Register(FunctionTable, ARRAY_SIZE(FunctionTable));
}

View File

@ -5,15 +5,101 @@
#pragma once
#include "core/hle/service/service.h"
#include "common/bit_field.h"
////////////////////////////////////////////////////////////////////////////////////////////////////
// Namespace HID_User
// This service is used for interfacing to physical user controls... perhaps "Human Interface
// Devices"? Uses include game pad controls, accelerometers, gyroscopes, etc.
// This service is used for interfacing to physical user controls.
// Uses include game pad controls, touchscreen, accelerometers, gyroscopes, and debug pad.
namespace HID_User {
/**
* Structure of a Pad controller state.
*/
struct PadState {
union {
u32 hex;
BitField<0, 1, u32> a;
BitField<1, 1, u32> b;
BitField<2, 1, u32> select;
BitField<3, 1, u32> start;
BitField<4, 1, u32> right;
BitField<5, 1, u32> left;
BitField<6, 1, u32> up;
BitField<7, 1, u32> down;
BitField<8, 1, u32> r;
BitField<9, 1, u32> l;
BitField<10, 1, u32> x;
BitField<11, 1, u32> y;
BitField<28, 1, u32> circle_right;
BitField<29, 1, u32> circle_left;
BitField<30, 1, u32> circle_up;
BitField<31, 1, u32> circle_down;
};
};
/**
* Structure of a single entry in the PadData's Pad state history array.
*/
struct PadDataEntry {
PadState current_state;
PadState delta_additions;
PadState delta_removals;
s16 circle_pad_x;
s16 circle_pad_y;
};
/**
* Structure of all data related to the 3DS Pad.
*/
struct PadData {
s64 index_reset_ticks;
s64 index_reset_ticks_previous;
u32 index; // the index of the last updated Pad state history element
u32 pad1;
u32 pad2;
PadState current_state; // same as entries[index].current_state
u32 raw_circle_pad_data;
u32 pad3;
std::array<PadDataEntry, 8> entries; // Pad state history
};
// Pre-defined PadStates for single button presses
const PadState PAD_NONE = {{0}};
const PadState PAD_A = {{1u << 0}};
const PadState PAD_B = {{1u << 1}};
const PadState PAD_SELECT = {{1u << 2}};
const PadState PAD_START = {{1u << 3}};
const PadState PAD_RIGHT = {{1u << 4}};
const PadState PAD_LEFT = {{1u << 5}};
const PadState PAD_UP = {{1u << 6}};
const PadState PAD_DOWN = {{1u << 7}};
const PadState PAD_R = {{1u << 8}};
const PadState PAD_L = {{1u << 9}};
const PadState PAD_X = {{1u << 10}};
const PadState PAD_Y = {{1u << 11}};
const PadState PAD_CIRCLE_RIGHT = {{1u << 28}};
const PadState PAD_CIRCLE_LEFT = {{1u << 29}};
const PadState PAD_CIRCLE_UP = {{1u << 30}};
const PadState PAD_CIRCLE_DOWN = {{1u << 31}};
// Methods for updating the HID module's state
void PadButtonPress(PadState pad_state);
void PadButtonRelease(PadState pad_state);
void PadUpdateComplete();
/**
* HID service interface.
*/
class Interface : public Service::Interface {
public:

View File

@ -27,6 +27,7 @@ static const int kScreenBottomHeight = 240; ///< 3DS bottom screen height
extern RendererBase* g_renderer; ///< Renderer plugin
extern int g_current_frame; ///< Current frame
extern EmuWindow* g_emu_window; ///< Emu window
/// Start the video core
void Start();