ruby-ffprobe 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+.config
+InstalledFiles
+*.gem
+doc
+*.swp
+test/testcases/source.ogv
+coverage

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Philip Garrett.
+
+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,38 @@
+= FFProbe - ffprobe wrapper for Ruby
+
+FFprobe is a simple multimedia streams analyzer with a command-line
+interface based on the FFmpeg project libraries.  This is a ruby
+interface to that command-line program.
+
+== You will need
+
+* A working Ruby installation
+* A working ffprobe installation (http://sourceforge.net/projects/ffprobe/)
+* A sane build environment
+
+== Author
+
+* Philip Garrett <philgarr at gmail.com>
+
+== Copyright and License
+
+Copyright (c) 2010 Philip Garrett.
+
+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/Rakefile

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rcov/rcovtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ruby-ffprobe"
+    gemspec.summary = "Ruby wrapper for FFprobe multimedia analyzer"
+    gemspec.description = File.read(File.join(File.dirname(__FILE__),"README.rdoc"))
+    gemspec.email = "philgarr@gmail.com"
+    gemspec.homepage = "http://github.com/kingpong/ruby-ffprobe"
+    gemspec.authors = ["Philip Garrett"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+namespace "ffprobe" do
+  task "exec" do
+    next if ENV["FFPROBE"]
+    ENV['PATH'].split(":").each do |dir|
+      fqpath = File.join(dir,"ffprobe")
+      if File.executable?(fqpath)
+        ENV['FFPROBE'] = fqpath
+        break
+      end
+    end
+    next if ENV["FFPROBE"]
+    raise "Could not find ffprobe in your path. You may set the environment variable FFPROBE to point to your ffprobe executable"
+  end
+end
+
+task "set_testopts_verbose" do
+  ENV["TESTOPTS"] = '-v'
+end
+
+Rake::TestTask.new do |t|
+   t.libs << "test"
+   t.test_files = FileList['test/**/test*.rb']
+   t.verbose = true
+ end
+
+desc "Run tests with verbosity enabled"
+task "vtest" => [:set_testopts_verbose, :test]
+
+namespace "test" do
+  desc "Generate ffprobe output test cases"
+  task "cases" => ["ffprobe:exec","test/testcases/source.ogv"] do |t|
+    require "lib/ffprobe/safe_pipe"
+    dest_dir = File.expand_path("test/testcases")
+    source = File.expand_path(t.prerequisites.last)
+    variations = { "no_args" => [] }
+    %w{files frames packets streams tags}.each do |opt|
+      variations[opt]             = ["-show_#{opt}"]
+      variations["pretty_#{opt}"] = ["-show_#{opt}", "-pretty"]
+    end
+    variations["files_streams_tags"] = ["-show_files", "-show_streams", "-show_tags"]
+    variations["pretty_files_streams_tags"] = ["-show_files", "-show_streams", "-show_tags", "-pretty"]
+    variations.each_pair do |name,args|
+      FFProbe::SafePipe.new(ENV["FFPROBE"], *(args + [source])).run do |pipe|
+        File.open(File.join(dest_dir,"#{name}.testcase"),"w") do |output|
+          output.write pipe.read
+        end
+      end
+    end
+  end
+  
+  desc "Cleanup test output and testcases"
+  task "clean" do
+    Dir["test/testcases/*.testcase"].each { |file| File.unlink(file) }
+  end
+end
+
+Rcov::RcovTask.new("coverage") do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.output_dir = "coverage"
+  t.verbose = true
+  t.rcov_opts << '--exclude /gems/'
+end
+
+task "rcov" => "coverage"
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/ffprobe.rb

@@ -0,0 +1,106 @@
+#
+# ffprobe.rb
+#
+# Copyright (c) 2010 Philip Garrett.
+#
+# 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.
+#
+
+require 'ffprobe/entity'
+require 'ffprobe/file_info'
+require 'ffprobe/frame_info'
+require 'ffprobe/packet_info'
+require 'ffprobe/parser'
+require 'ffprobe/result'
+require 'ffprobe/safe_pipe'
+require 'ffprobe/stream_info'
+require 'ffprobe/tags_info'
+
+class FFProbe
+  
+  class << self
+    attr_accessor :executable
+  end
+  self.executable ||= "ffprobe"
+  
+  class InvalidArgument < StandardError; end
+  
+  FEATURES = [ :read_packets, :read_frames, :show_files, :show_frames, :show_packets, :show_streams, :show_tags, :pretty ]
+  FEATURES.each {|feature| attr_accessor(feature) }
+  
+  DEFAULT_FEATURES = [:show_streams, :show_tags]
+  
+  attr_accessor :features
+  def features=(desired_features)
+    @features = desired_features.each {|feature|
+      raise(InvalidArgument, "Unrecognized feature #{feature}") unless FEATURES.include?(feature)
+    }
+  end
+
+  attr_accessor :units
+  alias :units? :units
+  def units=(bool)
+    require 'ffprobe/unit' if bool
+    @units = bool
+  end
+  
+  def initialize(*desired_features)
+    desired_features = DEFAULT_FEATURES if desired_features.empty?
+    self.features = desired_features.reject {|f| f == :units }
+    self.units = desired_features.include?(:units)
+  end
+  
+  def probe(filename)
+    params = features.map {|f| "-#{f.to_s}" }
+    params << filename
+    result = nil
+    pipe = SafePipe.new(executable,*params)
+    pipe.run do |stream|
+      result = Result.from_stream(stream, self.units?)
+    end
+    result.success = pipe.success?
+    result.pretty = self.pretty? if result
+    result
+  end
+  
+  def pretty?
+    features.include?(:pretty)
+  end
+  
+  private
+  
+  def executable
+    self.class.executable
+  end
+  
+end
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/ffprobe/entity.rb

@@ -0,0 +1,33 @@
+class FFProbe
+  class Entity
+    
+    def self.from_hash(hash,units=false)
+      target = new
+      target.units = units
+      hash.each {|k,v| target.__send__("#{k}=", v) }
+      target
+    end
+    
+    attr_accessor :units
+    alias :units? :units
+    
+    def self.units(mapping)
+      mapping.each do |property,unit|
+        self.class_eval <<-EOF
+          def #{property}=(val)
+            if units?
+              if val.nil?
+                @#{property} = nil
+              else
+                @#{property} = Unit.new("\#{val} #{unit}")
+              end
+            else
+              @#{property} = val
+            end
+          end
+        EOF
+      end
+    end
+    
+  end
+end

data/lib/ffprobe/file_info.rb

@@ -0,0 +1,14 @@
+class FFProbe
+  class FileInfo < Entity
+    
+    attr_accessor :filename, :nb_streams, :demuxer_name, :demuxer_long_name,
+                  :start_time, :duration, :size, :bit_rate,
+                  :probed_size, :probed_nb_pkts, :probed_nb_frames
+
+    units :start_time => "s",
+          :duration => "s",
+          :size => "byte",
+          :bit_rate => "bit/s"
+
+  end
+end

data/lib/ffprobe/frame_info.rb

@@ -0,0 +1,15 @@
+class FFProbe
+  class FrameInfo < Entity
+    
+    attr_accessor :codec_type, :pict_type, :quality, :coded_picture_number, :display_picture_number,
+                  :interlaced_frame, :repeat_pict, :reference, :samples_size, :stream_index,
+                  :size, :pkt_pts, :pkt_dts, :pkt_duration, :file_pkt_nb, :stream_pkt_nb, :pkt_flag_key
+
+    units :size => "byte",
+          :pkt_pts => "s",
+          :pkt_dts => "s",
+          :pkt_duration => "s",
+          :samples_size => "byte"
+
+  end
+end

data/lib/ffprobe/packet_info.rb

@@ -0,0 +1,13 @@
+class FFProbe
+  class PacketInfo < Entity
+    
+    attr_accessor :codec_type, :stream_index, :pts, :pts_time, :dts, :dts_time,
+                  :size, :file_pkt_nb, :stream_pkt_nb, :duration_ts, :duration_time, :flag_key
+                
+    units :pts_time => "s",
+          :dts_time => "s",
+          :size => "byte",
+          :duration_time => "s"
+
+  end
+end

data/lib/ffprobe/parser.rb

@@ -0,0 +1,27 @@
+class FFProbe
+  class Parser
+    
+    def parse_stream(io)
+      result = {}
+      dest = nil
+      io.each_line do |line|
+        # $stderr.puts line
+        line.chomp!
+        case line
+        when /\A\[(\w+)\]\Z/
+          (result[$1.to_sym] ||= []).push( dest = {} )
+        when /\A\[\/(\w+)\]\Z/
+          # ignored, stanzas can't nest.
+        when /\A(\w+)=(.*)/
+          if dest
+            dest[$1.to_sym] = $2 == "N/A" ? nil : $2.strip
+          end
+        else
+          (result[:EXTRA] ||= []).push(line)
+        end
+      end
+      result
+    end
+    
+  end
+end

data/lib/ffprobe/result.rb

@@ -0,0 +1,107 @@
+
+class FFProbe
+  class Result
+    
+    def self.from_stream(io,units=false)
+      from_hash(Parser.new.parse_stream(io), units)
+    end
+
+    def self.from_hash(hash,units=false)
+      target = new
+      target.units = units
+      hash.each do |key,value|
+        case key
+        when :FILE
+          target.file = FileInfo.from_hash(value[0], units)
+        when :FRAME
+          target.frames += value.map {|f| FrameInfo.from_hash(f, units) }
+        when :PACKET
+          target.packets += value.map {|p| PacketInfo.from_hash(p, units) }
+        when :STREAM
+          target.streams += value.map {|s| StreamInfo.from_hash(s, units) }
+        when :TAGS
+          target.tags = TagsInfo.from_hash(value[0], units)
+        when :EXTRA
+          target.extra = Array.new(value)
+        end
+      end
+      target
+    end
+    
+    attr_accessor :file
+    attr_accessor :frames
+    attr_accessor :packets
+    attr_accessor :streams
+    attr_accessor :tags
+    attr_accessor :extra
+
+    attr_accessor :pretty
+    alias :pretty? :pretty
+    
+    attr_accessor :success
+    alias :success? :success
+    
+    attr_accessor :units
+    alias :units? :units
+    
+    def initialize
+      @file = FileInfo.new
+      @frames = []
+      @packets = []
+      @streams = []
+      @tags = TagsInfo.new
+      @extra = []
+    end
+    
+    def has_video?
+      @streams.first {|s| s.codec_type == "video" }
+    end
+    
+    def video?
+      @streams.length == 1 && has_video?
+    end
+    
+    def has_audio?
+      @streams.first {|s| s.codec_type == "audio" }
+    end
+    
+    def audio?
+      @streams.length == 1 && has_audio?
+    end
+    
+  end
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+#