ruby-mp3info 0.5.1 → 0.6

data/lib/mp3info.rb

@@ -1,4 +1,4 @@
-# $Id: mp3info.rb 51 2007-09-10 11:53:52Z moumar $
+# $Id: mp3info.rb 64 2008-02-24 02:11:57Z 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.1"
+  VERSION = "0.6"
 
   LAYER = [ nil, 3, 2, 1]
   BITRATE = [
@@ -161,14 +161,16 @@ class Mp3Info
     end
   end
 
-  # Instantiate a new Mp3Info object with name +filename+
-  def initialize(filename)
+  # Instantiate Mp3Info object with name +filename+ and an
+  # options hash for ID3v2#new underlying object
+  def initialize(filename, id3v2_options = {})
     $stderr.puts("#{self.class}::new() does not take block; use #{self.class}::open() instead") if block_given?
     @filename = filename
+    @id3v2_options = id3v2_options
     reload
   end
 
-  # reload the file from disk
+  # reload (or load for the first time) the file from disk
   def reload
     raise(Mp3InfoError, "empty file") unless File.size?(@filename)
     @hastag1 = false
@@ -176,7 +178,7 @@ class Mp3Info
     @tag1 = {}
     @tag1.extend(HashKeys)
 
-    @tag2 = ID3v2.new
+    @tag2 = ID3v2.new(@id3v2_options)
 
     @file = File.new(filename, "rb")
     @file.extend(Mp3FileMethods)
@@ -283,8 +285,8 @@ class Mp3Info
   end
 
   # "block version" of Mp3Info::new()
-  def self.open(filename)
-    m = self.new(filename)
+  def self.open(*params)
+    m = self.new(*params)
     ret = nil
     if block_given?
       begin
@@ -307,6 +309,7 @@ class Mp3Info
     self
   end
   
+  # Remove id3v2 from mp3
   def removetag2
     @tag2.clear
     self
@@ -397,7 +400,6 @@ class Mp3Info
 	tempfile_name = @filename + ".tmp"
 	File.open(tempfile_name, "wb") do |tempfile|
 	  unless @tag2.empty?
-	    tempfile.write("ID3")
 	    tempfile.write(@tag2.to_bin)
 	  end
 

data/lib/mp3info/id3v2.rb

@@ -1,8 +1,11 @@
 require "mp3info/extension_modules"
+require "iconv"
 
 # This class is not intended to be used directly
 class ID3v2 < DelegateClass(Hash) 
-  VERSION_MAJ = 3
+  
+  # Major version used when writing tags
+  WRITE_VERSION = 3
   
   TAGS = {
     "AENC" => "Audio encryption",
@@ -81,22 +84,33 @@ class ID3v2 < DelegateClass(Hash)
     "WXXX" => "User defined URL link frame"
   }
 
+  # See id3v2.4.0-structure document, at section 4.
+  TEXT_ENCODINGS = ["iso-8859-1", "utf-16", "utf-16be", "utf-8"]
+
   include Mp3Info::HashKeys
   
   attr_reader :io_position
 
-  # possibles keys:
-  # :+lang+ for writing comments
-  # :+encoding+: :+iso+ or :+unicode+ 
+  # :+lang+: for writing comments
+  #
+  # :+encoding+: one of the string of +TEXT_ENCODINGS+, 
+  # used as a source and destination encoding respectively
+  # for read and write tag2 values.
   attr_reader :options
   
   def initialize(options = {})
     @options = { 
-      :lang => "ENG", 
-      :encoding => :iso  #language encoding bit 0 for iso_8859_1, 1 for unicode
+      :lang => "ENG",
+      :encoding => "iso-8859-1"
     }
+
     @options.update(options)
+    @text_encoding_index = TEXT_ENCODINGS.index(@options[:encoding])
     
+    unless @text_encoding_index
+      raise(ArgumentError, "bad id3v2 text encoding specified")
+    end
+
     @hash = {}
     #TAGS.keys.each { |k| @hash[k] = nil }
     @hash_orig = {}
@@ -105,19 +119,22 @@ class ID3v2 < DelegateClass(Hash)
     @version_maj = @version_min = nil
   end
 
+  # does this tag correctly read ?
   def valid?
     @valid
   end
 
+  # does this tag has been changed ?
   def changed?
     @hash_orig != @hash
   end
   
+  # full version of this tag (like 2.3.0)
   def version
     "2.#{@version_maj}.#{@version_min}"
   end
 
-  ### gets id3v2 tag information from io
+  ### gets id3v2 tag information from io object (must support #seek() method)
   def from_io(io)
     @io = io
     version_maj, version_min, flags = @io.read(3).unpack("CCB4")
@@ -142,6 +159,7 @@ class ID3v2 < DelegateClass(Hash)
     # we should now have io sitting at the first MPEG frame
   end
 
+  # dump tag for writing. Version is always 2.#{WRITE_VERSION}.0.
   def to_bin
     #TODO handle of @tag2[TLEN"]
     #TODO add of crc
@@ -151,7 +169,7 @@ class ID3v2 < DelegateClass(Hash)
     @hash.each do |k, v|
       next unless v
       next if v.respond_to?("empty?") and v.empty?
-      data = encode_tag(k, v.to_s)
+      data = encode_tag(k, v.to_s, WRITE_VERSION)
       #data << "\x00"*2 #End of tag
 
       tag << k[0,4]   #4 characte max for a tag's key
@@ -161,9 +179,9 @@ class ID3v2 < DelegateClass(Hash)
       tag << data
     end
 
-    tag_str = ""
+    tag_str = "ID3"
     #version_maj, version_min, unsync, ext_header, experimental, footer 
-    tag_str << [ VERSION_MAJ, 0, "0000" ].pack("CCB4")
+    tag_str << [ WRITE_VERSION, 0, "0000" ].pack("CCB4")
     tag_str << to_syncsafe(tag.size)
     tag_str << tag
     p tag_str if $DEBUG
@@ -172,21 +190,26 @@ class ID3v2 < DelegateClass(Hash)
 
   private
 
+  def encode_tag(name, value, version)
+    puts "encode_tag(#{name.inspect}, #{value.inspect}, #{version})" if $DEBUG
+
+    text_encoding_index = @text_encoding_index 
+    if version == 3
+      # 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)[0]
+	text_encoding_index = 1
+      end
+    end
 
-  def encode_tag(name, value)
-    puts "encode_tag(#{name.inspect}, #{value.inspect})" if $DEBUG
     case name
       when "COMM"
-	[ @options[:encoding] == :iso ? 0 : 1, @options[:lang], 0, value ].pack("ca3ca*")
-      when /^W/ # URL link frames
+	[ text_encoding_index , @options[:lang], 0, transcoded_value ].pack("ca3ca*")
+      when "UFID", /^W/ # URL link frames
         value
       else
-        if @options[:encoding] == :iso
-	  "\x00"+value
-	else
-	  "\x01"+value #Iconv.iconv("UNICODE", "ISO-8859-1", value)[0]
-	end
-      #data << "\x00"   
+	text_encoding_index.chr + transcoded_value
     end
   end
 
@@ -197,22 +220,18 @@ class ID3v2 < DelegateClass(Hash)
         #FIXME improve this
 	encoding, lang, str = value.unpack("ca3a*")
 	out = value.split(0.chr).last
-      when /^W/ # URL link frames
+      when "UFID", /^W/ # URL link frames
         out = value
       else
-	encoding = value[0]     # language encoding bit 0 for iso_8859_1, 1 for unicode
+	encoding = value[0]     # language encoding (see TEXT_ENCODINGS constant)
 	out = value[1..-1] 
     end
-
-    if encoding == 1 #and name[0] == ?T
-      require "iconv"
-      
-      #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", "UTF-16", out)[0] 
-      rescue Iconv::IllegalSequence, Iconv::InvalidCharacter
-      end
+    
+    printf("encoding: %d, value: %s\n", encoding, value.inspect) if $DEBUG
+    # we need to convert the string in order to match
+    # the requested encoding
+    if encoding && encoding != @text_encoding_index
+      out = Iconv.iconv(@options[:encoding], TEXT_ENCODINGS[encoding], out)[0]
     end
     out
   end

data/{test.rb → test/test_ruby-mp3info.rb}

@@ -21,10 +21,6 @@ class Mp3InfoTest < Test::Unit::TestCase
     "TRCK" => "tracknum"
   }
   
