ffmprb 0.11.3 → 0.11.4

data/ffmprb.gemspec

@@ -6,14 +6,43 @@ require 'ffmprb/version'
 Gem::Specification.new do |spec|
   spec.name          = 'ffmprb'
   spec.version       = Ffmprb::VERSION
-  spec.authors       = ["showbox.com", "Costa Shapiro"]
+  spec.authors       = ["Costa Shapiro"]
   spec.email         = ['costa@mouldwarp.com']
 
-  spec.summary       = "ffmprb is your audio/video montage friend, based on https://ffmpeg.org"
+  spec.summary       = "ffmprb is your audio/video manipulation pal, based on https://ffmpeg.org"
   spec.description   = "A video and audio composing DSL (Damn-Simple Language) and a micro-engine for ffmpeg and ffriends"
   spec.homepage      = Ffmprb::GEM_GITHUB_URL
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  def self.ignore_match(pattern, path)
+    path = '/' + path  unless path =~ %r'^/'
+    if File.directory?(path)
+      path += '/'  unless path =~ %r'/$'
+    end
+    if pattern.is_a?(Array)
+      pattern
+    else
+      [pattern]
+    end.any? do |pattern|
+      pattern = '**/' + pattern  unless pattern =~ %r'^/'
+      pattern += '**'  if pattern =~ %r'/$'
+      File.fnmatch(pattern, path)
+    end
+  end
+
+  pattern =
+    if (ignore_pattern_lines = File.readlines('.gemignore') rescue nil)
+      ignore_pattern_lines.map do |line|
+        stripped = line.split(/(?<!\\)#/)[0].strip
+        stripped  unless stripped.empty?
+      end.compact
+    else
+      %w[test/ spec/ features/]
+    end
+
+  # NOTE dotfiles are ignored by .glob
+  spec.files = Dir['**/*'].reject{|path| ignore_match pattern, path}
+  # TODO:rm spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -23,15 +52,6 @@ Gem::Specification.new do |spec|
   # NOTE make it into an optional dependency? Nah for now
   spec.add_dependency 'thor', '~> 0.19.1'
 
-  spec.add_development_dependency 'bundler', '>= 1.11.2'
-  spec.add_development_dependency 'byebug', '>= 8.2.4'
-  spec.add_development_dependency 'simplecov', '>= 0.11.2'
-  spec.add_development_dependency 'guard-rspec', '>= 4.6.5'
-  spec.add_development_dependency 'guard-bundler', '>= 2.1.0'
-  spec.add_development_dependency 'rake', '>= 11.1.2'
-  spec.add_development_dependency 'rmagick', '>= 2.15.4'
-  spec.add_development_dependency 'ruby-sox', '>= 0.0.3'
-  spec.add_development_dependency 'firebase', '>= 0.2.6'
-
-  spec.post_install_message = "Have fun with your montage! To enable proc visualisation, install firebase gem and set FFMPRB_PROC_VIS_FIREBASE env."  unless Ffmprb::FIREBASE_AVAILABLE
+  spec.post_install_message = "Have fun with your a/v! To enable proc visualisation, install firebase gem and set FFMPRB_PROC_VIS_FIREBASE env."  unless
+    Ffmprb::FIREBASE_AVAILABLE
 end

data/lib/defaults.rb

@@ -19,7 +19,7 @@ module Ffmprb
   Process.input_video_fps = nil  # NOTE the documented ffmpeg default is 25
 
   Process.output_video_resolution = CGA
-  Process.output_video_fps = 16
+  Process.output_video_fps = 16  # NOTE the documented ffmpeg default is 25
   Process.output_audio_encoder = 'libmp3lame'
   Process.output_audio_sampling_freq = nil  # NOTE Use ffmpeg default by default, specify otherwise e.g. 44100
 

data/lib/ffmprb.rb

@@ -25,13 +25,13 @@ module Ffmprb
       name ||=  blk.source_location.map(&:to_s).map{ |s| ::File.basename s.to_s, ::File.extname(s) }.join(':')
       process = Process.new(name: name, **opts)
       proc_vis_node process  if respond_to? :proc_vis_node  # XXX simply include the ProcVis if it makes into a gem
-      logger.debug "Starting process with #{args} #{opts} in #{blk.source_location}"
+      logger.debug{"Starting process with #{args} #{opts} in #{blk.source_location}"}
 
       process.instance_exec *args, &blk
-      logger.debug "Initialized process with #{args} #{opts} in #{blk.source_location}"
+      logger.debug{"Initialized process with #{args} #{opts} in #{blk.source_location}"}
 
       process.run.tap do
-        logger.debug "Finished process with #{args} #{opts} in #{blk.source_location}"
+        logger.debug{"Finished process with #{args} #{opts} in #{blk.source_location}"}
       end
     end
     alias :action! :process  # ;)

data/lib/ffmprb/file.rb

@@ -17,27 +17,27 @@ module Ffmprb
         ->{
           path = file.respond_to?(:path)? file.path : file
           mode ||= file.respond_to?(mode)? file.mode.to_s[0] : 'r'
-          Ffmprb.logger.debug "Trying to open #{path} (for #{mode}-buffering or something)"
+          Ffmprb.logger.debug{"Trying to open #{path} (for #{mode}-buffering or something)"}
           ::File.open(path, mode)
         }
       end
 
       def create(path)
         new(path: path, mode: :write).tap do |file|
-          Ffmprb.logger.debug "Created file with path: #{file.path}"
+          Ffmprb.logger.debug{"Created file with path: #{file.path}"}
         end
       end
 
       def open(path)
         new(path: path, mode: :read).tap do |file|
-          Ffmprb.logger.debug "Opened file with path: #{file.path}"
+          Ffmprb.logger.debug{"Opened file with path: #{file.path}"}
         end
       end
 
       def temp(extname)
         file = create(Tempfile.new(['', extname]))
         path = file.path
-        Ffmprb.logger.debug "Created temp file with path: #{path}"
+        Ffmprb.logger.debug{"Created temp file with path: #{path}"}
 
         return file  unless block_given?
 
@@ -49,7 +49,7 @@ module Ffmprb
           rescue
             Ffmprb.logger.warn "#{$!.class.name} removing temp file with path #{path}: #{$!.message}"
           end
-          Ffmprb.logger.debug "Removed temp file with path: #{path}"
+          Ffmprb.logger.debug{"Removed temp file with path: #{path}"}
         end
       end
 
@@ -69,12 +69,12 @@ module Ffmprb
           rescue
             Ffmprb.logger.warn "#{$!.class.name} removing temp file with path #{path}: #{$!.message}"
           end
-          Ffmprb.logger.debug "Removed temp file with path: #{path}"
+          Ffmprb.logger.debug{"Removed temp file with path: #{path}"}
         end
       end
 
       def temp_fifo_path(extname)
-        ::File.join Dir.tmpdir, Dir::Tmpname.make_tmpname('', 'p' + extname)
+        ::File.join Dir.tmpdir, "#{rand(2**222)}p#{extname}"
       end
 
       def image?(extname)
@@ -168,7 +168,7 @@ module Ffmprb
       else
         FileUtils.remove_entry path
       end
-      Ffmprb.logger.debug "Removed file with path: #{path}"
+      Ffmprb.logger.debug{"Removed file with path: #{path}"}
       @path = nil
     end
 

data/lib/ffmprb/file/sample.rb

@@ -11,7 +11,7 @@ module Ffmprb
       audio = File.temp('.wav')  if audio == true
       video = File.temp('.png')  if video == true
 
-      Ffmprb.logger.debug "Snap shooting files, video path: #{video ? video.path : 'NONE'}, audio path: #{audio ? audio.path : 'NONE'}"
+      Ffmprb.logger.debug{"Snap shooting files, video path: #{video ? video.path : 'NONE'}, audio path: #{audio ? audio.path : 'NONE'}"}
 
       fail Error, "Incorrect output extname (must be image)"  unless !video || video.channel?(:video) && !video.channel?(:audio)
       fail Error, "Incorrect audio extname (must be sound)"  unless !audio || audio.channel?(:audio) && !audio.channel?(:video)
@@ -30,7 +30,7 @@ module Ffmprb
         begin
           video.unlink  if video
           audio.unlink  if audio
-          Ffmprb.logger.debug "Removed sample files"
+          Ffmprb.logger.debug{"Removed sample files"}
         rescue
           Ffmprb.logger.warn "#{$!.class.name} removing sample files: #{$!.message}"
         end

data/lib/ffmprb/file/threaded_buffered.rb

@@ -7,7 +7,7 @@ module Ffmprb
       def threaded_buffered_fifo(extname='.tmp', reader_open_on_writer_idle_limit: nil, proc_vis: nil)
         input_fifo_file = temp_fifo(extname)
         output_fifo_file = temp_fifo(extname)
-        Ffmprb.logger.debug "Opening #{input_fifo_file.path}>#{output_fifo_file.path} for buffering"
+        Ffmprb.logger.debug{"Opening #{input_fifo_file.path}>#{output_fifo_file.path} for buffering"}
         Util::Thread.new do
           begin
             io_buff = Util::ThreadedIoBuffer.new(opener(input_fifo_file, 'r'), opener(output_fifo_file, 'w'), keep_outputs_open_on_input_idle_limit: reader_open_on_writer_idle_limit)
@@ -20,13 +20,13 @@ module Ffmprb
             ensure
               Util::Thread.join_children!
             end
-            Ffmprb.logger.debug "IoBuffering from #{input_fifo_file.path} to #{output_fifo_file.path} ended"
+            Ffmprb.logger.debug{"IoBuffering from #{input_fifo_file.path} to #{output_fifo_file.path} ended"}
           ensure
             input_fifo_file.unlink  if input_fifo_file
             output_fifo_file.unlink  if output_fifo_file
           end
         end
-        Ffmprb.logger.debug "IoBuffering from #{input_fifo_file.path} to #{output_fifo_file.path} started"
+        Ffmprb.logger.debug{"IoBuffering from #{input_fifo_file.path} to #{output_fifo_file.path} started"}
 
         [input_fifo_file, output_fifo_file]
       end

data/lib/ffmprb/filter.rb

@@ -262,7 +262,10 @@ module Ffmprb
       end
 
       def complex_args(*filters)
-        ['-filter_complex', filters.join('; ')]  unless filters.empty?
+        [].tap do |args|
+          args << '-filter_complex' << filters.join('; ') unless
+            filters.empty?
+        end
       end
 
       private

data/lib/ffmprb/find_silence.rb

@@ -5,7 +5,7 @@ module Ffmprb
     # NOTE not for streaming just yet
     def find_silence(input_file, output_file)
       path = "#{input_file.path}->#{output_file.path}"
-      logger.debug "Finding silence (#{path})"
+      logger.debug{"Finding silence (#{path})"}
       silence = []
       Util.ffmpeg('-i', input_file.path, *find_silence_detect_args, output_file.path).
         scan(SILENCE_DETECT_REGEX).each do |mark, time|
@@ -25,7 +25,10 @@ module Ffmprb
           Ffmprb.warn "Unknown silence mark: #{mark}"
         end
       end
-      logger.debug "Found silence (#{path}): [#{silence.map{|t,v| "#{t}: #{v}"}}]"
+      logger.debug{
+        silence_map = silence.map{|t,v| "#{t}: #{v}"}
+        "Found silence (#{path}): [#{silence_map}]"
+      }
       silence
     end
 

data/lib/ffmprb/process.rb

@@ -39,7 +39,7 @@ module Ffmprb
       def input_video_options
         {
           auto_rotate: input_video_auto_rotate,
-          fps: input_video_fps
+          fps: input_video_fps  # TODO seen failing on apng (w/ffmpeg v4.x)
         }
       end
       def input_audio_options
@@ -97,7 +97,10 @@ module Ffmprb
             end
             overlay in_over.volume ducked_overlay_volume
 
-            Ffmprb.logger.debug "Ducking audio with volumes: {#{ducked_overlay_volume.map{|t,v| "#{t}: #{v}"}.join ', '}}"
+            Ffmprb.logger.debug{
+              ducked_overlay_volume_map = ducked_overlay_volume.map{|t,v| "#{t}: #{v}"}
+              "Ducking audio with volumes: {#{ducked_overlay_volume_map.join ', '}}"
+            }
           end
 
         end
@@ -157,7 +160,6 @@ module Ffmprb
       thr = Util::Thread.new main: !parent do
         proc_vis_node Thread.current
         # NOTE yes, an exception can occur anytime, and we'll just die, it's ok, see above
-        # XXX just to return something -- no apparent practical use
         cmd = command
         opts = {limit: limit, timeout: timeout}
         opts[:ignore_broken_pipes] = ignore_broken_pipes  unless ignore_broken_pipes.nil?

data/lib/ffmprb/process/input.rb

@@ -14,7 +14,7 @@ module Ffmprb
           end
         end
 
-        # XXX check for unknown options
+        # TODO! check for unknown options
 
         def video_args(video=nil)
           video = Process.input_video_options.merge(video.to_h)

data/lib/ffmprb/process/input/looping.rb

@@ -60,7 +60,7 @@ module Ffmprb
             end
           end
           cpy_io = File.temp_fifo(src_io.extname)
-          Ffmprb.logger.debug "(L2) Temporising the raw input (#{src_io.path}) and creating copy (#{cpy_io.path})"
+          Ffmprb.logger.debug{"(L2) Temporising the raw input (#{src_io.path}) and creating copy (#{cpy_io.path})"}
 
           src_io.threaded_buffered_copy_to @raw.io, cpy_io
 
@@ -70,9 +70,8 @@ module Ffmprb
           @raw.process.proc_vis_node dst_io
 
           Util::Thread.new "looping input processor" do
-            # Ffmprb.logger.debug "Processing before looping"
+            Ffmprb.logger.debug{"(L3) Pre-processing into (#{dst_io.path})"}
 
-            Ffmprb.logger.debug "(L3) Pre-processing into (#{dst_io.path})"
             Ffmprb.process @_unfiltered, parent: @raw.process do |unfiltered|  # TODO limit:
 
               inp = input(cpy_io)
@@ -83,10 +82,8 @@ module Ffmprb
             end
           end
 
-          # Ffmprb.logger.debug "Preprocessed (from #{src_io.path}) looping input: #{dst_io.path}, output: #{io.io.path}, and raw input copy will go through #{buff_raw_io.path} to #{@raw.io.path}..."
-
           buff_ios = (1..times).map{File.temp_fifo intermediate_extname}
-          Ffmprb.logger.debug "Preprocessed #{dst_io.path} will be teed to #{buff_ios.map(&:path).join '; '}"
+          Ffmprb.logger.debug{"Preprocessed #{dst_io.path} will be teed to #{buff_ios.map(&:path).join '; '}"}
           Util::Thread.new "cloning buffer watcher" do
             dst_io.threaded_buffered_copy_to(*buff_ios).tap do |io_buff|
               Util::Thread.join_children!
@@ -94,17 +91,15 @@ module Ffmprb
             end
           end
 
-          # Ffmprb.logger.debug "Concatenation of #{buff_ios.map(&:path).join '; '} will go to #{@io.io.path} to be fed to this process"
-
           # NOTE additional (filtered, processed and looped) input io
           aux_io = File.temp_fifo(intermediate_extname)
 
           # NOTE (4)
 
           Util::Thread.new "looper" do
-            Ffmprb.logger.debug "Looping #{buff_ios.size} times"
+            Ffmprb.logger.debug{"Looping #{buff_ios.size} times"}
 
-            Ffmprb.logger.debug "(L4) Looping (#{buff_ios.map &:path}) into (#{aux_io.path})"
+            Ffmprb.logger.debug{"(L4) Looping (#{buff_ios.map &:path}) into (#{aux_io.path})"}
             begin  # NOTE may not write its entire output, it's ok
               Ffmprb.process parent: @raw.process, ignore_broken_pipes: false do
 
@@ -121,7 +116,7 @@ module Ffmprb
 
           # NOTE (1)
 
-          Ffmprb.logger.debug "(L1) Creating a new input (#{aux_io.path}) to the process"
+          Ffmprb.logger.debug{"(L1) Creating a new input (#{aux_io.path}) to the process"}
           @raw.process.input(aux_io)
         end
 

data/lib/ffmprb/process/output.rb

@@ -84,7 +84,7 @@ module Ffmprb
             # NOTE Image-Padding to match the target resolution
             # TODO full screen only at the moment (see exception above)
 
-            Ffmprb.logger.debug "#{self} asking for filters of #{curr_reel.reel.io.inspect} video: #{channel(:video)}, audio: #{channel(:audio)}"
+            Ffmprb.logger.debug{"#{self} asking for filters of #{curr_reel.reel.io.inspect} video: #{channel(:video)}, audio: #{channel(:audio)}"}
             @filters.concat(
               curr_reel.reel.filters_for lbl, video: channel(:video), audio: channel(:audio)
             )
@@ -151,7 +151,7 @@ module Ffmprb
               )  if channel?(:audio)
 
               segments << new_prev_lbl
