flash-header 0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007 Manfred Stienstra <m.stienstra@fngtps.com>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,3 @@
+Flash-header
+
+Flash-header is a library to read contents of a Shockwave Flash file (.swf) header.

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+NAME = 'flash-header'
+VERSIE = '0.1' 
+RDOC_OPTS = ['--quiet', '--title', "Flash-header",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--charset", "utf-8",
+    "--inline-source"]
+CLEAN.include ['pkg', 'doc', '*.gem']
+
+desc 'Default: run tests'
+task :default => [:test]
+task :package => [:clean]
+
+desc 'Run tests'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = true
+end
+
+desc 'Create documentation'
+Rake::RDocTask.new("doc") do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options += RDOC_OPTS
+  rdoc.main = "README"
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec =
+    Gem::Specification.new do |s|
+        s.name = NAME
+        s.version = VERSIE
+        s.platform = Gem::Platform::RUBY
+        s.has_rdoc = true
+        s.extra_rdoc_files = ["README", "LICENSE"]
+        s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|test)\/']
+        s.summary = "Library for parsing the headers of a Shockwave Flash file"
+        s.description = "Pure ruby library for parsing the headers of a Shockwave Flash file."
+        s.author = "Manfred Stienstra"
+        s.email = 'manfred@fngtps.com'
+        s.homepage = 'https://fngtps.com/projects/flash-header'
+        s.required_ruby_version = '>= 1.8.0'
+
+        s.files = %w(README LICENSE Rakefile) +
+          Dir.glob("lib/**/*") + 
+          Dir.glob("examples/**/*") +
+          Dir.glob("bin/**/*")
+
+        s.require_path = "lib"
+        s.bindir = "bin"
+        s.executables = %w(flash_header)
+    end
+
+Rake::GemPackageTask.new(spec) do |p|
+    p.need_tar = true
+    p.gem_spec = spec
+end
+
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{NAME}-#{VERSIE}}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end

data/bin/flash_header

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' rescue LoadError
+require 'flash_header'
+
+if ARGV[0]
+  header = FlashHeader.new ARGV[0]
+else
+  header = FlashHeader.new
+  header.file = $stdin
+  header.read_header
+end
+
+%w(signature version size width heigth).each do |attribute|
+  puts "#{attribute.capitalize}: #{header.header[attribute.intern]}"
+end

data/lib/bit_unpacker.rb

@@ -0,0 +1,74 @@
+# The BitUnPacker class unpacks the byte-packed format used in Flash files. In most cases data types
+# are stored as a number of complete bytes, in file formats where size matters a lot some people choose
+# to store information as packed bytes. This means that the boundary of a value can lie within a byte.
+class BitUnpacker
+  # Initialize a new BitUnpacker, note that the BitUnpacker is a parse class with a lot of internal
+  # state variables. You probably only want to use the class methods.
+  #
+  # <tt>bytes</tt>: A string with the bytes to unpack
+  # <tt>size</tt>: The number of bits per entry
+  # <tt>parts</tt>: The number of entries to unpack from the string, default is (bytes.length*8)/size
+  # <tt>skip</tt>: The number of bits to skip from the start of the string, default is 0
+  def initialize(bytes, size, parts=nil, skip=nil)
+    # Input
+    @bytes = bytes
+    @size = size
+    @parts = parts || (bytes.length*8)/size
+    @skip = skip || 0
+    # Reader state
+    @bytes_offset = 0
+    @current = @bytes[0]
+    @have = 8
+    if @skip
+      # TODO: skip more than 8 bytes
+      take @skip
+      @have -= @skip
+    end
+  end
+  
+  # Take a number of bits from the current byte and shift them away
+  def take(bits)
+    value = @current >> 8 - bits
+    @current = (@current & (0xff >> bits)) << bits
+    value
+  end
+  
+  # Unpack by treating every consecutive block of bits as a signed integer
+  def uunpack
+    unpacked = []
+    value = 0
+    @parts.times do
+      # It's signed, so we need the first byte to determine the sign
+      want = @size - 1
+      is_negative = take(1) == 1 ? true : false
+      @have -= 1
+      while want > 0
+        if want < @have
+          value = (value << want) + take(want)
+          @have -= want
+          want = 0
+        else # want > @have
+          value = (value << @have) + take(@have)
+          want -= @have
+          @have = 8
+          
+          @bytes_offset += 1
+          @current = @bytes[@bytes_offset]
+        end
+      end
+      unpacked << (is_negative ? -value : value)
+      value = 0
+    end
+    unpacked
+  end
+  
+  # Unpack a byte-packed string and interpret the values as a signed integer
+  #
+  # <tt>bytes</tt>: A string with the bytes to unpack
+  # <tt>size</tt>: The number of bits per entry
+  # <tt>parts</tt>: The number of entries to unpack from the string, default is (bytes.length*8)/size
+  # <tt>skip</tt>: The number of bits to skip from the start of the string, default is 0
+  def self.uunpack(bytes, size, parts=nil, skip=nil)
+    BitUnpacker.new(bytes, size, parts, skip).uunpack
+  end
+end