-  # aliasing to allow testing with old versions of Test::Unit
-  alias set_up setup 
-  alias tear_down teardown
-
   def setup
     # Command to create a dummy MP3
     # dd if=/dev/zero bs=1024 count=15 | lame --preset cbr 128 -r -s 44.1 --bitwidth 16 - - | ruby -rbase64 -e 'print Base64.encode64($stdin.read)'
@@ -94,7 +90,6 @@ EOF
     FileUtils.rm_f(TEMP_FILE)
   end
 
-
   def test_to_s
     Mp3Info.open(TEMP_FILE) { |info| assert(info.to_s.is_a?(String)) }
   end
@@ -104,15 +99,15 @@ EOF
       str = "0"*1024*1024
       f.write(str)
     end
-    assert_raises(Mp3InfoError) {
+    assert_raises(Mp3InfoError) do
       mp3 = Mp3Info.new(TEMP_FILE)
-    }
+    end
   end
 
   def test_is_an_mp3
-    assert_nothing_raised {
+    assert_nothing_raised do
       Mp3Info.new(TEMP_FILE).close
-    }
+    end
   end
   
   def test_detected_info
@@ -129,7 +124,7 @@ EOF
   end
   
   def test_vbr_mp3_length
-    temp_file_vbr = File.join(File.dirname($0), "vbr.mp3")
+    temp_file_vbr = File.join(File.dirname($0), "test_vbr_length.mp3")
 
     unless File.exists?(temp_file_vbr)
       tempfile = Tempfile.new("ruby-mp3info_test")
@@ -235,7 +230,7 @@ EOF
 
   def test_id3v2_version
     written_tag = write_temp_file(BASIC_TAG2)
