ffmpeg_web 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f07383478d87fdb82d3f7edb2dfecc86b1faa65
+  data.tar.gz: eb67c2bd4e2b2c8b163e2258e352e5ae93d024fe
+SHA512:
+  metadata.gz: b26f548704f8b8db547f669bd7c6ba709b460d6cd47254c72719dddaa03d025968f6531036e53ea60cfe5b7f65765f483f9f42bbd0df5257fc627be2335b5a72
+  data.tar.gz: a0e37deaf0ca9ed6015cbdd2b4190732b9d0f99d2381f15b164ae9430f03b6c55ed7f91b528301015b71f091240e45a4e52b31cf69ab942439217e44c336ab37

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jason
+
+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,29 @@
+# FfmpegWeb
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ffmpeg_web'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ffmpeg_web
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/ffmpeg_web/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 new Pull Request

data/Rakefile

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

data/ffmpeg_web.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffmpeg_web/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ffmpeg_web"
+  spec.version       = FFmpegWeb::VERSION
+  spec.authors       = ["Jason"]
+  spec.email         = ["jsofokleous@googlemail.com"]
+  spec.summary       = %q{A Ruby wrapper for FFMpeg that allows you to transcode video into a web optimised format. }
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/jasonsof/ffmpeg_web"
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec" 
+end

data/lib/ffmpeg_web.rb

@@ -0,0 +1,143 @@
+require "ffmpeg_web/version"
+
+module FFmpegWeb
+  class Transcoder
+    attr_accessor :input, :output, :video_info
+
+    def initialize(input, output)
+      @input = input
+      @output = output
+      
+      raise "Input file does not exist" if !File.exists?(input)
+      raise "Output directory does not exist" if !File.exists?(File.dirname(output))
+
+      @video_info = ffmpeg_info
+
+      raise "File is not a valid movie file" if !is_valid?
+    end
+
+    # returns the duration of the video in seconds
+    def duration
+      duration = /Duration: (\d{2}):(\d{2}):(\d{2}).(\d{2})/.match(@video_info)
+      duration_in_milliseconds = ($~[1].to_i * 60 * 60) + ($~[2].to_i * 60) + $~[3].to_i + ($~[4].to_i / 1000)
+    end
+
+    # transcodes the file and returns an io pipe object
+    def transcode(output_size=nil)
+      progress_read, progress_write = IO::pipe
+      pid = Process.fork do
+        progress_read.close
+
+        if output_size.nil?
+         crf_encode(progress_write)
+        else
+          two_pass_encode(output_size, progress_write)
+        end
+      end
+
+      progress_write.close
+
+      progress_read
+    end
+
+    private
+      def ffmpeg_info
+        read, write = IO::pipe
+        pid = Process.fork do
+          read.close
+
+          $stderr.reopen(write)
+          exec("ffmpeg -y -i '#{@input}'")
+        end
+        write.close
+
+        ffmpeg_output = read.read
+        ffmpeg_output
+      end
+
+      def is_valid?
+        video_stream, audio_stream = nil
+
+        if match = @video_info.match(/Video: (.*)$/i)
+          video_stream = match.captures.first
+        end
+
+        if match = @video_info.match(/Audio: (.*)$/i)
+          audio_stream = match.captures.first
+        end
+
+        video_stream && audio_stream
+      end
+
+      def two_pass_encode(output_size, progress_write)
+        output_size_in_kilobits = output_size * 8192      
+        audio_bitrate = 128
+        total_bitrate = output_size_in_kilobits / self.duration
+        video_bitrate = total_bitrate - audio_bitrate
+
+        first_pass = "ffmpeg -y -i '#{@input}' -movflags faststart -c:v libx264 -preset slow -b:v #{video_bitrate}k -an -pass 1 -f mp4 /dev/null"
+        second_pass = "ffmpeg -y -i '#{@input}' -movflags faststart -c:v libx264 -preset slow -b:v #{video_bitrate}k -c:a libfaac -b:a #{audio_bitrate}k -pass 2 '#{@output}.mp4'"
+
+        pid, read = do_pass(first_pass)
+        log_progress(read, progress_write, 1, 2)
+        pid, status = Process.waitpid2(pid)
+
+        pid, read = do_pass(second_pass)
+        log_progress(read, progress_write, 2, 2)
+        pid, status = Process.waitpid2(pid)
+        status.exitstatus
+      end
+
+      def crf_encode(progress_write)
+        pid, read = do_pass("ffmpeg -y -i '#{@input}' -movflags faststart -c:v libx264 -preset slow -crf 20 -c:a libfaac '#{output}.mp4'")
+        log_progress(read, progress_write, 1, 1)
+
+        pid, status = Process.waitpid2(pid)
+        status.exitstatus
+      end
+
+      def do_pass(cmd)
+        read, write = IO::pipe
+        pid = Process.fork do
+          read.close
+
+          $stderr.reopen(write)
+          $stdout.reopen(write)
+          exec(cmd)
+        end
+        write.close
+
+        [pid, read]
+      end
+
+      def log_progress(input_stream, output_stream, current_pass, number_of_passes)
+        duration = 0.00 #milliseconds
+        elapsed = 0.00 #milliseconds
+
+        while line = input_stream.gets
+          if line =~ /Duration: (\d{2}):(\d{2}):(\d{2}).(\d{2})/ && duration == 0.00
+            duration = ($~[1].to_i * 60 * 60 * 1000) + ($~[2].to_i * 60 * 1000) + ($~[3].to_i * 1000) + $~[4].to_i
+            break
+          end     
+        end
+
+        while line = input_stream.gets("\r")
+          line = line.encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '') if line
+          if line =~ /time=(\d{2}):(\d{2}):(\d{2}).(\d{2})/
+            elapsed = ($~[1].to_i * 60 * 60 * 1000) + ($~[2].to_i * 60 * 1000) + ($~[3].to_i * 1000) + $~[4].to_i
+
+            pass_progress = (elapsed.to_f / duration.to_f) * 100
+            if number_of_passes > 1 && current_pass > 1
+              progress = (pass_progress / number_of_passes) + (100 / number_of_passes)
+            elsif number_of_passes > 1 && current_pass == 1
+              progress = pass_progress / number_of_passes
+            else
+              progress = pass_progress
+            end
+            
+            output_stream.puts progress.round(2).to_s + "%"
+          end
+        end
+      end      
+  end
+end

data/lib/ffmpeg_web/version.rb

@@ -0,0 +1,3 @@
+module FFmpegWeb
+  VERSION = "0.0.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'ffmpeg_web'
+
+RSpec.configure do |config|
+end
+
+def fixture_path
+  @fixture_path ||= File.join(File.dirname(__FILE__), 'fixtures')
+end
+
+def base_path
+  @base_path ||= Dir.pwd#File.expand_path("..",Dir.pwd)
+end

data/spec/transcoder_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe FFmpegWeb::Transcoder do
+  let(:good_input) { "#{fixture_path}/10 seconds.mov" }
+  let(:bad_input) { "#{fixture_path}/broken.mp4" }
+  let(:output) { "#{fixture_path}/output" }
+
+  describe "#initialize" do
+    it "sets the @input variable" do
+      transcoder = FFmpegWeb::Transcoder.new(good_input, output)
+      expect(transcoder.instance_variable_get(:@input)).to eq good_input
+    end
+    it "sets the @output variable" do
+      transcoder = FFmpegWeb::Transcoder.new(good_input, output)
+      expect(transcoder.instance_variable_get(:@output)).to eq output
+    end
+
+    context "when the input is an invalid video file" do
+      it "raises an exception" do
+        expect {
+          transcoder = FFmpegWeb::Transcoder.new(bad_input, output)
+          }.to raise_exception
+      end
+    end
+
+    context "when the input does not exist" do
+      it "raises an exception" do
+        input = "/path/to/nonexistent/input.mov"
+
+        expect {
+          transcoder = FFmpegWeb::Transcoder.new(input, output)
+        }.to raise_exception
+      end
+    end
+
+    context "when the output directory does not exist" do
+      it "raises an exception" do
+        output = "/path/nonexistent/output"
+
+        expect {
+          transcoder = FFmpegWeb::Transcoder.new(good_input, output)
+        }.to raise_exception
+      end
+    end
+  end
+
+  describe "#duration" do
+    context "when the input is a valid video file" do
+      it "returns the videos duration in seconds" do
+        transcoder = FFmpegWeb::Transcoder.new(good_input, output)
+        expect(transcoder.duration).to eq(10)
+      end
+
+      it "returns a Fixnum" do
+        transcoder = FFmpegWeb::Transcoder.new(good_input, output)
+        expect(transcoder.duration).to be_a(Fixnum)
+      end
+    end
+  end
+
+  describe "#transcode" do
+    let(:megabyte) { 1024.0 * 1024.0 }
+
+    after(:each) do
+      begin
+        FileUtils.rm("#{fixture_path}/output.mp4")
+        FileUtils.rm("#{base_path}/ffmpeg2pass-0.log")
+        FileUtils.rm("#{base_path}/ffmpeg2pass-0.log.mbtree")
+      rescue Errno::ENOENT
+      end
+    end
+
+    context "given an output filesize" do
+      it "creates an output file around the size given" do
+        desired_output_size_in_mb = 10
+
+        transcoder = FFmpegWeb::Transcoder.new(good_input, output)
+        progress_stream = transcoder.transcode(desired_output_size_in_mb)
+        while progress = progress_stream.gets
+        end
+
+        expect(File.exists?("#{output}.mp4")).to be_true
+        output_size = File.size("#{output}.mp4").to_f / megabyte
+        expect(output_size).to be_within(1).of(desired_output_size_in_mb)
+      end
+    end
+
+    context "without given an output filesize" do
+      it "creates an output file" do
+        transcoder = FFmpegWeb::Transcoder.new(good_input, output)
+        progress_stream = transcoder.transcode(10)
+        while progress = progress_stream.gets
+        end
+
+        expect(File.exists?("#{output}.mp4")).to be_true
+      end
+    end
+
+    it "returns an IO stream" do
+      transcoder = FFmpegWeb::Transcoder.new(good_input, output)
+      progress_stream = transcoder.transcode(10)
+      expect(progress_stream).to be_an(IO)
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ffmpeg_web
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-27 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: ''
+email:
+- jsofokleous@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ffmpeg_web.gemspec
+- lib/ffmpeg_web.rb
+- lib/ffmpeg_web/version.rb
+- spec/fixtures/10 seconds.mov
+- spec/fixtures/broken.mp4
+- spec/spec_helper.rb
+- spec/transcoder_spec.rb
+homepage: https://github.com/jasonsof/ffmpeg_web
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for FFMpeg that allows you to transcode video into a web optimised
+  format.
+test_files:
+- spec/fixtures/10 seconds.mov
+- spec/fixtures/broken.mp4
+- spec/spec_helper.rb
+- spec/transcoder_spec.rb