mkv2m4v 0.0.1 → 0.1.1

data/.gitignore

@@ -7,7 +7,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/README.md

@@ -1,6 +1,3 @@
-**This gem is a work in progress.** Do not expect any supported functionality
-until v0.1.0.
-
 # mkv2m4v
 
 Converts audio and video tracks from a MKV (Matroska Media) container into a
@@ -15,12 +12,44 @@ It attempts to pass through as many codecs as possible.
 
 ## Installation
 
-    $ brew install mediainfo
-    $ gem install mkv2m4v
+mkv2m4v is dependent upon `mediainfo`, `mkvextract`, `ffmpeg`, and `MP4Box`.
+
+```bash
+$ brew install mediainfo
+$ brew install gpac
+$ brew install mkvtoolnix
+$ gem install mkv2m4v
+```
+
+_Note: `gpac` includes `MP4Box` and is dependent on `ffmpeg`, so `ffmpeg`
+should install automatically. If not, you should manually install `ffmpeg`:_
+
+```bash
+# ffmpeg should already be installed, but just in case:
+$ brew install ffmpeg --with-tools
+```
 
 ## Usage
 
-    $ mkv2m4v some-video.mkv
+```bash
+$ mkv2m4v some-video.mkv
+```
+
+## Background
+
+I got fed up with the reliability of the conversion tools out there for
+converting MKV video containers to Apple TV compatible videos. Many of the
+existing tools appear to have potential on the surface, but they fail under
+certain scenarios.
+
+[Handbrake](http://handbrake.fr/) is still the most realiable existing tool
+out there, but it re-encodes h.264 video tracks, which is not ideal and very
+slow.
+
+The goal is to get a better, more automated tool to accomplish the task of
+generating Apple TV compatible videos. Nothing more. It should generate an M4V
+media file with the best possible quality given the original source and the
+defaults should require no additional human interaction.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,10 @@
+require "rake/testtask"
 require "bundler/gem_tasks"
+
+desc "Default: run unit tests."
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib" << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/doc/notes.md

@@ -0,0 +1,26 @@
+Extracting tracks from an mkv (assuming correct track numbers):
+
+    $ mediainfo example.mkv # Inspect track IDs
+    $ mkvextract tracks example.mkv 1:example.h264 2:example.dts
+
+Converting dts to ac3:
+
+    $ ffmpeg -i example.dts -acodec ac3 -ac 6 -ab 640k example-6ch.ac3
+
+Converting dts to aac:
+
+    $ ffmpeg -i example.dts -acodec libfaac -ac 2 -ab 160k example-2ch.aac
+
+Converting ac3 to aac:
+
+    $ ffmpeg -i example.ac3 -acodec libfaac -ac 2 -ab 160k example-2ch.aac
+
+Remux the tracks into an M4V container. For Apple TV surround sound support,
+the audio tracks must be in the same group with all but the first AAC track
+disabled. [[source](http://forum.doom9.org/archive/index.php/t-160302.html)]
+
+    $ MP4Box \
+      -add example.h264:lang=en:name="AVC Video" \
+      -add example-2ch.aac:lang=en:group=1:delay=84:name="Stereo" \
+      -add example-6ch.ac3:lang=en:group=1:delay=84:disable:name="AC3" \
+      -new example_testing.m4v

data/lib/mkv2m4v/file.rb

@@ -0,0 +1,80 @@
+require "mkv2m4v/track"
+require "mkv2m4v/track_ranker"
+require "mkv2m4v/transcoder"
+require "mediainfo"
+require "forwardable"
+require "iso639"
+require "colorize"
+
+module Mkv2m4v
+  class File
+    extend Forwardable
+
+    attr_reader :info, :video_tracks, :audio_tracks, :text_tracks
+    attr_reader :ideal_video_track, :ideal_audio_track
+    def_delegator :info, :filename, :name
+    def_delegator :info, :full_filename, :filename
+
+    def initialize(filename, options = {})
+      @info = Mediainfo.new(filename)
+      @options = options
+      @languages = @options[:languages]
+      init_tracks
+    end
+
+    def format
+      info.general.format
+    end
+
+    def print
+      puts "#{format}: #{name}".black.on_yellow
+      video_tracks.filter.each(&:print) if @options[:verbose]
+      audio_tracks.filter.each(&:print) if @options[:verbose]
+      text_tracks.filter.each(&:print)  if @options[:verbose]
+      print_ideal_tracks
+      puts
+    end
+
+    def transcode
+      puts "#{format}: #{name}".black.on_yellow
+      Transcoder.new(self, @options).run
+      puts
+    end
+
+    def self.each(filenames, options = {})
+      filenames.each do |filename|
+        if ::File.exists?(filename)
+          yield new(filename, options)
+        else
+          $stderr.puts "#{filename} does not exist."
+        end
+      end
+    end
+
+    private
+
+    def print_ideal_tracks
+      puts "==> Ideal video track"
+      @ideal_video_track.print
+      puts "==> Ideal audio track"
+      @ideal_audio_track.print
+    end
+
+    def init_tracks
+      @video_tracks = tracks_by_type(:video)
+      @audio_tracks = tracks_by_type(:audio)
+      @text_tracks  = tracks_by_type(:text)
+
+      @ideal_video_track = video_tracks.filter.rank.first
+      @ideal_audio_track = audio_tracks.filter.rank.first
+    end
+
+    def tracks_by_type(type)
+      info_tracks = info.send(type)
+      tracks = info_tracks.count.times.map do |i|
+        Mkv2m4v.const_get("#{type.capitalize}Track").new(info_tracks[i])
+      end
+      Mkv2m4v.const_get("#{type.capitalize}Ranker").new(tracks, @options)
+    end
+  end
+end

data/lib/mkv2m4v/track.rb

@@ -0,0 +1,86 @@
+require "forwardable"
+
+module Mkv2m4v
+  class Track
+    extend Forwardable
+
+    attr_reader :info
+    def_delegator :info, :stream_id, :id
+    def_delegators :info, :format
+
+    def initialize(track_info)
+      @info = track_info
+    end
+
+    def language
+      Iso639[info["language"]]
+    end
+
+    def title
+      info["title"]
+    end
+
+    def format_description
+      "#{format} (#{info.format_info}, #{info.codec_id})"
+    end
+  end
+
+  class VideoTrack < Track
+    def_delegators :info, :frame_size, :interlaced?, :fps, :width, :height
+
+    def resolution
+      "#{frame_size}#{interlaced? ? "i" : "p"}"
+    end
+
+    def print
+      puts "Track #{id}: (video)"
+      puts "  Format:     #{format_description}"
+      puts "  Resolution: #{resolution}"
+      puts "  FPS:        #{fps}"
+      puts "  Language:   #{language}"
+      puts "  Title:      #{title}"
+    end
+  end
+
+  class AudioTrack < Track
+    def_delegators :info, :bit_rate
+
+    def channel_count
+      info.channels.to_s.chars.first.to_i
+    end
+
+    def bit_rate_kbps
+      info.bit_rate.gsub(/\D/, "").to_i if info.bit_rate
+    end
+
+    def channel_description
+      "#{channel_count} (#{info.channel_positions})"
+    end
+
+    def bit_rate_description
+      "#{bit_rate_kbps}k (#{info.bit_rate_mode})"
+    end
+
+    def print
+      puts "Track #{id}: (audio)"
+      puts "  Format:     #{format_description}"
+      puts "  Channels:   #{channel_description}"
+      puts "  Bit rate:   #{bit_rate_description}"
+      puts "  Language:   #{language}"
+      puts "  Title:      #{title}"
+    end
+  end
+
+  class TextTrack < Track
+    def format_description
+      "#{format} (#{info.codec_id})"
+    end
+
+    def print
+      puts "Track #{id}: (text)"
+      puts "  Format:     #{format_description}"
+      puts "  Language:   #{language}"
+      puts "  Title:      #{title}"
+    end
+  end
+end

data/lib/mkv2m4v/track_ranker.rb

@@ -0,0 +1,64 @@
+require "forwardable"
+
+module Mkv2m4v
+  class TrackRanker
+    extend Forwardable
+
+    def_delegators :@tracks, :each, :first
+
+    def initialize(tracks, options = {})
+      @tracks = tracks
+      @options = options
+    end
+
+    def filter
+      filtered_tracks = @tracks.select { |t| language_okay?(t) }
+      self.class.new(filtered_tracks, @options)
+    end
+
+    def rank
+      ranked_tracks = @tracks.sort_by { |t| score(t) }.reverse
+      self.class.new(ranked_tracks, @options)
+    end
+
+    protected
+
+    def language_match?(track)
+      @options.languages.include?(track.language)
+    end
+
+    def language_okay?(track)
+      track.language.nil? ||
+        @options.languages.empty? ||
+        language_match?(track)
+    end
+  end
+
+  class VideoRanker < TrackRanker
+    def score(track)
+      score = 0
+      score += 8 if track.format == "AVC"
+      score += (track.height || 0)/ 1080.0 * 4.0
+      score += 2 if language_match?(track)
+      score
+    end
+  end
+
+  class AudioRanker < TrackRanker
+    def score(track)
+      score = 0
+      score += 4 if ["DTS", "AC-3"].include?(track.format)
+      score += 2 if track.format == "AAC"
+      score += (track.channel_count || 0) / 8.0 * 2.0
+      score += (track.bit_rate_kbps || 0) / 1500.0 * 2.0
+      score += 4 if language_match?(track)
+      score
+    end
+  end
+
+  class TextRanker < TrackRanker
+    # scoring not implemented yet
+    # def score(track)
+    # end
+  end
+end

data/lib/mkv2m4v/transcoder.rb

@@ -0,0 +1,141 @@
+require "fileutils"
+require "colorize"
+
+module Mkv2m4v
+  class Transcoder
+    def initialize(file, options = {})
+      @file = file
+      @options = options
+    end
+
+    def run
+      setup
+      extract
+      transcode_avc
+      transcode_aac
+      transcode_ac3
+      remux
+      cleanup
+    end
+
+    private
+
+    def setup
+      FileUtils.mkdir_p tmp_dir
+    end
+
+    def extract
+      puts "==> Extracting #{video_id}:video.#{video_ext} #{audio_id}:audio.#{audio_ext} ".magenta
+      system "mkvextract tracks #{@file.filename.inspect} #{video_id}:#{video_file} #{audio_id}:#{audio_file}"
+    end
+
+    def transcode_avc
+      if video_format == "AVC"
+        puts "==> Assuming pass through for h.264 video track".yellow.on_black
+      else
+        puts "==> ERROR: Wrong Video format".white.on_red
+      end
+    end
+
+    def transcode_aac
+      if audio_format == "AAC"
+        puts "==> Assuming pass through for AAC audio track".yellow.on_black
+      else
+        puts "==> Transcoding #{audio_format} to Stereo AAC audio track".magenta
+        system "ffmpeg -i #{audio_file.inspect} -acodec libfaac -ac 2 -ab 160k #{audio_basename}.aac"
+      end
+    end
+
+    def transcode_ac3
+      if audio_format == "AC-3"
+        puts "==> Assuming pass through for AC-3 audio track".yellow.on_black
+      elsif audio_format == "AAC"
+        puts "==> Skipping AC-3 surround audio track".yellow.on_black
+        @skip_ac3 = true
+      else
+        puts "==> Transcoding #{audio_format} to Surround AC-3 audio track".magenta
+        system "ffmpeg -i #{audio_file.inspect} -acodec ac3 -ac #{max_audio_channels} -ab #{max_audio_bit_rate}k #{audio_basename}.ac3"
+      end
+    end
+
+    def remux
+      puts "==> Remuxing everything into an M4V container".magenta
+      command = "MP4Box"
+      command << " -add #{video_basename.inspect}.h264:lang=en:name=\"AVC Video\" "
+      command << " -add #{audio_basename.inspect}.aac:lang=en:group=1:delay=84:name=\"Stereo\" "
+      unless @skip_ac3
+        command << " -add #{audio_basename.inspect}.ac3:lang=en:group=1:delay=84:disable:name=\"AC3\" "
+      end
+      command << " -new #{m4v_file.inspect}"
+      system command
+    end
+
+    def cleanup
+      FileUtils.rm_rf tmp_dir
+    end
+
+    def video_basename
+      ::File.join(tmp_dir, "video")
+    end
+
+    def video_file
+      [video_basename, video_ext].join(".")
+    end
+
+    def video_id
+      @file.ideal_video_track.id
+    end
+
+    def video_format
+      @file.ideal_video_track.format
+    end
+
+    def video_ext
+      if video_format == "AVC"
+        "h264"
+      else
+        video_format.gsub(/\W/, "").downcase
+      end
+    end
+
+    def audio_basename
+      ::File.join(tmp_dir, "audio")
+    end
+
+    def audio_file
+      [audio_basename, audio_ext].join(".")
+    end
+
+    def audio_id
+      @file.ideal_audio_track.id
+    end
+
+    def audio_format
+      @file.ideal_audio_track.format
+    end
+
+    def audio_ext
+      audio_format.gsub(/\W/, "").downcase
+    end
+
+    def max_audio_channels
+      [@file.ideal_audio_track.channel_count, 6].min
+    end
+
+    def max_audio_bit_rate
+      [@file.ideal_audio_track.bit_rate_kbps, 640].min
+    end
+
+    def dir
+      @options[:dir] || ::File.dirname(@file.filename)
+    end
+
+    def tmp_dir
+      ::File.join(dir, ::File.basename(@file.name, ".*") + "-tracks")
+    end
+
+    def m4v_file
+      ::File.join(dir, ::File.basename(@file.name, ".*") + ".m4v")
+    end
+  end
+end

data/lib/mkv2m4v/version.rb

@@ -1,5 +1,5 @@
 module Mkv2m4v
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 
   VersionDescription = "mkv2m4v #{VERSION} (c) 2012 Ryan McGeary"
   Description = <<EOS

data/lib/mkv2m4v.rb

@@ -1,5 +1,5 @@
 require "mkv2m4v/version"
-require "mkv2m4v/mediainfo"
+require "mkv2m4v/file"
 require "trollop"
 
 module Mkv2m4v
@@ -10,56 +10,17 @@ module Mkv2m4v
 
     def run
       if @options[:info]
-        print_info
+        each_file(&:print)
       else
-        convert_files
+        each_file(&:transcode)
       end
     end
 
     private
 
-    def convert_files
-      $stderr.puts "Converting files is not yet supported. For now, try the --info option."
-      # each_file do |file|
-      # end
-    end
-
-    def print_info
-      each_file do |file|
-        info = Mediainfo.new file
-        puts "#{info.general.format}: #{file}"
-        info.video.count.times do |i|
-          print_video_track(info.video[i])
-        end
-        info.audio.count.times do |i|
-          print_audio_track(info.audio[i])
-        end
-        puts
-      end
-    end
-
-    def print_video_track(video)
-      puts "Video Track #{video.stream_id}:"
-      puts "  Format: #{video.format} (#{video.format_info}, #{video.codec_id})"
-      puts "  Resolution: #{video.frame_size}#{video.interlaced? ? "i" : "p"}"
-      puts "  FPS: #{video.fps}"
-      puts "  Language: #{video.language}"
-    end
-
-    def print_audio_track(audio)
-      puts "Audio Track #{audio.stream_id}:"
-      puts "  Format: #{audio.format} (#{audio.format_info}, #{audio.codec_id})"
-      puts "  Channels: #{audio.channel_count} (#{audio.channel_positions})"
-      puts "  Language: #{audio.language}"
-    end
-
     def each_file
-      ARGV.each do |file|
-        if File.exists?(file)
-          yield file
-        else
-          $stderr.puts "#{file} does not exist."
-        end
+      Mkv2m4v::File.each(@filenames, @options) do |file|
+        yield file
       end
     end
 
@@ -69,7 +30,12 @@ module Mkv2m4v
         version Mkv2m4v::VersionDescription
         banner [Mkv2m4v::Description, Mkv2m4v::Usage].join("\n")
         opt :info, "Print media info only"
+        opt :lang, "Preferred languages", :type => :strings, :default => ["English"]
+        opt :dir, "Destination directory", :type => :string
+        opt :verbose, "More output", :type => :boolean
       end
+      @options[:languages] = @options[:lang].map { |lang| Iso639[lang] }.compact
+      @filenames = ARGV
     end
   end
 end

data/mkv2m4v.gemspec

@@ -17,6 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency("trollop", "~> 2.0")
-  gem.add_dependency("mediainfo", "~> 0.7")
+  gem.add_dependency "trollop",   "~> 2.0"
+  gem.add_dependency "mediainfo", "~> 0.7"
+  gem.add_dependency "iso639",    "~> 1.0", ">= 1.0.5"
+  gem.add_dependency "colorize",  "~> 0.5"
+
+  gem.add_development_dependency "minitest",       "~> 4.3"
+  gem.add_development_dependency "rake",           "~> 10.0"
 end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "minitest/pride"

metadata

@@ -2,14 +2,14 @@
 name: mkv2m4v
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryan McGeary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2012-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,6 +43,76 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.7'
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+    none: false
+  name: iso639
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    none: false
+  name: colorize
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    none: false
+  name: minitest
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    none: false
+  name: rake
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    none: false
 description: ! 'mkv2m4v is a command line utility that converts audio and video tracks
   from a
 
@@ -62,10 +132,15 @@ files:
 - README.md
 - Rakefile
 - bin/mkv2m4v
+- doc/notes.md
 - lib/mkv2m4v.rb
-- lib/mkv2m4v/mediainfo.rb
+- lib/mkv2m4v/file.rb
+- lib/mkv2m4v/track.rb
+- lib/mkv2m4v/track_ranker.rb
+- lib/mkv2m4v/transcoder.rb
 - lib/mkv2m4v/version.rb
 - mkv2m4v.gemspec
+- test/test_helper.rb
 homepage: https://github.com/rmm5t/mkv2m4v
 licenses: []
 post_install_message: 
@@ -90,4 +165,5 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Makes Apple TV compatible videos
-test_files: []
+test_files:
+- test/test_helper.rb

data/lib/mkv2m4v/mediainfo.rb

@@ -1,13 +0,0 @@
-require "mediainfo"
-
-class Mediainfo::Stream
-  def language
-    self["language"]
-  end
-end
-
-class Mediainfo::AudioStream
-  def channel_count
-    channels.to_s.chars.first.to_i
-  end
-end