raw_image 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec', :cli => "--color" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shane Brinkman-Davis
+
+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,41 @@
+# RawImage
+
+Store uncompressed bitmap images efficiently in Ruby. Provides some basic image manipulations. Is intended to be the basis for other gems that want to work with raw, uncompressed images.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'raw_image'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install raw_image
+
+## Usage
+
+```
+require "raw_image"
+include RawImage
+
+# create 10 wide and 5 pixel high black rgba image
+image(:size => point(10,5))
+
+# create 10 wide and 5 pixel high white rgba image
+image(:size => point(10,5), :color => white)
+
+# create 10 wide and 5 pixel high white rgb image
+image(:size => point(10,5), :color => white, :format => :rgb8)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/raw_image.rb

@@ -0,0 +1,17 @@
+require "gui_geometry"
+
+%w{
+  colors
+  color
+  color_formats
+  image
+  version
+}.each do |file|
+  require File.join(File.dirname(__FILE__),"raw_image",file)
+end
+
+module RawImage
+  include GuiGeo
+  def color(*args) Color.new *args; end
+  def image(*args) Image.new *args; end
+end

data/lib/raw_image/color.rb

@@ -0,0 +1,50 @@
+# encoding: BINARY
+
+module RawImage
+class Color
+  include Colors
+
+  attr_accessor :r, :g, :b, :a
+
+  # 0 <= values <= 1
+  def initialize(r=0, g=r, b=r, a=1.0)
+    @r = r; @g = g; @b = b; @a = a
+  end
+
+  # 0 <= val <= 1
+  def gray=(val)
+    @r = @g = @b = g
+  end
+  alias :grey= :gray=
+
+  def byte(int)
+    "%c"%int
+  end
+
+  def inspect
+    "color(#{[r,g,b,a].join(', ')})"
+  end
+
+  def to_s
+    "#%02x%02x%02x%02x"%[r8,g8,b8,a8]
+  end
+
+  def r8; r * 255; end
+  def g8; g * 255; end
+  def b8; b * 255; end
+  def a8; a * 255; end
+  def gray8; g * 255; end
+  alias :grey8 :gray8
+
+  def gray; (r+g+b)/3; end
+  alias :grey :gray
+
+  def to_bytes(format)
+    case format
+    when :g8    then [byte(g8)].join
+    when :rgb8  then [byte(r8), byte(g8), byte(b8)].join
+    when :rgba8 then [byte(r8), byte(g8), byte(b8), byte(a8)].join
+    end
+  end
+end
+end

data/lib/raw_image/color_formats.rb

@@ -0,0 +1,10 @@
+module RawImage
+# legal image formats and info about each format
+def self.color_formats
+  {
+  :g8 => {:byte_size => 1, :bit_size => 8},     # single, monochrome channel
+  :rgb8 => {:byte_size => 3, :bit_size => 24},  # red, green, blue, 8bits per channel
+  :rgba8 => {:byte_size => 4, :bit_size => 32}, # red, green, blue, alpha 8bits per channel
+  }
+end
+end

data/lib/raw_image/colors.rb

@@ -0,0 +1,10 @@
+module RawImage
+module Colors
+  def black; Color.new(0.0); end
+  def white; Color.new(1.0); end
+  def gray; Color.new(0.5); end
+  alias :grey :gray
+
+  def transparent; Color.new(0, 0, 0, 0); end
+end
+end

data/lib/raw_image/image.rb

@@ -0,0 +1,129 @@
+# encoding: BINARY
+
+module RawImage
+class Image
+  include GuiGeo
+  include RawImage
+  include Colors
+
+  # raw image data as a binary string
+  attr_reader :data
+
+  # width & height of the image
+  attr_reader :size
+
+  # pixel format of iamge
+  attr_reader :format
+
+  # length of each line in bytes
+  attr_reader :line_byte_size
+
+  # :format => symbol
+  # :size => point
+  # :data => string
+  # :line_byte_size => integer or nil
+  # :color => Color (clear-to-color if data is nil)
+  def initialize(options={})
+    @format = options[:format] || :rgba8
+    raise ArgumentError.new("unsupported format: #{format.inspect}") unless RawImage.color_formats[format]
+
+    @size = options[:size]
+    raise ArgumentError.new("size#{size} must be at least (1,1)") unless size > point
+
+    @line_byte_size = options[:line_byte_size] || minimum_line_byte_size
+    raise ArgumentError.new("line_byte_size must be at least #{minimum_line_byte_size} for the given format #{format.inspect} and size #{size}") unless line_byte_size >= minimum_line_byte_size
+
+    @data = options[:data] || new_data(options[:color])
+    raise ArgumentError.new("expecting data to be #{byte_size} bytes (was #{data.length})") unless data.length == byte_size
+  end
+
+  # total byte-size of the string (should always == data.length)
+  def byte_size; size.y * line_byte_size; end
+
+  # number of pixels in image
+  def pixel_size; size.x * size.y; end
+
+  # bytes per pixel
+  def pixel_byte_size; RawImage.color_formats[format][:byte_size]; end
+
+  # the rectangle defining the area of the image
+  def area; rect size; end
+
+  # get the byte-offset into data of a given pixel location
+  def byte_offset(loc) loc.y * line_byte_size + loc.x * pixel_byte_size; end
+
+  # return the byte of a single horizontal sub-line of data
+  # (start is a GuiGeo::Point)
+  def sub_horizontal_line(start, length)
+    offset = byte_offset start
+    data[offset .. (offset + (length*pixel_byte_size)-1)]
+  end
+
+  # return a new image with the pixels from the specified sub_area (GuiGeo::Rectangle)
+  def subimage(sub_area)
+    sub_area = area | sub_area
+
+    byte_width_minus_one = sub_area.w * pixel_byte_size - 1
+    stride = line_byte_size
+    offset = byte_offset(sub_area.loc) - stride
+    data = @data
+    Image.new :size => sub_area.size, :format => format, :data => (sub_area.h.times.collect do
+      offset += stride
+      data[offset .. (offset + byte_width_minus_one)]
+    end).join
+  end
+
+  # replace the pixels of the given sub_area (GuiGeo::Rectangle) with the specified Image::Color
+  def replace_rect(sub_area, color)
+    sub_area = area | sub_area
+    return unless sub_area.present?
+
+    replace_line = color.to_bytes(format) * sub_area.w
+
+    data = @data
+    each_line(sub_area) do |range|
+      data[range] = replace_line
+    end
+  end
+
+  # replace the pixels of the given sub_area (GuiGeo::Rectangle) with the pixels of the given image (Image)
+  # optional: specify a sub-area of the source image to copy
+  def replace_image(loc, image, source_sub_area = nil)
+    raise ArgumentError.new unless format == image.format
+    loc -= source_sub_area.loc if source_sub_area
+    source_sub_area = (area - loc) | image.area | source_sub_area
+    target_sub_area = source_sub_area + loc
+    return unless target_sub_area.present?
+
+    data = @data
+    w = source_sub_area.w
+    l = source_sub_area.loc
+    each_line(target_sub_area) do |range|
+      data[range] = image.sub_horizontal_line(l, w)
+      l.y += 1
+    end
+  end
+
+  private
+  def minimum_line_byte_size; size.x * pixel_byte_size; end
+
+  # assumes sub_area is a strict sub_area of self.area
+  def each_line(sub_area)
+    byte_width_minus_one = sub_area.w * pixel_byte_size - 1
+    stride = line_byte_size
+    offset = byte_offset(sub_area.loc) - stride
+
+    sub_area.h.times do
+      offset += stride
+      range = offset .. (offset + byte_width_minus_one)
+      yield range
+    end
+  end
+
+  def new_data(color)
+    color ||= transparent
+    color_string = color.to_bytes(format)
+    color_string * pixel_size
+  end
+end
+end

data/lib/raw_image/version.rb

@@ -0,0 +1,3 @@
+module RawImage
+  VERSION = "0.0.1"
+end

data/raw_image.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'raw_image/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "raw_image"
+  gem.version       = RawImage::VERSION
+  gem.authors       = ["Shane Brinkman-Davis"]
+  gem.email         = ["shanebdavis@gmail.com"]
+  gem.description   = %q{Gem for storing and manipulating raw, uncompressed bitmap images}
+  gem.summary       = %q{Gem for storing and manipulating raw, uncompressed bitmap images}
+  gem.homepage      = "https://github.com/shanebdavis/raw_image"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'gui_geometry', ">= 0.1.1"
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-test'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/color_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+module RawImage
+describe "Color" do
+  include ::RawImage
+  include Colors
+
+  it "new" do
+    Color.new.to_s.should == "#000000ff"
+    Color.new(0.5).to_s.should == "#7f7f7fff"
+    Color.new(1).to_s.should == "#ffffffff"
+    Color.new(1,0.5,0.25,0.1).to_s.should == "#ff7f3f19"
+  end
+
+  it "defined colors" do
+    transparent.to_s.should == "#00000000"
+    black.to_s.should == "#000000ff"
+    gray.to_s.should == "#7f7f7fff"
+    white.to_s.should == "#ffffffff"
+  end
+
+  it "accessors" do
+    c = Color.new 0.1, 0.2, 0.3, 0.4
+    c.r.should == 0.1
+    c.g.should == 0.2
+    c.b.should == 0.3
+    c.a.should == 0.4
+  end
+
+  it "to_bytes - various values" do
+    transparent.to_bytes(:rgba8).should == "\0\0\0\0"
+    black.to_bytes(:rgba8).should == "\0\0\0\xff"
+    white.to_bytes(:rgba8).should == "\xff\xff\xff\xff"
+    Color.new(0.25,1,0.5,1).to_bytes(:rgba8).should == "?\xff\x7f\xff"
+  end
+
+  it "to_bytes - various formats" do
+    gray.to_bytes(:g8).should == "\x7F"
+    gray.to_bytes(:rgb8).should == "\x7F\x7F\x7F"
+    gray.to_bytes(:rgba8).should == "\x7F\x7F\x7F\xFF"
+  end
+
+  it "set gray" do
+    c = Color.new 0.1, 0.2, 0.3, 0.4
+    c.gray = 0.25
+    c.to_s.should == "#33333366"
+  end
+
+  it "inspect" do
+    white.inspect.should == "color(1.0, 1.0, 1.0, 1.0)"
+  end
+
+  it "easy constructor" do
+    color(0.1).to_s.should == "#191919ff"
+  end
+end
+end

data/spec/image_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module RawImage
+describe "Image" do
+  include RawImage
+  include Colors
+  it "new" do
+    image(:size => point(10,10)).data.should == "\x00"*400
+  end
+
+  it "subimage" do
+    i = image(:size => point(10,10))
+    i.subimage(rect(2,2,5,5)).data.should == "\x00"*100
+  end
+
+  it "replace_rect" do
+    i = image(:size => point(5,5))
+    i.replace_rect rect(1,1,2,2), white
+    i.data.should ==
+      "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"+
+      "\x00\x00\x00\x00\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00\x00\x00\x00\x00\x00\x00"+
+      "\x00\x00\x00\x00\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00\x00\x00\x00\x00\x00\x00"+
+      "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"+
+      "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  end
+
+  it "replace_image" do
+    i = image(:size => point(5,5))
+    i2 = image(:size => point(5,5), :color => white)
+    i.replace_image point(3,2), i2
+    i.data.should ==
+      "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"+
+      "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"+
+      "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF"+
+      "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF"+
+      "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF"
+  end
+
+end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "vendor/ruby"
+end
+
+require File.join(File.dirname(__FILE__),"..","lib","raw_image")

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: raw_image
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Shane Brinkman-Davis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gui_geometry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for storing and manipulating raw, uncompressed bitmap images
+email:
+- shanebdavis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/raw_image.rb
+- lib/raw_image/color.rb
+- lib/raw_image/color_formats.rb
+- lib/raw_image/colors.rb
+- lib/raw_image/image.rb
+- lib/raw_image/version.rb
+- raw_image.gemspec
+- spec/color_spec.rb
+- spec/image_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shanebdavis/raw_image
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem for storing and manipulating raw, uncompressed bitmap images
+test_files:
+- spec/color_spec.rb
+- spec/image_spec.rb
+- spec/spec_helper.rb