id3lib-ruby 0.5.0 → 0.6.0

data/lib/id3lib.rb

@@ -9,7 +9,7 @@ require 'id3lib/accessors'
 # Have a look at ID3Lib::Tag for an introduction on how to use this library.
 #
 module ID3Lib
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 
   # ID3 version 1. All V constants can be used with the methods
   # new, update! or strip! of ID3Lib::Tag. 
@@ -69,7 +69,8 @@ module ID3Lib
   #
   # There are a number of accessors for text frames like
   # title, performer, album, track, year, comment and genre. Have a look
-  # at ID3Lib::Accessors for a complete list.
+  # at ID3Lib::Accessors for a complete list. They can only be used for
+  # text that is encoded with ISO-8859-1.
   #
   #    tag.title    #=> "Shy Boi"
   #
@@ -95,13 +96,17 @@ module ID3Lib
   #    # Also raises an exception:
   #    tag.find{ |f| f[:id] == :TLAN }[:text]
   #
-  # Because only text frames can be set with accessors, you have to add
-  # special frames by hand.
+  # Because only ISO-8859-1 encoded text frames can be set with accessors, you
+  # have to add special frames by hand.
   #
   #    # Add two comments
   #    tag << {:id => :COMM, :text => 'chunky bacon'}
   #    tag << {:id => :COMM, :text => 'really.'}
   #
+  #    # Add an UTF-16 text frame with BOM (byte order mark)
+  #    tag << {:id => :TIT2, :text => "\xff\xfe\x60\x4f\x7d\x59",
+  #            :textenc => 1}
+  #
   #    # Add an attached picture
   #    cover = {
   #      :id          => :APIC,
@@ -206,6 +211,21 @@ module ID3Lib
       f ? f[:text] : nil
     end
 
+    #
+    # Get the text of a user frame specified by _description_.
+    # Returns nil if the frame can't be found.
+    #
+    #    tag.user_frame_text('MusicBrainz Album Id')
+    #    #=> "f0d6c31f-8f9f-47fe-b5f5-3b96746b48fa"
+    #
+    #    tag.user_frame_text('MusicBrainz Album Artist Id')
+    #    #=> nil
+    #
+    def user_frame_text(description)
+      f = find{ |f| f[:id] == :TXXX && f[:description] == description }
+      f ? f[:text] : nil
+    end
+
     #
     # Set the text of a frame. First, all frames with the specified _id_ are
     # deleted and then a new frame with _text_ is appended.

data/test/test_reading.rb

@@ -31,6 +31,23 @@ class TestReading < Test::Unit::TestCase
     assert_equal 'Pop',           @tag.genre
   end
 
+  def test_frame_text
+    assert_equal 'Dummy Title',   @tag.frame_text(:TIT2)
+    assert_equal 'Dummy Artist',  @tag.frame_text(:TPE1)
+    assert_equal 'Dummy Album',   @tag.frame_text(:TALB)
+    assert_equal '1/10',          @tag.frame_text(:TRCK)
+    assert_equal '2000',          @tag.frame_text(:TYER)
+    assert_equal 'Dummy Comment', @tag.frame_text(:COMM)
+    assert_equal 'Pop',           @tag.frame_text(:TCON)
+    assert_equal nil,             @tag.frame_text(:AENC)
+  end
+
+  def test_user_frame_text
+    album_id = @tag.user_frame_text('MusicBrainz Album Id')
+    assert_equal '992dc19a-5631-40f5-b252-fbfedbc328a9', album_id
+    assert_equal nil, @tag.user_frame_text('Inexistent')
+  end
+
   def test_comments
     one, two = @tag.comment_frames
     assert_not_nil one

data/test/test_unicode.rb

@@ -54,6 +54,16 @@ class TestUnicode < Test::Unit::TestCase
     assert_equal "\x4f\x60\x59\x7d", @tag.title
   end
 
+  def test_reading_lyrics
+    @tag = ID3Lib::Tag.new('test/data/unicode.mp3', ID3Lib::V2)
+    lyrics = @tag.find{ |f| f[:id] == :USLT }
+    assert_equal 1, lyrics[:textenc]
+    assert_equal "zho", lyrics[:language]
+    # This is "U+6771 U+4EAC" (Tokyo) in UTF-16BE
+    tokyo = "\x67\x71\x4e\xac"
+    assert_equal tokyo, lyrics[:text]
+  end
+
   def test_invalid_data
     nonstr = 1
     @tag.reject!{ |f| f[:id] == :TIT2 }

data/test/test_writing.rb

@@ -175,7 +175,7 @@ class TestWriting < Test::Unit::TestCase
     assert_equal 2176, File.size(Temp)
     @tag.padding = false
     @tag.update!
-    assert_equal 348, File.size(Temp)
+    assert_equal 416, File.size(Temp)
   end
 
   def test_failing_update

