mediakit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba4ab75bf6e7d06e4d47117147e26dd2dccdb650
-  data.tar.gz: d4e1e172178d66a94c581696e00235a896567cf0
+  metadata.gz: 6bce22e6bb5655d6ef5522dfb86cd95660b56119
+  data.tar.gz: 4ae5b7f5a0c1348aa22de26b0da11a80c47f0f05
 SHA512:
-  metadata.gz: 02b9db5afc15386e6398f267513cb5c7b040e540e7f6f677f5b9d9f70d410b49c16a28cea77a3006df674a95ce67d2e5ef8209629ce69e38c16bb52da3acdcb7
-  data.tar.gz: b42d2eb275b21769af3c90e3a8df77220cdd81abe5bc060f10912995ec6d2e0ffa230dba12f43eb34f036373aeacf7575e2e779b4d505f0c7878dd6405fd5b9b
+  metadata.gz: 67789568de47730bc876c7be8971d45bfa6e69179cb227abd4052a390e41aea7eb52939932b144a27bcc2752abe02c690361e88c8e8b9f5973ae3a2897d8ed54
+  data.tar.gz: 8db964b6558ceec920bc45833bcb7e57cccc1a5f6891c69540c40b3934a35761feb7d02f440f0abb0bbfda304bf463c02de0b20b3d21cab73f8854032dc751ef

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
   - 2.2.0
+before_install:
+  - gem update --system
+  - gem update bundler
+  - gem --version

data/README.md

@@ -1,5 +1,7 @@
 # Mediakit
 
+[![Build Status](https://travis-ci.org/ainame/mediakit.svg)](https://travis-ci.org/ainame/mediakit)
+
 mediakit is the libraries for ffmpeg and sox backed media manipulation something.
 I've design this library for following purpose.
 
@@ -8,7 +10,10 @@ I've design this library for following purpose.
 
 ## Development Plan
 
+Currently under development.
+
 * [x] low-level interface for ffmpeg
+* [ ] low-level interface's basic feature
 * [ ] high-level interface for ffmpeg
 * [ ] low-level interface for sox
 * [ ] high-level interface for sox
@@ -46,18 +51,18 @@ but can pass certain it.
 
 ```rb
 driver = Mediakit::Drivers::FFmpeg.new
-ffmpeg = Mediakit::Runners::FFmpeg.new(driver)
+ffmpeg = Mediakit::FFmpeg.new(driver)
 
-options = Mediakit::Runners::FFmpeg::Options.new(
-  Mediakit::Runners::FFmpeg::Options::GlobalOption.new(
+options = Mediakit::FFmpeg::Options.new(
+  Mediakit::FFmpeg::Options::GlobalOption.new(
     't' => 100,
     'y' => true,
   ),
-  Mediakit::Runners::FFmpeg::Options::InputFileOption.new(
+  Mediakit::FFmpeg::Options::InputFileOption.new(
     options: nil,
     path:    input,
   ),
-  Mediakit::Runners::FFmpeg::Options::OutputFileOption.new(
+  Mediakit::FFmpeg::Options::OutputFileOption.new(
     options: {
       'vf' => 'crop=320:320:0:0',
       'ar' => '44100',
@@ -66,7 +71,7 @@ options = Mediakit::Runners::FFmpeg::Options.new(
     path:    output,
   ),
 )
-puts "$ ffmpeg #options"
+puts "$ #{ffmpeg.command(options)}"
 puts ffmpeg.run(options)
 ```
 

data/Rakefile

@@ -1 +1,16 @@
-require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task(default: :test)
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end

data/lib/mediakit/drivers.rb

@@ -1,9 +1,10 @@
 require 'shellwords'
-require 'mediakit/utils/popen_helper'
+require 'mediakit/utils/process_runner'
 
 module Mediakit
   module Drivers
     class DriverError < StandardError; end
+    class FailError < DriverError; end
     class ConfigurationError < DriverError; end
 
     class Base
@@ -25,18 +26,21 @@ module Mediakit
       # execute command and return result
       #
       # @overload run(args)
-      #   @param args [String] arguments for command
-      # @overload run(*args)
-      #   @param args [Array] arguments for command
-      # @return result [Bool] runners result
+      #   @param [String] args string argument for command
+      # @overload run(*args, options)
+      #   @param [Array] args arguments for command
+      #   @option [Hash] options run options
+      # @return [Bool] stdout output
       def run(*args)
+        options = (args.last && args.last.kind_of?(Hash)) ? args.pop : {}
         begin
-          escaped_args = Mediakit::Utils::PopenHelper.escape(*args)
-          Mediakit::Utils::PopenHelper.run(bin, escaped_args)
-        rescue Mediakit::Utils::PopenHelper::CommandNotFoundError => e
+          escaped_args = Mediakit::Utils::ProcessRunner.escape(*args)
+          runner = Mediakit::Utils::ProcessRunner.new(options)
+          stdout, stderr, exit_status = runner.run(bin, escaped_args)
+          raise(FailError, stderr) unless exit_status
+          stdout
+        rescue Mediakit::Utils::ProcessRunner::CommandNotFoundError => e
           raise(ConfigurationError, "cant' find bin in #{bin}.")
-        rescue => e
-          raise(DriverError, "#{self.class} catch error with command(#{Mediakit::Utils::PopenHelper.command(bin,escaped_args)}) - #{e.message}, #{e.backtrace.join("\n")}")
         end
       end
 
@@ -46,9 +50,9 @@ module Mediakit
       #   @param args [String] arguments for command
       # @overload run(*args)
       #   @param args [Array] arguments for command
-      # @return result [String] runners to execute
+      # @return [String] command
       def command(*args)
-        escaped_args = Mediakit::Utils::PopenHelper.escape(*args)
+        escaped_args = Mediakit::Utils::ProcessRunner.escape(*args)
         "#{bin} #{escaped_args}"
       end
     end
@@ -58,18 +62,19 @@ module Mediakit
       #
       # @overload run(args)
       #   @param args [String] arguments for command
-      # @overload run(*args)
+      # @overload run(*args, options)
       #   @param args [Array] arguments for command
-      # @return result [Bool] runners result
+      #   @option options [Hash] run options
+      # @return [Bool] stdout output
       def run(args = '')
         begin
           # Force escape args string on here,
           # because this design can't use Cocaine::CommandLine's safety solution.
-          escaped_args = Mediakit::Utils::PopenHelper.escape(args.dup)
+          escaped_args = Mediakit::Utils::ProcessRunner.escape(args.dup)
           command_line = Cocaine::CommandLine.new(bin, escaped_args, swallow_stderr: true)
           command_line.run
-        rescue => e
-          raise(DriverError, "#{self.class} catch error with runners [$ #{command_line.command}] - #{e.message}, #{e.backtrace.join("\n")}")
+        rescue Cocaine::ExitStatusError => e
+          raise(FailError, e.message)
         end
       end
 
@@ -79,7 +84,7 @@ module Mediakit
       #   @param args [String] arguments for command
       # @overload run(*args)
       #   @param args [Array] arguments for command
-      # @return result [String] runners to execute
+      # @return [String] command commands to execute
       def command(args = '')
         Cocaine::CommandLine.new(bin, args).command
       end
@@ -126,12 +131,15 @@ module Mediakit
       end
     end
 
+    # factory class for ffmpeg driver
     class FFmpeg < AbstractFactory
     end
 
+    # factory class for ffprobe driver
     class FFprobe < AbstractFactory
     end
 
+    # factory class for sox driver
     class Sox < AbstractFactory
     end
   end

data/lib/mediakit/ffmpeg/introspection.rb

@@ -0,0 +1,29 @@
+module Mediakit
+  class FFmpeg
+    module Introspection
+      DELIMITER_FOR_CODECS  = "\n -------\n".freeze
+      DELIMITER_FOR_FORMATS = "\n --\n".freeze
+      DELIMITER_FOR_CODER   = "\n ------\n".freeze
+
+      def codecs
+        @codecs ||= run(global_options('codecs')).split(DELIMITER_FOR_CODECS)[1].each_line.to_a
+      end
+
+      def formats
+        @formats ||= run(global_options('formats')).split(DELIMITER_FOR_FORMATS)[1].each_line.to_a
+      end
+
+      def decoders
+        @decoders ||= run(global_options('decoders')).split(DELIMITER_FOR_CODER)[1].each_line.to_a
+      end
+
+      def encoders
+        @encoders ||= run(global_options('encoders')).split(DELIMITER_FOR_CODER)[1].each_line.to_a
+      end
+
+      def global_options(flag)
+        Options.new(Options::GlobalOption.new(flag => true))
+      end
+    end
+  end
+end

data/lib/mediakit/ffmpeg/options.rb

@@ -9,11 +9,10 @@ module Mediakit
     #
     class Options
       attr_reader(:global, :inputs, :output)
-      # constructor
-      #
-      # @option args [Mediakit::FFmpeg::Options::GlobalOption]
-      # @option args [Array<Mediakit::FFmpeg::Options::InputFileOption>] array object Mediakit::FFmpeg::Options::InputOption
-      # @option args [Mediakit::FFmpeg::Options::OutputFileOption]
+
+      # @option [Mediakit::FFmpeg::Options::GlobalOption] args option
+      # @option [Mediakit::FFmpeg::Options::InputFileOption] args Mediakit::FFmpeg::Options::InputOption
+      # @option [Mediakit::FFmpeg::Options::OutputFileOption] args output file option
       def initialize(*args)
         @global, @inputs, @output = nil, [], nil
         args.each do |option|
@@ -61,9 +60,7 @@ module Mediakit
 
       # Base class for Options
       class OrderedHash < ActiveSupport::OrderedHash
-        # initializer
-        #
-        # @param options [Hash] initial option values
+        # @param [Hash] options initial option values
         def initialize(options = {})
           options.each { |key, value| raise_if_invalid_arg_error(key, value) } if options
           self.merge!(options) if options && options.kind_of?(Hash)
@@ -119,8 +116,8 @@ module Mediakit
       end
 
       class InputFileOption < OptionPathPair
-        # @param options [Hash] input options
-        # @param path [String] input file path
+        # @param [Hash] :options input options
+        # @param [String] :path input file path
         def initialize(options:, path:)
           ordered_hash = OrderedHash.new(options)
           super(options: ordered_hash, path: path)
@@ -132,8 +129,8 @@ module Mediakit
       end
 
       class OutputFileOption < OptionPathPair
-        # @param options [Hash] output options
-        # @param path [String] output file path
+        # @param [Hash] :options output options
+        # @param [String] :path output file path
         def initialize(options:, path:)
           ordered_hash = OrderedHash.new(options)
           super(options: ordered_hash, path: path)
@@ -144,23 +141,14 @@ module Mediakit
         end
       end
 
-      class InputFileOptionCollection
-        attr_reader(:input_file_options)
-
-        # @param *input_file_options [Mediakit::FFmpeg::InputFileOptions]
-        def initialize(*input_file_options)
-          @options = input_file_options
-        end
-
-        def empty?
-          @options.empty?
+      class QuoteString
+        def initialize(string)
+          @string = string
         end
 
-        def compose
-          @options.map(&:compose).join(' ')
+        def to_s
+          "\"#{@string}\""
         end
-
-        alias_method :to_s, :compose
       end
 
       # see https://www.ffmpeg.org/ffmpeg.html#Stream-specifiers-1

data/lib/mediakit/ffmpeg.rb

@@ -1,14 +1,12 @@
-require 'mediakit/ffmpeg/options'
 require 'mediakit/drivers'
+require 'mediakit/ffmpeg/options'
+require 'mediakit/ffmpeg/introspection'
 
 module Mediakit
   class FFmpeg
-    class FFmpegError < StandardError;
-    end
+    include Introspection
+    class FFmpegError < StandardError; end
 
-    DELIMITER_FOR_CODECS  = "\n -------\n".freeze
-    DELIMITER_FOR_FORMATS = "\n --\n".freeze
-    DELIMITER_FOR_CODER   = "\n ------\n".freeze
 
     def initialize(driver)
       @driver = driver
@@ -16,7 +14,7 @@ module Mediakit
 
     # execute runners with options object
     #
-    # @param options [Mediakit::Runners::FFmpeg::Options] options object to create CLI argument
+    # @param [Mediakit::Runners::FFmpeg::Options] options options to create CLI argument
     def run(options)
       args = options.compose
       execute(args)
@@ -27,38 +25,10 @@ module Mediakit
       @driver.command(args)
     end
 
-    def codecs
-      @codecs ||= run(global_options('codecs')).split(DELIMITER_FOR_CODECS)[1].each_line.to_a
-    end
-
-    def formats
-      @formats ||= run(global_options('formats')).split(DELIMITER_FOR_FORMATS)[1].each_line.to_a
-    end
-
-    def decoders
-      @decoders ||= run(global_options('decoders')).split(DELIMITER_FOR_CODER)[1].each_line.to_a
-    end
-
-    def encoders
-      @encoders ||= run(global_options('encoders')).split(DELIMITER_FOR_CODER)[1].each_line.to_a
-    end
-
     private
 
     def execute(args = '')
-      begin
-        @driver.run(args)
-      rescue Drivers::DriverError => e
-        raise(FFmpegError, "#catch driver's error - #{e.message}, #{e.backtrace.join("\n")}")
-      end
-    end
-
-    def global_options(flag)
-      Mediakit::FFmpeg::Options.new(
-        Mediakit::FFmpeg::Options::GlobalOptions.new(
-          flag => true,
-        ),
-      )
+      @driver.run(args)
     end
   end
 end

data/lib/mediakit/ffprobe.rb

@@ -10,11 +10,7 @@ module Mediakit
     end
 
     def execute(args = '')
-      begin
-        driver.run(args)
-      rescue => e
-        raise(FFprobeError, "#{self.class} catch error - #{e.message}, #{e.backtrace.join("\n")}")
-      end
+      driver.run(args)
     end
 
     def get_json(path)

data/lib/mediakit/utils/process_runner.rb

@@ -0,0 +1,159 @@
+require 'shellwords'
+require 'open3'
+require 'thread'
+require 'timeout'
+
+
+module Mediakit
+  module Utils
+    class ProcessRunner
+      class CommandNotFoundError < StandardError;
+      end
+      class TimeoutError < StandardError;
+      end
+
+      def initialize(timeout: nil)
+        @timeout = timeout
+      end
+
+      # @overload run(command, *args)
+      #   @param command [String]
+      #   @param args [Array] args as array for safety shellescape
+      # @overload run(command, args)
+      #   @param command [String] command name
+      #   @param args [Array] args as string
+      # @return out [String] stdout of command
+      # @return err [String] stderr of command
+      # @return exit_status [Boolean] is succeeded
+      def run(bin, *args)
+        command = self.class.command(bin, *args)
+
+        pid, out, err, exit_status = nil
+        out_reader, err_reader = nil
+        watch = TimeoutWatch.new(@timeout)
+        begin
+          stdin, stdout, stderr, wait_thr = Open3.popen3(command)
+          stdin.close
+          pid = wait_thr.pid
+          watch.start(Thread.current)
+          out_reader = IOReader.new(stdout) { |chunk| watch.update }
+          err_reader = IOReader.new(stderr) { |chunk| watch.update }
+
+          wait_thr.join
+          exit_status = (wait_thr.value.exitstatus == 0)
+        rescue Errno::ENOENT => e
+          raise(CommandNotFoundError, "Can't find command - #{command}, #{e.meessage}")
+        rescue Timeout::Error => error
+          Process.kill('SIGKILL', pid)
+          raise(error)
+        ensure
+          out_reader.finish
+          err_reader.finish
+          watch.finish
+        end
+
+        [out_reader.data, err_reader.data, exit_status]
+      end
+
+      def self.command(bin, *args)
+        escaped_args = escape(*args)
+        "#{bin} #{escaped_args}"
+      end
+
+      def self.escape(*args)
+        case args.size
+        when 1
+          escape_with_split(args[0])
+        else
+          Shellwords.join(args.map { |x| Shellwords.escape(x) })
+        end
+      end
+
+      private
+
+      def self.escape_with_split(string)
+        splits = Shellwords.split(string)
+        splits = splits.map { |x| Shellwords.escape(x) }
+        splits.join(' ')
+      end
+
+      class IOReader
+        attr_reader(:data)
+
+        def initialize(io, &block)
+          raise(ArgumentError) unless block_given?
+          @io = io
+          @data = ''
+          @block = block
+          start
+        end
+
+        def finish
+          @thread.join
+          @thread.kill
+        end
+
+        private
+        def start
+          @thread = Thread.new { read }
+          nil
+        end
+
+        def read
+          return if @io.closed?
+          begin
+            while chunk = @io.gets
+              @data << chunk
+              @block.call(chunk) if @block
+            end
+          rescue IOError => e
+            warn "[WARN] IOError #{e.message}"
+          ensure
+            @io.close unless @io.closed?
+          end
+        end
+      end
+
+      # watch process progress by io.
+      # when wait time exceed duration, then kill process.
+      class TimeoutWatch
+        attr_reader(:duration)
+
+        def initialize(duration)
+          @duration   = duration
+          @watched_at = Time.now
+          @mutex      = Mutex.new
+        end
+
+        def start(current_thread, &block)
+          @current_thread = current_thread
+          @watch_thread = Thread.new do
+            loop do
+              if timeout?
+                @current_thread.raise(Timeout::Error, "wait timeout error with #{duration} sec.")
+              end
+              sleep(0.1)
+            end
+          end
+          nil
+        end
+
+        def finish
+          @watch_thread.kill
+        end
+
+        def update
+          @mutex.synchronize do
+            @watched_at = Time.now
+          end
+        end
+
+        private
+
+        def timeout?
+          (Time.now - @watched_at) > duration
+        end
+      end
+    end
+  end
+end

data/lib/mediakit/version.rb

@@ -1,3 +1,3 @@
 module Mediakit
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mediakit.gemspec

@@ -24,8 +24,8 @@ EOS
 
   spec.add_runtime_dependency "cocaine", "~> 0.5.7"
   spec.add_runtime_dependency "activesupport", "~> 4"
-  spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry", '~> 0.10'
   spec.add_development_dependency "ruby-debug-ide", "~> 0.4"
+  spec.add_development_dependency "yard", "> 0.8"
 end

data/sample/configure.rb

@@ -0,0 +1,9 @@
+require 'mediakit'
+
+root = File.expand_path(File.join(File.dirname(__FILE__), '../'))
+Mediakit::Drivers::FFmpeg.configure do |config|
+  config.bin_path = File.join(root, 'test/supports/ffmpeg')
+end
+
+driver = Mediakit::Drivers::FFmpeg.new
+puts driver.run('-version')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mediakit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ainame
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: |
   mediakit is the libraries for ffmpeg and sox backed media manipulation something.
   you can create complex manipulation for media as a ruby code.
@@ -113,11 +113,13 @@ files:
 - lib/mediakit.rb
 - lib/mediakit/drivers.rb
 - lib/mediakit/ffmpeg.rb
+- lib/mediakit/ffmpeg/introspection.rb
 - lib/mediakit/ffmpeg/options.rb
 - lib/mediakit/ffprobe.rb
-- lib/mediakit/utils/popen_helper.rb
+- lib/mediakit/utils/process_runner.rb
 - lib/mediakit/version.rb
 - mediakit.gemspec
+- sample/configure.rb
 - sample/raw_crop.rb
 - templates/codec.rb.erb
 - templates/decoder.rb.erb
@@ -142,8 +144,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: mediakit is the libraries for ffmpeg and sox backed media manipulation something.
 test_files: []
+has_rdoc: 

data/lib/mediakit/utils/popen_helper.rb

@@ -1,68 +0,0 @@
-require 'shellwords'
-require 'open3'
-
-module Mediakit
-  module Utils
-    module PopenHelper
-
-      class CommandNotFoundError < StandardError;
-      end
-
-      # @overload run(command, *args)
-      #   @param command [String]
-      #   @param args [Array] args as array for safety shellescape
-      # @overload run(command, args)
-      #   @param command [String] command name
-      #   @param args [Array] args as string
-      # @return out [String] stdout of command
-      # @return err [String] stderr of command
-      # @return exit_status [Boolean] is succeeded
-      def run(bin, *args)
-        command = command(bin, *args)
-
-        out, err, exit_status = nil
-        begin
-          Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
-            stdin.close
-            out         = stdout.read
-            err         = stderr.read
-            exit_status = (wait_thr.value.exitstatus == 0)
-          end
-        rescue Errno::ENOENT => e
-          raise(CommandNotFoundError, "Can't find command - #{command}, #{e.meessage}")
-        end
-
-        [out, err, exit_status]
-      end
-
-      module_function(:run)
-
-      def command(bin, *args)
-        escaped_args = escape(*args)
-        "#{bin} #{escaped_args}"
-      end
-
-      module_function(:command)
-
-      def escape(*args)
-        case args.size
-        when 1
-          _escape_with_split(args[0])
-        else
-          Shellwords.join(args.map { |x| Shellwords.escape(x) })
-        end
-      end
-
-      module_function(:escape)
-
-      def _escape_with_split(string)
-        splits = Shellwords.split(string)
-        splits = splits.map { |x| Shellwords.escape(x) }
-        splits.join(' ')
-      end
-
-      module_function(:_escape_with_split)
-
-    end
-  end
-end