gif-info 0.1.0

data/lib/gif-info/blocks/trailer.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "gif-info/block"
+
+##
+# Primary GifInfo module.
+#
+
+class GifInfo
+
+    ##
+    # General blocks module.
+    #
+    
+    module Blocks
+    
+        ##
+        # Indicates the end of the file.
+        #
+        
+        class Trailer < Block
+            ##
+            # Skips block in stream.
+            #
+     
+            def skip!
+                @io.seek(1, IO::SEEK_CUR)
+            end
+        end
+    end
+end

data/lib/gif-info/body.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+##
+# Primary GifInfo module.
+#
+
+class GifInfo
+    
+    ##
+    # Decoder and holder of block-encoded GIF data.
+    #
+    
+    class Body
+    
+        ##
+        # IO object.
+        #
+        
+        @io
+        
+        ##
+        # Position in stream.
+        #
+        
+        @position
+        
+        ##
+        # Data contained in the data body.
+        #
+        
+        @data
+        
+        ##
+        # Constructor.
+        # @param [IO] io IO object
+        #
+        
+        def initialize(io)
+            @io = io
+            @position = io.pos
+        end
+        
+        ##
+        # Returns data.
+        # If block given, streams it, in otherwise returns full value.
+        #
+        # @yield [String] chunk in size of one data block of the raw data
+        # @return [String] full data content
+        # 
+        
+        def data(&block)
+            if not @data.nil?
+                return @data
+            end
+            
+            self.prepare!     # seeks to block position
+            
+            if not block.nil?
+                loop do
+                    size = @io.getbyte
+                    break if size <= 0
+                    block.call(@io.read(size))
+                end
+            else
+                data = ""
+                self.data do |chunk|
+                    data << chunk
+                end
+                @data = data
+                
+                return @data
+            end
+        end
+        
+        ##
+        # Skips the body content in stream.
+        #
+        
+        def skip!
+            loop do
+                size = @io.getbyte
+                break if size <= 0
+                @io.seek(size, IO::SEEK_CUR)
+            end
+        end
+        
+        ##
+        # Prepares for reading.
+        #
+        
+        def prepare!
+            @io.seek(@position)
+        end
+        
+        ##
+        # Returns bytesize of the data body.
+        # @return [Integer] length in bytes
+        #
+        
+        def bytesize
+            self.data.bytesize
+        end
+    end
+end

data/lib/gif-info/color-table.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "gif-info/raw-block"
+
+##
+# Primary GifInfo module.
+#
+
+class GifInfo
+
+    ##
+    # General color table block.
+    # @abstract
+    #
+    
+    class ColorTable < RawBlock
+    
+        ##
+        # Constructor.
+        #
+        # @param [IO] io IO object
+        # @param [Integer] size size as it's reported by header blocks
+        #
+        
+        def initialize(io, size)
+            super(io, 3 * (2 ** (size + 1)))
+        end
+        
+    end
+    
+end

data/lib/gif-info/data-block.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "gif-info/block"
+require "gif-info/body"
+
+##
+# Primary GifInfo module.
+#
+
+class GifInfo
+
+    ##
+    # Abstract block which contains data in {Body} form only.
+    # @abstract
+    #
+    
+    class DataBlock < Block
+    
+        ##
+        # Data body content.
+        #
+        
+        @body
+        
+        ##
+        # Returns data body.
+        # @return [Body] data body
+        #
+        
+        def body
+            if @body.nil?
+                @body = Body::new(@io)
+            end
+            
+            return @body
+        end
+        
+        ##
+        # Skips block in stream.
+        #
+        
+        def skip!
+            self.body.skip!
+        end
+        
+        ##
+        # Returns block size.
+        # @return [Integer] block size in bytes
+        #
+        
+        def bytesize
+            self.body.bytesize
+        end
+    end
+end

