id3lib-ruby 0.2.1 → 0.3.0

data/CHANGES

@@ -1,8 +1,16 @@
 = id3lib-ruby changes
 
+=== 0.3.0 (r29)
+
+* Added generation of mswin32 binary gem. This means that
+  installing on Windows is a piece of cake. No dependencies, no
+  compiling, just a gem installation.
+* Changed Info.frame to use hash access instead of find -> faster.
+
 === 0.2.1 (r23)
 
-* Fixed extconf.rb to print a message and abort if id3lib can't be found.
+* Fixed extconf.rb to print a message and abort if id3lib can't be
+  found.
 
 === 0.2.0 (r21)
 

data/README

@@ -15,6 +15,7 @@ The class documentation starts at ID3Lib::Tag.
 * Custom data frames like attached picture (APIC)
 * Pretty complete coverage of id3lib's features
 * UTF-16 support
+* Windows binary gem available
 
 See TODO for planned features.
 
@@ -28,7 +29,10 @@ The home of id3lib-ruby is http://id3lib-ruby.rubyforge.org
 
 == Installation
 
-Installation through Rubygems:
+Note that id3lib has to be installed before running any of the following
+commands, unless you use the Windows binary gem.
+
+Installation through RubyGems:
 
   gem install id3lib-ruby
 

data/Rakefile

@@ -10,12 +10,10 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 
 
-PKG_VERSION = '0.2.1'
+PKG_VERSION = '0.3.0'
 
-PKG_FILES = FileList[
+PKG_COMMON = FileList[
   'lib/**/*.rb',
-  'ext/extconf.rb',
-  'ext/*.cxx',
   'test/test_*.rb',
   'test/data/*.mp3',
   'test/data/cover.jpg',
@@ -24,16 +22,18 @@ PKG_FILES = FileList[
 ]
 
 
-desc 'Default task is to build extension.'
-task :default => [:ext]
-
-
 desc "Build extension."
 task :ext do
   sh "cd ext && rake"
   puts "(end)"
 end
 
+desc "Build mswin32 extension."
+task :ext_mswin32 do
+  sh 'cd ext/mswin32; rake'
+  puts "(end)"
+end
+
 
 Rake::TestTask.new do |t|
   t.libs = ['lib', 'ext']
@@ -63,7 +63,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_FILES
+    s.files       = PKG_COMMON + FileList['ext/extconf.rb', 'ext/*.cxx']
     s.extensions  = ['ext/extconf.rb']
     s.test_files  = FileList['test/test_*.rb']
     s.has_rdoc    = true
@@ -79,7 +79,21 @@ if defined? Gem
     pkg.need_tar_gz = true
     pkg.need_zip = true
   end
-end
+
+  spec_mswin32 = spec.clone
+  spec_mswin32.files = PKG_COMMON + FileList['ext/mswin32/id3lib_api.so']
+  spec_mswin32.extensions = []
+  spec_mswin32.require_paths = ['lib', 'ext/mswin32']
+  spec_mswin32.platform = Gem::Platform::WIN32
+
+  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/"
+  end
+
+end  # defined? Gem
 
 
 task :web => [:web_doc] do
@@ -97,12 +111,9 @@ Rake::RDocTask.new :web_doc do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
 task :usage_html do
   require 'syntax/convertors/html'
-
   convertor = Syntax::Convertors::HTML.for_syntax('ruby')
   html = convertor.convert(File.read('usage.rb'))
-
   puts html
 end

data/TODO

@@ -1,5 +1,4 @@
 = id3lib-ruby to-do list
 
-* Create Windows binary gem (id3lib.dll included).
 * Evaluate a more object-oriented way to handle frames, instead of hashes.
 * Add UTF-8 support if id3lib can handle it.

data/lib/id3lib.rb

@@ -327,7 +327,7 @@ module ID3Lib
 
     def self.read(libframe)
       frame = {}
-      info = Info.frame(libframe.num)
+      info = Info.frame_num(libframe.num)
       frame[:id] = info[ID]
       if info[FIELDS].include?(:textenc)
         textenc = field(libframe, :textenc).integer
@@ -350,16 +350,18 @@ module ID3Lib
     end
 
     def self.write(frame, libframe)
-      textenc = frame[:textenc]
-      field(libframe, :textenc).set_integer(textenc) if textenc
+      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)
-          # TODO: Add method to check if frames are valid.
+          # Ignore invalid fields
           next
         end
-        next if field_id == :textenc
         libfield = field(libframe, field_id)
         if textenc and textenc > 0
+          # Special treatment for Unicode
           libfield.set_encoding(textenc)
           libfield.set_unicode(value)
         else

data/lib/id3lib/info.rb

@@ -55,33 +55,39 @@ module ID3Lib
   #
   module Info
     
+    #
+    # 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
+    #
     Frames = [
       # Special frames
-      [1, :AENC, "Audio encryption", [:owner, :data]], # not fully supported by id3lib
+      [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]], # not fully supported by id3lib
+      [3, :ASPI, "Audio seek point index", [:data]],
       [4, :COMM, "Comments", [:textenc, :language, :description, :text]],
-      [5, :COMR, "Commercial frame", [:data]], # not fully supported by id3lib
+      [5, :COMR, "Commercial frame", [:data]],
       [6, :ENCR, "Encryption method registration", [:owner, :id, :data]],
       [7, :EQU2, "Equalisation (2)", [:id, :text]],
-      [8, :EQUA, "Equalization", [:data]], # not fully supported by id3lib
-      [9, :ETCO, "Event timing codes", [:data]], # not fully supported by id3lib
+      [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]],
       [12, :IPLS, "Involved people list", [:textenc, :text]],
