whirled_peas 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16dc58df5e4b6dbb2bdf51d95841d02bc9172f1e116efd8afd0633df592a7c8e
-  data.tar.gz: 0a2a14b167b502954a9ec2e58d762b32b60a2ab62e136d976b7d1d70e5630189
+  metadata.gz: 1c57dd3e70f4d79c41731d220f9cb3f7fec0a3e554a715f7da556dec5e0a5cde
+  data.tar.gz: 736d62121796101237e9aaa4fc5f37b0fe59f6d8c7670b149e63e0faf0ff9f3e
 SHA512:
-  metadata.gz: 94d96284d6b3201496456fad7b464f3b71ab02c51878817e81856331fa3cb763a36383198ffe2be31f2e9747580656cb13a587b630f4f5866cd40340c1617744
-  data.tar.gz: 51e6271630fda2450af38f59f9c8d888b2b9338efacb6f8c7664393b1fdea8e616f00e20eec47b8bba59c25db510cade9a359119e06d02f8ac9c8de79f372664
+  metadata.gz: 1823dc0eba84af3a78992c349c1d922bfd7837452133a0e1b6e35de2fe1d94ad589b0eda8cf5c7a70ae41ec92345ef8dcde6c2e0eeb63193de806582a5d2578a
+  data.tar.gz: d10d355b30e2cc1a0cc15413c5681b04135ec7f53a2e20e9a4ea307a8ae9bd0b69fb04cacb494dcfee8b7a9d473ae852173d140a708d1bb04210084f824acd99

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.12.0- 2021-01-31
+
+- [f218ed5](https://github.com/tcollier/whirled_peas/tree/f218ed5a8bbc20fc332a42ad9720467784a916e2): Optimize rendered frames
+
 ## v0.11.1 - 2021-01-31
 
 - [36e48cf](https://github.com/tcollier/whirled_peas/tree/36e48cf6731706539c6c41ce0ef66e86c62380a5): Add highlight colors and border style to theme

data/doc/components.md

@@ -33,8 +33,6 @@ This component takes the following options
 
 #### Optional
 
-- `active_bg_color` - background color of the active item
-- `active_color` - text color of the active item
 - `flow` - `:l2r` or `:t2b`
 - `separator` - string used to separate items in the list, e.g. `", "` for a horizontal list or `"----"` for a vertical list
 - `viewport_size` - number of characters of the viewport in the flow direction
@@ -48,8 +46,6 @@ WhirledPeas.template do |composer, settings|
     component.separator = ', '
     component.active_index = active
     component.viewport_size = 27
-    component.active_color = :blue
-    component.active_bg_color = :bright_yellow
   end
 end
 ```

data/doc/themes.md

@@ -13,3 +13,38 @@ end
 ```
 
 Theme settings will be used as default settings throughout the template, however theme settings can be overridden on any element.
+
+### Theme Settings
+
+The following theme settings override the existing default settings for all elements.
+
+- `axis_color` - axis color for graphs (defaults to `border_color`)
+- `bg_color` - background color (defaults to system color)
+- `border_color` - border color (defaults to `color`)
+- `border_style` - border style (defaults to `bold`)
+- `color` - text color (defaults to system color)
+
+The following theme settings provide new options that can be applied to existing settings. E.g.
+
+```ruby
+WhirledPeas.register_theme(:my_theme) do |theme|
+  theme.highlight_bg_color = :bright_white
+  theme.highlight_color = :red
+  # ...
+end
+
+WhirledPeas.template(:my_theme) do |composer, settings|
+  # ...
+  composer.add_text do |composer, settings|
+    composer.bg_color = :highlight
+    composer.color = :highlight
+    "This Is Important!!!"
+  end
+end
+```
+
+- `highlight_bg_color` - provides a new `:highlight` option that can be applied to `bg_color` settings (defaults to `color`)
+- `highlight_color` - provides a new `:highlight` option that can be applied to `color` settings (defaults to `bg_color`)
+- `title_font` - provides a new `:theme` option that can be applied to `title_font` settings (defaults to system default)
+
+Note: the defaults for the `highlight_bg_color` and `highlight_color` options result in inverting the background and text colors.

data/examples/components.rb

@@ -13,8 +13,6 @@ class TemplateFactory
         component.separator = ', '
         component.active_index = active
         component.viewport_size = 27
-        component.active_color = :green
-        component.active_bg_color = :yellow
       end
     end
   end
@@ -23,9 +21,9 @@ end
 class Application
   def start(producer)
     producer.frameset(5, easing: :parametric) do |fs|
-      ITEMS.length.times { |i| fs.add_frame('intro', args: { active: i }) }
+      TemplateFactory::ITEMS.length.times { |i| fs.add_frame('intro', args: { active: i }) }
     end
-    producer.add_frame('hold', duration: 1, args: { active: ITEMS.length - 1 })
+    producer.add_frame('hold', duration: 1, args: { active: TemplateFactory::ITEMS.length - 1 })
   end
 end
 

data/examples/graph.rb

@@ -32,7 +32,7 @@ class TemplateFactory
               settings.color = :bright_blue
               settings.height = 15
               INNER_WIDTH.times.map do |i|
-                easing.ease(i.to_f / (INNER_WIDTH - 1))
+                easing.invert(i.to_f / (INNER_WIDTH - 1))
               end
             end
           end

data/lib/whirled_peas/animator/debug_consumer.rb

@@ -4,8 +4,8 @@ module WhirledPeas
       def add_frameset(frameset)
         require 'json'
 
-        frameset.each_frame do |frame, args|
-          puts [frame, *(JSON.generate(args) unless args.empty?)].join(' ')
+        frameset.each_frame do |frame, duration, args|
+          puts [frame, "duration=#{duration}", *(JSON.generate(args) unless args.empty?)].join(' ')
         end
       end
 

data/lib/whirled_peas/animator/easing.rb

@@ -21,6 +21,10 @@ module WhirledPeas
 
       EFFECTS = %i[in out in_out]
 
+      INVERSE_MAX_ITERATIONS = 10
+      INVERSE_DELTA = 0.0001
+      INVERSE_EPSILON = 0.00001
+
       def initialize(easing=:linear, effect=:in_out)
         unless EASING.key?(easing)
           raise ArgumentError,
@@ -45,6 +49,56 @@ module WhirledPeas
         end
       end
 
+      def invert(target)
+        ease_fn = case effect
+        when :in
+          proc { |v| ease_in(v) }
+        when :out
+          proc { |v| ease_out(v) }
+        else
+          proc { |v| ease_in_out(v) }
+        end
+
+        # Use Newton's method(!!) to find the inverse values of the easing function for the
+        # specified target. Make an initial guess that is equal to the target and see how
+        # far off the eased value is from the target. If we are close enough (as dictated by
+        # INVERSE_EPSILON constant), then we return our guess. If we aren't close enough, then
+        # find the slope of the eased line (approximated with a small step of INVERSE_DELTA
+        # along the x-axis). The intersection of the slope and target will give us the value
+        # of our next guess.
+        #
+        # Since most easing functions only vary slightly from the identity line (y = x), we
+        # can typically get the eased guess within epsilon of the target in a few iterations,
+        # however only iterate at most INVERSE_MAX_ITERATIONS times.
+        #
+        #         ┃                     ......
+        #         ┃                  ...
+        # target -┃------------+  ...
+        #         ┃          /.|..
+        #         ┃      ../.  |
+        #         ┃   ...  |   |
+        #         ┃...     |   |
+        #         ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━
+        #                  |   |
+        #              guess   next guess
+        #
+        # IMPORTANT: This method only works well for monotonic easing functions
+
+        # Pick the target as the first guess. For targets of 0 and 1 (and 0.5 for ease_in_out),
+        # this guess will be the exact value that yields the target. For other values, the
+        # eased guess will generally be close to the target.
+        guess = target
+        INVERSE_MAX_ITERATIONS.times do |i|
+          eased_guess = ease_fn.call(guess)
+          error = eased_guess - target
+          break if error.abs < INVERSE_EPSILON
+          next_eased_guess = ease_fn.call(guess + INVERSE_DELTA)
+          delta_eased = next_eased_guess - eased_guess
+          guess -= INVERSE_DELTA * error / delta_eased
+        end
+        guess
+      end
+
       private
 
       attr_reader :easing, :effect
@@ -60,6 +114,9 @@ module WhirledPeas
         1 - EASING[easing].call(1 - value)
       end
 
+      # Ease in/ease out
+      #
+      # @see https://www.youtube.com/watch?v=5WPbqYoz9HA
       def ease_in_out(value)
         if value < 0.5
           ease_in(value * 2) / 2

data/lib/whirled_peas/animator/frameset.rb

@@ -4,8 +4,8 @@ require_relative 'frame'
 module WhirledPeas
   module Animator
     class Frameset
-      def initialize(frame_slots, easing, effect)
-        @frame_slots = frame_slots
+      def initialize(duration, easing, effect)
+        @duration = duration
         @easing = Easing.new(easing, effect)
         @frames = []
       end
@@ -16,17 +16,22 @@ module WhirledPeas
 
       # Yield each frame in an "eased" order
       def each_frame(&block)
-        frame_slots.times do |i|
-          input = i.to_f / (frame_slots - 1)
-          eased_value = @easing.ease(input)
-          index = (eased_value * (frames.length - 1)).floor
-          yield *frames[index]
+        return if frames.length == 0
+        if frames.length == 1
+          frame, args = frames[0]
+          yield frame, duration, args
+        else
+          frames.each.with_index do |(frame, args), index|
+            curr_ease = @easing.invert(index.to_f / frames.length)
+            next_ease = @easing.invert((index + 1).to_f / frames.length)
+            yield frame, duration * (next_ease - curr_ease), args
+          end
         end
       end
 
       private
 
-      attr_reader :frame_slots, :easing, :frames
+      attr_reader :duration, :easing, :frames
     end
     private_constant :Frameset
   end

data/lib/whirled_peas/animator/producer.rb

@@ -4,32 +4,31 @@ require_relative 'frameset'
 module WhirledPeas
   module Animator
     class Producer
-      def self.produce(consumer, refresh_rate)
-        producer = new(consumer, refresh_rate)
+      def self.produce(consumer)
+        producer = new(consumer)
         yield producer
         consumer.process
       end
 
-      def initialize(consumer, refresh_rate)
+      def initialize(consumer)
         @consumer = consumer
-        @refresh_rate = refresh_rate
       end
 
-      def add_frame(name, duration: nil, args: {})
-        frameset(duration || 1 / refresh_rate) do |fs|
+      def add_frame(name, duration:, args: {})
+        frameset(duration) do |fs|
           fs.add_frame(name, args: args)
         end
       end
 
       def frameset(duration, easing: :linear, effect: :in_out, &block)
-        fs = Frameset.new((duration * refresh_rate).round, easing, effect)
+        fs = Frameset.new(duration, easing, effect)
         yield fs
         consumer.add_frameset(fs)
       end
 
       private
 
-      attr_reader :consumer, :refresh_rate
+      attr_reader :consumer
     end
   end
 end

data/lib/whirled_peas/animator/renderer_consumer.rb

@@ -1,5 +1,6 @@
 require 'whirled_peas/graphics/renderer'
 require 'whirled_peas/utils/ansi'
+require 'whirled_peas/device/rendered_frame'
 
 module WhirledPeas
   module Animator
@@ -9,23 +10,24 @@ module WhirledPeas
         @device = device
         @width = width
         @height = height
-        @renders = []
+        @rendered_frames = []
       end
 
       def add_frameset(frameset)
-        frameset.each_frame do |frame, args|
+        frameset.each_frame do |frame, duration, args|
           template = template_factory.build(frame, args)
-          renders << Graphics::Renderer.new(template, width, height).paint
+          strokes = Graphics::Renderer.new(template, width, height).paint
+          rendered_frames << Device::RenderedFrame.new(strokes, duration)
         end
       end
 
       def process
-        device.handle_renders(renders)
+        device.handle_rendered_frames(rendered_frames)
       end
 
       private
 
-      attr_reader :template_factory, :device, :width, :height, :renders
+      attr_reader :template_factory, :device, :width, :height, :rendered_frames
     end
   end
 end

data/lib/whirled_peas/command/frames.rb

@@ -13,9 +13,7 @@ module WhirledPeas
         require 'whirled_peas/animator/debug_consumer'
         require 'whirled_peas/animator/producer'
 
-        Animator::Producer.produce(
-          Animator::DebugConsumer.new, WhirledPeas.config.refresh_rate
-        ) do |producer|
+        Animator::Producer.produce(Animator::DebugConsumer.new) do |producer|
           config.application.start(producer)
         end
       end

data/lib/whirled_peas/command/play.rb

@@ -28,13 +28,11 @@ module WhirledPeas
           Utils::Ansi.with_screen do |width, height|
             consumer = Animator::RendererConsumer.new(
               WhirledPeas.config.template_factory,
-              Device::Screen.new(WhirledPeas.config.refresh_rate),
+              Device::Screen.new,
               width,
               height
             )
-            Animator::Producer.produce(
-              consumer, WhirledPeas.config.refresh_rate
-            ) do |producer|
+            Animator::Producer.produce(consumer) do |producer|
               config.application.start(producer)
             end
           end
@@ -60,9 +58,9 @@ module WhirledPeas
           require 'whirled_peas/utils/file_handler'
 
           Utils::Ansi.with_screen do
-            screen = Device::Screen.new(WhirledPeas.config.refresh_rate)
-            renders = Utils::FileHandler.read(wpz_file)
-            screen.handle_renders(renders)
+            screen = Device::Screen.new
+            rendered_frames = Utils::FileHandler.read(wpz_file)
+            screen.handle_rendered_frames(rendered_frames)
           end
         end
 

data/lib/whirled_peas/command/record.rb

@@ -21,9 +21,7 @@ module WhirledPeas
           width,
           height
         )
-        Animator::Producer.produce(
-          consumer, WhirledPeas.config.refresh_rate
-        ) do |producer|
+        Animator::Producer.produce(consumer) do |producer|
           config.application.start(producer)
         end
       end

data/lib/whirled_peas/command/still.rb

@@ -1,3 +1,5 @@
+require 'whirled_peas/device/rendered_frame'
+
 require_relative 'frame_command'
 
 module WhirledPeas
@@ -16,12 +18,14 @@ module WhirledPeas
         require 'whirled_peas/utils/ansi'
 
         Utils::Ansi.with_screen do |width, height|
-          rendered = Graphics::Renderer.new(
+          strokes = Graphics::Renderer.new(
             WhirledPeas.config.template_factory.build(frame, frame_args),
             width,
             height
           ).paint
-          Device::Screen.new(10000).handle_renders([rendered])
+          Device::Screen.new.handle_rendered_frames(
+            [Device::RenderedFrame.new(strokes, 0)]
+          )
         end
       end
     end

data/lib/whirled_peas/command/themes.rb

@@ -35,12 +35,14 @@ module WhirledPeas
             end
           end
           Utils::Ansi.with_screen do |width, height|
-            rendered = Graphics::Renderer.new(
+            strokes = Graphics::Renderer.new(
               template,
               80,
               30
             ).paint
-            Device::Screen.new(10000).handle_renders([rendered])
+            Device::Screen.new.handle_rendered_frames(
+              [Device::RenderedFrame.new(strokes, 0)]
+            )
           end
 
           if index < theme_names.length - 1
@@ -62,7 +64,6 @@ module WhirledPeas
       def validate!
         super
         config_file = args.shift
-        @error_text = 'hi'
         unless config_file.nil?
           # We think we have a valid ruby config file, set the absolute path to @config
           @config_file = config_file[0] == '/' ? config_file : File.join(Dir.pwd, config_file)

data/lib/whirled_peas/component/list_with_active.rb

@@ -32,7 +32,7 @@ module WhirledPeas
       def compose(composer, settings)
         %i[items active_index].each do |required_attr|
           if send(required_attr).nil?
-            raise ArugmentError, "Require field #{required_attr} missing"
+            raise ArgumentError, "Required field #{required_attr} missing"
           end
         end
 

data/lib/whirled_peas/config.rb

@@ -2,9 +2,6 @@ require 'logger'
 
 module WhirledPeas
   class Config
-    # Refreshed rate measured in frames per second
-    DEFAULT_REFRESH_RATE = 30
-
     DEFAULT_LOG_LEVEL = Logger::INFO
     DEFAULT_LOG_FILE = 'whirled_peas.log'
 
@@ -35,7 +32,7 @@ module WhirledPeas
       "[#{severity}] #{datetime.strftime('%Y-%m-%dT%H:%M:%S.%L')} (#{progname}) - #{msg}\n"
     end
 
-    attr_writer :application, :template_factory, :refresh_rate, :log_level, :log_formatter, :log_file
+    attr_writer :application, :template_factory, :log_level, :log_formatter, :log_file
 
     def application
       unless @application
@@ -51,10 +48,6 @@ module WhirledPeas
       @template_factory
     end
 
-    def refresh_rate
-      @refresh_rate || DEFAULT_REFRESH_RATE
-    end
-
     def log_level
       @log_level || DEFAULT_LOG_LEVEL
     end