greatseth-mediainfo 0.1

data/Changelog

@@ -0,0 +1 @@
+v0.1 Initial Release

data/LICENSE

@@ -0,0 +1,18 @@
+This program is free software. It comes without any warranty, to
+the extent permitted by applicable law. You can redistribute it
+and/or modify it under the terms of the Do What The Fuck You Want
+To Public License, Version 2, as published by Sam Hocevar. See
+http://sam.zoy.org/wtfpl/COPYING for more details.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+
+Copyright (C) 2009 Seth Thomas Rasmussen
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.

data/Manifest

@@ -0,0 +1,7 @@
+Changelog
+lib/mediainfo/attr_readers.rb
+lib/mediainfo.rb
+LICENSE
+Manifest
+Rakefile
+README.markdown

data/README.markdown

@@ -0,0 +1,27 @@
+# Mediainfo
+
+Mediainfo is a class encapsulating the ability to run `mediainfo` 
+on a file and expose the information it produces in a straightforward 
+manner.
+
+The mediainfo CLI can be obtained at http://mediainfo.sourceforge.net.
+
+## Usage
+  
+    info = Mediainfo.new "/path/to/file"
+  
+That will issue the system call to `mediainfo` and parse the output. 
+From there, you can call numerous methods to get a variety of information 
+about a file. Some attributes may be present for some files where others 
+are not.
+
+For a list of all possible attributes supported:
+  
+    Mediainfo.supported_attributes
+  
+In addition to the stock arguments provided by parsing `mediainfo` output, 
+some convenience methods and added behavior is added.
+
+## Contributors
+
+* Seth Thomas Rasmussen - http://greatseth.com

data/Rakefile

@@ -0,0 +1,35 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => :test
+
+namespace :mediainfo do
+  task :fixture do
+    unless file = ENV["file"]
+      puts "Usage: rake mediainfo:fixture file=/path/to/file"
+      exit
+    end
+    fixture = File.expand_path "./test/fixtures/#{File.basename file}.txt"
+    system "mediainfo #{file} > #{fixture}"
+    if File.exist? fixture
+      puts "Generated fixture #{fixture}."
+    else
+      puts "Error generating fixture. #{fixture} not created."
+    end
+  end
+end
+
+require "rubygems"
+require "echoe"
+
+Echoe.new "mediainfo" do |p|
+  p.author = "Seth Thomas Rasmussen"
+  p.email = "sethrasmussen@gmail.com"
+  p.url = "http://greatseth.com"
+  p.ignore_pattern = %w( test/**/* )
+end

data/lib/mediainfo/attr_readers.rb

