mm_tool 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb195a344b506ce9706580970d5e8db8843bf53b537161d63577dc84577089dc
+  data.tar.gz: b06f0eff5f6b0aeddd08b5ac1792d9cdf0869df5babab29fb771f9d3fac28e9d
+SHA512:
+  metadata.gz: a68290286f7db0bbcf5a0440c22ad3a213224439530c73280e70426fc52601a2d52d9c9dac278c7558de9b06317b8e284aae78ca6031b7b74f56f3b699c5823c
+  data.tar.gz: 769b79d23c56d70d9bbf4fa857629bad1376e332e7b6c87280a86d7d21dd0c54fe029c222a000dd7861c7aa764988372f81fc4e2dc754de3110bd79dd8a0bcb6

data/.gitattributes

@@ -0,0 +1,4 @@
+*.html linguist-documentation
+*.css linguist-documentation
+*.erb linguist-documentation
+*.js linguist-documentation

data/.gitignore

@@ -0,0 +1,24 @@
+# Rubymine noise
+.idea/
+
+# BBedit noise
+*.bbprojectd
+
+# Mac OS X noise
+.DS_Store
+
+# Ignore bundler lock files
+Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore build folders
+build/*
+
+# Yard cruft
+/doc/
+/.yardoc
+
+# Aruba
+/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License
+===============
+
+Copyright (c) 2020 Jim Derry
+
+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.md

@@ -0,0 +1,15 @@
+mm_tool, a multimedia tool
+==========================
+[![Gem Version](https://badge.fury.io/rb/mm_tool_.svg)](https://badge.fury.io/rb/mm_tool_)
+
+
+# About
+
+tbd
+
+
+# Change log
+
+- 0.1.0
+
+  - Initial release.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mm_tool"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/mm_tool

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+#=============================================================================
+# This module consolidates all of the classes the make up a complete MmTool
+# application, and is spread throughout several files based mostly on the
+# classes they contain.
+#=============================================================================
+module MmTool
+  require_relative '../lib/mm_tool'
+end
+
+
+#=============================================================================
+# Main
+#=============================================================================
+
+cli = MmTool::MmToolCli.new(MmTool::ApplicationMain.shared_application)
+cli.validate_prerequisites
+cli.run(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mm_tool.rb

@@ -0,0 +1,21 @@
+# Setup our load paths
+libdir = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "mm_tool/output_helper"
+require "mm_tool/user_defaults"
+require "mm_tool/version"
+
+require "mm_tool/application_main"
+require "mm_tool/mm_tool_cli"
+
+require 'mm_tool/mm_movie'
+require 'mm_tool/mm_movie_stream'
+
+require 'mm_tool/mm_movie_ignore_list'
+require "mm_tool/mm_user_defaults"
+
+module MmTool
+  class Error < StandardError
+  end
+end

data/lib/mm_tool/application_main.rb

@@ -0,0 +1,172 @@
+module MmTool
+
+  #=============================================================================
+  # The main application.
+  #=============================================================================
+  class ApplicationMain
+
+    require 'mm_tool.rb'
+
+    #------------------------------------------------------------
+    # Attributes
+    #------------------------------------------------------------
+    attr_accessor :tempfile
+
+    #------------------------------------------------------------
+    # Initialize
+    #------------------------------------------------------------
+    def initialize
+      @tempfile = nil
+      @defaults = MmUserDefaults.shared_user_defaults
+    end
+
+    #------------------------------------------------------------
+    # Singleton accessor
+    #------------------------------------------------------------
+    def self.shared_application
+      unless @self
+        @self = self.new
+      end
+      @self
+    end
+
+    #------------------------------------------------------------
+    # Output a message to the screen, and if applicable, to
+    # the temporary file for later opening.
+    #------------------------------------------------------------
+    def output(message, command = false)
+      puts message
+      if @tempfile
+        if command
+          message = message + "\n"
+        else
+          message = message.lines.collect {|line| "# #{line}"}.join + "\n"
+        end
+        @tempfile&.write(message)
+      end
+    end
+
+    #------------------------------------------------------------
+    # Return the transcode file header.
+    #------------------------------------------------------------
+    def transcode_script_header
+      <<~HEREDOC
+        #!/bin/sh
+
+        # Check this file, make any changes, and save it. It will be executed as soon
+        # as you close it. By default, this script will exit per the exit command
+        # below. Please further confirm that you wish to proceed with the proposed
+        # actions by commenting or removing the line below.
+        
+        exit 1
+
+      HEREDOC
+    end
+
+    #------------------------------------------------------------
+    # Return the report header.
+    #------------------------------------------------------------
+    #noinspection RubyResolve
+    def information_header
+      info_table_src = TTY::Table.new
+      @defaults.label_value_pairs.each {|pair| info_table_src << pair}
+      info_table_src << ["Disposition Columns:", MmMovie.dispositions.join(', ')]
+      info_table_src << ["Transcode File Location:", self.tempfile ? tempfile&.path : 'n/a']
+
+      info_table = C.bold("Looking for file(s) and processing them with the following options:\n")
+      info_table << info_table_src.render(:basic) do |renderer|
+        a = @defaults.label_value_pairs.map {|p| p[0].length }.max + 1
+        b = OutputHelper.console_width - a - 2
+        renderer.alignments    = [:right, :left]
+        renderer.multiline     = true
+        renderer.column_widths = [a,b]
+      end << "\n\n"
+    end
+
+    #------------------------------------------------------------
+    # The main run loop, to be run for each file.
+    #------------------------------------------------------------
+    def run_loop(file_name)
+
+      if @defaults[:ignore_files]
+        MmMovieIgnoreList.shared_ignore_list.add(path: file_name)
+        output("Note: added #{file_name} to the list of files to be ignored.")
+      elsif @defaults[:unignore_files]
+        MmMovieIgnoreList.shared_ignore_list.remove(path: file_name)
+        output("Note: removed #{file_name} to the list of files to be ignored.")
+      else
+        @file_count[:processed] = @file_count[:processed] + 1
+        movie = MmMovie.new(with_file: file_name)
+        a = movie.interesting?
+        b = MmMovieIgnoreList.shared_ignore_list.include?(file_name)
+        c = movie.low_quality?
+        s = @defaults[:scan_type]&.to_sym
+
+        if (s == :normal && a && !b && !c) ||
+            (s == :all && !b) ||
+            (s == :flagged && b) ||
+            (s == :quality && c ) ||
+            (s == :force)
+
+          @file_count[:displayed] = @file_count[:displayed] + 1
+          output(file_name)
+          output(movie.format_table)
+          output(movie.stream_table)
+          output("#{movie.command_rename} ; \\", true)
+          output("#{movie.command_transcode} ; \\", true)
+          output(movie.command_review_post, true)
+          output("\n\n", true)
+        end
+      end # if
+    end
+
+    #------------------------------------------------------------
+    # Run the application with the given file/directory.
+    #------------------------------------------------------------
+    def run(file_or_dir)
+
+      @file_count = { :processed => 0, :displayed => 0 }
+
+      if @defaults[:transcode]
+        @tempfile = Tempfile.create(['mm_tool-', '.sh'])
+        @tempfile&.write(transcode_script_header)
+        # @tempfile.flush
+      end
+
+      if @defaults[:info_header]
+        output information_header
+      end
+
+      if File.file?(file_or_dir)
+
+        original_scan_type = @defaults[:scan_type]
+        @defaults[:scan_type] = :force
+        run_loop(file_or_dir)
+        @defaults[:scan_type] = original_scan_type
+
+      elsif File.directory?(file_or_dir)
+
+        extensions = @defaults[:container_files]&.join(',')
+        Dir.chdir(file_or_dir) do
+          Dir.glob("**/*.{#{extensions}}").map {|path| File.expand_path(path) }.sort.each do |file|
+            run_loop(file)
+          end
+        end
+
+      else
+        output "Error: Execution should never have reached this point."
+        exit 1
+      end
+
+      output("#{File.basename($0)} processed #{@file_count[:processed]} files and displayed data for #{@file_count[:displayed]} of them.")
+
+    ensure
+      if @tempfile
+        @tempfile&.close
+        # @tempfile.unlink
+      end
+    end # run
+
+  end # class
+
+end # module

data/lib/mm_tool/mm_movie.rb

@@ -0,0 +1,217 @@
+module MmTool
+
+  #=============================================================================
+  # A movie as a self contained class. Instances of this class consist of
+  # one or more MmMovieStream instances, and contains intelligence about itself
+  # so that it can provide commands to ffmpeg and/or mkvpropedit as required.
+  # Upon creation it must be provided with a filename.
+  #=============================================================================
+  class MmMovie
+
+    require 'streamio-ffmpeg'
+    require 'tty-table'
+    require 'bytesize'
+
+    #------------------------------------------------------------
+    # This class method returns the known dispositions supported
+    # by ffmpeg. This array also reflects the output orders in
+    # the dispositions table field. Not combining them would
+    # result in a too-long table row.
+    #------------------------------------------------------------
+    def self.dispositions
+      %i(default dub original comment lyrics karaoke forced hearing_impaired visual_impaired clean_effects attached_pic timed_thumbnails)
+    end
+
+    #------------------------------------------------------------
+    # Initialize
+    #------------------------------------------------------------
+    def initialize(with_file:)
+      @defaults        = MmUserDefaults.shared_user_defaults
+      @streams         = MmMovieStream::streams(with_files: all_paths(with_file: with_file))
+      @format_metadata = FFMPEG::Movie.new(with_file).metadata[:format]
+    end
+
+    #------------------------------------------------------------
+    # Get the file-level 'duration' metadata.
+    #------------------------------------------------------------
+    def format_duration
+      seconds = @format_metadata[:duration]
+      seconds ? Time.at(seconds.to_i).utc.strftime("%H:%M:%S") : nil
+    end
+
+    #------------------------------------------------------------
+    # Get the file-level 'size' metadata.
+    #------------------------------------------------------------
+    def format_size
+      size = @format_metadata[:size]
+      size ? ByteSize.new(size) : 'unknown'
+    end
+
+    #------------------------------------------------------------
+    # Get the file-level 'title' metadata.
+    #------------------------------------------------------------
+    def format_title
+      @format_metadata&.dig(:tags, :title)
+    end
+
+    #------------------------------------------------------------
+    # Indicates whether any of the streams are of a lower
+    # quality than desired by the user.
+    #------------------------------------------------------------
+    def low_quality?
+      @streams.count {|stream| stream.low_quality?} > 0
+    end
+
+    #------------------------------------------------------------
+    # Indicates whether any of the streams are interesting.
+    #------------------------------------------------------------
+    def interesting?
+      @streams.count {|stream| stream.interesting?} > 0 || format_title
+    end
+
+    #------------------------------------------------------------
+    # Get the rendered text of the format_table.
+    #------------------------------------------------------------
+    def format_table
+      unless @format_table
+        @format_table = format_table_datasource.render(:basic) do |renderer|
+          renderer.column_widths = [10,10, 160]
+          renderer.multiline     = true
+          renderer.padding       = [0,1]
+          renderer.width         = 1000
+        end
+      end
+      @format_table
+    end
+
+    #------------------------------------------------------------
+    # For the given table, get the rendered text of the table
+    # for output.
+    #------------------------------------------------------------
+    def stream_table
+      unless @stream_table
+        @stream_table = stream_table_datasource.render(:unicode) do |renderer|
+          renderer.alignments    = [:center, :left, :left, :right, :right, :left, :left, :left, :left]
+          renderer.column_widths = [5,10,10,5,10,5,23,50,35]
+          renderer.multiline     = true
+          renderer.padding       = [0,1]
+          renderer.width         = 1000
+        end # do
+      end
+      @stream_table
+    end
+
+    #------------------------------------------------------------
+    # The complete command to rename the main input file to
+    # include a tag indicating that it's the original.
+    #------------------------------------------------------------
+    def command_rename
+      src = @streams[0].source_file
+      dst = File.join(File.dirname(src), File.basename(src, '.*') + @defaults[:suffix] + File.extname(src))
+      "mv \"#{src}\" \"#{dst}\""
+    end
+
+    #------------------------------------------------------------
+    # The complete, proposed ffmpeg command to transcode the
+    # input file to an output file. It uses the 'new_input_path'
+    # as the input file.
+    #------------------------------------------------------------
+    def command_transcode
+      command = ["ffmpeg \\"]
+      @streams.each {|stream| command |= ["   #{stream.instruction_input}"] if stream.instruction_input }
+      @streams.each {|stream| command << "   #{stream.instruction_map}" if stream.instruction_map }
+      @streams.each {|stream| command << "   #{stream.instruction_action}" if stream.instruction_action }
+      @streams.each {|stream| command << "   #{stream.instruction_disposition}" if stream.instruction_disposition }
+      @streams.each {|stream| command << "   #{stream.instruction_metadata}" if stream.instruction_metadata }
+      command << "   -metadata title=\"#{format_title}\" \\" if format_title
+      command << "   \"#{output_path}\""
+      command.join("\n")
+    end
+
+    #------------------------------------------------------------
+    # The complete command to view the output file after
+    # running the transcode command
+    #------------------------------------------------------------
+    def command_review_post
+      "\"#{$0}\" --no-use-external-subs \"#{output_path}\""
+    end
+
+
+    #============================================================
+     private
+    #============================================================
+
+    #------------------------------------------------------------
+    # Given the initial file, return an array of the initial
+    # file and associated SRTs, which are valid if they have
+    # no language, or a language specified in options.
+    #------------------------------------------------------------
+    def all_paths(with_file:)
+      all_paths = [with_file]
+      if @defaults[:use_external_subs]
+        base_path = File.join(File.dirname(with_file), File.basename(with_file, '.*'))
+        all_paths |= ([""] | @defaults[:keep_langs_subs]&.map {|lang| ".#{lang}" })
+                         .select {|lang| File.file?("#{base_path}#{lang}.srt")}
+                         .map {|lang| "#{base_path}#{lang}.srt"}
+      end
+      all_paths
+    end
+
+    #------------------------------------------------------------
+    # The name of the proposed output file, if different from
+    # the input file. This would be set in the event that the
+    # container of the input file is not one of the approved
+    # containers.
+    #------------------------------------------------------------
+    def output_path
+      path = @streams[0].source_file
+      if @defaults[:containers_preferred]&.include?(File.extname(path))
+        path
+      else
+        File.join(File.dirname(path), File.basename(path, '.*') + '.' + @defaults[:containers_preferred][0])
+      end
+    end
+
+    #------------------------------------------------------------
+    # Return a TTY::Table of the relevant format data.
+    #------------------------------------------------------------
+    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]
+      end
+      @format_table
+    end
+
+    #------------------------------------------------------------
+    # Return a TTY::Table of the movie, populated with the
+    # pertinent data of each stream.
+    #------------------------------------------------------------
+    def stream_table_datasource
+      unless @table
+        # Ensure that when we add the headers, they specifically are left-aligned.
+        headers = %w(index codec type w/# h/layout lang disposition title action(s))
+                      .map { |header| {:value => header, :alignment => :left} }
+
+        @table = TTY::Table.new(header: headers)
+
+        @streams.each do |stream|
+          row = []
+          row << stream.input_specifier
+          row << stream.codec_name
+          row << stream.codec_type
+          row << stream.quality_01
+          row << stream.quality_02
+          row << stream.language
+          row << stream.dispositions
+          row << stream.title
+          row << stream.action_label
+          @table << row
+        end
+      end
+      @table
+    end # table
+
+  end # class
+
+end # module