streamio-ffmpeg 0.5.0 → 0.6.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 0.6.0 2010-05-04
+
+* Cropping options now handled by EncodingOptions (croptop, cropbottom, cropleft and cropright)
+* Aspect ratio parameter calculated and added by default
+* Added transcoder options to preserve original aspect ratio on width or height
+
 == 0.5.0 2010-04-28
 
 * Added logging capabilities 

data/README.rdoc

@@ -48,7 +48,8 @@ Give custom command line options with a string.
 
 Use the EncodingOptions parser for humanly readable transcoding options. Below you'll find all the supported options. Note that the :custom key will be used as is without modification so use it for any tricky business you might need.
 
-  options = {:video_codec => "libx264", :frame_rate => 10, :resolution => "320x240", :video_bitrate => 300, 
+  options = {:video_codec => "libx264", :frame_rate => 10, :resolution => "320x240", :video_bitrate => 300,
+             :croptop => 60, :cropbottom => 60, :cropleft => 10, :cropright => 10, :aspect => 1.333333,
              :audio_codec => "libfaac", :audio_bitrate => 32, :audio_sample_rate => 22050, :audio_channels => 1,
              :custom => "-flags +loop -cmp +chroma -partitions +parti4x4+partp8x8 -flags2 +mixed_refs -me_method umh -subq 6 -refs 6 -rc_eq 'blurCplx^(1-qComp)' -coder 0 -me_range 16 -g 250 -keyint_min 25 -sc_threshold 40 -i_qfactor 0.71 -qcomp 0.6 -qmin 10 -qmax 51 -qdiff 4 -level 21"}
   movie.transcode("movie.mp4", options)
@@ -59,6 +60,22 @@ The transcode function returns a Movie object for the encoded file.
   
   transcoded_movie.video_codec # "flv"
   transcoded_movie.audio_codec # "mp3"
+  
+Aspect ratio is added to encoding options automatically if none is specified.
+
+  options = {:resolution => 320x180} # Will add -aspect 1.77777777777778 to ffmpeg
+
+Preserve aspect ratio on width or height by using the preserve_aspect_ratio transcoder option.
+
+  widescreen_movie = FFMPEG::Movie.new("path/to/widescreen_movie.mov")
+  
+  options = {:resolution => 320x240}
+  
+  transcoder_options = {:preserve_aspect_ratio => :width}
+  widescreen_movie.transcode("movie.mp4", options, transcoder_options) # Output resolution will be 320x180
+  
+  transcoder_options = {:preserve_aspect_ratio => :height}
+  widescreen_movie.transcode("movie.mp4", options, transcoder_options) # Output resolution will be 426x240
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/ffmpeg/encoding_options.rb

@@ -7,9 +7,19 @@ module FFMPEG
     end
     
     def to_s
-      collect do |key, value|
+      parameters = collect do |key, value|
         send("convert_#{key}", value) if supports_option?(key)
       end.join(" ")
+      parameters << " #{convert_aspect(calculate_aspect)}" if calculate_aspect?
+      parameters
+    end
+    
+    def width
+      self[:resolution].split("x").first.to_i rescue nil
+    end
+    
+    def height
+      self[:resolution].split("x").last.to_i rescue nil
     end
     
     private
@@ -17,6 +27,35 @@ module FFMPEG
       private_methods.include?("convert_#{option}")
     end
     
+    def convert_aspect(value)
+      "-aspect #{value}"
+    end
+    
+    def calculate_aspect
+      width, height = self[:resolution].split("x")
+      width.to_f / height.to_f
+    end
+    
+    def calculate_aspect?
+      self[:aspect].nil? && self[:resolution]
+    end
+    
+    def convert_croptop(value)
+      "-croptop #{value}"
+    end
+    
+    def convert_cropbottom(value)
+      "-cropbottom #{value}"
+    end
+    
+    def convert_cropleft(value)
+      "-cropleft #{value}"
+    end
+    
+    def convert_cropright(value)
+      "-cropright #{value}"
+    end
+    
     def convert_video_codec(value)
       "-vcodec #{value}"
     end

data/lib/ffmpeg/movie.rb

@@ -49,6 +49,10 @@ module FFMPEG
       resolution.split("x")[1].to_i rescue nil
     end
     
+    def calculated_aspect_ratio
+      width.to_f / height.to_f
+    end
+    
     def audio_channels
       return @audio_channels[/\d*/].to_i if @audio_channels["channels"]
       return 1 if @audio_channels["mono"]
@@ -59,8 +63,8 @@ module FFMPEG
       video_stream[/(\d*\.?\d*)\s?fps/] ? $1.to_f : nil
     end
     
-    def transcode(output_file, options, &block)
-      Transcoder.new(self, output_file, options).run &block
+    def transcode(output_file, options = EncodingOptions.new, transcoder_options = {}, &block)
+      Transcoder.new(self, output_file, options, transcoder_options).run &block
     end
     
     protected

data/lib/ffmpeg/transcoder.rb

@@ -2,7 +2,7 @@ require 'open3'
 
 module FFMPEG
   class Transcoder
-    def initialize(movie, output_file, options = EncodingOptions.new)
+    def initialize(movie, output_file, options = EncodingOptions.new, transcoder_options = {})
       @movie = movie
       @output_file = output_file
       
@@ -14,7 +14,10 @@ module FFMPEG
         raise ArgumentError, "Unknown options format '#{options.class}', should be either EncodingOptions, Hash or String."
       end
       
+      @transcoder_options = transcoder_options
       @errors = []
+      
+      apply_transcoder_options
     end
     
     def run
@@ -73,5 +76,17 @@ module FFMPEG
     def encoded
       @encoded ||= Movie.new(@output_file)
     end
+    
+    private
+    def apply_transcoder_options
+      case @transcoder_options[:preserve_aspect_ratio].to_s
+      when "width"
+        new_height = (@raw_options.width / @movie.calculated_aspect_ratio).to_i
+        @raw_options[:resolution] = "#{@raw_options.width}x#{new_height}"
+      when "height"
+        new_width = (@raw_options.height * @movie.calculated_aspect_ratio).to_i
+        @raw_options[:resolution] = "#{new_width}x#{@raw_options.height}"
+      end
+    end
   end
 end

data/spec/ffmpeg/encoding_options_spec.rb

@@ -7,12 +7,39 @@ module FFMPEG
         EncodingOptions.new(:video_codec => "libx264").to_s.should == "-vcodec libx264"
       end
       
+      it "should convert cropping options" do
+        EncodingOptions.new(:croptop => 20).to_s.should == "-croptop 20"
+        EncodingOptions.new(:cropbottom => 20).to_s.should == "-cropbottom 20"
+        EncodingOptions.new(:cropleft => 20).to_s.should == "-cropleft 20"
+        EncodingOptions.new(:cropright => 20).to_s.should == "-cropright 20"
+      end
+      
+      it "should know the width from the resolution or be nil" do
+        EncodingOptions.new(:resolution => "320x240").width.should == 320
+        EncodingOptions.new.width.should be_nil
+      end
+      
+      it "should know the height from the resolution or be nil" do
+        EncodingOptions.new(:resolution => "320x240").height.should == 240
+        EncodingOptions.new.height.should be_nil
+      end
+      
       it "should convert frame rate" do
         EncodingOptions.new(:frame_rate => 29.9).to_s.should == "-r 29.9"
       end
       
       it "should convert the resolution" do
-        EncodingOptions.new(:resolution => "640x480").to_s.should == "-s 640x480"
+        EncodingOptions.new(:resolution => "640x480").to_s.should include("-s 640x480")
+      end
+      
+      it "should add calculated aspect ratio" do
+        EncodingOptions.new(:resolution => "640x480").to_s.should include("-aspect 1.3333333")
+        EncodingOptions.new(:resolution => "640x360").to_s.should include("-aspect 1.77777777777778")
+      end
+      
+      it "should use specified aspect ratio if given" do
+        EncodingOptions.new(:resolution => "640x480", 
+                            :aspect => 1.77777777777778).to_s.should == "-s 640x480 -aspect 1.77777777777778"
       end
       
       it "should convert video bitrate" do

data/spec/ffmpeg/movie_spec.rb

@@ -81,6 +81,10 @@ module FFMPEG
         it "should should be valid" do
           @movie.should be_valid
         end
+        
+        it "should calculate the aspect ratio" do
+          @movie.calculated_aspect_ratio.to_s.should == "1.33333333333333"
+        end
       end
     end
     
@@ -89,10 +93,10 @@ module FFMPEG
         movie = Movie.new("#{fixture_path}/movies/awesome movie.mov")
 
         mockery = mock(Transcoder)
-        Transcoder.should_receive(:new).with(movie, "#{tmp_path}/awesome.flv", :custom => "-vcodec libx264").and_return(mockery)
+        Transcoder.should_receive(:new).with(movie, "#{tmp_path}/awesome.flv", {:custom => "-vcodec libx264"}, :preserve_aspect_ratio => :width).and_return(mockery)
         mockery.should_receive(:run)
 
-        movie.transcode("#{tmp_path}/awesome.flv", :custom => "-vcodec libx264")
+        movie.transcode("#{tmp_path}/awesome.flv", {:custom => "-vcodec libx264"}, :preserve_aspect_ratio => :width)
       end
     end
   end

data/spec/ffmpeg/transcoder_spec.rb

@@ -47,7 +47,7 @@ module FFMPEG
         FileUtils.rm_f "#{tmp_path}/optionalized.mp4"
         
         movie = Movie.new("#{fixture_path}/movies/awesome movie.mov")
-        options = {:video_codec => "libx264", :frame_rate => 10, :resolution => "320x240", :video_bitrate => 300, 
+        options = {:video_codec => "libx264", :frame_rate => 10, :resolution => "320x240", :video_bitrate => 300,
                    :audio_codec => "libfaac", :audio_bitrate => 32, :audio_sample_rate => 22050, :audio_channels => 1,
                    :custom => "-flags +loop -cmp +chroma -partitions +parti4x4+partp8x8 -flags2 +mixed_refs -me_method umh -subq 6 -refs 6 -rc_eq 'blurCplx^(1-qComp)' -coder 0 -me_range 16 -g 250 -keyint_min 25 -sc_threshold 40 -i_qfactor 0.71 -qcomp 0.6 -qmin 10 -qmax 51 -qdiff 4 -level 21"}
         
@@ -60,6 +60,27 @@ module FFMPEG
         encoded.audio_channels.should == 1
       end
       
+      describe "aspect ratio preservation" do
+        before(:each) do
+          @movie = Movie.new("#{fixture_path}/movies/awesome_widescreen.mov")
+          @options = {:resolution => "320x240"}
+        end
+        
+        it "should work on width" do
+          special_options = {:preserve_aspect_ratio => :width}
+
+          encoded = Transcoder.new(@movie, "#{tmp_path}/preserved_aspect.mp4", @options, special_options).run
+          encoded.resolution.should == "320x180"
+        end
+
+        it "should work on height" do
+          special_options = {:preserve_aspect_ratio => :height}
+        
+          encoded = Transcoder.new(@movie, "#{tmp_path}/preserved_aspect.mp4", @options, special_options).run
+          encoded.resolution.should == "426x240"
+        end
+      end
+
       it "should transcode the movie with String options" do
         FileUtils.rm_f "#{tmp_path}/string_optionalized.flv"
         

data/streamio-ffmpeg.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{streamio-ffmpeg}
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Backeus"]
-  s.date = %q{2010-04-28}
+  s.date = %q{2010-05-04}
   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 = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
      "spec/ffmpeg/movie_spec.rb",
      "spec/ffmpeg/transcoder_spec.rb",
      "spec/fixtures/movies/awesome movie.mov",
+     "spec/fixtures/movies/awesome_widescreen.mov",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/stremio-ffmpeg_spec.rb",

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - David Backeus
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-28 00:00:00 +02:00
+date: 2010-05-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ files:
 - spec/ffmpeg/movie_spec.rb
 - spec/ffmpeg/transcoder_spec.rb
 - spec/fixtures/movies/awesome movie.mov
+- spec/fixtures/movies/awesome_widescreen.mov
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/stremio-ffmpeg_spec.rb