rvideo-tecnobrat 0.9.4

data/spec/units/transcoder_spec.rb

@@ -0,0 +1,140 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+def setup_spec
+  @options = {:input_file => "foo", :output_file => "bar", :resolution => "baz"}
+  @simple_avi = "ffmpeg -i $input_file$ -ar 44100 -ab 64 -vcodec xvid -acodec mp3 -r 29.97 -s $resolution$ -y $output_file$"
+  @transcoder = RVideo::Transcoder.new
+  @mock_original_file = mock(:original)
+  @mock_original_file.stub!(:raw_response)
+  RVideo::Inspector.stub!(:new).and_return(@mock_original_file)
+end
+
+module RVideo
+  
+  describe Transcoder, " when the execute method receives valid parameters" do
+    before do
+      setup_spec
+      @transcoder.stub!(:check_integrity).and_return(true)
+    end
+    
+    it "should pass a string as-is, along with options" do
+      @transcoder.stub!(:parse_and_execute)
+      @simple_avi = "ffmpeg -i foo"
+      @transcoder.execute(@simple_avi, @options)
+    end
+    
+    it "should store a Tool object at transcoder.executed_commands" do
+      @mock_ffmpeg = mock("ffmpeg")
+      Tools::AbstractTool.stub!(:assign).and_return(@mock_ffmpeg)
+      @mock_ffmpeg.should_receive(:execute)
+      @transcoder.execute(@simple_avi, @options)
+      @transcoder.executed_commands.size.should == 1
+      @transcoder.executed_commands.first.should == @mock_ffmpeg
+    end
+    
+  end
+  
+  describe Transcoder, " file integrity checks" do
+
+    before do
+      setup_spec
+      @transcoder.stub!(:parse_and_execute)
+      @mock_processed_file = mock("processed")
+      @mock_original_file.stub!(:duration).and_return 10
+      @mock_processed_file.stub!(:duration).and_return 10
+      @mock_processed_file.stub!(:invalid?).and_return false
+      Inspector.should_receive(:new).once.with(:file => "foo").and_return(@mock_original_file)
+      Inspector.should_receive(:new).once.with(:file => "bar").and_return(@mock_processed_file)
+    end
+
+    it "should call the inspector twice on a successful job, and should set @original and @processed" do
+      @transcoder.original.should be_nil
+      @transcoder.processed.should be_nil
+
+      @transcoder.execute(@simple_avi, @options)
+      @transcoder.original.should == @mock_original_file
+      @transcoder.processed.should == @mock_processed_file
+    end
+    
+    it "should check integrity" do
+      @transcoder.should_receive(:check_integrity).once.and_return true
+      @transcoder.execute(@simple_avi, @options).should be_true
+      @transcoder.errors.should be_empty
+    end
+    
+    it "should fail if output duration is more than 10% different than the original" do
+      @mock_original_file.should_receive(:duration).twice.and_return(10)
+      @mock_processed_file.should_receive(:duration).twice.and_return(13)
+      @transcoder.execute(@simple_avi, @options).should be_false
+      @transcoder.errors.should == ["Original file has a duration of 10, but processed file has a duration of 13"]
+    end
+    
+    it "should fail if the processed file is invalid" do
+      @mock_processed_file.should_receive(:invalid?).and_return(true)
+      @transcoder.execute(@simple_avi, @options).should be_false
+      @transcoder.errors.should_not be_empty
+    end
+    
+  end
+  
+  describe Transcoder, "#parse_and_execute" do
+    before do
+      @options = {:input_file => "foo", :output_file => "bar", :resolution => "baz"}
+      @simple_avi = "ffmpeg -i $input_file$ -ar 44100 -ab 64 -vcodec xvid -acodec mp3 -r 29.97 -s $resolution$ -y $output_file$"
+      @mock_tool = mock("tool")
+      @mock_tool.stub!(:execute)
+      @transcoder = Transcoder.new
+      Inspector.stub!(:new)
+    end
+    
+    it "should assign a command via AbstractTool.assign, and pass the right options" do
+      Tools::AbstractTool.should_receive(:assign).with(@simple_avi, @options).and_return(@mock_tool)
+      @transcoder.send(:parse_and_execute, @simple_avi, @options)
+    end
+
+    it "should call Tools::AbstractTool once with a one-line recipe" do
+      Tools::AbstractTool.should_receive(:assign).once.and_return(@mock_tool)
+      @transcoder.send(:parse_and_execute, @simple_avi, @options)
+    end
+    
+    it "should call twice with a two-line recipe" do
+      two_line = "ffmpeg -i foo \n ffmpeg -i bar"
+      Tools::AbstractTool.should_receive(:assign).twice.and_return(@mock_tool)
+      @transcoder.send(:parse_and_execute, two_line, @options)
+    end
+    
+    it "should call five times with a five-line recipe" do
+      five_line = "ffmpeg -i foo \n ffmpeg -i bar \n flvtool -i foo \n mp4box \n qt tools 8"
+      Tools::AbstractTool.should_receive(:assign).exactly(5).and_return(@mock_tool)
+      @transcoder.send(:parse_and_execute, five_line, @options)
+    end
+    
+    it "should pass an exception from the abstract tool" do
+      Tools::AbstractTool.should_receive(:assign).and_raise(TranscoderError::UnexpectedResult)
+      
+      lambda {
+        @transcoder.send(:parse_and_execute, @simple_avi, @options)
+      }.should raise_error(TranscoderError::UnexpectedResult)
+    end
+  end
+
+  describe Transcoder, " when the execute method receives invalid parameters" do
+    before do
+      setup_spec
+    end
+    
+    it "should raise an exception when trying to call a tool that doesn't exist" do
+      lambda {
+        @transcoder.send(:parse_and_execute, "foo -i bar")
+      }.should raise_error(NameError, "uninitialized constant RVideo::Tools::Foo")
+    end
+    
+    it "should raise an exception when the first argument is not a string" do
+      [String, 1, 1.0, true, nil, :foo].each do |obj|
+        lambda {
+          @transcoder.execute(obj)
+        }.should raise_error(TranscoderError::UnknownError, /ArgumentError.*first/)      
+      end
+    end
+  end
+end