-              Ffmprb.logger.debug "Concatting segments: #{new_prev_lbl} pushed"
+              Ffmprb.logger.debug{"Concatting segments: #{new_prev_lbl} pushed"}
             end
 
             if curr_reel.transition
@@ -264,7 +264,7 @@ module Ffmprb
             end
             process.proc_vis_edge process, main_av_o, :remove
             process.proc_vis_edge process, main_av_inter_i
-            Ffmprb.logger.debug "Re-routed the main audio output (#{main_av_inter_i.path}->...->#{main_av_o.path}) through the process of audio ducking"
+            Ffmprb.logger.debug{"Re-routed the main audio output (#{main_av_inter_i.path}->...->#{main_av_o.path}) through the process of audio ducking"}
 
             over_a_i, over_a_o = File.threaded_buffered_fifo(Process.intermediate_channel_extname(audio: true, video: false), proc_vis: process)
             lbl_over = "o#{idx}l#{i}"
@@ -273,10 +273,10 @@ module Ffmprb
             )
             @channel_lbl_ios["#{lbl_over}:a"] = over_a_i
             process.proc_vis_edge process, over_a_i
-            Ffmprb.logger.debug "Routed and buffering auxiliary output fifos (#{over_a_i.path}>#{over_a_o.path}) for overlay"
+            Ffmprb.logger.debug{"Routed and buffering auxiliary output fifos (#{over_a_i.path}>#{over_a_o.path}) for overlay"}
 
             inter_i, inter_o = File.threaded_buffered_fifo(intermediate_extname, proc_vis: process)
