debprado-rvideo 0.9.6

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Jonathan Dahl and Slantwise Design
+
+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.txt

@@ -0,0 +1,91 @@
+RVideo
+
+RVideo allows you to inspect and process video files.
+
+
+Installation is a little involved. First, install the gem:
+
+  sudo gem install rvideo
+  
+Next, install ffmpeg and (possibly) other related libraries. This is
+documented elsewhere on the web, and can be a headache. If you are on OS X,
+the Darwinports build is reasonably good (though not perfect). Install with:
+
+  sudo port install ffmpeg
+
+Or, for a better build (recommended), add additional video- and audio-related
+libraries, like this:
+
+  sudo port install ffmpeg +lame +libogg +vorbis +faac +faad +xvid +x264 +a52
+  
+Most package management systems include a build of ffmpeg, but many include a
+poor build. So you may need to compile from scratch.
+
+If you want to create Flash Video files, also install flvtool2:
+
+  sudo gem install flvtool2
+
+Once ffmpeg and RVideo are installed, you're set. 
+
+To inspect a file, initialize an RVideo file inspector object. See the 
+documentation for details.
+
+A few examples:
+
+  file = RVideo::Inspector.new(:file => "#{APP_ROOT}/files/input.mp4")
+  
+  file = RVideo::Inspector.new(:raw_response => @existing_response)
+  
+  file = RVideo::Inspector.new(:file => "#{APP_ROOT}/files/input.mp4",
+                                :ffmpeg_binary => "#{APP_ROOT}/bin/ffmpeg")
+
+  file.fps        # "29.97"
+  file.duration   # "00:05:23.4"
+
+To transcode a video, initialize a Transcoder object.
+
+  transcoder = RVideo::Transcoder.new
+
+Then pass a command and valid options to the execute method
+
+  recipe = "ffmpeg -i $input_file$ -ar 22050 -ab 64 -f flv -r 29.97 -s"
+  recipe += " $resolution$ -y $output_file$"
+  recipe += "\nflvtool2 -U $output_file$"
+  begin
+    transcoder.execute(recipe, {:input_file => "/path/to/input.mp4",
+      :output_file => "/path/to/output.flv", :resolution => "640x360"})
+  rescue TranscoderError => e
+    puts "Unable to transcode file: #{e.class} - #{e.message}"
+  end
+
+If the job succeeds, you can access the metadata of the input and output
+files with:
+
+  transcoder.original     # RVideo::Inspector object
+  transcoder.processed    # RVideo::Inspector object
+
+If the transcoding succeeds, the file may still have problems. RVideo
+will populate an errors array if the duration of the processed video
+differs from the duration of the original video, or if the processed
+file is unreadable.
+
+Thanks to Peter Boling for early work on RVideo.
+
+Contribute to RVideo! If you want to help out, there are a few things you can 
+do.
+
+- Use, test, and submit bugs/patches
+- We need a RVideo::Tools::Mencoder class to add mencoder support.
+- Other tool classes would be great - On2, mp4box, Quicktime (?), etc.
+- Submit other fixes, features, optimizations, and refactorings
+
+If RVideo is useful to you, you may also be interested in RMovie, another Ruby
+video library. See http://rmovie.rubyforge.org/ for more.
+
+Finally, watch for Zencoder, a commercial video transcoder built by Slantwise 
+Design. Zencoder uses RVideo for its video processing, but adds file queuing,  
+distributed transcoding, a web-based transcoder dashboard, and more. See 
+http://zencoder.tv or http://slantwisedesign.com for more.
+
+Copyright (c) 2007 Jonathan Dahl and Slantwise Design. Released under the MIT 
+license.

data/RULES

@@ -0,0 +1,11 @@
+Collection of transcoding edge cases and rules
+------------------------
+
+* mpeg4 output errors out if frame rate is not supplied
+  
+  [mpeg4 @ 0x149e810]timebase not supported by mpeg 4 standard
+  Error while opening codec for output stream #0.0 - maybe incorrect parameters such as bit_rate, rate, width or height
+  
+  Solution: provide a frame rate with -r (any frame rate will do)
+  
+  

data/debprado-rvideo.gemspec

