id3lib-ruby 0.6.0-x86-mswin32-60

data/CHANGES

@@ -0,0 +1,67 @@
+= id3lib-ruby changes
+
+=== 0.6.0 (2010-05-16)
+
+* Added convenience method user_frame_text to Tag for finding a
+  TXXX frame given a description (e.g. "MusicBrainz Album Id")
+  (RubyForge feature request 24381)
+* Fixed compilation problem on Ruby 1.9 (GitHub issue 1)
+* Don't check for ID3Tag_New in extconf.rb (RubyForge bug 27589)
+* Updated to SWIG 1.3.40
+* Use rake-compiler for cross-compiling the extension
+
+=== 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).
+* Added more tests and a warning in README for writing of UTF-16 frames.
+
+=== 0.4.0 (r41)
+
+* Fixed Unicode problems (bug 4768).
+* Renamed ID3Lib::API methods to be more like the id3lib method names.
+  E.g. 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.
+* Updated to SWIG 1.3.29.
+
+=== 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.
+
+=== 0.2.0 (r21)
+
+* Overhauled direct access methods
+  * Remove frames by setting them to nil, e.g. tag.title = nil
+  * Removed methods for rarely used frames.
+  * All methods use strings now, no special cases like track anymore.
+  * Explicit call of to_s in set_frame_text.
+* More unit tests
+* Added method invalid_frames which is useful to detect invalid frame
+  data before calling update!.
+
+=== 0.1.0 (r19)
+
+* First release :)

data/INSTALL

@@ -0,0 +1,75 @@
+= 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.
+
+==== Ubuntu and Debian Linux
+
+Install libid3-dev and be sure to have ruby-dev installed, otherwise you
+won't be able to build Ruby extensions.
+
+  sudo aptitude install libid3-dev ruby-dev g++
+
+==== Fedora Linux
+
+  sudo yum install id3lib-devel ruby-devel gcc-c++
+
+==== Gentoo Linux
+
+  sudo emerge -n id3lib
+
+==== Mac OS X
+
+If you use the Ruby distribution provided by Mac OS X, you need to have Apple's
+Xcode installed in order to be able to build extensions.
+
+Now, either install id3lib through MacPorts or Fink, or by downloading and
+compiling manually.
+
+===== MacPorts
+
+  sudo port install id3lib
+
+===== Fink
+
+  sudo apt-get install id3lib4-dev
+
+=== 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
+
+==== Mac OS X
+
+On Mac OS X 10.5 and later, Ruby tries to compile the extension for multiple
+architectures (universal build) and fails. You have to specify the right
+architecture manually. For 64 bit Intel processors, do:
+
+  sudo env ARCHFLAGS="-arch x86_64" gem install id3lib-ruby
+
+For 32 bit Intel processors:
+
+  sudo env ARCHFLAGS="-arch i386" gem install id3lib-ruby
+
+And for PPC processors:
+
+  sudo env ARCHFLAGS="-arch ppc" gem install id3lib-ruby

data/README

