ffmpeg_progress 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be912ce3dcef0d9351c5499cee46cae82a6d6f02
+  data.tar.gz: 2fd3d86091bc2c7e6b26e802a6f0a500a0ffaed3
+SHA512:
+  metadata.gz: fa668255e546bc6905bba6acbd365d98fcba0dfd168c34c4e7172d2d9c6e627e648872827a590252747d13412d60c45b2f8363a3b6e24555a20a19231d6cc3f4
+  data.tar.gz: 5aa94f631e4848560fb61f05e328acef07b73608e23012c6171930108ff91c321272ff091291ae2a6d5090e65370280e8c2e2d4b6b1b68c93ab490ab6afa1adb

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Winterbraid
+
+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.rdoc

@@ -0,0 +1,29 @@
+=FfmpegProgress
+
+Execute +ffmpeg+ commands while displaying a pretty progress bar instead of the
+usual garbage.
+
+Convert from the shell with default options:
+  # Will save to ./converted/test.mp4
+  ruby -rffmpeg_progress -e "FfmpegProgress::Ffmpeg.new('test.avi').run"
+
+==Example Use
+  require 'ffmpeg_progress'
+
+  include FfmpegProgress
+
+  f = Ffmpeg.new 'input.avi'
+
+  # Occurrences of '_INPUT_' will be replaced with the input file name.
+  f.options = '-y -threads 0 -c:v libx264 -crf 22 -preset medium -c:a copy'
+
+  # Directories will be created if necessary.
+  f.output = 'output.mkv'
+
+  f.command
+  # => "ffmpeg -i input.avi -y -threads 0 -c:v libx264 -crf 22 " \
+  #   "-preset medium -c:a copy output.mkv &> ffmpeg.log"
+
+  # The optional block is passed self as a parameter and appended to
+  # the progress bar.
+  f.run { |ffmpeg| ffmpeg.output }

data/lib/ffmpeg_progress.rb