@@ -0,0 +1,10 @@
+Gem::Specification.new do |s|
+  s.name = "debprado-rvideo"
+  s.version = "0.9.6"
+  s.summary = "RVideo is a Ruby library for inspecting and transcoding video and audio files."
+  s.homepage = "http://gemcutter.org/gems/debprado-rvideo"
+  s.description = "Gives you video"
+  s.has_rdoc = false
+  s.authors = ["Adam Singer", "Zencoder"]
+  s.files = ["lib", "License.txt", "debprado-rvideo.gemspec", "RULES", "README.txt", "lib/rvideo.rb", "lib/rvideo/errors.rb", "lib/rvideo/float.rb", "lib/rvideo/inspector.rb", "lib/rvideo/transcoder.rb", "lib/rvideo/version.rb", "lib/rvideo/tools/abstract_tool.rb", "lib/rvideo/tools/ffmpeg.rb", "lib/rvideo/tools/ffmpeg2theora.rb", "lib/rvideo/tools/flvtool2.rb", "lib/rvideo/tools/mencoder.rb", "lib/rvideo/tools/mp4box.rb", "lib/rvideo/tools/mp4creator.rb", "lib/rvideo/tools/mplayer.rb", "lib/rvideo/tools/yamdi.rb"]
+end

data/lib/rvideo.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/rvideo'
+
+require 'inspector'
+require 'float'
+require 'tools/abstract_tool'
+require 'tools/ffmpeg'
+require 'tools/mencoder'
+require 'tools/flvtool2'
+require 'tools/mp4box'
+require 'tools/mplayer'
+require 'tools/mp4creator'
+require 'tools/ffmpeg2theora'
+require 'tools/yamdi'
+require 'errors'
+require 'transcoder'
+require 'active_support'
+
+TEMP_PATH = File.expand_path(File.dirname(__FILE__) + '/../tmp')
+FIXTURE_PATH = File.expand_path(File.dirname(__FILE__) + '/../spec/fixtures')
+TEST_FILE_PATH = File.expand_path(File.dirname(__FILE__) + '/../spec/files')
+REPORT_PATH = File.expand_path(File.dirname(__FILE__) + '/../report')
+

data/lib/rvideo/errors.rb

@@ -0,0 +1,24 @@
+module RVideo
+  class TranscoderError < RuntimeError
+    class InvalidCommand < TranscoderError
+    end
+  
+    class InvalidFile < TranscoderError
+    end
+    
+    class InputFileNotFound < TranscoderError
+    end
+    
+    class UnexpectedResult < TranscoderError
+    end
+    
+    class ParameterError < TranscoderError
+    end
+    
+    class UnknownError < TranscoderError
+    end
+    
+    class UnknownTool < TranscoderError
+    end
+  end
+end

data/lib/rvideo/float.rb

@@ -0,0 +1,7 @@
+# Add a rounding method to the Float class.
+class Float
+  def round_to(x)
+    (self * 10**x).round.to_f / 10**x
+  end
+end
+

data/lib/rvideo/inspector.rb

