ffmprb 0.6.9 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c63aad2be1497ee10ff566dafaa5a76f7e8cc87
-  data.tar.gz: 0b6b1f15cd314f7b51fc7dbddb3b9c37f47dcdfe
+  metadata.gz: 0f8aefe1bb66a17ba85e93faf30b2ac540badee5
+  data.tar.gz: e3260e027699ad813154fc24c64049f42b39c114
 SHA512:
-  metadata.gz: 183ba570ca74223f6f5974a969ff9f2bd74fe5a8a099e34b429901773d76d7757d8c58fb8666d9444abedc5539d978b98ef22fa1c534bb9b7ba43a14665a9701
-  data.tar.gz: a9be63b31513b789f454931b0514c3b7601e01ac38ba71ee4a596cd82cab7b99b3547439303aace34595235e69b719550d3361830431d8091bb5df922a3c6e2b
+  metadata.gz: 430d988b9a2c68dbdbbe7d75f1e20d3e9c2a92c2f0f905b8c461005d5667a522e9830b1fba2f88a339b131b285765401fdc6bfdc15cd1088295a017f6859f62c
+  data.tar.gz: 0675dcaeabd664f44e497f72f96860437171661cae6250b223a9610105206e139c38f2b5b04a49fffd09ff0b886039d4754a47f27a31d32322418ce3e754ae4f

data/circle.yml

@@ -0,0 +1,3 @@
+dependencies:
+  pre:
+    - sudo apt-add-repository -y ppa:oded-geek/multimedia; sudo apt-get update; sudo apt-get install ffmpeg

data/exe/ffmprb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rubygems'
+  gem 'ffmprb'
+rescue LoadError
+end
+
+require 'ffmprb'
+
+Ffmprb.execute

data/lib/ffmprb/execution.rb

@@ -0,0 +1,23 @@
+module Ffmprb
+
+  class Execution
+
+    def initialize(*params, script:)
+      @params = params
+      @script = eval("lambda{#{script}}")
+    end
+
+    def run
+      Ffmprb.process *@params, &@script
+    end
+
+  end
+
+  def self.execute
+    return STDERR.puts "Usage: (not quite usual) $ ffmprb streams... < script.ffmprb"  unless
+      ARGV.length > 1 && ARGV.grep(/^-/).empty?
+
+    Execution.new(*ARGV, script: STDIN.read).run
+  end
+
+end

data/lib/ffmprb/file.rb

@@ -13,16 +13,9 @@ module Ffmprb
         output_fifo_file = temp_fifo(extname)
 
         Ffmprb.logger.debug "Opening #{input_fifo_file.path}>#{output_fifo_file.path} for buffering"
-        buff = Util::IoBuffer.new(
-          ->{
-            Ffmprb.logger.debug "Trying to open #{input_fifo_file.path} for reading+buffering"
-            ::File.open(input_fifo_file.path, 'r')
-          },
-          ->{
-            Ffmprb.logger.debug "Trying to open #{output_fifo_file.path} for buffering+writing"
-            ::File.open(output_fifo_file.path, 'w')
-            }
-          )
+        buff = Util::IoBuffer.new(async_opener(input_fifo_file, 'r'), async_opener(output_fifo_file, 'w'))
+
+        # NOTE the blocking cleanup thread to join for synchronisation
         thr = Util::Thread.new do
           buff.flush!
           Ffmprb.logger.debug "IoBuffering from #{input_fifo_file.path} to #{output_fifo_file.path} ended"
@@ -31,7 +24,7 @@ module Ffmprb
         end
         Ffmprb.logger.debug "IoBuffering from #{input_fifo_file.path} to #{output_fifo_file.path} started"
 
-        yield buff  if block_given?  # XXX a hidden option
+        # XXX see io_buffer's XXX yield buff  if block_given?
 
         OpenStruct.new in: input_fifo_file, out: output_fifo_file, thr: thr
       end
@@ -83,6 +76,15 @@ module Ffmprb
         ::File.join Dir.tmpdir, Dir::Tmpname.make_tmpname('', 'p' + extname)
       end
 
+      protected
+
+      def async_opener(file, mode)
+        ->{
+          Ffmprb.logger.debug "Trying to open #{file.path} for #{mode}-buffering"
+          ::File.open(file.path, mode)
+        }
+      end
+
     end
 
 
@@ -100,15 +102,35 @@ module Ffmprb
 
     # Info
 
+    def exist?
+      ::File.exist? path
+    end
+
     def extname
       ::File.extname path
     end
 