@@ -0,0 +1,76 @@
+require "rubygems"
+require "active_support" # TODO selective includes once they are released
+
+class  Mediainfo
+module AttrReaders
+  def supported_attributes
+    @supported_attributes ||= []
+  end
+  
+  def mediainfo_attr_reader(name, mediainfo_key = nil)
+    supported_attributes << name
+    attr_name = "#{name}_before_type_cast"
+    define_method attr_name do
+      if v = instance_variable_get("@#{attr_name}")
+        v
+      else
+        v = if md = name.to_s.match(/^(#{SECTIONS.map { |x| x.underscore } * "|"})_(.+)$/)
+          k = mediainfo_key ? mediainfo_key : md[2].humanize.capitalize
+          if subsection = @parsed_response[md[1].capitalize]
+            subsection[k]
+          end
+        else
+          k = mediainfo_key ? mediainfo_key : name.to_s.humanize.capitalize
+          @parsed_response[k]
+        end
+        
+        instance_variable_set "@#{attr_name}", v
+        v
+      end
+    end
+    
+    define_method name do
+      if v = instance_variable_get("@#{name}")
+        v
+      else
+        v = send "#{name}_before_type_cast"
+        v = yield v if v and block_given?
+        
+        instance_variable_set "@#{name}", v
+        v
+      end
+    end
+  end
+  
+  def mediainfo_duration_reader(*a)
+    mediainfo_attr_reader *a do |v|
+      t = 0
+      v.split(/\s+/).each do |tf|
+        case tf
+        # XXX haven't actually seen hot they represent hours yet 
+        # but hopefully this is ok.. :\
+        when /\d+h/  then t += tf.to_i * 60 * 60 * 1000
+        when /\d+mn/ then t += tf.to_i * 60 * 1000
+        when /\d+ms/ then t += tf.to_i
+        when /\d+s/  then t += tf.to_i * 1000
+        else
+          raise "unexpected time fragment! please report bug!"
+        end
+      end
+      t
+    end
+  end
+  
+  def mediainfo_date_reader(*a)
+    mediainfo_attr_reader(*a) { |v| Time.parse v }
+  end
+  
+  def mediainfo_int_reader(*a)
+    mediainfo_attr_reader(*a) { |v| v.gsub(/\D+/, "").to_i }
+  end
+  
+  def mediainfo_section_query(name)
+    define_method("#{name}?") { @parsed_response.key? name.to_s.capitalize }
+  end
+end
+end

data/lib/mediainfo.rb

@@ -0,0 +1,205 @@
+require "mediainfo/attr_readers"
+
+# Mediainfo is a class encapsulating the ability to run `mediainfo` 
+# on a file and expose the information it produces in a straightforward 
+# manner.
+# 
+# Basic usage:
+#   
+#   info = Mediainfo.new "/path/to/file"
+#   
+# That will issue the system call to `mediainfo` and parse the output. 
+# From there, you can call numerous methods to get a variety of information 
+# about a file. Some attributes may be present for some files where others 
+# are not.
+# 
+# For a list of all possible attributes supported:
+#   
+#   Mediainfo.supported_attributes
+#   
+# In addition to the stock arguments provided by parsing `mediainfo` output, 
+# some convenience methods and added behavior is added.
+class Mediainfo
+  extend AttrReaders
+  
+  SECTIONS = %w( Audio Video Image ) # and General
+  
+  ### GENERAL
+  
+  mediainfo_attr_reader :codec_id, "Codec ID"
+  
+  mediainfo_duration_reader :duration
+  
+  mediainfo_attr_reader :format
+  mediainfo_attr_reader :format_profile
+  mediainfo_attr_reader :format_info
+  mediainfo_attr_reader :overall_bit_rate
+  mediainfo_attr_reader :writing_application
+  mediainfo_attr_reader :writing_library
+  
+  def size; File.size(@full_filename); end
+  
+  mediainfo_date_reader :mastered_date
+  mediainfo_date_reader :tagged_date
+  mediainfo_date_reader :encoded_date
+  
+  ### VIDEO
+  
+  mediainfo_section_query :video
+  
+  # XXX this breaks from RVideo::Inspector which returns 
+  # something like "#0.1" instead of "1"
+  mediainfo_attr_reader :video_stream_id, "ID"
+  
+  mediainfo_duration_reader :video_duration
+  
+  mediainfo_attr_reader :video_stream_size
+  mediainfo_attr_reader :video_bit_rate
+  mediainfo_attr_reader :video_nominal_bit_rate
+  
+  mediainfo_attr_reader :video_bit_rate_mode
+  def cbr?; video? and "Constant" == video_bit_rate_mode; end
+  def vbr?; video? and not cbr?; end
+  
+  mediainfo_attr_reader :video_scan_order
+  mediainfo_attr_reader :video_scan_type
+  def interlaced?;  video? and "Interlaced" == video_scan_type; end
+  def progressive?; video? and not interlaced? end
+  
+  mediainfo_int_reader :video_resolution
+  
+  mediainfo_attr_reader :video_colorimetry
+  alias_method :video_colorspace, :video_colorimetry
+  
+  mediainfo_attr_reader :video_format
+  mediainfo_attr_reader :video_format_profile
+  mediainfo_attr_reader :video_format_version
+  mediainfo_attr_reader :video_format_settings_cabac, "Format settings, CABAC"
+  mediainfo_attr_reader :video_format_settings_reframes, "Format settings, ReFrames"
+  mediainfo_attr_reader :video_format_settings_matrix, "Format settings, Matrix"
+  # Format settings, BVOP            : Yes
+  # Format settings, QPel            : No
+  # Format settings, GMC             : No warppoints
+  # mediainfo_attr_reader :video_format_settings_qpel, "Format settings, QPel"
+  
+  mediainfo_attr_reader :video_codec_id, "Codec ID"
+  mediainfo_attr_reader :video_codec_info, "Codec ID/Info"
+  
+  mediainfo_attr_reader :video_frame_rate
+  def fps; video_frame_rate[/[\d.]+/].to_f if video?; end
+  alias_method :framerate, :fps
+  
+  mediainfo_attr_reader :video_frame_rate_mode
+  
+  mediainfo_attr_reader :video_display_aspect_ratio
+  alias_method :display_aspect_ratio, :video_display_aspect_ratio
+  
+  mediainfo_attr_reader :video_bits_pixel_frame, "Bits/(Pixel*Frame)"
+  
+  mediainfo_int_reader :video_width
+  mediainfo_int_reader :video_height
+  
+  def resolution; "#{width}x#{height}" if video? or image?; end
+  def width;  if video?; video_width;  elsif image?; image_width;  end; end
+  def height; if video?; video_height; elsif image?; image_height; end; end
+  
+  mediainfo_date_reader :video_encoded_date
+  mediainfo_date_reader :video_tagged_date
+  
+  ### AUDIO
+  
+  mediainfo_section_query :audio
+  
+  # XXX this breaks from RVideo::Inspector which returns 
+  # something like "#0.1" instead of "1"
+  mediainfo_attr_reader :audio_stream_id, "ID"
+  
+  mediainfo_duration_reader :audio_duration
+  
+  mediainfo_attr_reader :audio_sampling_rate
+  mediainfo_attr_reader :audio_stream_size
+  mediainfo_attr_reader :audio_bit_rate
+  mediainfo_attr_reader :audio_bit_rate_mode
+  mediainfo_attr_reader :audio_interleave_duration, "Interleave, duration"
+  
+  mediainfo_int_reader :audio_resolution
+  alias_method :audio_sample_bit_depth, :audio_resolution
+  
+  mediainfo_attr_reader :audio_format
+  mediainfo_attr_reader :audio_format_info, "Format/Info"
+  mediainfo_attr_reader :audio_format_settings_endianness, "Format settings, Endianness"
+  mediainfo_attr_reader :audio_format_settings_sign, "Format settings, Sign"
+  mediainfo_attr_reader :audio_codec_id, "Codec ID"
+  mediainfo_attr_reader :audio_codec_info, "Codec ID/Info"
+  mediainfo_attr_reader :audio_channel_positions
+  
+  # XXX this breaks from RVideo::Inspector which returns 
+  # strings like "mono" or "stereo" for this method.
+  mediainfo_int_reader :audio_channels, "Channel(s)"
+  def stereo?; 2 == audio_channels; end
+  def mono?;   1 == audio_channels; end
+  
+  mediainfo_date_reader :audio_encoded_date
+  mediainfo_date_reader :audio_tagged_date
+  
+  ### IMAGE
+  
+  mediainfo_section_query :image
+  mediainfo_attr_reader :image_resolution
+  mediainfo_attr_reader :image_format
+  
+  mediainfo_int_reader :image_width
+  mediainfo_int_reader :image_height
+  
+  ###
+  
+  attr_reader :raw_response, :parsed_response,
+    :full_filename, :filename, :path
+  
+  def initialize(full_filename)
+    @mediainfo_binary = "mediainfo"
+    
+    @full_filename = full_filename
+    @path          = File.dirname  @full_filename
+    @filename      = File.basename @full_filename
+    
+    raise ArgumentError, "need a path to a video file, got nil" unless @full_filename
+    raise ArgumentError, "need a path to a video file, #{@full_filename} does not exist" unless File.exist? @full_filename
+    
+    @raw_response = mediainfo!
+    parse!
+  end
+  
+  attr_accessor :mediainfo_binary
+  
+  def mediainfo_version
+    `#{@mediainfo_binary} --Version`[/v([\d.]+)/, 1]
+  end
+  
+private
+  def mediainfo!
+    `#{@mediainfo_binary} #{@full_filename}`
+  end
+  
+  def parse!
+    @parsed_response = {}
+    subsection = nil
+    
+    @raw_response.split("\n").map { |x| x.strip }.each do |line|
+      next if line.empty? || line == "General"
+      
+      if SECTIONS.include? line
+        subsection = line
+        @parsed_response[subsection] = {}
+        next
+      end
+      
+      bucket = @parsed_response
+      bucket = bucket[subsection] if subsection
+      
+      key, value = line.split(":", 2).map { |x| x.strip }
+      
+      bucket[key] = value
+    end
+  end
+end

data/mediainfo.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mediainfo}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Seth Thomas Rasmussen"]
+  s.date = %q{2009-05-10}
+  s.description = %q{}
+  s.email = %q{sethrasmussen@gmail.com}
+  s.extra_rdoc_files = ["lib/mediainfo/attr_readers.rb", "lib/mediainfo.rb", "LICENSE", "README.markdown"]
+  s.files = ["Changelog", "lib/mediainfo/attr_readers.rb", "lib/mediainfo.rb", "LICENSE", "Manifest", "Rakefile", "README.markdown", "mediainfo.gemspec", "test/mediainfo_awaywego_encoded_test.rb", "test/mediainfo_awaywego_test.rb", "test/mediainfo_dinner_test.rb", "test/mediainfo_hats_test.rb", "test/mediainfo_test.rb", "test/mediainfo_vimeo_test.rb", "test/mediainfo_vimeoimage_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://greatseth.com}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Mediainfo", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{mediainfo}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{}
+  s.test_files = ["test/mediainfo_awaywego_encoded_test.rb", "test/mediainfo_awaywego_test.rb", "test/mediainfo_dinner_test.rb", "test/mediainfo_hats_test.rb", "test/mediainfo_test.rb", "test/mediainfo_vimeo_test.rb", "test/mediainfo_vimeoimage_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/test/mediainfo_awaywego_encoded_test.rb

@@ -0,0 +1,269 @@
+require "test_helper"
+require "mediainfo_test_helper"
+
+class MediainfoAwaywegoEncodedTest < ActiveSupport::TestCase
+  def setup
+    @info = mediainfo_mock "AwayWeGo_24fps_253_15000_1920x840.mov"
+  end
+
+  ### GENERAL
+  
+  test "audio?" do
+    assert @info.audio?
+  end
+  
+  test "video?" do
+    assert @info.video?
+  end
+  
+  test "format" do
+    assert_equal "MPEG-PS", @info.format
+  end
+
+  test "format profile" do
+    assert_nil @info.format_profile
+  end
+
+  test "codec id" do
+    assert_nil @info.codec_id
+  end
+
+  mediainfo_test_size
+
+  test "duration" do
+    assert_equal 36224, @info.duration
+    assert_equal "36s 224ms", @info.duration_before_type_cast
+  end
+
+  test "overall bitrate" do
+    assert_equal "17.3 Mbps", @info.overall_bit_rate
+  end
+
+  test "encoded date" do
+    assert_nil @info.encoded_date
+  end
+
+  test "tagged date" do
+    assert_nil @info.tagged_date
+  end
+
+  test "writing application" do
+    assert_nil @info.writing_application
+  end
+
+  test "writing library" do
+    assert_nil @info.writing_library
+  end
+
+  ### VIDEO
+  
+  test "video stream id" do
+    assert_equal "224 (0xE0)", @info.video_stream_id
+  end
+
+  test "video   Format" do
+    assert_equal "MPEG Video", @info.video_format
+  end
+  
+  test "video format version" do
+    assert_equal "Version 2", @info.video_format_version
+  end
+  
+  test "video format settings Matrix" do
+    assert_equal "Default", @info.video_format_settings_matrix
+  end
+  
+  test "video format profile" do
+    assert_nil @info.video_format_profile
+  end
+  
+  test "video format settings CABAC" do
+    assert_nil @info.video_format_settings_cabac
+  end
+  
+  test "video format settings ReFrames" do
+    assert_nil @info.video_format_settings_reframes
+  end
+
+  test "video   Codec ID" do
+    assert_nil @info.video_codec_id
+  end
+  
+  test "video codec info" do
+    assert_nil @info.video_codec_info
+  end
+
+  test "video   Duration" do
+    assert_equal 36202, @info.video_duration
+    assert_equal "36s 202ms", @info.video_duration_before_type_cast
+  end
+  
+  test "video bit rate mode" do
+    assert_equal "Constant", @info.video_bit_rate_mode
+    assert !@info.vbr?
+    assert @info.cbr?
+  end
+
+  test "video   Bit rate" do
+    assert_equal "16.0 Mbps", @info.video_bit_rate
+  end
+  
+  test "video nominal bit rate" do
+    assert_equal "15.0 Mbps", @info.video_nominal_bit_rate
+  end
+  
+  test "resolution" do
+    assert_equal "1920x1080", @info.resolution
+  end
+  
+  test "video   Width" do
+    assert_equal 1920, @info.video_width
+    assert_equal 1920, @info.width
+  end
+
+  test "video   Height" do
+    assert_equal 1080, @info.video_height
+    assert_equal 1080, @info.height
+  end
+
+  test "video   Display aspect ratio" do
+    assert_equal "16/9", @info.video_display_aspect_ratio
+    assert_equal "16/9", @info.display_aspect_ratio
+  end
+
+  test "video   Frame rate" do
+    assert_equal "29.970 fps", @info.video_frame_rate
+    assert_equal 29.97, @info.fps
+    assert_equal 29.97, @info.framerate
+  end
+  
+  test "video frame rate mode" do
+    assert_nil @info.video_frame_rate_mode
+  end
+
+  test "video   Resolution" do
+    assert_nil @info.video_resolution
+  end
+  
+  test "video colorimetry" do
+    assert_equal "4:2:2", @info.video_colorimetry
+    assert_equal "4:2:2", @info.video_colorspace
+  end
+
+  test "video   Scan type" do
+    assert_equal "Interlaced", @info.video_scan_type
+    assert @info.interlaced?
+    assert !@info.progressive?
+  end
+  
+  test "video scan order" do
+    assert_equal "Bottom Field First", @info.video_scan_order
+  end
+
+  test "video   Bits/(Pixel*Frame)" do
+    assert_equal "0.258", @info.video_bits_pixel_frame
+  end
+
+  test "video   Stream size" do
+    assert_nil @info.video_stream_size
+  end
+  
+  test "video encoded date" do
+    assert_nil @info.video_encoded_date
+    # assert_equal "UTC 2009-03-30 19:57:50", @info.video_encoded_date
+  end
+  
+  test "video tagged date" do
+    assert_nil @info.video_tagged_date
+    # assert_equal "UTC 2009-03-30 19:57:57", @info.video_tagged_date
+  end
+
+  ### AUDIO
+  
+  test "audio stream id" do
+    assert_equal "128 (0x80)", @info.audio_stream_id
+  end
+  
+  test "audio   Format" do 
+    assert_equal "AC-3", @info.audio_format
+  end
+  
+  test "audio format info" do
+    assert_equal "Audio Coding 3", @info.audio_format_info
+  end
+  
+  test "audio Format settings, Endianness" do
+    assert_nil @info.audio_format_settings_endianness
+  end
+  
+  test "audio Format settings, Sign" do
+    assert_nil @info.audio_format_settings_sign
+  end
+  
+  test "audio   Codec ID" do
+    assert_nil @info.audio_codec_id
+  end
+
+  test "audio   Codec ID/Info" do
+    assert_nil @info.audio_codec_info
+  end
+
+  test "audio   Duration" do
+    assert_equal 36224, @info.audio_duration
+    assert_equal "36s 224ms", @info.audio_duration_before_type_cast
+  end
+
+  test "audio   Bit rate mode" do
+    assert_equal "Constant", @info.audio_bit_rate_mode
+  end
+
+  test "audio   Bit rate" do
+    assert_equal "64.0 Kbps", @info.audio_bit_rate
+  end
+
+  test "audio   Channel(s)" do
+    assert_equal 2, @info.audio_channels
+  end
+  
+  test "audio channel positions" do
+    assert_equal "L R", @info.audio_channel_positions
+  end
+  
+  test "stereo?" do
+    assert @info.stereo?
+  end
+  
+  test "mono?" do
+    assert !@info.mono?
+  end
+
+  test "audio   Sampling rate" do
+    assert_equal "48.0 KHz", @info.audio_sampling_rate
+  end
+
+  test "audio   Resolution" do
+    assert_nil @info.audio_resolution
+  end
+
+  test "audio   Stream size" do
+    assert_nil @info.audio_stream_size
+  end
+
+  test "audio   Interleave, duration" do
+    assert_nil @info.audio_interleave_duration
+  end
+  
+  test "audio encoded date" do
+    assert_nil @info.audio_encoded_date
+    # assert_equal "UTC 2009-03-30 19:57:50", @info.audio_encoded_date
+  end
+  
+  test "audio tagged date" do
+    assert_nil @info.audio_tagged_date
+    # assert_equal "UTC 2009-03-30 19:57:57", @info.audio_tagged_date
+  end
+  
+  ### IMAGE
+  
+  mediainfo_test_not_an_image
+end