ruby-mp3info 0.5 → 0.5.1

data/CHANGELOG

@@ -1,3 +1,14 @@
+[0.5.1 10/09/2007]
+
+* ADDED: Mp3Info#reload method to reload the file from the disk
+* FIXED: bug [#2604] Not able to delete tag1
+* FIXED: bug #3401 'id3v2.rb dies when trying to read a certain mp3'
+* FIXED: bug #2957 'Error message "Can't define singleton"'
+* FIXED: bug #3068 'require_gem ("ruby-mp3info") doesn't works'
+* FIXED: bug #11967 "Leading 'h' from 'http://' gets chopped on URL fields"
+* PATCHED: with patch #3157 'Fix for 64 bit Ruby'
+
+
 [0.5 06/12/2005]
 
 * id3v2 writing and removing support added. tag2 attribute is r/w now

data/EXAMPLES

@@ -1,5 +1,7 @@
 = Examples
 
+ # a good exercise is to read the test.rb to understand how the library works deeper
+
  require "mp3info"
 
  # read and display infos & tags
@@ -38,3 +40,4 @@
   mp3.tag2.options[:lang] = "FRE"
   mp3.tag2.COMM = "my comment in french, correctly handled when reading and writing"
  end
+

data/lib/mp3info.rb

@@ -1,4 +1,4 @@
-# $Id: mp3info.rb,v 1.5 2005/04/26 13:41:41 moumar Exp $
+# $Id: mp3info.rb 51 2007-09-10 11:53:52Z moumar $
 # License:: Ruby
 # Author:: Guillaume Pierronnet (mailto:moumar_AT__rubyforge_DOT_org)
 # Website:: http://ruby-mp3info.rubyforge.org/
@@ -18,7 +18,7 @@ end
 
 class Mp3Info
 
-  VERSION = "0.5"
+  VERSION = "0.5.1"
 
   LAYER = [ nil, 3, 2, 1]
   BITRATE = [
@@ -77,7 +77,13 @@ class Mp3Info
     "comments" => "COMM",
     "genre_s"  => "TCON"
   }
-
+  
+  # http://www.codeproject.com/audio/MPEGAudioInfo.asp
+  SAMPLES_PER_FRAME = [
+    [384, 384, 384],    # Layer I   
+    [1152, 1152, 1152], # Layer II
+    [1152, 576, 576]    # Layer III
+  ]
 
   # mpeg version = 1 or 2
   attr_reader(:mpeg_version)
@@ -97,6 +103,9 @@ class Mp3Info
   # variable bitrate => true or false
   attr_reader(:vbr)
 
+  # only used in vbr mode
+  attr_reader(:samples_per_frame)
+
   # length in seconds as a Float
   attr_reader(:length)
 
@@ -155,8 +164,13 @@ class Mp3Info
   # Instantiate a new Mp3Info object with name +filename+
   def initialize(filename)
     $stderr.puts("#{self.class}::new() does not take block; use #{self.class}::open() instead") if block_given?
-    raise(Mp3InfoError, "empty file") unless File.stat(filename).size? #FIXME
     @filename = filename
+    reload
+  end
+
+  # reload the file from disk
+  def reload
+    raise(Mp3InfoError, "empty file") unless File.size?(@filename)
     @hastag1 = false
     
     @tag1 = {}
@@ -199,19 +213,18 @@ class Mp3Info
       ### extracts MPEG info from MPEG header and stores it in the hash @mpeg
       ###  head (fixnum) = valid 4 byte MPEG header
       
-    found = false
+      found = false
 
       5.times do
 	head = find_next_frame() 
-	head.extend(NumericBits)
 	@mpeg_version = [2, 1][head[19]]
-	@layer = LAYER[head.bits(18,17)]
+	@layer = LAYER[bits(head, 18,17)]
 	next if @layer.nil?
-	@bitrate = BITRATE[@mpeg_version-1][@layer-1][head.bits(15,12)-1]
+	@bitrate = BITRATE[@mpeg_version-1][@layer-1][bits(head, 15,12)-1]
 	@error_protection = head[16] == 0 ? true : false
-	@samplerate = SAMPLERATE[@mpeg_version-1][head.bits(11,10)]
+	@samplerate = SAMPLERATE[@mpeg_version-1][bits(head, 11,10)]
 	@padding = (head[9] == 1 ? true : false)
-	@channel_mode = CHANNEL_MODE[@channel_num = head.bits(7,6)]
+	@channel_mode = CHANNEL_MODE[@channel_num = bits(head, 7,6)]
 	@copyright = (head[3] == 1 ? true : false)
 	@original = (head[2] == 1 ? true : false)
 	@vbr = false
@@ -240,7 +253,10 @@ class Mp3Info
 	# currently this just skips the TOC entries if they're found
 	@file.seek(100, IO::SEEK_CUR) if flags[0] == 1
 	@vbr_quality = @file.get32bits if flags[3] == 1
-	@length = (26/1000.0)*@frames
+
+        @samples_per_frame = SAMPLES_PER_FRAME[@layer-1][@mpeg_version-1] 
+	@length = @frames * @samples_per_frame / Float(@samplerate)
+
 	@bitrate = (((@streamsize/@frames)*@samplerate)/144) >> 10
 	@vbr = true
       else
@@ -285,8 +301,7 @@ class Mp3Info
   # Remove id3v1 from mp3
   def removetag1
     if hastag1?
-      newsize = @file.stat.size(filename) - TAGSIZE
-      @file.truncate(newsize)
+      Mp3Info.removetag1(@filename)
       @tag1.clear
     end
     self
@@ -294,6 +309,7 @@ class Mp3Info
   
   def removetag2
     @tag2.clear
+    self
   end
 
   # Does the file has an id3v1 or v2 tag?
@@ -315,14 +331,18 @@ class Mp3Info
   def rename(new_filename)
     @filename = new_filename
   end
-
+  
   # Flush pending modifications to tags and close the file
   def close
     puts "close" if $DEBUG
     if @tag != @tag_orig
       puts "@tag has changed" if $DEBUG
-      @tag.each do |k, v|
-        @tag1[k] = v
+
+      # @tag1 has precedence over @tag
+      if @tag1 == @tag1_orig
+	@tag.each do |k, v|
+	  @tag1[k] = v
+	end
       end
       
       V1_V2_TAG_MAPPING.each do |key1, key2|
@@ -333,8 +353,8 @@ class Mp3Info
     if @tag1 != @tag1_orig
       puts "@tag1 has changed" if $DEBUG
       raise(Mp3InfoError, "file is not writable") unless File.writable?(@filename)
-      @tag1_orig.update(@tag1)
-      #puts "@tag1_orig: #{@tag1_orig.inspect}"
+      #@tag1_orig.update(@tag1)
+      @tag1_orig = @tag1.dup
       File.open(@filename, 'rb+') do |file|
 	file.seek(-TAGSIZE, File::SEEK_END)
 	t = file.read(3)
@@ -389,7 +409,6 @@ class Mp3Info
       end
       File.rename(tempfile_name, @filename)
     end
-    @file = nil
   end
 
   # inspect inside Mp3Info
@@ -409,7 +428,11 @@ private
     @file.seek(0)
     f3 = @file.read(3)
     gettag1 if f3 == "TAG"  # v1 tag at beginning
-    @tag2.from_io(@file) if f3 == "ID3"  # v2 tag at beginning
+    begin
+      @tag2.from_io(@file) if f3 == "ID3"  # v2 tag at beginning
+    rescue RuntimeError => e
+      raise(Mp3InfoError, e.message)
+    end
       
     unless @hastag1         # v1 tag at end
         # this preserves the file pos if tag2 found, since gettag2 leaves
@@ -456,6 +479,11 @@ private
     @tag1["comments"] = comments.strip
     @tag1["genre"] = @file.getc
     @tag1["genre_s"] = GENRES[@tag1["genre"]] || ""
+
+    # clear empty tags
+    @tag1.delete_if { |k, v| v.respond_to?(:empty?) && v.empty? }
+    @tag1.delete("genre") if @tag1["genre"] == 255
+    @tag1.delete("tracknum") if @tag1["tracknum"] == 0
   end
 
   ### reads through @file from current pos until it finds a valid MPEG header
@@ -496,6 +524,13 @@ private
     true
   end
 
+  ### returns the selected bit range (b, a) as a number
+  ### NOTE: b > a  if not, returns 0
+  def bits(n, b, a)
+    t = 0
+    b.downto(a) { |i| t += t + n[i] }
+    t
+  end
 end
 
 if $0 == __FILE__

data/lib/mp3info/extension_modules.rb

@@ -13,20 +13,11 @@ class Mp3Info
     end
   end
 
-  module NumericBits #:nodoc:
-    ### returns the selected bit range (b, a) as a number
-    ### NOTE: b > a  if not, returns 0
-    def bits(b, a)
-      t = 0
-      b.downto(a) { |i| t += t + self[i] }
-      t
-    end
-  end
-
   module Mp3FileMethods #:nodoc:
     def get32bits
       (getc << 24) + (getc << 16) + (getc << 8) + getc
     end
+
     def get_syncsafe
       (getc << 21) + (getc << 14) + (getc << 7) + getc
     end

data/lib/mp3info/id3v2.rb

@@ -121,7 +121,7 @@ class ID3v2 < DelegateClass(Hash)
   def from_io(io)
     @io = io
     version_maj, version_min, flags = @io.read(3).unpack("CCB4")
-    unsync, ext_header, experimental, footer = (0..3).collect { |i| flags[i].chr == '1' }
+    @unsync, ext_header, experimental, footer = (0..3).collect { |i| flags[i].chr == '1' }
     raise("can't find version_maj ('#{version_maj}')") unless [2, 3, 4].include?(version_maj)
     @version_maj, @version_min = version_maj, version_min
     @valid = true
@@ -178,6 +178,8 @@ class ID3v2 < DelegateClass(Hash)
     case name
       when "COMM"
 	[ @options[:encoding] == :iso ? 0 : 1, @options[:lang], 0, value ].pack("ca3ca*")
+      when /^W/ # URL link frames
+        value
       else
         if @options[:encoding] == :iso
 	  "\x00"+value
@@ -195,6 +197,8 @@ class ID3v2 < DelegateClass(Hash)
         #FIXME improve this
 	encoding, lang, str = value.unpack("ca3a*")
 	out = value.split(0.chr).last
+      when /^W/ # URL link frames
+        out = value
       else
 	encoding = value[0]     # language encoding bit 0 for iso_8859_1, 1 for unicode
 	out = value[1..-1] 
@@ -206,7 +210,7 @@ class ID3v2 < DelegateClass(Hash)
       #strip byte-order bytes at the beginning of the unicode string if they exists
       out[0..3] =~ /^[\xff\xfe]+$/ and out = out[2..-1]
       begin
-	out = Iconv.iconv("ISO-8859-1", "UNICODE", out)[0] 
+	out = Iconv.iconv("ISO-8859-1", "UTF-16", out)[0] 
       rescue Iconv::IllegalSequence, Iconv::InvalidCharacter
       end
     end
@@ -224,10 +228,26 @@ class ID3v2 < DelegateClass(Hash)
 	seek_to_v2_end
         break
       else
-        #size = @file.get_syncsafe #this seems to be a bug
+        #size = @io.get_syncsafe #this seems to be a bug
         size = @io.get32bits
-        puts "name '#{name}' size #{size} " if $DEBUG
-        @io.seek(2, IO::SEEK_CUR)     # skip flags
+	@io.read(2)
+=begin
+        size_str = @io.read(4)
+
+	@io.getc #flags part 1
+	# just read the unsync bit
+	b = @io.getc
+	unsync = ((b >> 1) & 1) == 1
+
+	if unsync
+	  size = (size_str[0] << 21) + (size_str[1] << 14) + (size_str[2]<< 7) + size_str[3]
+	else
+	  size = size_str.unpack("N").first
+	end
+	require "to_b"
+=end
+        puts "name '#{name}' size #{size}" if $DEBUG
+        #@io.seek(2, IO::SEEK_CUR)     # skip flags
         add_value_to_tag2(name, size)
 #        case name
 #          when /^T/
@@ -277,7 +297,9 @@ class ID3v2 < DelegateClass(Hash)
   ### create an array if the key already exists in the tag
   def add_value_to_tag2(name, size)
     puts "add_value_to_tag2" if $DEBUG
-    data = decode_tag(name, @io.read(size))
+    raise("tag size too big for tag #{name.inspect} unsync #{@unsync} ") if size > 50_000_000
+    data_io = @io.read(size)
+    data = decode_tag(name, data_io)
     if self.keys.include?(name)
       unless self[name].is_a?(Array)
         self[name] = self[name].to_a
@@ -286,12 +308,14 @@ class ID3v2 < DelegateClass(Hash)
     else
       self[name] = data 
     end
+    p data if $DEBUG
   end
   
   ### runs thru @file one char at a time looking for best guess of first MPEG
   ###  frame, which should be first 0xff byte after id3v2 padding zero's
   def seek_to_v2_end
     until @io.getc == 0xff
+      raise EOFError if @io.eof?
     end
     @io.seek(-1, IO::SEEK_CUR)
   end

data/test.rb

@@ -6,6 +6,7 @@ require "test/unit"
 require "base64"
 require "mp3info"
 require "fileutils"
+require "tempfile"
 
 class Mp3InfoTest < Test::Unit::TestCase
 
@@ -126,6 +127,25 @@ EOF
       assert_equal(info.length, 0.1305625)
     end
   end
+  
+  def test_vbr_mp3_length
+    temp_file_vbr = File.join(File.dirname($0), "vbr.mp3")
+
+    unless File.exists?(temp_file_vbr)
+      tempfile = Tempfile.new("ruby-mp3info_test")
+      tempfile.close
+      system("dd if=/dev/zero of=#{tempfile.path} bs=1024 count=30000")
+      raise "cannot find lame binary in path" unless system("which lame")
+      system("lame -h -v -b 112 -r -s 44.1 --bitwidth 16 #{tempfile.path} #{temp_file_vbr}")
+      tempfile.close!
+    end
+
+    Mp3Info.open(temp_file_vbr) do |info|
+      assert(info.vbr)
+      assert_equal(1152, info.samples_per_frame)
+      assert_in_delta(174.210612, info.length, 0.000001)
+    end
+  end
 
   def test_removetag1
     Mp3Info.open(TEMP_FILE) { |info| info.tag1 = @tag }
@@ -251,6 +271,38 @@ EOF
     assert_equal(tag, write_temp_file(tag))
   end
 
+  def test_infinite_loop_on_seek_to_v2_end
+    
+  end
+
+  def test_leading_char_gets_chopped
+    tag2 = BASIC_TAG2.dup
+    tag2["WOAR"] = "http://foo.bar"
+    w = write_temp_file(tag2)
+    assert_equal("http://foo.bar", w["WOAR"])
+
+    system(%(id3v2 --WOAR "http://foo.bar" "#{TEMP_FILE}"))
+
+    Mp3Info.open(TEMP_FILE) do |mp3|
+      assert_equal "http://foo.bar", mp3.tag2["WOAR"]
+    end
+  end
+
+  def test_remove_tag
+    Mp3Info.open(TEMP_FILE) do |mp3|
+      tag = mp3.tag
+      tag.title = "title"
+      tag.artist = "artist"
+      mp3.close
+      mp3.reload
+      assert !mp3.tag1.empty?, "tag is empty"
+      mp3.removetag1
+      mp3.close
+      mp3.reload
+      assert mp3.tag1.empty?, "tag is not empty"
+    end
+  end
+
     #test the tag with php getid3
 #    prog = %{
 #    <?php
@@ -266,6 +318,21 @@ EOF
 #      p io.read
 #    end
 
+  def test_good_parsing_of_a_pathname
+    fn = "Freak On `(Stone�s Club Mix).mp3"
+    File.rename(TEMP_FILE, fn)
+    begin
+      mp3 = Mp3Info.new(fn)
+      mp3.tag.title = fn
+      mp3.close
+      mp3.reload
+      assert_equal fn, mp3.tag.title 
+      mp3.close
+    ensure
+      File.delete(fn)
+    end
+  end
+
   #test the tag with the "id3v2" program
   def id3v2_prog_test(tag, written_tag)
     return if PLATFORM =~ /win32/

metadata

@@ -1,10 +1,10 @@
-!ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
 specification_version: 1
 name: ruby-mp3info
 version: !ruby/object:Gem::Version 
-  version: "0.5"
-date: 2005-12-09 00:00:00 +01:00
+  version: 0.5.1
+date: 2007-09-10 00:00:00 +02:00
 summary: ruby-mp3info is a pure-ruby library to retrieve low level informations on mp3 files and manipulate id3v1 and id3v2 tags
 require_paths: 
 - lib
@@ -12,7 +12,7 @@ email: moumar@rubyforge.org
 homepage: http://ruby-mp3info.rubyforge.org
 rubyforge_project: ruby-mp3info
 description: 
-autorequire: 
+autorequire: mp3info
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Guillaume Pierronnet
 files: 
@@ -39,8 +40,10 @@ test_files: []
 
 rdoc_options: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- EXAMPLES
 executables: []
 
 extensions: []