+    def channel?(medium)
+      case medium
+      when :video
+        image_extname? || movie_extname?
+      when :audio
+        sound_extname? || movie_extname?
+      end
+    end
+
     def length
-      @duration ||= probe['format']['duration']
-      return @duration.to_f  if @duration
+      return @duration  if @duration
+
+      # NOTE first attempt
+      @duration = probe['format']['duration']
+      @duration &&= @duration.to_f
+      return @duration  if @duration
 
-      @duration = probe(true)['frames'].reduce(0){|sum, frame| sum + frame['pkt_duration_time'].to_f}
+      # NOTE a harder try
+      @duration = probe(true)['frames'].reduce(0) do |sum, frame|
+        sum + frame['pkt_duration_time'].to_f
+      end
     end
 
     def resolution
@@ -127,9 +149,9 @@ module Ffmprb
 
       Ffmprb.logger.debug "Snap shooting files, video path: #{video ? video.path : 'NONE'}, audio path: #{audio ? audio.path : 'NONE'}"
 
-      raise Error, "Incorrect output extname (must be .jpg)"  unless !video || video.extname =~ /jpe?g$/
-      raise Error, "Incorrect audio extname (must be .mp3)"  unless !audio || audio.extname =~ /mp3$/
-      raise Error, "Can sample either video OR audio UNLESS a block is given"  unless block_given? || (!!audio != !!video)
+      raise Error, "Incorrect output extname (must be .jpg)"  unless !video || video.channel?(:video) && !video.channel?(:audio)
+      raise Error, "Incorrect audio extname (must be .mp3)"  unless !audio || audio.channel?(:audio) && !audio.channel?(:video)
+      raise Error, "Can sample either video OR audio UNLESS a block is given"  unless block_given? || !!audio != !!video
 
       cmd = ['-i', path]
       cmd += ['-deinterlace', '-an', '-ss', at, '-r', 1, '-vcodec', 'mjpeg', '-f', 'mjpeg', video.path]  if video
@@ -153,6 +175,13 @@ module Ffmprb
 
     # Manipulation
 
+    def read
+      ::File.read path
+    end
+    def write(s)
+      ::File.write path, s
+    end
+
     def remove
       FileUtils.remove_entry path
       Ffmprb.logger.debug "Removed file with path: #{path}"
@@ -170,15 +199,27 @@ module Ffmprb
       end
     end
 
-    def probe(force=false)
-      return @probe  unless !@probe || force
+    def probe(harder=false)
+      return @probe  unless !@probe || harder
       cmd = ['-v', 'quiet', '-i', path, '-print_format', 'json', '-show_format', '-show_streams']
-      cmd << '-show_frames'  if force
+      cmd << '-show_frames'  if harder
       @probe = JSON.parse(Util::ffprobe *cmd).tap do |probe|
         raise Error, "This doesn't look like a ffprobable file"  unless probe['streams']
       end
     end
 
+    def image_extname?
+      extname =~ /^\.(jpe?g|y4m)$/i
+    end
+
+    def sound_extname?
+      extname =~ /^\.(mp3|wav)$/i
+    end
+
+    def movie_extname?
+      extname =~ /^\.(mp4|flv)$/i
+    end
+
   end
 
 end

data/lib/ffmprb/filter.rb

@@ -18,8 +18,7 @@ module Ffmprb
         inout "afade=out:d=#{duration}", input, output
       end
 
-      # NOTE inputs order matters
-      def amix(inputs, output=nil)
+      def amix_to_first(inputs, output=nil)
         inout "amix=#{[*inputs].length}:duration=first", inputs, output
       end
 
@@ -169,7 +168,7 @@ module Ffmprb
           filters.concat [
             *afade_out(blend_duration, "#{inputs.first}:a", "#{aux_lbl}:a"),
             *afade_in(blend_duration, "#{inputs.last}:a", "#{auxx_lbl}:a"),
-            *amix(["#{auxx_lbl}:a", "#{aux_lbl}:a"], "#{output}:a")
+            *amix_to_first(["#{auxx_lbl}:a", "#{aux_lbl}:a"], "#{output}:a")
           ]  if audio
         end
       end
@@ -182,8 +181,9 @@ module Ffmprb
         inout "volume='#{volume_exp volume}':eval=frame", input, output
       end
 
-      def volume_exp(volume)  # NOTE volume is an ordered Hash
-        return volume  unless volume.respond_to?(:each)
+      def volume_exp(volume)
+        return volume  unless volume.is_a?(Hash)
+
         raise Error, "volume cannot be empty"  if volume.empty?
 
         prev_at = 0.0

