klear 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d30b3fc67cb36ded1634f501d04b595d2b4fbd
-  data.tar.gz: 3c5ff4f6e7e861938787ca00c6dc14ae9ddde8e9
+  metadata.gz: 2ce4d5cdafe23e6dff8a591fbb74ab16316acff8
+  data.tar.gz: db86b996953818cadb54ae3217a6d911b097d83a
 SHA512:
-  metadata.gz: d5a97de9e79d49d94a7b0b4b5aaf82ea7cbfec08469f865e1efb5e532367837b3ffca36283a92eb4fd2516152687acd0de5a1ee4a9c65bd5901a8918ee4b45d3
-  data.tar.gz: f77483348a71ac19d7a4576fc8910d30384273ce98cb0fcf175c9ed71ed933ad292e8609a220da47878be5cbaa9e4217f7be32fcea76fa4c2e825cdf85a4427a
+  metadata.gz: 996c00baae0b8081d085affe62d9d0b07e460148d01698fec8365e0e5be65d8e4699947cfbe7c2018c8cea23a6f3217b8732444db9cf5ffa6598e9cd801a4c66
+  data.tar.gz: 44b5b2ad67c6db67bc7fdf9590064a9f3e506a9612c15c0711b0ee15a4fbdaf62148104b85bde55f1d2d35eb534acda1ea259d87a635d8bb46dc54f5af8c80e5

data/README.md

@@ -1,63 +1,77 @@
-# Kinetic Light Engine Archive - klear
+# klear: Kinetic Light Engine Archive file format and CLI utitlies
 
-Create and manage choreographies for motors and lights on the Manta Rhei. This
-document describes the Kinetic Light Engine File Format which contains
-Choreographies and all data needed for playing it.
+The *klear* gem includes library code and the `klear` command line utility to
+create and manage the choreographies for motors and/or lights in kinetic
+installations. It was originally developed as part of the [Manta Rhei
+project][1] but is now extraced for generic use.  
 
-To understand what this is all about please check the Manta Rhei project page:
+[1]: http://www.artcom.de/en/projects/project/detail/manta-rhei/
 
- - http://www.artcom.de/en/projects/project/detail/manta-rhei/
+This document describes the Kinetic Light Engine File Format which contains
+Choreographies and all data needed for playing it.
 
-This gem now is the starting point for refactoring the Manta Rhei code. The klear repo will contain all code for handling the actual content. Running the stepper motors or driving the OLEDs or DMX is part of the kinetic-light-engine which goes online soon.
+*(background: The gem is the starting point for refactoring the Manta Rhei
+code. The repo contains all code for handling the actual content while running
+the stepper motors or driving the OLEDs or DMX is part of the
+kinetic-light-engine.)*
 
-## File info 
+## File Format
 
-    $ klear info choreo.kle
+Files of this format should have the file extension `.kle`, e.g.
+"calm_05.kle".
 
-dumps archive content info to stdout.
- 
-## New File Generation
+### Layout and container Structure
 
-*Notice: file generation depends on jruby because of its usage of Java JAI*
+A .kle File contains multiple assets, incl. source PNGs, metatdata and a
+derived binary file containing frames in packed binary form. The Container
+Format is ZIP so a .kle file is just a zip-file containing files and folders.
+
+**Directory Layout**
+
++ *DIR* 'META-INF' (mandatory)
+    + 'kle.yml', YAML file containing meta-data describing aspects like framerate & more
+    + 'MANIFEST.MF' containing meta-data about the klear file itself (e.g.
+      format version)
++ *DIR* 'frames' (mandatory)
+    + Source PNGs files which were used to generate the kle
++ *DIR* cache' (optional)
+    + 'frames.bin', binary file containing data derived from the PNGs during
+      creation
+    + further pre-processed data or application state for optimized restarts
+      might be stored here.
++ *DIR* 'icon'
+    + 'normal.png', PNG file for a normal sized icon (150 x 110 px)
 
-Klear files are zipped directory structures which are generated from a set of images. The pixel values directly map to motor position and light intensity. On top of that, the klear file contains some additional meta info and cache date to speed up its loading at runtime. Generating a klear file from a images sequence in a directory goes like:
+### Workflow
 
-    $ rvm jruby exec ./bin/klear.rb generate image_sequence_dir outfile.kle
-    
-and of course, more documentation needs to come (means must be converted from the internal wiki to here).
+The initial source of a kle is a sequence of PNGs + metadata. Those are used to generate a .kle file incl. the file 'frames.bin'. The metadata is stored in 'META-INF/kle.yml' and describes aspects like fps.
 
