mm_tool 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58f5ac411fa199ac4b62febe8ca5896dfa7b490b4114038d8272681cee38b6d7
-  data.tar.gz: bd6f59ce638b8e374ecc63213570a45ae84d7341e1796e3588887ca1ff948de1
+  metadata.gz: 92055cbeccfc0cd1628a7d89d281c1c179bace5eae9a099c62082e66a4d82744
+  data.tar.gz: 48327dccb7a80c5f1636a88bfc3406851eae42ece5e0c82eb747e664aab54880
 SHA512:
-  metadata.gz: 7d32af155244f7019de5b7c9e9e37a89d91cc805463708f7f295efb7ac79b7982673d9d4e39bc18ef98aec00592642e8e1f9ec8e9588a51dd0df6f7bc53e2cbb
-  data.tar.gz: db86d0614d20fc56ccf75542966535543cd46a33a90015bfd0644293659a2c77135013bbf44448a0108ef3ffd7f36d85451f4d24454f807893fb2b1ea7eae2a3
+  metadata.gz: 767a31ed4096a56bfa3a481a7922692d7d42421f4ceec1f87e81dc178968a49f6ffba46f8caadf5b01b8cd244a5a85500942adafb61d0fcc18137a12605c5449
+  data.tar.gz: c518d44843912f60101507ede5ca4d4840850043375edc0be6b710465b6f6e5f2b9879c67fa62bff5702684a1dd69fb3784d10b78a5cfdb2a8b13b38072b99c2

data/bin/mm_tool

@@ -15,5 +15,4 @@ end
 #=============================================================================
 
 cli = MmTool::MmToolCli.new(MmTool::ApplicationMain.shared_application)
-cli.validate_prerequisites
 cli.run(ARGV)

data/lib/mm_tool/application_main.rb

@@ -1,5 +1,25 @@
 module MmTool
 
+  @@encoder_list = nil
+
+  #------------------------------------------------------------
+  # Module-level attribute provides list of installed encoders.
+  #------------------------------------------------------------
+  def self.encoder_list
+    unless @@encoder_list
+      @@encoder_list = %w()
+      codecs_allowed   = %w(libx264 libx265 h264_qsv hevc_qsv h264_videotoolbox hevc_videotoolbox)
+      task             = TTY::Command.new(printer: :null)
+
+      codecs_allowed.each do |codec|
+        result = task.run!("ffprobe -v quiet -codecs | grep #{codec}")
+        @@encoder_list << codec unless result.failure?
+      end
+    end
+    @@encoder_list
+  end
+
+
   #=============================================================================
   # The main application.
   #=============================================================================

data/lib/mm_tool/mm_movie.rb

@@ -27,7 +27,7 @@ module MmTool
     #------------------------------------------------------------
     def initialize(with_file:)
       @defaults        = MmUserDefaults.shared_user_defaults
-      @streams         = MmMovieStream::streams(with_files: all_paths(with_file: with_file))
+      @streams         = MmMovieStream::streams(with_files: all_paths(with_file: with_file), owner_ref: self)
       @format_metadata = FFMPEG::Movie.new(with_file).metadata[:format]
     end
 
@@ -47,6 +47,21 @@ module MmTool
       size ? ByteSize.new(size) : 'unknown'
     end
 
+    #------------------------------------------------------------
+    # Get the file-level 'bitrate' metadata.
+    #------------------------------------------------------------
+    def format_bitrate
+      size = @format_metadata[:bit_rate]
+      ByteSize.new(size).to_kb.to_i.to_s + "K"
+    end
+
+    #------------------------------------------------------------
+    # Get the file-level 'bitrate' metadata.
+    #------------------------------------------------------------
+    def raw_bitrate
+      @format_metadata[:bit_rate].to_i
+    end
+
     #------------------------------------------------------------
     # Get the file-level 'title' metadata.
     #------------------------------------------------------------
@@ -84,7 +99,7 @@ module MmTool
     def format_table
       unless @format_table
         @format_table = format_table_datasource.render(:basic) do |renderer|
-          renderer.column_widths = [10,10, 160]
+          renderer.column_widths = [10,10,10,160]
           renderer.multiline     = true
           renderer.padding       = [0,1]
           renderer.width         = 1000
@@ -192,8 +207,8 @@ module MmTool
     #------------------------------------------------------------
     def format_table_datasource
       unless @format_table
-        @format_table = TTY::Table.new(header: %w(Duration: Size: Title:))
-        @format_table << [format_duration, format_size, format_title]
+        @format_table = TTY::Table.new(header: %w(Duration: Size: Bitrate: Title:))
+        @format_table << [format_duration, format_size, format_bitrate, format_title]
       end
       @format_table
     end