@@ -0,0 +1,84 @@
+= id3lib-ruby
+
+id3lib-ruby provides a Ruby interface to the id3lib C++ library for easily
+editing ID3 tags (v1 and v2) of MP3 audio files.
+
+The class documentation starts at ID3Lib::Tag.
+
+
+== Features
+
+* Read and write ID3v1 and ID3v2 tags
+* Simple interface for adding, changing and removing frames
+* Quick access to common text frames like title and performer
+* Custom data frames like attached picture (APIC)
+* Pretty complete coverage of id3lib's features
+* UTF-16 support (warning: id3lib writes broken UTF-16 frames)
+* Windows binary gem available
+
+The CHANGES file contains a list of changes between versions.
+
+
+== Installation
+
+See INSTALL.
+
+
+== Online Information
+
+The home of id3lib-ruby is http://id3lib-ruby.rubyforge.org
+
+
+== Usage
+
+  require 'rubygems'
+  require 'id3lib'
+  
+  # Load a tag from a file
+  tag = ID3Lib::Tag.new('talk.mp3')
+  
+  # Get and set text frames with convenience methods
+  tag.title  #=> "Talk"
+  tag.album = 'X&Y'
+  tag.track = '5/13'
+  
+  # Tag is a subclass of Array and each frame is a Hash
+  tag[0]
+  #=> { :id => :TPE1, :textenc => 0, :text => "Coldplay" }
+  
+  # Get the number of frames
+  tag.length  #=> 7
+  
+  # Remove all comment frames
+  tag.delete_if{ |frame| frame[:id] == :COMM }
+  
+  # Get info about APIC frame to see which fields are allowed
+  ID3Lib::Info.frame(:APIC)
+  #=> [ 2, :APIC, "Attached picture",
+  #=>   [:textenc, :mimetype, :picturetype, :description, :data] ]
+  
+  # Add an attached picture frame
+  cover = {
+    :id          => :APIC,
+    :mimetype    => 'image/jpeg',
+    :picturetype => 3,
+    :description => 'A pretty picture',
+    :textenc     => 0,
+    :data        => File.read('cover.jpg')
+  }
+  tag << cover
+  
+  # Last but not least, apply changes
+  tag.update!
+
+
+== Licence
+
+This library has Ruby's licence:
+
+http://www.ruby-lang.org/en/LICENSE.txt
+
+
+== Author
+
+Robin Stocker <robinstocker at rubyforge.org>

data/Rakefile

@@ -0,0 +1,181 @@
+
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+
+begin
+  require 'rake/extensiontask'
+rescue LoadError
+  # Compiling of extension will have to be done manually.
+end
+
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'open-uri'
+
+
+FILES_COMMON = FileList[
+  'lib/**/*.rb',
+  'test/test_*.rb',
+  'test/data/*.mp3',
+  'test/data/cover.jpg',
+  'Rakefile',
+  '*.rb'
+]
+
+FILES_DOC = FileList[
+  'README', 'INSTALL', 'TODO', 'CHANGES'
+]
+
+FILES_EXT = FileList[
+  'ext/id3lib_api/*.{rb,cxx,i}',
+  'ext/id3lib_api/Rakefile'
+]
+
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib', 'ext/id3lib_api']
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+
+
+RDOC_OPTS = ['--inline-source', '--line-numbers', '--main', 'README']
+
+desc "Generate RDOC documentation."
+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')
+end
+task :doc => [:rdoc]
+
+
+if defined? Gem
+
+  spec = Gem::Specification.new do |s|
+    s.name        = 'id3lib-ruby'
+    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) of MP3 audio files.'
+    s.description = File.read('README')
+    s.requirements << 'id3lib C++ library'
+    s.files       = FILES_COMMON + FILES_EXT
+    s.test_files  = FileList['test/test_*.rb']
+    s.extensions  << 'ext/id3lib_api/extconf.rb'
+    s.has_rdoc    = true
+    s.extra_rdoc_files = FILES_DOC
+    s.rdoc_options = RDOC_OPTS
+    s.author      = 'Robin Stocker'
+    s.email       = 'robinstocker@rubyforge.org'
+    s.homepage    = 'http://id3lib-ruby.rubyforge.org'
+    s.rubyforge_project = "id3lib-ruby"
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar_gz = true
+    pkg.need_zip = true
+  end
+
+  if defined? Rake::ExtensionTask
+
+    host = 'i586-mingw32msvc'
+    plat = 'x86-mswin32-60'
+    tmp = "#{Dir.pwd}/tmp/#{plat}"
+    cflags = "'-Os -DID3LIB_LINKOPTION=1'"
+    config_options = ["--with-opt-dir=#{tmp}", "--with-cflags=#{cflags}"]
+    id3lib_version = '3.8.3'
+    id3lib = "id3lib-#{id3lib_version}"
+    id3lib_url = "http://downloads.sourceforge.net/project/" +
+                 "id3lib/id3lib/#{id3lib_version}/#{id3lib}.tar.gz"
+    patches = FileList["#{Dir.pwd}/ext/mswin32/patches/*patch"]
+
+    Rake::ExtensionTask.new('id3lib_api', spec) do |ext|
+      ext.cross_compile = true
+      ext.cross_platform = plat
+      ext.cross_config_options.concat(config_options)
+      if RUBY_PLATFORM =~ /mingw/
+        ext.config_options.concat(config_options)
+      end
+    end
+
+    task :cross => [:id3lib] do
+      # Mkmf just uses "g++" as C++ compiler, despite what's in rbconfig.rb.
+      # So, we need to hack around it by setting CXX to the cross compiler.
+      ENV["CXX"] = "#{host}-g++"
+    end
+
+    # Linking to the DLLs provided by id3lib.sf.net doesn't seem to work on
+    # Windows, so we download and compile it automatically (the same as when
+    # cross compiling).
+    if RUBY_PLATFORM =~ /mingw/
+      Rake::Task[:compile].prerequisites.unshift(:id3lib)
+    end
+
+    task :id3lib => ["#{tmp}/lib/libid3.a"]
+
+    file "#{tmp}/lib/libid3.a" => ["#{tmp}/#{id3lib}/config.log"] do
+      chdir "#{tmp}/#{id3lib}" do
+        env = "CFLAGS=#{cflags} CXXFLAGS=#{cflags}"
+        sh "sh configure --host=#{host} --prefix=#{tmp} #{env}"
+        sh "make"
+        sh "make install"
+      end
+    end
+
+    file "#{tmp}/#{id3lib}/config.log" => ["#{tmp}/#{id3lib}.tar.gz"] do
+      chdir tmp do
+        sh "tar xzf #{id3lib}.tar.gz"
+        patches.each do |patch|
+          sh "patch -p0 < #{patch}"
+        end
+      end
+    end
+
+    file "#{tmp}/#{id3lib}.tar.gz" => [tmp] do |t|
+      puts "Downloading #{id3lib_url}"
+      data = open(id3lib_url).read()
+      break if data == nil
+      chdir tmp do
+        open(File.basename(t.name), 'wb') do |f|
+          f.write(data)
+        end
+      end
+    end
+
+    directory tmp
+
+  end  # defined? Rake::ExtensionTask
+
+end  # defined? Gem
+
+
+task :web => [:web_doc] do
+  puts "# Now execute the following:"
+  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
+
+desc "Generate RDOC documentation for web."
+Rake::RDocTask.new :web_doc do |rdoc|
+  rdoc.rdoc_dir = 'web/doc'
+  rdoc.title = 'id3lib-ruby'
+  rdoc.options = RDOC_OPTS.clone
+  rdoc.options << '--main' << 'ID3Lib::Tag'
+  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')
+  html = convertor.convert(File.read('usage.rb'))
+  puts html
+end

data/TODO

@@ -0,0 +1,10 @@
+= id3lib-ruby to-do list
+
+The underlying C++ library id3lib is no longer maintained and outdated (no
+support for ID3v2.4). Therefore id3lib-ruby is no longer actively developed.
+Here's the old to-do list anyway:
+
+* Evaluate an object-oriented way to handle frames, instead of with hashes.
+* Make the update! method intelligent, because the call of strip each time
+  is very slow and stupid.
+* Add UTF-8 support if id3lib can handle it.

data/ext/id3lib_api/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 -initname id3lib_api id3lib_api.i"
+end
+
+file 'Makefile' do
+  ruby "extconf.rb"
+end

data/ext/id3lib_api/extconf.rb

@@ -0,0 +1,27 @@
+# Default opt dirs to help mkmf find id3lib
+configure_args = "--with-opt-dir=/usr/local:/opt/local:/sw "
+ENV['CONFIGURE_ARGS'] = configure_args + ENV.fetch('CONFIGURE_ARGS', "")
+
+require 'mkmf'
+
+def error msg
+  message msg + "\n"
+  abort
+end
+
+unless have_library('stdc++')
+  error "You must have libstdc++ installed."
+end
+
+unless have_library('z')
+  error "You must have zlib installed."
+end
+
+# This is only necessary for linking on Windows (don't ask me why).
+have_library('iconv')
+
+unless have_header('id3.h') and have_library('id3')
+  error "You must have id3lib installed in order to use id3lib-ruby."
+end
+
+create_makefile('id3lib_api')