pixelart 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc4a5d1c756256a1162bdab5208ff01549b7e2543ccb301457845dd1f393b48
-  data.tar.gz: 1f07a5a8203fc4b4fc93446bc52d6abf8ca1b94368c48952649c423ef0100b15
+  metadata.gz: 627a2802ea7e3ad7a10490ea4f721d57a4007669fe59a0b6cc17fb798c60b7a7
+  data.tar.gz: 8edd801f96debe5b664f31180510ea103469f1f62e5f4ee88959046718350b7f
 SHA512:
-  metadata.gz: 6031f337310c6935841ae3a9c2528f4aa6179c8a5b6b9a4b4aa21d0f98b9a9dd5a0578792cce660be1f15c11d95e35785efa80547e1950d28cf8e3ff21a05243
-  data.tar.gz: 4615099b098378c2eee14cb854c2ee67237a278172b3c789be1de72a59c9ba6779e8dc2a4e9a4384c93b2771d5c8f31a8cf1f51cff308d6bf0e27468a50d0cb3
+  metadata.gz: 8bdff35694d0212e5c48799be188b1cfeef29bd24e48f46fab6e387f5dcdcde3063105db5fd1cab21f8b03ce12c1420fb5abed0f59ae42801b57164ff6682e08
+  data.tar.gz: de54f3cc88c6dd7e198abdba49eb7549c1ae18c018a24695ccc676dee94360b9fed68f0e415ce92060993fd1323f4c5cfd40831b5411bf7db0fb008d67951f60

data/Manifest.txt

@@ -3,7 +3,10 @@ Manifest.txt
 README.md
 Rakefile
 lib/pixelart.rb
+lib/pixelart/base.rb
 lib/pixelart/color.rb
 lib/pixelart/gradient.rb
 lib/pixelart/image.rb
+lib/pixelart/misc.rb
+lib/pixelart/palette.rb
 lib/pixelart/version.rb

data/README.md

@@ -58,7 +58,7 @@ Note: The color 0 (transparent) is auto-magically added / defined.
 And let's mint a mooncat image:
 
 ``` ruby
-img = Pixelart::Image.parse( pixels, colors: colors )
+img = Image.parse( pixels, colors: colors )
 img.save( './i/mooncat_white.png' )
 ```
 
