format_parser 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 789592107e9fa74091745b703249248b6a05e9dd73af45803ab799708f8498fc
-  data.tar.gz: 191ff20e5b8d455f681eb19b40a2bd406c1cfa1a9b2aeebaa483ea829071e532
+  metadata.gz: 91bcb409bce9e0576a83680ef91cd6e910e6df9b4bc4953cb23de8d887021b59
+  data.tar.gz: ef6f74cd026bb3dd26e16c3282f9ec71e5b63f8e957d4b818cdac0acbc058c74
 SHA512:
-  metadata.gz: dde5379a4d0590019ac6eee21361e10688f8582efa169132f28a0dc531f6b05811368e987a3a30902dcc1a509952c11bb9810bee3f3dbd17e99f3c13f1776b71
-  data.tar.gz: ec5a699fb441ca622006fb2885a6e1ce623da0a7ea6a5b78e5df83db2a1f9227dd023681f12a7ec703188133a8276e363dd3e5c090bca3ce694064124925e47e
+  metadata.gz: c118d28ecce997d45058d3b19de89d1c8ab6a88df390c58875f4ad22b36043f4562913c78c66cea380357184d48fddf6cf5736a8f7f7eb62a83fea6bddc85b13
+  data.tar.gz: 70ee5504c514fbed060ca62cf0cd0e429f1f01535e805de6a974dbcd5a9154b81c859a70a09ad39fc2ef8c341391f3f1f2a2ed3566a19976884dea03b9d541d6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.9.0
+* Add a parser for the BMP image file format
+
 ## 0.8.0
 * Add `Measurometer` for applying instrumentation around FormatParser operaions. See documentation for usage.
 

data/lib/format_parser/version.rb

@@ -1,3 +1,3 @@
 module FormatParser
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/lib/parsers/bmp_parser.rb

@@ -0,0 +1,41 @@
+# Based on https://en.wikipedia.org/wiki/BMP_file_format
+
+class FormatParser::BMPParser
+  include FormatParser::IOUtils
+
+  VALID_BMP = 'BM'
+  PIXEL_ARRAY_OFFSET = 54
+
+  def call(io)
+    io = FormatParser::IOConstraint.new(io)
+
+    magic_number, _file_size, _reserved1, _reserved2, dib_header_location = safe_read(io, 14).unpack('A2Vv2V')
+    return unless VALID_BMP == magic_number
+    return unless dib_header_location == PIXEL_ARRAY_OFFSET
+
+    dib_header = safe_read(io, 40)
+
+    _header_size, width, height, _planes, _bits_per_pixel,
+    _compression_method, _image_size, horizontal_res,
+    vertical_res, _n_colors, _i_colors = dib_header.unpack('Vl<2v2V2l<2V2')
+
+    # There are cases where the height might by negative indicating the data
+    # is ordered from top to bottom instead of bottom to top
+    # http://www.dragonwins.com/domains/getteched/bmp/bmpfileformat.htm#The%20Image%20Header
+    data_order = height < 0 ? :inverse : :normal
+
+    FormatParser::Image.new(
+      format: :bmp,
+      width_px: width,
+      height_px: height.abs,
+      color_mode: :rgb,
+      intrinsics: {
+        vertical_resolution: vertical_res,
+        horizontal_resolution: horizontal_res,
+        data_order: data_order
+      }
+    )
+  end
+
+  FormatParser.register_parser self, natures: :image, formats: :bmp
+end

data/spec/parsers/bmp_parser_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe FormatParser::BMPParser do
+  it 'parses a BMP file with positive height_px values' do
+    bmp_path = fixtures_dir + '/BMP/test.bmp'
+    parsed = subject.call(File.open(bmp_path, 'rb'))
+
+    expect(parsed).not_to be_nil
+    expect(parsed.nature).to eq(:image)
+    expect(parsed.format).to eq(:bmp)
+    expect(parsed.color_mode).to eq(:rgb)
+
+    expect(parsed.width_px).to eq(40)
+    expect(parsed.height_px).to eq(27)
+
+    expect(parsed.intrinsics).not_to be_nil
+    expect(parsed.intrinsics[:vertical_resolution]).to eq(2834)
+    expect(parsed.intrinsics[:horizontal_resolution]).to eq(2834)
+    expect(parsed.intrinsics[:data_order]).to eq(:normal)
+  end
+
+  it 'parses a BMP file with negative height_px values (divergent scan order)' do
+    bmp_path = fixtures_dir + '/BMP/test2.bmp'
+    parsed = subject.call(File.open(bmp_path, 'rb'))
+
+    expect(parsed).not_to be_nil
+    expect(parsed.nature).to eq(:image)
+    expect(parsed.format).to eq(:bmp)
+    expect(parsed.color_mode).to eq(:rgb)
+
+    expect(parsed.width_px).to eq(1920)
+    expect(parsed.height_px).to eq(1080)
+
+    expect(parsed.intrinsics).not_to be_nil
+    expect(parsed.intrinsics[:vertical_resolution]).to eq(2835)
+    expect(parsed.intrinsics[:horizontal_resolution]).to eq(2835)
+    expect(parsed.intrinsics[:data_order]).to eq(:inverse)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: format_parser
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Noah Berman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-17 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ks
@@ -172,6 +172,7 @@ files:
 - lib/io_utils.rb
 - lib/measurometer.rb
 - lib/parsers/aiff_parser.rb
+- lib/parsers/bmp_parser.rb
 - lib/parsers/cr2_parser.rb
 - lib/parsers/dpx_parser.rb
 - lib/parsers/exif_parser.rb
@@ -204,6 +205,7 @@ files:
 - spec/io_utils_spec.rb
 - spec/measurometer_spec.rb
 - spec/parsers/aiff_parser_spec.rb
+- spec/parsers/bmp_parser_spec.rb
 - spec/parsers/cr2_parser_spec.rb
 - spec/parsers/dpx_parser_spec.rb
 - spec/parsers/exif_parser_spec.rb