pixelflut 0.0.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53fa839b0f1e655d481296ff80e16c50bcb14cb8b65002508a6cbdb6cf602d18
-  data.tar.gz: dc278f90adf043c2acfa484ea1beaadb04c12dd70e18e7ed2daa88db69ea1f28
+  metadata.gz: d060b7c6e1888c61141aa6f24fae4e2255f4335d8e63ff8dcf1a8710f6d749a4
+  data.tar.gz: 81cb2846a78285887dab175ab3cb45bc9dcb4d9b0cf7d01add3d607431d537c5
 SHA512:
-  metadata.gz: 1bbf4d13ed7bc852d20000103456680ececcfc4286225b0fb7be74afce25ad89dff6fdcb5e89120737c599645591400c5761e4c0172e632c742599975ee5a5da
-  data.tar.gz: 53368ac74848597f441952344f40e30744517da98db162405d7837f461d15096a66a37e0291763672d60119a8fe1d8266ee91c2ca7764bd7a2eef71620b3ec95
+  metadata.gz: d30c42ab6b714404eff2f5dfb3c861c96010266086a497ba2684acb7e6c8ca2b3d79999e41fc10b44fb89a62c1375ed0b68b6da74afa79dfe40cc775c0031d47
+  data.tar.gz: 58ab45066aeff1c2b1162ff225ba24498a966a7a75caae0219f849695c1cf7d1b997ddbfba605ed118ffea2c9a72a222e666525b2936a618c6563b083b8f4208

data/.gitignore

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

data/README.md

@@ -1,14 +1,12 @@
 # Pixelflut
 
-A Pixelflut server written in Ruby.
+A Pixelflut client written in Ruby.
 
 ## Description
 
