ruby-mp3info 0.6.12 → 0.6.13

data/History.txt

@@ -1,3 +1,11 @@
+=== 0.6.13 / 2009-05-26
+
+* fixed bad mapping of artist inside id3 2.2
+* adding fusil fuzzer tests
+* Improved support for id3v2.2 to id3v2.3 field mapping
+* each_frame() iterator
+* removed @bitrate & @length computation based on @tag2[TLEN]
+
 === 0.6.12 / 2009-02-23
 
 * fixed bug when @tag2["TLEN"] == 0

data/lib/mp3info.rb

@@ -18,7 +18,7 @@ end
 
 class Mp3Info
 
-  VERSION = "0.6.12"
+  VERSION = "0.6.13"
 
   LAYER = [ nil, 3, 2, 1]
   BITRATE = {
@@ -82,7 +82,7 @@ class Mp3Info
   # for id3v2.2
   TAG_MAPPING_2_2 = { 
     "title"    => "TT2",
-    "artist"   => "TP2", 
+    "artist"   => "TP1", 
     "album"    => "TAL",
     "year"     => "TYE",
     "tracknum" => "TRK",
@@ -259,7 +259,7 @@ class Mp3Info
       5.times do
 	head = find_next_frame() 
         @first_frame_pos = @file.pos - 4
-        current_frame = get_frames_infos(head)
+        current_frame = Mp3Info.get_frames_infos(head)
 	@mpeg_version = current_frame[:mpeg_version]
 	@layer = current_frame[:layer]
 	@header[:error_protection] = head[16] == 0 ? true : false
@@ -267,11 +267,11 @@ class Mp3Info
 	@samplerate = current_frame[:samplerate]
 	@header[:padding] = current_frame[:padding]
 	@header[:private] = head[8] == 0 ? true : false
-	@channel_mode = CHANNEL_MODE[@channel_num = bits(head, 7,6)]
-	@header[:mode_extension] = bits(head, 5,4)
+	@channel_mode = CHANNEL_MODE[@channel_num = Mp3Info.bits(head, 7,6)]
+	@header[:mode_extension] = Mp3Info.bits(head, 5,4)
 	@header[:copyright] = (head[3] == 1 ? true : false)
 	@header[:original] = (head[2] == 1 ? true : false)
-	@header[:emphasis] = bits(head, 1,0)
+	@header[:emphasis] = Mp3Info.bits(head, 1,0)
 	@vbr = false
 	found = true
         break
@@ -307,50 +307,21 @@ class Mp3Info
 	# for cbr, calculate duration with the given bitrate
 	stream_size = @file.stat.size - (hastag1? ? TAG1_SIZE : 0) - (@tag2.io_position || 0)
 	@length = ((stream_size << 3)/1000.0)/@bitrate
-        full_scan_occured = false
         # read the first 100 frames and decide if the mp3 is vbr and needs full scan
         begin
           bitrate, length = frame_scan(100)
           if @bitrate != bitrate
             @vbr = true
             @bitrate, @length = frame_scan
-            full_scan_occured = true
           end
         rescue Mp3InfoInternalError
         end
-	if (tlen = @tag2["TLEN"]) && !full_scan_occured
-	  # but if another duration is given and it isn't close (within 5%)
-	  #  assume the mp3 is vbr and go with the given duration
-	  @length = (tlen.is_a?(Array) ? tlen.last : tlen).to_i/1000
-	  @bitrate = (stream_size / @bitrate) / 1024
-	end
       end
     ensure
       @file.close
     end
   end
 
-  def get_frames_infos(head)
-    # be sure we are in sync
-    if ((head & 0xffe00000) != 0xffe00000)    || # 11 bit MPEG frame sync
-       ((head & 0x00060000) == 0x00060000)    || #  2 bit layer type
-       ((head & 0x0000f000) == 0x0000f000)    || #  4 bit bitrate
-       ((head & 0x0000f000) == 0x00000000)    || #        free format bitstream
-       ((head & 0x00000c00) == 0x00000c00)    || #  2 bit frequency
-       ((head & 0xffff0000) == 0xfffe0000) 
-      raise Mp3InfoInternalError 
-    end
-    mpeg_version = [2.5, nil, 2, 1][bits(head, 20,19)]
-    
-    layer = LAYER[bits(head, 18,17)]
-    raise Mp3InfoInternalError if layer == nil || mpeg_version == nil
-    { :layer => layer,
-      :bitrate => BITRATE[mpeg_version][layer-1][bits(head, 15,12)-1],
-      :samplerate => SAMPLERATE[mpeg_version][bits(head, 11,10)],
-      :mpeg_version => mpeg_version,
-      :padding => (head[9] == 1) }
-  end
-
   # "block version" of Mp3Info::new()
   def self.open(*params)
     m = self.new(*params)
@@ -415,7 +386,12 @@ class Mp3Info
     end
     [pos, length]
   end
-  
+
+  # return the length in seconds of one frame
+  def frame_length
+    SAMPLES_PER_FRAME[@layer][@mpeg_version] / Float(@samplerate)
+  end
+
   # Flush pending modifications to tags and close the file
   def close
     puts "close" if $DEBUG
@@ -518,9 +494,58 @@ class Mp3Info
     s
   end
 
+  # iterates over each mpeg frame over the file, allowing you to 
+  # write some funny things, like an mpeg lossless cutter, or frame
+  # counter, or whatever you like ;) +frame+ is a hash with the following keys:
+  # :layer, :bitrate, :samplerate, :mpeg_version, :padding and :size (in bytes)
+  def each_frame
+    File.open(@filename, 'r') do |file|
+      file.seek(@first_frame_pos, File::SEEK_SET)
+      loop do
+        head = file.read(4).unpack("N").first
+        frame = Mp3Info.get_frames_infos(head)
+        file.seek(frame[:size] -4, File::SEEK_CUR)
+        yield frame
+        #puts "frame #{frame_count} len #{frame[:length]} br #{frame[:bitrate]} @file.pos #{@file.pos}"
+        break if file.eof?
+      end
+    end
+  end
 
 private
   
+  def Mp3Info.get_frames_infos(head)
+    # be sure we are in sync
+    if ((head & 0xffe00000) != 0xffe00000)    || # 11 bit MPEG frame sync
+       ((head & 0x00060000) == 0x00060000)    || #  2 bit layer type
+       ((head & 0x0000f000) == 0x0000f000)    || #  4 bit bitrate
+       ((head & 0x0000f000) == 0x00000000)    || #        free format bitstream
+       ((head & 0x00000c00) == 0x00000c00)    || #  2 bit frequency
+       ((head & 0xffff0000) == 0xfffe0000) 
+      raise Mp3InfoInternalError 
+    end
+    mpeg_version = [2.5, nil, 2, 1][bits(head, 20,19)]
+    
+    layer = LAYER[bits(head, 18,17)]
+    raise Mp3InfoInternalError if layer == nil || mpeg_version == nil
+
+    bitrate = BITRATE[mpeg_version][layer-1][bits(head, 15,12)-1]
+    samplerate = SAMPLERATE[mpeg_version][bits(head, 11,10)]
+    padding = (head[9] == 1)
+    if layer == 1
+      size = (12 * bitrate*1000.0 / samplerate + (padding ? 1 : 0))*4 
+    else # layer 2 and 3
+      size = 144 * (bitrate*1000.0 / samplerate) + (padding ? 1 : 0)
+    end
+    size = size.to_i
+    { :layer => layer,
+      :bitrate => bitrate,
+      :samplerate => samplerate,
+      :mpeg_version => mpeg_version,
+      :padding => padding,
+      :size => size }
+  end
+
   ### parses the id3 tags of the currently open @file
   def parse_tags
     return if @file.stat.size < TAG1_SIZE  # file is too small
@@ -587,7 +612,7 @@ private
         raise(Mp3InfoError, "end of file reached") if @file.eof?
         head = 0xff000000 + (data.getbyte(0) << 16) + (data.getbyte(1) << 8) + data.getbyte(2)
         begin
-          get_frames_infos(head)
+          Mp3Info.get_frames_infos(head)
           return head
         rescue Mp3InfoInternalError
           @file.seek(-3, IO::SEEK_CUR)
@@ -603,34 +628,21 @@ private
 
   def frame_scan(frame_limit = nil)
     frame_count = bitrate_sum = 0
-    @file.seek(@first_frame_pos, File::SEEK_SET)
-    current_frame = nil
-    loop do
-      head = @file.read(4).unpack("N").first
-      current_frame = get_frames_infos(head)
-      if current_frame[:layer] == 1
-        frame_length = (12 * current_frame[:bitrate]*1000.0 / current_frame[:samplerate] + (current_frame[:padding] ? 1 : 0))*4 
-      else # layer 2 and 3
-        frame_length = 144 * (current_frame[:bitrate]*1000.0 / current_frame[:samplerate]) + (current_frame[:padding] ? 1 : 0)
-      end
-      frame_length = frame_length.to_i
-      bitrate_sum += current_frame[:bitrate]
+    each_frame do |frame|
+      bitrate_sum += frame[:bitrate]
       frame_count += 1
-      @file.seek(frame_length -4, File::SEEK_CUR)
-      #puts "frame #{frame_count} len #{frame_length} br #{current_frame[:bitrate]} @file.pos #{@file.pos}"
-      break if @file.eof?
       break if frame_limit && (frame_count >= frame_limit)
     end
-
+    
     average_bitrate = bitrate_sum/frame_count.to_f
-    length = (frame_count-1) * SAMPLES_PER_FRAME[@layer][@mpeg_version] / Float(@samplerate)
+    length = (frame_count-1) * frame_length
     [average_bitrate, length]
   end
 
 
   ### returns the selected bit range (b, a) as a number
   ### NOTE: b > a  if not, returns 0
-  def bits(number, b, a)
+  def self.bits(number, b, a)
     t = 0
     b.downto(a) { |i| t += t + number[i] }
     t

data/lib/mp3info/id3v2.rb

@@ -5,7 +5,10 @@ require "mp3info/extension_modules"
 
 class ID3v2Error < StandardError ; end
 
-# This class is not intended to be used directly
+# This class can be used to decode id3v2 tags from files, like .mp3 or .ape for example.
+# It works like a hash, where key represents the tag name as 3 or 4 upper case letters
+# (respectively related to 2.2 and 2.3+ tag) and value represented as array or raw value.
+# Written version is always 2.3.
 class ID3v2 < DelegateClass(Hash) 
   
   # Major version used when writing tags
@@ -88,6 +91,69 @@ class ID3v2 < DelegateClass(Hash)
     "WXXX" => "User defined URL link frame"
   }
 
+  # Translate V2 to V3 tags
+  TAG_MAPPING_2_2_to_2_3 = {
+    "BUF"   => "RBUF",
+    "COM"   => "COMM",
+    "CRA"   => "AENC",
+    "EQU"   => "EQUA",
+    "ETC"   => "ETCO",
+    "GEO"   => "GEOB",
+    "MCI"   => "MCDI",
+    "MLL"   => "MLLT",
+    "PIC"   => "APIC",
+    "POP"   => "POPM",
+    "REV"   => "RVRB",
+    "RVA"   => "RVAD",
+    "SLT"   => "SYLT",
+    "STC"   => "SYTC",
+    "TAL"   => "TALB",
+    "TBP"   => "TBPM",
+    "TCM"   => "TCOM",
+    "TCO"   => "TCON",
+    "TCR"   => "TCOP",
+    "TDA"   => "TDAT",
+    "TDY"   => "TDLY",
+    "TEN"   => "TENC",
+    "TFT"   => "TFLT",
+    "TIM"   => "TIME",
+    "TKE"   => "TKEY",
+    "TLA"   => "TLAN",
+    "TLE"   => "TLEN",
+    "TMT"   => "TMED",
+    "TOA"   => "TOPE",
+    "TOF"   => "TOFN",
+    "TOL"   => "TOLY",
+    "TOR"   => "TORY",
+    "TOT"   => "TOAL",
+    "TP1"   => "TPE1",
+    "TP2"   => "TPE2",
+    "TP3"   => "TPE3",
+    "TP4"   => "TPE4",
+    "TPA"   => "TPOS",
+    "TPB"   => "TPUB",
+    "TRC"   => "TSRC",
+    "TRD"   => "TRDA",
+    "TRK"   => "TRCK",
+    "TSI"   => "TSIZ",
+    "TSS"   => "TSSE",
+    "TT1"   => "TIT1",
+    "TT2"   => "TIT2",
+    "TT3"   => "TIT3",
+    "TXT"   => "TEXT",
+    "TXX"   => "TXXX",
+    "TYE"   => "TYER",
+    "UFI"   => "UFID",
+    "ULT"   => "USLT",
+    "WAF"   => "WOAF",
+    "WAR"   => "WOAR",
+    "WAS"   => "WOAS",
+    "WCM"   => "WCOM",
+    "WCP"   => "WCOP",
+    "WPB"   => "WPB",
+    "WXX"   => "WXXX",
+  }
+
   # See id3v2.4.0-structure document, at section 4.
   TEXT_ENCODINGS = ["iso-8859-1", "utf-16", "utf-16be", "utf-8"]
 
@@ -188,20 +254,28 @@ class ID3v2 < DelegateClass(Hash)
     @hash.each do |k, v|
       next unless v
       next if v.respond_to?("empty?") and v.empty?
+      
+      # Automagically translate V2 to V3 tags
+      k = TAG_MAPPING_2_2_to_2_3[k] if TAG_MAPPING_2_2_to_2_3.has_key?(k)
+
       # doesn't encode id3v2.2 tags, which have 3 characters
       next if k.size != 4 
-      data = encode_tag(k, v.to_s, WRITE_VERSION)
-      #data << "\x00"*2 #End of tag
+      
+      # Output one flag for each array element, or one only if it's not an array
+      [v].flatten.each do |value|
+        data = encode_tag(k, value.to_s, WRITE_VERSION)
+        #data << "\x00"*2 #End of tag
 
-      tag << k[0,4]   #4 characte max for a tag's key
-      #tag << to_syncsafe(data.size) #+1 because of the language encoding byte
-      size = data.size
-      if RUBY_VERSION >= "1.9.0"
-        size = data.dup.force_encoding("binary").size
+        tag << k[0,4]   #4 characte max for a tag's key
+        #tag << to_syncsafe(data.size) #+1 because of the language encoding byte
+        size = data.size
+        if RUBY_VERSION >= "1.9.0"
+          size = data.dup.force_encoding("binary").size
+        end
+        tag << [size].pack("N") #+1 because of the language encoding byte
+        tag << "\x00"*2 #flags
+        tag << data
       end
-      tag << [size].pack("N") #+1 because of the language encoding byte
-      tag << "\x00"*2 #flags
-      tag << data
     end
 
     tag_str = "ID3"
@@ -236,6 +310,7 @@ class ID3v2 < DelegateClass(Hash)
 
     case name
       when "COMM"
+      puts "encode COMM: enc: #{text_encoding_index}, lang: #{@options[:lang]}, str: #{transcoded_value.dump}" if $DEBUG
 	[ text_encoding_index , @options[:lang], 0, transcoded_value ].pack("ca3ca*")
       when /^T/
 	text_encoding_index.chr + transcoded_value
@@ -248,7 +323,7 @@ class ID3v2 < DelegateClass(Hash)
   def decode_tag(name, raw_value)
     puts("decode_tag(#{name.inspect}, #{raw_value.inspect})") if $DEBUG
     case name
-      when "COMM"
+      when /^COM/
         #FIXME improve this
 	encoding, lang, str = raw_value.unpack("ca3a*") 
 	out = raw_value.split(0.chr).last
@@ -257,15 +332,15 @@ class ID3v2 < DelegateClass(Hash)
 	out = raw_value[1..-1] 
 	# we need to convert the string in order to match
 	# the requested encoding
-	if out && encoding != @text_encoding_index
+	if encoding && TEXT_ENCODINGS[encoding] && out && encoding != @text_encoding_index
 	  begin
-	    Iconv.iconv(@options[:encoding], TEXT_ENCODINGS[encoding], out).first
+	    out = Iconv.iconv(@options[:encoding], TEXT_ENCODINGS[encoding], out).first
 	  rescue Iconv::Failure
-	    return out
 	  end
-	else
-	  return out
 	end
+        # remove padding zeros for textual tags
+        out.sub!(/\0*$/, '')
+        return out
       else
         return raw_value
     end
@@ -276,7 +351,7 @@ class ID3v2 < DelegateClass(Hash)
   def read_id3v2_3_frames
     loop do # there are 2 ways to end the loop
       name = @io.read(4)
-      if name.getbyte(0) == 0 or name == "MP3e" #bug caused by old tagging application "mp3ext" ( http://www.mutschler.de/mp3ext/ )
+      if name.nil? || name.getbyte(0) == 0 || name == "MP3e" #bug caused by old tagging application "mp3ext" ( http://www.mutschler.de/mp3ext/ )
         @io.seek(-4, IO::SEEK_CUR)    # 1. find a padding zero,
 	seek_to_v2_end
         break
@@ -299,7 +374,7 @@ class ID3v2 < DelegateClass(Hash)
   def read_id3v2_2_frames
     loop do
       name = @io.read(3)
-      if name.getbyte(0) == 0
+      if name.nil? || name.getbyte(0) == 0
         @io.seek(-3, IO::SEEK_CUR)
 	seek_to_v2_end
         break
@@ -323,10 +398,6 @@ class ID3v2 < DelegateClass(Hash)
       
     data_io = @io.read(size)
     data = decode_tag(name, data_io)
-    # remove padding zeros for textual tags
-    if data && name =~ /^T/
-      data.sub!(/\0*$/, '')
-    end
 
     if self["TPOS"] =~ /(\d+)\s*\/\s*(\d+)/
       self["disc_number"] = $1.to_i
@@ -348,7 +419,7 @@ class ID3v2 < DelegateClass(Hash)
   ###  frame, which should be first 0xff byte after id3v2 padding zero's
   def seek_to_v2_end
     until @io.getbyte == 0xff
-      raise EOFError if @io.eof?
+      raise ID3v2Error, "got EOF before finding id3v2 end" if @io.eof?
     end
     @io.seek(-1, IO::SEEK_CUR)
   end
@@ -357,11 +428,5 @@ class ID3v2 < DelegateClass(Hash)
   def to_syncsafe(num)
     ( (num<<3) & 0x7f000000 )  + ( (num<<2) & 0x7f0000 ) + ( (num<<1) & 0x7f00 ) + ( num & 0x7f )
   end
-
-#  def method_missing(meth, *args)
-#    m = meth.id2name
-#    return nil if TAGS.has_key?(m) and self[m].nil?
-#    super
-#  end
 end
 

data/test/test_ruby-mp3info.rb

@@ -302,9 +302,11 @@ class Mp3InfoTest < Test::Unit::TestCase
       expected_tag = { 
         "genre_s"       => "Hip Hop/Rap",
         "title"         => "Intro",
-        "comments"      => "\000engiTunPGAP\0000\000\000",
+        #"comments"      => "\000engiTunPGAP\0000\000\000",
+        "comments"      => "0",
         "year"          => 2006,
         "album"         => "Air Max",
+        "artist"        => "Grems Aka Supermicro",
         "tracknum"      => 1 }
       # test universal tag
       assert_equal expected_tag, mp3.tag
@@ -318,13 +320,13 @@ class Mp3InfoTest < Test::Unit::TestCase
       mp3.tag.comments = "comments"
       mp3.flush
       expected_tag = { 
-        "artist"=>"toto",
-        "genre_s"=>"Hip Hop/Rap",
-        "title"=>"Intro",
-        "comments"=>"comments",
-        "year"=>2006,
-        "album"=>"Air Max",
-        "tracknum"=>1}
+        "artist" => "toto",
+        "genre_s" => "Hip Hop/Rap",
+        "title" => "Intro",
+        "comments" => "comments",
+        "year" => 2006,
+        "album" => "Air Max",
+        "tracknum" => 1}
 
       assert_equal expected_tag, mp3.tag
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-mp3info
 version: !ruby/object:Gem::Version 
-  version: 0.6.12
+  version: 0.6.13
 platform: ruby
 authors: 
 - Guillaume Pierronnet
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-23 00:00:00 +01:00
+date: 2009-05-26 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.3
+        version: 1.9.0
     version: 
 description: "* written in pure ruby  * read low-level informations like bitrate, length, samplerate, etc... * read, write, remove id3v1 and id3v2 tags * correctly read VBR files (with or without Xing header) * only 2.3 version is supported for writings id3v2 tags  == SYNOPSIS:  a good exercise is to read the test.rb to understand how the library works deeper  require \"mp3info\" # read and display infos & tags Mp3Info.open(\"myfile.mp3\") do |mp3info| puts mp3info end  # read/write tag1 and tag2 with Mp3Info#tag attribute # when reading tag2 have priority over tag1 # when writing, each tag is written. Mp3Info.open(\"myfile.mp3\") do |mp3| puts mp3.tag.title    puts mp3.tag.artist    puts mp3.tag.album puts mp3.tag.tracknum mp3.tag.title = \"track title\" mp3.tag.artist = \"artist name\" end  Mp3Info.open(\"myfile.mp3\") do |mp3| # you can access four letter v2 tags like this puts mp3.tag2.TIT2 mp3.tag2.TIT2 = \"new TIT2\" # or like that mp3.tag2[\"TIT2\"] # at this time, only COMM tag is processed after reading and before writing # according to ID3v2#options hash mp3.tag2.options[:lang] = \"FRE\" mp3.tag2.COMM = \"my comment in french, correctly handled when reading and writing\" end"
 email: moumar@rubyforge.org