ruby-mp3info 0.6.7 → 0.6.8

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.6.8 / 2008-08-20
+
+* support for MPEG 2.5 (thanks to Oleguer Huguet Ibars)
+* support for vbr files without Xing header
+
 === 0.6.7 / 2008-06-26
 
 * Mp3Info#header hash now gives access to additional mpeg attributes (thanks to Andrew Kuklewicz)

data/README.txt

@@ -14,6 +14,7 @@ mp3 files.
 * 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:

data/lib/mp3info.rb

@@ -1,5 +1,5 @@
 # coding:utf-8
-# $Id: mp3info.rb 90 2008-06-26 09:49:38Z moumar $
+# $Id: mp3info.rb 94 2008-08-19 13:34:18Z moumar $
 # License:: Ruby
 # Author:: Guillaume Pierronnet (mailto:moumar_AT__rubyforge_DOT_org)
 # Website:: http://ruby-mp3info.rubyforge.org/
@@ -18,24 +18,33 @@ end
 
 class Mp3Info
 
-  VERSION = "0.6.7"
+  VERSION = "0.6.8"
 
   LAYER = [ nil, 3, 2, 1]
-  BITRATE = [
+  BITRATE = {
+    1 => 
     [
       [32, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 448],
       [32, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 384],
       [32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320] ],
+    2 => 
+    [
+      [32, 48, 56, 64, 80, 96, 112, 128, 144, 160, 176, 192, 224, 256],
+      [8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160],
+      [8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160]
+    ],
+    2.5 => 
     [
       [32, 48, 56, 64, 80, 96, 112, 128, 144, 160, 176, 192, 224, 256],
       [8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160],
       [8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160]
     ]
-  ]
-  SAMPLERATE = [
-    [ 44100, 48000, 32000 ],
-    [ 22050, 24000, 16000 ]
-  ]
+  }
+  SAMPLERATE = {
+    1 => [ 44100, 48000, 32000 ],
+    2 => [ 22050, 24000, 16000 ],
+    2.5 => [ 11025, 12000, 8000 ]
+  }
   CHANNEL_MODE = [ "Stereo", "JStereo", "Dual Channel", "Single Channel"]
 
   GENRES = [
@@ -94,9 +103,10 @@ class Mp3Info
   
   # 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
+    nil,
+    {1=>384, 2=>384, 2.5=>384},    # Layer I   
+    {1=>1152, 2=>1152, 2.5=>1152}, # Layer II
+    {1=>1152, 2=>576, 2.5=>576}    # Layer III
   ]
 
   # mpeg version = 1 or 2
@@ -117,9 +127,6 @@ class Mp3Info
   # variable bitrate => true or false
   attr_reader(:vbr)
 
-  # only used in vbr mode
-  attr_reader(:samples_per_frame)
-
   # Hash representing values in the MP3 frame header. Keys are one of the following:
   # - :private (boolean)
   # - :copyright (boolean)
@@ -244,15 +251,17 @@ class Mp3Info
       
       found = false
 
+      head = nil
       5.times do
 	head = find_next_frame() 
-	@mpeg_version = [2, 1][head[19]]
-	@layer = LAYER[bits(head, 18,17)]
-	next if @layer.nil?
+        @first_frame_pos = @file.pos - 4
+        current_frame = get_frames_infos(head)
+	@mpeg_version = current_frame[:mpeg_version]
+	@layer = current_frame[:layer]
 	@header[:error_protection] = head[16] == 0 ? true : false
-	@bitrate = BITRATE[@mpeg_version-1][@layer-1][bits(head, 15,12)-1]
-	@samplerate = SAMPLERATE[@mpeg_version-1][bits(head, 11,10)]
-	@header[:padding] = (head[9] == 1 ? true : false)
+	@bitrate = current_frame[:bitrate]
+	@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)
@@ -261,12 +270,11 @@ class Mp3Info
 	@header[:emphasis] = bits(head, 1,0)
 	@vbr = false
 	found = true
-	break
+        break
       end
 
       raise(Mp3InfoError, "Cannot find good frame") unless found
 
