id3lib-ruby 0.4.1-mswin32 → 0.5.0-mswin32

data/CHANGES

@@ -1,5 +1,18 @@
 = id3lib-ruby changes
 
+=== 0.5.0 (2006-12-16)
+
+* Warn when encountering nil field instead of raising exception (bug 6446).
+* Corrected allowed fields - they are now generated from id3lib's source.
+* Renamed :id field to :identifier because of confusion with frame ID.
+* Added INSTALL document for installation instructions.
+* Fixed memory leak in extension, where iterator was never released.
+  According to tests, there is no memory leak anymore.
+* Added two patches for id3lib in mswin32 gem:
+  * unicode16: fixes Unicode writing bug
+  * convert_i-leak: fixes memory leak in Unicode conversion function
+* Updated to SWIG 1.3.31.
+
 === 0.4.1 (r53)
 
 * Added :description to the allowed fields of :TXXX frames (patch 5484).

data/INSTALL

@@ -0,0 +1,57 @@
+= id3lib-ruby installation instructions
+
+== Binary package (Windows)
+
+There are precompiled binary gems available for Windows, so the installation
+is as simple as typing the following and selecting the newest mswin32 gem:
+
+  gem install id3lib-ruby
+
+== Source package
+
+For other systems, there is a RubyGems package or a compressed archive.
+
+=== Prerequisites
+
+Before installing id3lib-ruby, you need to install the underlying id3lib
+library and, depending on your system, set CONFIGURE_ARGS.
+
+==== Debian
+
+Install libid3-dev and be sure to have ruby1.8-dev installed, otherwise you
+won't be able to build Ruby extensions.
+
+  sudo aptitude install libid3-dev
+
+==== Gentoo
+
+  sudo emerge -n id3lib
+
+==== OS X with Fink
+
+Install id3lib4-dev:
+
+  sudo apt-get install id3lib4-dev
+
+Fink puts the library and header files in /sw. In order to enable the
+id3lib-ruby install program to find them, do:
+
+  export CONFIGURE_ARGS="--with-opt-dir=/sw"
+
+==== Manual compilation
+
+Download, compile and install id3lib. When installing in /usr/local, you
+have to set CONFIGURE_ARGS:
+
+  export CONFIGURE_ARGS="--with-opt-dir=/usr/local"
+
+=== Installing id3lib-ruby
+
+Now you're ready to install id3lib-ruby. If you use RubyGems, run the
+following and select the newest version marked "ruby":
+
+  sudo gem install id3lib-ruby
+
+Or if you install from the archive, unpack it and do:
+
+  sudo ruby setup.rb

data/README

@@ -21,23 +21,14 @@ See TODO for planned features.
 The CHANGES file contains a list of changes between versions.
 
 
-== Online Information
-
-The home of id3lib-ruby is http://id3lib-ruby.rubyforge.org
-
-
 == Installation
 
-Note that id3lib has to be installed before running any of the following
-commands, unless you use the Windows binary gem.
-
-Installation through RubyGems:
+See INSTALL.
 
-  gem install id3lib-ruby
 
-Manual installation:
+== Online Information
 
-  ruby setup.rb
+The home of id3lib-ruby is http://id3lib-ruby.rubyforge.org
 
 
 == Usage

data/Rakefile

@@ -10,8 +10,6 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 
 