data/lib/mm_tool/mm_movie_stream.rb

@@ -15,7 +15,7 @@ module MmTool
     # an array of MmMovieStreams reflecting the streams present
     # in each of them.
     #------------------------------------------------------------
-    def self.streams(with_files:)
+    def self.streams(with_files:, owner_ref:)
       # Arrays are passed around by reference; when this array is created and
       # used as a reference in each stream, and *also* returned from this class
       # method, everyone will still be using the same reference. It's important
@@ -24,7 +24,7 @@ module MmTool
       with_files.each_with_index do |path, i|
         ff_movie = FFMPEG::Movie.new(path)
         ff_movie.metadata[:streams].each do |stream|
-          streams << MmMovieStream.new(stream_data: stream, source_file: path, file_number: i, streams_ref: streams)
+          streams << MmMovieStream.new(stream_data: stream, source_file: path, file_number: i, streams_ref: streams, owner_ref: owner_ref)
         end
       end
       streams
@@ -33,12 +33,13 @@ module MmTool
     #------------------------------------------------------------
     # Initialize
     #------------------------------------------------------------
-    def initialize(stream_data:, source_file:, file_number:, streams_ref:)
+    def initialize(stream_data:, source_file:, file_number:, streams_ref:, owner_ref:)
       @defaults    = MmUserDefaults.shared_user_defaults
       @data        = stream_data
       @source_file = source_file
       @file_number = file_number
       @streams     = streams_ref
+      @owner_ref   = owner_ref
     end
 
     #------------------------------------------------------------
@@ -463,13 +464,47 @@ module MmTool
     # Given a codec, return the ffmpeg encoder string.
     #------------------------------------------------------------
     def encoder_string(for_codec:)
+
+      # If we have to use bitrate for controlling quality, we want to ensure that we don't
+      # exceed the current bitrate, which would be a lossy conversion to a larger file.
+      # This only applies to videotoolbox on Intel. We'll use constant quality for everything else.
+      # Pretty much, we don't want to use videotoolbox on macOS. Hey? Why can't we use qsv on macOS?
+      rate_h264 = (@owner_ref.raw_bitrate * 0.750).to_i
+      rate_h265 = (@owner_ref.raw_bitrate * 0.500).to_i
+
+      string_h264 = ByteSize.new(rate_h264).to_kb.to_i.to_s + "K"
+      string_h265 = ByteSize.new(rate_h265).to_kb.to_i.to_s + "K"
+
+      # Constant quality mode is only available for Apple Silicon!
+      # Can't use -q:v 65 without Apple Silicon.
+      # Have to use -b:v 6000K (for example) on Intel.
+      # HEVC doesn't seem to work on Intel without -pix_fmt yuv420p10le.
+      encoder_strings = {
+        :libx264           => "libx264 -crf 23 -force_key_frames chapters",
+        :libx265           => "libx265 -crf 28 -x265-params log-level=error -force_key_frames chapters",
+        :h264_qsv          => "h264_qsv -global_quality 22 -lookahead 1 -force_key_frames chapters",
+        :hevc_qsv          => "hevc_qsv -global_quality 22 -lookahead 1 -force_key_frames chapters",
+        :h264_videotoolbox => "h264_videotoolbox -b:v #{string_h264} -force_key_frames chapters",
+        :hevc_videotoolbox => "hevc_videotoolbox -b:v #{string_h265} -pix_fmt yuv420p10le -force_key_frames chapters"
+      }
+      if RUBY_PLATFORM.downcase.start_with?('arm64')
+        encoder_strings[:h264_videotoolbox] = "h264_videotoolbox -q:v 50 -force_key_frames chapters"
+        encoder_strings[:hevc_videotoolbox] = "hevc_videotoolbox -q:v 50 -force_key_frames chapters"
+      end
+
+      encoder = @defaults[:encoder].to_sym
+
       case for_codec.downcase
       when 'hevc'
-        "libx265 -crf 28 -x265-params log-level=error -force_key_frames chapters"
+        return encoder_strings[:libx265] if [:auto, :libx265].include?(encoder)
+        return encoder_strings[:hevc_qsv] if encoder == :hevc_qsv
+        return encoder_strings[:hevc_videotoolbox] if encoder == :hevc_videotoolbox
       when 'h264'
-        "libx264 -crf 23"
+        return encoder_strings[:libx264] if [:auto, :libx264].include?(encoder)
+        return encoder_strings[:h264_qsv] if encoder == :h264_qsv
+        return encoder_strings[:h264_videotoolbox] if encoder == :h264_videotoolbox
       when 'aac'
