paperclip-ffmpeg 0.8.0 → 0.9.0

data/README.md

@@ -45,6 +45,20 @@ This will produce:
 
 You may optionally add `<attachment>_meta` to your model and paperclip-ffmpeg will add information about the processed video.
 
+Streaming Video
+-------------------
+
+When ffmpeg produces mp4 files, it places the moov atom at the end which makes it unstreamable. To handle this, paperclip-ffmpeg includes a processor to run qtfaststart after producing the video file.
+
+In your model:
+
+    class Lesson < ActiveRecord::Base
+      has_attached_file :video, :styles => {
+          :mobile => {:geometry => "400x300", :format => 'mp4', :streaming => true}
+      }, :processors => [:ffmpeg, :qtfaststart]
+    end
+
+See [danielgtaylor/qtfaststart](https://github.com/danielgtaylor/qtfaststart) for instructions on how to setup qtfaststart.
 
 License
 -------

data/lib/paperclip-ffmpeg.rb

@@ -1,160 +1,3 @@
 require "paperclip"
-module Paperclip
-  class Ffmpeg < Processor
-    attr_accessor :geometry, :format, :whiny, :convert_options
-
-    # Creates a Video object set to work on the +file+ given. It
-    # will attempt to transcode the video into one defined by +target_geometry+
-    # which is a "WxH"-style string. +format+ should be specified.
-    # Video transcoding will raise no errors unless
-    # +whiny+ is true (which it is, by default. If +convert_options+ is
-    # set, the options will be appended to the convert command upon video transcoding
-    def initialize file, options = {}, attachment = nil
-      @convert_options = {
-        :input => {},
-        :output => { :y => nil }
-      }
-      unless options[:convert_options].nil? || options[:convert_options].class != Hash
-        unless options[:convert_options][:input].nil? || options[:convert_options][:input].class != Hash
-          @convert_options[:input].reverse_merge! options[:convert_options][:input]
-        end
-        unless options[:convert_options][:output].nil? || options[:convert_options][:output].class != Hash
-          @convert_options[:output].reverse_merge! options[:convert_options][:output]
-        end
-      end
-      
-      @geometry        = options[:geometry]
-      @file            = file
-      @keep_aspect     = !@geometry.nil? && @geometry[-1,1] != '!'
-      @pad_only        = @keep_aspect    && @geometry[-1,1] == '#'
-      @enlarge_only    = @keep_aspect    && @geometry[-1,1] == '<'
-      @shrink_only     = @keep_aspect    && @geometry[-1,1] == '>'
-      @whiny           = options[:whiny].nil? ? true : options[:whiny]
-      @format          = options[:format]
-      @time            = options[:time].nil? ? 3 : options[:time]
-      @current_format  = File.extname(@file.path)
-      @basename        = File.basename(@file.path, @current_format)
-      @meta            = identify
-      attachment.instance_write(:meta, @meta)
-    end
-    # Performs the transcoding of the +file+ into a thumbnail/video. Returns the Tempfile
-    # that contains the new image/video.
-    def make
-      src = @file
-      dst = Tempfile.new([@basename, @format ? ".#{@format}" : ''])
-      dst.binmode
-      
-      parameters = []
-      # Add geometry
-      if @geometry
-        # Extract target dimensions
-        if @geometry =~ /(\d*)x(\d*)/
-          target_width = $1
-          target_height = $2
-        end
-        # Only calculate target dimensions if we have current dimensions
-        unless @meta[:size].nil?
-          current_geometry = @meta[:size].split('x')
-          # Current width and height
-          current_width = current_geometry[0]
-          current_height = current_geometry[1]
-          if @keep_aspect
-            if @enlarge_only
-              if current_width.to_i < target_width.to_i
-                # Keep aspect ratio
-                width = target_width.to_i
-                height = (width.to_f / (@meta[:aspect].to_f)).to_i
-                @convert_options[:output][:s] = "#{width.to_i}x#{height.to_i}"
-              else
-                return nil
-              end
-            elsif @shrink_only
-              if current_width.to_i > target_width.to_i
-                # Keep aspect ratio
-                width = target_width.to_i
-                height = (width.to_f / (@meta[:aspect].to_f)).to_i
-                @convert_options[:output][:s] = "#{width.to_i}x#{height.to_i}"
-              else
-                return nil
-              end
-            elsif @pad_only
-              # Keep aspect ratio
-              width = target_width.to_i
-              height = (width.to_f / (@meta[:aspect].to_f)).to_i
-              # We should add half the delta as a padding offset Y
-              pad_y = (target_height.to_f - height.to_f) / 2
-              if pad_y > 0
-                @convert_options[:output][:vf] = "scale=#{width}:-1,pad=#{width.to_i}:#{target_height.to_i}:0:#{pad_y}:black"
-              else
-                @convert_options[:output][:vf] = "scale=#{width}:-1,crop=#{width.to_i}:#{height.to_i}"
-              end
-            else
-              # Keep aspect ratio
-              width = target_width.to_i
-              height = (width.to_f / (@meta[:aspect].to_f)).to_i
-              @convert_options[:output][:s] = "#{width.to_i}x#{height.to_i}"
-            end
-          else
-            # Do not keep aspect ratio
-            @convert_options[:output][:s] = "#{target_width.to_i}x#{target_height.to_i}"
-          end
-        end
-      end
-      # Add format
-      case @format
-      when 'jpg', 'jpeg', 'png', 'gif' # Images
-        @convert_options[:input][:ss] = @time
-        @convert_options[:input][:vframes] = 1
-        @convert_options[:output][:f] = 'image2'
-      end
-      
-      # Add source
-      parameters << @convert_options[:input].map { |k,v| "-#{k.to_s} #{v} "}
-      parameters << "-i :source"
-      parameters << @convert_options[:output].map { |k,v| "-#{k.to_s} #{v} "}
-      parameters << ":dest"
-
-      parameters = parameters.flatten.compact.join(" ").strip.squeeze(" ")
-      
-      Paperclip.log("[paperclip][ffmpeg] #{parameters}")
-      begin
-        success = Paperclip.run("ffmpeg", parameters, :source => "#{File.expand_path(src.path)}", :dest => File.expand_path(dst.path))
-      rescue Cocaine::ExitStatusError => e
-        raise PaperclipError, "error while processing video for #{@basename}: #{e}" if @whiny
-      end
-
-      dst
-    end
-    
-    def identify
-      meta = {}
-      command = "ffmpeg -i #{File.expand_path(@file.path)} 2>&1"
-      Paperclip.log(command)
-      ffmpeg = IO.popen(command)
-      ffmpeg.each("\r") do |line|
-        if line =~ /((\d*)\s.?)fps,/
-          meta[:fps] = $1.to_i
-        end
-        # Matching lines like:
-        # Video: h264, yuvj420p, 640x480 [PAR 72:72 DAR 4:3], 10301 kb/s, 30 fps, 30 tbr, 600 tbn, 600 tbc
-        if line =~ /Video:(.*)/
-          v = $1.to_s.split(',')
-          size = v[2].strip!.split(' ').first
-          meta[:size] = size.to_s
-          meta[:aspect] = size.split('x').first.to_f / size.split('x').last.to_f
-        end
-        # Matching Duration: 00:01:31.66, start: 0.000000, bitrate: 10404 kb/s
-        if line =~ /Duration:(\s.?(\d*):(\d*):(\d*\.\d*))/
-          meta[:length] = $2.to_s + ":" + $3.to_s + ":" + $4.to_s
-        end
-      end
-      meta
-    end
-  end
-  
-  class Attachment
-    def meta
-      instance_read(:meta)
-    end
-  end
-end
+require "processors/ffmpeg"
+require "processors/qtfaststart"

data/lib/processors/ffmpeg.rb

@@ -0,0 +1,159 @@
+module Paperclip
+  class Ffmpeg < Processor
+    attr_accessor :geometry, :format, :whiny, :convert_options
+
+    # Creates a Video object set to work on the +file+ given. It
+    # will attempt to transcode the video into one defined by +target_geometry+
+    # which is a "WxH"-style string. +format+ should be specified.
+    # Video transcoding will raise no errors unless
+    # +whiny+ is true (which it is, by default. If +convert_options+ is
+    # set, the options will be appended to the convert command upon video transcoding.
+    def initialize file, options = {}, attachment = nil
+      @convert_options = {
+        :input => {},
+        :output => { :y => nil }
+      }
+      unless options[:convert_options].nil? || options[:convert_options].class != Hash
+        unless options[:convert_options][:input].nil? || options[:convert_options][:input].class != Hash
+          @convert_options[:input].reverse_merge! options[:convert_options][:input]
+        end
+        unless options[:convert_options][:output].nil? || options[:convert_options][:output].class != Hash
+          @convert_options[:output].reverse_merge! options[:convert_options][:output]
+        end
+      end
+      
+      @geometry        = options[:geometry]
+      @file            = file
+      @keep_aspect     = !@geometry.nil? && @geometry[-1,1] != '!'
+      @pad_only        = @keep_aspect    && @geometry[-1,1] == '#'
+      @enlarge_only    = @keep_aspect    && @geometry[-1,1] == '<'
+      @shrink_only     = @keep_aspect    && @geometry[-1,1] == '>'
+      @whiny           = options[:whiny].nil? ? true : options[:whiny]
+      @format          = options[:format]
+      @time            = options[:time].nil? ? 3 : options[:time]
+      @current_format  = File.extname(@file.path)
+      @basename        = File.basename(@file.path, @current_format)
+      @meta            = identify
+      attachment.instance_write(:meta, @meta)
+    end
+    # Performs the transcoding of the +file+ into a thumbnail/video. Returns the Tempfile
+    # that contains the new image/video.
+    def make
+      src = @file
+      dst = Tempfile.new([@basename, @format ? ".#{@format}" : ''])
+      dst.binmode
+      
+      parameters = []
+      # Add geometry
+      if @geometry
+        # Extract target dimensions
+        if @geometry =~ /(\d*)x(\d*)/
+          target_width = $1
+          target_height = $2
+        end
+        # Only calculate target dimensions if we have current dimensions
+        unless @meta[:size].nil?
+          current_geometry = @meta[:size].split('x')
+          # Current width and height
+          current_width = current_geometry[0]
+          current_height = current_geometry[1]
+          if @keep_aspect
+            if @enlarge_only
+              if current_width.to_i < target_width.to_i
+                # Keep aspect ratio
+                width = target_width.to_i
+                height = (width.to_f / (@meta[:aspect].to_f)).to_i
+                @convert_options[:output][:s] = "#{width.to_i/2*2}x#{height.to_i/2*2}"
+              else
+                return nil
+              end
+            elsif @shrink_only
+              if current_width.to_i > target_width.to_i
+                # Keep aspect ratio
+                width = target_width.to_i
+                height = (width.to_f / (@meta[:aspect].to_f)).to_i
+                @convert_options[:output][:s] = "#{width.to_i/2*2}x#{height.to_i/2*2}"
+              else
+                return nil
+              end
+            elsif @pad_only
+              # Keep aspect ratio
+              width = target_width.to_i
+              height = (width.to_f / (@meta[:aspect].to_f)).to_i
+              # We should add half the delta as a padding offset Y
+              pad_y = (target_height.to_f - height.to_f) / 2
+              if pad_y > 0
+                @convert_options[:output][:vf] = "scale=#{width}:-1,pad=#{width.to_i}:#{target_height.to_i}:0:#{pad_y}:black"
+              else
+                @convert_options[:output][:vf] = "scale=#{width}:-1,crop=#{width.to_i}:#{height.to_i}"
+              end
+            else
+              # Keep aspect ratio
+              width = target_width.to_i
+              height = (width.to_f / (@meta[:aspect].to_f)).to_i
+              @convert_options[:output][:s] = "#{width.to_i/2*2}x#{height.to_i/2*2}"
+            end
+          else
+            # Do not keep aspect ratio
+            @convert_options[:output][:s] = "#{target_width.to_i/2*2}x#{target_height.to_i/2*2}"
+          end
+        end
+      end
+      # Add format
+      case @format
+      when 'jpg', 'jpeg', 'png', 'gif' # Images
+        @convert_options[:input][:ss] = @time
+        @convert_options[:output][:vframes] = 1
+        @convert_options[:output][:f] = 'image2'
+      end
+      
+      # Add source
+      parameters << @convert_options[:input].map { |k,v| "-#{k.to_s} #{v} "}
+      parameters << "-i :source"
+      parameters << @convert_options[:output].map { |k,v| "-#{k.to_s} #{v} "}
+      parameters << ":dest"
+
+      parameters = parameters.flatten.compact.join(" ").strip.squeeze(" ")
+      
+      Paperclip.log("[ffmpeg] #{parameters}")
+      begin
+        success = Paperclip.run("ffmpeg", parameters, :source => "#{File.expand_path(src.path)}", :dest => File.expand_path(dst.path))
+      rescue Cocaine::ExitStatusError => e
+        raise PaperclipError, "error while processing video for #{@basename}: #{e}" if @whiny
+      end
+
+      dst
+    end
+    
+    def identify
+      meta = {}
+      command = "ffmpeg -i #{File.expand_path(@file.path)} 2>&1"
+      Paperclip.log(command)
+      ffmpeg = IO.popen(command)
+      ffmpeg.each("\r") do |line|
+        if line =~ /((\d*)\s.?)fps,/
+          meta[:fps] = $1.to_i
+        end
+        # Matching lines like:
+        # Video: h264, yuvj420p, 640x480 [PAR 72:72 DAR 4:3], 10301 kb/s, 30 fps, 30 tbr, 600 tbn, 600 tbc
+        if line =~ /Video:(.*)/
+          v = $1.to_s.split(',')
+          size = v[2].strip!.split(' ').first
+          meta[:size] = size.to_s
+          meta[:aspect] = size.split('x').first.to_f / size.split('x').last.to_f
+        end
+        # Matching Duration: 00:01:31.66, start: 0.000000, bitrate: 10404 kb/s
+        if line =~ /Duration:(\s.?(\d*):(\d*):(\d*\.\d*))/
+          meta[:length] = $2.to_s + ":" + $3.to_s + ":" + $4.to_s
+        end
+      end
+      meta
+    end
+  end
+  
+  class Attachment
+    def meta
+      instance_read(:meta)
+    end
+  end
+end

data/lib/processors/qtfaststart.rb

@@ -0,0 +1,46 @@
+module Paperclip
+  class Qtfaststart < Processor
+    attr_accessor :streaming, :format, :whiny
+    
+    # Creates a Video object set to work on the +file+ given. It
+    # will attempt to reposition the moov atom in the video given
+    # if +streaming+ is set.
+    def initialize file, options = {}, attachment = nil
+      @streaming      = options[:streaming]
+      @file            = file
+      @whiny           = options[:whiny].nil? ? true : options[:whiny]
+      @format          = options[:format]
+      @current_format  = File.extname(@file.path)
+      @basename        = File.basename(@file.path, @current_format)
+      attachment.instance_write(:meta, @meta)
+    end
+    
+    # Performs the atom repositioning on +file+.
+    # Returns the Tempfile that contains the new video or the original
+    # file if +streaming+ wasn't set. 
+    def make
+      return @file unless @streaming
+      
+      src = @file
+      dst = Tempfile.new([@basename, @format ? ".#{@format}" : ''])
+      dst.binmode
+      
+      parameters = []
+      # Add source
+      parameters << ":source"
+      # Add destination
+      parameters << ":dest"
+
+      parameters = parameters.flatten.compact.join(" ").strip.squeeze(" ")
+      
+      Paperclip.log("[qtfaststart] #{parameters}")
+      begin
+        success = Paperclip.run("qtfaststart", parameters, :source => "#{File.expand_path(src.path)}", :dest => File.expand_path(dst.path))
+      rescue Cocaine::ExitStatusError => e
+        raise PaperclipError, "error while processing video for #{@basename}: #{e}" if @whiny
+      end
+
+      dst
+    end
+  end
+end

data/paperclip-ffmpeg.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "paperclip-ffmpeg"
-  s.version     = '0.8.0'
+  s.version     = '0.9.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Omar Abdel-Wahab"]
   s.email       = ["owahab@gmail.com"]

metadata

@@ -2,7 +2,7 @@
 name: paperclip-ffmpeg
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Omar Abdel-Wahab
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-06 00:00:00 +02:00
+date: 2012-04-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,6 +39,8 @@ files:
 - README.md
 - Rakefile
 - lib/paperclip-ffmpeg.rb
+- lib/processors/ffmpeg.rb
+- lib/processors/qtfaststart.rb
 - paperclip-ffmpeg.gemspec
 has_rdoc: true
 homepage: http://github.com/owahab/paperclip-ffmpeg