data/lib/flash_header.rb

@@ -0,0 +1,80 @@
+require 'zlib'
+require 'bit_unpacker'
+
+# Read and parses the headers of an SWF file.
+#
+# Examples:
+#
+#   header = FlashHeader.new('dog_on_skateboard.swf')
+#   header.size #=> 5234
+#
+#   header = FlashHeader.new
+#   # You can feed it any object that supports the read method
+#   header.file = StringIO.new(flash_data)
+#   header.read_header
+#   header.width #=> 640
+#   header.height #=> 480
+class FlashHeader
+  # An open IO object to read the headers from.
+  attr_accessor :file
+  # Reader for the instance variable that holds all the header values
+  attr_reader :header
+
+  # Initialize a new FlashHeader instance. This reads the file and parses the header.
+  #
+  # <tt>filename</tt>: A filename for a shockwave flash file (optional).
+  def initialize(filename=nil)
+    @header = {}
+    unless filename.nil?
+      @file = File.open filename
+      begin
+        read_header
+      ensure
+        @file.close
+      end
+    end
+  end
+
+  # Read the header of the initialized file
+  def read_header
+    temp = @file.read
+    # Signature is three ASCII bytes, CWS or FWS
+    @header[:signature] = temp[0..2]
+    # Version is one byte version number
+    @header[:version] = temp[3]
+    # Size is LE byte order BE bit order
+    @header[:size] = temp[4..7].unpack('C*').reverse.inject(0) do |t,i|
+      (t << 8) + i
+    end
+    # Chop off the header part we just parsed
+    if compressed?
+      temp = Zlib::Inflate.inflate temp[8..-1]
+    else
+      temp = temp[8..-1]
+    end
+    return if temp.empty?
+    
+    # First 5 bits are the number of bits for the RECT structure
+    nbits = temp[0] >> 3
+    # 5 bits + 4 times nbits, byte aligned
+    nbytes = ((5 + nbits*4) / 8.0).ceil
+    bytes = BitUnpacker.uunpack(temp[0..nbytes], nbits, 4, 5)
+    @header[:width] = bytes[1] / 20
+    @header[:heigth] = bytes[3] / 20
+    # TODO: support for framerate and the other thing
+  end
+
+  # Returns true if the file was compressed, otherwise it returns false
+  def compressed?
+    @header[:signature][0..0] == 'C'
+  end
+
+  # Adds method access to the headers; signature, version, size, width and height.
+  def method_missing(m, *a)
+    if @header.has_key?(m.to_sym)
+      @header[m.to_sym]
+    else
+      super
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: flash-header
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2007-10-07 00:00:00 +02:00
+summary: Library for parsing the headers of a Shockwave Flash file
+require_paths: 
+- lib
+email: manfred@fngtps.com
+homepage: https://fngtps.com/projects/flash-header
+rubyforge_project: 
+description: Pure ruby library for parsing the headers of a Shockwave Flash file.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Manfred Stienstra
+files: 
+- README
+- LICENSE
+- Rakefile
+- lib/bit_unpacker.rb
+- lib/flash_header.rb
+- bin/flash_header
+test_files: []
+
+rdoc_options: 
+- --quiet
+- --title
+- Flash-header
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --charset
+- utf-8
+- --inline-source
+- --exclude
+- ^(examples|test)\/
+extra_rdoc_files: 
+- README
+- LICENSE
+executables: 
+- flash_header
+extensions: []
+
+requirements: []
+
+dependencies: []
+