taglib-ruby 0.6.0 → 1.1.0

data/test/mpeg_file_test.rb

@@ -11,12 +11,7 @@ class TestMPEGFile < Test::Unit::TestCase
       tag = @file.tag
       assert_not_nil tag
       assert_equal TagLib::Tag, tag.class
-    end
-
-    should "have an ID3v2 tag" do
-      tag = @file.id3v2_tag(false)
-      assert_not_nil tag
-      assert_equal TagLib::ID3v2::Tag, tag.class
+      assert tag.empty?
     end
 
     context "audio properties" do
@@ -29,7 +24,8 @@ class TestMPEGFile < Test::Unit::TestCase
       end
 
       should "contain information" do
-        assert_equal 2, @properties.length
+        assert_equal 2, @properties.length_in_seconds
+        assert_equal 2299, @properties.length_in_milliseconds
         assert_equal 157, @properties.bitrate
         assert_equal 44100, @properties.sample_rate
         assert_equal 2, @properties.channels
@@ -54,10 +50,127 @@ class TestMPEGFile < Test::Unit::TestCase
           assert @xing_header.valid?
           assert_equal 88, @xing_header.total_frames
           assert_equal 45140, @xing_header.total_size
+          assert_equal TagLib::MPEG::XingHeader::Xing, @xing_header.type
         end
       end
     end
 
+    should "have no tag" do
+      refute @file.id3v1_tag?
+      refute @file.id3v2_tag?
+      refute @file.ape_tag?
+    end
+
+    teardown do
+      @file.close
+      @file = nil
+    end
+  end
+
+  context "The id3v1.mp3 file" do
+    setup do
+      read_properties = true
+      @file = TagLib::MPEG::File.new("test/data/id3v1.mp3", read_properties)
+    end
+
+    should "have a basic tag" do
+      tag = @file.tag
+      assert_not_nil tag
+      assert_equal TagLib::Tag, tag.class
+      refute tag.empty?
+    end
+
+    context "audio properties" do
+      setup do
+        @properties = @file.audio_properties
+      end
+
+      should "be MPEG audio properties" do
+        assert_equal TagLib::MPEG::Properties, @properties.class
+      end
+
+      should "contain information" do
+        assert_equal 0, @properties.length_in_seconds
+        assert_equal 261, @properties.length_in_milliseconds
+        assert_equal 141, @properties.bitrate
+        assert_equal 44100, @properties.sample_rate
+        assert_equal 2, @properties.channels
+        assert_equal TagLib::MPEG::Header::Version1, @properties.version
+        assert_equal 3, @properties.layer
+        assert_equal false, @properties.protection_enabled
+        assert_equal TagLib::MPEG::Header::JointStereo, @properties.channel_mode
+        assert_equal false, @properties.copyrighted?
+        assert_equal true, @properties.original?
+      end
+
+      context "Xing header" do
+        setup do
+          @xing_header = @properties.xing_header
+        end
+
+        should "exist" do
+          assert_not_nil @xing_header
+        end
+
+        should "contain information" do
+          assert @xing_header.valid?
+          assert_equal 10, @xing_header.total_frames
+          assert_equal 4596, @xing_header.total_size
+          assert_equal TagLib::MPEG::XingHeader::Xing, @xing_header.type
+        end
+      end
+    end
+
+    context "tag" do
+      setup do
+        @tag = @file.tag
+      end
+
+      should "exist" do
+        refute_nil @tag
+        assert_equal TagLib::Tag, @tag.class
+      end
+
+      should "have basic properties" do
+        refute @tag.empty?
+
+        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
+      end
+    end
+
+    context "ID3V1 tag" do
+      setup do
+        @tag = @file.id3v1_tag(false)
+      end
+
+      should "exist" do
+        assert @file.id3v1_tag?
+        refute @file.id3v2_tag?
+        refute @file.ape_tag?
+
+        assert_not_nil @tag
+        assert_equal TagLib::ID3v1::Tag, @tag.class
+      end
+
+      should "have basic properties" do
+        refute @tag.empty?
+
+        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
+      end
+    end
+
     teardown do
       @file.close
       @file = nil

data/test/vorbis_file_test.rb

@@ -22,8 +22,8 @@ class TestVorbisFile < Test::Unit::TestCase
       end
 
       should "contain basic information" do
-        assert_equal 0, @properties.length # file is short
-        assert_equal 64, @properties.bitrate
+        assert_equal 0, @properties.length_in_seconds # file is short
+        assert_equal 371, @properties.bitrate
         assert_equal 44100, @properties.sample_rate
         assert_equal 2, @properties.channels
       end