-      [13, :LINK, "Linked information", [:data]], # not fully supported by id3lib
+      [13, :LINK, "Linked information", [:data]],
       [14, :MCDI, "Music CD identifier", [:data]],
-      [15, :MLLT, "MPEG location lookup table", [:data]], # not fully supported by id3lib
-      [16, :OWNE, "Ownership frame", [:data]], # not fully supported by id3lib
+      [15, :MLLT, "MPEG location lookup table", [:data]],
+      [16, :OWNE, "Ownership frame", [:data]],
       [17, :PRIV, "Private frame", [:owner, :data]],
       [18, :PCNT, "Play counter", [:counter]],
       [19, :POPM, "Popularimeter", [:email, :rating, :counter]],
-      [20, :POSS, "Position synchronisation frame", [:data]], # not fully supported by id3lib
-      [21, :RBUF, "Recommended buffer size", [:data]], # not fully supported by id3lib
-      [22, :RVA2, "Relative volume adjustment (2)", [:data]], # not fully supported by id3lib
-      [23, :RVAD, "Relative volume adjustment", [:data]], # not fully supported by id3lib
-      [24, :RVRB, "Reverb", [:data]], # not fully supported by id3lib
-      [25, :SEEK, "Seek frame", [:data]], # not fully supported by id3lib
+      [20, :POSS, "Position synchronisation frame", [:data]],
+      [21, :RBUF, "Recommended buffer size", [:data]],
+      [22, :RVA2, "Relative volume adjustment (2)", [:data]],
+      [23, :RVAD, "Relative volume adjustment", [:data]],
+      [24, :RVRB, "Reverb", [:data]],
+      [25, :SEEK, "Seek frame", [:data]],
       [26, :SIGN, "Signature frame", [:id, :data]],
       [27, :SYLT, "Synchronized lyric/text", [:textenc, :language, :timestampformat, :contenttype, :description, :data]],
       [28, :SYTC, "Synchronized tempo codes", [:timestampformat, :data]],
@@ -151,8 +157,104 @@ module ID3Lib
       [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]]
+      [92, :WXXX, "User defined URL link", [:textenc, :description, :url]],
     ]
