taglib-ruby 0.7.1 → 1.0.0

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,8 +1,8 @@
 module TagLib
   module Version
-    MAJOR = 0
-    MINOR = 7
-    PATCH = 1
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/taglib/wav.rb

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

data/taglib-ruby.gemspec

@@ -23,10 +23,10 @@ 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 '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 'yard', '~> 0.9.12'
   s.add_development_dependency 'kramdown', '~> 1.0'
   s.add_development_dependency 'test-unit', '~> 3.1'
 
@@ -38,6 +38,7 @@ 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",
@@ -78,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",
@@ -119,10 +124,13 @@ DESC
     "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/aiff-sample.aiff",
     "test/data/add-relative-volume.cpp",
+    "test/data/aiff-sample.aiff",
     "test/data/crash.mp3",
     "test/data/flac-create.cpp",
     "test/data/flac.flac",
@@ -141,16 +149,14 @@ DESC
     "test/data/wav-create.cpp",
     "test/data/wav-dump.cpp",
     "test/data/wav-sample.wav",
-    "test/aiff_examples_test.rb",
-    "test/aiff_file_test.rb",
-    "test/aiff_file_write_test.rb",
-    "test/helper.rb",
+    "test/file_test.rb",
     "test/fileref_open_test.rb",
     "test/fileref_properties_test.rb",
     "test/fileref_write_test.rb",
-    "test/file_test.rb",
     "test/flac_file_test.rb",
     "test/flac_file_write_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",
@@ -170,6 +176,6 @@ DESC
     "test/vorbis_tag_test.rb",
     "test/wav_examples_test.rb",
     "test/wav_file_test.rb",
-    "test/wav_file_write_test.rb",
+    "test/wav_file_write_test.rb"
   ]
 end

data/tasks/ext.rake

@@ -1,19 +1,28 @@
 # Extension tasks and cross-compiling
 
 host = 'i686-w64-mingw32'
-$plat = 'i386-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"
+install_so = "#{install_dir}/lib/libtag.so"
 $cross_config_options = ["--with-opt-dir=#{install_dir}"]
 
-taglib_version = '1.9.1'
-taglib = "taglib-#{taglib_version}"
-taglib_url = "https://github.com/taglib/taglib/releases/download/v#{taglib_version}/#{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
@@ -43,6 +52,9 @@ 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
@@ -62,7 +74,7 @@ task :cross do
   ENV["CXX"] = "#{host}-g++"
 end
 
-file "tmp/#{$plat}/stage/lib/libtag.dll" => [install_dll] do |f|
+file "#{tmp_arch}/stage/lib/libtag.dll" => [install_dll] do |f|
   install install_dll, f
 end
 
@@ -74,6 +86,18 @@ file install_dll => ["#{tmp}/#{taglib}"] do
   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"
@@ -83,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/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,6 +34,7 @@ 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',
@@ -47,7 +67,11 @@ 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
 

data/test/aiff_examples_test.rb

@@ -16,7 +16,7 @@ class AIFFExamples < Test::Unit::TestCase
 
       # @example Reading AIFF-specific audio properties
       TagLib::RIFF::AIFF::File.open("#{DATA_FILE_PREFIX}sample.aiff") do |file|
-        file.audio_properties.sample_width  #=>  16
+        file.audio_properties.bits_per_sample  #=>  16
       end
 
       # @example Saving ID3v2 cover-art to disk

data/test/aiff_file_test.rb

@@ -15,7 +15,8 @@ class AIFFFileTest < Test::Unit::TestCase
     end
 
     should "have an ID3v2 tag" do
-      assert_not_nil @tag
+      assert @file.id3v2_tag?
+      refute_nil @tag
       assert_equal TagLib::ID3v2::Tag, @tag.class
     end
 
@@ -64,14 +65,22 @@ class AIFFFileTest < Test::Unit::TestCase
       end
 
       should "contain basic information" do
-        assert_equal 2, @properties.length
+        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.sample_width
+        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
 

data/test/data/vorbis-create.cpp

@@ -4,11 +4,13 @@
 #include <taglib/taglib.h>
 #include <taglib/vorbisfile.h>
 
+#include "get_picture_data.cpp"
+
 using namespace TagLib;
 
 int main(int argc, char **argv) {
   if (argc != 2) {
-    std::cout << "usage: " << argv[0] << " file.mp3" << std::endl;
+    std::cout << "usage: " << argv[0] << " file.oga" << std::endl;
     exit(1);
   }
   char *filename = argv[1];
@@ -16,6 +18,9 @@ int main(int argc, char **argv) {
   Vorbis::File file(filename);
   Ogg::XiphComment *tag = file.tag();
 
+  tag->removeAllFields();
+  tag->removeAllPictures();
+
   tag->setTitle("Title");
   tag->setArtist("Artist");
   tag->setAlbum("Album");
@@ -36,6 +41,20 @@ int main(int argc, char **argv) {
   tag->addField("MULTIPLE", "A");
   tag->addField("MULTIPLE", "B", false);
 
+  ByteVector pictureData = getPictureData("globe_east_90.jpg");
+
+  FLAC::Picture picture;
+  picture.setType(FLAC::Picture::FrontCover);
+  picture.setMimeType("image/jpeg");
+  picture.setDescription("Globe");
+  picture.setWidth(90);
+  picture.setHeight(90);
+  picture.setColorDepth(24);
+  picture.setNumColors(0);
+  picture.setData(pictureData);
+
+  tag->addField("METADATA_BLOCK_PICTURE", picture.render().toBase64());
+
   file.save();
 }
 

data/test/fileref_properties_test.rb

@@ -12,7 +12,7 @@ class TestFileRefProperties < Test::Unit::TestCase
     end
 
     should "contain basic information" do
-      assert_equal 2, @properties.length
+      assert_equal 2, @properties.length_in_seconds
       assert_equal 157, @properties.bitrate
       assert_equal 44100, @properties.sample_rate
       assert_equal 2, @properties.channels

data/test/flac_file_test.rb

@@ -13,19 +13,27 @@ class FlacFileTest < Test::Unit::TestCase
     end
 
     should "have XiphComment" do
+      assert @file.xiph_comment?
       tag = @file.xiph_comment
       assert_not_nil tag
       assert_equal TagLib::Ogg::XiphComment, tag.class
     end
 
     should "have method for ID3v1 tag" do
+      refute @file.id3v1_tag?
       assert_nil @file.id3v1_tag
     end
 
     should "have method for ID3v2 tag" do
+      refute @file.id3v2_tag?
       assert_nil @file.id3v2_tag
     end
 
+    should "support stripping tags by type" do
+      @file.strip(TagLib::FLAC::File::XiphComment)
+      assert @file.xiph_comment?
+    end
+
     context "audio properties" do
       setup do
         @properties = @file.audio_properties
@@ -36,54 +44,61 @@ class FlacFileTest < Test::Unit::TestCase
       end
 
       should "contain basic information" do
-        assert_equal 1, @properties.length
-        assert_equal 212, @properties.bitrate
+        assert_equal 1, @properties.length_in_seconds
+        assert_equal 1017, @properties.length_in_milliseconds
+        assert_equal 209, @properties.bitrate
         assert_equal 44100, @properties.sample_rate
         assert_equal 1, @properties.channels
       end
 
       should "contain flac-specific information" do
-        assert_equal 16, @properties.sample_width
+        assert_equal 16, @properties.bits_per_sample
         s = ["78d19b86df2cd488b35957e6bd884968"].pack('H*')
         assert_equal s, @properties.signature
       end
     end
 
-    context "picture_list" do
+    should "have pictures" do
+      refute_empty @file.picture_list
+    end
+
+    context "first picture" do
       setup do
-        @pictures = @file.picture_list
+        @picture = @file.picture_list.first
+      end
+
+      should "be a TagLib::FLAC::Picture," do
+        assert_equal TagLib::FLAC::Picture, @picture.class
       end
 
-      should "have a picture" do
-        assert_equal 1, @pictures.size
+      should "have meta-data" do
+        assert_equal TagLib::FLAC::Picture::FrontCover, @picture.type
+        assert_equal "image/jpeg", @picture.mime_type
+        assert_equal "Globe", @picture.description
+        assert_equal 90, @picture.width
+        assert_equal 90, @picture.height
+        assert_equal 8, @picture.color_depth
+        assert_equal 0, @picture.num_colors
       end
 
-      context "first element" do
-        setup do
-          @picture = @pictures.first
-        end
-
-        should "be a TagLib::FLAC::Picture," do
-          assert_equal TagLib::FLAC::Picture, @picture.class
-        end
-
-        should "have meta-data" do
-          assert_equal TagLib::FLAC::Picture::FrontCover, @picture.type
-          assert_equal "image/jpeg", @picture.mime_type
-          assert_equal "Globe", @picture.description
-          assert_equal 90, @picture.width
-          assert_equal 90, @picture.height
-          assert_equal 8, @picture.color_depth
-          assert_equal 0, @picture.num_colors
-        end
-
-        should "have data" do
-          picture_data = File.open("test/data/globe_east_90.jpg", 'rb'){ |f| f.read }
-          assert_equal picture_data, @picture.data
-        end
+      should "have data" do
+        picture_data = File.open("test/data/globe_east_90.jpg", 'rb'){ |f| f.read }
+        assert_equal picture_data, @picture.data
       end
     end
 
+    should "support removing a picture" do
+      refute_empty @file.picture_list
+      @file.remove_picture(@file.picture_list.first)
+      assert_empty @file.picture_list
+    end
+
+    should "support removing all pictures" do
+      refute_empty @file.picture_list
+      @file.remove_pictures()
+      assert_empty @file.picture_list
+    end
+
     teardown do
       @file.close
       @file = nil