-            Ffmprb.logger.debug "Allocated fifos to buffer media (#{inter_i.path}>#{inter_o.path}) while finding silence"
+            Ffmprb.logger.debug{"Allocated fifos to buffer media (#{inter_i.path}>#{inter_o.path}) while finding silence"}
 
             ignore_broken_pipes_was = process.ignore_broken_pipes  # XXX maybe throw an exception instead?
             process.ignore_broken_pipes = true  # NOTE audio ducking process may break the overlay pipe
@@ -285,7 +285,10 @@ module Ffmprb
               process.proc_vis_edge main_av_inter_o, inter_i  # XXX mark it better
               silence = Ffmprb.find_silence(main_av_inter_o, inter_i)
 
-              Ffmprb.logger.debug "Audio ducking with silence: [#{silence.map{|s| "#{s.start_at}-#{s.end_at}"}.join ', '}]"
+              Ffmprb.logger.debug{
+                silence_map = silence.map{|s| "#{s.start_at}-#{s.end_at}"}
+                "Audio ducking with silence: [#{silence_map.join ', '}]"
+              }
 
               Process.duck_audio inter_o, over_a_o, silence, main_av_o,
                 process_options: {parent: process, ignore_broken_pipes: ignore_broken_pipes_was, timeout: process.timeout},

