ruby-mp3info 0.6.13 → 0.6.14

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.6.14 / 2011-06-17
+
+* Added a check for nil that was seen causing problems when processing files. (thanks to Carl Hall)
+* Fixed reading on win32, requires binary flag. (thanks to Jonas Tingeborn)
+* Fixed white spaces. Replaced tabs with spaces to make the source readable on for users other than the original author. (thanks to Jonas Tingeborn)
+* Add :parse_mp3 flag to new/open. (thanks to Dave Lee)
+* Add benchmark for parsing performance. (thanks to Dave Lee)
+* fixed ID3v2#io_position computing, so Mp3Info#audio_content() is correct now
+
 === 0.6.13 / 2009-05-26
 
 * fixed bad mapping of artist inside id3 2.2

data/Manifest.txt

@@ -1,6 +1,6 @@
 History.txt
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 install.rb
 lib/mp3info.rb

data/{README.txt → README.rdoc}

@@ -3,7 +3,7 @@ ruby-mp3info
 by Guillaume Pierronnet
 * http://ruby-mp3info.rubyforge.org/
 * http://rubyforge.org/projects/ruby-mp3info/
-* mercurial repository since v0.6.10: http://www.bitbucket.org/moumar/ruby-mp3info/overview/
+* https://github.com/moumar/ruby-mp3info
 
 == DESCRIPTION:
 

data/Rakefile

@@ -2,6 +2,9 @@
 
 require 'rubygems'
 require 'hoe'
+
+Hoe.plugin :yard
+
 $:.unshift("./lib/")
 require 'mp3info'
 
@@ -10,10 +13,11 @@ Hoe.new('ruby-mp3info', Mp3Info::VERSION) do |p|
   p.author = "Guillaume Pierronnet"
   p.email = "moumar@rubyforge.org"
   p.summary = "ruby-mp3info is a pure-ruby library to retrieve low level informations on mp3 files and manipulate id3v1 and id3v2 tags"
