rmedia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b37f6b6d61fd9f327536355d5fa94c138985ed15
+  data.tar.gz: 2769e68b608b2cc42be7f06cb4e1a80104077ff1
+SHA512:
+  metadata.gz: 03d5798614fed877e31330fd4ba28cf95c8c1d3a17dea10db672a0d86e2dbd8c191e11da397d981eb902fa21600027a793a19081690a54ca7eb9f5fa8641da57
+  data.tar.gz: 36c78eda9c3f20f225ac65a4fd59a274cb7b57b564336ee26c73f52613e4c7dc7236df2399c23753a80348750277f0e0d4656d4bc1b0e041957b126982f4cfb0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at himinato.k@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 himinato
+
+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,102 @@
+# Rmedia
+
+Rmedia is an interface between the Ruby and FFmpeg.
+
+* http[s] input ready.
+* [input seeking](https://trac.ffmpeg.org/wiki/Seeking) ready.
+* 2 pass encode ready.
+
+## Dependnecy
+
+[FFmpeg](https://ffmpeg.org/)
+
+How to build. [here](https://trac.ffmpeg.org/wiki/CompilationGuide)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rmedia'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rmedia
+
+## Usage
+
+### Settings
+
+Default, Rmedia need execution path and named ffmpeg / ffprobe. But you can set binary.
+
+```ruby
+FFmpeg.ffmpeg_bin = '/path/to/bin/ffmpeg'
+FFmpeg.ffprobe_bin = '/path/to/bin/ffprobe'
+```
+
+Default, Rmedia kill ffmpeg process when no 10 second IO feedback. But you can set timeout.
+
+```ruby
+FFmpeg.timeout = 30
+```
+
+### Media
+
+Readable data [here](https://github.com/himinato/rmedia/blob/master/lib/rmedia/media.rb#L7-L11)
+
+```ruby
+media = FFmpeg::Media.new('path/to/media')
+
+media.duration # 6.4
+media.width # 640
+```
+
+Via http[s]
+
+```ruby
+media = FFmpeg::Media.new('http://any/to/media')
+```
+
+### Transcode
+
+Use encode options. human friendly options [here](https://github.com/himinato/rmedia/blob/master/lib/rmedia/encode_options.rb#L3-L22)
+
+```ruby
+media.transcode('movie.webm', format: 'webm', video_bit_rate: '1500k') # transcode to webm
+trnascoded = media.transcode('movie.webm', format: 'webm', video_bit_rate: '1500k') # return encoded media
+```
+
+Or give a string.
+
+```ruby
+media.transcode('audio.mp3', '-f mp3 -vn') # transcode to mp3
+```
+
+You can use progress.
+
+```ruby
+media.transcode('movie.mp4') { |progress| puts progress } # 0.0 to 1.0
+```
+
+Input seeking. Give you faster performance.
+
+```ruby
+media.screenshot('out.jpg') # default screenshot make half of duration frame.
+media.screenshot('out.jpg', seek_position: 3.2) # you can change it. -ss / seek_position option.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rmedia"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rmedia.rb

@@ -0,0 +1,30 @@
+require 'open3'
+require 'rmedia/version'
+require 'rmedia/media'
+require 'rmedia/encode_option'
+require 'rmedia/option_parser'
+require 'rmedia/transcoder'
+
+module FFmpeg
+  def self.command(command)
+    Open3.popen3(*command) do |stdin, stdout, stderr, wait_thr|
+      yield(stdin, stdout, stderr, wait_thr) if block_given?
+    end
+  end
+
+  class << self
+    attr_accessor :ffmpeg_bin, :ffprobe_bin, :timeout
+
+    def ffmpeg_bin
+      @ffmpeg_bin ||= 'ffmpeg'
+    end
+
+    def ffprobe_bin
+      @ffprobe_bin ||= 'ffprobe'
+    end
+
+    def timeout
+      @timeout ||= 10
+    end
+  end
+end

data/lib/rmedia/encode_option.rb

@@ -0,0 +1,50 @@
+module FFmpeg
+  class EncodeOption < Hash
+    FRIENDLY_OPTIONS = {
+      format: '-f',
+      input: '-i',
+      duration: '-t',
+      stop_position: '-to',
+      limit_size: '-fs',
+      seek_position: '-ss',
+      video_bit_rate: '-b:v',
+      frame_rate: '-r',
+      resolution: '-s',
+      disable_video: '-vn',
+      video_filter: '-vf',
+      audio_bit_rate: '-b:a',
+      audio_sample_rate: '-ar',
+      audio_quality: '-q:a',
+      audio_channels: '-ac',
+      disable_audio: '-an',
+      audio_filter: '-af',
+      disable_subtitle: '-sn'
+    }.freeze
+
+    def initialize(opts = {})
+      opts.each do |key, value|
+        case
+        when FRIENDLY_OPTIONS[key.to_sym]
+          self[FRIENDLY_OPTIONS[key.to_sym]] = value
+        when private_methods.include?("opt_#{key}".to_sym)
+          send("opt_#{key}", value)
+        else
+          self[key.to_s] = value
+        end
+      end
+    end
+
+    def to_s
+      map do |key, value|
+        value.is_a?(String) || value.is_a?(Numeric) ? "#{key} #{value}" : key
+      end.join(' ')
+    end
+
+    private
+
+    def opt_screenshot(_v)
+      self['-f'] = 'image2'
+      self['-vframes'] = 1
+    end
+  end
+end

data/lib/rmedia/media.rb

@@ -0,0 +1,114 @@
+require 'faraday'
+require 'json'
+
+module FFmpeg
+  class Media
+    attr_accessor :status
+    attr_reader(
+      :path, :filename, :format, :duration, :size, :bit_rate,
+      :video_codec, :video_bit_rate, :width, :height, :resolution, :frame_rate, :sar, :dar, :pix_fmt,
+      :audio_codec, :audio_bit_rate, :audio_sample_rate, :channel_layout
+    )
+
+    def initialize(path)
+      raise Errno::ENOENT, "#{path} does not exist" unless path_exists?(path)
+
+      @path = path
+
+      options = '-v quiet -print_format json -show_format -show_streams'
+      command = "#{FFmpeg.ffprobe_bin} #{options} #{path}"
+
+      output = FFmpeg.command(command) { |_stdin, stdout| stdout.read }
+      json = JSON.parse(output)
+
+      raise "#{path} does not media" unless json['format']
+
+      media_info(json['format'])
+      streams_info(json['streams'])
+    end
+
+    def video?
+      @status & 2 == 2
+    end
+
+    def audio?
+      @status & 1 == 1
+    end
+
+    def transcode(output, options = {}, &block)
+      opts = EncodeOption.new(options)
+      command = OptionParser.command(@path, output, opts)
+      Transcoder.run(command, @duration, &block)
+      Media.new(output)
+    end
+
+    def screenshot(output, options = {}, &block)
+      opts = EncodeOption.new(options.merge(screenshot: true))
+      opts['-ss'] = @duration / 2.0 unless opts['-ss']
+      command = OptionParser.hacked_command(@path, output, opts)
+      Transcoder.run(command, @duration, &block)
+      Media.new(output)
+    end
+
+    def hacked_transcode(output, options = {}, &block)
+      opts = EncodeOption.new(options)
+      command = OptionParser.hacked_command(@path, output, opts)
+      Transcoder.run(command, @duration, &block)
+      Media.new(output)
+    end
+
+    private
+
+    def path_exists?(path)
+      File.exist?(path) || url_exists?(path)
+    end
+
+    def url_exists?(path)
+      client = Faraday.new { |f| f.use Faraday::Adapter::NetHttp }
+      res = client.head(path)
+      res.status == 200
+    rescue
+      false
+    end
+
+    def media_info(format)
+      @filename = format['filename'].split('/')[-1]
+      @format = format['format_name']
+      @duration = format['duration'].to_f
+      @size = format['size'].to_i
+      @bit_rate = format['bit_rate'].to_i
+      @status = 0
+    end
+
+    # Attributes set first stream both video and audio
+    def streams_info(streams)
+      streams.each do |stream|
+        case stream['codec_type']
+        when 'video' then @status & 2 == 0 && video_info(stream)
+        when 'audio' then @status & 1 == 0 && audio_info(stream)
+        end
+      end
+    end
+
+    def video_info(stream)
+      @video_codec = stream['codec_name']
+      @video_bit_rate = stream['bit_rate'].to_i
+      @width = stream['width'].to_i
+      @height = stream['height'].to_i
+      @resolution = "#{width}x#{height}"
+      @frame_rate = stream['avg_frame_rate'] == '0/0' ? nil : Rational(stream['avg_frame_rate'])
+      @sar = stream['sample_aspect_ratio']
+      @dar = stream['display_aspect_ratio']
+      @pix_fmt = stream['pix_fmt']
+      @status += 2
+    end
+
+    def audio_info(stream)
+      @audio_codec = stream['codec_name']
+      @audio_bit_rate = stream['bit_rate'].to_i
+      @audio_sample_rate = stream['sample_rate'].to_i
+      @channel_layout = stream['channel_layout']
+      @status += 1
+    end
+  end
+end

data/lib/rmedia/option_parser.rb

@@ -0,0 +1,52 @@
+module FFmpeg
+  module OptionParser
+    class << self
+      def command(input, output, options)
+        exec_ffmpeg_command(input, output, parse(options).to_s)
+      end
+
+      def hacked_command(input, output, options)
+        opts = parse(options).to_s
+        if opts.include?('-pass 2')
+          two_pass(input, output, opts)
+        else
+          input_seeking(input, output, opts)
+        end
+      end
+
+      private
+
+      def parse(options)
+        case
+        when options.is_a?(String) || options.is_a?(EncodeOption)
+          options
+        when options.is_a?(Hash)
+          EncodeOption.new(options)
+        else
+          fail ArgumentError, 'unknown options format, should be either optoins, Hash or String' # rubocop:disable LineLength
+        end
+      end
+
+      def exec_ffmpeg_command(input, output, opts)
+        "#{FFmpeg.ffmpeg_bin} -y -i #{input} #{opts} #{output}"
+      end
+
+      def two_pass(input, output, opts)
+        first_opts = "#{opts.sub('-pass 2', '-pass 1')} -an"
+        first_command = input_seeking(input, output, first_opts)
+        "#{first_command} && #{input_seeking(input, output, opts)}"
+      end
+
+      def input_seeking(input, output, opts)
+        opts.sub!(/-ss \d+[\.\d]*/, '')
+        if Regexp.last_match
+          # it makes faster transcoding.
+          #   NOTE: works only transcode, do not use -codec copy.
+          "#{FFmpeg.ffmpeg_bin} -y #{Regexp.last_match[0]} -i #{input} #{opts} #{output}"
+        else
+          exec_ffmpeg_command(input, output, opts)
+        end
+      end
+    end
+  end
+end

data/lib/rmedia/transcoder.rb

@@ -0,0 +1,44 @@
+require 'timeout'
+
+module FFmpeg
+  module Transcoder
+    class << self
+      def run(command, duration)
+        yield(0.0) if block_given?
+        FFmpeg.command(command) do |_stdin, _stdout, stderr, wait_thr|
+          last_update = Time.now
+
+          stderr.each('size=') do |line|
+            check_timeout(wait_thr.pid, last_update)
+            yield(edit_time(line) / duration) if block_given?
+          end
+        end
+        yield(1.0) if block_given?
+      end
+
+      private
+
+      def check_timeout(pid, last_update)
+        last_update = Time.now
+        if Time.now - last_update > FFmpeg.timeout
+          raise Timeout::Error.new('FFmpeg hung up')
+        end
+      rescue
+        Process.kill('KILL', pid)
+        raise
+      end
+
+      def edit_time(line)
+        return 0.0 unless line.include?('time=')
+        # ffmpeg 0.8 and above style
+        if line =~ /time=(\d+):(\d+):(\d+.\d+)/
+          (Regexp.last_match[1].to_i * 3600) +
+            (Regexp.last_match[2].to_i * 60) +
+            Regexp.last_match[3].to_f
+        else
+          0.0
+        end
+      end
+    end
+  end
+end

data/lib/rmedia/version.rb

@@ -0,0 +1,3 @@
+module FFmpeg
+  VERSION = "0.1.0"
+end

data/rmedia.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rmedia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rmedia'
+  spec.version       = FFmpeg::VERSION
+  spec.authors       = ['Shinichi Okamoto']
+  spec.email         = ['himinato.k@gmail.com']
+
+  spec.summary       = 'Ruby binding to FFmpeg'
+  spec.description   = 'Ruby interface to FFmpeg'
+  spec.homepage      = 'https://gihub.com/himinato/rmedia'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rmedia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shinichi Okamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby interface to FFmpeg
+email:
+- himinato.k@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rmedia.rb
+- lib/rmedia/encode_option.rb
+- lib/rmedia/media.rb
+- lib/rmedia/option_parser.rb
+- lib/rmedia/transcoder.rb
+- lib/rmedia/version.rb
+- rmedia.gemspec
+homepage: https://gihub.com/himinato/rmedia
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby binding to FFmpeg
+test_files: []