taglib-ruby 0.4.0-x86-mingw32

data/tasks/gemspec_check.rake

@@ -0,0 +1,19 @@
+desc "Checks file list in .gemspec against files tracked in Git"
+task :gemspec_check do |t|
+  exclude = ['.gitignore', '.travis.yml']
+  git_files = `git ls-files`.split("\n") - exclude
+  gemspec_files = $gemspec.files
+
+  only_in_gemspec = gemspec_files - git_files
+  only_in_git = git_files - gemspec_files
+
+  unless only_in_gemspec.empty?
+    puts "In gemspec but not in git:"
+    puts only_in_gemspec
+  end
+
+  unless only_in_git.empty?
+    puts "In git but not in gemspec:"
+    puts only_in_git
+  end
+end

data/tasks/swig.rake

@@ -0,0 +1,43 @@
+# Tasks for generating SWIG wrappers in ext
+
+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/include #{mod}.i"
+end
+
+task :swig =>
+  ['ext/taglib_base/taglib_base_wrap.cxx',
+   'ext/taglib_mpeg/taglib_mpeg_wrap.cxx',
+   'ext/taglib_id3v1/taglib_id3v1_wrap.cxx',
+   'ext/taglib_id3v2/taglib_id3v2_wrap.cxx',
+   'ext/taglib_ogg/taglib_ogg_wrap.cxx',
+   'ext/taglib_vorbis/taglib_vorbis_wrap.cxx']
+
+base_dependencies = ['ext/taglib_base/taglib_base.i', 'ext/taglib_base/includes.i']
+
+file 'ext/taglib_base/taglib_base_wrap.cxx' => base_dependencies do
+  run_swig('taglib_base')
+end
+
+file 'ext/taglib_mpeg/taglib_mpeg_wrap.cxx' => ['ext/taglib_mpeg/taglib_mpeg.i'] + base_dependencies do
+  run_swig('taglib_mpeg')
+end
+
+file 'ext/taglib_id3v1/taglib_id3v1_wrap.cxx' => ['ext/taglib_id3v1/taglib_id3v1.i'] + base_dependencies do
+  run_swig('taglib_id3v1')
+end
+
+file 'ext/taglib_id3v2/taglib_id3v2_wrap.cxx' => ['ext/taglib_id3v2/taglib_id3v2.i'] + base_dependencies do
+  run_swig('taglib_id3v2')
+end
+
+file 'ext/taglib_ogg/taglib_ogg_wrap.cxx' => ['ext/taglib_ogg/taglib_ogg.i'] + base_dependencies do
+  run_swig('taglib_ogg')
+end
+
+file 'ext/taglib_vorbis/taglib_vorbis_wrap.cxx' => ['ext/taglib_vorbis/taglib_vorbis.i'] + base_dependencies do
+  run_swig('taglib_vorbis')
+end

data/test/data/Makefile

@@ -0,0 +1,15 @@
+.PHONY: all clean
+
+all:: add-relative-volume id3v1-create vorbis-create
+
+add-relative-volume: add-relative-volume.cpp
+	g++ -o $@ $< -ltag -I/usr/include/taglib
+
+id3v1-create: id3v1-create.cpp
+	g++ -o $@ $< -ltag -I/usr/include/taglib
+
+vorbis-create: vorbis-create.cpp
+	g++ -o $@ $< -ltag -I/usr/include/taglib
+
+clean::
+	-rm add-relative-volume id3v1-create

data/test/data/add-relative-volume.cpp

