mhs-rvideo 0.9.4

data/lib/rvideo/tools/ffmpeg.rb

@@ -0,0 +1,154 @@
+module RVideo
+  module Tools
+    class Ffmpeg
+      include AbstractTool::InstanceMethods
+      
+      attr_reader :frame, :q, :size, :time, :output_bitrate, :video_size, :audio_size, :header_size, :overhead, :psnr, :output_fps
+      
+      # Not sure if this is needed anymore...
+      def tool_command
+        'ffmpeg'
+      end
+      
+      #
+      # Return -r and the frame rate of the original file. E.g.:
+      #
+      #   -r 29.97
+      #
+      # If the original frame rate can't be determined, return an empty 
+      # string.
+      def original_fps
+        inspect_original if @original.nil?
+        if @original.fps
+          "-r #{@original.fps}" 
+        else
+          ""
+        end
+      end
+      
+      private
+      
+      def parse_result(result)
+        
+        if m = /Unable for find a suitable output format for.*$/.match(result)
+          raise TranscoderError::InvalidCommand, m[0]
+        end
+        
+        if m = /Unknown codec \'(.*)\'/.match(result)
+          raise TranscoderError::InvalidFile, "Codec #{m[1]} not supported by this build of ffmpeg"
+       end
+        
+        if m = /could not find codec parameters/.match(result)
+          raise TranscoderError::InvalidFile, "Codec not supported by this build of ffmpeg"
+        end
+        
+        if m = /I\/O error occured\n(.*)$/.match(result)
+          raise TranscoderError::InvalidFile, "I/O error: #{m[1].strip}"
+        end
+          
+        if m = /\n(.*)Unknown Format$/.match(result)
+          raise TranscoderError::InvalidFile, "unknown format (#{m[1]})"
+        end
+        
+        if m = /\nERROR.*/m.match(result)
+          raise TranscoderError::InvalidFile, m[0]
+        end
+        
+        if result =~ /usage: ffmpeg/
+          raise TranscoderError::InvalidCommand, "must pass a command to ffmpeg"
+        end
+        
+        if result =~ /Output file does not contain.*stream/
+          raise TranscoderError, "Output file does not contain any video or audio streams."
+        end
+        
+        if m = /Unsupported codec.*id=(.*)\).*for input stream\s*(.*)\s*/.match(result) 
+          inspect_original if @original.nil?
+          case m[2]
+          when @original.audio_stream_id
+            codec_type = "audio"
+            codec = @original.audio_codec
+          when @original.video_stream_id
+            codec_type = "video"
+            codec = @original.video_codec
+          else
+            codec_type = "video or audio"
+            codec = "unknown"
+          end
+          
+          raise TranscoderError::InvalidFile, "Unsupported #{codec_type} codec: #{codec} (id=#{m[1]}, stream=#{m[2]})"
+          #raise TranscoderError, "Codec #{m[1]} not supported (in stream #{m[2]})"
+        end
+        
+        # Could not open './spec/../config/../tmp/processed/1/kites-1.avi'
+        if result =~ /Could not open .#{@output_file}.\Z/
+          raise TranscoderError, "Could not write output file to #{@output_file}"
+        end
+          
+        full_details = /Press .* to stop encoding\n(.*)/m.match(result)
+        raise TranscoderError, "Unexpected result details (#{result})" if full_details.nil?
+        details = full_details[1].strip.gsub(/\s*\n\s*/," - ")
+        
+        if details =~ /Could not write header/
+          raise TranscoderError, details
+        end
+        
+        #frame=  584 q=6.0 Lsize=     708kB time=19.5 bitrate= 297.8kbits/s    
+        #video:49kB audio:153kB global headers:0kB muxing overhead 250.444444%
+        
+        #frame= 4126 q=31.0 Lsize=    5917kB time=69.1 bitrate= 702.0kbits/s    
+        #video:2417kB audio:540kB global headers:0kB muxing overhead 100.140277%
+        
+        #frame=  273 fps= 31 q=10.0 Lsize=     398kB time=5.9 bitrate= 551.8kbits/s
+        #video:284kB audio:92kB global headers:0kB muxing overhead 5.723981%
+        
+        #mdb:94, lastbuf:0 skipping granule 0
+        #size=    1080kB time=69.1 bitrate= 128.0kbits /s    
+        #video:0kB audio:1080kB global headers:0kB muxing overhead 0.002893%
+        
+        #size=      80kB time=5.1 bitrate= 128.0kbits/s    ^Msize=     162kB time=10.3 bitrate= 128.0kbits/s    ^Msize=     241kB time=15.4 bitrate= 128.0kbits/s    ^Msize=     329kB time=21.1 bitrate= 128.0kbits/s    ^Msize=     413kB time=26.4 bitrate= 128.0kbits/s    ^Msize=     506kB time=32.4 bitrate= 128.0kbits/s    ^Msize=     591kB time=37.8 bitrate= 128.0kbits/s    ^Msize=     674kB time=43.2 bitrate= 128.0kbits/s    ^Msize=     771kB time=49.4 bitrate= 128.0kbits/s    ^Msize=     851kB time=54.5 bitrate= 128.0kbits/s    ^Msize=     932kB time=59.6 bitrate= 128.0kbits/s    ^Msize=    1015kB time=64.9 bitrate= 128.0kbits/s    ^Msize=    1094kB time=70.0 bitrate= 128.0kbits/s    ^Msize=    1175kB time=75.2 bitrate= 128.0kbits/s    ^Msize=    1244kB time=79.6 bitrate= 128.0kbits/s    ^Msize=    1335kB time=85.4 bitrate= 128.0kbits/s    ^Msize=    1417kB time=90.7 bitrate= 128.0kbits/s    ^Msize=    1508kB time=96.5 bitrate= 128.0kbits/s    ^Msize=    1589kB time=101.7 bitrate= 128.0kbits/s    ^Msize=    1671kB time=106.9 bitrate= 128.0kbits/s    ^Msize=    1711kB time=109.5 bitrate= 128.0kbits/s - video:0kB audio:1711kB global headers:0kB muxing overhead 0.001826%
+        
+        #mdb:14, lastbuf:0 skipping granule 0 - overread, skip -5 enddists: -2 -2 - overread, skip -5 enddists: -2 -2 - size=      90kB time=5.7 bitrate= 128.0kbits/s    \nsize=     189kB time=12.1 bitrate= 128.0kbits/s
+        
+        #size=      59kB time=20.2 bitrate=  24.0kbits/s    \nsize=     139kB time=47.4 bitrate=  24.0kbits/s    \nsize=     224kB time=76.5 bitrate=  24.0kbits/s    \nsize=     304kB time=103.7 bitrate=  24.0kbits/s    \nsi
+        
+        #mdb:14, lastbuf:0 skipping granule 0 - overread, skip -5 enddists: -2 -2 - overread, skip -5 enddists: -2 -2 - size=      81kB time=10.3 bitrate=  64.0kbits/s    \nsize=     153kB time=19.6 bitrate=  64.0kbits/s 
+        
+        #size=      65kB time=4.1 bitrate= 128.1kbits/s    \nsize=     119kB time=7.6 bitrate= 128.0kbits/s    \nsize=     188kB time=12.0 bitrate= 128.0kbits/s    \nsize=     268kB time=17.1 bitrate= 128.0kbits/s    \nsize=
+        
+        #Error while decoding stream #0.1     [mpeg4aac @ 0xb7d089f0]faac: frame decoding failed: Gain control not yet implementedError while decoding stream #0.1frame= 2143 fps= 83 q=4.0 size=    4476kB time=71.3 bitrate= 514.5kbits/s    ^M[mpeg4aac @ 0xb7d089f0]faac: frame decoding failed: Gain control not yet implementedError while decoding stream #0.1
+        
+        # NOTE: had to remove "\s" from "\s.*L.*size=" from this regexp below.
+        # Not sure why. Unit tests were succeeding, but hand tests weren't.
+        if details =~ /video:/ 
+          #success = /^frame=\s*(\S*)\s*q=(\S*).*L.*size=\s*(\S*)\s*time=\s*(\S*)\s*bitrate=\s*(\S*)\s*/m.match(details)
+          @frame = sanitary_match(/frame=\s*(\S*)/, details)
+          @output_fps = sanitary_match(/fps=\s*(\S*)/, details)
+          @q = sanitary_match(/\s+q=\s*(\S*)/, details)
+          @size = sanitary_match(/size=\s*(\S*)/, details)
+          @time = sanitary_match(/time=\s*(\S*)/, details)
+          @output_bitrate = sanitary_match(/bitrate=\s*(\S*)/, details)
+          
+          @video_size = /video:\s*(\S*)/.match(details)[1]
+          @audio_size = /audio:\s*(\S*)/.match(details)[1]
+          @header_size = /headers:\s*(\S*)/.match(details)[1]
+          @overhead = /overhead[:]*\s*(\S*)/.match(details)[1]
+          psnr_match = /PSNR=(.*)\s*size=/.match(details)
+          @psnr = psnr_match[1].strip if psnr_match
+          return true
+        end
+        
+        #[mp3 @ 0x54340c]flv doesnt support that sample rate, choose from (44100, 22050, 11025)
+        #Could not write header for output file #0 (incorrect codec parameters ?)
+        
+        raise TranscoderError::UnexpectedResult, details
+      end
+
+      def sanitary_match(regexp, string)
+        match = regexp.match(string)
+        return match[1] if match
+      end
+      
+    end
+  end
+end

