pixelflut 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4b1d4d4f5be08766e694539cf82507427f901f71ae1ec4c5568cec7344d1345
-  data.tar.gz: 65d9ebde1aa48a5989c28340d3da137b8d99d3952a85fbfb904ad7af64420df8
+  metadata.gz: b91c341d7ba55f35b968b3a35c31cb4e676b2055c2f86bd6a94e3f5a4847c788
+  data.tar.gz: 700e3fae41c985852236339eca7381f05d383e55c74e9948b2f7935b2f7bf69e
 SHA512:
-  metadata.gz: 377feb36cdde2221e3d6c7739acc9773d771d15cf319e93e379c6f86248189c286af91a25e13acda88fc40e030b956761ffa205215e4bb37ddd9ee64e805e748
-  data.tar.gz: 910cd772cedf70ddd4cb01445821ccf360f54d96a3c4076b9845886a0e5e1a232a0b153e640b574e6540c490c77691bd515a6b42bb74ade60f0970e2e201c9f9
+  metadata.gz: 68bbebdd53d083cf10e6bc5c76a18b81ac43347f929166d61493a4e8a54b07263f7ae18c1b23eb5c26317a8d02a33aea18f26740c0cb3f9f387338bb4322a2f5
+  data.tar.gz: c045bd205847f450c924c2e0f2485737af956f6f419e99b78dadd7b8ab101972f0b251bd09eb62bd39024f60c4f00b34830ccf367a718e71395d037696f735ea

data/README.md