@@ -91,7 +91,7 @@ colors = [
 And let's start minting:
 
 ``` ruby
-img = Pixelart::Image.parse( pixels, colors: colors )
+img = Image.parse( pixels, colors: colors )
 img.save( './i/mooncat_black.png' )
 
 img3x = img.zoom( 3 )
@@ -214,7 +214,7 @@ colors = {
 And let's mint an imperial master image:
 
 ``` ruby
-img = Pixelart::Image.parse( pixels, colors: colors )
+img = Image.parse( pixels, colors: colors )
 img.save( './i/vader.png' )
 ```
 
@@ -233,6 +233,50 @@ Voila!
 
 
 
+## Modular "Base" Version
+
+
+Note: By default if you require pixelart
+all classes inside the `Pixelart` module such as `Image`, `Color`, `Gradient`, `Palette8bit`, etc. get "top-leveled", that is,
+included in the top level e.g.:
+
+``` ruby
+require 'pixelart/base'
+include Pixelart
+```
+
+And now you can use all classes without
+the `Pixelart::` module scope e.g.:
+
+``` ruby
+gradient = Gradient.new( '000000', 'ffffff' )
+
+pp colors = gradient.colors( 256 )
+puts '---'
+pp colors.map { |color| Color.to_hex( color ) }
+```
+
+vs
+
+``` ruby
+gradient = Pixelart::Gradient.new( '000000', 'ffffff' )
+
+pp colors = gradient.colors( 256 )
+puts '---'
+pp colors.map { |color| Pixelart::Color.to_hex( color ) }
+```
+
+
+For a "stricter" modular version require the "base" version
+that always requires the `Pixelart::` module scope e.g.:
+
+``` ruby
+require 'pixelart/base'
+```
+
+
+
+
 ## Install
 
 Just install the gem:

data/lib/pixelart.rb

@@ -1,26 +1,10 @@
-## 3rd party
-require 'chunky_png'
 
-## stdlib
-require 'pp'
-require 'time'
-require 'date'
-require 'fileutils'
+## our own code (without "top-level" shortcuts e.g. "modular version")
+require 'pixelart/base'   # aka "strict(er)" version
 
 
-## our own code
-require 'pixelart/version'    # note: let version always go first
-require 'pixelart/color'
-require 'pixelart/gradient'
-require 'pixelart/image'
+###
+#  add convenience top-level shortcuts / aliases
+#    make Image, Color, Palette8bit, etc top-level
+include Pixelart
 
-
-
-
-
-### add some convenience shortcuts
-PixelArt = Pixelart
-
-
-
-puts Pixelart.banner    # say hello

data/lib/pixelart/base.rb

@@ -0,0 +1,35 @@
+## 3rd party
+require 'chunky_png'
+
+## stdlib
+require 'pp'
+require 'time'
+require 'date'
+require 'fileutils'
+
+
+## our own code
+require 'pixelart/version'    # note: let version always go first
+require 'pixelart/color'
+require 'pixelart/gradient'
+require 'pixelart/palette'
+require 'pixelart/image'
+
+require 'pixelart/misc'   ## misc helpers
+
+
+##########
+#  add some spelling convenience variants
+PixelArt = Pixelart
+
+module Pixelart
+  Palette256 = Palette8Bit = Palette8bit
+
+  class Image
+    Palette256 = Palette8Bit = Palette8bit
+  end
+end
+
+
+
+puts Pixelart.banner    # say hello

data/lib/pixelart/color.rb

@@ -7,6 +7,7 @@ class Color
   WHITE       = 0xffffffff   # rgba(255,255,255,255)
 
 
+
   def self.parse( color )
     if color.is_a?( Integer )  ## e.g. assumes ChunkyPNG::Color.rgb() or such
       color ## pass through as is 1:1
@@ -56,6 +57,75 @@ class Color
   def self.b( color ) ChunkyPNG::Color.b( color ); end
 
   def self.rgb( r, g, b ) ChunkyPNG::Color.rgb( r, g, b); end
+
+
+
+  ## known built-in color names
+  def self.build_names
+    names = {
+      '#00000000' => 'TRANSPARENT',
+      '#000000ff' => 'BLACK',
+      '#ffffffff' => 'WHITE',
+    }
+
+    ## auto-add grayscale 1 to 254
+    (1..254).each do |n|
+      hex = "#" + ('%02x' % n)*3
+      hex << "ff"  ## add alpha channel (255)
+      names[ hex ] = "8-BIT GRAYSCALE ##{n}"
+    end
+
+    names
+  end
+
+  NAMES = build_names
+
+
+
+  def self.format( color )
+    rgb = [r(color),
+           g(color),
+           b(color)]
+
+    # rgb in hex (string format)
+    #   note: do NOT include alpha channel for now - why? why not?
+    hex = "#" + rgb.map{|num| '%02x' % num }.join
+
+    hsl = to_hsl( color )
+    ## get alpha channel (transparency) for hsla
+    alpha = hsl[3]
+
+
+    buf = ''
+    buf << hex
+    buf << " / "
+    buf << "rgb("
+    buf << "%3d " % rgb[0]
+    buf << "%3d " % rgb[1]
+    buf << "%3d)"  % rgb[2]
+    buf << " - "
+    buf << "hsl("
+    buf << "%3d° " % (hsl[0] % 360)
+    buf << "%3d%% " % (hsl[1]*100+0.5).to_i
+    buf << "%3d%%)" % (hsl[2]*100+0.5).to_i
+
+    if alpha != 255
+      buf << " - α(%3d%%)" % (alpha*100/255+0.5).to_i
+    else
+      buf << "          "  ## add empty for 255 (full opacity)
+    end
+
+    ## note: add alpha channel to hex
+    alpha_hex = '%02x' % alpha
+    name = NAMES[ hex+alpha_hex ]
+    buf << " - #{name}"  if name
+
+    buf
+  end
+  class << self
+    alias_method :fmt, :format
+  end
+
 end  # class Color
 end  # module Pixelart
 

data/lib/pixelart/gradient.rb

@@ -1,8 +1,9 @@
 
-## inspired by
+## inspired / helped by
 ##  https://en.wikipedia.org/wiki/List_of_software_palettes#Color_gradient_palettes
 ##  https://github.com/mistic100/tinygradient
 ##   https://mistic100.github.io/tinygradient/
+##   https://bsouthga.dev/posts/color-gradients-with-python
 
 
 module Pixelart
@@ -21,23 +22,36 @@ class Gradient
 
 
   def colors( steps )
-    ## note: for now only support two colors
-    ##   note: gradient will include start (first)
-    ##     AND stop color (last) - stop color is NOT excluded for now!!
-    start = @stops[0]
-    stop  = @stops[1]
-
-    step = stepize( start, stop, steps-1 )
-    ## pp step
-
-    gradient = [start]
-
-    1.upto(steps-2).each do |i|
-       color = interpolate( step, start, i )
-       gradient << color
+    segments = @stops.size - 1
+
+    ## note: gradient will include start (first)
+    ##   AND stop color (last) - stop color is NOT excluded for now!!
+    if segments == 1
+       start = @stops[0]
+       stop  = @stops[1]
+
+       gradient = linear_gradient( start, stop, steps,
+                                   include_stop: true )
+    else
+      steps_per_segment, mod = steps.divmod( segments )
+      raise ArgumentError, "steps (#{steps}) must be divisible by # of segments (#{segments}); expected mod of 0 but got #{mod}"   if mod != 0
+
+      gradient = []
+      segments.times do |segment|
+        start = @stops[segment]
+        stop  = @stops[segment+1]
+        include_stop =  (segment == segments-1)  ## note: only include stop if last segment!!
+
+        # print "  segment #{segment+1}/#{segments} #{steps_per_segment} color(s) - "
+        # print "  start: #{start.inspect}  "
+        # print  include_stop ? 'include' : 'exclude'
+        # print " stop:  #{stop.inspect}"
+        # print "\n"
+
+        gradient += linear_gradient( start, stop, steps_per_segment,
+                                     include_stop: include_stop )
+      end
     end
-    ## note: use original passed in stop color (should match calculated)
-    gradient << stop
 
     ## convert to color (Integer)
     gradient.map do |color|
@@ -45,52 +59,48 @@ class Gradient
     end
  end
 
-##
-# Linearly compute the step size between start and end
-##  (not normalized)
-# @param {StepValue} start
-# @param {StepValue} end
-# @param {number} steps - number of desired steps
-#@return {StepValue}
 
-def stepize(start, stop, steps)
-  step = []
 
-  [0,1,2].each do |k|
-    step <<  Float(stop[k] - start[k]) / Float(steps)
-  end
-
-  step
-end
+ def interpolate( start, stop, steps, n )
+   ## note: n - expected to start with 1,2,3,etc.
+   color = []
+   3.times do |i|
+     stepize = Float(stop[i] - start[i]) / Float(steps-1)
+     value = stepize * n
+     ## convert back to Integer from Float
+     ##   add 0.5 for rounding up (starting with 0.5) - why? why not?
+     value = (value+0.5).to_i
+     value = start[i] + value
 
-##
-# Compute the final step color
-#  @param {StepValue} step - from `stepize`
-#  @param {StepValue} start
-#  @param {number} i - color index
-#  @return {StepValue}
+     color << value
+   end
+   color
+ end
 
-RGB_MAX = [256, 256, 256]
-def interpolate( step, start, i )
-  color = []
 
-  [0,1,2].each do |k|
-     color[k] = step[k]*i + start[k]
+ def linear_gradient( start, stop, steps,
+                      include_stop: true )
 
-     color[k] = if color[k] < 0.0
-                   color[k] + RGB_MAX[k]
-                else
-                   color[k] % RGB_MAX[k]
-                end
+  gradient = [start]  ## auto-add start color (first color in gradient)
 
-     ## convert back to Integer from Float
-     ##   add 0.5 for rounding up (starting with 0.5) - why? why not?
-     color[k] = (color[k]+0.5).to_i
+  if include_stop
+    1.upto( steps-2 ).each do |n|  ## sub two (-2), that is, start and stop color
+      gradient << interpolate( start, stop, steps, n )
+    end
+    # note: use original passed in stop color (should match calculated)
+    gradient << stop
+  else
+    1.upto( steps-1 ).each do |n|  ## sub one (-1), that is, start color only
+      ## note: add one (+1) to steps because stop color gets excluded (not included)!!
+      gradient << interpolate( start, stop, steps+1, n )
+    end
   end
-  color
+
+  gradient
 end
 
 
+
 end  # class Gradient
 end  # module Pixelart
 

data/lib/pixelart/image.rb

@@ -65,19 +65,71 @@ alias_method :scale, :zoom
 
 
 
+#######################
+## filter / effects
 
-def parse_color_map( color_map )
-  color_map.map do |k,v|
-    [Color.parse(k),  Color.parse(v)]
-  end.to_h
+def grayscale
+  img = @img.grayscale
+  Image.new( img.width, img.height, img )
 end
 
 ## add replace_colors alias too? - why? why not?
 def change_colors( color_map )
+  color_map = _parse_color_map( color_map )
+
   img = @img.dup  ## note: make a deep copy!!!
-  color_map = parse_color_map( color_map )
-  ## pp color_map
+  _change_colors!( img, color_map )
+
+  ## wrap into Pixelart::Image - lets you use zoom() and such
+  Image.new( img.width, img.height, img )
+end
+alias_method :recolor, :change_colors
+
+
+
+## predefined palette8bit color maps
+##     (grayscale to sepia/blue/false/etc.)
+##  - todo/check - keep "shortcut" convenience predefined map - why? why not?
+PALETTE8BIT = {
+  sepia: Palette8bit::GRAYSCALE.zip( Palette8bit::SEPIA ).to_h,
+  blue:  Palette8bit::GRAYSCALE.zip( Palette8bit::BLUE ).to_h,
+  false: Palette8bit::GRAYSCALE.zip( Palette8bit::FALSE ).to_h,
+}
+
+def change_palette8bit( palette )
+  ## step 0: mapping from grayscale to new 8bit palette (256 colors)
+  color_map = if palette.is_a( String ) || palette.is_a( Symbol )
+                 PALETTE8BIT[ palette.to_sym ]
+                 ## todo/fix: check for missing/undefined palette not found - why? why not?
+              else
+                 ##  make sure we have colors all in Integer not names, hex, etc.
+                 palette = _parse_colors( palette )
+                 Palette8bit::GRAYSCALE.zip( palette ).to_h
+              end
+
+  ## step 1: convert to grayscale (256 colors)
+  img = @img.grayscale
+  _change_colors!( img, color_map )
+
+  ## wrap into Pixelart::Image - lets you use zoom() and such
+  Image.new( img.width, img.height, img )
+end
+alias_method :change_palette256, :change_palette8bit
+
+
+####
+##  private helpers
+def _parse_colors( colors )
+  colors.map {|color| Color.parse( color ) }
+end
+
+def _parse_color_map( color_map )
+  color_map.map do |k,v|
+    [Color.parse(k),  Color.parse(v)]
+  end.to_h
+end
 
+def _change_colors!( img, color_map )
   img.width.times do |x|
     img.height.times do |y|
       color = img[x,y]
@@ -85,12 +137,7 @@ def change_colors( color_map )
       img[x,y] = new_color  if new_color
     end
   end
-
-  ## wrap into Pixelart::Image - lets you use zoom() and such
-  Image.new( img.width, img.height, img )
 end
-alias_method :recolor, :change_colors
-
 
 
 
@@ -124,6 +171,7 @@ def []=( x, y, value )  @img[x,y]=value; end
 def pixels()       @img.pixels; end
 
 ## return image ref - use a different name - why? why not?
+##   change to to_image  - why? why not?
 def image()        @img; end
 
 

data/lib/pixelart/misc.rb

@@ -0,0 +1,40 @@
+module Pixelart
+
+
+class Image
+class Palette8bit < Image  # or use Palette256 alias?
+  def initialize( colors, size: 1, spacing: nil )
+    ## todo/check: change size arg to pixel or such? better name/less confusing - why? why not?
+
+    ## todo/check: assert colors MUST have 256 colors!!!!
+
+    ## use a "smart" default if no spacing set
+    ##   0 for for (pixel) size == 1
+    ##   1 for the rest
+    spacing = size == 1 ? 0 : 1  if spacing.nil?
+
+    img = ChunkyPNG::Image.new( 32*size+(32-1)*spacing,
+                                 8*size+(8-1)*spacing )
+
+    colors.each_with_index do |color,i|
+      y,x = i.divmod( 32 )
+      if size > 1
+        size.times do |n|
+          size.times do |m|
+            img[ x*size+n+spacing*x,
+                 y*size+m+spacing*y] = color
+          end
+        end
+      else
+        img[x,y] = color
+      end
+    end
+
+    super( img.width, img.height, img )
+  end
+end # class Palette8bit
+
+end # class Image
+end # module Pixelart
+
+

data/lib/pixelart/palette.rb

@@ -0,0 +1,72 @@
+module Pixelart
+
+
+class Palette8bit     # or use Palette256 alias?
+
+
+  ## auto-add grayscale 0 to 255
+  ##  e.g. rgb(0,0,0)
+  ##       rgb(1,1,1)
+  ##       rgb(2,2,2)
+  ##       ...
+  ##       rgb(255,255,255)
+  GRAYSCALE = (0..255).map { |n| Color.rgb( n, n, n ) }
+
+
+   ## 8x32 gradient color stops
+   ##   see https://en.wikipedia.org/wiki/List_of_software_palettes#Color_gradient_palettes
+
+  SEPIA_STOPS = [
+    ['080400', '262117'],
+    ['272218', '453E2F'],
+    ['463F30', '645C48'],
+    ['655D48', '837A60'],
+
+    ['847A60', 'A29778'],
+    ['A39878', 'C1B590'],
+    ['C2B691', 'E0D2A8'],
+    ['E1D3A9', 'FEEFBF'],
+  ]
+
+  BLUE_STOPS = [
+    ['000000', '001F3E'],
+    ['002040', '003F7E'],
+    ['004080', '005FBD'],
+    ['0060BF', '007FFD'],
+
+    ['0080FF', '009FFF'],
+    ['00A0FF', '00BFFF'],
+    ['00C0FF', '00DFFF'],
+    ['00E0FF', '00FEFF'],
+  ]
+
+  FALSE_STOPS = [
+    ['FF00FF', '6400FF'],
+    ['5F00FF', '003CFF'],
+    ['0041FF', '00DCFF'],
+    ['00E1FF', '00FF82'],
+
+    ['00FF7D', '1EFF00'],
+    ['23FF00', 'BEFF00'],
+    ['C3FF00', 'FFA000'],
+    ['FF9B00', 'FF0000'],
+  ]
+
+
+  def self.build_palette( gradients )
+    colors_per_gradient, mod = 256.divmod( gradients.size )
+    raise ArgumentError, "8bit palette - 256 must be divisible by # of gradients (#{gradients.size}; expected mod of 0 but got #{mod}"   if mod != 0
+
+    colors = []
+    gradients.each do |stops|
+      colors += Gradient.new( *stops ).colors( colors_per_gradient )
+    end
+    colors
+  end
+
+  SEPIA     = build_palette( SEPIA_STOPS )
+  BLUE      = build_palette( BLUE_STOPS )
+  FALSE     = build_palette( FALSE_STOPS )
+end  # class Palette8bit
+end # module Pixelart
+

data/lib/pixelart/version.rb

@@ -3,7 +3,7 @@ module Pixelart
 
   MAJOR = 0
   MINOR = 1
-  PATCH = 3
+  PATCH = 4
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixelart
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -73,9 +73,12 @@ files:
 - README.md
 - Rakefile
 - lib/pixelart.rb
+- lib/pixelart/base.rb
 - lib/pixelart/color.rb
 - lib/pixelart/gradient.rb
 - lib/pixelart/image.rb
+- lib/pixelart/misc.rb
+- lib/pixelart/palette.rb
 - lib/pixelart/version.rb
 homepage: https://github.com/cryptocopycats/mooncats
 licenses: