taglib-ruby 0.6.0 → 1.1.0

data/lib/taglib.rb

@@ -14,3 +14,5 @@ require 'taglib/ogg'
 require 'taglib/vorbis'
 require 'taglib/flac'
 require 'taglib/mp4'
+require 'taglib/aiff'
+require 'taglib/wav'

data/lib/taglib/aiff.rb

@@ -0,0 +1,7 @@
+require 'taglib_aiff'
+
+module TagLib::RIFF::AIFF
+  class File
+    extend ::TagLib::FileOpenable
+  end
+end

data/lib/taglib/mp4.rb

@@ -22,10 +22,11 @@ module TagLib::MP4
     end
   end
 
-  class ItemListMap
+  class ItemMap
     alias :clear :_clear
     alias :insert :_insert
     alias :[] :fetch
+    alias :[]= :insert
     remove_method :_clear
     remove_method :_insert
 

data/lib/taglib/version.rb

@@ -1,7 +1,7 @@
 module TagLib
   module Version
-    MAJOR = 0
-    MINOR = 6
+    MAJOR = 1
+    MINOR = 1
     PATCH = 0
     BUILD = nil
 

data/lib/taglib/wav.rb

@@ -0,0 +1,11 @@
+require 'taglib_wav'
+
+module TagLib::RIFF::WAV
+
+  FORMAT_UNKNOWN = 0x0000
+  FORMAT_PCM     = 0x0001
+
+  class File
+    extend ::TagLib::FileOpenable
+  end
+end

data/taglib-ruby.gemspec

@@ -7,7 +7,7 @@ require 'taglib/version'
 Gem::Specification.new do |s|
   s.name        = "taglib-ruby"
   s.version     = TagLib::Version::STRING
-  s.authors     = ["Robin Stocker", "Jacob Vosmaer"]
+  s.authors     = ["Robin Stocker", "Jacob Vosmaer", "Thomas Chevereau"]
   s.email       = ["robin@nibor.org"]
   s.homepage    = "http://robinst.github.io/taglib-ruby/"
   s.licenses    = ["MIT"]
@@ -23,11 +23,12 @@ DESC
   s.require_paths = ["lib"]
   s.requirements = ["taglib (libtag1-dev in Debian/Ubuntu, taglib-devel in Fedora/RHEL)"]
 
-  s.add_development_dependency 'bundler', '~> 1.2'
-  s.add_development_dependency 'rake-compiler', '~> 0.8'
+  s.add_development_dependency 'bundler', '>= 1.2', '< 3'
+  s.add_development_dependency 'rake-compiler', '~> 0.9'
   s.add_development_dependency 'shoulda-context', '~> 1.0'
-  s.add_development_dependency 'yard', '~> 0.7'
-  s.add_development_dependency 'kramdown', '~> 1.0'
+  s.add_development_dependency 'yard', '~> 0.9.26'
+  s.add_development_dependency 'kramdown', '~> 2.3.0'
+  s.add_development_dependency 'test-unit', '~> 3.1'
 
   s.extensions = [
     "ext/taglib_base/extconf.rb",
@@ -37,22 +38,26 @@ DESC
     "ext/taglib_ogg/extconf.rb",
     "ext/taglib_vorbis/extconf.rb",
     "ext/taglib_flac/extconf.rb",
+    "ext/taglib_flac_picture/extconf.rb",
     "ext/taglib_mp4/extconf.rb",
+    "ext/taglib_aiff/extconf.rb",
+    "ext/taglib_wav/extconf.rb",
   ]
   s.extra_rdoc_files = [
-    "CHANGES.md",
+    "CHANGELOG.md",
     "LICENSE.txt",
     "README.md",
   ]
   s.files = [
     ".yardopts",
-    "CHANGES.md",
+    "CHANGELOG.md",
     "Gemfile",
     "Guardfile",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
     "docs/default/fulldoc/html/css/common.css",
+    "docs/taglib/aiff.rb",
     "docs/taglib/base.rb",
     "docs/taglib/flac.rb",
     "docs/taglib/id3v1.rb",
@@ -60,8 +65,13 @@ DESC
     "docs/taglib/mp4.rb",
     "docs/taglib/mpeg.rb",
     "docs/taglib/ogg.rb",
+    "docs/taglib/riff.rb",
     "docs/taglib/vorbis.rb",
+    "docs/taglib/wav.rb",
     "ext/extconf_common.rb",
+    "ext/taglib_aiff/extconf.rb",
+    "ext/taglib_aiff/taglib_aiff.i",
+    "ext/taglib_aiff/taglib_aiff_wrap.cxx",
     "ext/taglib_base/extconf.rb",
     "ext/taglib_base/includes.i",
     "ext/taglib_base/taglib_base.i",
@@ -69,6 +79,10 @@ DESC
     "ext/taglib_flac/extconf.rb",
     "ext/taglib_flac/taglib_flac.i",
     "ext/taglib_flac/taglib_flac_wrap.cxx",
+    "ext/taglib_flac_picture/extconf.rb",
+    "ext/taglib_flac_picture/includes.i",
+    "ext/taglib_flac_picture/taglib_flac_picture.i",
+    "ext/taglib_flac_picture/taglib_flac_picture_wrap.cxx",
     "ext/taglib_id3v1/extconf.rb",
     "ext/taglib_id3v1/taglib_id3v1.i",
     "ext/taglib_id3v1/taglib_id3v1_wrap.cxx",
@@ -88,9 +102,13 @@ DESC
     "ext/taglib_vorbis/extconf.rb",
     "ext/taglib_vorbis/taglib_vorbis.i",
     "ext/taglib_vorbis/taglib_vorbis_wrap.cxx",
+    "ext/taglib_wav/extconf.rb",
+    "ext/taglib_wav/taglib_wav.i",
+    "ext/taglib_wav/taglib_wav_wrap.cxx",
     "ext/valgrind-suppressions.txt",
     "ext/win.cmake",
     "lib/taglib.rb",
+    "lib/taglib/aiff.rb",
     "lib/taglib/base.rb",
     "lib/taglib/flac.rb",
     "lib/taglib/id3v1.rb",
@@ -100,17 +118,23 @@ DESC
     "lib/taglib/ogg.rb",
     "lib/taglib/version.rb",
     "lib/taglib/vorbis.rb",
+    "lib/taglib/wav.rb",
     "taglib-ruby.gemspec",
     "tasks/docs_coverage.rake",
     "tasks/ext.rake",
     "tasks/gemspec_check.rake",
     "tasks/swig.rake",
+    "test/aiff_examples_test.rb",
+    "test/aiff_file_test.rb",
+    "test/aiff_file_write_test.rb",
     "test/base_test.rb",
     "test/data/Makefile",
     "test/data/add-relative-volume.cpp",
+    "test/data/aiff-sample.aiff",
     "test/data/crash.mp3",
     "test/data/flac-create.cpp",
     "test/data/flac.flac",
+    "test/data/flac_nopic.flac",
     "test/data/get_picture_data.cpp",
     "test/data/globe_east_540.jpg",
     "test/data/globe_east_90.jpg",
@@ -123,12 +147,18 @@ DESC
     "test/data/unicode.mp3",
     "test/data/vorbis-create.cpp",
     "test/data/vorbis.oga",
-    "test/helper.rb",
+    "test/data/wav-create.cpp",
+    "test/data/wav-dump.cpp",
+    "test/data/wav-sample.wav",
+    "test/file_test.rb",
     "test/fileref_open_test.rb",
     "test/fileref_properties_test.rb",
     "test/fileref_write_test.rb",
     "test/flac_file_test.rb",
     "test/flac_file_write_test.rb",
+    "test/flac_picture_memory_test.rb",
+    "test/helper.rb",
+    "test/id3v1_genres_test.rb",
     "test/id3v1_tag_test.rb",
     "test/id3v2_frames_test.rb",
     "test/id3v2_header_test.rb",
@@ -136,6 +166,7 @@ DESC
     "test/id3v2_relative_volume_test.rb",
     "test/id3v2_tag_test.rb",
     "test/id3v2_unicode_test.rb",
+    "test/id3v2_unknown_frames_test.rb",
     "test/id3v2_write_test.rb",
     "test/mp4_file_test.rb",
     "test/mp4_file_write_test.rb",
@@ -145,5 +176,8 @@ DESC
     "test/unicode_filename_test.rb",
     "test/vorbis_file_test.rb",
     "test/vorbis_tag_test.rb",
+    "test/wav_examples_test.rb",
+    "test/wav_file_test.rb",
+    "test/wav_file_write_test.rb"
   ]
 end

