Module: MediaInfo

Defined in:
lib/mediainfo.rb,
lib/mediainfo/errors.rb,
lib/mediainfo/tracks.rb,
lib/mediainfo/version.rb

Defined Under Namespace

Classes: BadInputError, EnvironmentError, ExecutionError, IncompatibleVersionError, InvalidTrackAttributeValue, InvalidTrackType, NoStreamsForProxyError, RemoteUrlError, SingleStreamAPIError, Tracks, UnknownVersionError

Constant Summary collapse

VERSION = 
'1.5.0'

Class Method Summary collapse

Class Method Details

.from(input) ⇒ Object

Raises:



59
60
61
62
63
 
# File 'lib/mediainfo.rb', line 59

def self.from(input)
  return from_uri(input) if input.is_a?(URI)
  return from_string(input) if input.is_a?(String)
  raise BadInputError
end

.from_link(input) ⇒ Object 



86
87
88
 
# File 'lib/mediainfo.rb', line 86

def self.from_link(input)
  from_uri(URI(input))
end

.from_local_file(input) ⇒ Object

Raises:

  • (ArgumentError) 


76
77
78
79
80
81
82
83
84
 
# File 'lib/mediainfo.rb', line 76

def self.from_local_file(input)
  absolute_path = File.expand_path(input) # turns relative to absolute path

  raise ArgumentError, 'You must include a file location.' if absolute_path.nil?
  raise ArgumentError, "need a path to a video file, #{absolute_path} does not exist" unless File.exist?(absolute_path)

  return from_xml(File.open(absolute_path).read) if absolute_path.match(/[^\\]*\.(xml)$/)
  MediaInfo::Tracks.new(MediaInfo.run(absolute_path.shell_escape_double_quotes))
end

.from_string(input) ⇒ Object

Raises:



65
66
67
68
69
70
 
# File 'lib/mediainfo.rb', line 65

def self.from_string(input)
  return from_xml(input) if input.include?('<?xml')
  return from_link(input) if input.include?('://') && input =~ URI::regexp
  return from_local_file(input) if input.match(/[^\\]*\.\w+$/)
  raise BadInputError
end

.from_uri(input) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/mediainfo.rb', line 100

def self.from_uri(input)
  if input.host.include?('amazonaws.com')
    MediaInfo::Tracks.new(MediaInfo.run(input.to_s)) # Removed URI.escape due to Error parsing the X-Amz-Credential parameter; the Credential is mal-formed; expecting "&lt;YOUR-AKID&gt;/YYYYMMDD/REGION/SERVICE/aws4_request"
  else
    http = Net::HTTP.new(input.host, input.port) # Check if input is valid
    request = Net::HTTP::Head.new(input.request_uri) # Only grab the Headers to be sure we don't try and download the whole file; Doesn't work with presigned_urls in aws/s3
    http.use_ssl = true if input.is_a? URI::HTTPS # For https support
    http_request = http.request(request)
    raise RemoteUrlError, "HTTP call to #{input} is not working : #{http_request.value}" unless http_request.is_a?(Net::HTTPOK)
    MediaInfo::Tracks.new(MediaInfo.run(URI.escape(input.to_s)))
  end
end

.from_xml(input) ⇒ Object 



72
73
74
 
# File 'lib/mediainfo.rb', line 72

def self.from_xml(input)
  MediaInfo::Tracks.new(input)
end

.location ⇒ Object

Allow user to set custom mediainfo_path with ENV

Raises:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/mediainfo.rb', line 22

def self.location
  if ENV['MEDIAINFO_PATH'].nil?
    mediainfo_location = which('mediainfo')
  else
    mediainfo_location = ENV['MEDIAINFO_PATH']
    raise EnvironmentError, "MediaInfo path you provided cannot be found. Please check your mediainfo installation location..." unless ::File.exist? mediainfo_location
  end
  raise EnvironmentError, "MediaInfo binary cannot be found. Are you sure mediainfo is installed?" if mediainfo_location.nil? || mediainfo_location.empty?
  return mediainfo_location
end

.run(input = nil) ⇒ Object

Raises:

  • (ArgumentError) 


90
91
92
93
94
95
96
97
98
 
# File 'lib/mediainfo.rb', line 90

def self.run(input = nil)
  raise ArgumentError, 'Your input cannot be blank.' if input.nil?
  command = "#{location} \"#{input}\" --Output=XML"
  raw_response, errors, status = Open3.capture3(command)
  unless status.exitstatus == 0
    raise ExecutionError, "Execution of '#{command}' failed: \n #{errors.red}"
  end
  return raw_response
end

.set_singleton_method(object, name, parameters) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/mediainfo.rb', line 113

def self.set_singleton_method(object,name,parameters)
  # Handle parameters with invalid characters (instance_variable_set throws error)
  name.gsub!('.','_') if name.include?('.') ## period in name
  name.downcase!
  # Create singleton_method
  object.instance_variable_set("@#{name}",parameters)
  object.define_singleton_method name do
    object.instance_variable_get "@#{name}"
  end
end

.version ⇒ Object

Allow collection of MediaInfo version details

Raises:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/mediainfo.rb', line 34

def self.version
  version ||= `#{location} --Version`[/v([\d.]+)/, 1]
  # Ensure MediaInfo isn't buggy and returns something
  raise UnknownVersionError, 'Unable to determine mediainfo version. ' + "We tried: #{location} --Version." +
        'Set MediaInfo.path = \'/full/path/of/mediainfo\' if it is not in your PATH.' unless version
  # Ensure you're not using an old version of MediaInfo
  if version < '0.7.25'
    raise IncompatibleVersionError, "Your version of mediainfo, #{version}, " +
        'is not compatible with this gem. >= 0.7.25 required.'
  else
    @version = version
  end

end

.which(cmd) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
 
# File 'lib/mediainfo.rb', line 10

def self.which(cmd)
  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
    exts.each { |ext|
      exe = File.join(path, "#{cmd}#{ext}")
      return exe if File.executable?(exe) && !File.directory?(exe)
    }
  end
  return nil
end

.xml_parser ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'lib/mediainfo.rb', line 49

def self.xml_parser
  ENV['MEDIAINFO_XML_PARSER'].nil? || ENV['MEDIAINFO_XML_PARSER'].to_s.strip.empty? ? xml_parser = 'rexml/document' : xml_parser = ENV['MEDIAINFO_XML_PARSER']
  begin
    require xml_parser
  rescue Gem::LoadError => ex
    raise Gem::LoadError, "Your specified XML parser, #{xml_parser.inspect}, could not be loaded: #{ex.message}"
  end
  return xml_parser
end