streamio-ffmpeg 0.2.0 → 0.3.0

data/.gitignore

@@ -19,3 +19,5 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+script/*
+tmp/*

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.3.0 2009-02-07
+
+* Simple transcoding
+
 == 0.2.0 2009-02-06
 
 * Some more metadata parsing

data/README.rdoc

@@ -10,6 +10,8 @@ Simplest possible wrapper around FFMPEG to get metadata from movie files and do
 
 == Usage
 
+=== Reading Metadata
+
   movie = FFMPEG::Movie.new("path/to/movie.mov")
   
   movie.duration # 7.5 (duration of the movie in seconds)
@@ -29,6 +31,27 @@ Simplest possible wrapper around FFMPEG to get metadata from movie files and do
   movie.audio_channels # 2
   
   movie.valid? # true (would be false if ffmpeg fails to read the movie)
+  
+=== Transcoding
+
+Use :output_file option to specify the output file path.
+  
+  movie.transcode(:output_file => "tmp/movie.mp4") # Default ffmpeg settings for mp4 format
+
+Keep track of progress with an optional block.
+
+  movie.transcode(:output_file => "movie.mp4") { |progress| puts progress } # 0.2 ... 0.5 ... 1.0
+
+Give custom command line options to ffmpeg through :raw_options.
+
+  movie.transcode(:raw_options => "-ac aac -vc libx264 -ac 2 ...", :output_file => "movie.mp4")
+  
+The transcode function returns a Movie object for the encoded file.
+
+  transcoded_movie = movie.transcode(:output_file => "tmp/movie.flv")
+  
+  transcoded_movie.video_codec # "flv"
+  transcoded_movie.audio_codec # "mp3"
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/ffmpeg/movie.rb

@@ -1,14 +1,14 @@
-require 'open3'
-
 module FFMPEG
   class Movie
-    attr_reader :duration, :bitrate
+    attr_reader :path, :duration, :bitrate
     attr_reader :video_stream, :video_codec, :colorspace, :resolution
     attr_reader :audio_stream, :audio_codec, :audio_sample_rate
     
     def initialize(path)
       raise Errno::ENOENT, "the file '#{path}' does not exist" unless File.exists?(path)
       
+      @path = path
+      
       stdin, stdout, stderr = Open3.popen3("ffmpeg -i #{path}") # Output will land in stderr
       output = stderr.read
       
@@ -58,5 +58,10 @@ module FFMPEG
     def frame_rate
       video_stream[/(\d*\.\d*)\s?fps/] ? $1.to_f : nil
     end
+    
+    def transcode(options, &block)
+      transcoder = Transcoder.new(self, options)
+      transcoder.run &block
+    end
   end
-end
+end

data/lib/ffmpeg/transcoder.rb

@@ -0,0 +1,47 @@
+require 'open3'
+
+module FFMPEG
+  class Transcoder
+    def initialize(movie, options)
+      raise ArgumentError, "you need to specify options[:output_file]" unless options[:output_file]
+            
+      @movie = movie
+      @options = options
+    end
+    
+    def run
+      command = "ffmpeg -y -i '#{@movie.path}' #{@options[:raw_options]} '#{@options[:output_file]}'"
+      last_output = nil
+      Open3.popen3(command) do |stdin, stdout, stderr|
+        stderr.each("r") do |line|
+          if line =~ /time=(\d+.\d+)/
+            time = $1.to_f
+            progress = time / @movie.duration
+            yield(progress) if block_given?
+          end
+          if line =~ /Unsupported codec/
+            raise "Failed encoding: #{line}"
+          end
+          last_output = line
+        end
+      end  
+
+      if encoding_succeeded?
+        yield(1.0) if block_given?
+      else
+        raise "Failed encoding. Last output: #{last_output}. Original duration: #{@movie.duration}. Encoded duration: #{encoded.duration}."
+      end
+      
+      encoded
+    end
+    
+    def encoding_succeeded?
+      precision = 1.1
+      encoded.valid? && !(encoded.duration >= (@movie.duration * precision) or encoded.duration <= (@movie.duration / precision))
+    end
+    
+    def encoded
+      @encoded ||= Movie.new(@options[:output_file])
+    end
+  end
+end

data/lib/streamio-ffmpeg.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 require 'ffmpeg/movie'
+require 'ffmpeg/transcoder'
  
 module FFMPEG
   VERSION = '0.1.0'

data/spec/ffmpeg/movie_spec.rb

@@ -1,7 +1,7 @@
-#require File.dirname(__FILE__) + '/../spec_helper.rb'
 require 'spec_helper.rb'
 
 module FFMPEG
+  
   describe Movie do
     describe "given a non existing file" do
       it "should throw ArgumentError" do
@@ -9,73 +9,90 @@ module FFMPEG
       end
     end
     
-    describe "given a non movie file" do
-      before(:all) do
-        @movie = Movie.new(__FILE__)
-      end
-      
-      it "should not be valid" do
-        @movie.should_not be_valid
-      end
-    end
-    
-    describe "given awesome.mov file" do
-      before(:all) do
-        @movie = Movie.new("#{fixture_path}/movies/awesome.mov")
-      end
-      
-      it "should parse duration to number of seconds" do
-        @movie.duration.should == 7.5
-      end
-      
-      it "should parse the bitrate" do
-        @movie.bitrate.should == 481
-      end
+    describe "parsing" do
+      describe "given a non movie file" do
+        before(:all) do
+          @movie = Movie.new(__FILE__)
+        end
 
-      it "should parse video stream information" do
-        @movie.video_stream.should == "h264, yuv420p, 640x480 [PAR 1:1 DAR 4:3], 371 kb/s, 16.75 fps, 15 tbr, 600 tbn, 1200 tbc"
+        it "should not be valid" do
+          @movie.should_not be_valid
+        end
       end
 
-      it "should know the video codec" do
-        @movie.video_codec.should == "h264"
-      end
+      describe "given awesome.mov file" do
+        before(:all) do
+          @movie = Movie.new("#{fixture_path}/movies/awesome.mov")
+        end
 
-      it "should know the colorspace" do
-        @movie.colorspace.should == "yuv420p"
-      end
+        it "should remember the movie path" do
+          @movie.path.should == "#{fixture_path}/movies/awesome.mov"
+        end
 
-      it "should know the resolution" do
-        @movie.resolution.should == "640x480"
-      end
+        it "should parse duration to number of seconds" do
+          @movie.duration.should == 7.5
+        end
 
-      it "should know the width and height" do
-        @movie.width.should == 640
-        @movie.height.should == 480
-      end
+        it "should parse the bitrate" do
+          @movie.bitrate.should == 481
+        end
 
-      it "should know the framerate" do
-        @movie.frame_rate.should == 16.75
-      end
-      
-      it "should parse audio stream information" do
-        @movie.audio_stream.should == "aac, 44100 Hz, stereo, s16, 75 kb/s"
-      end
-      
-      it "should know the audio codec" do
-        @movie.audio_codec.should == "aac"
-      end
-      
-      it "should know the sample rate" do
-        @movie.audio_sample_rate.should == 44100
-      end
-      
-      it "should know the number of audio channels" do
-        @movie.audio_channels.should == 2
-      end
+        it "should parse video stream information" do
+          @movie.video_stream.should == "h264, yuv420p, 640x480 [PAR 1:1 DAR 4:3], 371 kb/s, 16.75 fps, 15 tbr, 600 tbn, 1200 tbc"
+        end
+
+        it "should know the video codec" do
+          @movie.video_codec.should == "h264"
+        end
+
+        it "should know the colorspace" do
+          @movie.colorspace.should == "yuv420p"
+        end
+
+        it "should know the resolution" do
+          @movie.resolution.should == "640x480"
+        end
+
+        it "should know the width and height" do
+          @movie.width.should == 640
+          @movie.height.should == 480
+        end
+
+        it "should know the framerate" do
+          @movie.frame_rate.should == 16.75
+        end
 
-      it "should should be valid" do
-        @movie.should be_valid
+        it "should parse audio stream information" do
+          @movie.audio_stream.should == "aac, 44100 Hz, stereo, s16, 75 kb/s"
+        end
+
+        it "should know the audio codec" do
+          @movie.audio_codec.should == "aac"
+        end
+
+        it "should know the sample rate" do
+          @movie.audio_sample_rate.should == 44100
+        end
+
+        it "should know the number of audio channels" do
+          @movie.audio_channels.should == 2
+        end
+
+        it "should should be valid" do
+          @movie.should be_valid
+        end
+      end
+    end
+    
+    describe "transcode" do
+      it "should run the transcoder" do
+        FileUtils.rm_f "#{tmp_path}/awesome.flv"
+        movie = Movie.new("#{fixture_path}/movies/awesome.mov")
+        encoded = movie.transcode(:output_file => "#{tmp_path}/awesome.flv")
+        encoded.should be_valid
+        File.exists?("#{tmp_path}/awesome.flv").should be_true
       end
     end
   end
+  
 end

data/spec/ffmpeg/transcoder_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper.rb'
+
+module FFMPEG
+  describe Transcoder do
+    describe "initializing" do
+      it "should require an output_file option" do
+        lambda { Transcoder.new(nil, {}) }.should raise_error(ArgumentError, /output_file/)
+      end
+    end
+    
+    describe "transcoding" do
+      it "should transcode the movie" do
+        FileUtils.rm_f "#{tmp_path}/awesome.flv"
+        movie = Movie.new("#{fixture_path}/movies/awesome.mov")
+        transcoder = Transcoder.new(movie, :output_file => "tmp/awesome.flv")
+        transcoder.run
+        transcoder.encoded.should be_valid
+        File.exists?("#{tmp_path}/awesome.flv").should be_true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'streamio-ffmpeg'
 require 'spec'
 require 'spec/autorun'
+require 'fileutils'
 
 Spec::Runner.configure do |config|
   
@@ -10,4 +11,10 @@ end
 
 def fixture_path
   @fixture_path ||= File.join(File.dirname(__FILE__), 'fixtures')
-end
+end
+
+def tmp_path  
+  @tmp_path ||= File.join(File.dirname(__FILE__), "..", "tmp")
+end
+
+FileUtils.mkdir_p tmp_path

data/streamio-ffmpeg.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{streamio-ffmpeg}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Backeus"]
-  s.date = %q{2010-02-06}
+  s.date = %q{2010-02-07}
   s.description = %q{Simple wrapper around ffmpeg to get metadata from movies and do transcoding}
   s.email = %q{duztdruid@gmail.com}
   s.extra_rdoc_files = [
@@ -25,8 +25,10 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/ffmpeg/movie.rb",
+     "lib/ffmpeg/transcoder.rb",
      "lib/streamio-ffmpeg.rb",
      "spec/ffmpeg/movie_spec.rb",
+     "spec/ffmpeg/transcoder_spec.rb",
      "spec/fixtures/movies/awesome.mov",
      "spec/spec.opts",
      "spec/spec_helper.rb",
@@ -39,6 +41,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Simple wrapper around ffmpeg to get metadata from movies and do transcoding}
   s.test_files = [
     "spec/ffmpeg/movie_spec.rb",
+     "spec/ffmpeg/transcoder_spec.rb",
      "spec/spec_helper.rb"
   ]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: streamio-ffmpeg
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - David Backeus
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-06 00:00:00 +01:00
+date: 2010-02-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,8 +40,10 @@ files:
 - Rakefile
 - VERSION
 - lib/ffmpeg/movie.rb
+- lib/ffmpeg/transcoder.rb
 - lib/streamio-ffmpeg.rb
 - spec/ffmpeg/movie_spec.rb
+- spec/ffmpeg/transcoder_spec.rb
 - spec/fixtures/movies/awesome.mov
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -76,4 +78,5 @@ specification_version: 3
 summary: Simple wrapper around ffmpeg to get metadata from movies and do transcoding
 test_files: 
 - spec/ffmpeg/movie_spec.rb
+- spec/ffmpeg/transcoder_spec.rb
 - spec/spec_helper.rb