data/tasks/ext.rake

@@ -1,23 +1,32 @@
 # Extension tasks and cross-compiling
 
 host = 'i686-w64-mingw32'
-plat = 'x86-mingw32'
+$plat = ENV['PLATFORM'] || 'i386-mingw32'
 
-tmp = "#{Dir.pwd}/tmp/#{plat}"
+
+taglib_version = ENV['TAGLIB_VERSION'] || '1.9.1'
+taglib = "taglib-#{taglib_version}"
+
+tmp = "#{Dir.pwd}/tmp"
+tmp_arch = "#{tmp}/#{$plat}"
 toolchain_file = "#{Dir.pwd}/ext/win.cmake"
-install_dir = "#{tmp}/install"
+install_dir = "#{tmp_arch}/#{taglib}"
 install_dll = "#{install_dir}/bin/libtag.dll"
-ldflags = "-static-libgcc -static-libstdc++"
-$cross_config_options = [%(--with-opt-dir=#{install_dir} --with-ldflags="#{ldflags}")]
+install_so = "#{install_dir}/lib/libtag.so"
+$cross_config_options = ["--with-opt-dir=#{install_dir}"]
 
-taglib_version = '1.8'
-taglib = "taglib-#{taglib_version}"
-taglib_url = "http://cloud.github.com/downloads/taglib/taglib/#{taglib}.tar.gz"
-# WITH_MP4, WITH_ASF only needed with taglib 1.7, will be default in 1.8
-taglib_options = "-DCMAKE_BUILD_TYPE=Release -DWITH_MP4=ON -DWITH_ASF=ON"
+taglib_url = "https://github.com/taglib/taglib/archive/v#{taglib_version}.tar.gz"
+taglib_options = [ "-DCMAKE_BUILD_TYPE=Release",
+                   "-DBUILD_EXAMPLES=OFF",
+                   "-DBUILD_TESTS=OFF",
+                   "-DBUILD_BINDINGS=OFF", # 1.11 builds bindings by default
+                   "-DBUILD_SHARED_LIBS=ON", # 1.11 builds static by default
+                   "-DWITH_MP4=ON",# WITH_MP4, WITH_ASF only needed with taglib 1.7, will be default in 1.8
+                   "-DWITH_ASF=ON"].join(' ')
 
 def configure_cross_compile(ext)
   ext.cross_compile = true
+  ext.cross_platform = $plat
   ext.cross_config_options.concat($cross_config_options)
   ext.cross_compiling do |gem|
     gem.files << "lib/libtag.dll"
@@ -43,30 +52,52 @@ end
 Rake::ExtensionTask.new("taglib_vorbis", $gemspec) do |ext|
   configure_cross_compile(ext)
 end
+Rake::ExtensionTask.new("taglib_flac_picture", $gemspec) do |ext|
+  configure_cross_compile(ext)
+end
 Rake::ExtensionTask.new("taglib_flac", $gemspec) do |ext|
   configure_cross_compile(ext)
 end
 Rake::ExtensionTask.new("taglib_mp4", $gemspec) do |ext|
   configure_cross_compile(ext)
 end
+Rake::ExtensionTask.new("taglib_aiff", $gemspec) do |ext|
+  configure_cross_compile(ext)
+end
+Rake::ExtensionTask.new("taglib_wav", $gemspec) do |ext|
+  configure_cross_compile(ext)
+end
 
-task :cross => [:taglib] do
+task :cross 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++"
-  install install_dll, "lib/"
 end
 
-task :taglib => [install_dll]
+file "#{tmp_arch}/stage/lib/libtag.dll" => [install_dll] do |f|
+  install install_dll, f
+end
 
 file install_dll => ["#{tmp}/#{taglib}"] do
   chdir "#{tmp}/#{taglib}" do
-    sh %(cmake -DCMAKE_INSTALL_PREFIX=#{install_dir} -DCMAKE_TOOLCHAIN_FILE=#{toolchain_file} -DCMAKE_SHARED_LINKER_FLAGS="#{ldflags}" #{taglib_options})
+    sh %(cmake -DCMAKE_INSTALL_PREFIX=#{install_dir} -DCMAKE_TOOLCHAIN_FILE=#{toolchain_file} #{taglib_options})
     sh "make VERBOSE=1"
     sh "make install"
   end
 end
 
+task :vendor => [install_so]
+
+file install_so => ["#{tmp_arch}/#{taglib}", "#{tmp_arch}/#{taglib}-build", "#{tmp}/#{taglib}"] do
+  chdir "#{tmp_arch}/#{taglib}-build" do
+    sh %(cmake -DCMAKE_INSTALL_PREFIX=#{install_dir} #{taglib_options} #{tmp}/#{taglib})
+    sh "make install VERBOSE=1"
+  end
+end
+
+directory "#{tmp_arch}/#{taglib}"
+directory "#{tmp_arch}/#{taglib}-build"
+
 file "#{tmp}/#{taglib}" => ["#{tmp}/#{taglib}.tar.gz"] do
   chdir tmp do
     sh "tar xzf #{taglib}.tar.gz"
@@ -76,12 +107,9 @@ end
 file "#{tmp}/#{taglib}.tar.gz" => [tmp] do |t|
   require 'open-uri'
   puts "Downloading #{taglib_url}"
-  data = open(taglib_url).read()
-  break if data == nil
-  chdir tmp do
-    open(File.basename(t.name), 'wb') do |f|
-      f.write(data)
-    end
+
+  File.open(t.name, 'wb') do |f|
+    IO.copy_stream(open(taglib_url), f)
   end
 end
 

data/tasks/gemspec_check.rake

@@ -1,6 +1,6 @@
 desc "Checks file list in .gemspec against files tracked in Git"
 task :gemspec_check do |t|
-  exclude = ['.gitignore', '.travis.yml']
+  exclude = ['.gitignore', '.github/workflows/ci.yml']
   git_files = `git ls-files`.split("\n") - exclude
   gemspec_files = $gemspec.files
 

data/tasks/swig.rake

@@ -1,11 +1,30 @@
 # Tasks for generating SWIG wrappers in ext
 
+# Execute SWIG for the specified extension.
+# Arguments:
+# mod:: The name of the SWIG wrapper to process.
+#
+# If the TAGLIB_DIR environment variable points to a directory,
+# $TAGLIB_DIR/include will be searched first for taglib headers.
 def run_swig(mod)
   swig = `which swig`.chomp
   if swig.empty?
     swig = `which swig2.0`.chomp
   end
-  sh "cd ext/#{mod} && #{swig} -c++ -ruby -autorename -initname #{mod} -I/usr/local/include -I/usr/include #{mod}.i"
+
+  # Standard search location for headers
+  include_args = %w{-I/usr/local/include -I/usr/include}
+
+  if ENV.has_key?('TAGLIB_DIR')
+    unless File.directory?(ENV['TAGLIB_DIR'])
+      abort "When defined, the TAGLIB_DIR environment variable must point to a valid directory."
+    end
+
+    # Push it in front to get it searched first.
+    include_args.unshift('-I' + ENV['TAGLIB_DIR'] + '/include')
+  end
+
+  sh "cd ext/#{mod} && #{swig} -c++ -ruby -autorename -initname #{mod} #{include_args.join(' ')} #{mod}.i"
 end
 
 task :swig =>
@@ -15,8 +34,11 @@ task :swig =>
    'ext/taglib_id3v2/taglib_id3v2_wrap.cxx',
    'ext/taglib_ogg/taglib_ogg_wrap.cxx',
    'ext/taglib_vorbis/taglib_vorbis_wrap.cxx',
+   'ext/taglib_flac/taglib_flac_picture_wrap.cxx',
    'ext/taglib_flac/taglib_flac_wrap.cxx',
    'ext/taglib_mp4/taglib_mp4_wrap.cxx',
+   'ext/taglib_aiff/taglib_aiff_wrap.cxx',
+   'ext/taglib_wav/taglib_wav_wrap.cxx',
   ]
 
 base_dependencies = ['ext/taglib_base/taglib_base.i', 'ext/taglib_base/includes.i']
@@ -45,10 +67,22 @@ file 'ext/taglib_vorbis/taglib_vorbis_wrap.cxx' => ['ext/taglib_vorbis/taglib_vo
   run_swig('taglib_vorbis')
 end
 
-file 'ext/taglib_flac/taglib_flac_wrap.cxx' => ['ext/taglib_flac/taglib_flac.i'] + base_dependencies do
+file 'ext/taglib_flac/taglib_flac_picture_wrap.cxx' => ['ext/taglib_flac_picture/taglib_flac_picture.i'] + base_dependencies do
+  run_swig('taglib_flac_picture')
+end
+
+file 'ext/taglib_flac/taglib_flac_wrap.cxx' => ['ext/taglib_flac/taglib_flac.i', 'ext/taglib_flac_picture/taglib_flac_picture.i'] + base_dependencies do
   run_swig('taglib_flac')
 end
 
 file 'ext/taglib_mp4/taglib_mp4_wrap.cxx' => ['ext/taglib_mp4/taglib_mp4.i'] + base_dependencies do
   run_swig('taglib_mp4')
 end
+
+file 'ext/taglib_aiff/taglib_aiff_wrap.cxx' => ['ext/taglib_aiff/taglib_aiff.i'] + base_dependencies do
+  run_swig('taglib_aiff')
+end
+
+file 'ext/taglib_wav/taglib_wav_wrap.cxx' => ['ext/taglib_wav/taglib_wav.i'] + base_dependencies do
+  run_swig('taglib_wav')
+end

data/test/aiff_examples_test.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class AIFFExamples < Test::Unit::TestCase
+
+  DATA_FILE_PREFIX = "test/data/aiff-"
+
+  context "TagLib::RIFF::AIFF::File" do
+
+    should "Run TagLib::RIFF::AIFF::File examples" do
+
+
+      # @example Reading the title
+      title = TagLib::RIFF::AIFF::File.open("#{DATA_FILE_PREFIX}sample.aiff") do |file|
+        file.tag.title
+      end
+
+      # @example Reading AIFF-specific audio properties
+      TagLib::RIFF::AIFF::File.open("#{DATA_FILE_PREFIX}sample.aiff") do |file|
+        file.audio_properties.bits_per_sample  #=>  16
+      end
+
+      # @example Saving ID3v2 cover-art to disk
+      TagLib::RIFF::AIFF::File.open("#{DATA_FILE_PREFIX}sample.aiff") do |file|
+        id3v2_tag = file.tag
+        cover = id3v2_tag.frame_list('APIC').first
+        ext = cover.mime_type.rpartition('/')[2]
+        File.open("#{DATA_FILE_PREFIX}cover-art.#{ext}", "wb") { |f| f.write cover.picture }
+      end
+
+
+      # checks
+      assert_equal "AIFF Dummy Track Title - ID3v2.4", title
+      assert_equal true, File.exist?("#{DATA_FILE_PREFIX}cover-art.jpeg")
+      FileUtils.rm("#{DATA_FILE_PREFIX}cover-art.jpeg")
+    end
+
+  end
+
+end

data/test/aiff_file_test.rb

@@ -0,0 +1,103 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class AIFFFileTest < Test::Unit::TestCase
+
+  SAMPLE_FILE = "test/data/aiff-sample.aiff"
+  PICTURE_FILE = "test/data/globe_east_540.jpg"
+
+  context "TagLib::RIFF::AIFF::File" do
+    setup do
+      @file = TagLib::RIFF::AIFF::File.new(SAMPLE_FILE)
+      @tag = @file.tag
+      File.open(PICTURE_FILE, "rb") do |f|
+        @picture_data = f.read
+      end
+    end
+
+    should "have an ID3v2 tag" do
+      assert @file.id3v2_tag?
+      refute_nil @tag
+      assert_equal TagLib::ID3v2::Tag, @tag.class
+    end
+
+    should "contain basic tag information" do
+      assert_equal "AIFF Dummy Track Title - ID3v2.4", @tag.title
+      assert_equal "AIFF Dummy Artist Name", @tag.artist
+      assert_equal "AIFF Dummy Album Title", @tag.album
+      assert_equal "AIFF Dummy Comment", @tag.comment
+      assert_equal "Jazz", @tag.genre
+      assert_equal 2014, @tag.year
+      assert_equal 3, @tag.track
+      assert_equal false, @tag.empty?
+    end
+
+    context "APIC frame" do
+      setup do
+        @apic = @tag.frame_list('APIC').first
+      end
+
+      should "exist" do
+        assert_not_nil @apic
+        assert_equal TagLib::ID3v2::AttachedPictureFrame, @apic.class
+      end
+
+      should "have a type" do
+        assert_equal TagLib::ID3v2::AttachedPictureFrame::FrontCover, @apic.type
+      end
+
+      should "have a mime type" do
+        assert_equal "image/jpeg", @apic.mime_type
+      end
+
+      should "have picture bytes" do
+        assert_equal 61649, @apic.picture.size
+        assert_equal @picture_data, @apic.picture
+      end
+    end
+
+    context "audio properties" do
+      setup do
+        @properties = @file.audio_properties
+      end
+
+      should "exist" do
+        assert_not_nil @properties
+      end
+
+      should "contain basic information" do
+        assert_equal 2, @properties.length_in_seconds
+        assert_equal 2937, @properties.length_in_milliseconds
+        assert_equal 256, @properties.bitrate
+        assert_equal 8000, @properties.sample_rate
+        assert_equal 2, @properties.channels
+      end
+
+      should "contain AIFF-specific information" do
+        assert_equal 16, @properties.bits_per_sample
+        assert_equal 23493, @properties.sample_frames
+      end
+
+      should "do not contain AIFF-C information" do
+        refute @properties.aiff_c?
+        assert_equal "", @properties.compression_type
+        assert_equal "", @properties.compression_name
+      end
+    end
+
+    teardown do
+      @file.close
+      @file = nil
+    end
+  end
+
+  context "TagLib::RIFF::AIFF::File.open" do
+    should "have open method" do
+      title = nil
+      TagLib::RIFF::AIFF::File.open(SAMPLE_FILE, false) do |file|
+        title = file.tag.title
+      end
+      assert_equal "AIFF Dummy Track Title - ID3v2.4", title
+    end
+  end
+
+end