@@ -0,0 +1,253 @@
+require 'fileutils'
+
+# {include:file:README.rdoc}
+module FfmpegProgress
+  # The current software version.
+  VERSION = '1.0.0'
+
+  # The date of the current version.
+  DATE = '2014-10-31'
+
+  # A short description of the software.
+  ABOUT = 'A fancy progress bar for ffmpeg.'
+
+  # Contains various examples of +ffmpeg+ options.
+  module Presets
+    # The default options. Convert the video to x264 and audio to AAC.
+    DEFAULT_OPTS = '-y -threads 0 -strict -2 -c:a aac -b:a 96k ' \
+      '-c:v libx264 -preset fast -tune fastdecode -crf 22 '
+
+    # Read the default subtitles embedded in an input MKV file and hardcode
+    # them into the video. Any embedded fonts must be extracted and installed
+    # first to preserve them in the output, for example:
+    #   mkvextract attachments input.mkv {1..10}
+    #   cp *.ttf *.ttc *.otf ~/.fonts
+    BURN_MKV_SUBS = '-y -threads 0 -strict -2 -sn -c:a copy ' \
+      '-c:v libx264 -preset fast -tune fastdecode -crf 22 ' \
+      '-vf "subtitles=_INPUT_"'
+
+    # Like {BURN_MKV_SUBS}, but also downscale the video to 800px width.
+    BURN_800 = '-y -threads 0 -strict -2 -sn -c:a aac -b:a 96k ' \
+      '-c:v libx264 -preset fast -tune fastdecode -crf 22 ' \
+      '-vf "[in]scale=800:-2[tmp];[tmp]subtitles=_INPUT_[out]"'
+  end
+
+  # Helper methods.
+  module Utils
+    # Colorize a string for the terminal (256-color mode).
+    #
+    # @param [String] string
+    # @param [Integer] color
+    # @return [String]
+    def colorize(string, color)
+      "\x1b[38;5;#{color}m#{string}\x1b[0m"
+    end
+
+    # Parse a time string in the +ffmpeg+ HH:MM:SS.ms format and return seconds.
+    #
+    # @param [String] time_string
+    # @return [Integer]
+    def parse_ffmpeg_time(time_string)
+      array = time_string.rpartition('.').first.split(':').map(&:to_i)
+
+      array[0] * 3600 + array[1] * 60 + array[2]
+    end
+  end
+
+  # The class that does the actual work.
+  class Ffmpeg
+    include Presets
+    include Utils
+
+    # The log file for ffmpeg. Progress data will be read from here.
+    LOG_FILE = 'ffmpeg.log'
+
+    # The extension for the default output file.
+    DEFAULT_EXT = 'mp4'
+
+    # The directory for the default output file.
+    DEFAULT_DIR = 'converted/'
+
+    # The default theme, change this with {#theme=}. {FfmpegProgress} expects
+    # a 256-color capable terminal.
+    DEFAULT_THEME = {
+      bars: 63, head: '[', full: '=', empty: '-', tail: ']',
+      end_fg: 202, full_fg: 214, empty_fg: 202,
+      time_fg: 214, block_fg: 214, finish_fg: 40, cancel_fg: 1
+    }
+
+    # The input file.
+    # @return [String]
+    attr_reader :input
+
+    # The output file. Directories will be auto-created on execution.
+    # @return [String]
+    attr_accessor :output
+
+    # Returns the duration (in seconds) of the input file.
+    # @return [Integer]
+    attr_reader :duration
+
+    # Returns the duration of the input file as a +ffmpeg+ format string
+    # (+HH:MM:SS.ms+).
+    #
+    # @return [Integer]
+    attr_reader :duration_ff
+
+    # The options to pass to +ffmpeg+. Any occurrences of the string +_INPUT_+
+    # will be converted to the value of the {#input} attribute.
+    # @return [String]
+    attr_accessor :options
+
+    # The theme for the progress bar. See {DEFAULT_THEME} for details.
+    # @return [Hash]
+    attr_accessor :theme
+
+    # The PID of the last spawned +ffmpeg+ process, or +nil+ if none spawned
+    # yet.
+    # @return [Integer]
+    attr_reader :pid
+
+    # Creates a new {Ffmpeg} instance.
+    #
+    # @param [String] input_file the source file name.
+    # @param [String] ffmpeg_options the options to pass to ffmpeg.
+    #   See {#options} for details and {Presets} for examples.
+    # @return [Ffmpeg]
+    def initialize(input_file = nil, ffmpeg_options = DEFAULT_OPTS)
+      self.input = input_file
+      @options = ffmpeg_options
+
+      @output ||= nil
+      @duration_ff ||= nil
+      @duration ||= nil
+
+      @block = nil
+
+      @pid = nil
+      @theme = DEFAULT_THEME
+
+      @last_bar = nil
+    end
+
+    # Set the input file.
+    #
+    # @param [String] string
+    # @return [String]
+    def input=(string)
+      @input = string
+
+      return @input unless @input
+
+      @duration_ff = `ffmpeg -i \'#{@input}\' 2>&1`.scan(/..:..:..\.../).first
+      @duration = parse_ffmpeg_time(@duration_ff)
+
+      @output ||= "#{DEFAULT_DIR}#{@input.rpartition('.').first}.#{DEFAULT_EXT}"
+
+      @input
+    end
+
+    # Returns the current +ffmpeg+ command that will be executed by {#run}.
+    #
+    # @return [String]
+    def command
+      "ffmpeg -i \'#{@input}\' #{@options} \'#{@output}\' &> #{LOG_FILE}"
+        .gsub('_INPUT_', "'#{@input}'")
+    end
+
+    # Run +ffmpeg+ while printing a progress bar to the terminal.
+    # If a block is passed, its return value will be attached to the
+    # progress bar. The current {Ffmpeg} instance will be passed to
+    # the block.
+    #
+    # @return [0]
+    def run(&block)
+      File.delete(LOG_FILE) if File.exist?(LOG_FILE)
+
+      FileUtils.mkpath(@output.rpartition('/').first) if output.include?('/')
+
+      @pid = spawn command
+      @block = block
+
+      sleep 1 until current_time
+      monitor_progress
+
+      cleanup
+
+      0
+    end
+
+    private
+
+    # Display the progress bar while waiting for +ffmpeg+ to finish.
+    def monitor_progress
+      until Process.waitpid(@pid, Process::WNOHANG)
+        print "\r#{progress_bar}"
+        sleep 1
+      end
+
+      puts "\r#{progress_bar(@theme[:finish_fg], @dur_string)}"
+    rescue Interrupt
+      puts "\r#{progress_bar(@theme[:cancel_fg])}"
+    end
+
+    # Display the progress bar.
+    def progress_bar(time_fg = @theme[:time_fg], time = current_time)
+      elements = bar_elements(time_fg, time)
+
+      bar =
+        "#{elements.head}#{elements.full}#{elements.empty}#{elements.tail}" \
+        "#{elements.head}#{elements.time}#{elements.tail}"
+
+      if @block
+        block_value = colorize(@block.call(self), @theme[:block_fg])
+        bar << "#{elements.head}#{block_value}#{elements.tail}"
+      end
+
+      bar
+    end
+
+    # Get the current time (in +ffmpeg+ format) from the log file.
+    # Returns +nil+ if the actual transcoding process has not started yet.
+    #
+    # @return [String]
+    def current_time
+      return nil unless File.exist?(LOG_FILE)
+      match = File.read(LOG_FILE).scan(/time=..:..:..\.../).last
+
+      return nil unless match
+      match.delete('time=')
+    end
+
+    # Generate bar elements for a given +ffmpeg+ time.
+    def bar_elements(time_fg, time)
+      elements = Struct.new(:head, :tail, :full, :empty, :time)
+      bars = (@theme[:bars] * parse_ffmpeg_time(time) / @duration).round
+
+      elements.new(
+        colorize(@theme[:head], @theme[:end_fg]),
+        colorize(@theme[:tail], @theme[:end_fg]),
+        colorize(@theme[:full] * bars, @theme[:full_fg]),
+        colorize(@theme[:empty] * (@theme[:bars] - bars), @theme[:empty_fg]),
+        colorize(time, time_fg)
+      )
+    end
+
+    # Kill +ffmpeg+ if still running, and delete the log file.
+    def cleanup
+      Process.detach(@pid)
+
+      ffmpeg_alive =
+        begin
+          Process.kill(0, @pid)
+          true
+        rescue Errno::ESRCH
+          false
+        end
+
+      Process.kill('TERM', @pid) if ffmpeg_alive
+
+      File.delete(LOG_FILE) if File.exist?(LOG_FILE)
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: ffmpeg_progress
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Winterbraid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-31 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Execute ffmpeg commands and display a progress bar.
+email: Winterbraid@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.rdoc
+- lib/ffmpeg_progress.rb
+homepage: https://github.com/Winterbraid/ffmpeg_progress
+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 fancy progress bar for ffmpeg.
+test_files: []
+has_rdoc: