carrierwave-video 0.2.3 → 0.3.0

data/README.rdoc

@@ -15,7 +15,7 @@ Using bundler:
 = Usage
 
     class VideoUploader < CarrierWave::Uploader::Base
-      include CarrierWave::VideoConverter
+      include CarrierWave::Video
 
       process encode_video: [:mp4, callbacks: { after_transcode: :set_success } ]
     end
@@ -63,7 +63,30 @@ Logging:
     logger: :method  #returns object that behaves like Logger
 
 Custom:
-  streamio-ffmpeg accepts custom params. You may pass these in but keep in mind the watermarking params will be appended if there were any.
+streamio-ffmpeg accepts custom params. You may pass these in but keep in mind the watermarking params will be appended if there were any.
+  custom: '-b 1500k'
+
+= Dynamic Configuration
+
+    class VideoUploader < CarrierWave::Uploader::Base
+      include CarrierWave::Video
+
+      DEFAULTS = {
+        watermark: {
+          path: Rails.root.join('watermark-large.png')
+        }
+      }
+
+      process :encode
+
+      def encode
+        encode_video(:mp4, DEFAULTS) do |movie, params|
+          if movie.height < 720
+            params[:watermark][:path] = Rails.root.join('watermark-small.png')
+          end
+        end
+      end
+    end
 
 = OGG/OGV & Theora
 
@@ -80,7 +103,7 @@ If you need support for this it shouldn't be too hard to add. (Use streamio-ffmp
 Example:
 
     class VideoUploader < CarrierWave::Uploader::Base
-      include CarrierWave::VideoConverter
+      include CarrierWave::Video
 
       version :mp4 do
         process :encode_video => [:mp4, {...}]

data/carrierwave-video.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", ">= 2.10.0"
   s.add_development_dependency "rake"
 
   s.add_runtime_dependency 'streamio-ffmpeg'

data/lib/carrierwave-video/version.rb

@@ -1,5 +1,5 @@
 module Carrierwave
   module Video
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/lib/carrierwave/video.rb

@@ -44,17 +44,17 @@ module CarrierWave
       cache_stored_file! if !cached?
 
       @options = CarrierWave::Video::FfmpegOptions.new(format, opts)
-      tmp_path  = File.join( File.dirname(current_path), "tmpfile.#{format}" )
+      tmp_path = File.join( File.dirname(current_path), "tmpfile.#{format}" )
+      file = ::FFMPEG::Movie.new(current_path)
 
+      if opts[:resolution] == :same
+        @options.format_options[:resolution] = file.resolution
+      end
 
-      with_trancoding_callbacks do
-        file = ::FFMPEG::Movie.new(current_path)
+      yield(file, @options.format_options) if block_given?
 
-        if opts[:resolution] == :same
-          @options.format_options[:resolution] = file.resolution
-        end
-
-        file.transcode(tmp_path, @options.format_options, @options.encoder_options)
+      with_trancoding_callbacks do
+        file.transcode(tmp_path, @options.format_params, @options.encoder_options)
         File.rename tmp_path, current_path
       end
     end

data/lib/carrierwave/video/ffmpeg_options.rb

@@ -1,23 +1,17 @@
 module CarrierWave
   module Video
     class FfmpegOptions
-      attr_reader :watermark_path, :watermark_position, :watermark_pixels,
-        :format, :resolution, :custom, :callbacks
+      attr_reader :format, :resolution, :custom, :callbacks
 
       def initialize(format, options)
         @format = format.to_s
-        @watermark = options[:watermark].present?
         @resolution = options[:resolution] || "640x360"
         @custom = options[:custom]
         @callbacks = options[:callbacks] || {}
         @logger = options[:logger]
         @unparsed = options
 
-        if watermark?
-          @watermark_path = options[:watermark][:path]
-          @watermark_position = options[:watermark][:position].to_s || :bottom_right
-          @watermark_pixels = options[:watermark][:pixels_from_edge] || 10
-        end
+        @format_options = defaults.merge(options)
       end
 
       def raw
@@ -29,59 +23,67 @@ module CarrierWave
       end
 
       def encoder_options
-        {preserve_aspect_ratio: :width}
+        { preserve_aspect_ratio: :width }
       end
 
+      # input
       def format_options
-        @format_options ||= begin
-          result = case format
-          when "mp4"
-            {
-              video_codec: 'libx264',
-              audio_codec: 'libfaac',
-              custom: "-qscale 0 -vpre slow -vpre baseline -g 30 #{watermark_params}"
-            }
-          when "webm"
-            {
-              video_codec: 'libvpx',
-              audio_codec: 'libvorbis',
-              custom: "-b 1500k -ab 160000 -f webm -g 30 #{watermark_params}"
-            }
-          when "ogv"
-            {
-              video_codec: 'libtheora',
-              audio_codec: 'libvorbis',
-              custom: "-b 1500k -ab 160000 -g 30 #{watermark_params}"
-            }
-          else
-            {}
-          end
+        @format_options
+      end
 
-          { resolution: resolution }.merge(result).tap do |h|
-            h[:custom] = "#{custom} #{watermark_params}".strip if custom.present?
-          end
-        end
+      # output
+      def format_params
+        params = @format_options.dup
+        params[:custom] = [params[:custom], watermark_params].compact.join(' ')
+        params
       end
 
       def watermark?