-  p.description = p.paragraphs_of('README.txt', 5..9).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.description = p.paragraphs_of('README.rdoc', 5..9).join("\n\n")
+  p.url = p.paragraphs_of('README.rdoc', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.remote_rdoc_dir = ''
+  p.rdoc_locations << "rubyforge.org:/var/www/gforge-projects/ruby-mp3info/"
 end
 
 # vim: syntax=Ruby

data/lib/mp3info.rb

@@ -1,5 +1,4 @@
 # coding:utf-8
-# $Id: mp3info.rb 98 2008-09-16 11:07:31Z moumar $
 # License:: Ruby
 # Author:: Guillaume Pierronnet (mailto:moumar_AT__rubyforge_DOT_org)
 # Website:: http://ruby-mp3info.rubyforge.org/
@@ -18,7 +17,7 @@ end
 
 class Mp3Info
 
-  VERSION = "0.6.13"
+  VERSION = "0.6.14"
 
   LAYER = [ nil, 3, 2, 1]
   BITRATE = {
@@ -161,7 +160,7 @@ class Mp3Info
 
   # Test the presence of an id3v1 tag in file +filename+
   def self.hastag1?(filename)
-    File.open(filename) { |f|
+    File.open(filename,"rb") { |f|
       f.seek(-TAG1_SIZE, File::SEEK_END)
       f.read(3) == "TAG"
     }
@@ -169,7 +168,7 @@ class Mp3Info
 
   # Test the presence of an id3v2 tag in file +filename+
   def self.hastag2?(filename)
-    File.open(filename) { |f|
+    File.open(filename,"rb") { |f|
       f.read(3) == "ID3"
     }
   end
@@ -191,15 +190,15 @@ class Mp3Info
 
   # Instantiate Mp3Info object with name +filename+.
   # options hash is used for ID3v2#new. 
-  # You can specify :parse_tags => false to disable the processing 
+  # Specify :parse_tags => false to disable the processing
   # of the tags (read and write).
+  # Specify :parse_mp3 => false to disable processing of the mp3
   def initialize(filename, options = {})
     warn("#{self.class}::new() does not take block; use #{self.class}::open() instead") if block_given?
     @filename = filename
+    options = {:parse_mp3 => true, :parse_tags => true}.update(options)
     @tag_parsing_enabled = options.delete(:parse_tags)
-    if @tag_parsing_enabled == nil
-      @tag_parsing_enabled = true
-    end
+    @mp3_parsing_enabled = options.delete(:parse_mp3)
     @id3v2_options = options
     reload
   end
@@ -249,74 +248,10 @@ class Mp3Info
         @tag_orig = @tag.dup
       end
 
-
-      ### extracts MPEG info from MPEG header and stores it in the hash @mpeg
-      ###  head (fixnum) = valid 4 byte MPEG header
-      
-      found = false
-
-      head = nil
-      5.times do
-	head = find_next_frame() 
-        @first_frame_pos = @file.pos - 4
-        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
-	@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 = 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] = Mp3Info.bits(head, 1,0)
-	@vbr = false
-	found = true
-        break
+      if @mp3_parsing_enabled
+        parse_mp3
       end
 
-      raise(Mp3InfoError, "Cannot find good frame") unless found
-
-      seek = @mpeg_version == 1 ? 
-	(@channel_num == 3 ? 17 : 32) :       
-	(@channel_num == 3 ?  9 : 17)
-
-      @file.seek(seek, IO::SEEK_CUR)
-      
-      vbr_head = @file.read(4)
-      if vbr_head == "Xing"
-	puts "Xing header (VBR) detected" if $DEBUG
-	flags = @file.get32bits
-	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
-
-        samples_per_frame = SAMPLES_PER_FRAME[@layer][@mpeg_version] 
-	@length = frame_count * samples_per_frame / Float(@samplerate)
-
-	@bitrate = (((stream_size/frame_count)*@samplerate)/144) / 1024
-	@vbr = true
-      else
-	# 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
-        # 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
-      end
     ensure
       @file.close
     end
@@ -403,9 +338,9 @@ class Mp3Info
 
       # @tag1 has precedence over @tag
       if @tag1 == @tag1_orig
-	@tag.each do |k, v|
-	  @tag1[k] = v
-	end
+        @tag.each do |k, v|
+          @tag1[k] = v
+        end
       end
 
       # ruby-mp3info can only write v2.3 tags
@@ -452,28 +387,28 @@ class Mp3Info
       raise(Mp3InfoError, "file is not writable") unless File.writable?(@filename)
       tempfile_name = nil
       File.open(@filename, 'rb+') do |file|
-	#if tag2 already exists, seek to end of it
-	if @tag2.parsed?
-	  file.seek(@tag2.io_position)
-	end
+        #if tag2 already exists, seek to end of it
+        if @tag2.parsed?
+          file.seek(@tag2.io_position)
+        end
   #      if @file.read(3) == "ID3"
   #        version_maj, version_min, flags = @file.read(3).unpack("CCB4")
   #        unsync, ext_header, experimental, footer = (0..3).collect { |i| flags[i].chr == '1' }
-  #	tag2_len = @file.get_syncsafe
+  #        tag2_len = @file.get_syncsafe
   #        @file.seek(@file.get_syncsafe - 4, IO::SEEK_CUR) if ext_header
-  #	@file.seek(tag2_len, IO::SEEK_CUR)
+  #        @file.seek(tag2_len, IO::SEEK_CUR)
   #      end
-	tempfile_name = @filename + ".tmp"
-	File.open(tempfile_name, "wb") do |tempfile|
-	  unless @tag2.empty?
-	    tempfile.write(@tag2.to_bin)
-	  end
-
-	  bufsiz = file.stat.blksize || 4096
-	  while buf = file.read(bufsiz)
-	    tempfile.write(buf)
-	  end
-	end
+        tempfile_name = @filename + ".tmp"
+        File.open(tempfile_name, "wb") do |tempfile|
+          unless @tag2.empty?
+            tempfile.write(@tag2.to_bin)
+          end
+
+          bufsiz = file.stat.blksize || 4096
+          while buf = file.read(bufsiz)
+            tempfile.write(buf)
+          end
+        end
       end
       File.rename(tempfile_name, @filename)
     end
@@ -499,7 +434,7 @@ class Mp3Info
   # 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.open(@filename, 'rb') do |file|
       file.seek(@first_frame_pos, File::SEEK_SET)
       loop do
         head = file.read(4).unpack("N").first
@@ -639,6 +574,75 @@ private
     [average_bitrate, length]
   end
 
+  def parse_mp3
+    ### extracts MPEG info from MPEG header and stores it in the hash @mpeg
+    ###  head (fixnum) = valid 4 byte MPEG header
+    
+    found = false
+
+    head = nil
+    5.times do
+      head = find_next_frame() 
+      @first_frame_pos = @file.pos - 4
+      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
+      @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 = 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] = Mp3Info.bits(head, 1,0)
+      @vbr = false
+      found = true
+      break
+    end
+
+    raise(Mp3InfoError, "Cannot find good frame") unless found
+
+    seek = @mpeg_version == 1 ? 
+      (@channel_num == 3 ? 17 : 32) :       
+      (@channel_num == 3 ?  9 : 17)
+
+    @file.seek(seek, IO::SEEK_CUR)
+    
+    vbr_head = @file.read(4)
+    if vbr_head == "Xing"
+      puts "Xing header (VBR) detected" if $DEBUG
+      flags = @file.get32bits
+      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
+
+      samples_per_frame = SAMPLES_PER_FRAME[@layer][@mpeg_version] 
+      @length = frame_count * samples_per_frame / Float(@samplerate)
+
+      @bitrate = (((stream_size/frame_count)*@samplerate)/144) / 1024
+      @vbr = true
+    else
+      # 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
+      # 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
+    end
+  end
 
   ### returns the selected bit range (b, a) as a number
   ### NOTE: b > a  if not, returns 0

data/lib/mp3info/extension_modules.rb

@@ -1,3 +1,8 @@
+# coding:utf-8
+# License:: Ruby
+# Author:: Guillaume Pierronnet (mailto:moumar_AT__rubyforge_DOT_org)
+# Website:: http://ruby-mp3info.rubyforge.org/
+
 class Mp3Info 
   module HashKeys #:nodoc:
     ### lets you specify hash["key"] as hash.key
@@ -18,7 +23,7 @@ class Mp3Info
       alias getbyte []
     else
       def getbyte(i)
-        self[i].ord
+        self[i].ord unless self[i].nil?
       end
     end
   end

data/lib/mp3info/id3v2.rb

@@ -1,3 +1,8 @@
+# coding:utf-8
+# License:: Ruby
+# Author:: Guillaume Pierronnet (mailto:moumar_AT__rubyforge_DOT_org)
+# Website:: http://ruby-mp3info.rubyforge.org/
+
 require "delegate"
 require "iconv"
 
@@ -223,7 +228,6 @@ class ID3v2 < DelegateClass(Hash)
     raise(ID3v2Error, "can't find version_maj ('#{version_maj}')") unless [2, 3, 4].include?(version_maj)
     @version_maj, @version_min = version_maj, version_min
     @tag_length = @io.get_syncsafe
-    @io_position = original_pos + @tag_length
     
     @parsed = true
     begin
@@ -238,6 +242,8 @@ class ID3v2 < DelegateClass(Hash)
     rescue ID3v2Error => e
       warn("warning: id3v2 tag not fully parsed: #{e.message}")
     end
+    @io_position = @io.pos
+    @tag_length = @io_position - original_pos
 
     @hash_orig = @hash.dup
     #no more reading
@@ -339,7 +345,7 @@ class ID3v2 < DelegateClass(Hash)
 	  end
 	end
         # remove padding zeros for textual tags
-        out.sub!(/\0*$/, '')
+        out.sub!(/\0*$/, '') unless out.nil?
         return out
       else
         return raw_value

data/test/test_ruby-mp3info.rb

@@ -441,6 +441,16 @@ class Mp3InfoTest < Test::Unit::TestCase
     end
   end
 
+  def test_audio_content_problematic
+    File.open(TEMP_FILE, "w") { |f| f.write(FIXTURES["audio_content_fixture"]) }
+    Mp3Info.open(TEMP_FILE) do |mp3|
+      expected_pos = 150
+      audio_content_pos, audio_content_size = mp3.audio_content
+      assert_equal expected_pos, audio_content_pos
+      assert_equal File.size(TEMP_FILE) - expected_pos, audio_content_size
+    end
+  end
+
   def test_headerless_vbr_file
     mp3_length = 3
     # this will generate a 15 sec mp3 file (44100hz*16bit*2channels) = 60/4 = 15

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-mp3info
 version: !ruby/object:Gem::Version 
-  version: 0.6.13
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 6
+  - 14
+  version: 0.6.14
 platform: ruby
 authors: 
 - Guillaume Pierronnet
@@ -9,20 +15,80 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-26 00:00:00 +02:00
-default_executable: 
+date: 2011-06-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: hoe-yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        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"
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id002
+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: []
 
@@ -31,43 +97,50 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - install.rb
 - lib/mp3info.rb
 - lib/mp3info/extension_modules.rb
 - lib/mp3info/id3v2.rb
 - test/test_ruby-mp3info.rb
-has_rdoc: true
 homepage: 
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --title
+- RubyMp3info Documentation
+- --quiet
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: ruby-mp3info
-rubygems_version: 1.3.1
+rubygems_version: 1.8.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: ruby-mp3info is a pure-ruby library to retrieve low level informations on mp3 files and manipulate id3v1 and id3v2 tags
 test_files: 
 - test/test_ruby-mp3info.rb