pnm 0.1.0

data/lib/pnm/image.rb

@@ -0,0 +1,129 @@
+module PNM
+
+  # Class for +PBM+, +PGM+, and +PPM+ images. See PNM module for examples.
+  class Image
+
+    # The type of the image. See ::new for details.
+    attr_reader :type
+
+    # The width of the image in pixels.
+    attr_reader :width
+
+    # The height of the image in pixels.
+    attr_reader :height
+
+    # The maximum gray or color value. See ::new for details.
+    attr_reader :maxgray
+
+    # The pixel data, given as a two-dimensional array.
+    # See ::new for details.
+    attr_reader :pixels
+
+    # An optional multiline comment string.
+    attr_reader :comment
+
+    # Creates an image from a two-dimensional array of bilevel,
+    # gray, or RGB values.
+    #
+    # +type+::    The type of the image (+:pbm+, +:pgm+, or +:ppm+).
+    # +pixels+::  The pixel data, given as a two-dimensional array of
+    #
+    #             * for PBM: bilevel values (0 or 1),
+    #             * for PGM: gray values between 0 and +maxgray+,
+    #             * for PPM: an array of 3 values between 0 and +maxgray+,
+    #               corresponding to red, green, and blue (RGB).
+    #
+    #             PPM also accepts an array of gray values.
+    #
+    #             A value of 0 means that the color is turned off.
+    #
+    # Optional settings that can be specified in the +options+ hash:
+    #
+    # +maxgray+:: The maximum gray or color value.
+    #             For PGM and PPM, +maxgray+ must be less or equal 255
+    #             (the default value). For PBM, this setting is ignored
+    #             and +maxgray+ is always set to 1.
+    # +comment+:: A multiline comment string (default: empty string).
+    def initialize(type, pixels, options = {})
+      @type    = type
+      @width   = pixels.first.size
+      @height  = pixels.size
+      @maxgray = options[:maxgray] || 255
+      @comment = (options[:comment] || '').chomp
+      @pixels  = pixels
+
+      @maxgray = 1  if type == :pbm
+
+      if type == :ppm && !pixels.first.first.kind_of?(Array)
+        @pixels = pixels.map {|row| row.map {|pixel| gray_to_rgb(pixel) } }
+      end
+    end
+
+    # Writes the image to +file+ (a filename or an IO object),
+    # using the specified encoding.
+    # Valid encodings are +:binary+ (default) and +:ascii+.
+    #
+    # Returns the number of bytes written.
+    def write(file, encoding = :binary)
+      content = if encoding == :ascii
+                  to_ascii
+                elsif encoding == :binary
+                  to_binary
+                end
+
+      if file.kind_of?(String)
+        File.binwrite(file, content)
+      else
+        file.binmode
+        file.write content
+      end
+    end
+
+    # Returns a string with a short image format description.
+    def info
+      "#{type.to_s.upcase} #{width}x#{height} #{type_string}"
+    end
+
+    alias :to_s :info
+
+    private
+
+    def type_string  # :nodoc:
+      case type
+      when :pbm
+        'Bilevel'
+      when :pgm
+        'Grayscale'
+      when :ppm
+        'Color'
+      end
+    end
+
+    def header(encoding)  # :nodoc:
+      header =  "#{PNM.magic_number[type][encoding]}\n"
+      if comment
+        comment.split("\n").each {|line| header << "# #{line}\n" }
+      end
+      header << "#{width} #{height}\n"
+      header << "#{maxgray}\n"  unless type == :pbm
+
+      header
+    end
+
+    def to_ascii  # :nodoc:
+      data_string = Converter.array2ascii(pixels)
+
+      header(:ascii) << data_string
+    end
+
+    def to_binary  # :nodoc:
+      data_string = Converter.array2binary(type, pixels)
+
+      header(:binary) << data_string
+    end
+
+    def gray_to_rgb(gray_value)  # :nodoc:
+      Array.new(3, gray_value)
+    end
+  end
+end

data/lib/pnm/parser.rb

