activejob-ffmpeg 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bedb71118c02a03d503b94b2c8faa4d64ed3375a
+  data.tar.gz: ec15cebf580764607e8eaa38b5ccece91554d21a
+SHA512:
+  metadata.gz: 139c562453808334ae8310cd0ade7998a28c625415dfcf9ca3bdf9703086e5bc8548a785c04bc6edd1aebf33d555726f9efd4b264d7ae454803ab810033a889e
+  data.tar.gz: 7f26c2a3d8906934d30b7b2c7d41f38455a1374ae0c011424f68b1a52808df51f7e2b02e58a63bd8759fae47e5feea03c3a40d1a7d19c078f3eeffe336dd0861

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+spec/samples/output.*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache:
+  - bundler
+before_install:
+  - ci/install_ffmpeg
+  - export PATH=`pwd`/ffmpeg:$PATH
+rvm:
+  - 2.1
+notifications:
+  email:
+    on_success: change

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-ffmpeg.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 joker1007
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# ActiveJob::Ffmpeg
+[![Gem Version](https://badge.fury.io/rb/activejob-ffmpeg.svg)](http://badge.fury.io/rb/activejob-ffmpeg)
+[![Build Status](https://travis-ci.org/joker1007/activejob-ffmpeg.svg?branch=master)](https://travis-ci.org/joker1007/activejob-ffmpeg)
+[![Coverage Status](https://coveralls.io/repos/joker1007/activejob-ffmpeg/badge.png)](https://coveralls.io/r/joker1007/activejob-ffmpeg)
+
+ActiveJob job definition for ffmpeg.
+
+## Installation
+gem install:
+
+    $ gem install activejob-ffmpeg
+
+Add this line to your application's Gemfile:
+
+    gem 'activejob-ffmpeg', github: "joker1007/activejob-ffmpeg"
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+class EncodeJob < ActiveJob::Ffmpeg::BaseJob
+  def on_progress(progress, extra_data = {})
+    p progress
+  end
+
+  def on_complete(encoder, extra_data = {})
+    puts "complete"
+  end
+end
+
+EncodeJob.perform_later(input_filename, output_filename, extra_data, :mp4)
+```
+
+Implemented Encoder class is following:
+
+- mp4
+- WebM
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/activejob-ffmpeg/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activejob-ffmpeg.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_job/ffmpeg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activejob-ffmpeg"
+  spec.version       = ActiveJob::Ffmpeg::VERSION
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+  spec.description   = %q{easier way to use ffmpeg in activejob}
+  spec.summary       = %q{easier way to use ffmpeg in activejob}
+  spec.homepage      = "https://github.com/joker1007/activejob-ffmpeg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency     "activejob", ">= 4.2.0.rc3"
+  spec.add_development_dependency "bundler", ">= 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "tapp"
+  spec.add_development_dependency "coveralls"
+end

data/ci/install_ffmpeg

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+mkdir ffmpeg
+wget "http://ffmpeg.gusari.org/static/64bit/ffmpeg.static.64bit.latest.tar.gz"
+tar xzf ffmpeg.static.64bit.latest.tar.gz -C ffmpeg

data/lib/active_job/ffmpeg.rb

@@ -0,0 +1,41 @@
+require "active_job/ffmpeg/version"
+
+module ActiveJob
+  module Ffmpeg
+
+    autoload :BaseJob, "#{File.dirname(__FILE__)}/ffmpeg/base_job"
+
+    module Encoder
+      autoload :Base, "#{File.dirname(__FILE__)}/ffmpeg/encoder/base"
+      autoload :MP4, "#{File.dirname(__FILE__)}/ffmpeg/encoder/mp4"
+      autoload :WebM, "#{File.dirname(__FILE__)}/ffmpeg/encoder/webm"
+    end
+
+    class << self
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
+
+      def logger=(logger)
+        @logger = logger
+      end
+
+      def ffmpeg_cmd
+        ENV["FFMPEG"] || "ffmpeg"
+      end
+
+      def get_aspect(filename)
+        return nil unless filename
+
+        aspect = nil
+        ffmpeg = IO.popen("#{ffmpeg_cmd} -i #{filename.shellescape} 2>&1")
+        ffmpeg.each("\r") do |line|
+          if line =~ /Stream.*Video.*, (\d+)x(\d+)[,\s]/
+            aspect = "#{$1}/#{$2}".to_r
+          end
+        end
+        aspect
+      end
+    end
+  end
+end

data/lib/active_job/ffmpeg/base_job.rb

@@ -0,0 +1,25 @@
+require 'active_job'
+require 'active_support/core_ext/hash'
+
+module ActiveJob
+  module Ffmpeg
+    class BaseJob < ActiveJob::Base
+      def perform(input_filename, output_filename, extra_data = {}, format = :mp4)
+        case format.to_s
+        when "mp4"
+          encoder = Encoder::MP4.new
+        when "webm"
+          encoder = Encoder::WebM.new
+        end
+
+        encoder.on_progress = Proc.new {|progress| on_progress(progress, extra_data)} \
+          if respond_to?(:on_progress)
+
+        encoder.on_complete = Proc.new {|enc| on_complete(enc, extra_data)} \
+          if respond_to?(:on_complete)
+
+        encoder.do_encode(input_filename, output_filename)
+      end
+    end
+  end
+end

data/lib/active_job/ffmpeg/encoder/base.rb

@@ -0,0 +1,93 @@
+require "shellwords"
+require "open3"
+
+module ActiveJob
+  module Ffmpeg
+    module Encoder
+      class Base
+        attr_reader :size, :video_bitrate, :audio_bitrate, :audio_sample_rate, :other_options
+        attr_reader :input_filename, :output_filename
+        attr_reader :on_progress, :on_complete
+
+        def initialize(options = {})
+          raise ArgumentError unless options.is_a?(Hash)
+          merged_options = preset_options.merge(options)
+          @size              = merged_options[:size]
+          @aspect            = merged_options[:aspect]
+          @video_bitrate     = merged_options[:video_bitrate]
+          @audio_bitrate     = merged_options[:audio_bitrate]
+          @audio_sample_rate = merged_options[:audio_sample_rate]
+          @other_options     = merged_options[:other_options]
+        end
+
+        def preset_options
+          {}
+        end
+
+        def format
+          raise NotImplementedError
+        end
+
+        def vcodec
+          raise NotImplementedError
+        end
+
+        def acodec
+          raise NotImplementedError
+        end
+
+        def aspect(filename = nil)
+          @aspect || Ffmpeg.get_aspect(filename)
+        end
+
+        def on_progress=(progress_proc)
+          raise ArgumentError unless progress_proc.is_a?(Proc)
+          @on_progress = progress_proc
+        end
+
+        def on_complete=(complete_proc)
+          raise ArgumentError unless complete_proc.is_a?(Proc)
+          @on_complete = complete_proc
+        end
+
+        def do_encode(input, output)
+          @input_filename = input
+          @output_filename = output
+          cmd = %W(#{Ffmpeg.ffmpeg_cmd} -y -i #{@input_filename} -f #{format} -s #{size} -aspect #{aspect(@input_filename)} -vcodec #{vcodec} -b:v #{video_bitrate} -acodec #{acodec} -ar #{audio_sample_rate} -b:a #{audio_bitrate})
+          cmd.concat(other_options.split(" "))
+          cmd.reject!(&:empty?)
+          cmd << @output_filename
+
+          if ENV["DEBUG"]
+            Ffmpeg.logger.debug(cmd.map(&:shellescape).join(" "))
+          end
+
+          duration = nil
+          time = nil
+          progress = nil
+
+          Open3.popen3(*cmd) do |stdin, stdout, stderr, wait_th|
+            while line = stderr.gets("\r")
+              if line =~ /Duration:(\s.?(\d*):(\d*):(\d*)\.(\d*))/
+                duration = $2.to_i * 3600 + $3.to_i * 60 + $4.to_i
+              end
+
+              if line =~ /frame=.*time=(\s*(\d*):(\d*):(\d*)\.(\d*))/
+                time = $2.to_i * 3600 + $3.to_i * 60 + $4.to_i
+              end
+
+              if duration && time
+                progress = (time / duration.to_f)
+                on_progress.call(progress) if on_progress
+              end
+            end
+
+            wait_th.join
+          end
+
+          on_complete.call(self) if on_complete
+        end
+      end
+    end
+  end
+end

data/lib/active_job/ffmpeg/encoder/mp4.rb

@@ -0,0 +1,50 @@
+module ActiveJob
+  module Ffmpeg
+    module Encoder
+      class MP4 < Base
+        def initialize(options = {})
+          super
+          @acodec = options[:acodec] || acodec_select
+        end
+
+        def preset_options
+          {
+            :size              => "640x480",
+            :video_bitrate     => "600k",
+            :audio_bitrate     => "128k",
+            :audio_sample_rate => 44100,
+            :other_options     => "-partitions all -me_method hex -subq 6 -me_range 16 -g 250 -keyint_min 25 -sc_threshold 40 -i_qfactor 0.71 -b_strategy 1 -qcomp 0.6 -qmin 10 -qmax 51 -qdiff 4 -maxrate 1000 -level 30 -async 2#{acodec_select == "libfdk_aac" ? " -cutoff 18000" : ""}"
+          }
+        end
+
+        def vcodec
+          "libx264"
+        end
+
+        def acodec
+          @acodec
+        end
+
+        def format
+          "mp4"
+        end
+
+        private
+
+        def acodec_select
+          return @acodec if @acodec
+          @acodec = case `#{Ffmpeg.ffmpeg_cmd} -v quiet -codecs | grep aac`
+                    when /libfdk_aac/
+                      "libfdk_aac"
+                    when /libfaac/
+                      "libfaac"
+                    when /aac/
+                      "aac"
+                    when /libvo_aacenc/
+                      "libvo_aacenc"
+                    end
+        end
+      end
+    end
+  end
+end

data/lib/active_job/ffmpeg/encoder/webm.rb

@@ -0,0 +1,29 @@
+module ActiveJob
+  module Ffmpeg
+    module Encoder
+      class WebM < Base
+        def preset_options
+          {
+            :size              => "640x480",
+            :video_bitrate     => "600k",
+            :audio_bitrate     => "128k",
+            :audio_sample_rate => 44100,
+            :other_options     => "-aq 3 -partitions all -me_method hex -subq 6 -me_range 16 -g 250 -keyint_min 25 -sc_threshold 40 -i_qfactor 0.71 -b_strategy 1 -qcomp 0.6 -qmin 10 -qmax 51 -qdiff 4 -level 30 -async 2"
+          }
+        end
+
+        def vcodec
+          "libvpx"
+        end
+
+        def acodec
+          "libvorbis"
+        end
+
+        def format
+          "webm"
+        end
+      end
+    end
+  end
+end

data/lib/active_job/ffmpeg/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module Ffmpeg
+    VERSION = "0.0.3"
+  end
+end

data/lib/activejob-ffmpeg.rb

@@ -0,0 +1 @@
+require "active_job/ffmpeg"

data/spec/lib/activejob-ffmpet_spec.rb

@@ -0,0 +1,133 @@
+require "spec_helper"
+
+describe ActiveJob::Ffmpeg do
+  describe ".get_aspect" do
+    subject { ActiveJob::Ffmpeg.get_aspect("#{sample_dir}/sample_16_9.mp4") }
+
+    it { should eq "16/9".to_r }
+  end
+
+  describe "#do_encode" do
+    context "MP4" do
+      subject(:encoder) { ActiveJob::Ffmpeg::Encoder::MP4.new }
+
+      describe "on_progress callback" do
+        before do
+          encoder.on_progress = Proc.new {|progress| true }
+        end
+
+        it "on_progress receive call" do
+          expect(encoder.on_progress).to receive(:call).with(an_instance_of(Float)).at_least(4).and_call_original
+          encoder.do_encode("#{sample_dir}/sample.mp4", "#{sample_dir}/output.mp4")
+        end
+
+        describe "shellescape" do
+          it "on_progress receive call" do
+            expect(encoder.on_progress).to receive(:call).with(an_instance_of(Float)).at_least(4).and_call_original
+            encoder.do_encode("#{sample_dir}/hoge's title.mp4", "#{sample_dir}/output.mp4")
+          end
+        end
+      end
+
+      describe "on_complete callback" do
+        before do
+          encoder.on_complete = Proc.new {|encoder| true }
+        end
+
+        it "on_complete receive call" do
+          expect(encoder.on_complete).to receive(:call).with(encoder).once
+          encoder.do_encode("#{sample_dir}/sample.mp4", "#{sample_dir}/output.mp4")
+        end
+      end
+
+      describe "debug log" do
+        before do
+          ENV["DEBUG"] = "1"
+          expect(ActiveJob::Ffmpeg.logger).to be_a(Logger)
+        end
+
+        after do
+          ENV["DEBUG"] = nil
+        end
+
+        it "should call logger.debug" do
+          expect(ActiveJob::Ffmpeg.logger).to receive(:debug)
+          encoder.do_encode("#{sample_dir}/sample.mp4", "#{sample_dir}/output.mp4")
+        end
+      end
+    end
+
+    context "WebM" do
+      subject(:encoder) { ActiveJob::Ffmpeg::Encoder::WebM.new }
+
+      describe "on_progress callback" do
+        before do
+          encoder.on_progress = Proc.new {|progress| true }
+        end
+
+        it "on_progress receive call" do
+          expect(encoder.on_progress).to receive(:call).with(an_instance_of(Float)).at_least(4)
+          encoder.do_encode("#{sample_dir}/sample.mp4", "#{sample_dir}/output.webm")
+        end
+      end
+
+      describe "on_complete callback" do
+        before do
+          encoder.on_complete = Proc.new {|encoder| true }
+        end
+
+        it "on_complete receive call" do
+          expect(encoder.on_complete).to receive(:call).with(encoder).once
+          encoder.do_encode("#{sample_dir}/sample.mp4", "#{sample_dir}/output.webm")
+        end
+      end
+    end
+  end
+end
+
+describe ActiveJob::Ffmpeg::BaseJob do
+  context "When job is performed" do
+    class ::TestJob < ActiveJob::Ffmpeg::BaseJob
+    end
+
+    it "should receive do_encode" do
+      input_filename = "#{sample_dir}/sample.mp4"
+      output_filename = "#{sample_dir}/output.mp4"
+      expect_any_instance_of(ActiveJob::Ffmpeg::Encoder::MP4).to receive(:do_encode).with(input_filename, output_filename).once
+      TestJob.perform_later(input_filename, output_filename)
+    end
+  end
+
+  context "Job class has on_progress method" do
+    class ProgressJob < ActiveJob::Ffmpeg::BaseJob
+
+      def on_progress(progress, extra_data = {})
+        true
+      end
+    end
+
+    it "should receive on_progress" do
+      input_filename = "#{sample_dir}/sample.mp4"
+      output_filename = "#{sample_dir}/output.mp4"
+      expect_any_instance_of(ProgressJob).to receive(:on_progress).with(an_instance_of(Float), {}).at_least(4)
+      ProgressJob.perform_later(input_filename, output_filename)
+    end
+  end
+
+  context "Job class has on_complete method" do
+    class CompleteJob < ActiveJob::Ffmpeg::BaseJob
+
+      def on_complete(encoder, extra_data = {})
+        true
+      end
+    end
+
+    it "should receive on_complete" do
+      input_filename = "#{sample_dir}/sample.mp4"
+      output_filename = "#{sample_dir}/output.mp4"
+      expect_any_instance_of(CompleteJob).to receive(:on_complete).with(an_instance_of(ActiveJob::Ffmpeg::Encoder::MP4), {"id" => 1}).once
+      CompleteJob.perform_later(input_filename, output_filename, {"id" => 1})
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'coveralls'
+Coveralls.wear!
+
+require 'active_job'
+require 'active_job/ffmpeg'
+
+require 'tapp'
+
+$spec_dir = File.dirname(File.expand_path(__FILE__))
+
+RSpec.configure do |config|
+  config.order = :random
+end
+
+def sample_dir
+  File.expand_path("../samples", __FILE__)
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: activejob-ffmpeg
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0.rc3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0.rc3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tapp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: easier way to use ffmpeg in activejob
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activejob-ffmpeg.gemspec
+- ci/install_ffmpeg
+- lib/active_job/ffmpeg.rb
+- lib/active_job/ffmpeg/base_job.rb
+- lib/active_job/ffmpeg/encoder/base.rb
+- lib/active_job/ffmpeg/encoder/mp4.rb
+- lib/active_job/ffmpeg/encoder/webm.rb
+- lib/active_job/ffmpeg/version.rb
+- lib/activejob-ffmpeg.rb
+- spec/lib/activejob-ffmpet_spec.rb
+- spec/samples/hoge's title.mp4
+- spec/samples/sample.mp4
+- spec/samples/sample_16_9.mp4
+- spec/spec_helper.rb
+homepage: https://github.com/joker1007/activejob-ffmpeg
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: easier way to use ffmpeg in activejob
+test_files:
+- spec/lib/activejob-ffmpet_spec.rb
+- spec/samples/hoge's title.mp4
+- spec/samples/sample.mp4
+- spec/samples/sample_16_9.mp4
+- spec/spec_helper.rb