-        "libfdk_aac"
+        return "libfdk_aac"
       else
         raise Exception.new "Error: somehow an unsupported codec '#{for_codec}' was specified."
       end

data/lib/mm_tool/mm_tool_cli.rb

@@ -12,6 +12,11 @@ module MmTool
     # Initialize
     #------------------------------------------------------------
     def initialize(app_instance = MmTool::ApplicationMain.shared_application)
+      self.validate_prerequisites
+
+      decorated_list = MmTool.encoder_list.map{|s| C.bold(s)}.join(', ')
+      USER_DEFAULTS[:encoder][:help_desc].gsub!('ENCODER_LIST', decorated_list)
+
       @application = app_instance
       @defaults = MmUserDefaults.shared_user_defaults
       @defaults.register_defaults(with_hash: USER_DEFAULTS)
@@ -58,10 +63,10 @@ module MmTool
     #------------------------------------------------------------
     #noinspection RubyResolve
     def validate_prerequisites
-      commands = %w(ffmpeg)
-      codecs   = %w(libx264 libx265 libfdk_aac)
-      task     = TTY::Command.new(printer: :null)
-      success  = true
+      commands        = %w(ffmpeg ffprobe)
+      codecs_required = %w(libx264 libx265 libfdk_aac)
+      task            = TTY::Command.new(printer: :null)
+      success         = true
 
       # We'll check everything in items before failing, so that we can provide
       # a comprehensive list to the user. No one wants to see what's missing
@@ -74,17 +79,17 @@ module MmTool
       end
       exit 1 unless success
 
-      # Now we'll make sure that all of the codecs that we're interested in
-      # are installed as part of ffmpeg. This is necessary because not every
-      # binary distribution supports non-free.
+      # Now we'll make sure that all of the required codecs are installed as part of ffmpeg.
+      # This is necessary because not every binary distribution supports non-free.
 
       # Again, we'll check them all before failing in order to list everything.
-      codecs.each do |codec|
+      codecs_required.each do |codec|
         result = task.run!("ffprobe -v quiet -codecs | grep #{codec}")
         OutputHelper.print_error("Error: ffmpeg was built without support for the #{C.bold(codec)} codec, which is required.") if result.failure?
         success = success && result.success?
       end
       exit 1 unless success
+
     end
 
     #------------------------------------------------------------
@@ -271,6 +276,9 @@ module MmTool
         when '--fix-undefined-language'
           @defaults[:fix_undefined_language] = true
 
+        when '--encoder'
+          @defaults[:encoder] = validate_encoder_value(args[0], args[1])
+
           #-----------------------
           # Quality
           #-----------------------
@@ -328,6 +336,23 @@ module MmTool
       value
     end
 
+    #------------------------------------------------------------
+    # Perform a really simple validation of the given value for
+    # the given argument, returning the value if successful.
+    # ------------------------------------------------------------
+    #noinspection RubyResolve
+    def validate_encoder_value(arg, value)
+      if !value
+        OutputHelper.print_error_and_exit("Error: option #{C.bold(arg)} was specified, but no value was given.")
+      elsif value =~ /^-.*$/
+        OutputHelper.print_error_and_exit("Error: option #{C.bold(arg)} was specified, but the value #{C.bold(value)} looks like another option argument.")
+      end
+      unless MmTool.encoder_list.include?(value)
+        OutputHelper.print_error_and_exit("Error: Unknown encoder #{C.bold(value)} specified for option #{C.bold(arg)}. Use #{C.bold(File.basename($0) << '--help')} for supported encoders.")
+      end
+      value
+    end
+
   end # class
 
 end # module

data/lib/mm_tool/user_defaults.rb

@@ -356,6 +356,22 @@ module MmTool
           HEREDOC
       },
 
+      :encoder => {
+        :default    => 'auto',
+        :value      => nil,
+        :arg_short  => nil,
+        :arg_long   => '--encoder',
+        :arg_format => nil,
+        :item_label => 'Specify Non-default Encoder',
+        :help_group => 'Transcoding Options',
+        :help_desc  => <<~HEREDOC
+                You can use #{C.bold('--encoder')} to specify the encoder to use when mm_tool determines that
+                transcoding should take place. Use one of ENCODER_LIST, or #{C.bold('auto')}. The default is
+                #{C.bold('%s')}. Note that #{C.bold('auto')} will choose #{C.bold('libx264')} or
+                #{C.bold('libx265')}, depending on the value of #{C.bold('--codecs-video-preferred')}.
+        HEREDOC
+      },
+
       #----------------------------
       # Quality Options
       #----------------------------

data/lib/mm_tool/version.rb

@@ -1,3 +1,3 @@
 module MmTool
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mm_tool
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Jim Derry
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-07 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-table
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Curate your movie files.