Class: Sh::TagReader

Inherits:
Object show all
Defined in:
lib/sh_tagreader.rb

Class Method Summary collapse

Class Method Details

.read(path) {|metadata| ... } ⇒ Object

Yields:

  • (metadata) 


6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/sh_tagreader.rb', line 6

def self.read path, &block
  # Ensure that the path is absolute
  @path = File.expand_path path
  
  # Use shared-mime-info to determine MIME types if
  # it is available.
  if try_require 'shared-mime-info'
    type = MIME.check(@path)
    @mime = type.to_s if type.media == 'audio'
  else
  	# Attempt to use the `file` command
  	begin
    	type = `file --mime-type -b #{@path}`
    	@mime = type if type[0..5] == 'audio/'
    rescue Exception
    	@mime = nil
    end
    
    # As a fallback, guess MIME type from file extension.
  if not @mime or @mime.empty?
  @mime = {
    '.mp3' => 'audio/mpeg',
    '.m4a' => 'audio/mp4',
    '.flac' => 'audio/x-flac',
    '.ogg' => 'audio/ogg',
    '.wav' => 'audio/x-wav',
    '.wma' => 'audio/x-ms-wma'
  }[File.extname @path]
end
  end
  
  metadata = {}
			
			# Choose appropriate method for MIME type
  begin
    case @mime
    when 'audio/mpeg'
      metadata = TagReader.read_mp3 path
    when 'audio/mp4'
      metadata = TagReader.read_m4a path
    when 'audio/ogg'
      metadata = TagReader.read_ogg path
    when 'audio/x-flac'
      metadata = TagReader.read_flac path
    when 'audio/x-ms-wma'
      metadata = TagReader.read_wma path
    when 'audio/x-wav'
      metadata = TagReader.read_wave path
    end
  rescue Exception
    Log.warning "Couldn't parse tags for " + path
  end
			
			# Report on our metadata findings
  yield metadata if block
  return metadata
end

.read_flac(path) {|metadata| ... } ⇒ Object

Read metadata from FLAC file

Yields:

  • (metadata) 


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/sh_tagreader.rb', line 123

def self.read_flac path, &block
  metadata = {}
  if try_require 'flacinfo'
    flac = FlacInfo.new(path)
    flac.comment.each do |comment|
      split = comment.split('=')
      key = split.first.downcase
      value = (split[1..-1]).join
      value = nil if value == '' or value.is_binary_data?
      case key
      when 'title'
        metadata[:title] = value.to_u if value
      when 'artist'
        metadata[:artist] = value.to_u if value
      when 'album'
        metadata[:album] = value.to_u if value
      when 'year'
        metadata[:year] = value.to_i
      when 'tracknumber'
        metadata[:track_num] = value.to_i
      end
    end
  else
    Log.info 'Please install the "flacinfo" gem in order to read FLAC info'
  end
  yield metadata if block
  return metadata
end

.read_m4a(path) {|metadata| ... } ⇒ Object

Read metadata from M4A file

Yields:

  • (metadata) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/sh_tagreader.rb', line 85

def self.read_m4a path, &block
  metadata = {}
  if try_require 'mp4info'
    mp4 = MP4Info.open path
    metadata[:title] = mp4.NAM.to_u if mp4.NAM
    metadata[:artist] = mp4.ART.to_u if mp4.ART
    metadata[:album] = mp4.ALB.to_u if mp4.ALB
    metadata[:year] = mp4.DAY.to_i
    metadata[:track_num] = mp4.TRKN.first.to_i
    metadata[:duration] = mp4.SECS
  else
    Log.info 'Please install the "mp4info" gem in order to read M4A info'
  end
  yield metadata if block
  return metadata
end

.read_mp3(path) {|metadata| ... } ⇒ Object

Read metadata from MP3 file

Yields:

  • (metadata) 


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/sh_tagreader.rb', line 65

def self.read_mp3 path, &block
  metadata = {}
  if try_require 'mp3info'
    Mp3Info.open path do |mp3|
      t = mp3.tag
      metadata[:title] = t.title.to_u if t.title
      metadata[:artist] = t.artist.to_u if t.artist
      metadata[:album] = t.album.to_u if t.album
      metadata[:year] = t.year.to_i
      metadata[:track_num] = t.tracknum.to_i
      metadata[:duration] = mp3.length
    end
  else
    Log.info 'Please install the "mp3info" gem in order to read MP3 info'
  end
  yield metadata if block
  return metadata
end

.read_ogg(path) {|metadata| ... } ⇒ Object

Read metadata from OGG Vorbis file

Yields:

  • (metadata) 


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/sh_tagreader.rb', line 103

def self.read_ogg path, &block
  metadata = {}
  if try_require 'ogginfo'
    OggInfo.open path do |ogg|
      t = ogg.tag
      metadata[:title] = t.title.to_u if t.title
      metadata[:artist] = t.artist.to_u if t.artist
      metadata[:album] = t.album.to_u if t.album
      metadata[:year] = t.date.to_i
      metadata[:track_num] = t.tracknumber.to_i
      metadata[:duration] = ogg.length
    end rescue Exception
  else
    Log.info 'Please install the "ogginfo" gem in order to read OGG info'
  end
  yield metadata if block
  return metadata
end

.read_wave(path) {|metadata| ... } ⇒ Object

Read metadata from Wave file

Yields:

  • (metadata) 


182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/sh_tagreader.rb', line 182

def self.read_wave path, &block
  metadata = {}
  if try_require 'waveinfo'
    wave = WaveInfo.new path
    metadata[:duration] = wave.duration
  else
    Log.info 'Please install the "waveinfo" gem in order to read WAV info'
  end
  yield metadata if block
  return metadata
end

.read_wma(path) {|metadata| ... } ⇒ Object

Read metadata from WMA file

Yields:

  • (metadata) 


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/sh_tagreader.rb', line 153

def self.read_wma path, &block
  metadata = {}
  if try_require 'wmainfo'
    wma = WmaInfo.new(path)
    wma.tags.each do |key, value|
      key = key.downcase
      value = nil if value == '' or value.is_binary_data?
      case key
      when 'title'
        metadata[:title] = value.to_u if value
      when 'author'
        metadata[:artist] = value.to_u if value
      when 'albumtitle'
        metadata[:album] = value.to_u if value
      when 'year'
        metadata[:year] = value.to_i
      when 'tracknumber'
        metadata[:track_num] = value.to_i
      end
    end
    metadata[:duration] = wma.info["playtime_seconds"]
  else
    Log.info 'Please install the "wmainfo" gem in order to read WMA info'
  end
  yield metadata if block
  return metadata
end