@@ -0,0 +1,40 @@
+#include <iostream>
+#include <stdlib.h>
+
+#include <taglib/taglib.h>
+#include <taglib/mpegfile.h>
+#include <taglib/id3v2tag.h>
+#include <taglib/relativevolumeframe.h>
+
+using namespace TagLib;
+
+int main(int argc, char **argv) {
+  if (argc != 2) {
+    std::cout << "usage: " << argv[0] << " file.mp3" << std::endl;
+    exit(1);
+  }
+  char *filename = argv[1];
+
+  MPEG::File file(filename);
+  ID3v2::Tag *tag = file.ID3v2Tag(true);
+
+  ID3v2::RelativeVolumeFrame *rv = new ID3v2::RelativeVolumeFrame();
+
+  rv->setVolumeAdjustmentIndex(512);
+  rv->setVolumeAdjustmentIndex(1024, ID3v2::RelativeVolumeFrame::Subwoofer);
+
+  ID3v2::RelativeVolumeFrame::PeakVolume pv1;
+  pv1.bitsRepresentingPeak = 8;
+  pv1.peakVolume = "A"; // 0x41, 0b01000001
+  rv->setPeakVolume(pv1);
+
+  ID3v2::RelativeVolumeFrame::PeakVolume pv2;
+  pv2.bitsRepresentingPeak = 4;
+  pv2.peakVolume = "?"; // 0x3F, 0b00111111
+  rv->setPeakVolume(pv2, ID3v2::RelativeVolumeFrame::Subwoofer);
+
+  tag->addFrame(rv);
+  file.save();
+}
+
+// vim: set filetype=cpp sw=2 ts=2 expandtab:

data/test/data/id3v1-create.cpp

@@ -0,0 +1,31 @@
+#include <iostream>
+#include <stdlib.h>
+
+#include <taglib/taglib.h>
+#include <taglib/mpegfile.h>
+#include <taglib/id3v1tag.h>
+
+using namespace TagLib;
+
+int main(int argc, char **argv) {
+  if (argc != 2) {
+    std::cout << "usage: " << argv[0] << " file.mp3" << std::endl;
+    exit(1);
+  }
+  char *filename = argv[1];
+
+  MPEG::File file(filename);
+  ID3v1::Tag *tag = file.ID3v1Tag(true);
+
+  tag->setTitle("Title");
+  tag->setArtist("Artist");
+  tag->setAlbum("Album");
+  tag->setComment("Comment");
+  tag->setGenre("Pop");
+  tag->setYear(2011);
+  tag->setTrack(7);
+
+  file.save(MPEG::File::ID3v1);
+}
+
+// vim: set filetype=cpp sw=2 ts=2 expandtab:

data/test/data/vorbis-create.cpp

@@ -0,0 +1,42 @@
+#include <iostream>
+#include <stdlib.h>
+
+#include <taglib/taglib.h>
+#include <taglib/vorbisfile.h>
+
+using namespace TagLib;
+
+int main(int argc, char **argv) {
+  if (argc != 2) {
+    std::cout << "usage: " << argv[0] << " file.mp3" << std::endl;
+    exit(1);
+  }
+  char *filename = argv[1];
+
+  Vorbis::File file(filename);
+  Ogg::XiphComment *tag = file.tag();
+
+  tag->setTitle("Title");
+  tag->setArtist("Artist");
+  tag->setAlbum("Album");
+  tag->setComment("Comment");
+  tag->setGenre("Pop");
+  tag->setYear(2011);
+  tag->setTrack(7);
+
+  tag->addField("VERSION", "original");
+  tag->addField("PERFORMER", "Performer");
+  tag->addField("COPYRIGHT", "2011 Me, myself and I");
+  tag->addField("LICENSE", "Any Use Permitted");
+  tag->addField("ORGANIZATION", "Organization");
+  tag->addField("DESCRIPTION", "Test file");
+  tag->addField("LOCATION", "Earth");
+  tag->addField("CONTACT", "Contact");
+
+  tag->addField("MULTIPLE", "A");
+  tag->addField("MULTIPLE", "B", false);
+
+  file.save();
+}
+
+// vim: set filetype=cpp sw=2 ts=2 expandtab:

data/test/fileref_open_test.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class FileRefOpenTest < Test::Unit::TestCase
+  context "TagLib::FileRef.open" do
+    should "return result" do
+      title = TagLib::FileRef.open("test/data/vorbis.oga", false) do |file|
+        tag = file.tag
+        assert_not_nil tag
+        tag.title
+      end
+      assert_equal "Title", title
+    end
+
+    should "close even with exception" do
+      f = nil
+      begin
+        TagLib::FileRef.open("test/data/vorbis.oga", false) do |file|
+          f = file
+          raise NotImplementedError
+        end
+        flunk("Should have raised NotImplementedError.")
+      rescue NotImplementedError
+        begin
+          f.tag
+          flunk("Should have raised ObjectPreviouslyDeleted.")
+        rescue => e
+          assert_equal "ObjectPreviouslyDeleted", e.class.to_s
+        end
+      end
+    end
+  end
+end

data/test/fileref_properties_test.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestFileRefProperties < Test::Unit::TestCase
+  context "The crash.mp3 file audio properties" do
+    setup do
+      @fileref = TagLib::FileRef.new("test/data/crash.mp3", true, TagLib::AudioProperties::Average)
+      @properties = @fileref.audio_properties
+    end
+
+    should "exist" do
+      assert_not_nil @properties
+    end
+
+    should "contain basic information" do
+      assert_equal 2, @properties.length
+      assert_equal 157, @properties.bitrate
+      assert_equal 44100, @properties.sample_rate
+      assert_equal 2, @properties.channels
+    end
+  end
+end

data/test/fileref_write_test.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+require 'fileutils'
+
+class TestFileRefWrite < Test::Unit::TestCase
+
+  SAMPLE_FILE = "test/data/sample.mp3"
+  OUTPUT_FILE = "test/data/output.mp3"
+
+  context "TagLib::FileRef" do
+    setup do
+      FileUtils.cp SAMPLE_FILE, OUTPUT_FILE
+      @file = TagLib::MPEG::File.new(OUTPUT_FILE, false)
+    end
+
+    should "be able to save the title" do
+      tag = @file.tag
+      assert_not_nil tag
+      tag.title = "New Title"
+      success = @file.save
+      assert success
+      @file.close
+      @file = nil
+
+      written_file = TagLib::MPEG::File.new(OUTPUT_FILE, false)
+      assert_equal "New Title", written_file.tag.title
+      written_file.close
+    end
+
+    teardown do
+      if @file
+        @file.close
+        @file = nil
+      end
+      FileUtils.rm OUTPUT_FILE
+    end
+  end
+
+  context "TagLib::FileRef.open" do
+    setup do
+      FileUtils.cp SAMPLE_FILE, OUTPUT_FILE
+    end
+
+    should "be able to save file" do
+      TagLib::MPEG::File.open(OUTPUT_FILE, false) do |file|
+        tag = file.tag
+        tag.title = "New Title"
+        file.save
+      end
+
+      title = TagLib::MPEG::File.open(OUTPUT_FILE, false) do |file|
+        tag = file.tag
+        tag.title
+      end
+      assert_equal "New Title", title
+    end
+
+    teardown do
+      FileUtils.rm OUTPUT_FILE
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda-context'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'taglib'
+
+HAVE_ENCODING = !RUBY_VERSION.start_with?("1.8")

data/test/id3v1_tag_test.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestID3v1Tag < Test::Unit::TestCase
+  context "The id3v1.mp3 file" do
+    setup do
+      read_properties = false
+      @file = TagLib::MPEG::File.new("test/data/id3v1.mp3", read_properties)
+    end
+
+    should "have an ID3v1 tag" do
+      assert_not_nil @file.id3v1_tag
+    end
+
+    context "ID3v1 tag" do
+      setup do
+        @tag = @file.id3v1_tag
+      end
+
+      should "have basic properties" do
+        assert_equal 'Title', @tag.title
+        assert_equal 'Artist', @tag.artist
+        assert_equal 'Album', @tag.album
+        assert_equal 'Comment', @tag.comment
+        assert_equal 'Pop', @tag.genre
+        assert_equal 2011, @tag.year
+        assert_equal 7, @tag.track
+        assert_equal false, @tag.empty?
+      end
+    end
+
+    teardown do
+      @file.close
+      @file = nil
+    end
+  end
+end