data/lib/rvideo/tools/flvtool2.rb

@@ -0,0 +1,49 @@
+module RVideo
+  module Tools
+    class Flvtool2
+      include AbstractTool::InstanceMethods
+      
+      attr_reader :raw_metadata
+      
+      #attr_reader :has_key_frames, :cue_points, :audiodatarate, :has_video, :stereo, :can_seek_to_end, :framerate, :audiosamplerate, :videocodecid, :datasize, :lasttimestamp,
+      #  :audiosamplesize, :audiosize, :has_audio, :audiodelay, :videosize, :metadatadate, :metadatacreator, :lastkeyframetimestamp, :height, :filesize, :has_metadata, :audiocodecid,
+      #  :duration, :videodatarate, :has_cue_points, :width
+      
+      def tool_command
+        'flvtool2'
+      end
+      
+      private
+      
+      def parse_result(result)
+        if result.empty?
+          return true
+        end
+        
+        if m = /ERROR: No such file or directory(.*)\n/.match(result)
+          raise TranscoderError::InputFileNotFound, m[0]
+        end
+        
+        if m = /ERROR: IO is not a FLV stream/.match(result)
+          raise TranscoderError::InvalidFile, "input must be a valid FLV file"
+        end
+          
+        if m = /Copyright.*Norman Timmler/i.match(result)
+          raise TranscoderError::InvalidCommand, "command printed flvtool2 help text (and presumably didn't execute)"
+        end
+        
+        if m = /ERROR: undefined method .?timestamp.? for nil/.match(result)
+          raise TranscoderError::InvalidFile, "Output file was empty (presumably)"
+        end
+        
+        if m = /\A---(.*)...\Z/m.match(result)
+          @raw_metadata = m[0]
+          return true
+        end
+
+        raise TranscoderError::UnexpectedResult, result
+      end
+      
+    end
+  end
+end