@@ -12,8 +12,8 @@ This gem is an open experiment. You are welcome to fork or create pull requests
 
 Use [Bundler](http://gembundler.com/) to install the gem:
 
-```bash
-$ gem install pixelflut
+```sh
+gem install pixelflut
 ```
 
 Now the `pxf` command offers the complete functionality.
@@ -22,18 +22,19 @@ Now the `pxf` command offers the complete functionality.
 
 You'll find some help on the command line:
 
-```bash
+```
 $ pxf
-Usage: pxf [OPTIONS] IMAGE
+Usage: pxf [options] <image>
 
 Options:
-    --host ADDRESS        target host address
--p, --port PORT           target port (default 1234)
--c, --connections CONN    count of connections (default 4)
--b, --bytes BYTES         send junks of BYTES size
--x, --transpose-x X       transpose image X pixels
--y, --transpose-y Y       transpose image Y pixels
--s, --scale SCALE         scale image by SCALE factor
--m, --pixel MODE          select pixel coding (RGBX | RGBA | RGB)
--h, --help                print this help
+      --host <address>       target host address (default 127.0.0.1)
+  -p, --port <port>          target port (default 1337)
+  -c, --connections <count>  count of connections (default 4)
+  -x, --transpose-x <x>      transpose image <x> pixels
+  -y, --transpose-y <y>      transpose image <y> pixels
+  -m, --mode <mode>          select pixel encoding (TEXT | BIN)
+  -t, --threads              use threads instead of processes
+  -h, --help                 print this help
+  -v, --version              print version information
+
 ```

data/bin/pxf

@@ -1,69 +1,133 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-help <<~end, 'IMAGE'
-      --host ADDRESS        target host address
-  -p, --port PORT           target port (default 1234)
-  -c, --connections CONN    count of connections (default 4)
-  -b, --bytes BYTES         send junks of BYTES size
-  -x, --transpose-x X       transpose image X pixels
-  -y, --transpose-y Y       transpose image Y pixels
-  -s, --scale SCALE         scale image by SCALE factor
-  -m, --pixel MODE          select pixel coding (RGBX | RGBA | RGB)
-  -h, --help                print this help
+$stdout.sync = $stderr.sync = true
+$name = Process.setproctitle(File.basename(Process.argv0))
+
+if ARGV.index('-h') || ARGV.index('--help')
+  puts <<~HELP
+    Usage: #{$name} [options] <png_image>
+
+    Options:
+          --host <address>       target host address (default 127.0.0.1)
+      -p, --port <port>          target port (default 1234)
+      -c, --connections <count>  count of connections (default 4)
+      -m, --mode <mode>          select pixel encoding (TEXT | BIN)
+      -t, --threads              use threads instead of processes
+      -x, --transpose-x <x>      transpose image <x> pixels
+      -y, --transpose-y <y>      transpose image <y> pixels
+      -h, --help                 print this help
+      -v, --version              print version information
+  HELP
+  exit
 end
 
-main do |opts|
-  data = create_junks(opts)
-  print("spawn #{data.size}")
-  data.size.times do |i|
-    next unless fork
-    Process.setproctitle(name(format("#{name}-%02d", i + 1)))
-    data = data[i].join
-    GC.start
-    GC.disable
-    Pixelflut::Sender.send(opts.address, data) { print('.') }
-  end
-rescue SocketError => e
-  error(3, e)
-rescue LoadError => e
-  error(4, e)
-rescue Errno::ECONNREFUSED
-  error(2, 'unable to connect')
-rescue Errno::EPIPE
-  error(2, 'connection lost')
+if ARGV.index('-v') || ARGV.index('--version')
+  require_relative('../lib/pixelflut/version')
+  puts("#{$name} - Pixelflut v#{Pixelflut::VERSION}")
+  exit
 end
 
-def create_junks(opts)
-  lines = Pixelflut.convert(**opts.to_h)
-  return Pixelflut.slices(lines, count: opts.count) if opts.bytes.zero?
-  Pixelflut.junks(lines, bytes: opts.bytes)
+def die!(msg, code: 1)
+  $stderr.puts("#{$name}: #{msg}")
+  exit(code)
 end
 
-before do
-  $stderr.sync = $stdout.sync = true
-  Process.setproctitle(name)
-  require_relative('../lib/pixelflut')
+die!('argument missing') if ARGV.empty?
+
+require_relative('../lib/pixelflut')
+
+module Configuration
+  class << self
+    attr_reader :use_threads
+
+    def address
+      require_relative('../lib/pixelflut/sender')
+      Pixelflut::Sender.as_address(@host || '127.0.0.1', @port || 1234)
+    end
+
+    private
+
+    def invalid(value, name)
+      die!("value for #{name} missing") if value.nil?
+      die!("invalid value for #{name} - '#{value}'")
+    end
+
+    def as_str(value, name)
+      value.nil? || value.empty? ? invalid(value, name) : value
+    end
+
+    def as_uint(value, name)
+      (ret = value.to_i).positive? ? ret : invalid(value, name)
+    end
+
+    def as_mode(value, name)
+      %w[text bin].include?(v = value.downcase) ? v : invalid(value, name)
+    end
+  end
+
+  until ARGV.empty?
+    case arg = ARGV.shift
+    when '--host'
+      @host = as_str(ARGV.shift, 'host')
+    when '-p', '--port'
+      @port = as_uint(ARGV.shift, 'port')
+    when '-c', '--connections'
+      Pixelflut.count = as_uint(ARGV.shift, 'connections')
+      die!("too many connections - #{Pixelflut.count}") if Pixelflut.count > 255
+    when '-m', '--mode', '--pixel'
+      Pixelflut.mode = as_mode(ARGV.shift, 'mode')
+    when '-t', '--use-threads'
+      @use_threads = true
+    when '-x', '--transpose-x'
+      Pixelflut.delta_x = ARGV.shift.to_i
+    when '-y', '--transpose-y'
+      Pixelflut.delta_y = ARGV.shift.to_i
+    else
+      die!("invalid option - #{arg}") if Pixelflut.file_name
+      Pixelflut.file_name = arg
+    end
+  end
+
+  die!('<image> missing') unless Pixelflut.file_name
 end
 
-parse_argv do |args|
-  Struct.new(:address, :count, :bytes, :x, :y, :mode, :scale, :source) do
-    def to_h
-      { source: source, x: x, y: y, scale: scale, mode: mode }
+def use_processes(address, data)
+  puts("#{$name}: start #{data.size} processes for #{data.sum(&:size)} bytes")
+  data.size.times do |i|
+    next unless fork
+    data = data[i]
+    GC.start
+    $name = Process.setproctitle("#{$name}-#{'0' if i < 9}#{i + 1}")
+    Pixelflut::Sender.send(address, data) do |size|
+      puts("#{$name}: #{size} bytes")
     end
-  end.new(
-    Pixelflut::Sender.address(
-      args['ADDRESS'] || '127.0.0.1',
-      (args['PORT'] || 1234).to_i
-    ),
-    (args['CONN'] || 4).to_i,
-    args['BYTES'].to_i,
-    args['X'].to_i,
-    args['Y'].to_i,
-    { 'RGBA' => :rgba, 'RGB' => :rgb }[args['MODE']] || :rgbx,
-    args.key?('SCALE') ? args['SCALE'].to_f : nil,
-    args['IMAGE']
-  )
+  end
 end
 
-BEGIN { require('mini-cli') and include(MiniCli) }
+def use_threads(address, data)
+  puts("#{$name}: start #{data.size} threads for #{data.sum(&:size)} bytes")
+  Thread.report_on_exception = false
+  data.map! { |slice| Thread.start { Pixelflut::Sender.send(address, slice) } }
+  GC.start
+  data.each(&:join)
+end
+
+begin
+  if Configuration.use_threads
+    use_threads(Configuration.address, Pixelflut.data)
+  else
+    use_processes(Configuration.address, Pixelflut.data)
+  end
+rescue Errno::ECONNREFUSED
+  die!('unable to connect', code: 2)
+rescue Errno::EPIPE
+  die!('connection lost', code: 2)
+rescue SocketError => e
+  die!(e, code: 3)
+rescue LoadError => e
+  die!(e, code: 4)
+rescue Interrupt
+  print("\b\b") if $stdout.tty?
+  die!('aborted', code: 130)
+end

data/lib/pixelflut/sender.rb

@@ -1,29 +1,31 @@
-require 'socket'
+# frozen_string_literal: true
 
 module Pixelflut
   module Sender
-    def self.address(host, port)
-      Addrinfo.tcp(host, port)
+    def self.as_address(host, port)
+      require('socket') unless defined?(Addrinfo)
+      info = Addrinfo.tcp(host, port)
+      Address.new(
+        Socket.pack_sockaddr_in(info.ip_port, info.ip_address),
+        info.ipv6? ? :INET6 : :INET
+      )
     end
 
     def self.send(address, data)
       socket = create_socket(address)
-      yield(socket) if block_given?
-      loop { socket.write(data) }
+      yield(data.bytesize) if block_given?
+      socket.write(data) while true
     end
 
     def self.create_socket(address)
-      Socket
-        .new(address.ipv6? ? :INET6 : :INET, :STREAM)
-        .tap do |socket|
-          socket.sync = false
-          socket.setsockopt(:TCP, :NODELAY, 0)
-          socket.setsockopt(:SOCKET, :KEEPALIVE, 0)
-          socket.do_not_reverse_lookup = true
-          socket.connect(
-            Socket.pack_sockaddr_in(address.ip_port, address.ip_address)
-          )
-        end
+      socket = Socket.new(address.type, :STREAM)
+      socket.connect(address.sockaddr_in)
+      socket.setsockopt(:TCP, :NODELAY, 1)
+      socket.setsockopt(:SOCKET, :KEEPALIVE, 0)
+      socket.sync = socket.do_not_reverse_lookup = true
+      socket
     end
+
+    Address = Struct.new(:sockaddr_in, :type)
   end
 end

data/lib/pixelflut/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pixelflut
-  VERSION = '0.2.1'
+  VERSION = '1.0.0'
 end

data/lib/pixelflut.rb

@@ -1,57 +1,99 @@
 # frozen_string_literal: true
 
-require_relative 'pixelflut/image'
-require_relative 'pixelflut/sender'
-
 module Pixelflut
   class << self
-    def convert(source:, x: 0, y: 0, scale: nil, mode: :rgbx)
-      _convert(as_image(source, scale), x, y, &as_cvt(mode))
+    attr_accessor :file_name, :count, :mode, :delta_x, :delta_y
+
+    def data
+      sliced(convert(*load).shuffle!, @count).map!(&:join)
     end
 
-    def slices(lines, count: 4)
-      Array.new(count) { [] }.tap do |ret|
-        lines.each_with_index { |line, idx| ret[idx % count] << line }
-      end
+    private
+
+    def load
+      require('chunky_png') unless defined?(ChunkyPNG)
+      image = ChunkyPNG::Canvas.from_file(@file_name)
+      [image.width, image.height, image.pixels.pack("N#{image.pixels.size}")]
+    rescue Errno::ENOENT => e
+      raise(LoadError, e.message, cause: e)
     end
 
-    def junks(lines, bytes:)
-      size, ret = 0, [current = []]
-      lines.each do |line|
-        next current << line if (size += line.bytesize) < bytes
-        ret << (current = [line])
-        size = line.bytesize
+    # def load_rmagick
+    #   require('rmagick') unless defined?(Magick)
+    #   image = Magick::Image.read(@file_name).first
+    #   image.scale!(@scale) if @scale
+    #   [
+    #     image.columns,
+    #     image.rows,
+    #     image.export_pixels_to_str(0, 0, image.columns, image.rows, 'rgba')
+    #   ]
+    # rescue Magick::ImageMagickError => e
+    #   raise(LoadError, e.message, cause: e)
+    # end
+
+    def sliced(array, number)
+      division = array.size / number
+      modulo = array.size % number
+      pos = 0
+      Array.new(number) do |index|
+        length = division + (modulo > 0 && modulo > index ? 1 : 0)
+        slice = array.slice(pos, length)
+        pos += length
+        slice
       end
-      ret
     end
-    alias packages junks # backward compatibility
-
-    private
 
-    def _convert(image, dx, dy)
-      image.each_pixel.to_a.map! do |x, y, px|
-        "PX #{x + dx} #{y + dy} #{yield(px)}\n"
-      end.shuffle!
+    def convert(width, height, blob)
+      if @mode == 'bin'
+        to_bin_format(width, height, blob)
+      else
+        to_text_format(width, height, blob)
+      end
     end
 
-    def as_image(source, scale)
-      Image.new(source).tap { |image| image.scale(scale) if scale }
+    def to_text_format(width, height, blob)
+      ret = []
+      pos = -1
+      height.times do |y|
+        width.times do |x|
+          next if (a = blob.getbyte(pos += 4)) == 0
+          ret << format(
+            (
+              if a == 255
+                "PX %d %d %02x%02x%02x\n"
+              else
+                "PX %d %d %02x%02x%02x%02x\n"
+              end
+            ),
+            x + @delta_x,
+            y + @delta_y,
+            blob.getbyte(pos - 3),
+            blob.getbyte(pos - 2),
+            blob.getbyte(pos - 1),
+            a
+          )
+        end
+      end
+      ret
     end
 
-    def as_cvt(mode)
-      case mode
-      when :rgb
-        lambda { |px| px.to_color(Magick::AllCompliance, false, 8, true)[1, 6] }
-      when :rgba
-        lambda { |px| px.to_color(Magick::AllCompliance, true, 8, true)[1, 8] }
-      else
-        lambda do |px|
-          px.to_color(Magick::AllCompliance, false, 8, true)[
-            1,
-            px.alpha >= 65_535 ? 6 : 8
-          ]
+    def to_bin_format(width, height, blob)
+      ret = []
+      pos = 0
+      height.times do |y|
+        width.times do |x|
+          if blob[pos + 3] != "\x0"
+            ret << "PB#{[x + @delta_x, y + @delta_y].pack('v2')}#{blob[pos, 4]}"
+          end
+          pos += 4
         end
       end
+      ret
     end
   end
+
+  @count = ENV['TC'].to_i
+  @count = 4 unless @count.positive?
+  @mode = 'text'
+  @delta_x = @delta_y = 0
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: pixelflut
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rmagick
+  name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,48 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mini-cli
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |
   Based on the idea of a simple server protocol to collaborate on a shared
   canvas named [Pixelflut](https://cccgoe.de/wiki/Pixelflut) this gem
@@ -73,27 +31,21 @@ description: |
 email:
 executables:
 - pxf
-- pxf-info
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
 - README.md
 - bin/pxf
-- bin/pxf-info
-- gems.rb
 - lib/pixelflut.rb
-- lib/pixelflut/image.rb
 - lib/pixelflut/sender.rb
 - lib/pixelflut/version.rb
-- pixelflut.gemspec
-- rakefile.rb
 homepage: https://github.com/mblumtritt/pixelflut
 licenses: []
 metadata:
   source_code_uri: https://github.com/mblumtritt/pixelflut
   bug_tracker_uri: https://github.com/mblumtritt/pixelflut/issues
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -109,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.9
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: A fast Pixelflut client written in Ruby.

data/.gitignore

@@ -1,3 +0,0 @@
-tmp/
-pkg/
-gems.locked

data/bin/pxf-info

@@ -1,32 +0,0 @@
-#! /bin/sh
-
-set -e
-
-if [ "$1" = '--help' ]
-then
-  echo "Usage: ${0##*/} [-p|--port PORT] ADDRESS
-
-Requests screen size of Pixelflut server at ADDRESS.
-"
-  exit 0
-fi
-
-PORT="1234"
-ADDRESS=""
-
-while [ $# -gt 0 ]
-do
-  key="$1"
-  case $key in
-  -p|--port)
-    PORT="$2"
-    shift; shift
-    ;;
-  *)
-    ADDRESS="$key"
-    shift
-    ;;
-  esac
-done
-
-echo "SIZE\nQUIT\n" | nc "$ADDRESS" "$PORT"

data/gems.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-source('https://rubygems.org') { gemspec }

data/lib/pixelflut/image.rb

@@ -1,32 +0,0 @@
-require 'rmagick'
-
-module Pixelflut
-  class Image
-    def initialize(file_name)
-      @image = Magick::ImageList.new(file_name)[0]
-    rescue Magick::ImageMagickError => e
-      raise(LoadError, e.message, cause: e)
-    end
-
-    def width
-      @image.columns
-    end
-
-    def height
-      @image.rows
-    end
-
-    def resize_to(width, height = nil)
-      @image.resize_to_fit!(width, height)
-    end
-
-    def scale(factor)
-      @image.scale!(factor)
-    end
-
-    def each_pixel
-      return to_enum(__method__) unless block_given?
-      @image.each_pixel { |px, x, y| 0 != px.alpha and yield(x, y, px) }
-    end
-  end
-end

data/pixelflut.gemspec

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/pixelflut/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'pixelflut'
-  spec.version = Pixelflut::VERSION
-  spec.author = 'Mike Blumtritt'
-
-  spec.required_ruby_version = '>= 2.7.2'
-
-  spec.summary = 'A fast Pixelflut client written in Ruby.'
-  spec.description = <<~DESCRIPTION
-    Based on the idea of a simple server protocol to collaborate on a shared
-    canvas named [Pixelflut](https://cccgoe.de/wiki/Pixelflut) this gem
-    implements a fast Ruby client version.
-  DESCRIPTION
-  spec.homepage = 'https://github.com/mblumtritt/pixelflut'
-
-  spec.metadata['source_code_uri'] = 'https://github.com/mblumtritt/pixelflut'
-  spec.metadata['bug_tracker_uri'] =
-    'https://github.com/mblumtritt/pixelflut/issues'
-
-  spec.add_runtime_dependency 'rmagick'
-  spec.add_runtime_dependency 'mini-cli', '>= 0.4.0'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-
-  spec.bindir = 'bin'
-  spec.executables = %w[pxf pxf-info]
-
-  spec.files = Dir.chdir(__dir__) { `git ls-files -z`.split(0.chr) }
-  spec.extra_rdoc_files = %w[README.md]
-end

data/rakefile.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-
-$stdout.sync = $stderr.sync = true
-
-task(:default) { exec 'rake --tasks' }