-    assert_equal( "2.3.0", written_tag.version )
+    assert_equal( "2.#{ID3v2::WRITE_VERSION}.0", written_tag.version )
   end
 
   def test_id3v2_methods
@@ -254,6 +249,30 @@ EOF
     id3v2_prog_test(BASIC_TAG2, w)
   end
 
+  #test the tag with the "id3v2" program
+  def id3v2_prog_test(tag, written_tag)
+    return if RUBY_PLATFORM =~ /win32/
+    return if `which id3v2`.empty?
+    start = false
+    id3v2_output = {}
+    `id3v2 -l #{TEMP_FILE}`.each do |line|
+      if line =~ /^id3v2 tag info/
+        start = true 
+	next    
+      end
+      next unless start
+      k, v = /^(.{4}) \(.+\): (.+)$/.match(line)[1,2]
+      case k
+	#COMM (Comments): ()[spa]: fmg
+        when "COMM"
+	  v.sub!(/\(\)\[.{3}\]: (.+)/, '\1')
+      end
+      id3v2_output[k] = v
+    end
+
+    assert_equal( id3v2_output, written_tag, "id3v2 program output doesn't match")
+  end
+
   def test_id3v2_trash
   end
 
@@ -319,7 +338,7 @@ EOF
 #    end
 
   def test_good_parsing_of_a_pathname
-    fn = "Freak On `(Stone�s Club Mix).mp3"
+    fn = "Freak On `(Stone´s Club Mix).mp3"
     File.rename(TEMP_FILE, fn)
     begin
       mp3 = Mp3Info.new(fn)
@@ -333,28 +352,38 @@ EOF
     end
   end
 
-  #test the tag with the "id3v2" program
-  def id3v2_prog_test(tag, written_tag)
-    return if PLATFORM =~ /win32/
-    return if `which id3v2`.empty?
-    start = false
-    id3v2_output = {}
-    `id3v2 -l #{TEMP_FILE}`.each do |line|
-      if line =~ /^id3v2 tag info/
-        start = true 
-	next    
-      end
-      next unless start
-      k, v = /^(.{4}) \(.+\): (.+)$/.match(line)[1,2]
-      case k
-	#COMM (Comments): ()[spa]: fmg
-        when "COMM"
-	  v.sub!(/\(\)\[.{3}\]: (.+)/, '\1')
-      end
-      id3v2_output[k] = v
+  def test_validity_of_id3v2_options
+    info = Mp3Info.new(TEMP_FILE)
+    expected_hash = { :lang => "ENG", :encoding => "iso-8859-1" }
+    assert_equal( expected_hash, info.tag2.options)
+
+    assert_raises(ArgumentError) do
+      Mp3Info.new(TEMP_FILE, :encoding => "bad encoding")
     end
+  end
 
-    assert_equal( id3v2_output, written_tag, "id3v2 program output doesn't match")
+  def test_encoding_read
+    Mp3Info.open(TEMP_FILE) do |mp3|
+      mp3.tag2['TEST'] = "all\xe9"
+    end
+
+    Mp3Info.open(TEMP_FILE, :encoding => "utf-8") do |mp3|
+      assert_equal "all\xc3\xa9", mp3.tag2['TEST']
+    end
+
+    Mp3Info.open(TEMP_FILE, :encoding => "iso-8859-1") do |mp3|
+      assert_equal "all\xe9", mp3.tag2['TEST']
+    end
+  end
+
+  def test_encoding_write
+    Mp3Info.open(TEMP_FILE, :encoding => 'utf-8') do |mp3|
+      mp3.tag2['TEST'] = "all\xc3\xa9"
+    end
+
+    Mp3Info.open(TEMP_FILE, :encoding => "iso-8859-1") do |mp3|
+      assert_equal "all\xe9", mp3.tag2['TEST']
+    end
   end
 
   def write_temp_file(tag)

metadata

@@ -1,54 +1,72 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: ruby-mp3info
 version: !ruby/object:Gem::Version 
-  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
-email: moumar@rubyforge.org
-homepage: http://ruby-mp3info.rubyforge.org
-rubyforge_project: ruby-mp3info
-description: 
-autorequire: mp3info
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: "0.6"
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Guillaume Pierronnet
-files: 
-- README
-- CHANGELOG
-- EXAMPLES
-- test.rb
-- lib/mp3info.rb
-- lib/mp3info/extension_modules.rb
-- lib/mp3info/id3v2.rb
-test_files: []
-
-rdoc_options: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
-extra_rdoc_files: 
-- README
-- CHANGELOG
-- EXAMPLES
+date: 2008-02-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.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"
+email: moumar@rubyforge.org
 executables: []
 
 extensions: []
 
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- install.rb
+- lib/mp3info.rb
+- lib/mp3info/extension_modules.rb
+- lib/mp3info/id3v2.rb
+- test/test_ruby-mp3info.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: ruby-mp3info
+rubygems_version: 1.0.1
+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
+test_files: 
+- test/test_ruby-mp3info.rb