-Based on the idea of a simple server protocol to collaborate on a shared canvas named [Pixel Flut](https://cccgoe.de/wiki/Pixelflut) this gem implements a Ruby version.
+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 Ruby version of a client.
 
-This gem is an open experiment to write a fast server and canvas in Ruby. You are welcome to fork or create pull requests to find the fastest solution!
-
-The gem includes some tools to develop Pixelflut clients and pre-processors.
+This gem is an open experiment. You are welcome to fork or create pull requests to find the fastest solution!
 
 ### Installation
 
@@ -26,76 +24,16 @@ You'll find some help on the command line:
 
 ```bash
 $ pxf
-usage: pxf command [options]
-
-valid commands:
-convert    Convert given IMAGE file to Pixelflut ASCII format.
-generate   Execute given generator FILEs.
-help       Print help for given COMMAND.
-send       Send given Pixelflut ASCII file to a server.
-server     Start Pixelflut server.
-version    Print version information.
-```
-
-### Start a Sserver
-
-Starting the server on default port `1234` and open a drawing screen is quite simple:
-
-```bash
-$ pxf server
-```
-
-With these options you can configure the server:
-
-```
--b, --bind ADDR          bind to given address
--p, --port PORT          select port(default: 1234)
--k, --keep-alive         set maximum keep-alive time
--r, --read_buffer SIZE   set read buffer size (default: 1024)
--w, --width WIDTH        set canvas width (default: 800)
--h, --height HEIGHT      set canvas height (default: 600)
--f, --[no-]fullscreen    run in fullscreen mode
+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
 ```
-
-### Convert an Image
-
-There is a conversion command which can be used to convert a given image to the Pixelflut ASCII text format:
-
-```bash
-$ pxf convert image.png
-```
-
-The result can send directly to a server (sample assumes the server runs on localhost port 1234):
-
-```bash
-$ pxf convert image.png | pxf send
-```
-
-The converter can help you to resize and positioning the image at the servers canvas. These options are avail:
-
-```
--x, --transpose-x X   transpose image X pixels
--y, --transpose-y Y   transpose image Y pixels
--w, --width WIDTH     resize the image to given WIDTH
--h, --height HEIGHT   resize the image to given HEIGHT
-```
-
-It maybe faster to pre-process your images and send them later:
-
-```bash
-$ pxf convert -x 50 -y 100 --width 100 image1.png > image1.px
-$ pxf convert -x 150 --width 2100 image2.png > image2.px
-$ pxf send -h pixel_host image1.px image2.px
-```
-
-### Send Pixelflut ASCII Text
-
-The `pxf send` command can be used to send given Pixelflut ASCII text files to a server. It uses several connections at the same time to fasten the transmission.
-
-Next sample will send the Pixelflut ASCII text file named `pixels.px` to the server on port 1234 at address `pixelhost` using 12 connections:
-
-```bash
-$ pxf send -h pixelhost -p 1234 -c 12 pixels.px
-```
-
-If no file is given the STDIN will be read and send afterwards to the server.

data/bin/pxf

@@ -1,33 +1,67 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-def bin_root
-  File.realdirpath('../', __FILE__).freeze
-end
+require 'mini-cli'
+include MiniCli
 
-def find_commands
-  Hash[Dir.glob(File.join(bin_root, 'pxf-*')).map!{ |cmd| [File.basename(cmd)[4..-1], cmd] }]
+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
 end
 
-def err(msg)
-  $stderr.puts("pxf: #{msg}")
-  exit 1
+Process.setproctitle(name)
+$stderr.sync = $stdout.sync = true
+
+parse_argv do |args|
+  Struct.new(:host, :port, :count, :bytes, :x, :y, :mode, :scale, :source) do
+    def to_h
+      { source: source, x: x, y: y, scale: scale, mode: mode }
+    end
+  end.new(
+    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
 
-def general_help
-  puts('usage: pxf command [options]', nil, 'valid commands:')
-  map = find_commands.transform_values!{ |cmd| %x(#{cmd} --short-help) }
-  cmds = map.keys.sort!
-  len = cmds.max_by(&:size).size + 3
-  cmds.each do |cmd|
-    print cmd.ljust(len)
-    puts(map[cmd])
+main do |opts|
+  require_relative '../lib/pixelflut'
+  address = Pixelflut::Sender.address(opts.host, opts.port)
+  data = create_data(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(address, data) { print('.') }
   end
-  exit
+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')
 end
 
-general_help if ARGV.empty? || ARGV[0] == '--help' || ARGV[0] == '-h'
-cmd = ARGV.shift
-fname = File.join(bin_root, 'pxf-' + cmd)
-err("no such command - #{cmd}") unless File.executable?(fname)
-exec(fname, *ARGV)
+def create_data(opts)
+  data = Pixelflut.convert(**opts.to_h)
+  return Pixelflut.slices(data, count: opts.count) if opts.bytes.zero?
+  Pixelflut.packages(data, bytes: opts.bytes)
+end

data/bin/pxf-info

@@ -0,0 +1,32 @@
+#! /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 +1,3 @@
 # frozen_string_literal: true
 
-source('https://rubygems.org'){ gemspec }
+source('https://rubygems.org') { gemspec }

data/lib/pixelflut.rb

@@ -1,8 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'pixelflut/image'
+require_relative 'pixelflut/sender'
+
 module Pixelflut
-  LibDir = File.realdirpath('../pixelflut', __FILE__).freeze
-  autoload :App, File.join(LibDir, 'app.rb')
-  autoload :Server, File.join(LibDir, 'server.rb')
-  autoload :Canvas, File.join(LibDir, 'canvas.rb')
-  autoload :Converter, File.join(LibDir, 'converter.rb')
-  autoload :VERSION, File.join(LibDir, 'version.rb')
+  class << self
+    def convert(source:, x: 0, y: 0, scale: nil, mode: :rgbx)
+      _convert(as_image(source, scale), x, y, &as_cvt(mode))
+    end
+
+    def slices(lines, count: 4)
+      Array.new(count) { [] }.tap do |ret|
+        lines.each_with_index { |line, idx| ret[idx % count] << line }
+      end
+    end
+
+    def packages(lines, bytes:)
+      ret = [current = []]
+      size = 0
+      lines.each do |line|
+        next current << line if (size += line.bytesize) < bytes
+        ret << (current = [line])
+        size = line.bytesize
+      end
+      ret
+    end
+
+    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!
+    end
+
+    def as_image(source, scale)
+      Image.new(source).tap { |image| image.scale(scale) if scale }
+    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
+          ]
+        end
+      end
+    end
+  end
 end

data/lib/pixelflut/image.rb

@@ -0,0 +1,32 @@
+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/lib/pixelflut/sender.rb

@@ -0,0 +1,29 @@
+require 'socket'
+
+module Pixelflut
+  module Sender
+    def self.address(host, port)
+      Addrinfo.tcp(host, port)
+    end
+
+    def self.send(address, data)
+      socket = create_socket(address)
+      yield(socket) if block_given?
+      loop { socket.write(data) }
+    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
+    end
+  end
+end

data/lib/pixelflut/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pixelflut
-  VERSION = '0.0.10'.freeze
+  VERSION = '0.2.0'
 end

data/pixelflut.gemspec

@@ -1,37 +1,34 @@
 # frozen_string_literal: true
 
-require File.expand_path('../lib/pixelflut/version', __FILE__)
+require_relative 'lib/pixelflut/version'
 
-GemSpec = Gem::Specification.new do |spec|
+Gem::Specification.new do |spec|
   spec.name = 'pixelflut'
   spec.version = Pixelflut::VERSION
-  spec.summary = 'A Pixelflut server written in Ruby.'
-  spec.description = <<~EOS
-    Based on the idea of a simple server protocol to collaborate on a shared canvas named
-    [Pixel Flut](https://cccgoe.de/wiki/Pixelflut) this gem implements a Ruby version.
-  EOS
   spec.author = 'Mike Blumtritt'
-  spec.email = 'mike.blumtritt@invision.de'
+
+  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 = {'issue_tracker' => 'https://github.com/mblumtritt/pixelflut/issues'}
-  spec.rubyforge_project = spec.name
 
-  spec.add_runtime_dependency 'gosu', '>= 0.13.2'
-  spec.add_development_dependency 'bundler', '>= 1.16.0'
-  spec.add_development_dependency 'rake', '>= 12.3.0'
+  spec.metadata['source_code_uri'] = 'https://github.com/mblumtritt/pixelflut'
+  spec.metadata['bug_tracker_uri'] =
+    'https://github.com/mblumtritt/pixelflut/issues'
 
-  spec.platform = Gem::Platform::RUBY
-  spec.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.add_runtime_dependency 'rmagick'
+  spec.add_runtime_dependency 'mini-cli'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
 
-  spec.require_paths = %w[lib]
   spec.bindir = 'bin'
-  spec.executables = Dir.glob(File.expand_path('../bin/*', __FILE__)).map!{ |fn| File.basename(fn) }
-
-  all_files = %x(git ls-files -z).split(0.chr)
-  spec.test_files = all_files.grep(%r{^(spec|test)/})
-  spec.files = all_files - spec.test_files
+  spec.executables = %w[pxf pxf-info]
 
-  spec.has_rdoc = false
+  spec.files = Dir.chdir(__dir__) { `git ls-files -z`.split(0.chr) }
   spec.extra_rdoc_files = %w[README.md]
 end