data/lib/ffmprb/util.rb

@@ -18,8 +18,10 @@ module Ffmprb
         sh *ffprobe_cmd, *args, limit: limit, timeout: timeout
       end
 
+      # TODO warn on broken pipes incompatibility with 4.x or something
       def ffmpeg(*args, limit: nil, timeout: cmd_timeout, ignore_broken_pipes: true)
-        args = ['-loglevel', 'debug'] + args  if Ffmprb.ffmpeg_debug
+        args = ['-loglevel', 'debug'] + args  if
+          Ffmprb.ffmpeg_debug
         sh *ffmpeg_cmd, *args, output: :stderr, limit: limit, timeout: timeout, ignore_broken_pipes: ignore_broken_pipes
       end
 
@@ -42,7 +44,7 @@ module Ffmprb
                 value = wait_thr.value
                 status = value.exitstatus  # NOTE blocking
                 if status != 0
-                  if value.signaled? && value.termsig == Signal.list['PIPE']
+                  if value.signaled? && value.termsig == Signal.list['PIPE']  # TODO! this doesn't seem to work for ffmpeg 4.x (it ignores SIGPIPEs)
                     if ignore_broken_pipes
                       Ffmprb.logger.info "Ignoring broken pipe: #{cmd_str}"
                     else
@@ -54,7 +56,7 @@ module Ffmprb
                   end
                 end
               end
