id3lib-ruby 0.4.1 → 0.5.0

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/ext/generate_info.rb

@@ -1,71 +1,84 @@
+#!/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 = {}
 
-file = ARGV.first || '/usr/local/include/id3/globals.h'
+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
 
-data = IO.read(file)
 
-fields = []
-frames = []
-genres = []
+field_info = []
+frame_info = []
+genre_info = []
 
-data.scan(/ID3_ENUM\((\w+)\)\s+\{\s+(.+?)\s+\}/m) do |name, enum|
+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.sub!('ID3FN_', '')
-      field.downcase!
-      fields << [id, field.to_sym, description]
+
+      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
-      if frame == '????'
-        frame = :____
-      else
-        frame = frame.to_sym
-      end
-      possible_fields =
-      case frame
-      when :____ : []
-      when :AENC : [:owner, :data]
-      when :APIC : [:textenc, :mimetype, :picturetype, :description, :data]
-      when :ASPI, :COMR, :EQUA, :ETCO, :LINK,
-        :MCDI, :MLLT, :OWNE, :POSS, :RBUF,
-        :RVA2, :RVAD, :RVRB, :SEEK
-        [:data]
-      when :COMM : [:textenc, :language, :description, :text]
-      when :ENCR : [:owner, :id, :data]
-      when :EQU2 : [:id, :text]
-      when :GEOB : [:textenc, :mimetype, :filename, :description, :data]
-      when :GRID : [:owner, :id, :data]
-      when :IPLS : [:textenc, :text]
-      when :PRIV : [:owner, :data]
-      when :PCNT : [:counter]
-      when :POPM : [:email, :rating, :counter]
-      when :SIGN : [:id, :data]
-      when :SYLT : [:textenc, :language, :timestampformat, :contenttype, :description, :data]
-      when :SYTC : [:timestampformat, :data]
-      when :UFID : [:owner, :data]
-      when :USER : [:textenc, :language, :text]
-      when :USLT : [:textenc, :language, :description, :text]
-      when :WCOM, :WCOP, :WOAF, :WOAR, :WOAS, :WORS, :WPAY, :WPUB : [:text]
-      when :WXXX : [:textenc, :description, :url]
-      else [:textenc, :text]
-      end
-      frames << [id, frame, description, possible_fields]
+      frame = (frame == '????') ? :____ : frame.to_sym
+
+      fields = allowed_fields[frame] || []
+
+      frame_info << [id, frame, description, fields]
       id += 1
     end
   end
 end
 
-data.scan(/(ID3_v1_genre_description).+?\{(.+?)\}/m) do |name, list|
+globals_file.scan(/(ID3_v1_genre_description).+?\{(.+?)\}/m) do |name, list|
   id = 0
-  list.scan(/"(.+?)"/) do |genre|
-    genres << genre.first
+  list.scan(/"([^"]+)"/) do |genre|
+    genre_info << genre.first
     id += 1
   end
 end
@@ -76,7 +89,7 @@ def indent level, text
 end
 
 indent 4, "Frames = ["
-frames.each do |f|
+frame_info.each do |f|
   comment = case f[1]
   when :____ : "# Special frames"
   when :TALB : "# Text information frames"
@@ -89,25 +102,25 @@ end
 indent 4, "]"
 
 indent 4, "FramesByID = {"
-frames.each do |f|
+frame_info.each do |f|
   indent 6, f[1].inspect + " => Frames[" + f[0].to_s + "],"
 end
 indent 4, "}"
 
 indent 4, "Fields = ["
-fields.each do |f|
+field_info.each do |f|
   indent 6, f.inspect + ","
 end
 indent 4, "]"
 
 indent 4, "FieldsByID = {"
-fields.each do |f|
+field_info.each do |f|
   indent 6, f[1].inspect.ljust(16) + " => Fields[" + f[0].to_s + "],"
 end
 indent 4, "}"
 
 indent 4, "Genres = ["
-genres.each_slice(4) do |gs|
+genre_info.each_slice(4) do |gs|
   indent 6, "# Winamp extensions" if gs.first == "Folk"
   indent 6, gs.map{ |g| g.inspect }.join(", ") + ","
 end

data/ext/id3lib_api.i

@@ -54,17 +54,18 @@ public:
 	%rename (find) Find;
 	ID3_Frame * Find(ID3_FrameID name) const;
 
-	%rename (iterator_new) CreateIterator;
+	%rename (create_iterator) CreateIterator;
+	%newobject CreateIterator;
 	ID3_Tag::Iterator * CreateIterator();
