mp3file 0.0.2

data/spec/mp3file/mp3_header_spec.rb

@@ -0,0 +1,336 @@
+require File.dirname(__FILE__) + '/../../lib/mp3file'
+require File.dirname(__FILE__) + '/../common_helpers'
+
+include CommonHelpers
+
+describe Mp3file::MP3Header do
+  it "raises an error if the first byte isn't 255" do
+    lambda { Mp3file::MP3Header.new(create_io([ 0xAA, 0xF8, 0x10, 0x01 ])) }.
+      should(raise_error(Mp3file::InvalidMP3HeaderError))
+  end
+
+  it "raises an error if the second sync byte is wrong" do
+    lambda { Mp3file::MP3Header.new(create_io([ 0xFF, 0xB8, 0x10, 0x01 ])) }.
+      should(raise_error(Mp3file::InvalidMP3HeaderError))
+  end
+
+  describe "#version" do
+    [ [ [ 0xFF, 0b1110_0010, 0x10, 0x01 ], 'MPEG 2.5' ],
+      [ [ 0xFF, 0b1111_0010, 0x10, 0x01 ], 'MPEG 2' ],
+      [ [ 0xFF, 0b1111_1010, 0x10, 0x01 ], 'MPEG 1' ],
+    ].each do |bytes, version|
+      it "recognizes #{version}" do
+        h = Mp3file::MP3Header.new(create_io(bytes))
+        h.version.should == version
+      end
+    end
+
+    it "raises an error on an invalid version" do
+      lambda { Mp3file::MP3Header.new(create_io([ 0xFF, 0b1110_1010, 0x10, 0x01 ])) }.
+        should(raise_error(Mp3file::InvalidMP3HeaderError))
+    end
+  end
+
+  describe "#layer" do
+    [ [ [ 0xFF, 0b1111_1010, 0x10, 0x01 ], 'Layer III' ],
+      [ [ 0xFF, 0b1111_1100, 0x10, 0x01 ], 'Layer II' ],
+      [ [ 0xFF, 0b1111_1110, 0x10, 0x01 ], 'Layer I' ],
+    ].each do |bytes, layer|
+      it "recognizes #{layer}" do
+        h = Mp3file::MP3Header.new(create_io(bytes))
+        h.layer.should == layer
+      end
+    end
+
+    it "raises an error on an invalid version" do
+      lambda { Mp3file::MP3Header.new(create_io([ 0xFF, 0b1111_1000, 0x10, 0x01 ])) }.
+        should(raise_error(Mp3file::InvalidMP3HeaderError))
+    end
+  end
+
+  describe "#has_crc" do
+    it "detects when a CRC is present" do
+      h = Mp3file::MP3Header.new(create_io([ 0xFF, 0b1111_1010, 0x10, 0x01 ]))
+      h.has_crc == true
+    end
+    it "detects when there is not a CRC present" do
+      h = Mp3file::MP3Header.new(create_io([ 0xFF, 0b1111_1011, 0x10, 0x01 ]))
+      h.has_crc == true
+    end
+  end
+
+  describe "#bitrate" do
+    [ [ "MPEG 1 Layer I",     0xFF, [ 32, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 448 ] ],
+      [ "MPEG 1 Layer II",    0xFD, [ 32, 48, 56,  64,  80,  96, 112, 128, 160, 192, 224, 256, 320, 384 ] ],
+      [ "MPEG 1 Layer III",   0xFB, [ 32, 40, 48,  56,  64,  80,  96, 112, 128, 160, 192, 224, 256, 320 ] ],
+      [ "MPEG 2 Layer I",     0xF7, [ 32, 48, 56,  64,  80,  96, 112, 128, 144, 160, 176, 192, 224, 256 ] ],
+      [ "MPEG 2 Layer II",    0xF5, [  8, 16, 24,  32,  40,  48,  56,  64,  80,  96, 112, 128, 144, 160 ] ],
+      [ "MPEG 2 Layer III",   0xF3, [  8, 16, 24,  32,  40,  48,  56,  64,  80,  96, 112, 128, 144, 160 ] ],
+      [ "MPEG 2.5 Layer I",   0xE7, [ 32, 48, 56,  64,  80,  96, 112, 128, 144, 160, 176, 192, 224, 256 ] ],
+      [ "MPEG 2.5 Layer II",  0xE5, [  8, 16, 24,  32,  40,  48,  56,  64,  80,  96, 112, 128, 144, 160 ] ],
+      [ "MPEG 2.5 Layer III", 0xE3, [  8, 16, 24,  32,  40,  48,  56,  64,  80,  96, 112, 128, 144, 160 ] ],
+    ].each do |version_layer, byte2, bitrates|
+      context "for #{version_layer}" do
+        bitrates.each_with_index do |br, i|
+          it "detects #{br} kbps" do
+            io = create_io([ 0xFF, byte2, (i + 1) << 4, 0x01 ])
+            h = Mp3file::MP3Header.new(io)
+            h.bitrate.should == br * 1000
+          end
+        end
+
+        it "rejects a free bitrate" do
+          io = create_io([ 0xFF, byte2, 0x00, 0x01 ])
+          lambda { Mp3file::MP3Header.new(io) }.should(raise_error(Mp3file::InvalidMP3HeaderError))
+        end
+
+        it "rejects a bad bitrate" do
+          io = create_io([ 0xFF, byte2, 0xF0, 0x01 ])
+          lambda { Mp3file::MP3Header.new(io) }.should(raise_error(Mp3file::InvalidMP3HeaderError))
+        end
+      end
+    end
+  end
+
+  describe "#samplerate" do
+    [ [ "MPEG 1",   0xFF, [ 44100, 48000, 32000 ] ],
+      [ "MPEG 2",   0xF5, [ 22050, 24000, 16000 ] ],
+      [ "MPEG 2.5", 0xE3, [ 11025, 12000,  8000 ] ],
+    ].each do |version, byte2, srs|
+      context "for #{version}" do
+        srs.each_with_index do |sr, i|
+          it "detects #{sr} Hz" do
+            io = create_io([ 0xFF, byte2, 0x10 + (i << 2), 0x01 ])
+            h = Mp3file::MP3Header.new(io)
+            h.samplerate.should == sr
+          end
+        end
+
+        it "rejects reserved samplerate values" do
+          io = create_io([ 0xFF, byte2, 0x1C, 0x01 ])
+          lambda { Mp3file::MP3Header.new(io) }.should(raise_error(Mp3file::InvalidMP3HeaderError))
+        end
+      end
+    end
+  end
+
+  describe "#has_padding" do
+    it "detects if the frame is padded" do
+      io = create_io([ 0xFF, 0xFB, 0b0001_1010, 0x01 ])
+      h = Mp3file::MP3Header.new(io)
+      h.has_padding.should == true
+    end
+
+    it "detects if the frame is not padded" do
+      io = create_io([ 0xFF, 0xFB, 0b0001_1000, 0x01 ])
+      h = Mp3file::MP3Header.new(io)
+      h.has_padding.should == false
+    end
+  end
+
+  describe "#mode" do
+    it "detects Stereo" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0000_0001 ])
+      h = Mp3file::MP3Header.new(io)
+      h.mode.should == 'Stereo'
+    end
+
+    it "detects Joint Stereo" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0100_0001 ])
+      h = Mp3file::MP3Header.new(io)
+      h.mode.should == 'Joint Stereo'
+    end
+
+    it "detects Dual Channel" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b1000_0001 ])
+      h = Mp3file::MP3Header.new(io)
+      h.mode.should == 'Dual Channel'
+    end
+
+    it "detects Mono" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b1100_0001 ])
+      h = Mp3file::MP3Header.new(io)
+      h.mode.should == 'Mono'
+    end
+  end
+
+  describe "#mode_extension" do
+    context "For Layers I & II" do
+      it "detects bands 4 to 31" do
+        io = create_io([ 0xFF, 0xFE, 0x92, 0b0100_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == 'bands 4 to 31'
+      end
+
+      it "detects bands 8 to 31" do
+        io = create_io([ 0xFF, 0xFD, 0x92, 0b0101_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == 'bands 8 to 31'
+      end
+
+      it "detects bands 12 to 31" do
+        io = create_io([ 0xFF, 0xFE, 0x92, 0b0110_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == 'bands 12 to 31'
+      end
+
+      it "detects bands 16 to 31" do
+        io = create_io([ 0xFF, 0xFD, 0x92, 0b0111_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == 'bands 16 to 31'
+      end
+    end
+
+    context "For Layer III" do
+      it "detects neither mode extension" do
+        io = create_io([ 0xFF, 0xFB, 0x92, 0b0100_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == nil
+      end
+
+      it "detects only Intensity Stereo" do
+        io = create_io([ 0xFF, 0xFB, 0x92, 0b0101_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == 'Intensity Stereo'
+      end
+
+      it "detects only M/S Stereo" do
+        io = create_io([ 0xFF, 0xFB, 0x92, 0b0110_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == 'M/S Stereo'
+      end
+
+      it "detects both Intensity Stereo & M/S Stereo" do
+        io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == [ 'Intensity Stereo', 'M/S Stereo' ]
+      end
+    end
+
+    context "for non-Joint-Stereo headers" do
+      it "should return no mode extension for Stereo" do
+        io = create_io([ 0xFF, 0xFE, 0x92, 0b0011_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == nil
+      end
+
+      it "should return no mode extension for Dual Channel" do
+        io = create_io([ 0xFF, 0xFD, 0x92, 0b1011_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == nil
+      end
+
+      it "should return no mode extension for Mono" do
+        io = create_io([ 0xFF, 0xFB, 0x92, 0b1111_0001 ])
+        h = Mp3file::MP3Header.new(io)
+        h.mode_extension.should == nil
+      end
+    end
+  end
+
+  describe "#copyright" do
+    it "detects copyrighted material" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_1001 ])
+      h = Mp3file::MP3Header.new(io)
+      h.copyright.should == true
+    end
+
+    it "detects non-copyrighted material" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_0001 ])
+      h = Mp3file::MP3Header.new(io)
+      h.copyright.should == false
+    end
+  end
+
+  describe "#original" do
+    it "detects original material" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_0101 ])
+      h = Mp3file::MP3Header.new(io)
+      h.original.should == true
+    end
+
+    it "detects non-original material" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_0001 ])
+      h = Mp3file::MP3Header.new(io)
+      h.original.should == false
+    end
+  end
+
+  describe "#emphasis" do
+    it "detects no emphasis" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_0000 ])
+      h = Mp3file::MP3Header.new(io)
+      h.emphasis.should == 'none'
+    end
+
+    it "detects 50/15 ms" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_0001 ])
+      h = Mp3file::MP3Header.new(io)
+      h.emphasis.should == '50/15 ms'
+    end
+
+    it "raises an error on 2" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_0010 ])
+      lambda { Mp3file::MP3Header.new(io) }.should(raise_error(Mp3file::InvalidMP3HeaderError))
+    end
+
+    it "detects CCIT J.17" do
+      io = create_io([ 0xFF, 0xFB, 0x92, 0b0111_0011 ])
+      h = Mp3file::MP3Header.new(io)
+      h.emphasis.should == 'CCIT J.17'
+    end
+  end
+
+  describe "#samples" do
+    combinations = [
+      [ "MPEG 1 Layer I",     0xFF,  384 ],
+      [ "MPEG 1 Layer II",    0xFD, 1152 ],
+      [ "MPEG 1 Layer III",   0xFB, 1152 ],
+      [ "MPEG 2 Layer I",     0xF7,  384 ],
+      [ "MPEG 2 Layer II",    0xF5, 1152 ],
+      [ "MPEG 2 Layer III",   0xF3,  576 ],
+      [ "MPEG 2.5 Layer I",   0xE7,  384 ],
+      [ "MPEG 2.5 Layer II",  0xE5, 1152 ],
+      [ "MPEG 2.5 Layer III", 0xE3,  576 ],
+    ]
+    combinations.each do |name, byte2, samples|
+      it("for #{name}, returns %d samples" % [ samples ]) do
+        io = create_io([ 0xFF, byte2, 0x92, 0xC1 ])
+        h = Mp3file::MP3Header.new(io)
+        h.samples.should == samples
+      end
+    end
+  end
+
+  describe "#frame_size" do
+    combinations = [
+      [ "MPEG 1 Layer I 32 kbps 32 kHz padded",        0xFF, 0x1B,  52 ],
+      [ "MPEG 1 Layer II 56 kbps 48 kHz not padded",   0xFD, 0x34, 168 ],
+      [ "MPEG 1 Layer III 64 kbps 44.1 kHz padded",    0xFB, 0x53, 209 ],
+      [ "MPEG 2 Layer III 144 kbps 24 kHz not padded", 0xF3, 0xD5, 432 ],
+    ]
+    combinations.each do |name, byte2, byte3, size|
+      it "for #{name}, returns #{size} bytes" do
+        io = create_io([ 0xFF, byte2, byte3, 0xC1 ])
+        h = Mp3file::MP3Header.new(io)
+        h.frame_size.should == size
+      end
+    end
+  end
+
+  describe "#side_bytes" do
+    combinations = [
+      [ "MPEG 1 Stereo",   0xFF, 0x18, 0x01, 32 ],
+      [ "MPEG 1 Mono",     0xFF, 0x18, 0xC1, 17 ],
+      [ "MPEG 2 J-Stereo", 0xF3, 0xD5, 0x41, 17 ],
+      [ "MPEG 2.5 Mono",   0xE3, 0xD5, 0xC1,  9 ],      
+    ]
+    combinations.each do |name, b2, b3, b4, side_bytes|
+      it "for #{name}, returns #{side_bytes} bytes" do
+        io = create_io([ 0xFF, b2, b3, b4 ])
+        h = Mp3file::MP3Header.new(io)
+        h.side_bytes.should == side_bytes
+      end
+    end
+  end
+end

data/spec/mp3file/xing_header_spec.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/../../lib/mp3file'
+require File.dirname(__FILE__) + '/../common_helpers'
+
+include CommonHelpers
+
+describe Mp3file::XingHeader do
+  it 'raises an error if the first 4 bytes don\'t say "Xing"' do
+    io = StringIO.new("Ping\x00\x00\x00\x00")
+    lambda { Mp3file::XingHeader.new(io) }.should(raise_error(Mp3file::InvalidXingHeaderError))
+  end
+
+  it 'raises an error if the next int is more than 15' do
+    io = StringIO.new("Xing\x00\x00\x00\x10")
+    lambda { Mp3file::XingHeader.new(io) }.should(raise_error(Mp3file::InvalidXingHeaderError))
+  end
+
+  describe "with no parts" do
+    subject { Mp3file::XingHeader.new(StringIO.new("Xing\x00\x00\x00\x00")) }
+    its(:frames) { should == nil }
+    its(:bytes) { should == nil }
+    its(:toc) { should == nil }
+    its(:quality) { should == nil }
+  end
+
+  describe "with only a frame count" do
+    subject { Mp3file::XingHeader.new(StringIO.new("Xing\x00\x00\x00\x01\x00\x00\x14\xFA")) }
+    its(:frames) { should == 5370 }
+    its(:bytes) { should == nil }
+    its(:toc) { should == nil }
+    its(:quality) { should == nil }
+  end
+
+  describe "with only a byte count" do
+    subject { Mp3file::XingHeader.new(StringIO.new("Xing\x00\x00\x00\x02\x00\x00\x14\xFA")) }
+    its(:frames) { should == nil }
+    its(:bytes) { should == 5370 }
+    its(:toc) { should == nil }
+    its(:quality) { should == nil }
+  end
+
+  describe "with only a TOC" do
+    subject { Mp3file::XingHeader.new(StringIO.new("Xing\x00\x00\x00\x04" + ("\x00" * 100))) }
+    its(:frames) { should == nil }
+    its(:bytes) { should == nil }
+    its(:toc) { should == [ 0 ] * 100 }
+    its(:quality) { should == nil }
+  end
+
+  describe "with only a quality" do
+    subject { Mp3file::XingHeader.new(StringIO.new("Xing\x00\x00\x00\x08\x00\x00\x00\x55")) }
+    its(:frames) { should == nil }
+    its(:bytes) { should == nil }
+    its(:toc) { should == nil }
+    its(:quality) { should == 85 }
+  end
+
+  describe "with all four" do
+    subject do
+      str = [ 
+        'Xing', # ID
+        "\x00\x00\x00\x0F", # Which fields are present
+        "\x00\x4B\xF4\x80", # The frame count
+        "\x00\x1C\x7B\xB0", # The byte count
+        "\x00" * 100,       # The TOC
+        "\x00\x00\x00\x55",  # The quality
+      ].join('')
+      Mp3file::XingHeader.new(StringIO.new(str))
+    end
+
+    its(:frames) { should == 4977792 }
+    its(:bytes) { should == 1866672 }
+    its(:toc) { should == [ 0 ] * 100 }
+    its(:quality) { should == 85 }
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: mp3file
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Watts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-01 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19138680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19138680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &19138260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19138260
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: &19137840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19137840
+description: Reads MP3 headers and returns their information.
+email:
+- ahwatts@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- doc/id3v2.2.0.txt
+- doc/id3v2.3.0.txt
+- doc/id3v2.4.0-frames.txt
+- doc/id3v2.4.0-structure.txt
+- lib/mp3file.rb
+- lib/mp3file/id3v1_tag.rb
+- lib/mp3file/id3v2.rb
+- lib/mp3file/id3v2/bit_padded_int.rb
+- lib/mp3file/id3v2/frame_header.rb
+- lib/mp3file/id3v2/header.rb
+- lib/mp3file/id3v2/tag.rb
+- lib/mp3file/id3v2/text_frame.rb
+- lib/mp3file/id3v2/version.rb
+- lib/mp3file/mp3_file.rb
+- lib/mp3file/mp3_header.rb
+- lib/mp3file/version.rb
+- lib/mp3file/xing_header.rb
+- mp3file.gemspec
+- spec/common_helpers.rb
+- spec/files/bret_96.mp3
+- spec/files/bret_id3v1.mp3
+- spec/files/bret_id3v2.mp3
+- spec/files/bret_vbr_6.mp3
+- spec/mp3file/id3v1_tag_spec.rb
+- spec/mp3file/id3v2/bit_padded_int_spec.rb
+- spec/mp3file/id3v2/frame_header_spec.rb
+- spec/mp3file/id3v2/header_spec.rb
+- spec/mp3file/id3v2/tag_spec.rb
+- spec/mp3file/id3v2/version_spec.rb
+- spec/mp3file/mp3_file_spec.rb
+- spec/mp3file/mp3_header_spec.rb
+- spec/mp3file/xing_header_spec.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/mp3file
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mp3file
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Reads MP3 headers and returns their information.
+test_files: []