@@ -0,0 +1,83 @@
+module PNM
+
+  # Parser for PNM image files. Only for internal usage.
+  class Parser
+
+    # Parses PNM image data.
+    #
+    # +content+:: A string containing the image file content.
+    #
+    # Returns a hash containing the parsed data as strings:
+    #
+    # * +:magic_number+,
+    # * +:maxgray+ (only for PGM and PPM),
+    # * +:width+,
+    # * +:height+,
+    # * +:data+,
+    # * +:comments+ (only if present): an array of comment strings.
+    def self.parse(content)
+      content = content.dup
+
+      magic_number = nil
+      tokens   = []
+      comments = []
+
+      until magic_number
+        token = get_next_token!(content)
+
+        if token[0] == '#'
+          comments << token.gsub(/# */, '')
+        else
+          magic_number = token
+        end
+      end
+
+      raise "Unknown magic number"  unless token_number[magic_number]
+
+      while tokens.size < token_number[magic_number]
+        content.gsub!(/\A[ \t\r\n]+/, '')
+        token = get_next_token!(content)
+        if token[0] == '#'
+          comments << token.gsub(/# */, '')
+        else
+          tokens << token
+        end
+      end
+
+      width, height, maxgray = tokens
+
+      result = {
+        :magic_number => magic_number,
+        :width        => width,
+        :height       => height,
+        :data         => content
+      }
+      result[:maxgray]  = maxgray   if maxgray
+      result[:comments] = comments  unless comments.empty?
+
+      result
+    end
+
+    def self.token_number  # :nodoc:
+      {
+        'P1' => 2,
+        'P2' => 3,
+        'P3' => 3,
+        'P4' => 2,
+        'P5' => 3,
+        'P6' => 3
+      }
+    end
+
+    def self.get_next_token!(content)  # :nodoc:
+      if content[0] == '#'
+        token, rest = content.split("\n", 2)
+      else
+        token, rest = content.split(/[ \t\r\n]|(?=#)/, 2)
+      end
+      content.clear << rest
+
+      token
+    end
+  end
+end

data/lib/pnm/version.rb

@@ -0,0 +1,4 @@
+module PNM
+  VERSION  = '0.1.0'       # :nodoc:
+  DATE     = '2013-10-26'  # :nodoc:
+end

data/pnm.gemspec

@@ -0,0 +1,42 @@
+require './lib/pnm'
+
+version  = PNM::VERSION
+date     = PNM::DATE
+homepage = PNM::HOMEPAGE
+tagline  = PNM::TAGLINE
+
+Gem::Specification.new do |s|
+  s.name              = 'pnm'
+  s.version           = version
+  s.date              = date
+
+  s.description = 'PNM is a pure Ruby library for creating, reading, ' +
+                  'and writing of PNM image files (Portable Anymap): ' +
+                  'PBM (Portable Bitmap), ' +
+                  'PGM (Portable Graymap), and ' +
+                  'PPM (Portable Pixmap).'
+  s.summary = "PNM - #{tagline}"
+
+  s.authors = ['Marcus Stollsteimer']
+  s.email = 'sto.mar@web.de'
+  s.homepage = homepage
+
+  s.license = 'GPL-3'
+
+  s.required_ruby_version = '>=1.9.3'
+
+  s.add_development_dependency('rake')
+
+  s.require_path = 'lib'
+
+  s.test_files = Dir.glob('test/**/test_*.rb')
+
+  s.files = %w{
+      README.md
+      Rakefile
+      pnm.gemspec
+    } +
+    Dir.glob('{benchmark,lib,test}/**/*')
+
+  s.rdoc_options = ['--charset=UTF-8']
+end

data/test/bilevel_ascii.pbm

@@ -0,0 +1,9 @@
+P1
+# Bilevel
+5 6
+0 0 0 0 0
+0 1 1 1 0
+0 0 1 0 0
+0 0 1 0 0
+0 0 1 0 0
+0 0 0 0 0

data/test/color_ascii.ppm

@@ -0,0 +1,6 @@
+P3
+5 3
+6
+0 6 0 1 5 1 2 4 2 3 3 4 4 2 6
+1 5 2 2 4 2 3 3 2 4 2 2 5 1 2
+2 4 6 3 3 4 4 2 2 5 1 1 6 0 0

data/test/grayscale_ascii.pgm

@@ -0,0 +1,8 @@
+P2
+# Grayscale
+# (with multiline comment)
+4 3
+250
+0 50 100 150
+50 100 150 200
+100 150 200 250

data/test/grayscale_binary_crlf.pgm

@@ -0,0 +1,5 @@
+P5
+2 3
+255
+AB
+AB

data/test/test_converter.rb

@@ -0,0 +1,183 @@
+# test_converter.rb: Unit tests for the PNM library.
+#
+# Copyright (C) 2013 Marcus Stollsteimer
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pnm/converter'
+
+
+describe PNM::Converter do
+
+  before do
+    @converter = PNM::Converter
+
+    @pbm6  = {
+               :width  => 6,
+               :height => 2,
+               :array  => [[0,1,0,0,1,1], [0,0,0,1,1,1]],
+               :ascii  => "0 1 0 0 1 1\n0 0 0 1 1 1\n",
+               :binary => ['4C1C'].pack('H*')
+             }
+
+    @pbm14 = {
+               :width  => 14,
+               :height => 2,
+               :array  => [[0,0,1,1,1,0,0,0,1,1,0,0,1,0], [0,1,0,1,1,0,1,1,1,0,1,1,1,1]],
+               :ascii  => "0 0 1 1 1 0 0 0 1 1 0 0 1 0\n0 1 0 1 1 0 1 1 1 0 1 1 1 1\n",
+               :binary => ['38C85BBC'].pack('H*')
+             }
+
+    @pbm = @pbm14
+
+    @pgm =   {
+               :width  => 4,
+               :height => 3,
+               :array  => [[0, 85, 170, 255], [85, 170, 255, 0], [170, 255, 0, 85]],
+               :ascii  => "0 85 170 255\n85 170 255 0\n170 255 0 85\n",
+               :binary => ['0055AAFF55AAFF00AAFF0055'].pack('H*')
+             }
+
+    @ppm =   {
+               :width  => 3,
+               :height => 2,
+               :array  => [[[0,128,255], [128,255,0], [255,0,128]],
+                           [[255,128,0], [128,0,255], [0,255,128]]],
+               :ascii  => "0 128 255 128 255 0 255 0 128\n255 128 0 128 0 255 0 255 128\n",
+               :binary => ['0080FF80FF00FF0080FF80008000FF00FF80'].pack('H*')
+             }
+  end
+
+  it 'can convert from ASCII encoded PBM data' do
+    data     = @pbm[:ascii]
+    expected = @pbm[:array]
+
+    @converter.ascii2array(:pbm, data).must_equal expected
+  end
+
+  it 'can convert from ASCII encoded PGM data' do
+    data     = @pgm[:ascii]
+    expected = @pgm[:array]
+
+    @converter.ascii2array(:pgm, data).must_equal expected
+  end
+
+  it 'can convert from ASCII encoded PPM data' do
+    data     = @ppm[:ascii]
+    expected = @ppm[:array]
+
+    @converter.ascii2array(:ppm, data).must_equal expected
+  end
+
+  it 'can convert from binary encoded PBM data (width 6)' do
+    width    = @pbm6[:width]
+    height   = @pbm6[:height]
+    data     = @pbm6[:binary]
+    expected = @pbm6[:array]
+
+    @converter.binary2array(:pbm, width, height, data).must_equal expected
+  end
+
+  it 'can convert from binary encoded PBM data (width 14)' do
+    width    = @pbm14[:width]
+    height   = @pbm14[:height]
+    data     = @pbm14[:binary]
+    expected = @pbm14[:array]
+
+    @converter.binary2array(:pbm, width, height, data).must_equal expected
+  end
+
+  it 'can convert from binary encoded PGM data' do
+    width    = @pgm[:width]
+    height   = @pgm[:height]
+    data     = @pgm[:binary]
+    expected = @pgm[:array]
+
+    @converter.binary2array(:pgm, width, height, data).must_equal expected
+  end
+
+  it 'can convert from binary encoded PPM data' do
+    width    = @ppm[:width]
+    height   = @ppm[:height]
+    data     = @ppm[:binary]
+    expected = @ppm[:array]
+
+    @converter.binary2array(:ppm, width, height, data).must_equal expected
+  end
+
+  it 'accepts an additional whitespace character for binary encoded data' do
+    width    = @pbm14[:width]
+    height   = @pbm14[:height]
+    data     = @pbm14[:binary] + "\t"
+    expected = @pbm14[:array]
+
+    @converter.binary2array(:pbm, width, height, data).must_equal expected
+  end
+
+  it 'can convert to ASCII encoded PBM data' do
+    data     = @pbm[:array]
+    expected = @pbm[:ascii]
+
+    @converter.array2ascii(data).must_equal expected
+  end
+
+  it 'can convert to ASCII encoded PGM data' do
+    data     = @pgm[:array]
+    expected = @pgm[:ascii]
+
+    @converter.array2ascii(data).must_equal expected
+  end
+
+  it 'can convert to ASCII encoded PPM data' do
+    data     = @ppm[:array]
+    expected = @ppm[:ascii]
+
+    @converter.array2ascii(data).must_equal expected
+  end
+
+  it 'can convert to binary encoded PBM data (width 6)' do
+    data     = @pbm6[:array]
+    expected = @pbm6[:binary]
+
+    @converter.array2binary(:pbm, data).must_equal expected
+  end
+
+  it 'can convert to binary encoded PBM data (width 14)' do
+    data     = @pbm14[:array]
+    expected = @pbm14[:binary]
+
+    @converter.array2binary(:pbm, data).must_equal expected
+  end
+
+  it 'can convert to binary encoded PGM data' do
+    data     = @pgm[:array]
+    expected = @pgm[:binary]
+
+    @converter.array2binary(:pgm, data).must_equal expected
+  end
+
+  it 'can convert to binary encoded PPM data' do
+    data     = @ppm[:array]
+    expected = @ppm[:binary]
+
+    @converter.array2binary(:ppm, data).must_equal expected
+  end
+
+  it 'can calculate correct byte widths for a PBM image' do
+    @converter.byte_width(:pbm,  0).must_equal 0
+    @converter.byte_width(:pbm,  1).must_equal 1
+    @converter.byte_width(:pbm,  7).must_equal 1
+    @converter.byte_width(:pbm,  8).must_equal 1
+    @converter.byte_width(:pbm,  9).must_equal 2
+    @converter.byte_width(:pbm, 64).must_equal 8
+    @converter.byte_width(:pbm, 65).must_equal 9
+  end
+
+  it 'can calculate correct byte widths for a PGM image' do
+    @converter.byte_width(:pgm, 13).must_equal 13
+  end
+
+  it 'can calculate correct byte widths for a PPM image' do
+    @converter.byte_width(:ppm, 13).must_equal 39
+  end
+end