mediainfo-simple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 774cc9754389bb59899baaef43c768b00217f574
+  data.tar.gz: d498ba562edaeff68d4a457f81498c7cb5a06469
+SHA512:
+  metadata.gz: 97a7730eb1e19f7ccfccf0e22c763c055cb95b9e4e043da0361ef5da8e752ad35658a39ded36c9f652e0bb5725d2d0a1974da5d6d6a7018834470d0bfa4eb0db
+  data.tar.gz: 50930e665b202f107715d1bb6cb501e5a77f111b9e467ef7540d7ac91f84dd85dc558f3333bae5b5680cce4b42916eefebb08ec5d179d19ee23f6a702d791ee9

data/lib/mediainfo-simple.rb

@@ -0,0 +1,101 @@
+require 'mediainfo-simple/parser'
+require 'mediainfo-simple/stream_factory'
+require 'mediainfo-simple/stream'
+require 'mediainfo-simple/streams/audio'
+require 'mediainfo-simple/streams/video'
+require 'mediainfo-simple/streams/text'
+require 'mediainfo-simple/streams/image'
+require 'mediainfo-simple/streams/general'
+require 'mediainfo-simple/streams/menu'
+require 'mediainfo-simple/streams/other'
+
+
+class MediaInfo
+
+  attr_accessor :streams
+
+  def initialize filename
+    # we check that the file exist
+    raise ArgumentError, "give the filename as a parameter (got nil)" if filename == nil
+    raise ArgumentError, "filename must be a string" if ! filename.is_a? String
+    filename = File.expand_path filename
+    raise ArgumentError, "#{filename} does not exist" if ! File.exist? filename
+    
+    # we parse the file
+    @streams = []
+    MediaInfoParser.new filename, self
+  end
+
+
+  # return true if there is a general stream, false otherwise
+  def general?
+    @streams.any? { |stream| stream.is_a? GeneralStream }
+  end
+
+  # return true if there is a video stream, false otherwise
+  def video?
+    @streams.any? { |stream| stream.is_a? VideoStream }
+  end
+
+  # return true if there is an audio stream, false otherwise
+  def audio?
+    @streams.any? { |stream| stream.is_a? AudioStream }
+  end
+
+  # return true if there is a text stream, false otherwise
+  def text?
+    @streams.any? { |stream| stream.is_a? TextStream }
+  end
+
+  # return true if there is an image stream, false otherwise
+  def image?
+    @streams.any? { |stream| stream.is_a? ImageStream }
+  end
+
+  # return true if there is an menu stream, false otherwise
+  def menu?
+    @streams.any? { |stream| stream.is_a? MenuStream }
+  end
+
+  # return true if there is an undefined stream, false otherwise
+  def other?
+    @streams.any? { |stream| stream.is_a? OtherStream }
+  end
+
+  # returns an array with all the video streams
+  def general
+    @streams.select { |stream| stream.is_a? GeneralStream }
+  end
+
+  # returns an array with all the video streams
+  def video
+    @streams.select { |stream| stream.is_a? VideoStream }
+  end
+
+  # returns an array with all the audio streams
+  def audio
+    @streams.select { |stream| stream.is_a? AudioStream }
+  end
+
+  # returns an array with all the text streams
+  def text
+    @streams.select { |stream| stream.is_a? TextStream }
+  end
+
+  # returns an array with all the image streams
+  def image
+    @streams.select { |stream| stream.is_a? ImageStream }
+  end
+
+  # returns an array with all the menu streams
+  def menu
+    @streams.select { |stream| stream.is_a? MenuStream }
+  end
+
+  # returns an array with all the other streams
+  def other
+    @streams.select { |stream| stream.is_a? OtherStream }
+  end
+
+end
+

data/lib/mediainfo-simple/parser.rb

