catpix_mini 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbe7bb291ed03d1f3f945fe22fd96230016be3e1
+  data.tar.gz: 89b52d847d8e76dfa0c8aa69eabcfbb3fbfd7ace
+SHA512:
+  metadata.gz: 259af61caf5768dd2eeea81ca932e840233206275036d36b8fd8afafaf0af569664c2f0e1713e584dacab118881350c4ddc07a6fdf70148df57544e00b1e7c44
+  data.tar.gz: 0051a1e22e34b494382ef415947e4f74e2edc30eb3669ddc51fb6872619773c30c5e9151eab056a04a020535b69ab9a93d5a06fe56df818810e7541bb76ead5a

data/.gitignore

@@ -0,0 +1,52 @@
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lgtm_hd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Radek Pazdera
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Catpix_Minimagick_HD
+
+Renders images in the terminal.
+
+## Why not a fork but clone
+
+This project is a "port" from [pazdera's catpix repo](https://github.com/pazdera/catpix).
+The original project is based on RMagick while this one is based on MiniMagick. I was spending
+time finding solutions with MiniMagick but could not find any hence I decided to port from the
+original.
+
+![Pokemon](http://radek.io/assets/images/posts/catpix/pokemon.png)
+
+## More examples
+
+For more examples and APIs please check out [pazdera's catpix repo](https://github.com/pazdera/catpix). They should be very similar at this point except that the binary name is changed from `catpix` to `catpix_mini`.
+
+## Performances
+
+MiniMagick is supposed to be lighter and faster since it provides only a thin wrapper around
+the ImageMagick command-line toolset. I have done a bit of testing and find that catpix_mini
+has upper advantage when rendering large image while catpix is slightly faster for smaller image.
+
+
+    time catpix ./img/benchmark.jpg  
+    48.25s user 0.56s system 87% cpu 55.578 total
+
+    catpix_mini ./img/benchmark.jpg  
+    42.26s user 0.76s system 83% cpu 51.647 total
+
+
+Note: I have done not many benchmarks, and performance is not super important in my case. All
+I need is to be able to include catpix in my powered-by-minimagick project. So please do some
+more proper tests and let me know your results.
+
+
+## Quality
+
+RMagick return pixels colours in 16bits by default while MiniMagick is only 8 bits therefor the
+quality at high-res looks slightly better in catpix compared to catpix-mini.
+
+Only slightly because the quality printed out to terminal is not too insanely detailed to begin with.
+
+
+## About Me
+
+AJAX Amsterdamche and Chandler Bing's big fan.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/catpix_mini

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2015 Radek Pazdera <me@radek.io>
+# Distributed under the MIT License (see LICENSE.txt)
+
+require 'docopt'
+require 'catpix_mini'
+
+doc = <<DOCOPT
+Print images in the terminal.
+
+Usage:
+  #{File.basename __FILE__} --help | --version
+  #{File.basename __FILE__} [options] <path>
+
+Options:
+  -w=<width>, --limit-width     Limit width of the image (factor of the size
+                                of the terminal window) [default: 1].
+  -h=<height>, --limit-height   Limit height of the image (factor of the size
+                                of the terminal window) [default: 0],
+  -c=<pos>, --center            Set x, y or xy centering in the window.
+  -b=<colour>, --bg             Set background colour.
+  -f, --bg-fill                 Draw background around the image as well.
+  -r=<res>, --resolution        Either 'high' or 'low' [default: auto].
+
+  --help                        Show this message.
+  --version                     Print the version.
+DOCOPT
+
+begin
+  args = Docopt::docopt doc, :version => CatpixMini::VERSION
+rescue Docopt::Exit => e
+  $stderr.puts e.message
+  exit 1
+end
+
+options = {
+  :limit_x => args['--limit-width'].to_f,
+  :limit_y => args['--limit-height'].to_f,
+  :bg_fill => args['--bg-fill'],
+  :resolution => args['--resolution']
+}
+
+if args['--center']
+  options[:center_x] = true if args['--center'].include? 'x'
+  options[:center_y] = true if args['--center'].include? 'y'
+
+  if not args['--center'].include? 'x' or not args['--center'].include? 'x'
+    $stderr.puts "Error: Invalid --center argument. Use x, y or xy."
+    $stderr.puts doc
+  end
+end
+
+options[:bg] = args['--bg'] if args['--bg']
+
+CatpixMini::print_image args['<path>'], options
+exit 0

data/catpix_mini.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'catpix_mini/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "catpix_mini"
+  spec.version       = CatpixMini::VERSION
+  spec.authors       = ["Radek Pazdera", "Huy Dinh"]
+  spec.email         = ["me@radek.io", "phradion@gmail.com"]
+  spec.summary       = %q{Cat images into the terminal. A port to work with MiniMagick}
+  spec.description   = %q{Print images (png, jpg, gif and many others) in the
+                          command line with ease. Using rmagick and tco in the
+                          background to read the images and convert them into
+                          the extended 256 colour palette for terminals.
+                          This gem is ported from original catpix gem to be
+                          compatible with MiniMagick instead of RMagick. It will
+                          also be faster when rendering large images.}
+  spec.homepage      = "https://github.com/phradion/catpix_mini_HD"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 1.9"
+
+  spec.add_runtime_dependency "tco", "~> 0.1", ">= 0.1.8"
+  spec.add_runtime_dependency "mini_magick", "~> 4.7.0", ">= 4.7.0"
+  spec.add_dependency "docopt", "~> 0.5", ">= 0.5.0"
+  spec.add_dependency "ruby-terminfo", "~> 0.1", ">= 0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.4"
+end

data/lib/catpix_mini.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2015 Radek Pazdera <me@radek.io>
+# Distributed under the MIT License (see LICENSE.txt)
+# Ported to use mini_magick (c) 2017 Huy Dinh <phradion@gmail.com>
+
+require "catpix_mini/version"
+require "catpix_mini/private"
+
+# Provides a function to print images in the terminal. A range of different
+# formats is supported (check out what ImageMagick supports). Under the hood,
+# this module uses two components:
+#
+# * [rmagick](https://rmagick.github.io/) to read and scale the images and
+# * [tco](https://github.com/pazdera/tco) to map their pixels on the extended
+#   colour palette in the terminal.
+#
+# Some other minor features like centering and handling background colours
+# are supplied directly by this module.
+module CatpixMini
+  # Print an image to the terminal.
+  #
+  # All formats supported by ImageMagick are supported. The image's colours
+  # will be mapped onto the extended 256 colour palette. Also by default, it
+  # will be scaled down to fit the width of the terminal while keeping its
+  # proportions. This can be changed using the `options` parameter.
+  #
+  # @param [Hash] options Adjust some parameters of the image when printed.
+  # @option options [Float] :limit_x A factor of the terminal window's width.
+  #                                  If present, the image will be scaled down
+  #                                  to fit (proportions are kept). Using 0
+  #                                  will disable the scaling. [default: 1.0]
+  # @option options [Float] :limit_y A factor of the terminal window's height.
+  #                                  If present, the image will be scaled down
+  #                                  to fit (proportions are kept). Using 0
+  #                                  will disable the scaling. [default: 0]
+  # @option options [Boolean] :center_x Center the image horizontally in the
+  #                                     terminal window. [default: false]
+  # @option options [Boolean] :center_y Center the image vertically in the
+  #                                     terminal window. [default: false]
+  # @option options [String] :bg Background colour to use in case there are
+  #                              any fully transparent pixels in the image.
+  #                              This can be a RGB value '#c0ffee' or a tco
+  #                              alias 'red' or 'blue'. [default: nil]
+  # @option options [Boolean] :bg_fill Fill the margins around the image with
+  #                                    background colour. [default: false]
+  # @option options [String] :resolution Determines the pixel size of the
+  #                                      rendered image. Can be set to `high`,
+  #                                      `low` or `auto` (default). If set to
+  #                                      `auto` the resolution will be picked
+  #                                      automatically based on your terminal's
+  #                                      support of unicode.
+  def self.print_image(path, options={})
+
+    options = default_options.merge! options
+
+    if options[:resolution] == 'auto'
+      options[:resolution] = can_use_utf8? ? 'high' : 'low'
+    end
+    @@resolution = options[:resolution]
+
+    img = load_image path
+    resize! img, options[:limit_x], options[:limit_y]
+
+    margins = get_margins img, options[:center_x], options[:center_y]
+    margins[:colour] = options[:bg_fill] ? options[:bg] : nil
+
+    if high_res?
+      do_print_image_hr img, margins, options
+    else
+      do_print_image_lr img, margins, options
+    end
+  end
+end

data/lib/catpix_mini/private.rb

@@ -0,0 +1,212 @@
+# Copyright (c) 2015 Radek Pazdera <me@radek.io>
+# Distributed under the MIT License (see LICENSE.txt)
+# Ported to use mini_magick (c) 2017 Huy Dinh <phradion@gmail.com>
+
+require "mini_magick"
+require "tco"
+require "terminfo"
+
+module CatpixMini
+  private
+  MAX_OPACITY = 65535
+
+  def self.default_options
+    {
+      limit_x: 1.0,
+      limit_y: 0,
+      center_x: false,
+      center_y: false,
+      bg: nil,
+      bg_fill: false,
+      resolution: 'auto'
+    }
+  end
+
+  @@resolution = nil
+
+  def self.high_res?
+    @@resolution == 'high'
+  end
+
+  def self.can_use_utf8?
+    ENV.values_at("LC_ALL", "LC_CTYPE", "LANG").compact.first.include?("UTF-8")
+  end
+
+  def self.prep_lr_pixel(colour)
+    colour ? "  ".bg(colour) : "  "
+  end
+
+  def self.print_lr_pixel(colour)
+    print prep_lr_pixel colour
+  end
+
+  def self.prep_hr_pixel(colour_top, colour_bottom)
+    upper = "\u2580"
+    lower = "\u2584"
+
+    return " " if colour_bottom.nil? and colour_top.nil?
+    return lower.fg colour_bottom if colour_top.nil?
+    return upper.fg colour_top if colour_bottom.nil?
+
+    c_top = Tco::match_colour colour_top
+    c_bottom = Tco::match_colour colour_bottom
+    if c_top == c_bottom
+      return " ".bg "@#{c_top}"
+    end
+
+    upper.fg("@#{c_top}").bg("@#{c_bottom}")
+  end
+
+  def self.print_hr_pixel(colour_top, colour_bottom)
+    print prep_hr_pixel colour_top, colour_bottom
+  end
+
+  # Returns normalised size of the terminal window
+  #
+  # Catpix can use either two blank spaces to approximate a pixel in the
+  # temrinal or the 'upper half block' and 'bottom half block' characters.
+  #
+  # Depending on which of the above will be used, the screen size
+  # must be normalised accordingly.
+  def self.get_screen_size
+    th, tw = TermInfo.screen_size
+    if high_res? then [tw, th * 2] else [tw / 2, th] end
+  end
+
+  def self.load_image(path)
+    MiniMagick::Image.open(path)
+  end
+
+  # Scale the image down based on the limits while keeping the aspect ratio
+  def self.resize!(img, limit_x=0, limit_y=0)
+    tw, th = get_screen_size
+    iw = img[:width]
+    ih = img[:height]
+
+    width = limit_x > 0 ? (tw * limit_x).to_i : iw
+    height = limit_y > 0 ? (th * limit_y).to_i : ih
+
+    # Resize the image if it's bigger than the limited viewport
+    if iw > width or ih > height
+      img.resize "#{width}x#{height}"
+    end
+  end
+
+  # Determine the margins based on the centering options
+  def self.get_margins(img, center_x, center_y)
+    margins = {}
+    tw, th = get_screen_size
+
+    x_space = tw - img[:width]
+    if center_x
+      margins[:left] = x_space / 2
+      margins[:right] = x_space / 2 + x_space % 2
+    else
+      margins[:left] = 0
+      margins[:right] = x_space
+    end
+
+    y_space = th - img[:height]
+    if center_y
+      margins[:top] = y_space / 2
+      margins[:bottom] = y_space / 2 + y_space % 2
+    else
+      margins[:top] = 0
+      margins[:bottom] = 0
+    end
+
+    if high_res? and margins[:top] % 2 and margins[:bottom] % 2
+      margins[:top] -= 1
+      margins[:bottom] += 1
+    end
+
+    margins
+  end
+
+  #############################################################################
+  # "DRAWING" METHODS
+  #############################################################################
+
+  def self.prep_vert_margin(size, colour)
+    tw = get_screen_size
+
+    buffer = ""
+    if high_res?
+      (size / 2).times do
+        sub_buffer = ""
+        tw.times { sub_buffer += prep_hr_pixel nil, nil }
+        buffer += sub_buffer.bg(colour) + "\n"
+      end
+    else
+      size.times do
+        sub_buffer = ""
+        tw.times { sub_buffer += prep_lr_pixel nil }
+        buffer += sub_buffer.bg(colour) + "\n"
+      end
+    end
+    buffer
+  end
+
+  def self.prep_horiz_margin(size, colour)
+    buffer = ""
+    if high_res?
+      size.times { buffer += prep_hr_pixel nil, nil }
+    else
+      size.times { buffer += prep_lr_pixel nil }
+    end
+    buffer.bg colour
+  end
+
+  ##
+  # Print the image in low resolution
+  def self.do_print_image_lr(img, margins, options)
+    pixels = img.get_pixels
+    rows = img[:height]
+    cols = pixels[0].length
+
+    print prep_vert_margin margins[:top], margins[:colour]
+
+    0.upto(rows - 1) do |row|
+      buffer = prep_horiz_margin margins[:left], margins[:colour]
+      0.upto(cols - 1) do |col|
+        pixel = pixels[row][col]
+        buffer += prep_lr_pixel pixel
+      end
+      buffer += prep_horiz_margin margins[:right], margins[:colour]
+      puts buffer
+    end
+
+    print prep_vert_margin margins[:bottom], margins[:colour]
+
+  end
+
+  ##
+  # Print the image in high resolution (using unicode's upper half block)
+  def self.do_print_image_hr(img, margins, options)
+    pixels = img.get_pixels
+    rows = img[:height]
+    cols = pixels[0].length
+
+
+    print prep_vert_margin margins[:top], margins[:colour]
+
+    0.step(rows - 1, 2) do |row|
+      # line buffering makes it about 20% faster
+      buffer = prep_horiz_margin margins[:left], margins[:colour]
+      0.upto(cols - 1) do |col|
+        top_pixel = pixels[row][col]
+        colour_top = top_pixel
+
+        bottom_pixel = pixels[row+1][col]
+        colour_bottom = bottom_pixel
+
+        buffer += prep_hr_pixel colour_top, colour_bottom
+      end
+      buffer += prep_horiz_margin margins[:right], margins[:colour]
+      puts buffer
+    end
+
+    print prep_vert_margin margins[:bottom], margins[:colour]
+
+  end
+end

data/lib/catpix_mini/version.rb

@@ -0,0 +1,7 @@
+# Copyright (c) 2015 Radek Pazdera <me@radek.io>
+# Distributed under the MIT License (see LICENSE.txt)
+
+module CatpixMini
+  # Version of the gem
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: catpix_mini
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Radek Pazdera
+- Huy Dinh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tco
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: |-
+  Print images (png, jpg, gif and many others) in the
+                            command line with ease. Using rmagick and tco in the
+                            background to read the images and convert them into
+                            the extended 256 colour palette for terminals.
+                            This gem is ported from original catpix gem to be
+                            compatible with MiniMagick instead of RMagick. It will
+                            also be faster when rendering large images.
+email:
+- me@radek.io
+- phradion@gmail.com
+executables:
+- catpix_mini
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/catpix_mini
+- catpix_mini.gemspec
+- lib/catpix_mini.rb
+- lib/catpix_mini/private.rb
+- lib/catpix_mini/version.rb
+homepage: https://github.com/phradion/catpix_mini_HD
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Cat images into the terminal. A port to work with MiniMagick
+test_files: []