-PKG_VERSION = '0.4.1'
-
 FILES_COMMON = FileList[
   'lib/**/*.rb',
   'test/test_*.rb',
@@ -21,6 +19,10 @@ FILES_COMMON = FileList[
   '*.rb'
 ]
 
+FILES_DOC = FileList[
+  'README', 'INSTALL', 'TODO', 'CHANGES'
+]
+
 FILES_EXT = FileList[
   'ext/*.rb',
   'ext/*.cxx',
@@ -56,8 +58,8 @@ Rake::RDocTask.new :rdoc do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title = 'id3lib-ruby'
   rdoc.options = RDOC_OPTS
+  rdoc.rdoc_files.include(FILES_DOC)
   rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include('README', 'TODO', 'CHANGES')
 end
 task :doc => [:rdoc]
 
@@ -65,7 +67,7 @@ task :doc => [:rdoc]
 if defined? Gem
   spec = Gem::Specification.new do |s|
     s.name        = 'id3lib-ruby'
-    s.version     = PKG_VERSION
+    s.version     = File.read('lib/id3lib.rb')[/VERSION = '(.*)'/, 1]
     s.summary     =
       'id3lib-ruby provides a Ruby interface to the id3lib C++ library for ' +
       'easily editing ID3 tags (v1 and v2) like with pyid3lib.'
@@ -74,7 +76,7 @@ if defined? Gem
     s.extensions  = ['ext/extconf.rb']
     s.test_files  = FileList['test/test_*.rb']
     s.has_rdoc    = true
-    s.extra_rdoc_files = FileList['README', 'CHANGES', 'TODO']
+    s.extra_rdoc_files = FILES_DOC
     s.rdoc_options = RDOC_OPTS
     s.author      = 'Robin Stocker'
     s.email       = 'robinstocker@rubyforge.org'
@@ -95,9 +97,9 @@ if defined? Gem
 
   desc "Build mswin32 gem."
   task :gem_mswin32 => [:ext_mswin32] do
-    Gem::Builder.new(spec_mswin32).build
-    mkdir_p "pkg"
-    mv "id3lib-ruby-#{PKG_VERSION}-mswin32.gem", "pkg/"
+    gemfile = Gem::Builder.new(spec_mswin32).build
+    mkpath "pkg"
+    mv gemfile, "pkg/"
   end
 
 end  # defined? Gem
@@ -105,7 +107,7 @@ end  # defined? Gem
 
 task :web => [:web_doc] do
   puts "# Now execute the following:"
-  puts "scp web/* robinstocker@rubyforge.org:/var/www/gforge-projects/id3lib-ruby/"
+  puts "scp web/index.html web/logo.png web/red.css robinstocker@rubyforge.org:/var/www/gforge-projects/id3lib-ruby/"
   puts "scp -r web/doc robinstocker@rubyforge.org:/var/www/gforge-projects/id3lib-ruby/"
 end
 
@@ -115,10 +117,11 @@ Rake::RDocTask.new :web_doc do |rdoc|
   rdoc.title = 'id3lib-ruby'
   rdoc.options = RDOC_OPTS.clone
   rdoc.options << '--main' << 'ID3Lib::Tag'
-  rdoc.rdoc_files.include('README', 'TODO', 'CHANGES')
+  rdoc.rdoc_files.include(FILES_DOC)
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+desc "Generate syntax-highlighted HTML of usage.rb."
 task :usage_html do
   require 'syntax/convertors/html'
   convertor = Syntax::Convertors::HTML.for_syntax('ruby')

data/lib/id3lib/info.rb

@@ -57,25 +57,29 @@ module ID3Lib
     
     #
     # Please note that these frames are not fully supported by id3lib:
-    #   AENC, ASPI, COMR, EQUA, ETCO, LINK, MLLT,
-    #   OWNE, POSS, RBUF, RVA2, RVAD, RVRB, SEEK
+    #   AENC, COMR, EQUA, ETCO, MCDI, MLLT,
+    #   OWNE, POSS, RBUF, RVAD, RVRB, SYTC
+    # And these are not supported at all (segfault on usage):
+    #   ASPI, EQU2, RVA2, SEEK, SIGN, TDEN,
+    #   TDOR, TDRC, TDRL, TDTG, TIPL, TMCL,
+    #   TMOO, TPRO, TSOA, TSOP, TSOT, TSST
     #
     Frames = [
       # Special frames
       [0, :____, "No known frame", []],
-      [1, :AENC, "Audio encryption", [:owner, :data]],
-      [2, :APIC, "Attached picture", [:textenc, :mimetype, :picturetype, :description, :data]],
-      [3, :ASPI, "Audio seek point index", [:data]],
+      [1, :AENC, "Audio encryption", [:data]],
+      [2, :APIC, "Attached picture", [:textenc, :imageformat, :mimetype, :picturetype, :description, :data]],
+      [3, :ASPI, "Audio seek point index", []],
       [4, :COMM, "Comments", [:textenc, :language, :description, :text]],
       [5, :COMR, "Commercial frame", [:data]],
-      [6, :ENCR, "Encryption method registration", [:owner, :id, :data]],
-      [7, :EQU2, "Equalisation (2)", [:id, :text]],
+      [6, :ENCR, "Encryption method registration", [:owner, :identifier, :data]],
+      [7, :EQU2, "Equalisation (2)", []],
       [8, :EQUA, "Equalization", [:data]],
       [9, :ETCO, "Event timing codes", [:data]],
       [10, :GEOB, "General encapsulated object", [:textenc, :mimetype, :filename, :description, :data]],
-      [11, :GRID, "Group identification registration", [:owner, :id, :data]],
+      [11, :GRID, "Group identification registration", [:owner, :identifier, :data]],
       [12, :IPLS, "Involved people list", [:textenc, :text]],
-      [13, :LINK, "Linked information", [:data]],
+      [13, :LINK, "Linked information", [:identifier, :url, :text]],
       [14, :MCDI, "Music CD identifier", [:data]],
       [15, :MLLT, "MPEG location lookup table", [:data]],
       [16, :OWNE, "Ownership frame", [:data]],
@@ -84,13 +88,13 @@ module ID3Lib
       [19, :POPM, "Popularimeter", [:email, :rating, :counter]],
       [20, :POSS, "Position synchronisation frame", [:data]],
       [21, :RBUF, "Recommended buffer size", [:data]],
-      [22, :RVA2, "Relative volume adjustment (2)", [:data]],
+      [22, :RVA2, "Relative volume adjustment (2)", []],
       [23, :RVAD, "Relative volume adjustment", [:data]],
       [24, :RVRB, "Reverb", [:data]],
-      [25, :SEEK, "Seek frame", [:data]],
-      [26, :SIGN, "Signature frame", [:id, :data]],
+      [25, :SEEK, "Seek frame", []],
+      [26, :SIGN, "Signature frame", []],
       [27, :SYLT, "Synchronized lyric/text", [:textenc, :language, :timestampformat, :contenttype, :description, :data]],
-      [28, :SYTC, "Synchronized tempo codes", [:timestampformat, :data]],
+      [28, :SYTC, "Synchronized tempo codes", [:data]],
       # Text information frames
       [29, :TALB, "Album/Movie/Show title", [:textenc, :text]],
       [30, :TBPM, "BPM (beats per minute)", [:textenc, :text]],
@@ -98,13 +102,13 @@ module ID3Lib
       [32, :TCON, "Content type", [:textenc, :text]],
       [33, :TCOP, "Copyright message", [:textenc, :text]],
       [34, :TDAT, "Date", [:textenc, :text]],
-      [35, :TDEN, "Encoding time", [:textenc, :text]],
+      [35, :TDEN, "Encoding time", []],
       [36, :TDLY, "Playlist delay", [:textenc, :text]],
-      [37, :TDOR, "Original release time", [:textenc, :text]],
-      [38, :TDRC, "Recording time", [:textenc, :text]],
-      [39, :TDRL, "Release time", [:textenc, :text]],
-      [40, :TDTG, "Tagging time", [:textenc, :text]],
-      [41, :TIPL, "Involved people list", [:textenc, :text]],
+      [37, :TDOR, "Original release time", []],
+      [38, :TDRC, "Recording time", []],
+      [39, :TDRL, "Release time", []],
+      [40, :TDTG, "Tagging time", []],
+      [41, :TIPL, "Involved people list", []],
       [42, :TENC, "Encoded by", [:textenc, :text]],
       [43, :TEXT, "Lyricist/Text writer", [:textenc, :text]],
       [44, :TFLT, "File type", [:textenc, :text]],
@@ -115,9 +119,9 @@ module ID3Lib
       [49, :TKEY, "Initial key", [:textenc, :text]],
       [50, :TLAN, "Language(s)", [:textenc, :text]],
       [51, :TLEN, "Length", [:textenc, :text]],
-      [52, :TMCL, "Musician credits list", [:textenc, :text]],
+      [52, :TMCL, "Musician credits list", []],
       [53, :TMED, "Media type", [:textenc, :text]],
-      [54, :TMOO, "Mood", [:textenc, :text]],
+      [54, :TMOO, "Mood", []],
       [55, :TOAL, "Original album/movie/show title", [:textenc, :text]],
       [56, :TOFN, "Original filename", [:textenc, :text]],
       [57, :TOLY, "Original lyricist(s)/text writer(s)", [:textenc, :text]],
@@ -129,19 +133,19 @@ module ID3Lib
       [63, :TPE3, "Conductor/performer refinement", [:textenc, :text]],
       [64, :TPE4, "Interpreted, remixed, or otherwise modified by", [:textenc, :text]],
       [65, :TPOS, "Part of a set", [:textenc, :text]],
-      [66, :TPRO, "Produced notice", [:textenc, :text]],
+      [66, :TPRO, "Produced notice", []],
       [67, :TPUB, "Publisher", [:textenc, :text]],
       [68, :TRCK, "Track number/Position in set", [:textenc, :text]],
       [69, :TRDA, "Recording dates", [:textenc, :text]],
       [70, :TRSN, "Internet radio station name", [:textenc, :text]],
       [71, :TRSO, "Internet radio station owner", [:textenc, :text]],
       [72, :TSIZ, "Size", [:textenc, :text]],
-      [73, :TSOA, "Album sort order", [:textenc, :text]],
-      [74, :TSOP, "Performer sort order", [:textenc, :text]],
-      [75, :TSOT, "Title sort order", [:textenc, :text]],
+      [73, :TSOA, "Album sort order", []],
+      [74, :TSOP, "Performer sort order", []],
+      [75, :TSOT, "Title sort order", []],
       [76, :TSRC, "ISRC (international standard recording code)", [:textenc, :text]],
       [77, :TSSE, "Software/Hardware and settings used for encoding", [:textenc, :text]],
-      [78, :TSST, "Set subtitle", [:textenc, :text]],
+      [78, :TSST, "Set subtitle", []],
       [79, :TXXX, "User defined text information", [:textenc, :description, :text]],
       [80, :TYER, "Year", [:textenc, :text]],
       # Special frames again
@@ -149,15 +153,15 @@ module ID3Lib
       [82, :USER, "Terms of use", [:textenc, :language, :text]],
       [83, :USLT, "Unsynchronized lyric/text transcription", [:textenc, :language, :description, :text]],
       # URL link frames
-      [84, :WCOM, "Commercial information", [:text]],
-      [85, :WCOP, "Copyright/Legal infromation", [:text]],
-      [86, :WOAF, "Official audio file webpage", [:text]],
-      [87, :WOAR, "Official artist/performer webpage", [:text]],
-      [88, :WOAS, "Official audio source webpage", [:text]],
-      [89, :WORS, "Official internet radio station homepage", [:text]],
-      [90, :WPAY, "Payment", [:text]],
-      [91, :WPUB, "Official publisher webpage", [:text]],
-      [92, :WXXX, "User defined URL link", [:textenc, :description, :url]],
+      [84, :WCOM, "Commercial information", [:url]],
+      [85, :WCOP, "Copyright/Legal infromation", [:url]],
+      [86, :WOAF, "Official audio file webpage", [:url]],
+      [87, :WOAR, "Official artist/performer webpage", [:url]],
+      [88, :WOAS, "Official audio source webpage", [:url]],
+      [89, :WORS, "Official internet radio station homepage", [:url]],
+      [90, :WPAY, "Payment", [:url]],
+      [91, :WPUB, "Official publisher webpage", [:url]],
+      [92, :WXXX, "User defined URL link", [:textenc, :description, :url]]
     ]
 
     FramesByID = {
@@ -272,7 +276,7 @@ module ID3Lib
       [12, :imageformat, "Image format field"],
       [13, :mimetype, "Mimetype field"],
       [14, :counter, "Counter field"],
-      [15, :id, "Identifier/Symbol field"],
+      [15, :identifier, "Identifier/Symbol field"],
       [16, :volumeadj, "Volume adjustment field"],
       [17, :numbits, "Number of bits field"],
       [18, :volchgright, "Volume chage on the right channel"],
@@ -299,7 +303,7 @@ module ID3Lib
       :imageformat     => Fields[12],
       :mimetype        => Fields[13],
       :counter         => Fields[14],
-      :id              => Fields[15],
+      :identifier      => Fields[15],
       :volumeadj       => Fields[16],
       :numbits         => Fields[17],
       :volchgright     => Fields[18],

data/lib/id3lib.rb

@@ -9,6 +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'
 
   # ID3 version 1. All V constants can be used with the methods
   # new, update! or strip! of ID3Lib::Tag. 
@@ -33,7 +34,7 @@ module ID3Lib
   #
   # === Example of use
   #
-  #    tag = ID3Lib::Tag.read('shy_boy.mp3')
+  #    tag = ID3Lib::Tag.new('shy_boy.mp3')
   #
   #    # Remove comments
   #    tag.delete_if{ |frame| frame[:id] == :COMM }
@@ -314,8 +315,8 @@ module ID3Lib
     private
 
     def read_frames
-      iterator = @tag.iterator_new
-      while libframe = @tag.iterator_next_frame(iterator)
+      iterator = @tag.create_iterator
+      while libframe = iterator.get_next
         self << Frame.read(libframe)
       end
     end
@@ -332,6 +333,11 @@ module ID3Lib
 
       info[FIELDS].each do |field_id|
         libfield = field(libframe, field_id)
+        unless libfield
+          warn "id3lib-ruby: Invalid field #{field_id.inspect} in " \
+               "#{frame[:id].inspect}, please report this as a bug."
+          next
+        end
         frame[field_id] =
           case Info::FieldType[libfield.get_type]
           when :integer
@@ -363,6 +369,7 @@ module ID3Lib
         end
 
         libfield = field(libframe, field_id)
+        next unless libfield
         case Info::FieldType[libfield.get_type]
         when :integer
           libfield.set_integer(value)

data/test/test_writing.rb

@@ -119,6 +119,7 @@ class TestWriting < Test::Unit::TestCase
     pic = {
       :id           => :APIC,
       :mimetype     => 'image/jpeg',
+      :imageformat  => '',
       :picturetype  => 3,
       :description  => 'A pretty picture.',
       :textenc      => 0,

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: id3lib-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
-date: 2006-08-24 00:00:00 +02:00
+  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
@@ -44,8 +44,9 @@ files:
 - setup.rb
 - ext/mswin32/id3lib_api.so
 - README
-- CHANGES
+- INSTALL
 - TODO
+- CHANGES
 test_files: 
 - test/test_unicode.rb
 - test/test_writing.rb
@@ -57,8 +58,9 @@ rdoc_options:
 - README
 extra_rdoc_files: 
 - README
-- CHANGES
+- INSTALL
 - TODO
+- CHANGES
 executables: []
 
 extensions: []