myy-color 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2a893a6bce235224a2b5914227bd5354334e083
+  data.tar.gz: 9018dfe883831727c29adbcf52e33efe2b236984
+SHA512:
+  metadata.gz: cceba474a1c2ce1c83dd330e8e3fb8f964ea6be18932fa47e8bbf64e93b10d12a4eedc306b11ec8bf7cc79207f6859a9afbca2ef03eb61825aa44a809dbae90f
+  data.tar.gz: bad0309811316d4c0d038d9eddcc709bd0646c730252d61b3824a45d67fa00d1ca3b5a3980cc85653a733030db89d5e98d93e707a0723095f5111d151e32350e

data/CHANGES

@@ -0,0 +1,29 @@
+
+Version 0.0.1
+-------------
+
+* Added a CHANGELOG
+
+* Renamed color to myy-color
+
+* Cleaned up myy_bmp2raw
+
+* Added two modules to myy-color
+ * BMP which handles the decoding of BMP files
+ * GL which handles the encoding of raw textures for OpenGL
+
+* Added a few tests that currently only test the decoding procedures.
+
+* Added a README which documents :
+ * The current goals of the project
+ * How to use the library
+ * How to use myy_bmp2raw
+ * What currently needs to be done. 
+ However a TODO file might be needed.
+
+* Created the gemspec file that handles the generation of the gem.
+  Build the gem like this :
+  `$ gem build myy-color.gemspec`
+
+* Modified the .gitignore file so that backup files, gem files and
+  test textures are not added in the Git tree.

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Miouyouyou
+
+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/bin/myy_bmp2raw

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require "myy-color"
+
+if ARGV.length < 4
+  puts "convert bmp_file input_color_encoding raw_file output_color_encoding"
+  puts "Example : convert file.bmp rgba8888 text.raw rgba5551"
+  exit
+end
+
+bmp_file, input_color_encoding, raw_file, output_color_encoding, = ARGV
+
+MyyColor::OpenGL.convert_bmp(bmp_filename: bmp_file,
+                             raw_filename: raw_file,
+                             from: input_color_encoding,
+                             to: output_color_encoding)
+
+puts "Raw converted."
+

data/lib/myy-color.rb

@@ -0,0 +1,181 @@
+module MyyColor
+  class DecompInfo
+    # right-shift operand (>>), and-mask operand (&), multiplication operand
+    def initialize(rs, am, mult)
+      @rs, @am, @mult = rs, am, mult
+    end
+    def decompose_component(whole_element)
+      ((whole_element >> @rs) & @am) * @mult
+    end
+    def recompose_component(component)
+      component / @mult << @rs
+    end
+  end
+  @@rgba = [:r, :g, :b, :a].freeze
+  @@orders = {
+    # encoding - {r: DecompInfo(rs, am, mult), g: idem, b: idem, a: idem)}
+    rgba4444:
+      [[12, 0xf, 16], [8, 0xf, 16], [4, 0xf, 16], [0, 0xf, 16]],
+    rgba5551:
+      [[11, 0b11111, 8], [6,0b11111,8], [1, 0b11111, 8], [0,  1, 255]],
+    argb5551:
+      [[10, 0b11111, 8], [5,0b11111,8], [0, 0b11111, 8], [15, 1, 255]],
+    rgba8888:
+      [[24, 0xff, 1], [16, 0xff, 1], [8, 0xff, 1], [0, 0xff, 1]],
+    bgra8888:
+      [[8, 0xff, 1], [16, 0xff, 1], [24, 0xff, 1], [0, 0xff, 1]],
+    argb8888:
+      [[16, 0xff, 1], [8, 0xff, 1], [0, 0xff, 1], [24, 0xff, 1]]
+  }
+  @@orders.each do |encoding,decomp_infos|
+    # if encoding is rgba5551 :
+    # decomp_infos = [[11, 0b11111, 8],...]
+    # encoding = :rgba5551
+
+    @@orders[encoding] = {} # Example : @@orders[:rgba5551] = {}
+
+    # Continuing with the same example :
+    # shift remove the first value of an array and return the removed value
+    #                                            rs,  am,  mult
+    # @@orders[:rgba5551][:r] = DecompInfo.new(*[11,0b11111, 8])
+    # @@orders[:rgba5551][:g] = DecompInfo.new(*[5,0b11111, 8])
+    # ...
+
+    @@rgba.each do |component|
+      component_decomp_infos = decomp_infos.shift
+      @@orders[encoding][component] =
+        DecompInfo.new(*component_decomp_infos)
+    end
+  end
+  def self.handle_format?(format)
+    @@orders.has_key?(format)
+  end
+  @@hf_meth = method(:handle_format?)
+  def self.handle_formats?(*formats)
+    formats.flatten.all?(&@@hf_meth)
+  end
+  def self.handled_formats
+    @@orders.keys
+  end
+  def self.check_infos(infos)
+    if infos.nil?
+      raise ArgumentError, "No valid informations provided about the encoding #{encoding}"
+    end
+  end
+  def self.decode(encoded_color, encoding: nil, infos: @@orders[encoding])
+
+    check_infos(infos)
+
+    @@rgba.map do |component|
+
+      infos[component].decompose_component(encoded_color)
+    end
+  end
+
+  ## Use : MyyColors.encode(r, g, b, a, encoding: :rgba5551) -> Fixnum
+  ## Note : r, g, b, a must be normalised values in the [0,255] range.
+  def self.encode(*rgba_colors, encoding: nil, infos: @@orders[encoding])
+    check_infos(infos)
+
+    color_components = rgba_colors.flatten
+
+    color = 0
+    @@rgba.each do |component|
+      color |= infos[component].recompose_component((color_components.shift))
+    end
+    color
+  end
+  def self.convert_pixels(input_pixels, from:, to:)
+    input_pixels.map do |pixel|
+      encode(decode(pixel, encoding: from), encoding: to)
+    end
+  end
+
+  module BMP
+
+    @@header_offsets = { content_start_address_info: 0xa }.freeze
+    @@unpack_formats = {
+      rgba5551: "S<*",
+      rgba4444: "S<*",
+      rgba8888: "I<*",
+      argb8888: "I<*"
+    }
+    def self.convert_content(filename:, from:, to:)
+      if MyyColor.handle_formats?(from, to)
+        if !File.exists?(filename)
+          raise ArgumentError,
+            "Are you sure about that file ? #{filename}"
+        end
+
+        infile = File.open(filename, "r")
+
+        infile.seek(@@header_offsets[:content_start_address_info])
+        start_address, bitmap_header_size, width, height =
+          infile.read(16).unpack("I<4")
+        $stderr.puts("[Read] width : %d (%x) -- height : %d (%02x)" %
+          [width, width, height, height])
+        $stderr.puts "[Read] Starting from : 0x%x" % start_address
+
+        infile.seek(start_address)
+
+        input_pixels = infile.read.unpack(@@unpack_formats[from])
+
+        infile.close
+
+        output = {
+          content:
+            MyyColor.convert_pixels(input_pixels, from: from, to: to),
+          metadata: {width: width, height: height}
+        }.freeze
+
+        $stderr.puts("Encoded pixels : %d - By width : %d" %
+                     [output[:content].length,
+                      output[:content].length/width])
+
+        output
+      else
+        raise ArgumentError, <<-error.strip.gsub(/\s+/, ' ')
+          One of these formats is not supported by MyyColor :
+          #{from} - #{to}
+          Supported formats :
+          #{MyyColor.handled_formats.join('\n')}
+        error
+      end
+    end
+  end
+
+  module OpenGL
+
+    module GL
+      UNSIGNED_BYTE = 0x1401
+      RGBA = 0x1908
+      UNSIGNED_SHORT_5_5_5_1 = 0x8034
+      UNSIGNED_SHORT_4_4_4_4 = 0x8033
+    end
+
+    @@formats = {
+      rgba5551: {headers: [GL::RGBA, GL::UNSIGNED_SHORT_5_5_5_1],
+                 unpack: "S<*", pack: "S<*"},
+      rgba4444: {headers: [GL::RGBA, GL::UNSIGNED_SHORT_4_4_4_4],
+                 unpack: "S<*", pack: "S<*"},
+      rgba8888: {headers: [GL::RGBA, GL::UNSIGNED_BYTE],
+                 unpack: "I<*", pack: "I>*"},
+      argb8888: {headers: [GL::RGBA, GL::UNSIGNED_BYTE],
+                 unpack: "I<*", pack: "I>*"}
+    }
+
+    def self.convert_bmp(bmp_filename:, raw_filename:, from:, to:)
+      raw = MyyColor::BMP.convert_content(filename: bmp_filename,
+                                          from: from.to_sym,
+                                          to: to.to_sym)
+      output_format = @@formats[to.to_sym]
+      metadata = [raw[:metadata][:width], raw[:metadata][:height]] +
+        output_format[:headers]
+
+      File.open(raw_filename, "w") do |out|
+        out.write(metadata.pack("I<*"))
+        out.write(raw[:content].flatten.pack(output_format[:pack]))
+      end
+    end
+  end
+end

data/lib/myy-color.rb~

@@ -0,0 +1,150 @@
+module MyyColor
+  class DecompInfo
+    # right-shift operand (>>), and-mask operand (&), multiplication operand
+    def initialize(rs, am, mult)
+      @rs, @am, @mult = rs, am, mult
+    end
+    def decompose_component(whole_element)
+      ((whole_element >> @rs) & @am) * @mult
+    end
+    def recompose_component(component)
+      component / @mult << @rs
+    end
+  end
+  @@rgba = [:r, :g, :b, :a].freeze
+  @@orders = {
+    # encoding - {r: DecompInfo(rs, am, mult), g: idem, b: idem, a: idem)}
+    rgba4444: [[12, 0xf, 16], [8, 0xf, 16], [4, 0xf, 16], [0, 0xf, 16]],
+    rgba5551: [[11, 0b11111, 8], [6,0b11111,8], [1, 0b11111, 8], [0,  1, 255]],
+    argb5551: [[10, 0b11111, 8], [5,0b11111,8], [0, 0b11111, 8], [15, 1, 255]],
+    rgba8888: [[24, 0xff, 1], [16, 0xff, 1], [8, 0xff, 1], [0, 0xff, 1]],
+    bgra8888: [[8, 0xff, 1], [16, 0xff, 1], [24, 0xff, 1], [0, 0xff, 1]],
+    argb8888: [[16, 0xff, 1], [8, 0xff, 1], [0, 0xff, 1], [24, 0xff, 1]]
+  }
+  @@orders.each do |encoding,decomp_infos|
+    # if encoding is rgba5551 :
+    # decomp_infos = [[11, 0b11111, 8],...]
+    # encoding = :rgba5551
+
+    @@orders[encoding] = {} # Example : @@orders[:rgba5551] = {}
+
+    # Continuing with the same example :
+    # shift remove the first value of an array and return the removed value
+    #                                            rs,  am,  mult
+    # @@orders[:rgba5551][:r] = DecompInfo.new(*[11,0b11111, 8])
+    # @@orders[:rgba5551][:g] = DecompInfo.new(*[5,0b11111, 8])
+    # ...
+
+    @@rgba.each do |component|
+      component_decomp_infos = decomp_infos.shift
+      @@orders[encoding][component] = DecompInfo.new(*component_decomp_infos)
+    end
+  end
+  def self.handle_format?(format)
+    @@orders.has_key?(format)
+  end
+  def self.handled_formats
+    @@orders.keys
+  end
+  def self.check_infos(infos)
+    if infos.nil?
+      raise ArgumentError, "No valid informations provided about the encoding #{encoding}"
+    end
+  end
+  def self.decode(encoded_color, encoding: nil, infos: @@orders[encoding])
+
+    check_infos(infos)
+
+    @@rgba.map do |component|
+
+      infos[component].decompose_component(encoded_color)
+    end
+  end
+  def self.encode(*rgba_colors, encoding: nil, infos: @@orders[encoding])
+    check_infos(infos)
+
+    color_components = rgba_colors.flatten
+
+    color = 0
+    @@rgba.each do |component|
+      color |= infos[component].recompose_component((color_components.shift))
+    end
+    color
+  end
+  def self.convert_pixels(input_pixels, from:, to:)
+    input_pixels.map do |pixel|
+      Color.encode(Color.decode(pixel, encoding: from), encoding: to)
+    end
+  end
+
+  module BMP
+
+    @@header_offsets = { content_start_address_info: 0xa }.freeze
+    def self.convert_content(filename:, from:, to:)
+      if MyyColor.handle_formats?(from, to)
+        infile = File.open(bmp_file, "r")
+
+        infile.seek(@@header_offsets[:content_start_address_info])
+        start_address, bitmap_header_size, width, height = infile.read(16).unpack("I<4")
+        puts "[Read] width : %d (%x) -- height : %d (%02x)" % [width, width, height, height]
+        puts "[Read] Starting from : 0x%x" % start_address
+
+        infile.seek(start_address)
+
+        input_pixels = infile.read.unpack(formats[input_color_encoding][:unpack])
+
+        infile.close
+
+        output = {
+          content: MyyColor.convert_pixels(input_pixels, from: from, to: to),
+          metadata: {width: width, height: height}
+        }.freeze
+
+        puts "Encoded pixels : %d - By width : %d" % [output[:content].length, output[:content].length/width]
+
+        output
+      else
+        raise ArgumentError, <<-error.strip.gsub(/\s+/, ' ')
+          One of these formats is not supported by MyyColor :
+          #{from} - #{to}
+          Supported formats :
+          #{MyyColor.handled_formats.join('\n')}
+        error
+      end
+    end
+  end
+
+  module OpenGL
+
+    module GL
+      UNSIGNED_BYTE = 0x1401
+      RGBA = 0x1908
+      UNSIGNED_SHORT_5_5_5_1 = 0x8034
+      UNSIGNED_SHORT_4_4_4_4 = 0x8033
+    end
+
+    @@formats = {
+      rgba5551: {headers: [GL::RGBA, GL::UNSIGNED_SHORT_5_5_5_1],
+                 unpack: "S<*", pack: "S<*"},
+      rgba4444: {headers: [GL::RGBA, GL::UNSIGNED_SHORT_4_4_4_4],
+                 unpack: "S<*", pack: "S<*"},
+      rgba8888: {headers: [GL::RGBA, GL::UNSIGNED_BYTE],
+                 unpack: "I<*", pack: "I>*"},
+      argb8888: {headers: [GL::RGBA, GL::UNSIGNED_BYTE],
+                 unpack: "I<*", pack: "I>*"}
+    }
+
+    def convert_bmp(bmp_filename:, raw_filename:, from:, to:)
+      raw = MyyColor::BMP.convert_content(filename: bmp_filename,
+                                          from: from.to_sym, to: to.to_sym)
+      output_format = @@formats[to.to_sym]
+      metadata = [raw[:metadata][:width], raw[:metadata][:height]] +
+        output_format[:headers]
+
+      File.open(raw_filename, "w") do |out|
+        out.write(metadata.pack("I<*"))
+        out.write(raw[:content].flatten.pack(output_format[:pack]))
+      end
+    end
+  end
+end

data/myy-color.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "myy-color"
+  s.version = "0.0.1"
+  s.authors = ["Myy"]
+  s.email = ["color@miouyouyou.fr"]
+  s.homepage = "https://github.com/Miouyouyou/myy-color"
+  s.summary = "a basic RGBA decoder/encoder"
+  s.description = <<-desc.strip.gsub(/\s+/, ' ')
+    MyyColor provides basic color encoding and decoding facilities,
+    which are mainly used for converting BMP to OpenGL raw texture
+    format.
+  desc
+  s.rubyforge_project = "myy-color"
+  s.files = Dir['LICENSE', 'README', 'CHANGES', 'myy-color.gemspec', 'lib/**', 'bin/myy_bmp2raw']
+  s.executables = %w(myy_bmp2raw)
+  s.license = 'MIT'
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: myy-color
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Myy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-11 00:00:00.000000000 Z
+dependencies: []
+description: MyyColor provides basic color encoding and decoding facilities, which
+  are mainly used for converting BMP to OpenGL raw texture format.
+email:
+- color@miouyouyou.fr
+executables:
+- myy_bmp2raw
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGES
+- LICENSE
+- bin/myy_bmp2raw
+- lib/myy-color.rb
+- lib/myy-color.rb~
+- myy-color.gemspec
+homepage: https://github.com/Miouyouyou/myy-color
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: myy-color
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: a basic RGBA decoder/encoder
+test_files: []