fusuma-plugin-remap 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb42159c757f56d2da9af424bfc088719bc22c965ad72bed52bc9bd81ad86e9f
-  data.tar.gz: cdddfbf418ecb85c1ad0cd3991d04ca5f022833ce4b344b1e9e37594c6c82ae9
+  metadata.gz: c2455d59dcc7050237331988d27f8def95586791fd1f86974146ceb7a373ff35
+  data.tar.gz: c39286dafd8112602c61953512d16f85f0e3b51c318e215431d5539efd33eadd
 SHA512:
-  metadata.gz: d8255feb9082b3f8e18962b8edfe73ba44ebb61d53f159ebeeadf6fda53ca796cbce18f100d4efdb8dcf3c8290920458c30ccffb924973b8a6a9eb0c855db555
-  data.tar.gz: c24ca94224d7aadb892af07c62fe689ff74e07b38ff09cc0a15b6755d1aa3092a2255c553aff93f6c6c4401220456ec665776fd9eb5b57da3e102816929f9182
+  metadata.gz: a40ff642c159e4f7a8f627929c01f99e44e666c0de24f5c977fff7c2967a37fce1693152053d6477edc9f4c87e7691b4b987ca7bd0fdbade5029d40f12d6e1a5
+  data.tar.gz: efb92a3fb8c1d67b93e811ad631d0437e5f0a2000035a2c2637ae942d25072869efb7c88a00478dfb6606239a3283f86bf6fc4ab970feeb6c295c1ed99f70d5f

data/README.md

@@ -1,13 +1,13 @@
 # Fusuma::Plugin::Remap [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-remap.svg)](https://badge.fury.io/rb/fusuma-plugin-remap) [![Build Status](https://github.com/iberianpig/fusuma-plugin-remap/actions/workflows/main.yml/badge.svg)](https://github.com/iberianpig/fusuma-plugin-remap/actions/workflows/main.yml)
 
-## Installation
+A Fusuma plugin for remapping keyboard events into virtual input devices. Compatible with other Fusuma plugins.
 
 **THIS PLUGIN IS EXPERIMENTAL.**
 
-A Fusuma plugin for remapping keyboard events into virtual input devices. Compatible with other Fusuma plugins.
-
 This plugin empowers users to manipulate keyboard events and convert them into virtual input devices. It is designed to integrate seamlessly with other Fusuma plugins, thus enabling users to construct sophisticated input configurations and achieve distinctive functionalities. A key feature is the dynamic alteration of remapping layers within the Fusuma process, thereby enabling users to adapt their keyboard inputs to suit specific tasks or applications.
 