data/test/id3v2_frames_test.rb

@@ -0,0 +1,115 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestID3v2Frames < Test::Unit::TestCase
+  context "The sample.mp3 file's frames" do
+    setup do
+      read_properties = false
+      # It's important that file is an instance variable, otherwise the
+      # tag would get garbage collected along with the file, even if tag
+      # itself would still be reachable. The reason is because
+      # TagLib::MPEG::File owns the TagLib::ID3v2::Tag and automatically
+      # deletes it in its destructor.
+      @file = TagLib::MPEG::File.new("test/data/sample.mp3", read_properties)
+      picture_file = File.open("test/data/globe_east_540.jpg", "rb") do |f|
+        @picture_data = f.read
+      end
+      @tag = @file.id3v2_tag
+      @frames = @tag.frame_list
+    end
+
+    should "be complete" do
+      assert_not_nil @frames
+      assert_equal 11, @frames.size
+      frame = @frames.first
+      assert_equal "Dummy Title", frame.to_string
+    end
+
+    should "be enumerable" do
+      ids = @frames.collect{ |frame| frame.frame_id }
+      assert_equal ["TIT2", "TPE1", "TALB", "TRCK", "TDRC",
+                    "COMM", "COMM", "TCON", "TXXX", "COMM", "APIC"], ids
+    end
+
+    should "be automatically converted" do
+      apic = @tag.frame_list('APIC').first
+      comm = @tag.frame_list('COMM').first
+      tit2 = @tag.frame_list('TIT2').first
+      txxx = @tag.frame_list('TXXX').first
+      assert_equal TagLib::ID3v2::AttachedPictureFrame, apic.class
+      assert_equal TagLib::ID3v2::CommentsFrame, comm.class
+      assert_equal TagLib::ID3v2::TextIdentificationFrame, tit2.class
+      assert_equal TagLib::ID3v2::UserTextIdentificationFrame, txxx.class
+    end
+
+    should "be removable" do
+      assert_equal 11, @tag.frame_list.size
+      tit2 = @tag.frame_list('TIT2').first
+      @tag.remove_frame(tit2)
+      assert_equal 10, @tag.frame_list.size
+      begin
+        tit2.to_string
+        flunk("Should have raised ObjectPreviouslyDeleted.")
+      rescue => e
+        assert_equal "ObjectPreviouslyDeleted", e.class.to_s
+      end
+    end
+
+    should "be removable by ID" do
+      frames = @tag.frame_list
+      @tag.remove_frames('COMM')
+      tit2 = frames.find{ |f| f.frame_id == 'TIT2' }
+      # Other frames should still be accessible
+      assert_equal "Dummy Title", tit2.to_s
+    end
+
+    context "APIC frame" do
+      setup do
+        @apic = @tag.frame_list('APIC').first
+      end
+
+      should "have a type" do
+        assert_equal TagLib::ID3v2::AttachedPictureFrame::FrontCover, @apic.type
+      end
+
+      should "have a description" do
+        assert_equal "Blue Marble", @apic.description
+      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
+        if HAVE_ENCODING
+          assert_equal @picture_data.encoding, @apic.picture.encoding
+        end
+        assert_equal @picture_data, @apic.picture
+      end
+    end
+
+    context "TXXX frame" do
+      setup do
+        @txxx_frame = @tag.frame_list('TXXX').first
+      end
+
+      should "exist" do
+        assert_not_nil @txxx_frame
+      end
+
+      should "have to_s" do
+        expected = "[MusicBrainz Album Id] MusicBrainz Album Id 992dc19a-5631-40f5-b252-fbfedbc328a9"
+        assert_equal expected, @txxx_frame.to_string
+      end
+
+      should "have field_list" do
+        assert_equal ["MusicBrainz Album Id", "992dc19a-5631-40f5-b252-fbfedbc328a9"], @txxx_frame.field_list
+      end
+    end
+
+    teardown do
+      @file.close
+      @file = nil
+    end
+  end
+end