data/lib/ffmprb/find_silence.rb

@@ -0,0 +1,29 @@
+module Ffmprb
+
+  def self.find_silence(input_file, output_file)
+    logger.debug "Finding silence (#{input_file.path}->#{output_file.path})"
+    filters = Filter.silencedetect
+    options = ['-i', input_file.path, *Filter.complex_options(filters), output_file.path]
+    silence = []
+    Util.ffmpeg(*options).split("\n").each do |line|
+      next  unless line =~ /^\[silencedetect\s.*\]\s*silence_(\w+):\s*(\d+\.?d*)/
+      case $1
+      when 'start'
+        silence << OpenStruct.new(start_at: $2.to_f)
+      when 'end'
+        if silence.empty?
+          silence << OpenStruct.new(start_at: 0.0, end_at: $2.to_f)
+        else
+          raise Error, "ffmpeg is being stupid: silence_end with no silence_start"  if silence.last.end_at
+          silence.last.end_at = $2.to_f
+        end
+      else
+        Ffmprb.warn "Unknown silence mark: #{$1}"
+      end
+    end
+
+    logger.debug "Found silence (#{input_file.path}->#{output_file.path}): [#{silence.map{|t,v| "#{t}: #{v}"}}]"
+    silence
+  end
+
+end

data/lib/ffmprb/process/input.rb

@@ -105,12 +105,11 @@ module Ffmprb
 
 
       def initialize(io, only: nil)
-        @io = io
+        @io = resolve(io)
         @channels = [*only]
         @channels = nil  if @channels.empty?
         raise Error, "Inadequate A/V channels"  if
-          @io.respond_to?(:channel?) &&
-            [:video, :audio].any?{|medium| !@io.channel?(medium) && channel?(medium, true)}
+          [:video, :audio].any?{|medium| !@io.channel?(medium) && channel?(medium, true)}
       end
 
       def options
@@ -121,7 +120,7 @@ module Ffmprb
 
         # Channelling
 