data/test/vorbis_tag_test.rb

@@ -11,6 +11,7 @@ class TestVorbisTag < Test::Unit::TestCase
       assert_equal "Title", @tag.title
       assert_equal "Artist", @tag.artist
       assert_equal "Album", @tag.album
+      # Use DESCRIPTION if it exists, otherwise COMMENT.
       assert_equal "Test file", @tag.comment
       assert_equal "Pop", @tag.genre
       assert_equal 2011, @tag.year
@@ -24,7 +25,7 @@ class TestVorbisTag < Test::Unit::TestCase
     end
 
     should "have field_count" do
-      assert_equal 16, @tag.field_count
+      assert_equal 18, @tag.field_count
     end
 
     should "have vendor_id" do
@@ -61,14 +62,58 @@ class TestVorbisTag < Test::Unit::TestCase
       assert_equal ["Title", "Additional Title"], @tag.field_list_map['TITLE']
     end
 
-    should "support remove_field with value" do
-      @tag.remove_field('MULTIPLE', "A")
-      assert_equal ["B"], @tag.field_list_map['MULTIPLE']
+    should "support remove_fields" do
+      assert @tag.contains?('MULTIPLE')
+      @tag.remove_fields('MULTIPLE')
+      refute @tag.contains?('MULTIPLE')
     end
 
-    should "support remove_field without value" do
-      @tag.remove_field('MULTIPLE')
-      assert !@tag.contains?('MULTIPLE')
+    should "support remove_all_fields" do
+      refute_equal 0, @tag.field_count
+      @tag.remove_all_fields()
+      # remove_all_fields() do not remove pictures
+      assert_equal 1, @tag.field_count
+    end
+
+    should "have pictures" do
+      refute_empty @tag.picture_list
+    end
+
+    context "first picture" do
+      setup do
+        @picture = @tag.picture_list.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 24, @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
+    end
+
+    should "support removing a picture" do
+      refute_empty @tag.picture_list
+      @tag.remove_picture(@tag.picture_list.first)
+      assert_empty @tag.picture_list
+    end
+
+    should "support removing all pictures" do
+      refute_empty @tag.picture_list
+      @tag.remove_all_pictures()
+      assert_empty @tag.picture_list
     end
 
     teardown do
@@ -76,4 +121,13 @@ class TestVorbisTag < Test::Unit::TestCase
       @file = nil
     end
   end
+
+  context "The XiphComment class" do
+    should "support check_key" do
+      refute TagLib::Ogg::XiphComment::check_key("")
+      refute TagLib::Ogg::XiphComment::check_key("something=")
+      refute TagLib::Ogg::XiphComment::check_key("something~")
+      assert TagLib::Ogg::XiphComment::check_key("something")
+    end
+  end
 end

data/test/wav_examples_test.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class WAVExamples < Test::Unit::TestCase
+
+  DATA_FILE_PREFIX = "test/data/wav-"
+
+  context "TagLib::RIFF::WAV::File" do
+
+    should "Run TagLib::RIFF::WAV::File examples" do
+
+
+      # Reading the title
+
+      title = TagLib::RIFF::WAV::File.open("#{DATA_FILE_PREFIX}sample.wav") do |file|
+        file.tag.title
+      end
+
+      # Reading WAV-specific audio properties
+
+      TagLib::RIFF::WAV::File.open("#{DATA_FILE_PREFIX}sample.wav") do |file|
+        file.audio_properties.sample_rate  #=>  8
+      end
+
+      # Saving ID3v2 cover-art to disk
+
+      TagLib::RIFF::WAV::File.open("#{DATA_FILE_PREFIX}sample.wav") 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 "WAV Dummy Track Title", 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/wav_file_test.rb

