paperclip-ffmpeg 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed70895386bfb848e38e9676d7fc06be7036aa83
-  data.tar.gz: 50ce82bc678716a8fd8b57d27e5b6235cb43ea6c
+  metadata.gz: 1620e2af45e7e28ef8861e9373581f8dac0b0c5f
+  data.tar.gz: 907ea25e1fb77489b9d781376c43582d18014c6b
 SHA512:
-  metadata.gz: 7896ba9db89ba26ffc0a6176a0cbdc57bc0e2eda9d92abf733b06162fed99d0b50aaa50b7868974aabc863ff3400f21bf7057b4d39a8bb56a541e3bea12e9c37
-  data.tar.gz: c1282ab133998aade4fe109451eb3a2e994a60a2b0ff95b3b2edbf00c0929ecead7f706102a502eeda57d3823db601f127443aa7db8f08ee9e917d4c644f750d
+  metadata.gz: 33fb2b1dbf454b54416a569e770695eca092c99e542c0aad74f4830d779cbf4e62993a7a8bd273aca3c315f1a75d674b912cbb2f4eb1fac8e5ec70ca69e7541c
+  data.tar.gz: 7fedec9076d3c4a729019d5442016fd7fa7e3c3098b2c310ac1d695691b1817e5eb1077ff83129e995789d07de518c58b6573bff01d191d0825176da042eeb86

data/.gitignore