-## FileFormat
+If a kle file does not have frame.bin in its cache directory it can be regenerated. This is also useful for future format changes together with the manifest to detect if a frames.bin is deprecated and needs to be regenerated.
 
-File of this format have the file extension "kle", e.g. "calm_05.kle"
+The source sequence of PNGs is stored in the KLE-file as well, which allows features like frames.bin regeneration in the first place.
 
-### Layout and container Structure
+## Command Line Usage
 
-A .kle File contains multiple assets, incl. source PNGs, metatdata and a derived binary file containing frames in packed binary form. The Container Format is ZIP so a .kle file is just a zip-file containing files and folders.
+**File info**
 
-*Directory Layout*
+    $ klear info choreo.kle
 
-* Directory 'META-INF' (mandatory)
- * 'kle.yml' containing meta-data describing aspects like framerate & more
- * 'MANIFEST.MF' containing meta-data about the kle file itself (e.g. format version)
-* Directory 'frames' (mandatory)
- * Source PNGs which were used to generate the kle
-* Directory 'cache' (optional)
- * File 'frames.bin' containing binary data derived from the PNGs during creation
- * further pre-processed data or application state for optimized restarts might be stored here.
-* Directory 'icon'
- * contains one file 'normal.png' for a normal sized icon (150 x 110 px)
+dumps archive content info to stdout.
+ 
+**New File Generation**
 
-### Workflow
+*Notice: file generation depends on jruby because of its usage of Java JAI*
 
-The initial source of a kle is a sequence of PNGs + metadata. Those are used to generate a .kle file incl. the file 'frames.bin'. The metadata is stored in 'META-INF/kle.yml' and describes aspects like fps.
+Klear files are zipped directory structures which are generated from a set of images. The pixel values directly map to motor position and light intensity. On top of that, the klear file contains some additional meta info and cache date to speed up its loading at runtime. Generating a klear file from a images sequence in a directory goes like:
 
-If a kle file does not have frame.bin in its cache directory it can be regenerated. This is also useful for future format changes together with the manifest to detect if a frames.bin is deprecated and needs to be regenerated.
+    $ rvm jruby exec ./bin/klear.rb generate image_sequence_dir outfile.kle
+    
+and of course, more documentation needs to come (means must be converted from the internal wiki to here).
 
-The source sequence of PNGs is stored in the KLE-file as well, which allows features like frames.bin regeneration in the first place.
 
-### File Format Details
+## File Format Details
 
-#### PNGs
+### PNGs
 
 Each single PNG represents exactly one frame and is stored with 16-bit / channel. The size of the PNGs is determined by the number of columns and rows, where each tile is 10px x 10px in size. A Column represents the state of a blade at a frame (a certain point in time). The number of columns represents the number of blades. A Row represents one aspect across all blades, e.g. an outermost light or the state of the motor.
 
@@ -65,12 +79,13 @@ Each single PNG represents exactly one frame and is stored with 16-bit / channel
 
 !Waves_00129.png!
 
- * We have 11 rows and 14 columns (blades)
- * The lowest row describes the motor state
- * The other rows describe the state of the lights from one direction to the other (TODO: Define the direction - what is a point of reference?)
- * The Png then is 140x110px in size.
+* We have 11 rows and 14 columns (blades)
+* The lowest row describes the motor state
+* The other rows describe the state of the lights from one direction to the other (TODO:
+  Define the direction - what is a point of reference?)
+* The Png then is 140x110px in size.
 
-#### Sequence of PNGs
+### Sequence of PNGs
 
 The order of the sequence is defined by the sorting delivered by the Posix command `sort -n`. So any natural alphabetical naming to order the sequence is allowed.
 
@@ -78,12 +93,12 @@ The number of columns and rows must be the same for all PNGs.
 
 *Examples*
 
- * `A.png, B.png, X.png` is valid sequence of 3 PNGs
- * `Test_0001.png, Test_0002.png, Test__1000.png` is a valid sequence
+* `A.png, B.png, X.png` is valid sequence of 3 PNGs
+* `Test_0001.png, Test_0002.png, Test__1000.png` is a valid sequence
 
 A sequence does not need to be consecutive (it can have gaps e.g. `01.png,10.png` is valid and the existence of e.g. 05.png is not enforced).
 
-#### kle.yml
+### kle.yml
 
 Contains information about how to use the frames:
 
@@ -104,7 +119,7 @@ The geometry is determined automatically by reading the first png in the png seq
  fps: 25
 </pre>
 