+## Installation
+
 This plugin requires [fusuma](https://github.com/iberianpig/fusuma#update) 2.0
 
 ### Install dependencies
@@ -65,6 +65,13 @@ remap:
   SPACE: BTN_LEFT
 ```
 
+## Emergency stop keybind for virtual keyboard
+
+This is a special keybind for emergency stop. 
+If you press following keybind, physical keyboard will be ungrabbed and Fusuma process will be terminated.
+
+<kbd>RIGHTCTRL</kbd> → <kbd>LEFTCTRL</kbd>
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-remap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/exe/fusuma-remap

@@ -1,44 +1,93 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require "fusuma/plugin/inputs/input"
+require_relative "../lib/fusuma/plugin/inputs/remap_keyboard_input"
 require_relative "../lib/fusuma/plugin/remap/version"
-require_relative "../lib/fusuma/plugin/remap/remapper"
+require_relative "../lib/fusuma/plugin/remap/keyboard_remapper"
 require_relative "../lib/fusuma/plugin/remap/layer_manager"
 require "fusuma/config"
-require "revdev"
+require "fusuma/multi_logger"
 require "msgpack"
+require "irb"
 
-include Revdev
+Fusuma::MultiLogger.instance.debug_mode = true
+Fusuma::Config.instance.custom_path = "~/.config/fusuma/config.yml"
 
-if ARGV.length > 1
-  source_keyboards = [Revdev::EventDevice.new(ARGV.shift)]
-  internal_touchpad = Revdev::EventDevice.new(ARGV.shift)
-else
-  warn "Usage: #{$PROGRAM_NAME} /dev/input/KEYBOARD /dev/input/TOUCHPAD"
-  exit false
+# FIXME: use OptionParser and implement help
+if ARGV.length < 1
+  puts "you can specify keyboard name pattern and touchpad name pattern"
+  puts "$ #{$PROGRAM_NAME} 'AT Translated Set 2 keyboard' 'SynPS/2 Synaptics TouchPad'"
 end
 
-Fusuma::Config.instance.custom_path = "~/.config/fusuma/config.yml"
+keyboard_name_pattern ||= ARGV.shift || ["keyboard", "Keyboard", "KEYBOARD"]
+touchpad_name_pattern ||= ARGV.shift || ["touchpad", "Touchpad", "TOUCHPAD"]
+
+source_keyboards = Fusuma::Plugin::Inputs::RemapKeyboardInput::KeyboardSelector.new(keyboard_name_pattern).select
+internal_touchpad = Fusuma::Plugin::Inputs::RemapKeyboardInput::TouchpadSelector.new(touchpad_name_pattern).select.first
+
+if source_keyboards.empty?
+  warn "no keyboard found"
+  exit 1
+end
+
+if internal_touchpad.nil?
+  warn "no touchpad found"
+  exit 1
+end
+
+@layer_manager = Fusuma::Plugin::Remap::LayerManager.instance
 
-layer_manager = Fusuma::Plugin::Remap::LayerManager.instance
+keyboard_reader, fusuma_writer = IO.pipe
 
-_keyboard_reader, keyboard_writer = IO.pipe
+layers = Fusuma::Config.instance.keymap.select { |m| m[:context] && m[:remap] }.map { |m| m[:context] }.uniq
 Thread.new do
-  layer_manager.send_layer(layer: {foo: "bar"})
-  sleep 3
-  layer_manager.send_layer(layer: {thumbsense: true})
-  sleep 3
-  layer_manager.send_layer(layer: {thumbsense: true}, remove: true)
-
-  # u = MessagePack::Unpacker.new(keyboard_reader)
-  # loop do
-  #   puts "unpack: #{u.unpack}"
-  # end
+  layers.each do |layer|
+    @layer_manager.send_layer(layer: layer)
+    @layer_manager.send_layer(layer: layer, remove: true)
+    sleep 1
+  end
+
+  puts "=================================================="
+  puts "press key UP or DOWN to change layer"
+  puts "=================================================="
+
+  layer_selector = Fiber.new do
+    layers = ([{}] | layers)
+    @reverse = false
+    pos = 0
+    loop do
+      pos = if @reverse
+        (pos - 1) % layers.size
+      else
+        (pos + 1) % layers.size
+      end
+      @layer_manager.send_layer(layer: @layer_manager.current_layer, remove: true)
+      @layer_manager.send_layer(layer: layers[pos])
+      Fiber.yield
+    end
+  end
+
+  unpacker = MessagePack::Unpacker.new(keyboard_reader)
+  loop do
+    data = unpacker.unpack
+    next unless data.is_a? Hash
+    next unless data["status"] == 1
+
+    case data["key"]
+    when "UP"
+      @reverse = false
+      layer_selector.resume
+    when "DOWN"
+      @reverse = true
+      layer_selector.resume
+    end
+  end
 end
 
-Fusuma::Plugin::Remap::Remapper.new(
-  layer_manager: layer_manager,
-  keyboard_writer: keyboard_writer,
+Fusuma::Plugin::Remap::KeyboardRemapper.new(
+  layer_manager: @layer_manager,
+  fusuma_writer: fusuma_writer,
   source_keyboards: source_keyboards,
   internal_touchpad: internal_touchpad
 ).run

data/exe/fusuma-touchpad-remap

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "fusuma/plugin/inputs/input"
+require_relative "../lib/fusuma/plugin/inputs/remap_touchpad_input"
+require_relative "../lib/fusuma/plugin/remap/version"
+require_relative "../lib/fusuma/plugin/remap/touchpad_remapper"
+require_relative "../lib/fusuma/plugin/remap/layer_manager"
+require "fusuma/config"
+require "fusuma/multi_logger"
+require "revdev"
+require "msgpack"
+require "irb"
+
+Fusuma::MultiLogger.instance.debug_mode = true
+Fusuma::Config.instance.custom_path = "~/.config/fusuma/config.yml"
+
+touchpad_name_pattern = ["touchpad", "Touchpad", "TOUCHPAD"]
+
+# $DEBUG=true # puts events
+
+internal_touchpad = Fusuma::Plugin::Inputs::RemapKeyboardInput::TouchpadSelector.new(touchpad_name_pattern).select.first
+
+if internal_touchpad.nil?
+  warn "no touchpad found"
+  exit 1
+end
+
+touchpad_reader, touchpad_writer = IO.pipe
+
+Thread.new do
+  unpacker = MessagePack::Unpacker.new(touchpad_reader)
+  loop do
+    data = unpacker.unpack
+    puts data
+  end
+end
+
+Fusuma::Plugin::Remap::TouchpadRemapper.new(
+  touchpad_writer: touchpad_writer,
+  source_touchpad: internal_touchpad
+).run

data/fusuma-plugin-remap.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
   # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
   # support focal (20.04LTS) 2.7
 
-  spec.add_dependency "fusuma", ">= 3.1"
-  spec.add_dependency "fusuma-plugin-keypress", "~> 0.5"
+  spec.add_dependency "fusuma", ">= 3.4"
+  spec.add_dependency "fusuma-plugin-keypress", ">= 0.11.0"
   spec.add_dependency "msgpack"
   spec.add_dependency "revdev"
   spec.add_dependency "ruinput"

data/lib/fusuma/plugin/inputs/remap_keyboard_input.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require "fusuma/device"
-require "fusuma/plugin/remap/remapper"
-require "fusuma/plugin/remap/layer_manager"
+require_relative "../remap/keyboard_remapper"
+require_relative "../remap/layer_manager"
 
 module Fusuma
   module Plugin
@@ -26,84 +26,50 @@ module Fusuma
         end
 
         def io
-          @keyboard_reader
+          @fusuma_reader
         end
 
-        # @param record [String]
-        # @return [Event]
-        def create_event(record:)
-          data = MessagePack.unpack(record) # => {"key"=>"J", "status"=>1}
+        # override Input#read_from_io
+        # @return [Record]
+        def read_from_io
+          @unpacker ||= MessagePack::Unpacker.new(io)
+          data = @unpacker.unpack
 
-          unless data.is_a? Hash
-            MultiLogger.error("Invalid record: #{record}", data: data)
-            return
-          end
+          raise "data is not Hash : #{data}" unless data.is_a? Hash
 
-          code = data["key"]
           status = (data["status"] == 1) ? "pressed" : "released"
-          record = Events::Records::KeypressRecord.new(status: status, code: code)
-
-          e = Events::Event.new(tag: tag, record: record)
-          MultiLogger.debug(input_event: e)
-          e
+          Events::Records::KeypressRecord.new(status: status, code: data["key"], layer: data["layer"])
+        rescue EOFError => e
+          MultiLogger.error "#{self.class.name}: #{e}"
+          MultiLogger.error "Shutdown fusuma process..."
+          Process.kill("TERM", Process.pid)
         end
 
         private
 
         def setup_remapper
-          source_keyboards = KeyboardSelector.new(config_params(:keyboard_name_patterns)).select
-          internal_touchpad = TouchpadSelector.new(config_params(:touchpad_name_patterns)).select.first
-          MultiLogger.info(source_keyboards: source_keyboards.map(&:device_name), internal_touchpad: internal_touchpad.device_name)
+          config = {
+            keyboard_name_patterns: config_params(:keyboard_name_patterns),
+            touchpad_name_patterns: config_params(:touchpad_name_patterns)
+          }
 
           layer_manager = Remap::LayerManager.instance
 
           # physical keyboard input event
-          @keyboard_reader, keyboard_writer = IO.pipe
+          @fusuma_reader, fusuma_writer = IO.pipe
 
           @pid = fork do
             layer_manager.writer.close
-            @keyboard_reader.close
-            remapper = Remap::Remapper.new(
+            @fusuma_reader.close
+            remapper = Remap::KeyboardRemapper.new(
               layer_manager: layer_manager,
-              source_keyboards: source_keyboards,
-              keyboard_writer: keyboard_writer,
-              internal_touchpad: internal_touchpad
+              fusuma_writer: fusuma_writer,
+              config: config
             )
             remapper.run
           end
           layer_manager.reader.close
-          keyboard_writer.close
-        end
-
-        # Devices to detect key presses and releases
-        class KeyboardSelector
-          def initialize(names = ["keyboard", "Keyboard", "KEYBOARD"])
-            @names = names
-          end
-
-          # @return [Array<Revdev::EventDevice>]
-          def select
-            devices = Fusuma::Device.all.select { |d| Array(@names).any? { |name| d.name =~ /#{name}/ } }
-            devices.map { |d| Revdev::EventDevice.new("/dev/input/#{d.id}") }
-          end
-        end
-
-        class TouchpadSelector
-          def initialize(names)
-            @names = names
-          end
-
-          # @return [Array<Revdev::EventDevice>]
-          def select
-            devices = if @names
-              Fusuma::Device.all.select { |d| Array(@names).any? { |name| d.name =~ /#{name}/ } }
-            else
-              # available returns only touchpad devices
-              Fusuma::Device.available
-            end
-
-            devices.map { |d| Revdev::EventDevice.new("/dev/input/#{d.id}") }
-          end
+          fusuma_writer.close
         end
       end
     end

data/lib/fusuma/plugin/inputs/remap_touchpad_input.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "fusuma/device"
+require_relative "../remap/touchpad_remapper"
+# require_relative "../remap/layer_manager"
+
+module Fusuma
+  module Plugin
+    module Inputs
+      # Get touchpad events from remapper
+      class RemapTouchpadInput < Input
+        include CustomProcess
+
+        def config_param_types
+          {
+            touchpad_name_patterns: [Array, String]
+          }
+        end
+
+        attr_reader :pid
+
+        def initialize
+          super
+          setup_remapper
+        end
+
+        def io
+          @fusuma_reader
+        end
+
+        # override Input#read_from_io
+        # @return [Record]
+        def read_from_io
+          @unpacker ||= MessagePack::Unpacker.new(io)
+          data = @unpacker.unpack
+
+          raise "data is not Hash : #{data}" unless data.is_a? Hash
+
+          gesture = "touch"
+          finger = data["finger"]
+
+          # @touch_state ||= {}
+          # @mt_slot ||= 0
+          # @touch_state[@mt_slot] ||= {
+          #   MT_TRACKING_ID: nil,
+          #   X: nil,
+          #   Y: nil,
+          #   valid_touch_point: false
+          # }
+          # TODO: implement update touch_state
+          status =
+            if data["touch_state"].any? { |_, v| v["valid_touch_point"] }
+              "begin"
+            else
+              "end"
+            end
+
+          Events::Records::GestureRecord.new(gesture: gesture, status: status, finger: finger, delta: nil)
+        rescue EOFError => e
+          MultiLogger.error "#{self.class.name}: #{e}"
+          MultiLogger.error "Shutdown fusuma process..."
+          Process.kill("TERM", Process.pid)
+        end
+
+        private
+
+        def setup_remapper
+          internal_touchpad = TouchpadSelector.new(config_params(:touchpad_name_patterns)).select.first
+          if internal_touchpad.nil?
+            MultiLogger.error("No touchpad found: #{config_params(:touchpad_name_patterns)}")
+            exit
+          end
+
+          MultiLogger.info("set up remapper")
+          MultiLogger.info("internal_touchpad: #{internal_touchpad.device_name}")
+
+          # layer_manager = Remap::LayerManager.instance
+
+          # physical touchpad input event
+          @fusuma_reader, fusuma_writer = IO.pipe
+
+          @pid = fork do
+            # layer_manager.writer.close
+            @fusuma_reader.close
+            remapper = Remap::TouchpadRemapper.new(
+              # layer_manager: layer_manager,
+              fusuma_writer: fusuma_writer,
+              source_touchpad: internal_touchpad
+            )
+            remapper.run
+          end
+          # layer_manager.reader.close
+          fusuma_writer.close
+        end
+
+        class TouchpadSelector
+          def initialize(names = nil)
+            @names = names
+          end
+
+          # @return [Array<Revdev::EventDevice>]
+          def select
+            devices = if @names
+              Fusuma::Device.all.select { |d| Array(@names).any? { |name| d.name =~ /#{name}/ } }
+            else
+              # available returns only touchpad devices
+              Fusuma::Device.available
+            end
+
+            devices.map { |d| Revdev::EventDevice.new("/dev/input/#{d.id}") }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/inputs/remap_touchpad_input.yml

@@ -0,0 +1,4 @@
+plugin:
+  inputs:
+    remap_touchpad_input:
+      touchpad_name_patterns: ["touchpad", "Touchpad", "TOUCHPAD"]