+
+    FramesByID = {
+      :____ => Frames[0],
+      :AENC => Frames[1],
+      :APIC => Frames[2],
+      :ASPI => Frames[3],
+      :COMM => Frames[4],
+      :COMR => Frames[5],
+      :ENCR => Frames[6],
+      :EQU2 => Frames[7],
+      :EQUA => Frames[8],
+      :ETCO => Frames[9],
+      :GEOB => Frames[10],
+      :GRID => Frames[11],
+      :IPLS => Frames[12],
+      :LINK => Frames[13],
+      :MCDI => Frames[14],
+      :MLLT => Frames[15],
+      :OWNE => Frames[16],
+      :PRIV => Frames[17],
+      :PCNT => Frames[18],
+      :POPM => Frames[19],
+      :POSS => Frames[20],
+      :RBUF => Frames[21],
+      :RVA2 => Frames[22],
+      :RVAD => Frames[23],
+      :RVRB => Frames[24],
+      :SEEK => Frames[25],
+      :SIGN => Frames[26],
+      :SYLT => Frames[27],
+      :SYTC => Frames[28],
+      :TALB => Frames[29],
+      :TBPM => Frames[30],
+      :TCOM => Frames[31],
+      :TCON => Frames[32],
+      :TCOP => Frames[33],
+      :TDAT => Frames[34],
+      :TDEN => Frames[35],
+      :TDLY => Frames[36],
+      :TDOR => Frames[37],
+      :TDRC => Frames[38],
+      :TDRL => Frames[39],
+      :TDTG => Frames[40],
+      :TIPL => Frames[41],
+      :TENC => Frames[42],
+      :TEXT => Frames[43],
+      :TFLT => Frames[44],
+      :TIME => Frames[45],
+      :TIT1 => Frames[46],
+      :TIT2 => Frames[47],
+      :TIT3 => Frames[48],
+      :TKEY => Frames[49],
+      :TLAN => Frames[50],
+      :TLEN => Frames[51],
+      :TMCL => Frames[52],
+      :TMED => Frames[53],
+      :TMOO => Frames[54],
+      :TOAL => Frames[55],
+      :TOFN => Frames[56],
+      :TOLY => Frames[57],
+      :TOPE => Frames[58],
+      :TORY => Frames[59],
+      :TOWN => Frames[60],
+      :TPE1 => Frames[61],
+      :TPE2 => Frames[62],
+      :TPE3 => Frames[63],
+      :TPE4 => Frames[64],
+      :TPOS => Frames[65],
+      :TPRO => Frames[66],
+      :TPUB => Frames[67],
+      :TRCK => Frames[68],
+      :TRDA => Frames[69],
+      :TRSN => Frames[70],
+      :TRSO => Frames[71],
+      :TSIZ => Frames[72],
+      :TSOA => Frames[73],
+      :TSOP => Frames[74],
+      :TSOT => Frames[75],
+      :TSRC => Frames[76],
+      :TSSE => Frames[77],
+      :TSST => Frames[78],
+      :TXXX => Frames[79],
+      :TYER => Frames[80],
+      :UFID => Frames[81],
+      :USER => Frames[82],
+      :USLT => Frames[83],
+      :WCOM => Frames[84],
+      :WCOP => Frames[85],
+      :WOAF => Frames[86],
+      :WOAR => Frames[87],
+      :WOAS => Frames[88],
+      :WORS => Frames[89],
+      :WPAY => Frames[90],
+      :WPUB => Frames[91],
+      :WXXX => Frames[92],
+    }
     
     Fields = [
       [0, :nofield, "No field"],
@@ -180,7 +282,34 @@ module ID3Lib
       [22, :timestampformat, "SYLT Timestamp Format"],
       [23, :contenttype, "SYLT content type"]
     ]