@@ -0,0 +1,545 @@
+module RVideo # :nodoc:
+  class Inspector
+  
+    attr_reader :filename, :path, :full_filename, :raw_response, :raw_metadata
+    
+    attr_accessor :ffmpeg_binary
+    
+    #
+    # To inspect a video or audio file, initialize an Inspector object.
+    # 
+    #   file = RVideo::Inspector.new(options_hash)
+    # 
+    # Inspector accepts three options: file, raw_response, and ffmpeg_binary.
+    # Either raw_response or file is required; ffmpeg binary is optional. 
+    # 
+    # :file is a path to a file to be inspected.
+    # 
+    # :raw_response is the full output of "ffmpeg -i [file]". If the
+    # :raw_response option is used, RVideo will not actually inspect a file;
+    # it will simply parse the provided response. This is useful if your
+    # application has already collected the ffmpeg -i response, and you don't
+    # want to call it again.
+    # 
+    # :ffmpeg_binary is an optional argument that specifies the path to the
+    # ffmpeg binary to be used. If a path is not explicitly declared, RVideo
+    # will assume that ffmpeg exists in the Unix path. Type "which ffmpeg" to
+    # check if ffmpeg is installed and exists in your operating system's path.
+    # 
+
+    def initialize(options = {})
+      if options[:raw_response]
+        @raw_response = options[:raw_response]
+      elsif options[:file]
+        if options[:ffmpeg_binary]
+          @ffmpeg_binary = options[:ffmpeg_binary]
+          raise RuntimeError, "ffmpeg could not be found (trying #{@ffmpeg_binary})" unless FileTest.exist?(@ffmpeg_binary)
+        else
+          # assume it is in the unix path
+          raise RuntimeError, 'ffmpeg could not be found (expected ffmpeg to be found in the Unix path)' unless FileTest.exist?(`which ffmpeg`.chomp)
+          @ffmpeg_binary = "ffmpeg"
+        end
+
+        file = options[:file]
+        @filename = File.basename(file)
+        @path = File.dirname(file)
+        @full_filename = file
+        raise TranscoderError::InputFileNotFound, "File not found (#{file})" unless FileTest.exist?(file.gsub("\"",""))
+        @raw_response = `#{@ffmpeg_binary} -i #{@full_filename} 2>&1`
+      else
+        raise ArgumentError, "Must supply either an input file or a pregenerated response" if options[:raw_response].nil? and file.nil?
+      end
+
+      metadata = /(Input \#.*)\n[Must|At least]/m.match(@raw_response)
+      
+      if /Unknown format/i.match(@raw_response) || metadata.nil?
+        @unknown_format = true
+      elsif /Duration: N\/A/im.match(@raw_response)
+#      elsif /Duration: N\/A|bitrate: N\/A/im.match(@raw_response)
+        @unreadable_file = true
+        @raw_metadata = metadata[1] # in this case, we can at least still get the container type
+      else
+        @raw_metadata = metadata[1]
+      end
+    end
+    
+    #
+    # Returns true if the file can be read successfully. Returns false otherwise.
+    #
+      
+    def valid?
+      if @unknown_format or @unreadable_file
+        false
+      else
+        true
+      end
+    end
+    
+    #
+    # Returns false if the file can be read successfully. Returns false otherwise.
+    #
+    
+    def invalid?
+      !valid?
+    end
+    
+    #
+    # True if the format is not understood ("Unknown Format")
+    #
+    
+    def unknown_format?
+      if @unknown_format
+        true
+      else
+        false
+      end
+    end
+    
+    #
+    # True if the file is not readable ("Duration: N/A, bitrate: N/A")
+    #
+    
+    def unreadable_file?
+      if @unreadable_file
+        true
+      else
+        false
+      end
+    end
+    
+    #
+    # Does the file have an audio stream?
+    #
+    
+    def audio?
+      if audio_match.nil?
+        false
+      else
+        true
+      end
+    end
+    
+    #
+    # Does the file have a video stream?
+    #
+    
+    def video?
+      if video_match.nil?
+        false
+      else
+        true
+      end
+    end     
+    
+    #
+    # Take a screengrab of a movie. Requires an input file and a time parameter, and optionally takes an output filename. If no output filename is specfied, constructs one.
+    #
+    # Three types of time parameters are accepted - percentage (e.g. 3%), time in seconds (e.g. 60 seconds), and raw frame (e.g. 37). Will raise an exception if the time in seconds or the frame are out of the bounds of the input file.
+    #
+    # Types:
+    #   37s (37 seconds)
+    #   37f (frame 37)
+    #   37% (37 percent)
+    #   37  (default to seconds)
+    #
+    # If a time is outside of the duration of the file, it will choose a frame at the 99% mark.
+    #
+    # Example:
+    #
+    #   t = RVideo::Transcoder.new('path/to/input_file.mp4')
+    #   t.capture_frame('10%') # => '/path/to/screenshot/input-10p.jpg'
+    #
+    
+    def capture_frame(timecode, output_file = nil)
+      t = calculate_time(timecode)
+      unless output_file
+        output_file = "#{TEMP_PATH}/#{File.basename(@full_filename, ".*")}-#{timecode.gsub("%","p")}.jpg"
+      end
+      # do the work
+      # mplayer $input_file$ -ss $start_time$ -frames 1 -vo jpeg -o $output_file$
+      # ffmpeg -i $input_file$ -v nopb -ss $start_time$ -b $bitrate$ -an -vframes 1 -y $output_file$
+      command = "ffmpeg -i #{@full_filename} -ss #{t} -t 00:00:01 -r 1 -vframes 1 -f image2 #{output_file}"
+      Transcoder.logger.info("\nCreating Screenshot: #{command}\n")
+      frame_result = `#{command} 2>&1`
+      Transcoder.logger.info("\nScreenshot results: #{frame_result}")
+      output_file
+    end
+    
+    def calculate_time(timecode)
+      m = /\A([0-9\.\,]*)(s|f|%)?\Z/.match(timecode)
+      if m.nil? or m[1].nil? or m[1].empty?
+        raise TranscoderError::ParameterError, "Invalid timecode for frame capture: #{timecode}. Must be a number, optionally followed by s, f, or %."
+      end
+      
+      case m[2]
+      when "s", nil
+        t = m[1].to_f
+      when "f"
+        t = m[1].to_f / fps.to_f
+      when "%"
+        # milliseconds / 1000 * percent / 100 
+        t = (duration.to_i / 1000.0) * (m[1].to_f / 100.0)
+      else
+        raise TranscoderError::ParameterError, "Invalid timecode for frame capture: #{timecode}. Must be a number, optionally followed by s, f, or p."
+      end
+      
+      if (t * 1000) > duration
+        calculate_time("99%")
+      else
+        t
+      end
+    end
+    
+    #
+    # Returns the version of ffmpeg used, In practice, this may or may not be 
+    # useful.
+    #
+    # Examples:
+    #
+    #   SVN-r6399
+    #   CVS
+    #
+    
+    def ffmpeg_version
+      @ffmpeg_version = @raw_response.split("\n").first.split("version").last.split(",").first.strip
+    end
+    
+    #
+    # Returns the configuration options used to build ffmpeg.
+    #
+    # Example:
+    #
+    #   --enable-mp3lame --enable-gpl --disable-ffplay --disable-ffserver
+    #     --enable-a52 --enable-xvid
+    #
+    
+    def ffmpeg_configuration 
+      /(\s*configuration:)(.*)\n/.match(@raw_response)[2].strip
+    end
+    
+    #
+    # Returns the versions of libavutil, libavcodec, and libavformat used by
+    # ffmpeg.
+    #
+    # Example:
+    #
+    #   libavutil version: 49.0.0
+    #   libavcodec version: 51.9.0
+    #   libavformat version: 50.4.0
+    #
+    
+    def ffmpeg_libav
+      /^(\s*lib.*\n)+/.match(@raw_response)[0].split("\n").each {|l| l.strip! }
+    end
+    
+    #
+    # Returns the build description for ffmpeg.
+    #
+    # Example:
+    #
+    #   built on Apr 15 2006 04:58:19, gcc: 4.0.1 (Apple Computer, Inc. build
+    #     5250)
+    #
+    
+    def ffmpeg_build
+      /(\n\s*)(built on.*)(\n)/.match(@raw_response)[2]
+    end
+    
+    #
+    # Returns the container format for the file. Instead of returning a single
+    # format, this may return a string of related formats.
+    #
+    # Examples:
+    #
+    #   "avi"
+    #
+    #   "mov,mp4,m4a,3gp,3g2,mj2"
+    #
+    
+    def container
+      return nil if @unknown_format
+      
+      /Input \#\d+\,\s*(\S+),\s*from/.match(@raw_metadata)[1]
+    end
+    
+    #
+    # The duration of the movie, as a string.
+    #
+    # Example:
+    #
+    #   "00:00:24.4"  # 24.4 seconds
+    #
+    def raw_duration
+      return nil unless valid?
+      
+      /Duration:\s*([0-9\:\.]+),/.match(@raw_metadata)[1]
+    end
+    
+    #
+    # The duration of the movie in milliseconds, as an integer.
+    #
+    # Example: 
+    #
+    #   24400         # 24.4 seconds
+    #
+    # Note that the precision of the duration is in tenths of a second, not 
+    # thousandths, but milliseconds are a more standard unit of time than
+    # deciseconds.
+    #
+    
+    def duration
+      return nil unless valid?
+      
+      units = raw_duration.split(":")
+      (units[0].to_i * 60 * 60 * 1000) + (units[1].to_i * 60 * 1000) + (units[2].to_f * 1000).to_i
+    end
+    
+    # 
+    # The bitrate of the movie.
+    #
+    # Example:
+    #   
+    #  3132
+    #
+    
+    def bitrate
+      return nil unless valid?
+      
+      bitrate_match[1].to_i
+    end
+    
+    # 
+    # The bitrate units used. In practice, this may always be kb/s.
+    #
+    # Example:
+    #   
+    #   "kb/s"
+    #
+    
+    def bitrate_units
+      return nil unless valid?
+      
+      bitrate_match[2]
+    end
+    
+    def audio_bit_rate # :nodoc:
+      nil
+    end
+    
+    def audio_stream
+      return nil unless valid?
+      
+      #/\n\s*Stream.*Audio:.*\n/.match(@raw_response)[0].strip
+      match = /\n\s*Stream.*Audio:.*\n/.match(@raw_response)
+      return match[0].strip if match
+    end
+    
+    # 
+    # The audio codec used.
+    #
+    # Example:
+    #
+    #   "aac"
+    #
+  
+    def audio_codec
+      return nil unless audio?
+      
+      audio_match[2]
+    end
+    
+    #
+    # The sampling rate of the audio stream.
+    #
+    # Example:
+    #
+    #   44100
+    #
+    
+    def audio_sample_rate
+      return nil unless audio?
+      
+      audio_match[3].to_i
+    end
+    
+    #
+    # The units used for the sampling rate. May always be Hz.
+    #
+    # Example:
+    #
+    #   "Hz"
+    #
+    
+    def audio_sample_units
+      return nil unless audio?
+      
+      audio_match[4]
+    end
+    
+    #
+    # The channels used in the audio stream.
+    #
+    # Examples:
+    #   "stereo"
+    #   "mono"
+    #   "5:1"
+    #
+    
+    def audio_channels_string
+      return nil unless audio?
+      
+      audio_match[5]
+    end
+    
+    def audio_channels
+      return nil unless audio?
+
+      case audio_match[5]
+      when "mono"
+        1
+      when "stereo"
+        2
+      else
+        raise RuntimeError, "Unknown number of channels: #{audio_channels}"
+      end
+    end
+    
+    # 
+    # The ID of the audio stream (useful for troubleshooting).
+    #
+    # Example:
+    #   #0.1
+    #
+    
+    def audio_stream_id
+      return nil unless audio?
+      
+      audio_match[1]
+    end
+    
+    def video_stream
+      return nil unless valid?
+      
+      match = /\n\s*Stream.*Video:.*\n/.match(@raw_response)
+      return match[0].strip unless match.nil?
+      nil
+    end
+    
+    # 
+    # The ID of the video stream (useful for troubleshooting).
+    #
+    # Example:
+    #   #0.0
+    #
+    
+    def video_stream_id
+      return nil unless video?
+      
+      video_match[1]
+    end
+    
+    # 
+    # The video codec used.
+    #
+    # Example:
+    #
+    #   "mpeg4"
+    #
+    
+    def video_codec
+      return nil unless video?
+      
+      video_match[2]
+    end
+    
+    #
+    # The colorspace of the video stream.
+    #
+    # Example:
+    #
+    #   "yuv420p"
+    #
+    
+    def video_colorspace
+      return nil unless video?
+      
+      video_match[3]
+    end
+    
+    #
+    # The width of the video in pixels.
+    #
+    
+    def width
+      return nil unless video?
+      
+      video_match[4].to_i
+    end
+    
+    #
+    # The height of the video in pixels.
+    #
+    
+    def height
+      return nil unless video?
+      
+      video_match[5].to_i
+    end
+    
+    #
+    # width x height, as a string.
+    #
+    # Examples:
+    #   320x240
+    #   1280x720
+    #
+    
+    def resolution
+      return nil unless video?
+      
+      "#{width}x#{height}"
+    end
+    
+    # 
+    # The frame rate of the video in frames per second
+    #
+    # Example:
+    #
+    #   "29.97"
+    #
+    
+    def fps
+      return nil unless video?
+      
+      /([0-9\.]+) (fps|tb)/.match(video_stream)[1]
+    end
+    
+    private
+
+    def bitrate_match
+      /bitrate: ([0-9\.]+)\s*(.*)\s+/.match(@raw_metadata)
+    end
+
+    def audio_match
+      return nil unless valid?
+      
+      /Stream\s*(.*?)[,|:|\(|\[].*?\s*Audio:\s*(.*?),\s*([0-9\.]*) (\w*),\s*([a-zA-Z:]*)/.match(audio_stream)
+    end
+
+    def video_match
+      return nil unless valid?
+      
+      match = /Stream\s*(.*?)[,|:|\(|\[].*?\s*Video:\s*(.*?),\s*(.*?),\s*(\d*)x(\d*)/.match(video_stream)
+
+      # work-around for Apple Intermediate format, which does not have a color space
+      # I fake up a match data object (yea, duck typing!) with an empty spot where
+      # the color space would be.
+      if match.nil?
+        match = /Stream\s*(.*?)[,|:|\(|\[].*?\s*Video:\s*(.*?),\s*(\d*)x(\d*)/.match(video_stream)
+        match = [nil, match[1], match[2], nil, match[3], match[4]] unless match.nil?
+      end
+      
+      match
+    end
+  end
+end