mediainfo 0.5.1

data/Changelog

@@ -0,0 +1,24 @@
+v0.5.1 Packaging Fix
+- Gemspec was referencing a missing file
+- Behold: THREE DIGIT VERSION NUMBER. Serious business now!
+
+v0.5 Raw, Son
+- You can now initialize an instance from raw CLI output
+
+v0.4 Mediainfo Respects Your Existing Customs
+- Define String#shell_escape only if it is not already defined
+
+v0.3 Mediainfo Is High Class
+- Class instead of instance-level customization of mediainfo binary path. 
+  Set Mediainfo.path = /path/to/binary if mediainfo is not in your shell 
+  path.
+- Instances retain the :last_command run. The API to rerun that command is 
+  still private.
+- Started defining custom Mediainfo exception classes and are now raising 
+  Mediainfo::ExecutionError instead of RuntimeError if the system command 
+  exits with anything other than 0.
+
+v0.2 Escape from the Shell
+- Added proper escaping for funky filenames. Thanks to Peter Vandenberk!
+
+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,9 @@
+Changelog
+LICENSE
+Manifest
+README.markdown
+Rakefile
+lib/mediainfo.rb
+lib/mediainfo/attr_readers.rb
+lib/mediainfo/string.rb
+mediainfo.gemspec

data/README.markdown

@@ -0,0 +1,40 @@
+# Mediainfo
+
+Mediainfo is a class wrapping [the mediainfo CLI](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.
+
+Mediainfo is inspired by RVideo::Inspector, part of the rvideo gem. 
+The rvideo inspector is based on output from ffmpeg which is not 
+intended to be machine parseable. I spent a little while chasing 
+the ffmpeg development team, and decided finally that perhaps other 
+tools were better. As such, some of the API for Mediainfo is straight 
+from RVideo::Inspector. Some is not. Just saying.
+
+## Requirements
+
+This library is compatible with:
+  
+  MediaInfo Command line, 
+  MediaInfoLib - v0.7.11
+  
+to the extent that is documented in the tests.
+
+## Contributors
+
+* Seth Thomas Rasmussen - [http://greatseth.com](http://greatseth.com)
+* Peter Vandenberk - [http://github.com/pvdb](http://github.com/pvdb)

data/Rakefile

@@ -0,0 +1,37 @@
+require "rake/testtask"
+load "Rakefile.cloud" if File.exist? "Rakefile.cloud"
+
+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.description = "Mediainfo is a class wrapping the mediainfo CLI (http://mediainfo.sourceforge.net)"
+  p.author = "Seth Thomas Rasmussen"
+  p.email = "sethrasmussen@gmail.com"
+  p.url = "http://greatseth.com"
+  p.ignore_pattern = %w( test/**/* )
+end

data/lib/mediainfo.rb

@@ -0,0 +1,260 @@
+require "mediainfo/string"
+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.
+# 
+# You may also initialize a Mediainfo instance using raw CLI output 
+# you have saved for some reason.
+# 
+#   info = Mediainfo.new
+#   info.raw_response = cli_output
+# 
+# Setting the raw_response triggers the system call, and from that point on 
+# the object should behave the same as if you'd initialized it with the path 
+# to a file.
+# 
+# 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
+  def audio_sample_rate
+    return unless rate = audio_sampling_rate_before_type_cast
+    number = rate.gsub(/[^\d.]+/, "").to_f
+    number = case rate
+    when /KHz/ then number * 1000
+    when /Hz/  then number
+    else
+      raise "unhandled sample rate! please report bug!"
+    end
+    number.to_i
+  end
+  alias_method :audio_sampling_rate, :audio_sample_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, :escaped_full_filename
+  
+  def initialize(full_filename = nil)
+    if full_filename
+      @full_filename = File.expand_path 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
+
+      @escaped_full_filename = @full_filename.shell_escape
+
+      self.raw_response = mediainfo!
+    end
+  end
+
+  def raw_response=(mediainfo_cli_output)
+    @raw_response = mediainfo_cli_output
+    parse!
+    @raw_response
+  end
+  
+  class << self; attr_accessor :path; end
+  def path; self.class.path; end
+  
+  def self.default_mediainfo_path!; self.path = "mediainfo"; end
+  default_mediainfo_path! unless path
+  
+  def mediainfo_version
+    `#{path} --Version`[/v([\d.]+)/, 1]
+  end
+  
+  attr_reader :last_command
+  
+  class Error < StandardError; end
+  class ExecutionError < Error; end
+  
+  def inspect
+    super.sub /@raw_response=".+?", @/, %{@raw_response="...", @}
+  end
+  
+private
+  def mediainfo!
+    # for bash, see: http://www.faqs.org/docs/bashman/bashref_12.html
+    # but appears to be working for other shells: sh, zsh, ksh, dash
+    @last_command = "#{path} #{@escaped_full_filename}"
+    run_last_command!
+  end
+  
+  def run_last_command!
+    raw_response = `#{@last_command}`
+    unless $? == 0
+      raise ExecutionError, "Execution of `#{@last_command}` failed: #{raw_response.inspect}"
+    end
+    raw_response
+  end
+  
+  def parse!
+    @parsed_response = {}
+    subsection = nil
+    
+    @raw_response.to_s.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/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