vissen-output 0.6.1

data/lib/vissen/output/pixel_buffer.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Output
+    # The pixel buffer is an implementation of the general `Buffer` module that
+    # places `Pixel` objects in each buffer element.
+    class PixelBuffer
+      include Buffer
+
+      # @!method pixels
+      # @return [Pixel] the pixels in the buffer.
+      alias pixels elements
+
+      # @raise  [ContextError] if any of the filters does not share the same
+      #   context.
+      #
+      # @param  context [Context] the context in which the pixel buffer exists.
+      # @param  filters [Array<Filter>] the output filters to apply when
+      #   finalizing the buffer.
+      def initialize(context, filters = [])
+        super context, Pixel
+        # Verify that all filters share the same context
+        # before adding them.
+        filters.each { |f| raise ContextError unless share_context? f }
+        @filters = filters
+
+        freeze
+      end
+
+      # Prevent any more filters from being added.
+      #
+      # @return [self]
+      def freeze
+        @filters.freeze
+        super
+      end
+
+      # Zeros the RGB components of each pixel in the buffer.
+      def clear!
+        pixels.each(&:clear!)
+      end
+
+      # Replaces the pixel values of this buffer with those of the given object.
+      #
+      # @raise  [TypeError] if the other object is not a PixelBuffer.
+      #
+      # @param  other [PixelBuffer] the pixel buffer to copy values from.
+      def copy!(other)
+        raise TypeError unless other.is_a? self.class
+
+        other.each_with_index do |src_pixel, index|
+          dst_pixel = pixels[index]
+
+          dst_pixel.r = src_pixel.r
+          dst_pixel.g = src_pixel.g
+          dst_pixel.b = src_pixel.b
+        end
+      end
+
+      # Signals to the `PixelBuffer` that the user is done updating the color
+      # values and that the buffer should perform any post processing that is
+      # needed.
+      #
+      # @return [self]
+      def finalize!
+        @filters.each { |filter| filter.apply self }
+        self
+      end
+    end
+  end
+end

data/lib/vissen/output/point.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Output
+    # Points are simple two dimensional coordinates with an x and y component.
+    # They are used by the `CloudContext` to keep track of the position of its
+    # points.
+    class Point
+      # @return [Array<Float>] an array containing the x and y coordinates of
+      #   the point.
+      attr_reader :position
+
+      alias to_a position
+
+      # @param  x [Numeric] the x coordinate of the point.
+      # @param  y [Numeric] the y coordinate of the point.
+      # @param  scale [Numeric] a scale factor to apply to the coordinates.
+      def initialize(x, y, scale: 1.0)
+        @position = [x * scale, y * scale]
+      end
+
+      # @return [Float] the x coordinate of the point.
+      def x
+        @position[0]
+      end
+
+      # @return [Float] the y coordinate of the point.
+      def y
+        @position[1]
+      end
+
+      # Prevents the position from being changed.
+      #
+      # @return [self]
+      def freeze
+        @position.freeze
+        super
+      end
+
+      # @return [String] a string representation of the point.
+      def inspect
+        format('(%0.2f,%0.2f)', *@position)
+      end
+
+      class << self
+        # Coerce objects into points.
+        #
+        # @param  obj [#to_a] the object to be coerced into a `Point`.
+        # @param  args (see #initialize)
+        # @return [Point] a new `Point` object.
+        def from(obj, **args)
+          new(*obj.to_a, **args)
+        end
+      end
+    end
+  end
+end

data/lib/vissen/output/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Output
+    # The Vissen Output library version number.
+    VERSION = '0.6.1'
+  end
+end