-
       seek = @mpeg_version == 1 ? 
 	(@channel_num == 3 ? 17 : 32) :       
 	(@channel_num == 3 ?  9 : 17)
@@ -277,24 +285,33 @@ class Mp3Info
       if vbr_head == "Xing"
 	puts "Xing header (VBR) detected" if $DEBUG
 	flags = @file.get32bits
-	@streamsize = @frames = 0
-	flags[1] == 1 and @frames = @file.get32bits
-	flags[2] == 1 and @streamsize = @file.get32bits 
-	puts "#{@frames} frames" if $DEBUG
-	raise(Mp3InfoError, "bad VBR header") if @frames.zero?
+	stream_size = frame_count = 0
+	flags[1] == 1 and frame_count = @file.get32bits
+	flags[2] == 1 and stream_size = @file.get32bits 
+	puts "#{frame_count} frames" if $DEBUG
+	raise(Mp3InfoError, "bad VBR header") if frame_count.zero?
 	# 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
+	#@vbr_quality = @file.get32bits if flags[3] == 1
 
-        @samples_per_frame = SAMPLES_PER_FRAME[@layer-1][@mpeg_version-1] 
-	@length = @frames * @samples_per_frame / Float(@samplerate)
+        samples_per_frame = SAMPLES_PER_FRAME[@layer][@mpeg_version] 
+	@length = frame_count * samples_per_frame / Float(@samplerate)
 
-	@bitrate = (((@streamsize/@frames)*@samplerate)/144) >> 10
+	@bitrate = (((stream_size/frame_count)*@samplerate)/144) >> 10
 	@vbr = true
       else
 	# for cbr, calculate duration with the given bitrate
-	@streamsize = @file.stat.size - (hastag1? ? TAG1_SIZE : 0) - (@tag2.valid? ? @tag2.io_position : 0)
-	@length = ((@streamsize << 3)/1000.0)/@bitrate
+	stream_size = @file.stat.size - (hastag1? ? TAG1_SIZE : 0) - (@tag2.valid? ? @tag2.io_position : 0)
+	@length = ((stream_size << 3)/1000.0)/@bitrate
+        # 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
+          end
+        rescue Mp3InfoInternalError
+        end
 	if @tag2["TLEN"]
 	  # but if another duration is given and it isn't close (within 5%)
 	  #  assume the mp3 is vbr and go with the given duration
@@ -305,7 +322,7 @@ class Mp3Info
 	    # every single frame
 	    @vbr = true
 	    @length = @tag2["TLEN"].to_i/1000
-	    @bitrate = (@streamsize / @bitrate) >> 10
+	    @bitrate = (stream_size / @bitrate) >> 10
 	  end
 	end
       end
@@ -314,6 +331,25 @@ class Mp3Info
     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)]
+    { :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)
@@ -539,7 +575,6 @@ private
     # It should be at byte 0 when there's no id3v2 tag.
     # It should be at the end of the id3v2 tag or the zero padding if there
     #   is a id3v2 tag.
-
     #dummyproof = @file.stat.size - @file.pos => WAS TOO MUCH
     dummyproof = [ @file.stat.size - @file.pos, 2000000 ].min
     dummyproof.times do |i|
@@ -547,29 +582,48 @@ private
         data = @file.read(3)
         raise(Mp3InfoError, "end of file reached") if @file.eof?
         head = 0xff000000 + (data.getbyte(0) << 16) + (data.getbyte(1) << 8) + data.getbyte(2)
-        if check_head(head)
-            return head
-        else
-            @file.seek(-3, IO::SEEK_CUR)
+        begin
+          get_frames_infos(head)
+          return head
+        rescue Mp3InfoInternalError
+          @file.seek(-3, IO::SEEK_CUR)
         end
       end
     end
-    raise Mp3InfoError, "cannot find a valid frame after reading #{dummyproof} bytes"
+    if @file.eof?
+      raise Mp3InfoError, "cannot find a valid frame: got EOF"
+    else
+      raise Mp3InfoError, "cannot find a valid frame after reading #{dummyproof} bytes"
+    end
   end
 
-  ### checks the given header to see if it is valid
-  ###  head (fixnum) = 4 byte value to test for MPEG header validity
-  ### returns true if valid, false if not
-  def check_head(head)
-    return false if head & 0xffe00000 != 0xffe00000    # 11 bit MPEG frame sync
-    return false if head & 0x00060000 == 0x00060000    #  2 bit layer type
-    return false if head & 0x0000f000 == 0x0000f000    #  4 bit bitrate
-    return false if head & 0x0000f000 == 0x00000000    #        free format bitstream
-    return false if head & 0x00000c00 == 0x00000c00    #  2 bit frequency
-    return false if head & 0xffff0000 == 0xfffe0000
-    true
+  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]
+      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)
+    [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)

data/lib/mp3info/id3v2.rb

@@ -225,7 +225,13 @@ class ID3v2 < DelegateClass(Hash)
       # in id3v2.3 tags, there is only 2 encodings possible
       transcoded_value = value
       if text_encoding_index >= 2
-	transcoded_value = Iconv.iconv(TEXT_ENCODINGS[1], TEXT_ENCODINGS[text_encoding_index], value).first
+        begin
+	  transcoded_value = Iconv.iconv(TEXT_ENCODINGS[1], 
+					 TEXT_ENCODINGS[text_encoding_index], 
+					 value).first
+        rescue Iconv::Failure
+	  transcoded_value = value
+	end
 	text_encoding_index = 1
       end
     end

data/test/test_ruby-mp3info.rb

@@ -109,7 +109,6 @@ class Mp3InfoTest < Test::Unit::TestCase
 
     Mp3Info.open(TEMP_FILE) do |info|
       assert(info.vbr)
-      assert_equal(1152, info.samples_per_frame)
       assert_in_delta(174.210612, info.length, 0.000001)
     end
   end
@@ -405,6 +404,7 @@ class Mp3InfoTest < Test::Unit::TestCase
     end
   end
 
+=begin
   def test_should_raises_exception_when_writing_badly_encoded_frames
     assert_raises(Iconv::Failure) do 
       Mp3Info.open(TEMP_FILE, :encoding => 'utf-8') do |mp3|
@@ -412,6 +412,7 @@ class Mp3InfoTest < Test::Unit::TestCase
       end
     end
   end
+=end
 
   def test_audio_content
     require "digest/md5"
@@ -438,6 +439,19 @@ class Mp3InfoTest < Test::Unit::TestCase
     end
   end
 
+  def test_headerless_vbr_file
+    mp3_length = 3
+    # this will generate a 15 sec mp3 file (44100hz*16bit*2channels) = 60/4 = 15
+    system("dd if=/dev/urandom bs=44100 count=#{mp3_length*4}  2>/dev/null | \
+            lame -v -m s --vbr-new --preset 128 -r -s 44.1 --bitwidth 16 - -  > #{TEMP_FILE} 2>/dev/null")
+
+    Mp3Info.open(TEMP_FILE) do |mp3|
+      assert mp3.vbr
+      assert_in_delta(mp3_length, mp3.length, 0.1)
+      assert_in_delta(128, mp3.bitrate, 8)
+    end
+  end
+
   def compute_audio_content_mp3_digest(mp3)
     pos, size = mp3.audio_content
     data = File.open(mp3.filename) do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-mp3info
 version: !ruby/object:Gem::Version 
-  version: 0.6.7
+  version: 0.6.8
 platform: ruby
 authors: 
 - Guillaume Pierronnet
@@ -9,19 +9,20 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-26 00:00:00 +02:00
+date: 2008-08-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.6.0
+        version: 1.7.0
     version: 
-description: "* written in pure ruby  * read low-level informations like bitrate, length, samplerate, etc... * read, write, remove id3v1 and id3v2 tags * 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"
+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
 executables: []
 
@@ -64,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ruby-mp3info
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: ruby-mp3info is a pure-ruby library to retrieve low level informations on mp3 files and manipulate id3v1 and id3v2 tags