@@ -0,0 +1,108 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class WAVFileTest < Test::Unit::TestCase
+
+  SAMPLE_FILE = "test/data/wav-sample.wav"
+  PICTURE_FILE = "test/data/globe_east_540.jpg"
+
+  context "TagLib::RIFF::WAV::File" do
+    setup do
+      @file = TagLib::RIFF::WAV::File.new(SAMPLE_FILE)
+    end
+
+    should "open" do
+      assert_not_nil @file
+    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 0, @properties.length_in_seconds
+        assert_equal 698, @properties.length_in_milliseconds
+        assert_equal 88, @properties.bitrate
+        assert_equal 11025, @properties.sample_rate
+        assert_equal 1, @properties.channels
+      end
+
+      should "contain WAV-specific information" do
+        assert_equal 8, @properties.bits_per_sample
+        assert_equal TagLib::RIFF::WAV::FORMAT_PCM, @properties.format
+      end
+    end
+
+    context "ID3V2 tag" do
+      setup do
+        @tag = @file.tag
+      end
+
+      should "exist" do
+        assert @file.id3v2_tag?
+        assert_not_nil @tag
+        assert_equal TagLib::ID3v2::Tag, @tag.class
+      end
+
+      should "not have an Info tag" do
+        refute @file.info_tag?
+      end
+
+      should "contain basic tag information" do
+        assert_equal "WAV Dummy Track Title", @tag.title
+        assert_equal "WAV Dummy Artist Name", @tag.artist
+        assert_equal "WAV Dummy Album Title", @tag.album
+        assert_equal "WAV Dummy Comment", @tag.comment
+        assert_equal "Jazz", @tag.genre
+        assert_equal 2014, @tag.year
+        assert_equal 5, @tag.track
+        assert_equal false, @tag.empty?
+      end
+
+      context "APIC frame" do
+        setup do
+          @picture_data = File.open(PICTURE_FILE, 'rb') { |f| f.read }
+          @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
+    end
+
+    teardown do
+      @file.close
+      @file = nil
+    end
+  end
+
+  context "TagLib::RIFF::WAV::File.open" do
+    should "have open method" do
+      title = nil
+      TagLib::RIFF::WAV::File.open(SAMPLE_FILE, false) do |file|
+        title = file.tag.title
+      end
+      assert_equal "WAV Dummy Track Title", title
+    end
+  end
+
+end

data/test/wav_file_write_test.rb

@@ -0,0 +1,113 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class WAVFileWriteTest < Test::Unit::TestCase
+
+  SAMPLE_FILE = "test/data/wav-sample.wav"
+  OUTPUT_FILE = "test/data/_output.wav"
+  PICTURE_FILE = "test/data/globe_east_90.jpg"
+
+  def reloaded
+    TagLib::RIFF::WAV::File.open(OUTPUT_FILE, false) do |file|
+      yield file
+    end
+  end
+
+  context "TagLib::RIFF::WAV::File" do
+    setup do
+      FileUtils.cp SAMPLE_FILE, OUTPUT_FILE
+      @file = TagLib::RIFF::WAV::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_title = reloaded do |file|
+        file.tag.title
+      end
+      assert_equal "New Title", written_title
+    end
+
+    should "have one picture frame" do
+      assert_equal 2, @file.tag.frame_list('APIC').size
+    end
+
+    should "be able to remove all picture frames" do
+      @file.tag.remove_frames('APIC')
+      success = @file.save
+      assert success
+      @file.close
+      @file = nil
+
+      reloaded do |file|
+        assert_equal 0, file.tag.frame_list('APIC').size
+      end
+    end
+
+    should "be able to add a picture frame" do
+      picture_data = File.open(PICTURE_FILE, 'rb') { |f| f.read }
+
+      apic = TagLib::ID3v2::AttachedPictureFrame.new
+      apic.mime_type = "image/jpeg"
+      apic.description = "desc"
+      apic.text_encoding = TagLib::String::UTF8
+      apic.picture = picture_data
+      apic.type = TagLib::ID3v2::AttachedPictureFrame::BackCover
+
+      @file.tag.add_frame(apic)
+      success = @file.save
+      assert success
+      @file.close
+      @file = nil
+
+      reloaded do |file|
+        assert_equal 3, file.tag.frame_list('APIC').size
+      end
+
+      reloaded do |file|
+        written_apic = file.tag.frame_list("APIC")[2]
+        assert_equal "image/jpeg", written_apic.mime_type
+        assert_equal "desc", written_apic.description
+        assert_equal picture_data, written_apic.picture
+      end
+    end
+
+    teardown do
+      if @file
+        @file.close
+        @file = nil
+      end
+      FileUtils.rm OUTPUT_FILE
+    end
+  end
+
+  context "TagLib::RIFF::WAV::File.strip" do
+    setup do
+      FileUtils.cp SAMPLE_FILE, OUTPUT_FILE
+      @file = TagLib::RIFF::WAV::File.new(OUTPUT_FILE)
+    end
+
+    should "update the file immediately" do
+      assert @file.id3v2_tag?
+
+      @file.strip(TagLib::RIFF::WAV::File::ID3v2)
+
+      reloaded do |file|
+        refute @file.id3v2_tag?
+      end
+    end
+
+    teardown do
+      if @file
+        @file.close
+        @file = nil
+      end
+      FileUtils.rm OUTPUT_FILE
+    end
+  end
+end