metadata

@@ -1,37 +1,123 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: id3lib-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
-date: 2006-12-16 00:00:00 +01:00
-summary: id3lib-ruby provides a Ruby interface to the id3lib C++ library for easily editing ID3 tags (v1 and v2) like with pyid3lib.
-require_paths: 
-- lib
-email: robinstocker@rubyforge.org
-homepage: http://id3lib-ruby.rubyforge.org
-rubyforge_project: id3lib-ruby
-description: 
-autorequire: 
-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: 
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Robin Stocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-16 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |
+  = id3lib-ruby
+  
+  id3lib-ruby provides a Ruby interface to the id3lib C++ library for easily
+  editing ID3 tags (v1 and v2) of MP3 audio files.
+  
+  The class documentation starts at ID3Lib::Tag.
+  
+  
+  == Features
+  
+  * Read and write ID3v1 and ID3v2 tags
+  * Simple interface for adding, changing and removing frames
+  * Quick access to common text frames like title and performer
+  * Custom data frames like attached picture (APIC)
+  * Pretty complete coverage of id3lib's features
+  * UTF-16 support (warning: id3lib writes broken UTF-16 frames)
+  * Windows binary gem available
+  
+  The CHANGES file contains a list of changes between versions.
+  
+  
+  == Installation
+  
+  See INSTALL.
+  
+  
+  == Online Information
+  
+  The home of id3lib-ruby is http://id3lib-ruby.rubyforge.org
+  
+  
+  == Usage
+  
+    require 'rubygems'
+    require 'id3lib'
+    
+    # Load a tag from a file
+    tag = ID3Lib::Tag.new('talk.mp3')
+    
+    # Get and set text frames with convenience methods
+    tag.title  #=> "Talk"
+    tag.album = 'X&Y'
+    tag.track = '5/13'
+    
+    # Tag is a subclass of Array and each frame is a Hash
+    tag[0]
+    #=> { :id => :TPE1, :textenc => 0, :text => "Coldplay" }
+    
+    # Get the number of frames
+    tag.length  #=> 7
+    
+    # Remove all comment frames
+    tag.delete_if{ |frame| frame[:id] == :COMM }
+    
+    # Get info about APIC frame to see which fields are allowed
+    ID3Lib::Info.frame(:APIC)
+    #=> [ 2, :APIC, "Attached picture",
+    #=>   [:textenc, :mimetype, :picturetype, :description, :data] ]
+    
+    # Add an attached picture frame
+    cover = {
+      :id          => :APIC,
+      :mimetype    => 'image/jpeg',
+      :picturetype => 3,
+      :description => 'A pretty picture',
+      :textenc     => 0,
+      :data        => File.read('cover.jpg')
+    }
+    tag << cover
+    
+    # Last but not least, apply changes
+    tag.update!
+  
+  
+  == Licence
+  
+  This library has Ruby's licence:
+  
+  http://www.ruby-lang.org/en/LICENSE.txt
+  
+  
+  == Author
+  
+  Robin Stocker <robinstocker at rubyforge.org>
+
+email: robinstocker@rubyforge.org
+executables: []
+
+extensions: 
+- ext/id3lib_api/extconf.rb
+extra_rdoc_files: 
+- README
+- INSTALL
+- TODO
+- CHANGES
 files: 
-- lib/id3lib.rb
 - lib/id3lib/accessors.rb
 - lib/id3lib/info.rb
+- lib/id3lib.rb
 - test/test_unicode.rb
 - test/test_writing.rb
 - test/test_reading.rb
@@ -41,34 +127,48 @@ files:
 - Rakefile
 - usage.rb
 - setup.rb
-- ext/extconf.rb
-- ext/generate_info.rb
-- ext/id3lib_api_wrap.cxx
-- ext/id3lib_api.i
-- ext/Rakefile
+- ext/id3lib_api/extconf.rb
+- ext/id3lib_api/id3lib_api_wrap.cxx
+- ext/id3lib_api/id3lib_api.i
+- ext/id3lib_api/Rakefile
 - README
 - INSTALL
 - TODO
 - CHANGES
-test_files: 
-- test/test_unicode.rb
-- test/test_writing.rb
-- test/test_reading.rb
+has_rdoc: true
+homepage: http://id3lib-ruby.rubyforge.org
+licenses: []
+
+post_install_message: 
 rdoc_options: 
 - --inline-source
 - --line-numbers
 - --main
 - README
-extra_rdoc_files: 
-- README
-- INSTALL
-- TODO
-- CHANGES
-executables: []
-
-extensions: 
-- ext/extconf.rb
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: 
 - id3lib C++ library
-dependencies: []
-
+rubyforge_project: id3lib-ruby
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: id3lib-ruby provides a Ruby interface to the id3lib C++ library for easily editing ID3 tags (v1 and v2) of MP3 audio files.
+test_files: 
+- test/test_unicode.rb
+- test/test_writing.rb
+- test/test_reading.rb