-        if @io.respond_to?(:filters_for)  # NOTE assuming @io.respond_to?(:channel?)
+        if @io.respond_to?(:filters_for)
           lbl_aux = "au#{lbl}"
           @io.filters_for(lbl_aux, process: process, video: video, audio: audio) +
             [
@@ -136,8 +135,8 @@ module Ffmprb
           in_lbl = process[self]
           raise Error, "Data corruption"  unless in_lbl
           [
-            *(video && channel?(:video)? Filter.copy("#{in_lbl}:v", "#{lbl}:v"): nil),
-            *(audio && channel?(:audio)? Filter.anull("#{in_lbl}:a", "#{lbl}:a"): nil)
+            *(video && @io.channel?(:video) && channel?(:video)? Filter.copy("#{in_lbl}:v", "#{lbl}:v"): nil),
+            *(audio && @io.channel?(:audio) && channel?(:audio)? Filter.anull("#{in_lbl}:a", "#{lbl}:a"): nil)
           ]
         end
       end
@@ -162,13 +161,23 @@ module Ffmprb
         Loud.new self, volume: vol
       end
 
-      # XXX? protected
-
       def channel?(medium, force=false)
-        return @channels && @channels.include?(medium)  if force
+        return !!@channels && @channels.include?(medium) && @io.channel?(medium)  if force
+
+        (!@channels || @channels.include?(medium)) && @io.channel?(medium)
+      end
+
+      protected
 
-        (!@channels || @channels.include?(medium)) &&
-          (!@io.respond_to?(:channel?) || @io.channel?(medium))
+      def resolve(io)
+        return io  unless io.is_a? String
+
+        case io
+        when /^\/\w/
+          File.open io
+        else
+          raise Error, "Cannot resolve input: #{io}"
+        end
       end
 
     end

data/lib/ffmprb/process/output.rb

@@ -5,13 +5,15 @@ module Ffmprb
     class Output
 
       def initialize(io, only: nil, resolution: Ffmprb::QVGA, fps: 30)
-        @io = io
+        @io = resolve(io)
         @channels = [*only]
         @channels = nil  if @channels.empty?
         @resolution = resolution
         @fps = 30
       end
 
+      # XXX This method is exceptionally long at the moment. This is not too grand.
+      # However, structuring the code should be undertaken with care, as not to harm the composition clarity.
       def options(process)
         # XXX TODO manage stream labels through process
         raise Error, "Nothing to roll..."  if @reels.select(&:reel).empty?
@@ -21,7 +23,6 @@ module Ffmprb
 
         # Concatting
         segments = []
-        Ffmprb.logger.debug "Concatting segments: start"
 
         @reels.each_with_index do |curr_reel, i|
 
@@ -55,7 +56,6 @@ module Ffmprb
             # NOTE make sure previous reel rolls _long_ enough AND then _just_ enough
 
             prev_lbl = segments.pop
-            Ffmprb.logger.debug "Concatting segments: #{prev_lbl} popped"
 
             lbl_pad = "bl#{prev_lbl}#{i}"
             # NOTE generously padding the previous segment to support for all the cases
@@ -141,7 +141,6 @@ module Ffmprb
           end
 
           segments << lbl  # NOTE can be nil
-          Ffmprb.logger.debug "Concatting segments: #{lbl} pushed"
         end
 
         segments.compact!
@@ -174,7 +173,7 @@ module Ffmprb
             filters +=
               Filter.copy("#{lbl_out}:v", "#{lbl_nxt}:v")  if channel?(:video)
             filters +=
-              Filter.amix(["#{lbl_out}:a", "#{lbl_over}:a"], "#{lbl_nxt}:a")  if channel?(:audio)
+              Filter.amix_to_first(["#{lbl_out}:a", "#{lbl_over}:a"], "#{lbl_nxt}:a")  if channel?(:audio)
 
             lbl_out = lbl_nxt
           end
@@ -281,15 +280,28 @@ module Ffmprb
         add_reel reel, after, transition, (onto == :full_screen)
       end
 
-      # XXX? protected
-
       def channel?(medium, force=false)
-        return @channels && @channels.include?(medium)  if force
+        return !!@channels && @channels.include?(medium) && @io.channel?(medium)  if force
 
-        (!@channels || @channels.include?(medium)) &&
+        (!@channels || @channels.include?(medium)) && @io.channel?(medium) &&
           reels_channel?(medium)
       end
 
+      protected
+
+      def resolve(io)
+        return io  unless io.is_a? String
+
+        case io
+        when /^\/\w/
+          File.create(io).tap do |file|
+            Ffmprb.logger.warn "Output file exists (#{file.path}), will overwrite"  if file.exist?
+          end
+        else
+          raise Error, "Cannot resolve output: #{io}"
+        end
+      end
+
       private
 
       def reels_channel?(medium)

data/lib/ffmprb/util/io_buffer.rb

@@ -70,6 +70,8 @@ module Ffmprb
             while s = @q.deq
               next  if broken
               written = 0
+              tries = 1
+              logged_tries = 1/2
               while !broken
                 raise @terminate  if @terminate.kind_of?(Exception)
                 begin
@@ -77,15 +79,17 @@ module Ffmprb
                   written = output.write_nonblock(s)  if output  # NOTE will only be nil if @terminate is an exception
                   break  if written == s.length  # NOTE kinda optimisation
                   s = s[written..-1]
-                rescue Errno::EAGAIN
-                  Ffmprb.logger.debug "IoBuffer writer (to #{output.path}) retrying"
-                  sleep 0.01
-                rescue Errno::EWOULDBLOCK
-                  Ffmprb.logger.debug "IoBuffer writer (to #{output.path}) taking a break"
+                rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+                  if tries == 2 * logged_tries
+                    Ffmprb.logger.debug "IoBuffer writer (to #{output.path}) retrying... (#{tries} writes): #{$!.class}"
+                    logged_tries = tries
+                  end
                   sleep 0.01
                 rescue Errno::EPIPE
                   broken = true
                   Ffmprb.logger.debug "IoBuffer writer (to #{output.path}) broken"
+                ensure
+                  tries += 1
                 end
               end
             end
@@ -187,14 +191,21 @@ module Ffmprb
 
         @output_thr = Util::Thread.new("buffer writer output helper") do
           Ffmprb.logger.debug "Opening buffer output"
+          tries = 1
+          logged_tries = 1/2
           begin
             Timeout::timeout(self.class.timeout/2) do
               @output = @output.call
               Ffmprb.logger.debug "Opened buffer output: #{@output.path}"
             end
           rescue Timeout::Error
-            Ffmprb.logger.info "A little bit of timeout in the buffer writer helper thread"
+            if tries == 2 * logged_tries
+              Ffmprb.logger.info "A little bit of timeout in the buffer writer helper thread (##{tries})"
+              logged_tries = tries
+            end
             retry  unless @terminate.kind_of?(Exception)
+          ensure
+            tries += 1
           end
         end
       end

data/lib/ffmprb/util.rb

@@ -13,12 +13,12 @@ module Ffmprb
       attr_accessor :ffmpeg_cmd, :ffprobe_cmd
 
       def ffprobe(*args)
-        sh ffprobe_cmd, *args
+        sh *ffprobe_cmd, *args
       end
 
       def ffmpeg(*args)
         args = ['-loglevel', 'debug'] + args  if Ffmprb.debug
-        sh ffmpeg_cmd, '-y', *args, output: :stderr
+        sh *ffmpeg_cmd, '-y', *args, output: :stderr
       end
 
       def sh(*cmd, output: :stdout, log: :stderr)

data/lib/ffmprb/version.rb

@@ -1,3 +1,3 @@
 module Ffmprb
-  VERSION = "0.6.9"
+  VERSION = "0.7.0"
 end

data/lib/ffmprb.rb

@@ -1,12 +1,12 @@
+require 'ffmprb/execution'
 require 'ffmprb/file'
 require 'ffmprb/filter'
+require 'ffmprb/find_silence'
 require 'ffmprb/process'
 require 'ffmprb/util'
 require 'ffmprb/version'
 
 require 'logger'
-require 'time'
-require 'timeout'
 
 module Ffmprb
 
@@ -19,8 +19,8 @@ module Ffmprb
   class Error < StandardError
   end
 
-  Util.ffmpeg_cmd = 'ffmpeg'
-  Util.ffprobe_cmd = 'ffprobe'
+  Util.ffmpeg_cmd = ['ffmpeg']
+  Util.ffprobe_cmd = ['ffprobe']
 
   Process.duck_audio_hi = 0.9
   Process.duck_audio_lo = 0.1
@@ -34,14 +34,18 @@ module Ffmprb
 
   class << self
 
+    # NOTE the form with the block returns the result of #run
+    # NOTE the form without the block returns the process (before it is run)
     def process(*args, &blk)
       logger.debug "Starting process with #{args} in #{blk.source_location}"
-      Process.new.tap do |process|
-        if blk
-          process.instance_exec *args, &blk
-          process.run
-          logger.debug "Finished process with #{args} in #{blk.source_location}"
-        end
+      process = Process.new
+      return process  unless blk
+
+      process.instance_exec *args, &blk
+      logger.debug "Initialized process with #{args} in #{blk.source_location}"
+
+      process.run.tap do
+        logger.debug "Finished process with #{args} in #{blk.source_location}"
       end
     end
     alias :action! :process  # ;)
@@ -59,32 +63,6 @@ module Ffmprb
       @logger = logger
     end
 
-    def find_silence(input_file, output_file)
-      logger.debug "Finding silence (#{input_file.path}->#{output_file.path})"
-      filters = Filter.silencedetect
-      options = ['-i', input_file.path, *Filter.complex_options(filters), output_file.path]
-      silence = []
-      Util.ffmpeg(*options).split("\n").each do |line|
-        next  unless line =~ /^\[silencedetect\s.*\]\s*silence_(\w+):\s*(\d+\.?d*)/
-        case $1
-        when 'start'
-          silence << OpenStruct.new(start_at: $2.to_f)
-        when 'end'
-          if silence.empty?
-            silence << OpenStruct.new(start_at: 0.0, end_at: $2.to_f)
-          else
-            raise Error, "ffmpeg is being stupid: silence_end with no silence_start"  if silence.last.end_at
-            silence.last.end_at = $2.to_f
-          end
-        else
-          Ffmprb.warn "Unknown silence mark: #{$1}"
-        end
-      end
-
-      logger.debug "Found silence (#{input_file.path}->#{output_file.path}): [#{silence.map{|t,v| "#{t}: #{v}"}}]"
-      silence
-    end
-
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffmprb
 version: !ruby/object:Gem::Version
-  version: 0.6.9
+  version: 0.7.0
 platform: ruby
 authors:
 - showbox.com
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-26 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mkfifo
@@ -126,7 +126,8 @@ dependencies:
 description: A DSL (Damn-Simple Language) and a micro-engine for ffmpeg and ffriends
 email:
 - costa@showbox.com
-executables: []
+executables:
+- ffmprb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -143,10 +144,14 @@ files:
 - bin/rake
 - bin/rspec
 - bin/setup
+- circle.yml
+- exe/ffmprb
 - ffmprb.gemspec
 - lib/ffmprb.rb
+- lib/ffmprb/execution.rb
 - lib/ffmprb/file.rb
 - lib/ffmprb/filter.rb
+- lib/ffmprb/find_silence.rb
 - lib/ffmprb/process.rb
 - lib/ffmprb/process/input.rb
 - lib/ffmprb/process/output.rb