+};
 
-	// Needed because SWIG does not support nested classes yet.
-	%extend
-	{
-		ID3_Frame * iterator_next_frame(ID3_Tag::Iterator *iterator)
-		{
-			return iterator->GetNext();
-		}
-	}
+%rename (Tag_Iterator) ID3_Tag::Iterator;
+class ID3_Tag::Iterator
+{
+public:
+
+	%rename (get_next) GetNext;
+	virtual ID3_Frame * GetNext() = 0;
 };
 
 

data/ext/id3lib_api_wrap.cxx

@@ -1,6 +1,6 @@
 /* ----------------------------------------------------------------------------
  * This file was automatically generated by SWIG (http://www.swig.org).
- * Version 1.3.29
+ * Version 1.3.31
  * 
  * This file is not intended to be easily readable and contains a number of 
  * coding conventions designed to improve portability and efficiency. Do not make
@@ -119,7 +119,7 @@ private:
 #endif
 
 /* Deal with Microsoft's attempt at deprecating C standard runtime functions */
-#if !defined(SWIG_NO_CRT_SECURE_NO_DEPRECATE) && defined(_MSC_VER)
+#if !defined(SWIG_NO_CRT_SECURE_NO_DEPRECATE) && defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
 # define _CRT_SECURE_NO_DEPRECATE
 #endif
 
@@ -216,7 +216,7 @@ private:
 #endif
 
 /* Deal with Microsoft's attempt at deprecating C standard runtime functions */
-#if !defined(SWIG_NO_CRT_SECURE_NO_DEPRECATE) && defined(_MSC_VER)
+#if !defined(SWIG_NO_CRT_SECURE_NO_DEPRECATE) && defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
 # define _CRT_SECURE_NO_DEPRECATE
 #endif
 
@@ -229,7 +229,7 @@ private:
 
 /* This should only be incremented when either the layout of swig_type_info changes,
    or for whatever reason, the runtime changes incompatibly */
-#define SWIG_RUNTIME_VERSION "2"
+#define SWIG_RUNTIME_VERSION "3"
 
 /* define SWIG_TYPE_TABLE_NAME as "SWIG_TYPE_TABLE" */
 #ifdef SWIG_TYPE_TABLE