data/lib/vissen/output/vixel.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Output
+    # The `Vixel` (Vissen pixel) represents the two dimensional representation
+    # of each grid pixel, for each grid. Each vixel has an intensity (i) and a
+    # palette position (p), both with values in the range 0..1.
+    #
+    # TODO: How do we want the vixel to saturate? When written or when read?
+    class Vixel
+      # @return [Float] the vixel intensity.
+      attr_reader :i
+
+      # @return [Float] the vixel palette position.
+      attr_reader :p
+
+      # @param  i [Numeric] the vixel intensity.
+      # @param  p [Numeric] the vixel palette position.
+      def initialize(i = 0.0, p = 0.0)
+        self.i = i
+        self.p = p
+      end
+
+      # @param  other [Object] the object to check equality against.
+      # @return [true,false] true if the other object has the same intensity and
+      #   palette position.
+      def ==(other)
+        @i == other.i && @p == other.p
+      rescue NoMethodError
+        false
+      end
+
+      # @param  value [Numeric] the new intensity value.
+      # @return [Float] the truncated intensity value.
+      def i=(value)
+        @i = self.class.truncate value
+      end
+
+      # @param  value [Numeric] the new palette position.
+      # @return [Float] the truncated palette position.
+      def p=(value)
+        @p = self.class.truncate value
+      end
+
+      # @return [String] a string representation of the vixel.
+      def inspect
+        format '(%.1f, %.1f)', @i, @p
+      end
+
+      class << self
+        # Makes sure n is in the range 0..1.
+        #
+        # @param  n [Numeric] the value to truncate.
+        # @return [Float] n truncated to fit within the range 0..1.
+        def truncate(n)
+          if n <= 0    then 0.0
+          elsif n >= 1 then 1.0
+          else              n
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vissen/output/vixel_buffer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Output
+    # Vixel Buffer
+    #
+    # TODO: Document this class.
+    class VixelBuffer
+      include Buffer
+
+      # @return [Float] the global intensity of the buffer.
+      attr_accessor :intensity
+
+      # @return [Integer] the palette number currently in use.
+      attr_accessor :palette
+
+      # @!method vixels
+      # @return [Array<Vixel>] an array with the `Vixel` objects in the buffer.
+      alias vixels elements
+
+      # @param  context [Context] the context in which the buffer exists.
+      # @param  palette [Integer] the palette number to use when rendering.
+      # @param  intensity [Numeric] the global intensity at which to render.
+      def initialize(context, palette: 0, intensity: 1.0)
+        super(context, Vixel)
+
+        @palette   = palette
+        @intensity = intensity
+      end
+
+      # Render the layer vixels to the given buffer.
+      #
+      # @param  buffer [PixelBuffer] the buffer to store the resulting colors of
+      #   each point in.
+      # @param  intensity [Numeric] the intensity to scale the vixels intensity
+      #   with.
+      # @return [PixelBuffer] the same buffer that was given as a parameter.
+      def render(buffer, intensity: 1.0)
+        palette = context.palettes[@palette]
+        buffer.each_with_index do |color, index|
+          vixel = vixels[index]
+          next unless vixel.i.positive?
+
+          ratio = vixel.i * intensity * @intensity
+          color.mix_with! palette[vixel.p], ratio
+        end
+        buffer
+      end
+
+      # @return [Integer] the number of vixels in the buffer.
+      def vixel_count
+        vixels.length
+      end
+    end
+  end
+end

data/lib/vissen/output/vixel_stack.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Vissen
+  module Output
+    # Stack
+    #
+    # TODO: Document this class.
+    class VixelStack
+      extend Forwardable
+
+      # @return [Array<VixelBuffer>] the layers that make up the stack.
+      attr_reader :layers
+
+      # @return [Context] the context in which the stack exist.
+      attr_reader :context
+
+      # @!method point_count
+      # @return [Integer] the number of points in each layer of the stack.
+      def_delegators :@context, :point_count
+
+      alias vixel_count point_count
+
+      # TODO: Make palettes a keyword argument in the next minor version.
+      #
+      # @raise  [RangeError] if layer_count <= 0.
+      #
+      # @param  context [Context] the context in which the stack exist.
+      # @param  layer_count [Integer] the number of layers in the stack.
+      def initialize(context, layer_count)
+        raise RangeError if layer_count <= 0
+
+        @context = context
+        @layers  = Array.new(layer_count) { VixelBuffer.new context }
+
+        freeze
+      end
+
+      # Prevents more layers and palettes from being added.
+      #
+      # @return [self]
+      def freeze
+        @layers.freeze
+        super
+      end
+
+      # Accesses a vixel in one of the vixelbuffers stored in the stack.
+      #
+      # @param  layer [Integer] the index of the layer that is accessed.
+      # @param  args (see VixelBuffer#[])
+      # @return [Vixel,nil] the vixel at the given layer.
+      def [](layer, *args)
+        @layers[layer][*args]
+      end
+
+      # @return [PixelBuffer] a new, uninitialized pixel buffer.
+      def pixel_buffer
+        PixelBuffer.new context
+      end
+
+      # Renders each layer and combines the result in the given buffer.
+      #
+      # TODO: Could we cache the result of this operation at time t to an
+      #       internal PixelGrid and copy the stored information for subsequent
+      #       requests at or around the same time?
+      #
+      # @raise  [ContextError] if the pixel buffer does not share the same
+      #   context.
+      #
+      # @param  pixel_buffer [PixelBuffer] the buffer to store the resulting
+      #   colors of each point in.
+      # @param  intensity [Numeric] the intensity to scale the vixels intensity
+      #   with.
+      # @return [PixelBuffer] the same buffer that was given as a parameter.
+      def render(pixel_buffer, intensity: 1.0)
+        raise ContextError unless context == pixel_buffer.context
+
+        pixel_buffer.clear!
+
+        @layers.reduce(pixel_buffer) do |a, e|
+          e.render a, intensity: intensity
+        end
+
+        pixel_buffer.finalize!
+      end
+    end
+  end
+end