@@ -2,3 +2,8 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/dummy/public/system/videos/*
+spec/dummy/db/development.sqlite3
+spec/dummy/log/*
+spec/dummy/db/test.sqlite3
+

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -y ffmpeg

data/Gemfile

@@ -6,5 +6,5 @@ gemspec
 group :test do
   gem 'rake'
   gem 'bundler'
-  gem 'rspec'
+  gem 'rspec', '~> 2.14'
 end

data/README.md

@@ -8,7 +8,7 @@ This gem has been tested under Linux and Mac OS X, YMMV under Windows.
 Requirements
 ------------
 
-FFMPEG must be installed and Paperclip must have access to it. To ensure
+FFMPEG or AVCONV must be installed and Paperclip must have access to it. To ensure
 that it does, on your command line, run `which ffmpeg`.
 This will give you the path where ffmpeg is installed. For
 example, it might return `/usr/local/bin/ffmpeg`.
@@ -52,6 +52,8 @@ This will produce:
 
 You may optionally add `<attachment>_meta` to your model and paperclip-ffmpeg will add information about the processed video.
 
+You may optionally add `auto_rotate: true` to automatically straighten videos recoreded in a non-landscape mode.
+
 Streaming Video
 -------------------
 
@@ -69,6 +71,33 @@ end
 
 See [danielgtaylor/qtfaststart](https://github.com/danielgtaylor/qtfaststart) for instructions on how to setup qtfaststart.
 
+FFmpeg Options
+-------------------
+
+ffmpeg accepts a variety of options for video and audio like (-ac, -vn). To handle this, paperclip-ffmpeg accepts any options and passes them directly to the ffmpeg command via `convert_options` hash which includes the `input` and `output` options
+
+```ruby
+class Lesson < ActiveRecord::Base
+	has_attached_file :media, :styles => {
+    :medium => { :geometry => "640x480", :format => 'flv', :convert_options => {:output => {:ar => 44100}} },
+    :large => { :geometry => "1024x576", :format => 'flv', :convert_options => {:output => {:ar => 44100}} },
+  }, :processors => [:ffmpeg]
+end
+```
+
+Contribution
+-------
+Kudos goes to [all contributors](https://github.com/owahab/paperclip-ffmpeg/graphs/contributors) for their amazing work.
+
+If you'd like to contribute a feature or bugfix: Thanks! To make sure your
+fix/feature has a high chance of being included, please read the following
+guidelines:
+
+1. Post a new GitHub Issue[http://github.com/owahab/paperclip-ffmpeg/issues].
+2. Make sure there are tests! We will not accept any patch that is not tested.
+   It's a rare time when explicit tests aren't needed.
+
+
 License
 -------
 

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler'
 require 'rspec/core/rake_task'
-Bundler::GemHelper.install_tasks
 
-task :default
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/lib/paperclip_processors/ffmpeg.rb

@@ -35,6 +35,7 @@ module Paperclip
       @basename        = File.basename(@file.path, @current_format)
       @meta            = identify
       @pad_color       = options[:pad_color].nil? ? "black" : options[:pad_color]
+      @auto_rotate     = options[:auto_rotate].nil? ? false : options[:auto_rotate]
       attachment.instance_write(:meta, @meta)
     end
     # Performs the transcoding of the +file+ into a thumbnail/video. Returns the Tempfile
@@ -122,6 +123,19 @@ module Paperclip
         end
       end
 
+      # If file has rotation, rotate it back to horizontal
+      if @auto_rotate && !@meta[:rotate].nil?
+        Ffmpeg.log("Adding rotation #{@meta[:rotate]}") if @whiny
+        case @meta[:rotate]
+        when 90
+          @convert_options[:output][:vf] = 'transpose=1'
+        when 180
+          @convert_options[:output][:vf] = 'vflip, hflip'
+        when 270
+          @convert_options[:output][:vf] = 'transpose=2'
+        end
+      end
+
       Ffmpeg.log("Adding Format") if @whiny
       # Add format
       case @format
@@ -155,7 +169,8 @@ module Paperclip
 
       Ffmpeg.log(parameters)
       begin
-        success = Paperclip.run("ffmpeg", parameters, :source => "#{File.expand_path(src.path)}", :dest => File.expand_path(dst.path))
+        av_lib_version = Ffmpeg.detect_ffmpeg_or_avconv
+        success = Paperclip.run(av_lib_version, parameters, :source => "#{File.expand_path(src.path)}", :dest => File.expand_path(dst.path))
       rescue Cocaine::ExitStatusError => e
         raise Paperclip::Error, "error while processing video for #{@basename}: #{e}" if @whiny
       end
@@ -165,7 +180,8 @@ module Paperclip
     
     def identify
       meta = {}
-      command = "ffprobe \"#{File.expand_path(@file.path)}\" 2>&1"
+      av_lib_version = Ffmpeg.detect_ffprobe_or_avprobe
+      command = "#{av_lib_version} \"#{File.expand_path(@file.path)}\" 2>&1"
       Paperclip.log("[ffmpeg] #{command}")
       ffmpeg = Cocaine::CommandLine.new(command).run
       ffmpeg.split("\n").each do |line|
@@ -184,6 +200,9 @@ module Paperclip
         if line =~ /Duration:(\s.?(\d*):(\d*):(\d*\.\d*))/
           meta[:length] = $2.to_s + ":" + $3.to_s + ":" + $4.to_s
         end
+        if line =~ /rotate\s*:\s(\d*)/ 
+          meta[:rotate] = $1.to_i 
+        end
       end
       Paperclip.log("[ffmpeg] Command Success") if @whiny
       meta
@@ -193,6 +212,51 @@ module Paperclip
     def self.log message
       Paperclip.log "[ffmpeg] #{message}"
     end
+
+    def self.detect_ffmpeg_or_avconv
+      # Check whether ffmpeg or avconv is installed
+      result = Ffmpeg.detect_command("ffmpeg")
+      Ffmpeg.log("Result of command: #{result}") if @whiny
+      if result == true
+        Ffmpeg.log("Result of command: #{"ffmpeg"}") if @whiny
+          return "ffmpeg"
+      elsif result == false
+        Ffmpeg.log("Result of command: #{"avconv"}") if @whiny
+          return "avconv"
+      else
+        return "Error: no video conversion library detected. Please install ffmpeg or avconv."
+      end
+    end
+
+    def self.detect_ffprobe_or_avprobe
+      # Check whether ffprobe or avprobe is installed
+      result = Ffmpeg.detect_command("ffprobe")
+      Ffmpeg.log("Result of command: #{result}") if @whiny
+      if result == true
+        Ffmpeg.log("Result of command: #{"ffprobe"}") if @whiny
+        return "ffprobe"
+      elsif result == false
+        Ffmpeg.log("Result of command: #{"avprobe"}") if @whiny
+        return "avprobe"
+      else
+        return "Error: no video conversion library detected. Please install ffmpeg or avconv."
+      end
+    end
+
+    def self.detect_command(command)
+      command = "if command -v #{command} 2>/dev/null; then echo \"true\"; else echo \"false\"; fi"
+      Ffmpeg.log(command) if @whiny
+      result = Cocaine::CommandLine.new(command).run
+      Ffmpeg.log("Result of command: #{result}") if @whiny
+      case result
+        when /true/
+          return true
+        when /false/
+          return false
+        else
+          return nil
+      end
+    end
   end
   
   class Attachment

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     = '1.0.1'
+  s.version     = '1.2.0'
   s.platform    = Gem::Platform::RUBY
   s.licenses    = 'MIT'
   s.authors     = ["Omar Abdel-Wahab"]
@@ -18,6 +18,12 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
+  s.add_dependency("rails")
   s.add_dependency('paperclip', '>=2.5.2')
+  s.add_development_dependency('rspec-rails', '~> 2.14.2')
+  s.add_development_dependency("sqlite3")
+  s.add_development_dependency("database_cleaner")
+  s.add_development_dependency("shoulda")
+  s.add_development_dependency("image_size")
 end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/video.rb

@@ -0,0 +1,38 @@
+class Video < ActiveRecord::Base
+
+	has_attached_file :clip, :styles => {
+    :medium => { :geometry => "640x480", :format => 'flv', :convert_options => {:output => {:ar => 44100}} },
+    :large => { :geometry => "1024x576", :format => 'flv', :convert_options => {:output => {:ar => 44100}} }
+  }, :processors => [:ffmpeg]
+  validates_attachment_content_type :clip, content_type:['video/mp4','video/mpeg']
+
+  has_attached_file :wrongClip, :styles => {
+    :large => { :geometry => "1024x576", :format => 'flv', :convert_options => {:output => {:ar => 3000}} }
+  }, :processors => [:ffmpeg]
+  validates_attachment_content_type :wrongClip, content_type:['video/mp4','video/mpeg']
+
+  has_attached_file :clip_thumb_exceed, :styles => {
+    :large => { :geometry => "1024x576", :format => 'flv', :convert_options => {:output => {:ar => 44100}} },
+    :thumb => { :geometry => "100x100#", :format => 'jpg', :time => 10}
+  }, :processors => [:ffmpeg]
+  validates_attachment_content_type :clip_thumb_exceed, content_type:['video/mp4','video/mpeg']
+
+  has_attached_file :clip_thumb_normal, :styles => {
+    :large => { :geometry => "1024x576", :format => 'flv', :convert_options => {:output => {:ar => 44100}} },
+    :thumb => { :geometry => "100x100#", :format => 'jpg', :time => 0}
+  }, :processors => [:ffmpeg]
+  validates_attachment_content_type :clip_thumb_normal, content_type:['video/mp4','video/mpeg']
+
+  has_attached_file :clip_thumb_negative, :styles => {
+  	:large => { :geometry => "1024x576", :format => 'flv', :convert_options => {:output => {:ar => 44100}} },
+    :thumb => { :geometry => "100x100#", :format => 'jpg', :time => -10}
+  }, :processors => [:ffmpeg]
+  validates_attachment_content_type :clip_thumb_negative, content_type:['video/mp4','video/mpeg']
+  
+  has_attached_file :clip_thumb_bad_extension, :styles => {
+  	:large => { :geometry => "1024x576", :format => 'flv', :convert_options => {:output => {:ar => 44100}} },
+    :thumb => { :geometry => "100x100#", :format => 'foo', :time => 0}
+  }, :processors => [:ffmpeg]
+  validates_attachment_content_type :clip_thumb_bad_extension, content_type:['video/mp4','video/mpeg']
+end
+

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "paperclip-ffmpeg"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000