@@ -828,6 +828,21 @@ SWIG_UnpackDataName(const char *c, void *ptr, size_t sz, const char *name) {
 #endif
 #endif
 
+/* RSTRING_LEN, etc are new in Ruby 1.9, but ->ptr and ->len no longer work */
+/* Define these for older versions so we can just write code the new way */
+#ifndef RSTRING_LEN
+# define RSTRING_LEN(x) RSTRING(x)->len
+#endif
+#ifndef RSTRING_PTR
+# define RSTRING_PTR(x) RSTRING(x)->ptr
+#endif
+#ifndef RARRAY_LEN
+# define RARRAY_LEN(x) RARRAY(x)->len
+#endif
+#ifndef RARRAY_PTR
+# define RARRAY_PTR(x) RARRAY(x)->ptr
+#endif
+
 /*
  * Need to be very careful about how these macros are defined, especially
  * when compiling C++ code or C code with an ANSI C compiler.
@@ -871,10 +886,10 @@ SWIG_UnpackDataName(const char *c, void *ptr, size_t sz, const char *name) {
 #define StringValue(s) RB_STRING_VALUE(s)
 #endif
 #ifndef StringValuePtr
-#define StringValuePtr(s) RSTRING(RB_STRING_VALUE(s))->ptr
+#define StringValuePtr(s) RSTRING_PTR(RB_STRING_VALUE(s))
 #endif
 #ifndef StringValueLen
-#define StringValueLen(s) RSTRING(RB_STRING_VALUE(s))->len
+#define StringValueLen(s) RSTRING_LEN(RB_STRING_VALUE(s))
 #endif
 #ifndef SafeStringValue
 #define SafeStringValue(v) do {\
@@ -1303,7 +1318,7 @@ SWIG_Ruby_NewPointerObj(void *ptr, swig_type_info *type, int flags)
         downcast methods. */
       if (obj != Qnil) {
         VALUE value = rb_iv_get(obj, "__swigtype__");
-        char* type_name = RSTRING(value)->ptr;
+        char* type_name = RSTRING_PTR(value);
 				
         if (strcmp(type->name, type_name) == 0) {
           return obj;
@@ -1544,7 +1559,8 @@ static swig_module_info swig_module = {swig_types, 6, 0, 0, 0, 0};
 
 static VALUE mAPI;
 
-#define SWIGVERSION 0x010329 
+#define SWIGVERSION 0x010331 
+#define SWIG_VERSION SWIGVERSION
 
 
 #define SWIG_as_voidptr(a) const_cast< void * >(static_cast< const void * >(a)) 
@@ -1558,7 +1574,7 @@ static VALUE mAPI;
 
 
 SWIGINTERN swig_type_info*
-SWIG_pchar_descriptor()
+SWIG_pchar_descriptor(void)
 {
   static int init = 0;
   static swig_type_info* info = 0;
@@ -1579,7 +1595,7 @@ SWIG_AsCharPtrAndSize(VALUE obj, char** cptr, size_t* psize, int *alloc)
 
     char *cstr = STR2CSTR(obj);
     
-    size_t size = RSTRING(obj)->len + 1;
+    size_t size = RSTRING_LEN(obj) + 1;
     if (cptr)  {
       if (alloc) {
 	if (*alloc == SWIG_NEWOBJ) {
@@ -1794,9 +1810,6 @@ SWIG_AsVal_bool (VALUE obj, bool *val)
   return SWIG_TypeError;
 }
 
-SWIGINTERN ID3_Frame *ID3_Tag_iterator_next_frame(ID3_Tag *self,ID3_Tag::Iterator *iterator){
-			return iterator->GetNext();
-		}
 
 SWIGINTERNINLINE VALUE
 SWIG_From_int  (int value)
@@ -1863,7 +1876,7 @@ _wrap_new_Tag__SWIG_0(int argc, VALUE *argv, VALUE self) {
   if (!SWIG_IsOK(res1)) {
     SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "ID3_Tag" "', argument " "1"" of type '" "char const *""'");
   }
-  arg1 = buf1;
+  arg1 = reinterpret_cast< char * >(buf1);
   result = (ID3_Tag *)new ID3_Tag((char const *)arg1);DATA_PTR(self) = result;
   
   if (alloc1 == SWIG_NEWOBJ) delete[] buf1;
@@ -1998,7 +2011,7 @@ _wrap_Tag_link__SWIG_0(int argc, VALUE *argv, VALUE self) {
   if (!SWIG_IsOK(res2)) {
     SWIG_exception_fail(SWIG_ArgError(res2), "in method '" "Link" "', argument " "2"" of type '" "char const *""'");
   }
-  arg2 = buf2;
+  arg2 = reinterpret_cast< char * >(buf2);
   ecode3 = SWIG_AsVal_unsigned_SS_int(argv[1], &val3);
   if (!SWIG_IsOK(ecode3)) {
     SWIG_exception_fail(SWIG_ArgError(ecode3), "in method '" "Link" "', argument " "3"" of type '" "flags_t""'");
@@ -2038,7 +2051,7 @@ _wrap_Tag_link__SWIG_1(int argc, VALUE *argv, VALUE self) {
   if (!SWIG_IsOK(res2)) {
     SWIG_exception_fail(SWIG_ArgError(res2), "in method '" "Link" "', argument " "2"" of type '" "char const *""'");
   }
-  arg2 = buf2;
+  arg2 = reinterpret_cast< char * >(buf2);
   result = (arg1)->Link((char const *)arg2);
   vresult = SWIG_From_size_t(static_cast< size_t >(result));
   if (alloc2 == SWIG_NEWOBJ) delete[] buf2;
@@ -2394,7 +2407,7 @@ _wrap_Tag_get_filename(int argc, VALUE *argv, VALUE self) {
   }
   arg1 = reinterpret_cast< ID3_Tag * >(argp1);
   result = (char *)((ID3_Tag const *)arg1)->GetFileName();
-  vresult = SWIG_FromCharPtr(result);
+  vresult = SWIG_FromCharPtr((const char *)result);
   return vresult;
 fail:
   return Qnil;
@@ -2490,7 +2503,7 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Tag_iterator_new(int argc, VALUE *argv, VALUE self) {
+_wrap_Tag_create_iterator(int argc, VALUE *argv, VALUE self) {
   ID3_Tag *arg1 = (ID3_Tag *) 0 ;
   ID3_Tag::Iterator *result = 0 ;
   void *argp1 = 0 ;
@@ -2506,38 +2519,32 @@ _wrap_Tag_iterator_new(int argc, VALUE *argv, VALUE self) {
   }
   arg1 = reinterpret_cast< ID3_Tag * >(argp1);
   result = (ID3_Tag::Iterator *)(arg1)->CreateIterator();
-  vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_ID3_Tag__Iterator, 0 |  0 );
+  vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_ID3_Tag__Iterator, SWIG_POINTER_OWN |  0 );
   return vresult;
 fail:
   return Qnil;
 }
 
 
+swig_class cTag_Iterator;
+
 SWIGINTERN VALUE
-_wrap_Tag_iterator_next_frame(int argc, VALUE *argv, VALUE self) {
-  ID3_Tag *arg1 = (ID3_Tag *) 0 ;
-  ID3_Tag::Iterator *arg2 = (ID3_Tag::Iterator *) 0 ;
+_wrap_Tag_Iterator_get_next(int argc, VALUE *argv, VALUE self) {
+  ID3_Tag::Iterator *arg1 = (ID3_Tag::Iterator *) 0 ;
   ID3_Frame *result = 0 ;
   void *argp1 = 0 ;
   int res1 = 0 ;
-  void *argp2 = 0 ;
-  int res2 = 0 ;
   VALUE vresult = Qnil;
   
-  if ((argc < 1) || (argc > 1)) {
-    rb_raise(rb_eArgError, "wrong # of arguments(%d for 1)",argc); SWIG_fail;
+  if ((argc < 0) || (argc > 0)) {
+    rb_raise(rb_eArgError, "wrong # of arguments(%d for 0)",argc); SWIG_fail;
   }
-  res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_ID3_Tag, 0 |  0 );
+  res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_ID3_Tag__Iterator, 0 |  0 );
   if (!SWIG_IsOK(res1)) {
-    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "iterator_next_frame" "', argument " "1"" of type '" "ID3_Tag *""'"); 
+    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "GetNext" "', argument " "1"" of type '" "ID3_Tag::Iterator *""'"); 
   }
-  arg1 = reinterpret_cast< ID3_Tag * >(argp1);
-  res2 = SWIG_ConvertPtr(argv[0], &argp2,SWIGTYPE_p_ID3_Tag__Iterator, 0 |  0 );
-  if (!SWIG_IsOK(res2)) {
-    SWIG_exception_fail(SWIG_ArgError(res2), "in method '" "iterator_next_frame" "', argument " "2"" of type '" "ID3_Tag::Iterator *""'"); 
-  }
-  arg2 = reinterpret_cast< ID3_Tag::Iterator * >(argp2);
-  result = (ID3_Frame *)ID3_Tag_iterator_next_frame(arg1,arg2);
+  arg1 = reinterpret_cast< ID3_Tag::Iterator * >(argp1);
+  result = (ID3_Frame *)(arg1)->GetNext();
   vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_ID3_Frame, 0 |  0 );
   return vresult;
 fail:
@@ -2545,6 +2552,11 @@ fail:
 }
 
 
+SWIGINTERN void
+free_ID3_Tag_Iterator(ID3_Tag::Iterator *arg1) {
+    delete arg1;
+}
+
 swig_class cFrame;
 
 SWIGINTERN VALUE
@@ -2784,7 +2796,7 @@ _wrap_Field_get_ascii(int argc, VALUE *argv, VALUE self) {
   }
   arg1 = reinterpret_cast< ID3_Field * >(argp1);
   result = (char *)((ID3_Field const *)arg1)->GetRawText();
-  vresult = SWIG_FromCharPtr(result);
+  vresult = SWIG_FromCharPtr((const char *)result);
   return vresult;
 fail:
   return Qnil;
@@ -2924,7 +2936,7 @@ _wrap_Field_set_ascii(int argc, VALUE *argv, VALUE self) {
   if (!SWIG_IsOK(res2)) {
     SWIG_exception_fail(SWIG_ArgError(res2), "in method '" "Set" "', argument " "2"" of type '" "char const *""'");
   }
-  arg2 = buf2;
+  arg2 = reinterpret_cast< char * >(buf2);
   result = (arg1)->Set((char const *)arg2);
   vresult = SWIG_From_size_t(static_cast< size_t >(result));
   if (alloc2 == SWIG_NEWOBJ) delete[] buf2;
@@ -3039,7 +3051,7 @@ static swig_cast_info *swig_cast_initial[] = {
  * structures together.
  *
  * The generated swig_type_info structures are assigned staticly to an initial 
- * array. We just loop though that array, and handle each type individually.
+ * array. We just loop through that array, and handle each type individually.
  * First we lookup if this type has been already loaded, and if so, use the
  * loaded structure instead of the generated one. Then we have to fill in the
  * cast linked list. The cast data is initially stored in something like a
@@ -3077,32 +3089,49 @@ extern "C" {
 #define SWIGRUNTIME_DEBUG
 #endif
 
+
 SWIGRUNTIME void
 SWIG_InitializeModule(void *clientdata) {
   size_t i;
-  swig_module_info *module_head;
-  static int init_run = 0;
+  swig_module_info *module_head, *iter;
+  int found;
 
   clientdata = clientdata;
 
-  if (init_run) return;
-  init_run = 1;
-
-  /* Initialize the swig_module */
-  swig_module.type_initial = swig_type_initial;
-  swig_module.cast_initial = swig_cast_initial;
+  /* check to see if the circular list has been setup, if not, set it up */
+  if (swig_module.next==0) {
+    /* Initialize the swig_module */
+    swig_module.type_initial = swig_type_initial;
+    swig_module.cast_initial = swig_cast_initial;
+    swig_module.next = &swig_module;
+  }
 
   /* Try and load any already created modules */
   module_head = SWIG_GetModule(clientdata);
-  if (module_head) {
+  if (!module_head) {
+    /* This is the first module loaded for this interpreter */
+    /* so set the swig module into the interpreter */
+    SWIG_SetModule(clientdata, &swig_module);
+    module_head = &swig_module;
+  } else {
+    /* the interpreter has loaded a SWIG module, but has it loaded this one? */
+    found=0;
+    iter=module_head;
+    do {
+      if (iter==&swig_module) {
+        found=1;
+        break;
+      }
+      iter=iter->next;
+    } while (iter!= module_head);
+
+    /* if the is found in the list, then all is done and we may leave */
+    if (found) return;
+    /* otherwise we must add out module into the list */
     swig_module.next = module_head->next;
     module_head->next = &swig_module;
-  } else {
-    /* This is the first module loaded */
-    swig_module.next = &swig_module;
-    SWIG_SetModule(clientdata, &swig_module);
   }
-		 
+
   /* Now work on filling in swig_module.types */
 #ifdef SWIGRUNTIME_DEBUG
   printf("SWIG_InitializeModule: size %d\n", swig_module.size);
@@ -3269,12 +3298,19 @@ SWIGEXPORT void Init_id3lib_api(void) {
   rb_define_method(cTag.klass, "set_padding", VALUEFUNC(_wrap_Tag_set_padding), -1);
   rb_define_method(cTag.klass, "size", VALUEFUNC(_wrap_Tag_size), -1);
   rb_define_method(cTag.klass, "find", VALUEFUNC(_wrap_Tag_find), -1);
-  rb_define_method(cTag.klass, "iterator_new", VALUEFUNC(_wrap_Tag_iterator_new), -1);
-  rb_define_method(cTag.klass, "iterator_next_frame", VALUEFUNC(_wrap_Tag_iterator_next_frame), -1);
+  rb_define_method(cTag.klass, "create_iterator", VALUEFUNC(_wrap_Tag_create_iterator), -1);
   cTag.mark = 0;
   cTag.destroy = (void (*)(void *)) free_ID3_Tag;
   cTag.trackObjects = 0;
   
+  cTag_Iterator.klass = rb_define_class_under(mAPI, "Tag_Iterator", rb_cObject);
+  SWIG_TypeClientData(SWIGTYPE_p_ID3_Tag__Iterator, (void *) &cTag_Iterator);
+  rb_undef_alloc_func(cTag_Iterator.klass);
+  rb_define_method(cTag_Iterator.klass, "get_next", VALUEFUNC(_wrap_Tag_Iterator_get_next), -1);
+  cTag_Iterator.mark = 0;
+  cTag_Iterator.destroy = (void (*)(void *)) free_ID3_Tag_Iterator;
+  cTag_Iterator.trackObjects = 0;
+  
   cFrame.klass = rb_define_class_under(mAPI, "Frame", rb_cObject);
   SWIG_TypeClientData(SWIGTYPE_p_ID3_Frame, (void *) &cFrame);
   rb_define_alloc_func(cFrame.klass, _wrap_Frame_allocate);

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/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/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
@@ -47,8 +47,9 @@ files:
 - ext/id3lib_api.i
 - ext/Rakefile
 - README
-- CHANGES
+- INSTALL
 - TODO
+- CHANGES
 test_files: 
 - test/test_unicode.rb
 - test/test_writing.rb
@@ -60,8 +61,9 @@ rdoc_options:
 - README
 extra_rdoc_files: 
 - README
-- CHANGES
+- INSTALL
 - TODO
+- CHANGES
 executables: []
 
 extensions: