swf_file 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.bundle
+pkg

data/LICENSE

@@ -0,0 +1,28 @@
+This gem is based on Dennis Zhuang's swf-util library, made available at http://code.google.com/p/swf-util/, under the Apache License 2.0 (vide http://www.apache.org/licenses/LICENSE-2.0).
+
+The fixture files smallgoat.jpg, clicktag-decompressed.swf, clicktag.swf, originally made available under the MIT license (vide http://www.opensource.org/licenses/mit-license.php) at http://github.com/2performant/swiff, are included in this gem, without modification, under their original copyright © 2010 held by 2Perfomant.
+
+All modifications and additions contained within this gem, made available at http://github.com/DBA/swfheader, are licensed under the following terms and conditions:
+
+Copyright (c) 2010 Diogo Almeida
+
+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,27 @@
+==Introduction
+  Based on the swfutil lib, by Dennis Zhuang, the SWF File is lightweight gem to read swf file headers from within a Ruby application.
+
+==Ruby compatibility
+  Target version: 1.9.2dev
+  Also compatible with: 1.9.1-p376 and 1.8.7-p
+  
+  Not tested with versions under 1.8.7-p. Should you use this lib with other ruby versions, please provide feedback.
+
+==Install
+  gem install swf_file
+
+==LICENSE
+  Please refer to the LICENSE file.
+
+==Example
+  TODO
+
+==Issues, improvements, feedback an suggestions
+  To report issues, please use GitHub's issue manager (http://github.com/DBA/swf_file/issues). Meanwhile, feel free to fork the project and submit your modifications.
+  
+  Should you wish to contact me directly, please use GitHub's message box or the email available at the Rakefile.
+  
+==Pending
+  * Cleanup the class PackedBitObject, which still suffers from the pure import from SwfUtil
+  * Modularize SwfHeader a bit more
+  * Docs

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "swf_file"
+    gemspec.summary = "SWF File is lightweight gem to read swf file headers from within a Ruby application"
+    gemspec.description = "Based on the swfutil lib, by Dennis Zhuang, the SWF File is lightweight gem to read swf file headers from within a Ruby application. This gem is fully written in Ruby and is compatible with Ruby v1.9.x"
+    gemspec.email = "dba@gnomeslab.com"
+    gemspec.homepage = "http://github.com/DBA/swf_file"
+    gemspec.authors = ["DBA"]
+
+    # dependencies defined in Gemfile
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+#test_files_pattern = 'test/{unit,functional,other,matchers}/**/*_test.rb'
+test_files_pattern = 'test/unit/swf_file_test.rb'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = test_files_pattern
+  t.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/swf_file/compression.rb

@@ -0,0 +1,25 @@
+module Compression
+  private
+    def buffer_compressed?(memoize_result = true)
+      if memoize_result
+        @compressed ||= @buffer[0].ord == ?C.ord
+      else
+        @buffer[0].ord == ?C.ord
+      end
+    end
+
+    def decompress_buffer!
+      return @buffer unless buffer_compressed?(false)
+      
+      _buffer = @buffer # local buffer copy
+      _buffer = Zlib::Inflate.new.inflate strip_buffer_header(_buffer)
+      _buffer = _buffer[0,8] + _buffer
+      _buffer[0] = ?F
+      
+      @buffer = _buffer
+    end
+    
+    def strip_buffer_header(buffer)
+      buffer[8, buffer.size - 8]
+    end
+end

data/lib/swf_file/conversions.rb

@@ -0,0 +1,30 @@
+module Conversions
+  module Twips
+    def self.from_pixels(pixels)
+      pixels * 20
+    end
+  end
+  
+  module Pixels
+    def self.from_twips(twips)
+      twips / 20
+    end
+  end
+  
+  module Hash
+    def self.from_swf_header(header)
+      { file: header.file,
+        signature:    header.signature,
+        version:      header.version,
+        avm_version:  header.avm_version,
+        size:         header.size,
+        bit_count:    header.bit_count,
+        xmax:         header.xmax,
+        ymax:         header.ymax,
+        width:        header.width,
+        height:       header.height,
+        frame_rate:   header.frame_rate,
+        frame_count:  header.frame_count }
+    end
+  end
+end

data/lib/swf_file/packed_bit_object.rb

@@ -0,0 +1,54 @@
+# TODO: Needs refactoring & cleanup
+
+class PackedBitObject
+  attr_accessor :bitIndex, :byteIndex, :value, :nextBitIndex, :nextByteIndex, :nextByteBoundary
+  
+  def initialize(bitMarker,byteMarker,decimalValue)
+    @bitIndex = bitMarker;
+    @byteIndex = byteMarker;
+    @value = decimalValue;
+    @nextBitIndex = bitMarker;
+    if ( bitMarker <= 7 )
+      @nextBitIndex+=1
+      @nextByteIndex =byteMarker
+      @nextByteBoundary = (byteMarker+=1)
+    else
+      @nextBitIndex = 0
+      @nextByteIndex+=1
+      @nextByteBoundary = @nextByteIndex;
+    end
+  end
+  
+  def self.from_packed_bits(bytes, byte_marker, bit_marker, length)
+    total = 0
+    shift = 7 - bit_marker 
+    counter = 0 
+    bit_index = bit_marker 
+    byte_index = byte_marker 
+
+    while counter<length
+      (bit_marker...8).each do |i|
+        bit =((bytes[byte_marker].ord & 0xff ) >> shift ) & 1
+        total = ( total << 1 ) + bit
+        bit_index = i
+        shift-=1
+        counter+=1
+
+        if counter==length
+          break
+        end
+      end
+
+      byte_index = byte_marker
+      byte_marker+=1
+      bit_marker = 0
+      shift = 7
+    end
+
+    pbo = PackedBitObject.new(bit_index, byte_index, total)
+    
+    yield pbo if block_given?
+    
+    pbo
+  end
+end

data/lib/swf_file/parser.rb

@@ -0,0 +1,2 @@
+module Parser
+end

data/lib/swf_file/swf_header.rb

@@ -0,0 +1,97 @@
+class SwfHeader
+  include Compression
+  
+  attr_reader :file, :signature, :version, :avm_version, :size, :bit_count,
+              :xmax, :ymax, :width, :height,
+              :frame_rate, :frame_count
+  
+  def initialize(swf_file)
+    @file = swf_file
+    parse_header
+    parse_packed_bits
+  end
+  
+  def compressed?(memoize_result = true)
+    buffer_compressed?(memoize_result)
+  end
+  
+  # Returns the duration in milliseconds
+  def duration
+    ((@frame_count / @frame_rate.to_f).round(5) * 1000).round
+  end
+  
+  def to_s
+    "#{@file} #{@width}x#{@height} #{@frame_rate}fps"
+  end
+  
+  def to_hash
+    Conversions::Hash.from_swf_header self
+  end
+  
+  alias :inspect :to_hash
+  
+  private
+    def parse_header
+      @buffer, @size = get_swf_buffer_and_size
+      raise RuntimeError, "The provided file does not appear to be an SWF", caller unless swf?
+      
+      @signature  = @buffer[0,3]
+      @version    = @buffer[3].ord
+      
+      decompress_buffer! if compressed?
+
+      @bit_count  = ((@buffer[8].ord & 0xff) >> 3)
+    end
+    
+    def parse_packed_bits
+      PackedBitObject.from_packed_bits(@buffer, 8, 5, @bit_count) do |pbo|
+        
+        PackedBitObject.from_packed_bits(@buffer, pbo.nextByteIndex, pbo.nextBitIndex, @bit_count) do |pbo2|
+          @xmax = pbo2.value
+          
+          PackedBitObject.from_packed_bits(@buffer, pbo2.nextByteIndex, pbo2.nextBitIndex, @bit_count) do |pbo3|
+            
+            PackedBitObject.from_packed_bits(@buffer, pbo3.nextByteIndex, pbo3.nextBitIndex, @bit_count) do |pbo4|
+              @ymax   = pbo4.value
+              @width  = Conversions::Pixels.from_twips @xmax
+              @height = Conversions::Pixels.from_twips @ymax
+                            
+              byte_pointer = pbo4.nextByteIndex + 2
+              
+              @frame_rate = @buffer[byte_pointer].ord
+              byte_pointer += 1
+              
+              fc1 = @buffer[byte_pointer].ord & 0xFF
+              byte_pointer += 1
+              
+              fc2 = @buffer[byte_pointer].ord & 0xFF
+              byte_pointer += 1
+              
+              @frame_count = (fc2 << 8) + fc1
+              byte_pointer+=2
+              
+              @avm_version = ((@buffer[byte_pointer].ord & 0x08) == 0) ? "AVM1" : "AVM2"
+            end #pbo4
+          end #pbo3
+        end #pbo2
+      end #pbo
+    end
+    
+    def get_swf_buffer_and_size
+      size = 0
+      
+      buffer = File.open(@file,"rb") do |file|
+        file.seek(4, IO::SEEK_CUR)
+        size = file.read(4).unpack("L")[0]
+        
+        file.rewind
+        file.read
+      end
+      
+      [buffer, size]
+    end
+    
+    def swf?
+      @buffer[0,3] == 'FWS' || @buffer[0,3] == 'CWS'
+    end
+end

data/lib/swf_file.rb

@@ -0,0 +1,20 @@
+$:.unshift File.join(File.dirname(__FILE__), 'swf_file') unless $:.include? File.join(File.dirname(__FILE__), 'swf_file')
+
+require 'zlib'
+require 'parser'
+require 'compression'
+require 'conversions'
+require 'packed_bit_object'
+require 'swf_header'
+
+class SwfFile
+  def initialize(swf_path)
+    raise RuntimeError, "SWF file not found.", caller unless File.exists?(swf_path)
+  end
+  
+  def self.header(swf_path)
+    raise RuntimeError, "SWF file not found.", caller unless File.exists?(swf_path)
+    
+    SwfHeader.new(swf_path)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'test/unit'
+require 'shoulda'
+#require 'swfheader'
+require 'ruby-debug'
+require 'swf_file'
+
+def fixture_path(filename)
+  File.join(File.dirname(__FILE__), '..', 'fixtures', filename)
+end

data/test/unit/swf_file_test.rb

@@ -0,0 +1,99 @@
+require_relative '../test_helper'
+
+class SwfFileTest < Test::Unit::TestCase
+
+  context "SwfFile" do
+    context "Initialization" do
+      should "not be initializable without an SWF file path" do
+        assert_raise(ArgumentError) { SwfFile.new }
+      end
+    
+      should "raise an error if an invalid path is provided" do
+        assert_raise(RuntimeError) { SwfFile.new "/path_to_imaginary_file" }
+      end
+    end # Initialization context
+    
+    context "class method header" do      
+      should "raise an error when not provided with an SWF" do
+        assert_raise(RuntimeError) { SwfFile.header fixture_path('smallgoat.jpg') }
+      end
+      
+      setup do
+        @header = SwfFile.header fixture_path('clicktag.swf')
+      end
+      
+      should "return an instance of SwfHeader" do
+        assert_equal SwfHeader, @header.class
+      end
+      
+      should "indicate the file's size" do
+        assert_equal 4156, @header.size
+      end
+      
+      should "state if the swf was originally compressed" do
+        assert @header.compressed?
+        refute SwfFile.header(fixture_path('clicktag-decompressed.swf')).compressed?
+      end
+      
+      should "not make available private compression module methods" do
+        %w{ :buffer_compressed? :strip_buffer_header :decompress_buffer! }.each do |method|
+          refute @header.respond_to?(method)
+        end
+      end
+      
+      should "state if its buffer is currently compressed" do
+        assert @header.compressed?
+        refute @header.compressed?(false)
+      end
+      
+      should "have the version" do
+        assert_equal 8, @header.version
+      end
+      
+      should "have the bit count" do
+        assert_equal 15, @header.bit_count
+      end
+      
+      should "have the xmax and ymax values" do
+        assert_equal 9360, @header.xmax
+        assert_equal 1200, @header.ymax
+      end
+      
+      should "have the width and height values" do
+        assert_equal 468, @header.width
+        assert_equal 60, @header.height
+      end
+      
+      should "have the frame rate and frame count" do
+        assert_equal 24, @header.frame_rate
+        assert_equal 1, @header.frame_count
+      end
+      
+      should "include the duration of the swf file" do
+        assert_equal 42, @header.duration
+      end
+      
+      should "contain the avm version" do
+        assert_equal 'AVM1', @header.avm_version
+      end
+      
+      should "include the swf signature" do
+        assert_equal 'CWS', @header.signature
+      end
+      
+      should "output basing information when to_s is invoked" do
+        assert @header.to_s =~ /.+clicktag.swf\s\d+x\d+\s\d\dfps/
+      end
+      
+      should "be have a hash converter" do
+        assert_equal Hash, @header.to_hash.class
+      end
+      
+      should "have the same output for the instance methods inspect and to_hash" do
+        assert_equal @header.to_hash, @header.inspect
+      end
+      
+    end # SWF operations context
+    
+  end # SwfFile context
+end # SwfFileTest

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: swf_file
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- DBA
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-06 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Based on the swfutil lib, by Dennis Zhuang, the SWF File is lightweight gem to read swf file headers from within a Ruby application. This gem is fully written in Ruby and is compatible with Ruby v1.9.x
+email: dba@gnomeslab.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- fixtures/clicktag-decompressed.swf
+- fixtures/clicktag.swf
+- fixtures/smallgoat.jpg
+- lib/swf_file.rb
+- lib/swf_file/compression.rb
+- lib/swf_file/conversions.rb
+- lib/swf_file/packed_bit_object.rb
+- lib/swf_file/parser.rb
+- lib/swf_file/swf_header.rb
+- test/test_helper.rb
+- test/unit/swf_file_test.rb
+has_rdoc: true
+homepage: http://github.com/DBA/swf_file
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: SWF File is lightweight gem to read swf file headers from within a Ruby application
+test_files: 
+- test/test_helper.rb
+- test/unit/swf_file_test.rb