-        @watermark
+        @format_options[:watermark].present?
       end
 
       def watermark_params
-        return "" unless watermark?
-        positioning = case watermark_position
-                        when 'bottom_left'
-                          "#{watermark_pixels}:main_h-overlay_h-#{watermark_pixels}"
-                        when 'bottom_right'
-                          "main_w-overlay_w-#{watermark_pixels}:main_h-overlay_h-#{watermark_pixels}"
-                        when 'top_left'
-                          "#{watermark_pixels}:#{watermark_pixels}"
-                        when 'top_right'
-                          "main_w-overlay_w-#{watermark_pixels}:#{watermark_pixels}"
-                      end
+        return nil unless watermark?
+
+        @watermark_params ||= begin
+          path = @format_options[:watermark][:path]
+          position = @format_options[:watermark][:position].to_s || :bottom_right
+          margin = @format_options[:watermark][:pixels_from_edge] || @format_options[:watermark][:margin] || 10
+          positioning = case position
+                          when 'bottom_left'
+                            "#{margin}:main_h-overlay_h-#{margin}"
+                          when 'bottom_right'
+                            "main_w-overlay_w-#{margin}:main_h-overlay_h-#{margin}"
+                          when 'top_left'
+                            "#{margin}:#{margin}"
+                          when 'top_right'
+                            "main_w-overlay_w-#{margin}:#{margin}"
+                        end
 
-        "-vf \"movie=#{watermark_path} [logo]; [in][logo] overlay=#{positioning} [out]\""
+          "-vf \"movie=#{path} [logo]; [in][logo] overlay=#{positioning} [out]\""
+        end
       end
+
+      private
+
+        def defaults
+          @defaults ||= { resolution: '640x360', watermark: {} }.tap do |h|
+            case format
+            when 'mp4'
+              h[:video_codec] = 'libx264'
+              h[:audio_codec] = 'libfaac'
+              h[:custom] = '-qscale 0 -vpre slow -vpre baseline -g 30'
+            when 'ogv'
+              h[:video_codec] = 'libtheora'
+              h[:audio_codec] = 'libvorbis'
+              h[:custom] = '-b 1500k -ab 160000 -g 30'
+            when 'webm'
+              h[:video_codec] = 'libvpx'
+              h[:audio_codec] = 'libvorbis'
+              h[:custom] = '-b 1500k -ab 160000 -f webm -g 30'
+            end
+          end
+        end
     end
   end
 end

data/spec/lib/carrierwave_video_spec.rb

@@ -57,7 +57,7 @@ describe CarrierWave::Video do
 
           opts[:video_codec].should == 'libvpx'
           opts[:audio_codec].should == 'libvorbis'
-          opts[:custom].should == '-b 1500k -ab 160000 -f webm -g 30 '
+          opts[:custom].should == '-b 1500k -ab 160000 -f webm -g 30'
 
           path.should == "video/path/tmpfile.#{format}"
         end
@@ -226,8 +226,66 @@ describe CarrierWave::Video do
         })
       end
     end
-  end
 
+    context "given a block" do
+      let(:movie) { mock }
+      let(:opts) { {} }
+      let(:params) { { resolution: "640x360", watermark: {}, video_codec: "libvpx", audio_codec: "libvorbis", custom: "-b 1500k -ab 160000 -f webm -g 30" } }
+
+      before do
+        File.should_receive(:rename)
+        movie.stub(:resolution).and_return('1280x720')
+      end
+
+      it "calls the block, with the movie file and params" do
+        movie.should_receive(:transcode) do |path, format_opts, codec_opts|
+          format_opts[:video_codec].should == 'libvpx'
+          format_opts[:audio_codec].should == 'libvorbis'
+        end
+
+        expect {
+          |block| converter.encode_video(format, opts, &block)
+        }.to yield_with_args(movie, params)
+      end
+
+      it "allows the block to modify the params" do
+        block = Proc.new { |input, params| params[:custom] = '-preset slow' }
+
+        movie.should_receive(:transcode) do |path, format_opts, codec_opts|
+          format_opts[:custom].should == '-preset slow'
+        end
+
+        converter.encode_video(format, opts, &block)
+      end
+
+      it "evaluates the final params after any modifications" do
+        block = Proc.new do |input, params|
+          params[:custom] = '-preset slow'
+          params[:watermark][:path] = 'customized/path'
+        end
+
+        movie.should_receive(:transcode) do |path, format_opts, codec_opts|
+          format_opts[:custom].should == '-preset slow -vf "movie=customized/path [logo]; [in][logo] overlay= [out]"'
+        end
+
+        converter.encode_video(format, opts, &block)
+      end
+
+      it "gives preference to the block-provided settings" do
+        opts = { resolution: :same }
+
+        block = Proc.new do |input, params|
+          params[:resolution] = '1x1'
+        end
+
+        movie.should_receive(:transcode) do |path, format_opts, codec_opts|
+          format_opts[:resolution].should == '1x1'
+        end
+
+        converter.encode_video(format, opts, &block)
+      end
+    end
+  end
 
   describe "#encode_ogv" do
     let(:movie) { mock }

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - rheaton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-30 00:00:00 -04:00
+date: 2012-08-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,8 +26,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 2
+        - 10
         - 0
-        version: "0"
+        version: 2.10.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency