media_trim 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37f7ed510ad90d35e85ef47e33fabf9d1994779512a6c6b4342c570e3a957048
-  data.tar.gz: b0f0aed439b2fe793be04f38ea30937a767f53c997bb1723c38d9b2357b23e63
+  metadata.gz: 36fc227a339df6b896c637594bf92ce4d433efb4e6c24703132379790f7dfd80
+  data.tar.gz: 170d4360b331c7ec5263e729ef8066f0a28bf7e918bbe7c2372a7c9358e4e560
 SHA512:
-  metadata.gz: de4ee11b00dfc2067a94f1da192d76940ca09d1baacd8ce3ddb215444a0dd45c1a4aac93c46399432e5818aa76efba4bc2ccadaeb8f51bb317f707b40c8f456f
-  data.tar.gz: 1bdea1d74ba69994bfaf7452c1fe1fe6cd9b9c9ecb76530c45bfb640c5624ae55456ab3012cb39157778cb5fc4d0532003285285218b3a64702b0035926fbd71
+  metadata.gz: e9573015fdfb8d2c1abe826171b6962ad98aa3c0ce18cbb1348a52dac132f0d1007c12b14ba9c0f02fe145afe4d851a0463c6600edf38dfdf00b7e3e63b77b40
+  data.tar.gz: bc977e7881083631a2f521029ddd3b86b74b1a7ac901f69a78b18aec0370eb37ef8cf21b7085558408bfbeaea8869046904ed8cc2567d227473b0e39fbd8e84c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 0.2.2
+
+* Added a preflight check that validates the runtime environment before invoking
+ `ffmpeg`.  The preflight check halts on fatal errors such as a missing `ffmpeg`
+ binary, an unreadable input file, a missing software decoder for the input
+ codec, or insufficient disk space.
+* Implemented an automatic software-fallback when hardware acceleration
+ initialization fails.  The tool will warn the user, retry the operation using
+ software decoding (which is slower), and only abort if a required software
+ decoder or resource is missing.
+* Added a `--no-hwaccel` (`-H`) option to force software decoding and skip
+  hardware acceleration.
+
 ## 0.2.1
 
 * Added `spec.platform` to `media_trim.gemspec` because `RubyGems.org` now requires it

data/README.md

@@ -78,6 +78,29 @@ unless the `-V` option is specified.
 * `-f` Overwrite output file if present.
 * `-v` Verbose output.
 * `-V` Do not view the trimmed file when complete.
+* `-H` Disable hardware acceleration and use software decoding. If hardware
+  acceleration cannot be initialized on your system, the command will automatically
+  retry using software decoding. Software decoding may be slower but will produce
+  the same output. If a required software decoder is missing the program will
+  halt and display a clear error message.
+
+## Preflight checks
+
+Before running `ffmpeg` the `trim` command performs a set of preflight checks and
+reports any issues in clear English sentences. The checks include:
+
+- Verifying the `ffmpeg` executable is available; if it is not installed the
+  command aborts with instructions to install it.
+- Probing hardware acceleration initialization; if hardware acceleration
+  initialization fails the tool will warn you and retry in software mode.
+- Verifying that `ffmpeg` can perform a short software decode of the input
+  file; if software decoding fails the command will abort as this indicates a
+  missing decoder or an unreadable input file.
+- Checking there is sufficient disk space in the destination directory; the
+  command aborts if there is not enough free space.
+
+These checks ensure the tool halts on fatal problems and otherwise produces a
+successful result using software decoding when needed.
 
 
 #### Examples

data/lib/media_trim/version.rb

@@ -1,3 +1,3 @@
 module MediaTrimVersion
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/media_trim.rb

@@ -6,6 +6,7 @@ require_relative 'media_trim/version' unless defined? MediaTrimVersion::VERSION
 require_relative 'trim_class'
 require_relative 'trim_help'
 require_relative 'trim_main'
+require_relative 'trim_preflight'
 require_relative 'trim_run'
 
 if __FILE__ == $PROGRAM_NAME

data/lib/trim_help.rb

@@ -28,6 +28,11 @@ class MediaTrim
         -h Display help information.
         -v Verbose output
         -V Do not view the trimmed file when complete.
+        -H Disable hardware acceleration and use software decoding. If hardware
+           acceleration initialization fails on your system, the command will
+           automatically retry using software decoding. Software decoding is
+           slower, but it will produce the same output. If a required software
+           decoder is missing then the program will halt with an error.
 
       Examples:
         # Crop dir/file.mp4 from 15.0 seconds to the end of the video, save to demo/trim.demo.mp4:

data/lib/trim_main.rb

@@ -11,6 +11,7 @@ class MediaTrim
     @start = MediaTrim.time_format(MediaTrim.to_seconds(start))
     @interval = ['-ss', @start]
     @debug = options[:debug] || false
+    @no_hwaccel = options[:no_hwaccel] || false
 
     @overwrite = options[:overwrite] ? '-y' : '-n'
     @quiet     = options[:quiet].nil? || options[:quiet] ? ['-hide_banner', '-loglevel', 'error', '-nostats'] : []
@@ -38,6 +39,9 @@ class MediaTrim
       opts.on('-d', '--debug', 'Enable debug output') do
         @debug = true
       end
+      opts.on('-H', '--no-hwaccel', 'Disable hardware acceleration and use software decoding') do
+        @no_hwaccel = true
+      end
     end.parse!
   end
 

data/lib/trim_preflight.rb

@@ -0,0 +1,54 @@
+require 'open3'
+require 'shellwords'
+
+class MediaTrim
+  # Run a set of preflight checks and either exit on fatal errors or
+  # return an array of warning messages. The method uses clear, full-sentence
+  # messages so the user understands what is missing or degraded.
+  def preflight_check(input)
+    warnings = []
+
+    # Check that ffmpeg is installed
+    unless system('which ffmpeg > /dev/null 2>&1')
+      puts "Fatal: ffmpeg is not installed. Please install ffmpeg and try again.".red
+      exit 1
+    end
+
+    # Probe hardware acceleration initialization in a lightweight way. If
+    # this fails with hardware-specific errors we will warn and allow a
+    # software retry later. If probing fails for decoding reasons, that is fatal.
+    probe_cmd = ['ffmpeg', '-v', 'error', '-hwaccel', 'auto', '-i', input, '-t', '1', '-f', 'null', '-']
+    _, stderr, status = Open3.capture3(*probe_cmd)
+
+    if !status.success?
+      hwaccel_errors = [/CUDA_ERROR_NO_DEVICE/, /Failed to initialise VAAPI/, /Cannot open the X11 display/, /Device does not support VK_KHR_video_decode_queue/, /hwaccel/]
+      if hwaccel_errors.any? { |rx| stderr =~ rx }
+        warnings << "Hardware acceleration could not be initialized: #{stderr.lines.first(2).join(' ').strip}. The command will be retried using software decoding, which is slower but produces the same result." 
+      else
+        # If hw probe fails for other reasons, check software decoding capability.
+        sw_cmd = ['ffmpeg', '-v', 'error', '-i', input, '-t', '1', '-f', 'null', '-']
+        _, sw_stderr, sw_status = Open3.capture3(*sw_cmd)
+        unless sw_status.success?
+          puts "Fatal: ffmpeg cannot decode the input file. #{sw_stderr.lines.first(2).join(' ').strip}".red
+          exit 1
+        end
+      end
+    end
+
+    # Check available disk space in destination directory.
+    begin
+      dest_dir = Shellwords.escape(File.dirname(input))
+      avail = `df --output=avail -B1 #{dest_dir} 2>/dev/null`.lines.last.to_i
+    rescue StandardError
+      avail = 0
+    end
+    if avail == 0 || avail < 100_000_000
+      puts "Fatal: There is less than 100 MB of free space available in the destination directory. Please free space and try again.".red
+      exit 1
+    end
+
+    # If we reach here, return any collected warnings for user information.
+    warnings.each { |w| puts "Warning: #{w}".yellow }
+    warnings
+  end
+end

data/lib/trim_run.rb

@@ -6,22 +6,41 @@ class MediaTrim
     raise TrimError, 'Error: Starting timestamp must be a string'.red unless @start.instance_of? String
 
     puts "Trimming '#{@fname}' from #{@start}#{@msg_end}".cyan
-    command = ['ffmpeg',
-               *@quiet,
-               '-hwaccel', 'auto',
-               @overwrite,
-               '-i', @fname,
-               '-acodec', 'aac',
-               *@interval,
-               @copy_filename]
-    # puts command.join(' ').yellow
+
+    # Run preflight checks which may print warnings or exit on fatal errors.
+    preflight_warnings = preflight_check @fname
+
+    # Build ffmpeg command. Respect explicit no-hwaccel option.
+    base_args = ['ffmpeg', *@quiet, @overwrite, '-i', @fname, '-acodec', 'aac', *@interval, @copy_filename]
+
+    if @no_hwaccel
+      command = base_args
+    else
+      command = ['ffmpeg', *@quiet, '-hwaccel', 'auto', @overwrite, '-i', @fname, '-acodec', 'aac', *@interval, @copy_filename]
+    end
+
+    # Execute ffmpeg (timed). If hwaccel was used and failed, retry once without hwaccel.
     start_clock = Process.clock_gettime(Process::CLOCK_MONOTONIC)
     status = system(*command)
     end_clock = Process.clock_gettime(Process::CLOCK_MONOTONIC)
     elapsed = end_clock - start_clock
     puts "Trim took #{MediaTrim.time_format elapsed.to_i}".cyan
     $stdout.flush
-    exit 1 unless status
+
+    unless status
+      # If we attempted hwaccel and it failed, retry in software mode once.
+      if !@no_hwaccel && command.include?('-hwaccel')
+        puts "Warning: hardware acceleration failed. Retrying with software decoding, which may be slower but will produce the correct result.".yellow
+        soft_command = base_args
+        start_clock = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        status = system(*soft_command)
+        end_clock = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        elapsed = end_clock - start_clock
+        puts "Retry (software) took #{MediaTrim.time_format elapsed.to_i}".cyan
+        $stdout.flush
+      end
+      exit 1 unless status
+    end
 
     # View trimmed file unless -q option was specified
     return unless @view

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media_trim
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Mike Slinn
@@ -80,6 +80,7 @@ files:
 - lib/trim_class.rb
 - lib/trim_help.rb
 - lib/trim_main.rb
+- lib/trim_preflight.rb
 - lib/trim_run.rb
 - media_trim.gemspec
 - spec/spec_helper.rb
@@ -96,7 +97,7 @@ metadata:
   source_code_uri: https://github.com/mslinn/media_trim
 post_install_message: |2+
 
-  Thanks for installing media_trim v0.2.1!
+  Thanks for installing media_trim v0.2.2!
 
 rdoc_options: []
 require_paths:
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Trim an audio or video file using ffmpeg
 test_files: []