-#### MANIFEST.MF
+### MANIFEST.MF
 
 The manifest contains meta information about the file and file format itself:
 
@@ -121,9 +136,9 @@ Kle-Version: 1.0
 Created-By: ruby-kle-generator 0.344b
 </pre>
 
-#### frames.bin
+### frames.bin
 
-The frames.bin file contains the extracted 16-bit values sampled from each tile of the PNGs. It contains all frames and each frame contains all columns and rows.
+The frames.bin binary file contains the extracted 16-bit values sampled from each tile of the PNGs. It contains all frames and each frame contains all columns and rows.
 
 Each 16-bit value is saved as unsigned 16 bit integer big endian (network byte order) and uses 2 bytes in frames.bin.
 

data/bin/klear

@@ -9,7 +9,7 @@ require 'klear'
 
 def usage
   puts <<HELP
-klear usage
+klear usage (version: #{Klear::VERSION} - #{Klear::DATE})
 
   klear --help
     * this help

data/lib/klear/file_generator.rb

@@ -3,25 +3,34 @@
 
 class Klear::FileGenerator
   
+  Defaults = {
+    overwrite: false, 
+  }
+
   def initialize options = {}
+    @options = Defaults.merge(options)
     @png_path = nil
     @kle_path = nil
     @fps = 25
-    if options.has_key? :fps
-      @fps = options[:fps]
+    if @options.has_key? :fps
+      @fps = @options[:fps]
     end
     @gamma = 1.0
-    if options.has_key? :gamma
-      @gamma = options[:gamma]
+    if @options.has_key? :gamma
+      @gamma = @options[:gamma]
     end
     @geometry = nil
     @raw_frame_values = []
     @kle_file = nil
     @silent = true
-    if options.has_key? :silent
-      @silent = !!options[:silent]
+    if @options.has_key? :silent
+      @silent = !!@options[:silent]
     end
   end
+
+  def overwrite?
+    @options[:overwrite]
+  end
   
   def load
     Zip::ZipFile.open(@kle_path) { |kle|
@@ -30,15 +39,15 @@ class Klear::FileGenerator
   end
   
   def write
-    Zip::ZipFile.open(@kle_path, Zip::ZipFile::CREATE) { |kle|
+    Zip::ZipFile.open(@kle_path, Zip::ZipFile::CREATE) do |kle|
       @kle_file = kle
       add_pngs
       regenerate_cache
       
       # Meta
       kle.mkdir('META-INF')
-      kle.file.open("META-INF/MANIFEST.MF", "w") do |os|
-        os.write <<-MANIFEST
+      kle.file.open("META-INF/MANIFEST.MF", "w") do |fd|
+        fd.write <<-MANIFEST
 Manifest-Version: 1.0
 
 Kle-Version: 1.0
@@ -47,21 +56,26 @@ Generated-At: #{Time.now}
 
         MANIFEST
       end
-      kle.file.open("META-INF/kle.yml", "w") { |os|
-        os.write({
+
+      kle.file.open("META-INF/kle.yml", "w") do |fd|
+        fd.write({
           "geometry"    => @geometry,
           "gamma"       => @gamma,
           "fps"         => @fps
         }.to_yaml)
-      }
-    }
+      end
+    end
   end
   
   def generate thePngPath, theKleFile
     @png_path = thePngPath
     @kle_path = theKleFile
-    if File.exists? @kle_path
-      raise "File #{@kle_path} already exists"
+    if (File.exists? @kle_path) 
+      if overwrite?
+        FileUtils.rm(@kle_path, force: true)
+      else
+        raise "'#{@kle_path}' :: already exists! (use --overwrite to force it)"
+      end
     end
     write
     report

data/lib/klear/version.rb

@@ -1,4 +1,4 @@
 module Klear
-  VERSION = '0.1.3'
-  DATE    = '2013-08-07'
+  VERSION = '0.1.4'
+  DATE    = '2013-11-12'
 end

data/spec/lib/klear/file_generator_spec.rb

@@ -4,6 +4,14 @@ require 'fileutils'
 
 describe Klear::FileGenerator do
   if RUBY_PLATFORM.match /java/i
+
+    context 'default options' do
+      let(:fg) { Klear::FileGenerator.new }
+      it 'defaults to not overwrite' do 
+        expect(fg.overwrite?).to be(false)
+      end
+    end
+
   
     it "reads a directory with pngs and produces a valid kle file" do
       fg = Klear::FileGenerator.new :fps => 33, :gamma => 2.4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klear
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - art+com/dirk luesebrink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: applix