data/lib/vissen/output.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'vissen/output/version'
+
+require 'vissen/output/error'
+require 'vissen/output/context_error'
+require 'vissen/output/color'
+require 'vissen/output/filter'
+require 'vissen/output/filter/quantizer'
+require 'vissen/output/filter/gamma'
+require 'vissen/output/pixel'
+require 'vissen/output/point'
+require 'vissen/output/vixel'
+require 'vissen/output/palette'
+require 'vissen/output/palettes'
+require 'vissen/output/buffer'
+require 'vissen/output/context'
+require 'vissen/output/context/cloud'
+require 'vissen/output/context/circle'
+require 'vissen/output/context/grid'
+require 'vissen/output/pixel_buffer'
+require 'vissen/output/vixel_buffer'
+require 'vissen/output/vixel_stack'
+
+module Vissen
+  # The main job of the output module is to transform a multi layered collection
+  # of `Vixel` objects, a `VixelBuffer`, into a single layered collection of
+  # `Pixel`objects, a `PixelBuffer`.
+  module Output
+  end
+end

data/vissen-output.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vissen/output/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vissen-output'
+  spec.version       = Vissen::Output::VERSION
+  spec.authors       = ['Sebastian Lindberg']
+  spec.email         = ['seb.lindberg@gmail.com']
+
+  spec.summary       = 'The output interface of the vissen system.'
+  spec.description   = 'The output module implements all the objects and ' \
+                       'facilities used to talk to vissen sinks.'
+  spec.homepage      = 'https://github.com/midi-visualizer/vissen-output'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: vissen-output
+version: !ruby/object:Gem::Version
+  version: 0.6.1
+platform: ruby
+authors:
+- Sebastian Lindberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: The output module implements all the objects and facilities used to talk
+  to vissen sinks.
+email:
+- seb.lindberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vissen/output.rb
+- lib/vissen/output/buffer.rb
+- lib/vissen/output/color.rb
+- lib/vissen/output/context.rb
+- lib/vissen/output/context/circle.rb
+- lib/vissen/output/context/cloud.rb
+- lib/vissen/output/context/grid.rb
+- lib/vissen/output/context_error.rb
+- lib/vissen/output/error.rb
+- lib/vissen/output/filter.rb
+- lib/vissen/output/filter/gamma.rb
+- lib/vissen/output/filter/quantizer.rb
+- lib/vissen/output/palette.rb
+- lib/vissen/output/palettes.rb
+- lib/vissen/output/pixel.rb
+- lib/vissen/output/pixel_buffer.rb
+- lib/vissen/output/point.rb
+- lib/vissen/output/version.rb
+- lib/vissen/output/vixel.rb
+- lib/vissen/output/vixel_buffer.rb
+- lib/vissen/output/vixel_stack.rb
+- vissen-output.gemspec
+homepage: https://github.com/midi-visualizer/vissen-output
+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: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: The output interface of the vissen system.
+test_files: []