siskel 1.0.1

data/.gitignore

@@ -0,0 +1 @@
+tmp/*

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.0.1 2009-07-18
+
+* Initial release.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jonathan Dahl
+
+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.rdoc

@@ -0,0 +1,171 @@
+= Siskel
+
+A video/audio file inspector, powered by MediaInfo (http://mediainfo.sourceforge.net/).
+
+Siskel grew out of the RVideo project, and may replace the RVideo::Inspector library within RVideo. Head to http://groups.google.com/group/rvideo for more info.
+
+== Install Siskel
+
+  gem install siskel
+  
+== Install MediaInfo
+
+MediaInfo comes in a few versions, including a CLI (command-line interface) and a GUI version. You want the CLI.
+
+Download for most platforms at http://mediainfo.sourceforge.net/en/Download.
+
+Or build from source: http://mediainfo.sourceforge.net/en/Download/Source.
+
+== Basic usage
+
+  results = Siskel.review(:file => 'path/to/myfile.mp4')
+  
+  results[:format]              # "MPEG-4"
+  results[:duration]            # "208ms"
+  results[:audio][:format]      # "AAC"
+  results[:video][:width]       # "640 pixels"
+  
+== Details
+
+Siskel just parses the results of MediaInfo and returns a hash of the results. 
+
+MediaInfo itself returns results like this (abbreviated):
+
+  General
+  Complete name                    : tmp/videos/triple_figures.mov
+  Format                           : MPEG-4
+
+  Video
+  Format                           : MPEG-4 Visual
+  Width                            : 624 pixels
+  Height                           : 352 pixels
+  Bits/(Pixel*Frame)               : 0.299
+
+  Audio
+  Format                           : AAC
+  Bit rate                         : 128 Kbps
+  Sampling rate                    : 48.0 KHz
+  Channel(s)                       : 2 channels
+
+"General" options appear at top level.
+  
+  results[:complete_name]               # "tmp/videos/triple_figures.mov"
+  results[:format]                      # "MPEG-4"
+  
+"Video" and "Audio" options are nested.
+
+  results[:video][:format]              # "MPEG-4 Visual" 
+  results[:video][:width]               # "624 pixels"    
+  results[:video][:height]              # "352 pixels"    
+  results[:video][:bits_pixel_frame]    # "0.299"            
+                                                        
+  results[:audio][:format]              # "AAC"           
+  results[:audio][:bit_rate]            # "128 Kbps"      
+  results[:audio][:sampling_rate]       # "48.0 KHz"      
+  results[:audio][:channels]            # "2 channels"    
+  
+Keys are downcased, cleaned up, and turned into symbols. Parentheses are ignored, and spaces and punctuation become underscores. So "Complete Name" becomes :complete_name, "Format Settings, BVOP" becomes :format_settings_bvop, and "Bits/(Pixel*Frame)" becomes :bits_pixel_frame.
+  
+== Sample MediaInfo output
+
+  General
+  Complete name                    : tmp/videos/triple_figures.mov
+  Format                           : MPEG-4
+  Format profile                   : QuickTime
+  Codec ID                         : qt  
+  File size                        : 10.1 MiB
+  Duration                         : 40s 240ms
+  Overall bit rate                 : 2 104 Kbps
+  Performer                        : Flight Of The Conchords
+  Genre                            : TV Shows
+  Encoded date                     : UTC 2007-12-04 22:14:21
+  Tagged date                      : UTC 2007-12-04 22:14:22
+  Writing application              : VisualHub 1.23
+  Writing library                  : Apple QuickTime 7.3.0
+  com.apple.quicktime.player.movie : (Binary)
+  tvsh                             : Flight Of The Conchords
+  tvsn                             : 1
+  tves                             : 1
+
+  Video
+  ID                               : 1
+  Format                           : MPEG-4 Visual
+  Format profile                   : Simple@L1
+  Format settings, BVOP            : No
+  Format settings, QPel            : No
+  Format settings, GMC             : No warppoints
+  Format settings, Matrix          : Default (H.263)
+  Codec ID                         : 20
+  Duration                         : 40s 240ms
+  Bit rate mode                    : Variable
+  Bit rate                         : 1 971 Kbps
+  Width                            : 624 pixels
+  Height                           : 352 pixels
+  Display aspect ratio             : 16/9
+  Frame rate mode                  : Constant
+  Frame rate                       : 29.970 fps
+  Resolution                       : 24 bits
+  Colorimetry                      : 4:2:0
+  Scan type                        : Progressive
+  Bits/(Pixel*Frame)               : 0.299
+  Stream size                      : 9.45 MiB (94%)
+  Writing library                  : Lavc51.38.0
+  Encoded date                     : UTC 1970-01-01 00:00:00
+  Tagged date                      : UTC 2007-12-04 22:14:22
+
+  Audio
+  ID                               : 2
+  Format                           : AAC
+  Format/Info                      : Advanced Audio Codec
+  Format version                   : Version 4
+  Format profile                   : LC
+  Format settings, SBR             : No
+  Codec ID                         : 40
+  Duration                         : 40s 234ms
+  Bit rate mode                    : Variable
+  Bit rate                         : 128 Kbps
+  Channel(s)                       : 2 channels
+  Channel positions                : L R
+  Sampling rate                    : 48.0 KHz
+  Resolution                       : 16 bits
+  Stream size                      : 629 KiB (6%)
+  Encoded date                     : UTC 1970-01-01 00:00:00
+  Tagged date                      : UTC 2007-12-04 22:14:22
+
+== Why MediaInfo?
+
+RVideo used ffmpeg for file inspection, via "ffmpeg -i /path/to/file.mp4". This is sort of a hack; the -i flag is not "inspect", but "input file". So this command just calls ffmpeg with a file but doesn't tell ffmpeg what to do, and ffmpeg returns a bunch of data as a result. 
+
+But the biggest problem with using ffmpeg for file inspection is that the data returned by "ffmpeg -i" changes every few months. So the library is highly coupled to a particular version of SVN checkout of ffmpeg, which sucks.
+
+MediaInfo has only one purpose: to return this sort of data. Its text output doesn't change nearly as frequently as ffmpeg's, and if it does, it will be far easier to keep Siskel up to date with these changes. (MediaInfo has very little syntax: just headers and key/value pairs separated by colons. ffmpeg's output is verbose and unstructured.)
+
+A few other reasons for using MediaInfo for file inspection: it's reportedly faster than ffmpeg, and it's far smaller and simpler to install.
+
+The downside is that if you're already using ffmpeg, you need to install yet another video/audio tool. But MediaInfo is simple and small enough that this isn't a big deal.
+
+== Help out!
+
+For questions, bug reports, or improvements, head over to the RVideo Google Group: http://groups.google.com/group/rvideo.
+
+== LICENSE
+
+(The MIT License)
+
+Copyright © 2009 Jonathan Dahl
+
+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.
+
+== Shameless Plugs
+
+Check out Zencoder (http://zencoder.com), a scalable video transcoding product.
+
+* Blog: http://railspikes.com
+* GitHub: jondahl (http://github.com/jondahl)
+* Twitter: @jondahl (http://twitter.com/jondahl)
+* Other Startup: http://tumblon.com
+* Consulting: http://phronos.com

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "siskel"
+    gem.summary = %Q{A nippy video metadata inspector library}
+    gem.description = %Q{Inspect a video/audio file for properties and metadata, using mediainfo}
+    gem.email = "jphastings@gmail.com"
+    gem.homepage = "http://github.com/jphastings/AirVideo"
+    gem.authors = ["JP Hastings-Spital","Jon Dahl"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+task :default => :build

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/lib/siskel.rb

@@ -0,0 +1,44 @@
+class Siskel
+
+  #   results = Siskel.review(:file => 'path/to/myfile.mov')
+  #   results[:format]              # => 'MPEG-4'
+  #   results[:video][:frame_rate]  # => '29.970 fps'
+  
+  class << self
+    def review(options = {})
+      raise ArgumentError, "Must supply either an input file or a pregenerated response" if options[:raw_response].nil? and options[:file].nil?
+      raise ArgumentError, "File not found: #{options[:file]}" if options[:file] and !FileTest.exist?(options[:file])
+      parse_results(options[:raw_response] || `mediainfo "#{options[:file]}"`)
+    end
+  
+    def parse_results(mediainfo_results)
+      mediainfo_results.split("\n").inject({}) do |siskel_results, row|
+        result = parse_row(row)
+        if result.is_a?(Symbol)
+          @prefix = result
+          siskel_results[@prefix] ||= {}
+        elsif result.is_a?(Hash)
+          if @prefix.nil?
+            siskel_results[result.keys.first] = result.values.first
+          else
+            siskel_results[@prefix][result.keys.first] = result.values.first
+          end
+        end
+        siskel_results
+      end
+    end
+    
+    def parse_row(row)
+      results = /(.*) : (.*)/.match(row)
+      if results
+        return { make_key(results[1]) => results[2].strip }
+      elsif row =~ /\w+/ && row !=~ /General/i
+        return row.strip.downcase.to_sym
+      end
+    end
+    
+    def make_key(str)
+      str.strip.gsub(/[\(\)]/, "").gsub(/\W+/, "_").gsub(/_$/, "").downcase.to_sym
+    end
+  end
+end

data/siskel.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{siskel}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["JP Hastings-Spital", "Jon Dahl"]
+  s.date = %q{2010-08-01}
+  s.description = %q{Inspect a video/audio file for properties and metadata, using mediainfo}
+  s.email = %q{jphastings@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/siskel.rb",
+     "siskel.gemspec",
+     "test/fixtures/test_mediainfo_results.rb",
+     "test/fixtures/tiny.mp4",
+     "test/siskel_test.rb"
+  ]
+  s.homepage = %q{http://github.com/jphastings/AirVideo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A nippy video metadata inspector library}
+  s.test_files = [
+    "test/fixtures/test_mediainfo_results.rb",
+     "test/siskel_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/fixtures/test_mediainfo_results.rb

@@ -0,0 +1,67 @@
+class TestMediainfoResults
+  def self.triple_figures
+    "General
+    Complete name                    : tmp/videos/triple_figures.mov
+    Format                           : MPEG-4
+    Format profile                   : QuickTime
+    Codec ID                         : qt  
+    File size                        : 10.1 MiB
+    Duration                         : 40s 240ms
+    Overall bit rate                 : 2 104 Kbps
+    Performer                        : Flight Of The Conchords
+    Genre                            : TV Shows
+    Encoded date                     : UTC 2007-12-04 22:14:21
+    Tagged date                      : UTC 2007-12-04 22:14:22
+    Writing application              : VisualHub 1.23
+    Writing library                  : Apple QuickTime 7.3.0
+    com.apple.quicktime.player.movie : (Binary)
+    tvsh                             : Flight Of The Conchords
+    tvsn                             : 1
+    tves                             : 1
+
+    Video
+    ID                               : 1
+    Format                           : MPEG-4 Visual
+    Format profile                   : Simple@L1
+    Format settings, BVOP            : No
+    Format settings, QPel            : No
+    Format settings, GMC             : No warppoints
+    Format settings, Matrix          : Default (H.263)
+    Codec ID                         : 20
+    Duration                         : 40s 240ms
+    Bit rate mode                    : Variable
+    Bit rate                         : 1 971 Kbps
+    Width                            : 624 pixels
+    Height                           : 352 pixels
+    Display aspect ratio             : 16/9
+    Frame rate mode                  : Constant
+    Frame rate                       : 29.970 fps
+    Resolution                       : 24 bits
+    Colorimetry                      : 4:2:0
+    Scan type                        : Progressive
+    Bits/(Pixel*Frame)               : 0.299
+    Stream size                      : 9.45 MiB (94%)
+    Writing library                  : Lavc51.38.0
+    Encoded date                     : UTC 1970-01-01 00:00:00
+    Tagged date                      : UTC 2007-12-04 22:14:22
+
+    Audio
+    ID                               : 2
+    Format                           : AAC
+    Format/Info                      : Advanced Audio Codec
+    Format version                   : Version 4
+    Format profile                   : LC
+    Format settings, SBR             : No
+    Codec ID                         : 40
+    Duration                         : 40s 234ms
+    Bit rate mode                    : Variable
+    Bit rate                         : 128 Kbps
+    Channel(s)                       : 2 channels
+    Channel positions                : L R
+    Sampling rate                    : 48.0 KHz
+    Resolution                       : 16 bits
+    Stream size                      : 629 KiB (6%)
+    Encoded date                     : UTC 1970-01-01 00:00:00
+    Tagged date                      : UTC 2007-12-04 22:14:22"
+  end
+end

data/test/siskel_test.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'fixtures/test_mediainfo_results'
+require 'lib/siskel'
+
+class SiskelTest < Test::Unit::TestCase
+  
+  context "Siskel reviewer" do
+    should "return a results hash with raw results" do
+      results = Siskel.review(:raw_response => TestMediainfoResults.triple_figures)
+      assert_equal Hash, results.class
+    end
+    
+    should "return a results hash when passed a file" do
+      results = Siskel.review(:file => 'fixtures/tiny.mp4')
+      assert_equal Hash, results.class
+    end
+    
+    should "raise an exception if neither file nor raw results are provided" do
+      assert_raises ArgumentError do
+        results = Siskel.review
+      end
+    end
+    
+    should "raise an exception if file not found" do
+      assert_raises ArgumentError do
+        results = Siskel.review(:file => 'fixtures/not_there.mp4')
+      end
+    end
+    
+    context "results" do
+      setup do
+        @results = Siskel.review(:raw_response => TestMediainfoResults.triple_figures)
+      end
+      
+      should "have general attributes" do
+        assert @results[:general]
+        assert @results[:video]
+        assert @results[:audio][:format]
+      end
+    end
+    
+    context "compatibility" do
+      # TODO: add suite of compatibility tests
+      # should_inspect_media :file => 'file'
+      # should_inspect_media :response => 'response' 
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: siskel
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- JP Hastings-Spital
+- Jon Dahl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-01 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Inspect a video/audio file for properties and metadata, using mediainfo
+email: jphastings@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/siskel.rb
+- siskel.gemspec
+- test/fixtures/test_mediainfo_results.rb
+- test/fixtures/tiny.mp4
+- test/siskel_test.rb
+has_rdoc: true
+homepage: http://github.com/jphastings/AirVideo
+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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A nippy video metadata inspector library
+test_files: 
+- test/fixtures/test_mediainfo_results.rb
+- test/siskel_test.rb