-    
+
+    FieldsByID = {
+      :nofield         => Fields[0],
+      :textenc         => Fields[1],
+      :text            => Fields[2],
+      :url             => Fields[3],
+      :data            => Fields[4],
+      :description     => Fields[5],
+      :owner           => Fields[6],
+      :email           => Fields[7],
+      :rating          => Fields[8],
+      :filename        => Fields[9],
+      :language        => Fields[10],
+      :picturetype     => Fields[11],
+      :imageformat     => Fields[12],
+      :mimetype        => Fields[13],
+      :counter         => Fields[14],
+      :id              => Fields[15],
+      :volumeadj       => Fields[16],
+      :numbits         => Fields[17],
+      :volchgright     => Fields[18],
+      :volchgleft      => Fields[19],
+      :peakvolright    => Fields[20],
+      :peakvolleft     => Fields[21],
+      :timestampformat => Fields[22],
+      :contenttype     => Fields[23],
+    }
+
     FieldType = {
       0 => :integer, 
       1 => :binary, 
@@ -225,8 +354,9 @@ module ID3Lib
       "Britpop", "Negerpunk", "Polsk Punk", "Beat",
       "Christian Gangsta Rap", "Heavy Metal", "Black Metal", "Crossover",
       "Contemporary Christian", "Christian Rock ", "Merengue", "Salsa",
-      "Trash Metal", "Anime", "JPop", "Synthpop"
+      "Trash Metal", "Anime", "JPop", "Synthpop",
     ]
+
     
     #
     # Get information of frame specified by _id_.
@@ -234,8 +364,11 @@ module ID3Lib
     #    ID3Lib::Info.frame(:TIT2)  #=> [47, :TIT2, "Title/songname/content description", [:textenc, :text]]
     #
     def self.frame(id)
-      index = id.is_a?(Integer) ? NUM : ID
-      Frames.find{ |f| f[index] == id }
+      FramesByID[id]
+    end
+
+    def self.frame_num(num)
+      Frames[num]
     end
     
     #
@@ -244,8 +377,11 @@ module ID3Lib
     #    ID3Lib::Info.field(:text)  #=> [2, :text, "Text field"]
     #
     def self.field(id)
-      index = id.is_a?(Integer) ? NUM : ID
-      Fields.find{ |f| f[index] == id }
+      FieldsByID[id]
+    end
+
+    def self.field_num(num)
+      Fields[num]
     end
             
   end

metadata

@@ -3,11 +3,11 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: id3lib-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2006-05-19 00:00:00 +02:00
+  version: 0.3.0
+date: 2006-05-28 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
+- lib
 email: robinstocker@rubyforge.org
 homepage: http://id3lib-ruby.rubyforge.org
 rubyforge_project: id3lib-ruby
@@ -18,46 +18,47 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-  - Robin Stocker
+- Robin Stocker
 files: 
-  - lib/id3lib.rb
-  - lib/id3lib/accessors.rb
-  - lib/id3lib/info.rb
-  - ext/extconf.rb
-  - ext/id3lib_api_wrap.cxx
-  - test/test_reading.rb
-  - test/test_writing.rb
-  - test/data/sample.mp3
-  - test/data/unicode.mp3
-  - test/data/cover.jpg
-  - Rakefile
-  - setup.rb
-  - README
-  - CHANGES
-  - TODO
+- lib/id3lib.rb
+- lib/id3lib/accessors.rb
+- lib/id3lib/info.rb
+- test/test_writing.rb
+- test/test_reading.rb
+- test/data/sample.mp3
+- test/data/unicode.mp3
+- test/data/cover.jpg
+- Rakefile
+- setup.rb
+- ext/extconf.rb
+- ext/id3lib_api_wrap.cxx
+- README
+- CHANGES
+- TODO
 test_files: 
-  - test/test_reading.rb
-  - test/test_writing.rb
+- test/test_writing.rb
+- test/test_reading.rb
 rdoc_options: 
-  - "--line-numbers"
-  - "--main"
-  - README
+- --line-numbers
+- --main
+- README
 extra_rdoc_files: 
-  - README
-  - CHANGES
-  - TODO
+- README
+- CHANGES
+- TODO
 executables: []
+
 extensions: 
-  - ext/extconf.rb
+- ext/extconf.rb
 requirements: 
-  - id3lib C++ library
-dependencies: []
+- id3lib C++ library
+dependencies: []
+