-              Ffmprb.logger.debug "FINISHED: #{cmd_str}"
+              Ffmprb.logger.debug{"FINISHED: #{cmd_str}"}
 
               Thread.join_children! limit, timeout: timeout
 

data/lib/ffmprb/util/proc_vis.rb

@@ -137,7 +137,7 @@ module Ffmprb
           @proc_vis_firebase_client =
             if proc_vis_firebase
               url = "https://#{proc_vis_firebase}.firebaseio.com/proc/"
-              Ffmprb.logger.debug "Connecting to #{url}"
+              Ffmprb.logger.debug{"Connecting to #{url}"}
               begin
                 Firebase::Client.new(url).tap do
                   Ffmprb.logger.info "Connected to #{url}"

data/lib/ffmprb/util/thread.rb

@@ -42,12 +42,13 @@ module Ffmprb
       attr_reader :name
 
       def initialize(name="some", main: false, &blk)
+        orig_caller = caller
         @name = name
         @parent = Thread.current
         @live_children = []
         @children_mon = Monitor.new
         @dead_children_q = Queue.new
-        Ffmprb.logger.debug "about to launch #{name}"
+        Ffmprb.logger.debug{"about to launch #{name}"}
         sync_q = Queue.new
         super() do
           @parent.proc_vis_node self  if @parent.respond_to? :proc_vis_node