data/ext/extconf.rb

@@ -1,20 +0,0 @@
-require 'mkmf'
-
-def error msg
-  message msg + "\n"
-  abort
-end
-
-unless have_library('stdc++')
-  error "You must have libstdc++ installed."
-end
-
-unless have_library('z')
-  error "You must have zlib installed."
-end
-
-unless have_header('id3.h') and have_library('id3', 'ID3Tag_New')
-  error "You must have id3lib installed in order to use id3lib-ruby."
-end
-
-create_makefile('id3lib_api')

data/ext/generate_info.rb

@@ -1,127 +0,0 @@
-#!/usr/bin/ruby
-
-require 'enumerator'
-require 'pathname'
-
-
-id3lib_dir = Pathname.new(ARGV.first || '/home/robin/tmp/id3lib-3.8.3')
-
-globals_file = File.read(id3lib_dir + 'include/id3/globals.h')
-field_file   = File.read(id3lib_dir + 'src/field.cpp')
-
-def field_symbol(enum_name)
-  f = enum_name[/ID3FN_(.*)/, 1].downcase
-  if f == 'id'
-    :identifier
-  else
-    f.to_sym
-  end
-end
-
-
-field_groups   = {}
-allowed_fields = {}
-
-field_file.scan(/ID3_FieldDef (\w+)[^\{]+\{(.+?)\};/m) do |group, body|
-  fields = []
-  body.scan(/\{\W+(\w+)/) do |field_name, _|
-    next if field_name == "ID3FN_NOFIELD"
-    fields << field_name
-  end
-  fields.uniq!
-  fields.map!{ |f| field_symbol(f) }
-  field_groups[group] = fields
-end
-
-field_file.scan(/ID3_FrameDef ID3_FrameDefs[^\{]+\{(.+?)\};/m) do |body, _|
-  body.each_line do |line|
-    values = line.split(/\s*,\s*/)
-    next unless values.size > 1
-    frame = values[2].delete('"')
-    group = values[5]
-    next if frame.empty?
-    allowed_fields[frame.to_sym] = field_groups[group]
-  end
-end
-
-
-field_info = []
-frame_info = []
-genre_info = []
-
-globals_file.scan(/ID3_ENUM\((\w+)\)\s+\{\s+(.+?)\s+\}/m) do |name, enum|
-  case name
-  when 'ID3_FieldID'
-    id = 0
-    enum.scan(/([^\s,]+)(?: = (\d+),|,)\s*\/\*\*< ([^*]+)\s+\*\//m) do |field, newid, description|
-      id = newid.to_i if newid
-
-      field = field_symbol(field)
-      field_info << [id, field, description]
-
-      id += 1
-    end
-  when 'ID3_FrameID'
-    id = 0
-    enum.scan(/\/\* (\S+) \*\/ [^\s,]+(?: = (\d+),|,)\s*\/\*\*< ([^*]+)\s+\*\//m) do |frame, newid, description|
-      id = newid.to_i if newid
-      frame = (frame == '????') ? :____ : frame.to_sym
-
-      fields = allowed_fields[frame] || []
-
-      frame_info << [id, frame, description, fields]
-      id += 1
-    end
-  end
-end
-
-globals_file.scan(/(ID3_v1_genre_description).+?\{(.+?)\}/m) do |name, list|
-  id = 0
-  list.scan(/"([^"]+)"/) do |genre|
-    genre_info << genre.first
-    id += 1
-  end
-end
-
-
-def indent level, text
-  puts ' ' * level + text
-end
-
-indent 4, "Frames = ["
-frame_info.each do |f|
-  comment = case f[1]
-  when :____ : "# Special frames"
-  when :TALB : "# Text information frames"
-  when :UFID : "# Special frames again"
-  when :WCOM : "# URL link frames"
-  end
-  indent 6, comment if comment
-  indent 6, f.inspect + ","
-end
-indent 4, "]"
-
-indent 4, "FramesByID = {"
-frame_info.each do |f|
-  indent 6, f[1].inspect + " => Frames[" + f[0].to_s + "],"
-end
-indent 4, "}"
-
-indent 4, "Fields = ["
-field_info.each do |f|
-  indent 6, f.inspect + ","
-end
-indent 4, "]"
-
-indent 4, "FieldsByID = {"
-field_info.each do |f|
-  indent 6, f[1].inspect.ljust(16) + " => Fields[" + f[0].to_s + "],"
-end
-indent 4, "}"
-
-indent 4, "Genres = ["
-genre_info.each_slice(4) do |gs|
-  indent 6, "# Winamp extensions" if gs.first == "Folk"
-  indent 6, gs.map{ |g| g.inspect }.join(", ") + ","
-end
-indent 4, "]"