data/website/index.html

@@ -0,0 +1,219 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Ruby Video Processing
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+    <div style="text-align:right">
+      <a href="http://rvideo.rubyforge.org/rdoc">Documentation</a> | <a href="http://zencoder.tv">Zencoder</a> | <a href="http://railspikes.com">Blog</a> | <a href="http://groups.google.com/group/rvideo">Group</a>
+    </div>
+    <h1>Ruby Video Processing</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/rvideo"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/rvideo" class="numbers">0.9.3</a>
+    </div>
+    <h1>&#x2192; &#8216;rvideo&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+	<p>RVideo is a Ruby library inspects and processes video and audio files by 
+providing an interface to free Unix tools like ffmpeg.</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p>Installation is a little involved. First, install the gem:</p>
+
+
+<pre syntax="ruby">sudo gem install rvideo</pre>
+
+	<p>Next, install ffmpeg and (possibly) other related libraries. This is
+documented elsewhere on the web, and can be a headache. If you are on a Mac,
+the Macports build is reasonably good (though not perfect). Install with:</p>
+
+
+<pre>sudo port install ffmpeg</pre>
+
+	<p>Or, for a better build (recommended), add additional video- and audio-related
+libraries, like this:</p>
+
+
+<pre>sudo port install ffmpeg +lame +libogg +vorbis +faac +faad +xvid +x264 +a52</pre>
+
+	<p>Most package management systems include a build of ffmpeg, but many include a
+poor build. So you may need to compile from scratch.</p>
+
+
+	<p>If you want to create Flash Video files, also install flvtool2:</p>
+
+
+<pre>sudo gem install flvtool2</pre>
+
+	<p>Once ffmpeg and RVideo are installed, you&#8217;re set.</p>
+
+
+	<h2>The basics</h2>
+
+
+<pre>
+file = RVideo::Inspector.new(:file =&gt; "#{FILE_PATH}/filename.mp4")
+file.video_codec  # =&gt; mpeg4
+file.audio_codec  # =&gt; aac
+file.resolution   # =&gt; 320x240
+</pre>
+
+<pre>
+command = "ffmpeg -i $input_file -vcodec xvid -s $resolution$ $output_file$" 
+options = {
+  :input_file =&gt; "#{FILE_PATH}/filename.mp4", 
+  :output_file =&gt; "#{FILE_PATH}/processed_file.mp4",
+  :resolution =&gt; "640x480" 
+  }
+
+transcoder = RVideo::Transcoder.new
+
+transcoder.execute(command, options)
+
+transcoder.processed.video_codec # =&gt; xvid
+</pre>
+
+	<h2>Demonstration of usage</h2>
+
+
+	<p>To inspect a file, initialize an RVideo file inspector object. See the 
+documentation for details.</p>
+
+
+	<p>A few examples:</p>
+
+
+<pre>file = RVideo::Inspector.new(:file =&gt; "#{APP_ROOT}/files/input.mp4")</pre>
+
+<pre>file = RVideo::Inspector.new(:raw_response =&gt; @existing_response)</pre>
+
+<pre>
+file = RVideo::Inspector.new(:file =&gt; "#{APP_ROOT}/files/input.mp4",
+  :ffmpeg_binary =&gt; "#{APP_ROOT}/bin/ffmpeg")
+</pre>
+
+<pre>
+file.fps        # =&gt; "29.97" 
+file.duration   # =&gt; "00:05:23.4" 
+</pre>
+
+	<p>To transcode a video, initialize a Transcoder object.</p>
+
+
+<pre>transcoder = RVideo::Transcoder.new</pre>
+
+	<p>Then pass a command and valid options to the execute method.</p>
+
+
+<pre>
+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 =&gt; "/path/to/input.mp4",
+    :output_file =&gt; "/path/to/output.flv", :resolution =&gt; "640x360"})
+rescue TranscoderError =&gt; e
+  puts "Unable to transcode file: #{e.class} - #{e.message}" 
+end
+</pre>
+
+	<p>If the job succeeds, you can access the metadata of the input and output
+files with:</p>
+
+
+<pre>
+transcoder.original     # RVideo::Inspector object
+transcoder.processed    # RVideo::Inspector object
+</pre>
+
+	<p>Even if the file is processed, it 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.</p>
+
+
+	<h2>Contribute</h2>
+
+
+	<p>Contribute to RVideo! If you want to help out, there are a few things you can 
+do.</p>
+
+
+	<ul>
+	<li>Use, test, and submit bugs/patches</li>
+		<li>We need a RVideo::Tools::Mencoder class to add mencoder support.</li>
+		<li>Other tool classes would be great &#8211; On2, mp4box, Quicktime (?), etc.</li>
+		<li>Submit other fixes, features, optimizations, and refactorings</li>
+	</ul>
+
+
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+
+
+	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/rvideo/trunk</code> for anonymous access.</p>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/rvideo">http://groups.google.com/group/rvideo</a></p>
+
+
+	<h2>Zencoder (Shameless Plug)</h2>
+
+
+	<p>Zencoder is 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 <a href="http://zencoder.tv">http://zencoder.tv</a> or <a href="http://slantwisedesign.com">http://slantwisedesign.com</a> for more.</p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Send an email to Jonathan Dahl at jon [at] slantwisedesign.</p>
+    <p class="coda">
+      Page created with newgem by <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 30th October 2007<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,142 @@
+h1. Ruby Video Processing
+
+h1. → 'rvideo'
+
+
+h2. What
+
+RVideo is a Ruby library inspects and processes video and audio files by 
+providing an interface to free Unix tools like ffmpeg.
+
+h2. Installing
+
+Installation is a little involved. First, install the gem:
+
+<pre syntax="ruby">sudo gem install rvideo</pre>
+
+Next, install ffmpeg and (possibly) other related libraries. This is
+documented elsewhere on the web, and can be a headache. If you are on a Mac,
+the Macports build is reasonably good (though not perfect). Install with:
+
+  <pre>sudo port install ffmpeg</pre>
+
+Or, for a better build (recommended), add additional video- and audio-related
+libraries, like this:
+
+  <pre>sudo port install ffmpeg +lame +libogg +vorbis +faac +faad +xvid +x264 +a52</pre>
+  
+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:
+
+  <pre>sudo gem install flvtool2</pre>
+
+Once ffmpeg and RVideo are installed, you're set. 
+
+h2. The basics
+
+<pre>
+file = RVideo::Inspector.new(:file => "#{FILE_PATH}/filename.mp4")
+file.video_codec  # => mpeg4
+file.audio_codec  # => aac
+file.resolution   # => 320x240
+</pre>
+
+<pre>
+command = "ffmpeg -i $input_file -vcodec xvid -s $resolution$ $output_file$"
+options = {
+  :input_file => "#{FILE_PATH}/filename.mp4", 
+  :output_file => "#{FILE_PATH}/processed_file.mp4",
+  :resolution => "640x480"
+  }
+
+transcoder = RVideo::Transcoder.new
+
+transcoder.execute(command, options)
+
+transcoder.processed.video_codec # => xvid
+</pre>
+
+h2. Demonstration of usage
+
+To inspect a file, initialize an RVideo file inspector object. See the 
+documentation for details.
+
+A few examples:
+
+<pre>file = RVideo::Inspector.new(:file => "#{APP_ROOT}/files/input.mp4")</pre>
+  
+<pre>file = RVideo::Inspector.new(:raw_response => @existing_response)</pre>
+  
+<pre>
+file = RVideo::Inspector.new(:file => "#{APP_ROOT}/files/input.mp4",
+  :ffmpeg_binary => "#{APP_ROOT}/bin/ffmpeg")
+</pre>
+
+<pre>
+file.fps        # => "29.97"
+file.duration   # => "00:05:23.4"
+</pre>
+
+To transcode a video, initialize a Transcoder object.
+
+<pre>transcoder = RVideo::Transcoder.new</pre>
+
+Then pass a command and valid options to the execute method.
+
+<pre>
+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
+</pre>
+
+If the job succeeds, you can access the metadata of the input and output
+files with:
+
+<pre>
+transcoder.original     # RVideo::Inspector object
+transcoder.processed    # RVideo::Inspector object
+</pre>
+
+Even if the file is processed, it 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.
+
+h2. Contribute
+
+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
+
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
+The trunk repository is <code>svn://rubyforge.org/var/svn/rvideo/trunk</code> for anonymous access.
+
+
+h2. Forum
+
+"http://groups.google.com/group/rvideo":http://groups.google.com/group/rvideo
+
+h2. Zencoder (Shameless Plug)
+
+Zencoder is 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":http://zencoder.tv or "http://slantwisedesign.com":http://slantwisedesign.com for more.
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Send an email to Jonathan Dahl at jon [at] slantwisedesign.