data/lib/rvideo/tools/mencoder.rb

@@ -0,0 +1,65 @@
+module RVideo
+  module Tools
+    class Mencoder
+      include AbstractTool::InstanceMethods
+
+      attr_reader :frame, :size, :time, :bitrate, :video_size, :audio_size, :fps
+
+      def tool_command
+        'mencoder'
+      end
+
+      def original_fps
+        inspect_original if @original.nil?
+        if @original.fps
+          "-ofps #{@original.fps}" 
+        else
+          ""
+        end
+      end
+
+      def parse_result(result)
+        if m = /Exiting.*No output file specified/.match(result)
+          raise TranscoderError::InvalidCommand, "no command passed to mencoder, or no output file specified"
+        end
+        
+        if m = /Sorry, this file format is not recognized\/supported/.match(result)
+          raise TranscoderError::InvalidFile, "unknown format"
+        end
+        
+        if m = /Cannot open file\/device./.match(result)
+          raise TranscoderError::InvalidFile, "I/O error"
+        end
+        
+        if m = /File not found:$/.match(result)
+          raise TranscoderError::InvalidFile, "I/O error"
+        end
+        
+        video_details = result.match /Video stream:(.*)$/
+        if video_details
+          @bitrate = sanitary_match(/Video stream:\s*([0-9.]*)/, video_details[0])
+          @video_size = sanitary_match(/size:\s*(\d*)\s*(\S*)/, video_details[0])
+          @time = sanitary_match(/bytes\s*([0-9.]*)/, video_details[0])
+          @frame = sanitary_match(/secs\s*(\d*)/, video_details[0])
+          @fps = (@frame.to_f / @time.to_f).round_to(3)
+        elsif result =~ /Video stream is mandatory/
+          raise TranscoderError::InvalidFile, "Video stream required, and no video stream found"
+        end
+        
+        audio_details = result.match /Audio stream:(.*)$/
+        if audio_details
+          @audio_size = sanitary_match(/size:\s*(\d*)\s*(\S*)/, audio_details[0])
+        else
+          @audio_size = 0
+        end
+        @size = (@video_size.to_i + @audio_size.to_i).to_s
+      end
+
+      def sanitary_match(regexp, string)
+        match = regexp.match(string)
+        return match[1] if match
+      end
+      
+    end
+  end
+end

data/lib/rvideo/tools/mp4box.rb

@@ -0,0 +1,21 @@
+module RVideo
+  module Tools
+    class Mp4box
+      include AbstractTool::InstanceMethods
+      attr_reader :raw_metadata
+
+      def tool_command
+        'MP4Box'
+      end
+      
+      private
+      
+      def parse_result(result)
+        #currently, no useful info returned in result to determine if successful or not
+        @raw_metadata = result.empty? ? "No Results" : result
+        return true
+      end
+      
+    end
+  end
+end

data/lib/rvideo/tools/mp4creator.rb

@@ -0,0 +1,36 @@
+module RVideo
+  module Tools
+    class Mp4creator
+      include AbstractTool::InstanceMethods
+
+      attr_reader :raw_metadata
+
+      def tool_command
+        'mp4creator'
+      end
+
+      def original_fps
+        inspect_original if @original.nil?
+        if @original.fps
+          "-rate=#{@original.fps}" 
+        else
+          ""
+        end
+      end
+
+      def parse_result(result)
+        if m = /can't open file/.match(result)
+          raise TranscoderError::InvalidFile, "I/O error"
+        end
+        
+        if m = /unknown file type/.match(result)
+          raise TranscoderError::InvalidFile, "I/O error"
+        end
+        
+        @raw_metadata = result.empty? ? "No Results" : result
+        return true
+      end
+
+    end
+  end
+end

data/lib/rvideo/tools/mplayer.rb

@@ -0,0 +1,31 @@
+module RVideo
+  module Tools
+    class Mplayer
+      include AbstractTool::InstanceMethods
+
+      attr_reader :raw_metadata
+
+      def tool_command
+        'mplayer'
+      end
+
+      def parse_result(result)
+        if m = /This will likely crash/.match(result)
+          raise TranscoderError::InvalidFile, "unknown format"
+        end
+        
+        if m = /Failed to open/.match(result)
+          raise TranscoderError::InvalidFile, "I/O error"
+        end
+        
+        if m = /File not found/.match(result)
+          raise TranscoderError::InvalidFile, "I/O error"
+        end
+        
+        @raw_metadata = result.empty? ? "No Results" : result
+        return true
+      end
+
+    end
+  end
+end

data/lib/rvideo/transcoder.rb