data/lib/gif-info/dynamic-block.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "gif-info/fixed-block"
+
+##
+# Primary GifInfo module.
+#
+
+class GifInfo
+
+    ##
+    # Abstract block which contains both header and data with dynamic 
+    # (non-fixed) length.
+    #
+    # @abstract
+    #
+    
+    class DynamicBlock < FixedBlock
+    
+        ##
+        # Holds data body.
+        #
+        
+        @body
+        
+        ##
+        # Returns data body.
+        #
+        # @param [Integer] skip number of bytes to skip before data
+        # @return [Body] data body
+        #
+        
+        def body(skip = nil)
+            if @body.nil?
+                if not skip.nil?
+                    @io.seek(skip, IO::SEEK_CUR)    # skips dummy leader
+                end
+                @body = Body::new(@io)
+            end
+            
+            @body
+        end
+        
+        ##
+        # Skips block in stream.
+        #
+        
+        def skip!(additional = nil)
+            super()
+            if not additional.nil?
+                @io.seek(additional, IO::SEEK_CUR) 
+            end
+            self.body.skip!
+        end
+                
+        ##
+        # Returns block size.
+        # @return [Integer] block size in bytes
+        #
+
+        def bytesize
+            self.header.bytesize + self.body.bytesize
+        end
+    end
+end

data/lib/gif-info/fixed-block.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "struct-fx"     # 0.1.1
+require "gif-info/block"
+
+##
+# Primary GifInfo module.
+#
+
+class GifInfo
+
+    ##
+    # Abstract fixed-size block which contains header only. 
+    # @abstract
+    #
+    
+    class FixedBlock < Block
+    
+        ##
+        # Holds header.
+        #
+        
+        @header
+        
+        ##
+        # Holds header struct.
+        #
+        # In case, data are loaded, @header and @struct links to the 
+        # same objects.
+        #
+        
+        @struct
+        
+        ##
+        # Returns header struct.
+        # @return [StructFx] struct
+        #
+        
+        def header
+            if @header.nil?
+                self.prepare!
+                @header = __struct
+                @header << @io.read(@header.bytesize)
+            end
+            
+            @header
+        end
+        
+        ##
+        # Skips block in stream.
+        #
+        
+        def skip!
+            @io.seek(__struct.bytesize, IO::SEEK_CUR)
+        end
+        
+        ##
+        # Returns block size.
+        # @return [Integer] block size in bytes
+        #
+        
+        def bytesize
+            self.header.bytesize
+        end
+        
+        
+        private
+        
+        ##
+        # Returns header struct.
+        #
+        
+        def __struct
+            if @struct.nil?
+                @struct = StructFx::new(&self.class::STRUCTURE)
+            end
+            
+            @struct
+        end
+    end
+end

data/lib/gif-info/raw-block.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "gif-info/block"
+
+##
+# Primary GifInfo module.
+#
+
+class GifInfo
+
+    ##
+    # Abstract block which contains only datas in non-formatted form,
+    # so data which aren't encoded in block form as usuall in GIF.
+    # Typicall example are color tables which site is known in forward.
+    #
+    # @abstract
+    #
+    
+    class RawBlock < Block
+    
+        ##
+        # Data body of block.
+        #
+        
+        @body
+        
+        ##
+        # Indicates length of the data for read.
+        #
+        
+        @size
+        
+        ##
+        # Constructor.
+        #
+        # @param [IO] io IO object
+        # @param [Integer] size amount of data for read
+        #
+        
+        def initialize(io, size)
+            @size = size
+            super(io)
+        end
+        
+        ##
+        # Returns data body.
+        # @return [String] raw data
+        # 
+        
+        def body
+            if @body.nil?
+                self.prepare!
+                @body = @io.read(@size)
+            end
+            
+            return @body
+        end
+
+        ##
+        # Skips block in stream.
+        #
+        
+        def skip!
+            @io.seek(@size, IO::SEEK_CUR)
+        end
+        
+        ##
+        # Returns block size.
+        # @return [Integer] block size in bytes
+        #
+        
+        def bytesize
+            self.body.bytesize
+        end
+    end
+end
+