@@ -57,10 +58,10 @@ module Ffmprb
             Ffmprb.logger.warn "Not the main: true thread run by a not #{self.class.name} thread"  unless main
           end
           sync_q.enq :ok
-          Ffmprb.logger.debug "#{name} thread launched"
+          Ffmprb.logger.debug{"#{name} thread launched"}
           begin
             blk.call.tap do
-              Ffmprb.logger.debug "#{name} thread done"
+              Ffmprb.logger.debug{"#{name} thread done"}
             end
           rescue Exception
             Ffmprb.logger.warn "#{$!.class.name} raised in #{name} thread: #{$!.message}\nBacktrace:\n\t#{$!.backtrace.join("\n\t")}"
@@ -84,7 +85,7 @@ module Ffmprb
 
       def child_lives(thr)
         @children_mon.synchronize do
-          Ffmprb.logger.debug "picking up #{thr.name} thread"
+          Ffmprb.logger.debug{"picking up #{thr.name} thread"}
           @live_children << thr
         end
         proc_vis_edge self, thr
@@ -92,7 +93,7 @@ module Ffmprb
 
       def child_dies(thr)
         @children_mon.synchronize do
-          Ffmprb.logger.debug "releasing #{thr.name} thread"
+          Ffmprb.logger.debug{"releasing #{thr.name} thread"}
           @dead_children_q.enq thr
           fail "System Error"  unless @live_children.delete thr
         end