id3lib-ruby 0.3.1 → 0.4.0

data/CHANGES

@@ -1,5 +1,11 @@
 = id3lib-ruby changes
 
+=== 0.4.0 (r41)
+
+* Fixed Unicode problems (bug 4768).
+* Renamed ID3Lib::API methods to be more like the id3lib method names.
+  For example, the GetType() method is now named get_type instead of type.
+
 === 0.3.1 (r32)
 
 * Added check and messages for -lstdc++ and -lz to extconf.rb.

data/Rakefile

@@ -10,15 +10,22 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 
 
-PKG_VERSION = '0.3.1'
+PKG_VERSION = '0.4.0'
 
-PKG_COMMON = FileList[
+FILES_COMMON = FileList[
   'lib/**/*.rb',
   'test/test_*.rb',
   'test/data/*.mp3',
   'test/data/cover.jpg',
   'Rakefile',
-  'setup.rb'
+  '*.rb'
+]
+
+FILES_EXT = FileList[
+  'ext/*.rb',
+  'ext/*.cxx',
+  'ext/*.i',
+  'ext/Rakefile'
 ]
 
 
@@ -42,7 +49,7 @@ Rake::TestTask.new do |t|
 end
 
 
-RDOC_OPTS = ['--line-numbers', '--main', 'README']
+RDOC_OPTS = ['--inline-source', '--line-numbers', '--main', 'README']
 
 desc "Generate RDOC documentation."
 Rake::RDocTask.new :rdoc do |rdoc|
@@ -63,7 +70,7 @@ if defined? Gem
       'id3lib-ruby provides a Ruby interface to the id3lib C++ library for ' +
       'easily editing ID3 tags (v1 and v2) like with pyid3lib.'
     s.requirements << 'id3lib C++ library'
-    s.files       = PKG_COMMON + FileList['ext/extconf.rb', 'ext/*.cxx']
+    s.files       = FILES_COMMON + FILES_EXT
     s.extensions  = ['ext/extconf.rb']
     s.test_files  = FileList['test/test_*.rb']
     s.has_rdoc    = true
@@ -81,7 +88,7 @@ if defined? Gem
   end
 
   spec_mswin32 = spec.clone
-  spec_mswin32.files = PKG_COMMON + FileList['ext/mswin32/id3lib_api.so']
+  spec_mswin32.files = FILES_COMMON + FileList['ext/mswin32/id3lib_api.so']
   spec_mswin32.extensions = []
   spec_mswin32.require_paths = ['lib', 'ext/mswin32']
   spec_mswin32.platform = Gem::Platform::WIN32
@@ -99,14 +106,15 @@ 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 -r web/doc robinstocker@rubyforge.org:/var/www/gforge-projects/id3lib-ruby/doc"
+  puts "scp -r web/doc robinstocker@rubyforge.org:/var/www/gforge-projects/id3lib-ruby/"
 end
 
 desc "Generate RDOC documentation on web."
 Rake::RDocTask.new :web_doc do |rdoc|
   rdoc.rdoc_dir = 'web/doc'
   rdoc.title = 'id3lib-ruby'
-  rdoc.options << '--line-numbers' << '--main' << 'ID3Lib::Tag'
+  rdoc.options = RDOC_OPTS.clone
+  rdoc.options << '--main' << 'ID3Lib::Tag'
   rdoc.rdoc_files.include('README', 'TODO', 'CHANGES')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/ext/Rakefile

@@ -0,0 +1,21 @@
+
+require 'rake/clean'
+
+
+CLEAN.include '*.o', 'Makefile', 'mkmf.log'
+CLOBBER.include 'id3lib_api.so', 'id3lib_api.bundle'
+
+task :default => ['id3lib_api.bundle']
+task :swig    => ['id3lib_api_wrap.cxx']
+
+file 'id3lib_api.bundle' => ['id3lib_api_wrap.cxx', 'Makefile'] do
+  sh "make"
+end
+
+file 'id3lib_api_wrap.cxx' => ['id3lib_api.i'] do
+  sh "swig -c++ -ruby -feature id3lib_api id3lib_api.i"
+end
+
+file 'Makefile' do
+  ruby "extconf.rb"
+end

data/ext/generate_info.rb

@@ -0,0 +1,114 @@
+require 'enumerator'
+
+file = ARGV.first || '/usr/local/include/id3/globals.h'
+
+data = IO.read(file)
+
+fields = []
+frames = []
+genres = []
+
+data.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]
+      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]
+      id += 1
+    end
+  end
+end
+
+data.scan(/(ID3_v1_genre_description).+?\{(.+?)\}/m) do |name, list|
+  id = 0
+  list.scan(/"(.+?)"/) do |genre|
+    genres << genre.first
+    id += 1
+  end
+end
+
+
+def indent level, text
+  puts ' ' * level + text
+end
+
+indent 4, "Frames = ["
+frames.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 = {"
+frames.each do |f|
+  indent 6, f[1].inspect + " => Frames[" + f[0].to_s + "],"
+end
+indent 4, "}"
+
+indent 4, "Fields = ["
+fields.each do |f|
+  indent 6, f.inspect + ","
+end
+indent 4, "]"
+
+indent 4, "FieldsByID = {"
+fields.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|
+  indent 6, "# Winamp extensions" if gs.first == "Folk"
+  indent 6, gs.map{ |g| g.inspect }.join(", ") + ","
+end
+indent 4, "]"

data/ext/id3lib_api.i

@@ -0,0 +1,179 @@
+%module "ID3Lib::API"
+%{
+#include <id3/tag.h>
+%}
+
+
+enum ID3_FrameID;
+enum ID3_FieldID;
+enum ID3_FieldType;
+enum ID3_TextEnc;
+enum ID3_TagType;
+
+typedef unsigned int flags_t;
+
+
+%rename (Tag) ID3_Tag;
+class ID3_Tag
+{
+public:
+
+	ID3_Tag(const char *name = NULL);
+	~ID3_Tag();
+
+	%rename (has_tag_type) HasTagType;
+	bool HasTagType(ID3_TagType type) const;
+
+	%rename (link) Link;
+	size_t Link(const char *filename, flags_t flags = ID3TT_ALL);
+
+	%rename (update) Update;
+	flags_t Update(flags_t flags = ID3TT_ALL);
+
+	%rename (strip) Strip;
+	flags_t Strip(flags_t flags = ID3TT_ALL);
+
+	%rename (clear) Clear;
+	void Clear();
+
+	%rename (remove_frame) RemoveFrame;
+	ID3_Frame * RemoveFrame(const ID3_Frame *frame);
+
+	%rename (add_frame) AddFrame;
+	void AddFrame(const ID3_Frame *frame);
+
+	%rename (get_filename) GetFileName;
+	const char * GetFileName() const;
+
+	%rename (set_padding) SetPadding;
+	bool SetPadding(bool padding);
+
+	%rename (size) Size;
+	size_t Size() const;
+
+	%rename (find) Find;
+	ID3_Frame * Find(ID3_FrameID name) const;
+
+	%rename (iterator_new) 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 (Frame) ID3_Frame;
+class ID3_Frame
+{
+public:
+
+	ID3_Frame(ID3_FrameID id = ID3FID_NOFRAME);
+	~ID3_Frame();
+
+	%rename (get_field) GetField;
+	ID3_Field * GetField(ID3_FieldID name) const;
+
+	%rename (get_id) GetID;
+	ID3_FrameID GetID() const;
+};
+
+
+%rename (Field) ID3_Field;
+class ID3_Field
+{
+public:
+
+	// Getters
+
+	%rename (get_type) GetType;
+	ID3_FieldType GetType() const;
+
+	%rename (get_encoding) GetEncoding;
+	ID3_TextEnc GetEncoding() const;
+
+	%rename (get_integer) Get;
+	unsigned long Get() const;
+
+	%rename (get_ascii) GetRawText;
+	const char * GetRawText() const;
+
+	%extend
+	{
+		VALUE get_binary()
+		{
+			return rb_str_new((const char *)self->GetRawBinary(), self->Size());
+		}
+
+		VALUE get_unicode()
+		{
+			const char *string = (const char *)self->GetRawUnicodeText();
+			if (string == NULL) return rb_str_new("", 0);
+			long size = self->Size();
+			if (size >= 2 && string[size-2] == '\0' && string[size-1] == '\0') {
+				// id3lib seems to be inconsistent: the Unicode strings
+				// don't always end in 0x0000. If they do, we don't want these
+				// trailing bytes.
+				size -= 2;
+			}
+			return rb_str_new(string, size);
+		}
+	}
+
+	// Setters
+
+	%rename (set_encoding) SetEncoding(ID3_TextEnc);
+	bool SetEncoding(ID3_TextEnc enc);
+
+	%rename (set_integer) Set(unsigned long);
+	void Set(unsigned long i);
+
+	%rename (set_ascii) Set(const char *);
+	size_t Set(const char *string);
+
+	%extend
+	{
+		size_t set_binary(VALUE data)
+		{
+			StringValue(data);
+			return self->Set((const unsigned char *)RSTRING(data)->ptr,
+			                 RSTRING(data)->len);
+		}
+
+		size_t set_unicode(VALUE data)
+		{
+			StringValue(data);
+
+			long len;
+			unicode_t *unicode;
+
+			len = RSTRING(data)->len / sizeof(unicode_t);
+			unicode = (unicode_t *)malloc(sizeof(unicode_t) * (len+1));
+
+			if (unicode == NULL) {
+				rb_raise(rb_eNoMemError, "Couldn't allocate memory for Unicode data.");
+			}
+
+			memcpy(unicode, RSTRING(data)->ptr, sizeof(unicode_t) * len);
+			// Unicode strings need 0x0000 at the end.
+			unicode[len] = 0;
+			size_t retval = self->Set(unicode);
+
+			// Free Unicode! ;)
+			free(unicode);
+			return retval;
+		}
+	}
+
+protected:
+
+	ID3_Field();
+	~ID3_Field();
+};
+
+// vim: set filetype=cpp sw=4 ts=4 noexpandtab:

data/ext/id3lib_api_wrap.cxx

@@ -1795,8 +1795,8 @@ SWIG_AsVal_bool (VALUE obj, bool *val)
 }
 
 SWIGINTERN ID3_Frame *ID3_Tag_iterator_next_frame(ID3_Tag *self,ID3_Tag::Iterator *iterator){
-      return iterator->GetNext();
-    }
+			return iterator->GetNext();
+		}
 
 SWIGINTERNINLINE VALUE
 SWIG_From_int  (int value)
@@ -1804,49 +1804,48 @@ SWIG_From_int  (int value)
   return SWIG_From_long  (value);
 }
 
-SWIGINTERN VALUE ID3_Field_binary(ID3_Field *self){
-      return rb_str_new((const char *)self->GetRawBinary(), self->Size());
-    }
-SWIGINTERN VALUE ID3_Field_unicode(ID3_Field *self){
-      const char *string = (const char *)self->GetRawUnicodeText();
-      long size = self->Size();
-      if (size < 2) {
-        size = 0;
-      } else if (string[size-2] == '\0' && string[size-1] == '\0') {
-        // id3lib seems to be inconsistent: the unicode strings
-        // don't always end in 0x0000. If they do, we don't want these
-        // trailing bytes.
-        size -= 2;
-      }
-      return rb_str_new(string, size);
-    }
+SWIGINTERN VALUE ID3_Field_get_binary(ID3_Field *self){
+			return rb_str_new((const char *)self->GetRawBinary(), self->Size());
+		}
+SWIGINTERN VALUE ID3_Field_get_unicode(ID3_Field *self){
+			const char *string = (const char *)self->GetRawUnicodeText();
+			if (string == NULL) return rb_str_new("", 0);
+			long size = self->Size();
+			if (size >= 2 && string[size-2] == '\0' && string[size-1] == '\0') {
+				// id3lib seems to be inconsistent: the Unicode strings
+				// don't always end in 0x0000. If they do, we don't want these
+				// trailing bytes.
+				size -= 2;
+			}
+			return rb_str_new(string, size);
+		}
 SWIGINTERN size_t ID3_Field_set_binary(ID3_Field *self,VALUE data){
-      StringValue(data);
-      return self->Set( (const unsigned char *)RSTRING(data)->ptr, 
-        RSTRING(data)->len );
-    }
+			StringValue(data);
+			return self->Set((const unsigned char *)RSTRING(data)->ptr,
+			                 RSTRING(data)->len);
+		}
 SWIGINTERN size_t ID3_Field_set_unicode(ID3_Field *self,VALUE data){
-      StringValue(data);
+			StringValue(data);
 
-      long len;
-      unicode_t *unicode;
+			long len;
+			unicode_t *unicode;
 
-      len = RSTRING(data)->len / sizeof(unicode_t);
-      unicode = (unicode_t *)malloc(sizeof(unicode_t) * (len+1));
+			len = RSTRING(data)->len / sizeof(unicode_t);
+			unicode = (unicode_t *)malloc(sizeof(unicode_t) * (len+1));
 
-      if (unicode == NULL) {
-        rb_raise(rb_eNoMemError, "Couldn't allocate memory for unicode data.");
-      }
-      
-      memcpy(unicode, RSTRING(data)->ptr, sizeof(unicode_t) * len);
-      // Unicode strings need 0x0000 at the end.
-      unicode[len] = 0;
-      size_t retval = self->Set(unicode);
-
-      // Free Unicode! ;)
-      free(unicode);
-      return retval;
-    }
+			if (unicode == NULL) {
+				rb_raise(rb_eNoMemError, "Couldn't allocate memory for Unicode data.");
+			}
+
+			memcpy(unicode, RSTRING(data)->ptr, sizeof(unicode_t) * len);
+			// Unicode strings need 0x0000 at the end.
+			unicode[len] = 0;
+			size_t retval = self->Set(unicode);
+
+			// Free Unicode! ;)
+			free(unicode);
+			return retval;
+		}
 swig_class cTag;
 
 SWIGINTERN VALUE
@@ -2379,7 +2378,7 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Tag_filename(int argc, VALUE *argv, VALUE self) {
+_wrap_Tag_get_filename(int argc, VALUE *argv, VALUE self) {
   ID3_Tag *arg1 = (ID3_Tag *) 0 ;
   char *result = 0 ;
   void *argp1 = 0 ;
@@ -2639,7 +2638,7 @@ free_ID3_Frame(ID3_Frame *arg1) {
 }
 
 SWIGINTERN VALUE
-_wrap_Frame_field(int argc, VALUE *argv, VALUE self) {
+_wrap_Frame_get_field(int argc, VALUE *argv, VALUE self) {
   ID3_Frame *arg1 = (ID3_Frame *) 0 ;
   ID3_FieldID arg2 ;
   ID3_Field *result = 0 ;
@@ -2671,7 +2670,7 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Frame_num(int argc, VALUE *argv, VALUE self) {
+_wrap_Frame_get_id(int argc, VALUE *argv, VALUE self) {
   ID3_Frame *arg1 = (ID3_Frame *) 0 ;
   ID3_FrameID result;
   void *argp1 = 0 ;
@@ -2697,7 +2696,7 @@ fail:
 swig_class cField;
 
 SWIGINTERN VALUE
-_wrap_Field_type(int argc, VALUE *argv, VALUE self) {
+_wrap_Field_get_type(int argc, VALUE *argv, VALUE self) {
   ID3_Field *arg1 = (ID3_Field *) 0 ;
   ID3_FieldType result;
   void *argp1 = 0 ;
@@ -2721,9 +2720,9 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Field_integer(int argc, VALUE *argv, VALUE self) {
+_wrap_Field_get_encoding(int argc, VALUE *argv, VALUE self) {
   ID3_Field *arg1 = (ID3_Field *) 0 ;
-  unsigned long result;
+  ID3_TextEnc result;
   void *argp1 = 0 ;
   int res1 = 0 ;
   VALUE vresult = Qnil;
@@ -2733,11 +2732,11 @@ _wrap_Field_integer(int argc, VALUE *argv, VALUE self) {
   }
   res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_ID3_Field, 0 |  0 );
   if (!SWIG_IsOK(res1)) {
-    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "Get" "', argument " "1"" of type '" "ID3_Field const *""'"); 
+    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "GetEncoding" "', argument " "1"" of type '" "ID3_Field const *""'"); 
   }
   arg1 = reinterpret_cast< ID3_Field * >(argp1);
-  result = (unsigned long)((ID3_Field const *)arg1)->Get();
-  vresult = SWIG_From_unsigned_SS_long(static_cast< unsigned long >(result));
+  result = (ID3_TextEnc)((ID3_Field const *)arg1)->GetEncoding();
+  vresult = SWIG_From_int(static_cast< int >(result));
   return vresult;
 fail:
   return Qnil;
@@ -2745,9 +2744,9 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Field_binary(int argc, VALUE *argv, VALUE self) {
+_wrap_Field_get_integer(int argc, VALUE *argv, VALUE self) {
   ID3_Field *arg1 = (ID3_Field *) 0 ;
-  VALUE result;
+  unsigned long result;
   void *argp1 = 0 ;
   int res1 = 0 ;
   VALUE vresult = Qnil;
@@ -2757,11 +2756,11 @@ _wrap_Field_binary(int argc, VALUE *argv, VALUE self) {
   }
   res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_ID3_Field, 0 |  0 );
   if (!SWIG_IsOK(res1)) {
-    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "binary" "', argument " "1"" of type '" "ID3_Field *""'"); 
+    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "Get" "', argument " "1"" of type '" "ID3_Field const *""'"); 
   }
   arg1 = reinterpret_cast< ID3_Field * >(argp1);
-  result = (VALUE)ID3_Field_binary(arg1);
-  vresult = result;
+  result = (unsigned long)((ID3_Field const *)arg1)->Get();
+  vresult = SWIG_From_unsigned_SS_long(static_cast< unsigned long >(result));
   return vresult;
 fail:
   return Qnil;
@@ -2769,7 +2768,7 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Field_ascii(int argc, VALUE *argv, VALUE self) {
+_wrap_Field_get_ascii(int argc, VALUE *argv, VALUE self) {
   ID3_Field *arg1 = (ID3_Field *) 0 ;
   char *result = 0 ;
   void *argp1 = 0 ;
@@ -2793,7 +2792,7 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Field_unicode(int argc, VALUE *argv, VALUE self) {
+_wrap_Field_get_binary(int argc, VALUE *argv, VALUE self) {
   ID3_Field *arg1 = (ID3_Field *) 0 ;
   VALUE result;
   void *argp1 = 0 ;
@@ -2805,10 +2804,10 @@ _wrap_Field_unicode(int argc, VALUE *argv, VALUE self) {
   }
   res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_ID3_Field, 0 |  0 );
   if (!SWIG_IsOK(res1)) {
-    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "unicode" "', argument " "1"" of type '" "ID3_Field *""'"); 
+    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "get_binary" "', argument " "1"" of type '" "ID3_Field *""'"); 
   }
   arg1 = reinterpret_cast< ID3_Field * >(argp1);
-  result = (VALUE)ID3_Field_unicode(arg1);
+  result = (VALUE)ID3_Field_get_binary(arg1);
   vresult = result;
   return vresult;
 fail:
@@ -2817,55 +2816,85 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Field_set_integer(int argc, VALUE *argv, VALUE self) {
+_wrap_Field_get_unicode(int argc, VALUE *argv, VALUE self) {
   ID3_Field *arg1 = (ID3_Field *) 0 ;
-  unsigned long arg2 ;
+  VALUE result;
   void *argp1 = 0 ;
   int res1 = 0 ;
-  unsigned long val2 ;
+  VALUE vresult = Qnil;
+  
+  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_Field, 0 |  0 );
+  if (!SWIG_IsOK(res1)) {
+    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "get_unicode" "', argument " "1"" of type '" "ID3_Field *""'"); 
+  }
+  arg1 = reinterpret_cast< ID3_Field * >(argp1);
+  result = (VALUE)ID3_Field_get_unicode(arg1);
+  vresult = result;
+  return vresult;
+fail:
+  return Qnil;
+}
+
+
+SWIGINTERN VALUE
+_wrap_Field_set_encoding(int argc, VALUE *argv, VALUE self) {
+  ID3_Field *arg1 = (ID3_Field *) 0 ;
+  ID3_TextEnc arg2 ;
+  bool result;
+  void *argp1 = 0 ;
+  int res1 = 0 ;
+  int val2 ;
   int ecode2 = 0 ;
+  VALUE vresult = Qnil;
   
   if ((argc < 1) || (argc > 1)) {
     rb_raise(rb_eArgError, "wrong # of arguments(%d for 1)",argc); SWIG_fail;
   }
   res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_ID3_Field, 0 |  0 );
   if (!SWIG_IsOK(res1)) {
-    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "Set" "', argument " "1"" of type '" "ID3_Field *""'"); 
+    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "SetEncoding" "', argument " "1"" of type '" "ID3_Field *""'"); 
   }
   arg1 = reinterpret_cast< ID3_Field * >(argp1);
-  ecode2 = SWIG_AsVal_unsigned_SS_long(argv[0], &val2);
+  ecode2 = SWIG_AsVal_int(argv[0], &val2);
   if (!SWIG_IsOK(ecode2)) {
-    SWIG_exception_fail(SWIG_ArgError(ecode2), "in method '" "Set" "', argument " "2"" of type '" "unsigned long""'");
+    SWIG_exception_fail(SWIG_ArgError(ecode2), "in method '" "SetEncoding" "', argument " "2"" of type '" "ID3_TextEnc""'");
   } 
-  arg2 = static_cast< unsigned long >(val2);
-  (arg1)->Set(arg2);
-  return Qnil;
+  arg2 = static_cast< ID3_TextEnc >(val2);
+  result = (bool)(arg1)->SetEncoding(arg2);
+  vresult = SWIG_From_bool(static_cast< bool >(result));
+  return vresult;
 fail:
   return Qnil;
 }
 
 
 SWIGINTERN VALUE
-_wrap_Field_set_binary(int argc, VALUE *argv, VALUE self) {
+_wrap_Field_set_integer(int argc, VALUE *argv, VALUE self) {
   ID3_Field *arg1 = (ID3_Field *) 0 ;
-  VALUE arg2 = (VALUE) 0 ;
-  size_t result;
+  unsigned long arg2 ;
   void *argp1 = 0 ;
   int res1 = 0 ;
-  VALUE vresult = Qnil;
+  unsigned long val2 ;
+  int ecode2 = 0 ;
   
   if ((argc < 1) || (argc > 1)) {
     rb_raise(rb_eArgError, "wrong # of arguments(%d for 1)",argc); SWIG_fail;
   }
   res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_ID3_Field, 0 |  0 );
   if (!SWIG_IsOK(res1)) {
-    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "set_binary" "', argument " "1"" of type '" "ID3_Field *""'"); 
+    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "Set" "', argument " "1"" of type '" "ID3_Field *""'"); 
   }
   arg1 = reinterpret_cast< ID3_Field * >(argp1);
-  arg2 = argv[0];
-  result = ID3_Field_set_binary(arg1,arg2);
-  vresult = SWIG_From_size_t(static_cast< size_t >(result));
-  return vresult;
+  ecode2 = SWIG_AsVal_unsigned_SS_long(argv[0], &val2);
+  if (!SWIG_IsOK(ecode2)) {
+    SWIG_exception_fail(SWIG_ArgError(ecode2), "in method '" "Set" "', argument " "2"" of type '" "unsigned long""'");
+  } 
+  arg2 = static_cast< unsigned long >(val2);
+  (arg1)->Set(arg2);
+  return Qnil;
 fail:
   return Qnil;
 }
@@ -2907,14 +2936,12 @@ fail:
 
 
 SWIGINTERN VALUE
-_wrap_Field_set_encoding(int argc, VALUE *argv, VALUE self) {
+_wrap_Field_set_binary(int argc, VALUE *argv, VALUE self) {
   ID3_Field *arg1 = (ID3_Field *) 0 ;
-  ID3_TextEnc arg2 ;
-  bool result;
+  VALUE arg2 = (VALUE) 0 ;
+  size_t result;
   void *argp1 = 0 ;
   int res1 = 0 ;
-  int val2 ;
-  int ecode2 = 0 ;
   VALUE vresult = Qnil;
   
   if ((argc < 1) || (argc > 1)) {
@@ -2922,16 +2949,12 @@ _wrap_Field_set_encoding(int argc, VALUE *argv, VALUE self) {
   }
   res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_ID3_Field, 0 |  0 );
   if (!SWIG_IsOK(res1)) {
-    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "SetEncoding" "', argument " "1"" of type '" "ID3_Field *""'"); 
+    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "set_binary" "', argument " "1"" of type '" "ID3_Field *""'"); 
   }
   arg1 = reinterpret_cast< ID3_Field * >(argp1);
-  ecode2 = SWIG_AsVal_int(argv[0], &val2);
-  if (!SWIG_IsOK(ecode2)) {
-    SWIG_exception_fail(SWIG_ArgError(ecode2), "in method '" "SetEncoding" "', argument " "2"" of type '" "ID3_TextEnc""'");
-  } 
-  arg2 = static_cast< ID3_TextEnc >(val2);
-  result = (bool)(arg1)->SetEncoding(arg2);
-  vresult = SWIG_From_bool(static_cast< bool >(result));
+  arg2 = argv[0];
+  result = ID3_Field_set_binary(arg1,arg2);
+  vresult = SWIG_From_size_t(static_cast< size_t >(result));
   return vresult;
 fail:
   return Qnil;
@@ -3242,7 +3265,7 @@ SWIGEXPORT void Init_id3lib_api(void) {
   rb_define_method(cTag.klass, "clear", VALUEFUNC(_wrap_Tag_clear), -1);
   rb_define_method(cTag.klass, "remove_frame", VALUEFUNC(_wrap_Tag_remove_frame), -1);
   rb_define_method(cTag.klass, "add_frame", VALUEFUNC(_wrap_Tag_add_frame), -1);
-  rb_define_method(cTag.klass, "filename", VALUEFUNC(_wrap_Tag_filename), -1);
+  rb_define_method(cTag.klass, "get_filename", VALUEFUNC(_wrap_Tag_get_filename), -1);
   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);
@@ -3256,8 +3279,8 @@ SWIGEXPORT void Init_id3lib_api(void) {
   SWIG_TypeClientData(SWIGTYPE_p_ID3_Frame, (void *) &cFrame);
   rb_define_alloc_func(cFrame.klass, _wrap_Frame_allocate);
   rb_define_method(cFrame.klass, "initialize", VALUEFUNC(_wrap_new_Frame), -1);
-  rb_define_method(cFrame.klass, "field", VALUEFUNC(_wrap_Frame_field), -1);
-  rb_define_method(cFrame.klass, "num", VALUEFUNC(_wrap_Frame_num), -1);
+  rb_define_method(cFrame.klass, "get_field", VALUEFUNC(_wrap_Frame_get_field), -1);
+  rb_define_method(cFrame.klass, "get_id", VALUEFUNC(_wrap_Frame_get_id), -1);
   cFrame.mark = 0;
   cFrame.destroy = (void (*)(void *)) free_ID3_Frame;
   cFrame.trackObjects = 0;
@@ -3265,15 +3288,16 @@ SWIGEXPORT void Init_id3lib_api(void) {
   cField.klass = rb_define_class_under(mAPI, "Field", rb_cObject);
   SWIG_TypeClientData(SWIGTYPE_p_ID3_Field, (void *) &cField);
   rb_undef_alloc_func(cField.klass);
-  rb_define_method(cField.klass, "type", VALUEFUNC(_wrap_Field_type), -1);
-  rb_define_method(cField.klass, "integer", VALUEFUNC(_wrap_Field_integer), -1);
-  rb_define_method(cField.klass, "binary", VALUEFUNC(_wrap_Field_binary), -1);
-  rb_define_method(cField.klass, "ascii", VALUEFUNC(_wrap_Field_ascii), -1);
-  rb_define_method(cField.klass, "unicode", VALUEFUNC(_wrap_Field_unicode), -1);
+  rb_define_method(cField.klass, "get_type", VALUEFUNC(_wrap_Field_get_type), -1);
+  rb_define_method(cField.klass, "get_encoding", VALUEFUNC(_wrap_Field_get_encoding), -1);
+  rb_define_method(cField.klass, "get_integer", VALUEFUNC(_wrap_Field_get_integer), -1);
+  rb_define_method(cField.klass, "get_ascii", VALUEFUNC(_wrap_Field_get_ascii), -1);
+  rb_define_method(cField.klass, "get_binary", VALUEFUNC(_wrap_Field_get_binary), -1);
+  rb_define_method(cField.klass, "get_unicode", VALUEFUNC(_wrap_Field_get_unicode), -1);
+  rb_define_method(cField.klass, "set_encoding", VALUEFUNC(_wrap_Field_set_encoding), -1);
   rb_define_method(cField.klass, "set_integer", VALUEFUNC(_wrap_Field_set_integer), -1);
-  rb_define_method(cField.klass, "set_binary", VALUEFUNC(_wrap_Field_set_binary), -1);
   rb_define_method(cField.klass, "set_ascii", VALUEFUNC(_wrap_Field_set_ascii), -1);
-  rb_define_method(cField.klass, "set_encoding", VALUEFUNC(_wrap_Field_set_encoding), -1);
+  rb_define_method(cField.klass, "set_binary", VALUEFUNC(_wrap_Field_set_binary), -1);
   rb_define_method(cField.klass, "set_unicode", VALUEFUNC(_wrap_Field_set_unicode), -1);
   cField.mark = 0;
   cField.trackObjects = 0;

data/lib/id3lib.rb

@@ -327,25 +327,26 @@ module ID3Lib
 
     def self.read(libframe)
       frame = {}
-      info = Info.frame_num(libframe.num)
+      info = Info.frame_num(libframe.get_id)
       frame[:id] = info[ID]
-      if info[FIELDS].include?(:textenc)
-        textenc = field(libframe, :textenc).integer
-        frame[:textenc] = textenc
-      end
+
       info[FIELDS].each do |field_id|
-        next if field_id == :textenc
         libfield = field(libframe, field_id)
-        frame[field_id] = if textenc and textenc > 0
-          libfield.unicode
-        else
-          case Info::FieldType[libfield.type]
-          when :integer : libfield.integer
-          when :binary  : libfield.binary
-          when :text    : libfield.ascii
+        frame[field_id] =
+          case Info::FieldType[libfield.get_type]
+          when :integer
+            libfield.get_integer
+          when :binary
+            libfield.get_binary
+          when :text
+            if libfield.get_encoding > 0
+              libfield.get_unicode
+            else
+              libfield.get_ascii
+            end
           end
-        end
       end
+
       frame
     end
 
@@ -353,29 +354,35 @@ module ID3Lib
       if textenc = frame[:textenc]
         field(libframe, :textenc).set_integer(textenc)
       end
+
       frame.each do |field_id, value|
         next if field_id == :textenc
         unless Info.frame(frame[:id])[FIELDS].include?(field_id)
           # Ignore invalid fields
           next
         end
+
         libfield = field(libframe, field_id)
-        if textenc and textenc > 0
-          # Special treatment for Unicode
-          libfield.set_encoding(textenc)
-          libfield.set_unicode(value)
-        else
-          case Info::FieldType[libfield.type]
-          when :integer : libfield.set_integer(value)
-          when :binary  : libfield.set_binary(value)
-          when :text    : libfield.set_ascii(value)
+        case Info::FieldType[libfield.get_type]
+        when :integer
+          libfield.set_integer(value)
+        when :binary
+          libfield.set_binary(value)
+        when :text
+          if textenc and textenc > 0 and
+             [:text, :description, :filename].include?(field_id)
+            # Special treatment for Unicode
+            libfield.set_encoding(textenc)
+            libfield.set_unicode(value)
+          else
+            libfield.set_ascii(value)
           end
         end
       end
     end
 
     def self.field(libframe, id)
-      libframe.field(Info.field(id)[NUM])
+      libframe.get_field(Info.field(id)[NUM])
     end
 
   end

data/test/test_writing.rb

@@ -172,12 +172,19 @@ class TestWriting < Test::Unit::TestCase
   
   def test_unicode
     nihao = "\x4f\x60\x59\x7d"
-    @tag.reject!{ |f| f[:id] == :TIT2 }
-    @tag << {:id => :TIT2, :text => nihao, :textenc => 1}
+    frame = {
+      :id          => :COMM,
+      :text        => nihao,
+      :description => nihao,
+      :language    => "zho",
+      :textenc     => 1
+    }
+    @tag.comment = nil
+    @tag << frame
     @tag.update!(ID3Lib::V2)
-    assert_equal nihao, @tag.title
+    assert_equal frame, @tag.frame(:COMM)
     reload!(ID3Lib::V2)
-    assert_equal nihao, @tag.title
+    assert_equal frame, @tag.frame(:COMM)
   end
 
   def test_unicode_invalid_data

data/usage.rb

@@ -0,0 +1,40 @@
+
+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!

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.8.99
 specification_version: 1
 name: id3lib-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
-date: 2006-06-05 00:00:00 +02:00
+  version: 0.4.0
+date: 2006-06-27 00:00:00 +02: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
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Robin Stocker
 files: 
@@ -37,9 +38,13 @@ files:
 - test/data/unicode.mp3
 - test/data/cover.jpg
 - Rakefile
+- usage.rb
 - setup.rb
 - ext/extconf.rb
+- ext/generate_info.rb
 - ext/id3lib_api_wrap.cxx
+- ext/id3lib_api.i
+- ext/Rakefile
 - README
 - CHANGES
 - TODO
@@ -47,6 +52,7 @@ test_files:
 - test/test_writing.rb
 - test/test_reading.rb
 rdoc_options: 
+- --inline-source
 - --line-numbers
 - --main
 - README