mkv 0.0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.0.1
+------
+* Mac OSX implementation

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Pedro Rodrigues
+
+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,70 @@
+MKV
+===
+
+Simple wrapper around MKVToolNix's mkvinfo utility to get data from MKV movies, and mkvextract to extract subtitles.
+
+Installation
+------------
+
+    (sudo) gem install mkv
+
+This version is tested against MKVToolNix 5.8.0 build 2012-09-02-6920. So no guarantees with earlier versions.
+
+Usage
+-----
+
+### Require the gem
+
+``` ruby
+require 'rubygems'
+require 'mkv'
+```
+
+### Reading Metadata
+
+``` ruby
+movie = MKV::Movie.new("path/to/movie.mkv")
+
+track = movie.tracks.first # Contains all streams
+
+track.type # video, audio, or subtitles
+track.uid 
+track.number
+track.mkv_info_id
+track.lacing 
+track.codec_id
+
+# For video tracks
+track.width 
+track.height
+
+# For audio
+track.sampling_frequency
+track.channels
+
+# For subtitle & audio tracks
+track.language # ISO 639-3
+track.enabled
+track.default
+track.forced
+
+```
+
+Specify the path to mkvinfo and mkvextract
+--------------------------
+
+By default, streamio assumes that the mkvinfo and mkvextract binaries are available in the default installation paths:
+
+On Mac OSX:
+``` ruby
+MKV.mkvinfo_binary = "/Applications/Mkvtoolnix.app/Contents/MacOS/mkvinfo"
+MKV.mkvextrack_binary = "/Applications/Mkvtoolnix.app/Contents/MacOS/mkvextract"
+```
+
+On Windows:
+TODO!
+
+Copyright
+---------
+
+Copyright (c) 2012 Pedro Rodrigues. See LICENSE for details.

data/lib/mkv.rb

@@ -0,0 +1,85 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'logger'
+require 'stringio'
+require 'shellwords'
+require 'open3'
+require 'awesome_print'
+
+require 'mkv/version'
+require 'mkv/error'
+require 'mkv/io_patch'
+require 'mkv/movie'
+require 'mkv/track'
+
+module MKV
+  # MKV logs information about its progress when it's transcoding.
+  # Jack in your own logger through this method if you wish to.
+  #
+  # @param [Logger] log your own logger
+  # @return [Logger] the logger you set
+  def self.logger=(log)
+    @logger = log
+  end
+  
+  # Get MKV logger.
+  #
+  # @return [Logger]
+  def self.logger
+    return @logger if @logger
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::INFO
+    @logger = logger
+  end
+
+  # Set the path of the mkvinfo binary.
+  # Can be useful if you need to specify a path such as /usr/local/bin/MKV
+  #
+  # @param [String] path to the mkvinfo binary
+  # @return [String] the path you set
+  def self.mkvinfo_binary=(bin)
+    @mkvinfo_binary = bin
+  end
+
+  # Get the path to the mkvinfo binary, defaulting to an OS-dependent path
+  #
+  # @return [String] the path to the MKV binary
+  def self.mkvinfo_binary
+    @mkvinfo_binary.nil? ? default_mkvinfo_binary : @mkvinfo_binary
+  end
+
+  # Set the path of the mkvextract binary.
+  # Can be useful if you need to specify a path such as /usr/local/bin/MKV
+  #
+  # @param [String] path to the mkvextract binary
+  # @return [String] the path you set
+  def self.mkvextract_binary=(bin)
+    @mkvextract_binary = bin
+  end
+
+  # Get the path to the mkvextract binary, defaulting to an OS-dependent path
+  #
+  # @return [String] the path to the mkvextract binary
+  def self.mkvextract_binary
+    @mkvextract_binary.nil? ? default_mkvextract_binary : @mkvextract_binary
+  end
+
+  private 
+
+    def self.default_mkvinfo_binary
+      if is_macosx?
+        "/Applications/Mkvtoolnix.app/Contents/MacOS/mkvinfo"
+      else
+      end
+    end
+
+    def self.default_mkvextract_binary
+      if is_macosx?
+        "/Applications/Mkvtoolnix.app/Contents/MacOS/mkvextract"
+      else
+      end
+    end
+
+    def self.is_windows? ; RUBY_PLATFORM =~/.*?mingw.*?/i ; end
+    def self.is_macosx? ; RUBY_PLATFORM =~/.*?darwin.*?/i ; end
+end

data/lib/mkv/error.rb

@@ -0,0 +1,4 @@
+module MKV
+  class Error < StandardError
+  end
+end

data/lib/mkv/io_patch.rb

@@ -0,0 +1,59 @@
+if RUBY_VERSION =~ /1\.8/
+  # Useful when `timeout.rb`, which, on M.R.I 1.8, relies on green threads, does not work consistently.
+  begin
+    require 'system_timer'
+    MKV::Timer = SystemTimer
+  rescue LoadError
+    require 'timeout'
+    MKV::Timer = Timeout
+  end
+else
+  require 'timeout'
+  MKV::Timer = Timeout
+end
+
+require 'win32/process' if RUBY_PLATFORM =~ /(win|w)(32|64)$/
+
+#
+# Monkey Patch timeout support into the IO class
+#
+class IO
+  def each_with_timeout(pid, seconds, sep_string=$/)
+    sleeping_queue = Queue.new
+    thread = nil
+
+    timer_set = lambda do
+      thread = new_thread(pid) { MKV::Timer.timeout(seconds) { sleeping_queue.pop } }
+    end
+
+    timer_cancel = lambda do
+      thread.kill if thread rescue nil
+    end
+
+    timer_set.call
+    each(sep_string) do |buffer|
+      timer_cancel.call
+      yield buffer
+      timer_set.call
+    end
+  ensure
+    timer_cancel.call
+  end
+
+  private
+  def new_thread(pid, &block)
+    current_thread = Thread.current
+    Thread.new do
+      begin
+        block.call
+      rescue Exception => e
+        current_thread.raise e
+        if RUBY_PLATFORM =~ /(win|w)(32|64)$/
+          Process.kill(1, pid)
+        else
+          Process.kill('SIGKILL', pid)
+        end
+      end
+    end
+  end
+end

data/lib/mkv/movie.rb

