tiff 0.1

data/README.md

@@ -0,0 +1,30 @@
+Tiff
+====
+
+This is a simple wrapper around libtiff using FFI. It only implements a small
+subset of libffi's features -- just enough to generate a TIFF image and read
+back some of its data. If you're interested in adding features, you can always
+send me a pull request (please include specs!).
+
+Usage
+=====
+
+    Tiff::Image.open "filename.tif", "w" do |tiff|
+
+      tiff.set_field :compression, :CCITTFAX4
+      # or: tiff.set_field :compression, :CCITTFAX3
+
+      tiff.set_field :photometric, :min_is_white
+      # or: tiff.set_field :photometric, :min_is_black
+
+      tiff.bits_per_sample = 1
+      tiff.width = 200
+      tiff.height = 40
+
+      tiff.data = raw_data
+
+    end
+
+    image = Tiff::Image.open "filename.tif", "r"
+    image.get_field :width  # => 200
+    image.get_field :height # => 40

data/lib/tiff.rb

@@ -0,0 +1,8 @@
+require "ffi"
+
+module Tiff
+  require "tiff/tag"
+
+  require "tiff/bindings"
+  require "tiff/image"
+end

data/lib/tiff/bindings.rb

@@ -0,0 +1,99 @@
+module Tiff
+  module Bindings
+
+    extend FFI::Library
+
+    ffi_lib 'libtiff'
+
+    attach_function :open, :TIFFOpen,
+      [:string, :string], :pointer
+
+    attach_function :close, :TIFFClose,
+      [:pointer], :void
+
+    attach_function :set_field, :TIFFSetField,
+      [:pointer, :uint, :varargs], :int
+
+    attach_function :get_field, :TIFFGetField,
+      [:pointer, :uint, :varargs], :int
+
+    attach_function :write_raw_strip, :TIFFWriteRawStrip,
+      [:pointer, :uint, :pointer, :int], :int
+
+    @@tags = Hash.new do |hash, key|
+      raise KeyError, "Tag #{key.inspect} is unsupported. Available tags: #{hash.keys}"
+    end
+
+    class << self
+
+      # Returns a hash of tag names to Tag instances. See `lib/tiff/tags.rb`
+      # for a list of supported tags.
+      def tags
+        @@tags
+      end
+
+    end
+
+    # Initializes the tags hash with the default set of supported tags. See
+    # `man libtiff` and `man TIFFGetField` for details.
+
+    tags[:artist] = Tag.new(:artist, 315, :string)
+    tags[:bad_fax_lines] = Tag.new(:bad_fax_lines, 326, :uint)
+    tags[:bits_per_sample] = Tag.new(:bits_per_sample, 258, :ushort)
+    tags[:clean_fax_data] = Tag.new(:clean_fax_data, 327, :ushort)
+    tags[:compression] = Tag.new(:compression, 259, :ushort, CCITTFAX3: 3, CCITTFAX4: 4)
+    tags[:consecutive_bad_fax_lines] = Tag.new(:consecutive_bad_fax_lines, 328, :uint)
+    tags[:copyright] = Tag.new(:copyright, 33432, :string)
+    tags[:data_type] = Tag.new(:data_type, 32996, :ushort)
+    tags[:date_time] = Tag.new(:date_time, 306, :string)
+    tags[:document_name] = Tag.new(:document_name, 269, :string)
+    tags[:fill_order] = Tag.new(:fill_order, 266, :ushort)
+    tags[:group3_options] = Tag.new(:group3_options, 292, :uint)
+    tags[:group4_options] = Tag.new(:group4_options, 293, :uint)
+    tags[:height] = Tag.new(:height, 257, :uint)
+    tags[:host_computer] = Tag.new(:host_computer, 316, :string)
+    tags[:image_depth] = Tag.new(:image_depth, 32997, :uint)
+    tags[:image_description] = Tag.new(:image_description, 270, :string)
+    tags[:ink_names] = Tag.new(:ink_names, 333, :string)
+    tags[:ink_set] = Tag.new(:ink_set, 332, :ushort)
+    tags[:make] = Tag.new(:make, 271, :string)
+    tags[:matteing] = Tag.new(:matteing, 32995, :ushort)
+    tags[:max_sample_value] = Tag.new(:max_sample_value, 281, :ushort)
+    tags[:min_sample_value] = Tag.new(:min_sample_value, 280, :ushort)
+    tags[:model] = Tag.new(:model, 272, :string)
+    tags[:orientation] = Tag.new(:orientation, 274, :ushort)
+    tags[:page_name] = Tag.new(:page_name, 285, :string)
+    tags[:photometric] = Tag.new(:photometric, 262, :ushort, min_is_white: 0, min_is_black: 1)
+    tags[:predictor] = Tag.new(:predictor, 317, :ushort)
+    tags[:resolution_unit] = Tag.new(:resolution_unit, 296, :ushort, none: 1, inch: 2, centimeter: 3)
+    tags[:rows_per_strip] = Tag.new(:rows_per_strip, 278, :uint)
+    tags[:s_max_sample_value] = Tag.new(:s_max_sample_value, 341, :double)
+    tags[:s_min_sample_value] = Tag.new(:s_min_sample_value, 340, :double)
+    tags[:sample_format] = Tag.new(:sample_format, 339, :ushort)
+    tags[:samples_per_pixel] = Tag.new(:samples_per_pixel, 277, :ushort)
+    tags[:software] = Tag.new(:software, 305, :string)
+    tags[:sub_file_type] = Tag.new(:sub_file_type, 255, :uint)
+    tags[:target_printer] = Tag.new(:target_printer, 337, :string)
+    tags[:tile_depth] = Tag.new(:tile_depth, 32998, :uint)
+    tags[:tile_length] = Tag.new(:tile_length, 323, :uint)
+    tags[:tile_width] = Tag.new(:tile_width, 322, :uint)
+    tags[:width] = Tag.new(:width, 256, :uint)
+    tags[:x_position] = Tag.new(:x_position, 286, :float)
+    tags[:x_resolution] = Tag.new(:x_resolution, 282, :float)
+    tags[:y_cb_cr_positioning] = Tag.new(:y_cb_cr_positioning, 531, :ushort)
+    tags[:y_position] = Tag.new(:y_position, 286, :float)
+    tags[:y_resolution] = Tag.new(:y_resolution, 283, :float)
+
+    # Array types are not yet supported.
+    #
+    # tags[:reference_black_white] = Tag.new(:reference_black_white, 532, :float*)
+    # tags[:sto_nits] = Tag.new(:sto_nits, 37439, :double*)
+    # tags[:strip_byte_counts] = Tag.new(:strip_byte_counts, 279, :uint*)
+    # tags[:strip_offsets] = Tag.new(:strip_offsets, 273, :uint*)
+    # tags[:tile_byte_counts] = Tag.new(:tile_byte_counts, 324, :uint*)
+    # tags[:tile_offsets] = Tag.new(:tile_offsets, 324, :uint*)
+    # tags[:white_point] = Tag.new(:white_point, 318, :float*)
+    # tags[:y_cb_cr_coefficients] = Tag.new(:y_cb_cr_coefficients, 529, :float*)
+
+  end
+end

data/lib/tiff/image.rb

@@ -0,0 +1,91 @@
+module Tiff
+
+  class Image
+
+    attr_reader :path, :mode
+
+    # The file descriptor. This is an FFI::Pointer to the opened TIFF file.
+    attr_reader :fd
+
+    def initialize(path, mode)
+      @path = path
+      @mode = mode
+
+      @fd = Bindings::open path, mode
+    end
+
+    def close
+      Bindings::close fd
+    end
+
+    # Writes raw data to the image.
+    def data=(data)
+      Bindings::write_raw_strip fd, 0, data, data.length
+    end
+
+    # Sets a field on the image, using the list of tags in
+    # `Tiff::Bindings.tags`
+    def set_field(name, value)
+      tag = Bindings::tags[name]
+      Bindings::set_field fd, tag.id, tag.type, tag.serialize(value)
+    end
+
+    # Gets a field from the image, using the list of tags in #
+    # `Tiff::Bindings.tags`
+    def get_field(name)
+      tag = Bindings::tags[name]
+      pointer = FFI::MemoryPointer.new tag.type
+      result = Bindings::get_field fd, tag.id, :pointer, pointer
+      if result == 1
+        tag.deserialize pointer
+      else
+        nil
+      end
+    end
+
+    # Sets the image's width
+    def width=(width)
+      set_field :width, width
+    end
+
+    # Sets the image's height
+    def height=(height)
+      set_field :height, height
+    end
+
+    # Sets the image's bits_per_sample
+    def bits_per_sample=(bits_per_sample)
+      set_field :bits_per_sample, bits_per_sample
+    end
+
+    # Sets the image's compression
+    def compression=(compresion)
+      set_field :compression, compresion
+    end
+
+    # Sets the image's photometric
+    def photometric=(compresion)
+      set_field :photometric, compresion
+    end
+
+    class << self
+
+      # Initializes a new image. If a block is provided, the image is yielded
+      # and automatically closed.
+      def open(path, mode)
+        new(path, mode).tap do |image|
+          if block_given?
+            begin
+              yield image
+            ensure
+              image.close
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/tiff/tag.rb

@@ -0,0 +1,71 @@
+module Tiff
+  class Tag
+
+    # The name of this tag
+    attr_accessor :name
+
+    # The value for this tag as defined by `tiff.h`
+    attr_accessor :id
+
+    # The FFI type for this tag. See `man TIFFSetField` for the types of each
+    # field, and `https://github.com/ffi/ffi/wiki/Types` for it's corresponding
+    # value in ruby.
+    attr_accessor :type
+
+    # A hash of ruby to FFI values for serialization and deserialization.
+    attr_accessor :map
+
+    # Creates a new tag.
+    #
+    # - name: A rubyish name for the tag. Displayed to users for exceptions.
+    # - id: The value for this tag as defined by `tiff.h`
+    # - type: The FFI type of the tag
+    # - map: A hash of ruby to FFI values (optional)
+    #
+    # Examples:
+    #
+    #   width = Tag.new(:width, 256, :uint)
+    #   metric = Tag.new(:photometric, 262, :ushort, {
+    #     min_is_white: 0,
+    #     min_is_black: 1
+    #   })
+    #
+    def initialize(name, id, type, map = nil)
+      @name = name
+      @id = id
+      @type = type
+      @map = map
+    end
+
+    # Returns the value for serialization. If the tag does not have a map
+    # defined, this simply returns the value provided.
+    #
+    # If a map was provided for the tag, it will return the value for the
+    # mapping. If the mapping isn't found, it will raise an exception.
+    def serialize(value)
+      return value unless map
+
+      map.fetch value do
+        raise KeyError, "Tag #{name.inspect} does not support value #{value.inspect}. Defined values: #{map.keys}"
+      end
+    end
+
+    # Returns the deserialized value from the provided FFI::MemoryPointer.
+    #
+    # If a map was provided for the tag, it will return the ruby value if it
+    # exists. If the mapping isn't found, it will return the raw value.
+    def deserialize(pointer)
+      case type
+        when :string
+          string = pointer.read_pointer()
+          return string.null? ? nil : string.read_string()
+
+        else
+          value = pointer.send :"read_#{type}"
+          value = map.invert[value] if map && map.has_value?(value)
+          value
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: tiff
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Bernerd Schaefer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &70275682402260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70275682402260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70275682428940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70275682428940
+description: Ruby wrapper for libtiff with FFI
+email:
+- bj.schaefer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tiff/bindings.rb
+- lib/tiff/image.rb
+- lib/tiff/tag.rb
+- lib/tiff.rb
+- README.md
+homepage: ''
+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.6
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for libtiff with FFI
+test_files: []