@@ -0,0 +1,138 @@
+module RVideo # :nodoc:
+  class Transcoder
+    
+    attr_reader :executed_commands, :processed, :errors, :warnings, :total_time
+    
+    #
+    # To transcode a video, initialize a Transcoder object:
+    #
+    #   transcoder = RVideo::Transcoder.new("/path/to/input.mov")
+    #
+    # Then pass a recipe 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, {: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.
+    # 
+    
+    def initialize(input_file = nil)
+      # Allow a nil input_file for backwards compatibility. (Change at 1.0?)
+      check_input_file(input_file)
+      
+      @input_file = input_file
+      @executed_commands = []
+      @errors = []
+      @warnings = []
+    end
+    
+    def original
+      @original ||= Inspector.new(:file => @input_file)
+    end
+    
+    #
+    # Configure logging. Pass a valid Ruby logger object.
+    #
+    #   logger = Logger.new(STDOUT)
+    #   RVideo::Transcoder.logger = logger
+    #
+    
+    def self.logger=(l)
+      @logger = l
+    end
+    
+    def self.logger
+      if @logger.nil?
+        @logger = Logger.new('/dev/null')
+      end
+      
+      @logger
+    end
+    
+    #
+    # Requires a command and a hash of various interpolated options. The
+    # command should be one or more lines of transcoder tool commands (e.g.
+    # ffmpeg, flvtool2). Interpolate options by adding $option_key$ to the
+    # recipe, and passing :option_key => "value" in the options hash.
+    #
+    #   recipe = "ffmpeg -i $input_file$ -ar 22050 -ab 64 -f flv -r 29.97 
+    #   recipe += "-s $resolution$ -y $output_file$"
+    #   recipe += "\nflvtool2 -U $output_file$"
+    #
+    #   transcoder = RVideo::Transcoder.new("/path/to/input.mov")
+    #   begin
+    #     transcoder.execute(recipe, {:output_file => "/path/to/output.flv", :resolution => "320x240"})
+    #   rescue TranscoderError => e
+    #     puts "Unable to transcode file: #{e.class} - #{e.message}"
+    #   end
+    #
+    
+    def execute(task, options = {})
+      t1 = Time.now
+      
+      if @input_file.nil?
+        @input_file = options[:input_file]
+      end
+      
+      Transcoder.logger.info("\nNew transcoder job\n================\nTask: #{task}\nOptions: #{options.inspect}")
+      parse_and_execute(task, options)      
+      @processed = Inspector.new(:file => options[:output_file])
+      result = check_integrity
+      Transcoder.logger.info("\nFinished task. Total errors: #{@errors.size}\n")
+      @total_time = Time.now - t1
+      result
+    rescue TranscoderError => e
+      raise e
+    rescue Exception => e
+      Transcoder.logger.error("[ERROR] Unhandled RVideo exception: #{e.class} - #{e.message}\n#{e.backtrace}")
+      raise TranscoderError::UnknownError, "Unexpected RVideo error: #{e.message} (#{e.class})"
+    end
+        
+    private
+    
+    def check_input_file(input_file)
+      if input_file and !FileTest.exist?(input_file.gsub("\"",""))
+        raise TranscoderError::InputFileNotFound, "File not found (#{input_file})"
+      end
+    end
+    
+    def check_integrity
+      precision = 1.1
+      if @processed.invalid?
+        @errors << "Output file invalid"
+      elsif (@processed.duration >= (original.duration * precision) or @processed.duration <= (original.duration / precision))
+        @errors << "Original file has a duration of #{original.duration}, but processed file has a duration of #{@processed.duration}"
+      end
+      return @errors.size == 0
+    end
+    
+    def parse_and_execute(task, options = {})
+      raise TranscoderError::ParameterError, "Expected a recipe class (as a string), but got a #{task.class.to_s} (#{task})" unless task.is_a? String
+      options = options.merge(:input_file => @input_file)
+      
+      commands = task.split("\n").compact
+      commands.each do |c|
+        tool = Tools::AbstractTool.assign(c, options)
+        tool.original = @original
+        tool.execute
+        executed_commands << tool
+      end
+    end
+  end
+end

data/lib/rvideo/version.rb

@@ -0,0 +1,9 @@
+module Rvideo #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 9
+    TINY  = 4
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/rvideo.rb

@@ -0,0 +1,20 @@
+$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 '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')
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: mhs-rvideo
+version: !ruby/object:Gem::Version 
+  version: 0.9.4
+platform: ruby
+authors: 
+- Jonathan Dahl (Slantwise Design)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-27 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Inspect and process video or audio files.
+email: jon@slantwisedesign.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- README.txt
+- RULES
+- Rakefile
+- lib/rvideo.rb
+- lib/rvideo/errors.rb
+- lib/rvideo/float.rb
+- lib/rvideo/inspector.rb
+- lib/rvideo/tools/abstract_tool.rb
+- lib/rvideo/tools/ffmpeg.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/transcoder.rb
+- lib/rvideo/version.rb
+has_rdoc: true
+homepage: http://github.com/mhs/rvideo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rvideo
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Inspect and process video or audio files.
+test_files: []
+