@@ -0,0 +1,95 @@
+require 'rexml/document'
+
+
+class MediaInfoParser
+  attr_accessor :mediainfo_path_verified
+
+  def initialize filename, mediainfo_object, mediainfo_path=nil
+    # we check that MediaInfo CLI is installed
+    if not mediainfo_installed? mediainfo_path
+      raise RuntimeError, "mediainfo command-line interface not installed"
+    end
+
+    # we launch the MediaInfo scan
+    # it will fill the MediaInfo object with the data
+    mediainfo_run! filename, mediainfo_object
+  end
+
+
+  private #################################################
+
+  # a method to check that MediaInfo CLI is installed
+  # return true if installed, false otherwise
+  def mediainfo_installed? mediainfo_path=nil
+    # if the user specified the path, we check that MediaInfo
+    # is installed at the path provided by the user
+    # else, we get path with bash command `which`
+    # (`which` works on Linux and Mac, but I don't know about Windows)
+    if mediainfo_path != nil
+      if File.exist? File.expand_path(mediainfo_path)
+        @mediainfo_path_verified = mediainfo_path
+        return true
+      else
+        return false
+      end
+    else
+      mediainfo_path = `which 'mediainfo'`.rstrip
+      # NB: rstrip is needed to remove final '\n'
+      if mediainfo_path != ""
+        @mediainfo_path_verified = mediainfo_path
+        return true
+      else
+        return false
+      end
+    end
+  end
+
+  # we use the mediainfo command-line interface to get the XML results
+  # it returns the raw XML data
+  def mediainfo_run! filename, mediainfo_object
+    command = "#{mediainfo_path_verified} '#{filename}' --Output=XML"
+    raw_xml_response = `#{command} 2>&1`
+    unless $? == 0
+      raise RuntimeError, "Execution of `#{command}` failed: #{raw_xml_response.inspect}"
+    end
+    parse! raw_xml_response, mediainfo_object
+  end
+
+  # we parse the raw XML data (with ReXML), 
+  # and we fill the MediaInfo object attributes
+  def parse! raw_xml_response, mediainfo_object
+    # puts "#{raw_xml_response}"
+    REXML::Document.new(raw_xml_response).elements.each("/Mediainfo/File/track") { |track|
+      # we create a "Stream" object, depending on the Stream type
+      stream = StreamFactory.create track.attributes['type']
+
+      # we get each tag about the stream
+      track.children.select { |n| n.is_a? REXML::Element }.each do |c|
+        # we convert the tag name to a ruby-attribute-compatible name
+        tag_name = c.name.strip  # remove whitespaces at the beginning and the end
+        tag_name = tag_name.gsub(/ +/, "_")  # we replace spaces by '_'
+        # we replace characters forbidden in Ruby method names by '_':
+        tag_name = tag_name.gsub(/[\(\)\{\}\[\]\*\/\\,;\.:\+=\-\^\$\!\?\|@#\&"'`]+/, '_')
+        tag_name = tag_name.gsub(/^_+/, "")  # remove '_' at the beginning
+        tag_name = tag_name.gsub(/_+$/, "")  # remove '_' at the end
+        tag_name = tag_name.gsub(/_+/, "_")  # we replace several '_' following by a single one
+        tag_name = tag_name.downcase
+
+        # if there is an attribute in the Stream class,
+        # that has the same name as the tag name, we set it with the tag content
+        if stream.class.method_defined? tag_name + "="
+          # we call the method which name is the content of the string tag_name
+          stream.send tag_name + "=", c.text.strip
+        else
+          # to print the tag ignored, in case we want to support them
+          # puts "#{stream.class}: tag ignored: #{tag_name}, #{c.text.strip}"
+        end
+      end
+      
+      # we add the Stream objects to the MediaInfo object
+      mediainfo_object.streams << stream
+    }
+  end
+end
+
+

data/lib/mediainfo-simple/stream.rb

@@ -0,0 +1,11 @@
+class Stream
+  # to create aliases (getter and setter method)
+  # for attributes defined with attr_accessor
+  def self.attr_accessor_alias alias_name, alias_target
+    alias_method alias_name, alias_target                    # alias for the getter
+    alias_method alias_name.to_s+'=', alias_target.to_s+'='  # alias for the setter
+  end
+
+  attr_accessor :id
+  attr_accessor_alias :stream_id, :id
+end

data/lib/mediainfo-simple/stream_factory.rb

@@ -0,0 +1,14 @@
+class StreamFactory
+  def self.create stream_type
+    raise ArgumentError, "need a stream_type, received #{stream_type.inspect}" if stream_type.nil?
+
+    # we check that there is a subclass of stream for this stream
+    stream_class_name = "#{stream_type}Stream"
+    if not Object.const_defined? stream_class_name
+      raise "bad stream type: #{stream_type.inspect}"
+    end
+
+    # we return a (subclass of) Stream object
+    return Object.const_get(stream_class_name).new
+  end
+end

data/lib/mediainfo-simple/streams/audio.rb

@@ -0,0 +1,39 @@
+class AudioStream < Stream
+  attr_accessor :duration
+  attr_accessor :language
+  
+  attr_accessor :sampling_count
+  attr_accessor :sampling_rate
+  attr_accessor_alias :sample_rate, :sampling_rate
+
+  attr_accessor :stream_size
+  attr_accessor :bit_rate
+  attr_accessor :bit_rate_mode
+  attr_accessor :interleave_duration
+
+  attr_accessor :resolution
+  attr_accessor_alias :sample_bit_depth, :resolution
+
+  attr_accessor :format
+  attr_accessor :format_profile
+  attr_accessor :format_version
+  attr_accessor :format_info
+  attr_accessor :format_settings_sbr
+  attr_accessor :format_settings_endianness
+  attr_accessor :format_settings_sign
+  attr_accessor :codec_id
+  attr_accessor :codec_info
+  attr_accessor :codec
+  attr_accessor :codec_id_hint
+  attr_accessor :channel_positions
+
+  attr_accessor :channel_s
+  def stereo?; channels == 2; end
+  def mono?;   channels == 1; end
+
+  attr_accessor :encoded_date
+  attr_accessor :tagged_date
+
+  attr_accessor :menu_id
+end
+

data/lib/mediainfo-simple/streams/general.rb

@@ -0,0 +1,31 @@
+class GeneralStream < Stream
+  attr_accessor :complete_name
+  attr_accessor :file_size
+  attr_accessor :duration
+  
+  attr_accessor :format
+  attr_accessor :format_profile
+  attr_accessor :format_info
+  attr_accessor :codec
+  attr_accessor :overall_bit_rate
+  attr_accessor :encoded_application
+  attr_accessor_alias :writing_application, :encoded_application
+  attr_accessor :encoded_library
+  attr_accessor_alias :writing_library, :encoded_library
+  
+  attr_accessor :mastered_date
+  attr_accessor :tagged_date
+  attr_accessor :encoded_date
+  attr_accessor :last_modification_date
+  attr_accessor_alias :file_modified_date, :last_modification_date
+
+  # ID3Tags
+  attr_accessor :artist
+  attr_accessor :performer
+  attr_accessor :title
+  attr_accessor :genre
+  attr_accessor :album
+  attr_accessor :copyright
+  attr_accessor :year
+end
+

data/lib/mediainfo-simple/streams/image.rb

@@ -0,0 +1,12 @@
+class ImageStream < Stream
+  attr_accessor :resolution
+  attr_accessor :format
+  
+  attr_accessor :width
+  attr_accessor :height
+ 
+  def frame_size
+    "#{width}x#{height}" if width && height
+  end
+end
+

data/lib/mediainfo-simple/streams/menu.rb

@@ -0,0 +1,9 @@
+class MenuStream < Stream
+  attr_accessor :duration
+  attr_accessor :menu_id
+  attr_accessor :language
+  attr_accessor :encoded_date
+  attr_accessor :tagged_date
+  attr_accessor :delay
+end
+

data/lib/mediainfo-simple/streams/other.rb

@@ -0,0 +1,6 @@
+class OtherStream < Stream
+  attr_accessor :type
+  attr_accessor :timestamp_firstframe
+  attr_accessor_alias :timecode, :timestamp_firstframe
+end
+

data/lib/mediainfo-simple/streams/text.rb

@@ -0,0 +1,10 @@
+class TextStream < Stream
+  attr_accessor :duration
+  attr_accessor :language
+  attr_accessor :language_more_info  # like "For hearing impaired people"
+  attr_accessor :format
+  attr_accessor :codec_id
+  attr_accessor :codec_info
+  attr_accessor :menu_id
+end
+

data/lib/mediainfo-simple/streams/video.rb

@@ -0,0 +1,100 @@
+class VideoStream < Stream
+  attr_accessor :duration
+  
+  attr_accessor :stream_size
+  attr_accessor :bit_rate
+  attr_accessor :nominal_bit_rate
+  
+  attr_accessor :bit_rate_mode
+  def cbr?
+    video? && 'Constant' == bit_rate_mode
+  end
+
+  def vbr?
+    video? && !cbr?
+  end
+
+  attr_accessor :scan_order
+  attr_accessor :scan_type
+  def interlaced?
+    video? && 'Interlaced' == scan_type
+  end
+
+  def progressive?
+    video? && !interlaced?
+  end
+
+  attr_accessor :bitdepth
+  attr_accessor_alias :bit_depth, :bitdepth
+
+  attr_accessor :resolution
+
+  attr_accessor :colorimetry
+  attr_accessor :colorspace
+  attr_accessor_alias :color_space, :colorspace
+
+  attr_accessor :format
+  attr_accessor :format_info
+  attr_accessor :format_profile
+  attr_accessor :format_version
+  attr_accessor :format_settings_cabac
+  attr_accessor :format_settings_reframes
+  attr_accessor :format_settings_matrix
+  attr_accessor :format_settings_gop
+  attr_accessor :format_commercial
+  
+  attr_accessor :colour_primaries
+  attr_accessor_alias :color_primaries, :colour_primaries
+
+  attr_accessor :transfer_characteristics
+  attr_accessor :matrix_coefficients
+
+  attr_accessor :codec_id
+  attr_accessor :codec_info
+  attr_accessor :codec
+  attr_accessor_alias :codec_id_info, :codec_info
+
+  attr_accessor :frame_rate
+  attr_accessor_alias :framerate, :frame_rate
+  attr_accessor_alias :fps,       :frame_rate
+  # to convert framerate string to a float
+  # example: "25.000 fps" => 25.0 :
+  def fps_float
+    frame_rate[/[\d.]+/].to_f if frame_rate
+  end
+
+  attr_accessor :minimum_frame_rate
+  attr_accessor_alias :min_framerate, :minimum_frame_rate
+  attr_accessor_alias :min_fps,       :minimum_frame_rate
+  # like above, to convert min_fps strng to a float:
+  def min_fps_float
+    minimum_frame_rate[/[\d.]+/].to_f if video?
+  end
+
+  attr_accessor :maximum_frame_rate
+  attr_accessor_alias :max_framerate, :maximum_frame_rate
+  attr_accessor_alias :max_fps,       :maximum_frame_rate
+  def max_fps_float
+    maximum_frame_rate[/[\d.]+/].to_f if video?
+  end
+
+  attr_accessor :frame_rate_mode
+
+  attr_accessor :display_aspect_ratio
+
+  attr_accessor :bits_pixel_frame  # "Bits-(Pixel*Frame)"
+
+  attr_accessor :width
+  attr_accessor :height
+
+  def frame_size
+    "#{width}x#{height}" if width && height
+  end
+
+  attr_accessor :encoded_date
+  attr_accessor :tagged_date
+  
+  attr_accessor :standard
+  attr_accessor :menu_id
+end
+

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: mediainfo-simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vincent Marquet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies: []
+description: A simple MediaInfo wrapper.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mediainfo-simple.rb
+- lib/mediainfo-simple/parser.rb
+- lib/mediainfo-simple/stream.rb
+- lib/mediainfo-simple/stream_factory.rb
+- lib/mediainfo-simple/streams/audio.rb
+- lib/mediainfo-simple/streams/general.rb
+- lib/mediainfo-simple/streams/image.rb
+- lib/mediainfo-simple/streams/menu.rb
+- lib/mediainfo-simple/streams/other.rb
+- lib/mediainfo-simple/streams/text.rb
+- lib/mediainfo-simple/streams/video.rb
+homepage: http://github.com/vmarquet/ruby-mediainfo-simple
+licenses:
+- WTFPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A MediaInfo wrapper.
+test_files: []