@@ -0,0 +1,79 @@
+require 'time'
+
+module MKV
+  class Movie
+    @@timeout = 200
+
+    attr_reader :path
+    attr_reader :tracks
+
+    def initialize(path)
+      raise Errno::ENOENT, "the file '#{path}' does not exist" unless File.exists?(path)
+      
+      @path = path
+
+      # mkvinfo will output to stdout
+      command = "#{MKV.mkvinfo_binary} #{Shellwords.escape(path)}"
+      MKV.logger.info(command)
+      output = Open3.popen3(command) { |stdin, stdout, stderr| stdout.read}
+
+      match = output.gsub(/\n/, '$$').match /\|\+\ssegment tracks(.*?)\|\+\s(?:chapters|cluster)/i
+      tracks = match[1].gsub(/\$\$/, "\n")
+      match_tracks = tracks.gsub(/\n/, '$$').scan(/a track(.*?)(?:\|\s\+|$)/i)
+      match_tracks = match_tracks.map { |x| x.first.gsub(/\$\$/, "\n") }
+
+      @tracks = match_tracks.map do |track_data|
+        MKV::Track.new track_data
+      end
+      
+      @invalid = true if @tracks.any?
+      @invalid = true if output.include?("is not supported")
+      @invalid = true if output.include?("could not find codec parameters")
+    end
+    
+    def valid?
+      not @invalid
+    end
+
+    def has_subtitles? ; tracks.select { |t| t.type == 'subtitles' }.any? ; end
+    def has_video? ; tracks.select { |t| t.type == 'video' }.any? ; end
+    def has_audio? ; tracks.select { |t| t.type == 'audio' }.any? ; end
+
+    def extract_subtitles(destination_dir)
+      tracks.select { |t| t.type == 'subtitles' }.each do |track|
+        destination_filename = File.basename(@path).gsub(/\.mkv$/i, %Q[.#{track.language}.srt])
+        command = %Q[#{MKV.mkvextract_binary} tracks "#{@path}" #{track.mkv_info_id}:"#{File.join(destination_dir, destination_filename)}"]
+
+        output = ""
+        Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+          begin
+            yield(0.0) if block_given?
+            next_line = Proc.new do |line|
+              output << line
+              if line =~ /(\d+)%/
+                progress = $1.to_i 
+
+                yield(progress) if block_given?
+              end
+
+              if line =~ /Unsupported codec/
+                MKV.logger.error "Failed encoding...\nCommand\n#{command}\nOutput\n#{output}\n"
+                raise "Failed encoding: #{line}"
+              end
+            end
+            
+            if @@timeout
+              stdout.each_with_timeout(wait_thr.pid, @@timeout, "r", &next_line)
+            else
+              stdout.each("r", &next_line)
+            end
+              
+          rescue Timeout::Error => e
+            MKV.logger.error "Process hung...\nCommand\n#{command}\nOutput\n#{output}\n"
+            raise MKV::Error, "Process hung. Full output: #{output}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mkv/track.rb

@@ -0,0 +1,38 @@
+module MKV
+  class Track
+    # Video, Audio & Subtitle
+    attr_reader :type, :uid, :number, :mkv_info_id, :lacing, :codec_id
+    # Video
+    attr_reader :width, :height
+    # Audio
+    attr_reader :sampling_frequency, :channels
+    # Subtitle & Audio
+    attr_reader :language, :enabled, :default, :forced
+
+    def initialize(data)
+      (@number, @mkv_info_id) = data.match(/track number:\s(\d+)\s\(track ID for mkvmerge & mkvextract: (\d+)\)/i)[1..2] 
+      @uid = data.match(/track uid: (\d+)/i)[1]
+      @lacing = data.match(/lacing flag: (\d+)/i)[1] != '0'
+      @type = data.match(/track type: (\w+)/i)[1]
+      @codec_id = data.match(/codec id: (.*)/i)[1]
+
+      if @type == 'video'
+        @width = data.match(/pixel width: (\d+)/i)[1].to_i
+        @height = data.match(/pixel height: (\d+)/i)[1].to_i
+      end
+
+      if @type == 'audio'
+        @sampling_frequency = data.match(/sampling frequency: (\d+)/i)[1].to_i
+        @channels = data.match(/channels: (\d+)/i)[1].to_i
+      end
+
+      if @type == 'audio' || @type == 'subtitles'
+        @language = data.match(/language: (\w+)/i)[1]
+        @enabled = data.match(/enabled: (\d+)/i)[1] != '0'
+        @default = data.match(/default flag: (\d+)/i)[1] != '0'
+        @forced = data.match(/forced flag: (\d+)/i)[1] != '0'
+      end
+    end
+
+  end
+end

data/lib/mkv/version.rb

@@ -0,0 +1,3 @@
+module MKV
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: mkv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pedro Rodrigues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Simple wrapper around MKVToolNix's mkvinfo utility to get data from MKV
+  movies, and mkvextract to extract subtitles.
+email:
+- pedro@bbde.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mkv/error.rb
+- lib/mkv/io_patch.rb
+- lib/mkv/movie.rb
+- lib/mkv/track.rb
+- lib/mkv/version.rb
+- lib/mkv.rb
+- README.md
+- LICENSE
+- CHANGELOG
+homepage: http://github.com/gokuu/mkv
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Reads MKV info.
+test_files: []