gifenc 0.1.0 → 0.2.1

data/lib/gif.rb

@@ -93,6 +93,16 @@ module Gifenc
     # @return [Array<Extension>] Extension list.
     attr_accessor :extensions
 
+    # Automatically destroy each image right after processing it during encoding.
+    # This is intended to save as much memory as possible whenever that's sensitive.
+    # Normally, since the pixel data for each image gets encoded and appended to
+    # the final output, the data is briefly duplicated in memory. This avoids it.
+    # @note This will make the images unusable after the first encoding! So if
+    #   you plan on reusing them multiple times, do not enable this setting, or
+    #   only do so before the very last encoding.
+    # @return [Boolean] Auto-destroy mode.
+    attr_accessor :destroy
+
     # Creates a new GIF object.
     # @param width       [Integer]    Width of the logical screen (canvas) in pixels (see {#width} and {#resize}).
     # @param height      [Integer]    Height of the logical screen (canvas) in pixels (see {#height} and {#resize}).
@@ -104,6 +114,7 @@ module Gifenc
     # @param loops       [Integer]    Amount of times to loop the GIF (see {#loops}).
     # @param bg          [Integer]    Background color (see {#bg}).
     # @param ar          [Integer]    Pixel aspect ratio (see {#ar}).
+    # @param destroy     [Boolean]    Auto-destroy each image right after encoding (see {#destroy}).
     def initialize(
         width,
         height,
@@ -115,7 +126,8 @@ module Gifenc
         disposal:    nil,
         loops:       DEFAULT_LOOPS,
         bg:          DEFAULT_BACKGROUND,
-        ar:          DEFAULT_ASPECT_RATIO
+        ar:          DEFAULT_ASPECT_RATIO,
+        destroy:     false
       )
       # GIF attributes
       @width  = width
@@ -135,6 +147,9 @@ module Gifenc
       @images     = []
       @extensions = []
 
+      # Other
+      @destroy = destroy
+
       # If we want the GIF to loop, then add the Netscape Extension
       self.loops = loops
     end
@@ -159,7 +174,13 @@ module Gifenc
       @extensions.each{ |e| e.encode(stream) }
 
       # Encode frames containing image data (and local extensions)
-      @images.each{ |f| f.encode(stream) }
+      @images.size.times.each{ |i|
+        @images[i].encode(stream)
+        if @destroy
+          @images[i].destroy
+          @images[i] = nil
+        end
+      }
 
       # Trailer
       stream << TRAILER
@@ -208,6 +229,30 @@ module Gifenc
       self
     end
 
+    # Duplicates all frames in reverse order. Generates a boomerang effect,
+    # particularly neat when looped.
+    # @param first [Boolean] Whether to duplicate the very first frame. Probably
+    #   not desired for looping GIFs, because then the first frame would appear
+    #   twice in a row (at the start, and at the end). Useful for non-looping
+    #   boomerangs.
+    # @return [Gif] The GIF object.
+    def boomerang(first: false)
+      (@images.size - 2).downto(first ? 0 : 1).each{ |i|
+        @images << @images[i].dup
+      }
+      self
+    end
+
+    # Shortcut to modify the delay of the GIF's last frame, intended to
+    # showcase the final result before looping it.
+    # @param delay [Integer] The time, in 1/100ths of a second, to show the last
+    #   frame.
+    # @return [Gif] The GIF object.
+    def exhibit(delay = DEFAULT_EXHIBIT_TIME)
+      @images.last.delay = delay
+      self
+    end
+
     # Encode and write the GIF to a string.
     # @return [String] The string containing the encoded GIF file.
     def write

data/lib/gifenc.rb

@@ -1,3 +1,5 @@
+require 'pry-byebug'
+
 # Gifenc is a pure Ruby library to encode, decode and edit GIF files. It aims
 # to eventually support the complete {file:docs/Specification.md specification}.
 # The Gifenc module serves as a namespace to encapsulate the functionality
@@ -49,8 +51,13 @@ module Gifenc
   # Default pixel aspect ratio (`0` = square). Note that this setting is ignored
   # by most decoders.
   DEFAULT_ASPECT_RATIO = 0
+
+  # Default time to exhibit GIF's last frame when selected (in 1/100ths of sec)
+  DEFAULT_EXHIBIT_TIME = 100
 end
 
+require 'lzwrb'
+
 require_relative 'errors.rb'
 require_relative 'util.rb'
 require_relative 'geometry.rb'