waveinfo 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74a2aa7c0afcd31cf13309b02c971a3ec1facff6
-  data.tar.gz: 93a26151a2c6c9c1d0cf9fccc28ea02ab9ffe0b3
+  metadata.gz: 3992b0d0d7399d87f208ba8f945ccc5222d17e42
+  data.tar.gz: a2bfac5fb6489d62c3e8d62a18d884adab5e660b
 SHA512:
-  metadata.gz: 386634ff49009b618160c000d993a09307ef92f5c23b9402e0039fc6c28951c5fcae968cc5a3828d8093ab3369fa99dd0c98d8930afc057f33a9b3e76b326ec5
-  data.tar.gz: af7208c56fe6a80876ac86fa8a605747ae8e393750fbce281f405be4122cd34e8149b5b8831f0e3218a98f66cdec89fe642132448db0c8e8d4a4f91f5aa52919
+  metadata.gz: 4e94a35da99220464a0aedab63733eaa2d3c080de0ef22ada7fcd5e91f2d06e1b44fcb1d94c573fc6b04e1e1cfb36326f4af6df6ba82b71d2131cf477c54fc9f
+  data.tar.gz: bb01a4c1eeef8a5e7031f4591c95687874c9ef70470d1b8913e9a0d191f61e3041fce4d6fc288f05d323215de0789c35226df5b86b28c9ebbce7a792ab6d2403

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2009-2014 Nicholas J Humfrey
+Copyright (c) 2009-2015 Nicholas J Humfrey
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -26,21 +26,6 @@ Synopsis
     puts "Duration: #{wave.duration} secs"
 
 
-TODO
-----
-
-* Add support for the extensible format which uses GUIDs
-* Inplement more validity checks
-  - file is shorter than reported chunk size
-  - file is longer than reported chunk size
-* Implement more chunk types
-  - bext - Broadcast Wave Extention
-  - mext - MPEG audio extension chunk
-  - DISP - Title
-  - cart - CartChunk/aes46-2002
-  - LIST
-* Test against more weird Wave files
-
 
 Resources
 ---------
@@ -60,6 +45,6 @@ Contact
 -------
 
 * Author:    Nicholas J Humfrey
-* Email:     njh@aelius.com
-* Home Page: http://www.aelius.com/njh/
+* Twitter:   [@njh](https://twitter.com/njh)
+* Home Page: https://www.aelius.com/njh/
 

data/bin/waveinfo

@@ -11,7 +11,7 @@ end
 ARGV.each do |arg|
   wave = WaveInfo.new(arg)
   puts "Filename        : #{wave.filename}"
-  puts "Audio Format    : #{wave.audio_format} " + 
+  puts "Audio Format    : #{wave.audio_format} " +
        sprintf("(0x%2.2x)",wave.audio_format_id)
   puts "Duration        : " + sprintf("%2.2fs", wave.duration)
   puts "Channels        : #{wave.channels}"

data/lib/waveinfo.rb

@@ -8,10 +8,10 @@ class WaveInfo
   end
   self.debug = true
 
-  # Create a new WaveInfo object to get information and metadata about a 
+  # Create a new WaveInfo object to get information and metadata about a
   # Wave file (.wav). 'file' can either be a filename or an IO object.
   def initialize(file)
-  
+
     # Set default values
     @audio_format_id = 0
     @bits_per_sample = nil
@@ -21,7 +21,7 @@ class WaveInfo
     @data_size = nil
     @sample_rate = nil
     @samples = nil
-    
+
     # What was passed in to us?
     if file.is_a?(String)
       @io = File.new(file, 'rb')
@@ -34,12 +34,12 @@ class WaveInfo
       read_headers
     end
   end
-  
+
   # Return the name of the input file.
   def filename
     File.basename(@filepath)
   end
-  
+
   # Get the identifier of the audio codec (for example PCM would be 1).
   def audio_format_id
     @audio_format_id
@@ -74,7 +74,7 @@ class WaveInfo
         sprintf("Unknown (0x%2.2x)",@audio_format_id)
     end
   end
-  
+
   # Get the number of channels.
   def channels
     @channels
@@ -99,39 +99,58 @@ class WaveInfo
   def bits_per_sample
     @bits_per_sample
   end
-  
+
   # Get the total number of samples.
   def samples
     if @samples
       @samples
-    else
-      @data_size / @block_align
+    elsif @block_align.to_f.nonzero?
+      @data_size && @block_align ? @data_size / @block_align : 0.0
+    else 
+      0.0
     end
   end
-  
+
   # Get the length of the audio data (in bytes).
   def size
     @data_size
   end
-  
+
   # Get the duration of the audio (in seconds).
   def duration
-    samples.to_f / sample_rate.to_f
+    if sample_rate.to_f.nonzero?
+      sample_rate ? samples.to_f / sample_rate.to_f : 0.0
+    else
+      0.0
+    end
   end
 
+
   private
 
   def read_headers
     # Read in the chunk header
-    chunk_id = read_fourchar
-    raise FileFormatError.new("Chunk id is not 'RIFF' or 'RF64'") if chunk_id != 'RIFF' && chunk_id != 'RF64'
-    chunk_size = read_longint
-    chunk_format = read_fourchar
-    raise FileFormatError.new("Chunk format is not 'WAVE'") if chunk_format != 'WAVE'
-    
+    @chunk_id = read_fourchar
+    @chunk_size = read_longint
+    @chunk_format = read_fourchar
+    raise FileFormatError.new("Chunk format is not 'WAVE'") unless @chunk_format == 'WAVE'
+
+    if @chunk_id == 'RIFF'
+      position = 0xC
+    elsif @chunk_id == 'RF64'
+      # Next sub-chunk *has* to be a 'ds64'
+      subchunk_size = read_ds64_chunk
+      position = 0xC + subchunk_size
+    else
+      raise FileFormatError.new("Primary chunk id is not 'RIFF' or 'RF64'")
+    end
+
+    read_subchunks(position)
+  end
+
+  def read_subchunks(position)
     # Read in each of the sub-chunks
-    position = 0x0C
-    while(chunk_size-position) > 0 do
+    while(@chunk_size - position) > 0 do
       subchunk_id = read_fourchar
       subchunk_size = read_longint
       case subchunk_id
@@ -140,9 +159,15 @@ class WaveInfo
         when 'fact'
           read_fact_chunk(subchunk_size)
         when 'data'
+          unless subchunk_size == 0xFFFFFFFF
           @data_size = subchunk_size
+          end
           # Skip over the wave data
-          @io.seek(subchunk_size,IO::SEEK_CUR)
+          @io.seek(@data_size,IO::SEEK_CUR)
+        when nil
+          # Give up if read fails
+          $stderr.puts "Warning: read error before reaching end of file" if WaveInfo.debug
+          break
         else
           pos = sprintf("0x%x", position)
           $stderr.puts "Warning: unsupported sub-chunk at #{pos}: #{subchunk_id}" if WaveInfo.debug
@@ -150,7 +175,7 @@ class WaveInfo
       end
       position += subchunk_size + 8
     end
-    
+
   end
 
   def read_fmt_chunk(size)
@@ -160,35 +185,58 @@ class WaveInfo
     @byte_rate = read_longint
     @block_align = read_shortint
     @bits_per_sample = read_shortint
-    
+
     # Skip any extra parameters
     @io.seek(size-16,IO::SEEK_CUR) if size > 16
   end
-  
+
   def read_fact_chunk(size)
     # Read in the number of samples
-    @samples = read_longint
+    sample_count = read_longint
+    unless sample_count == 0xFFFFFFFF
+      @samples = sample_count
+    end
 
     # Skip any extra data
     @io.seek(size-4,IO::SEEK_CUR) if size > 4
   end
-  
+
+  def read_ds64_chunk
+    subchunk_id = read_fourchar
+    raise FileFormatError.new("First sub-chunk of RF64 file is not 'ds64'") unless subchunk_id == 'ds64'
+    subchunk_size = read_longint
+
+    riff_size_low = read_longint
+    riff_size_high = read_longint
+    data_size_low = read_longint
+    data_size_high = read_longint
+    sample_count_low = read_longint
+    sample_count_high = read_longint
+
+    @data_size = (data_size_high << 32) + data_size_low
+    @samples = (sample_count_high << 32) + sample_count_low
+    @chunk_size = (riff_size_high << 32) + riff_size_low
+
+    # Skip any extra data
+    @io.seek(subchunk_size-24,IO::SEEK_CUR) if subchunk_size > 24
+  end
+
   def read_fourchar
     @io.read(4)
   end
-  
+
   def read_longint
     bytes = @io.read(4)
     bytes ? bytes.unpack('V').first : nil
   end
-  
+
   def read_shortint
     bytes = @io.read(2)
     bytes ? bytes.unpack('v').first : nil
   end
-  
+
   # Exception raised if there is a problem parsing the Wave file
   class FileFormatError < StandardError
   end
-  
+
 end

data/lib/waveinfo/version.rb

@@ -1,3 +1,3 @@
 class WaveInfo
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/waveinfo_spec.rb

@@ -31,19 +31,19 @@ describe WaveInfo do
     it "should get the byte rate right" do
       expect(@wav.byte_rate).to eq(22050)
     end
-    
+
     it "should get the block align value right" do
       expect(@wav.block_align).to eq(2)
     end
-    
+
     it "should get the bits per sample right" do
       expect(@wav.bits_per_sample).to eq(16)
     end
-    
+
     it "should get the audio length in bytes right" do
       expect(@wav.size).to eq(8820)
     end
-    
+
     it "should get the number of samples right" do
       expect(@wav.samples).to eq(4410)
     end
@@ -51,7 +51,7 @@ describe WaveInfo do
     it "should get the audio duration right" do
       expect(@wav.duration).to eq(0.4)
     end
-    
+
     it "should know the name of the file read from" do
       expect(@wav.filename).to eq(File.basename(@filepath))
     end
@@ -82,19 +82,19 @@ describe WaveInfo do
     it "should get the byte rate right" do
       expect(@wav.byte_rate).to eq(1625)
     end
-    
+
     it "should get the block align value right" do
       expect(@wav.block_align).to eq(65)
     end
-    
+
     it "should get the bits per sample right" do
       expect(@wav.bits_per_sample).to eq(0)
     end
-    
+
     it "should get the audio length in bytes right" do
       expect(@wav.size).to eq(650)
     end
-    
+
     it "should get the number of samples right" do
       expect(@wav.samples).to eq(3200)
     end
@@ -102,7 +102,7 @@ describe WaveInfo do
     it "should get the audio duration right" do
       expect(@wav.duration).to eq(0.4)
     end
-    
+
     it "should know the name of the file read from" do
       expect(@wav.filename).to eq(File.basename(@filepath))
     end
@@ -133,19 +133,19 @@ describe WaveInfo do
     it "should get the byte rate right" do
       expect(@wav.byte_rate).to eq(176400)
     end
-    
+
     it "should get the block align value right" do
       expect(@wav.block_align).to eq(4)
     end
-    
+
     it "should get the bits per sample right" do
       expect(@wav.bits_per_sample).to eq(16)
     end
-    
+
     it "should get the audio length in bytes right" do
       expect(@wav.size).to eq(100000)
     end
-    
+
     it "should get the number of samples right" do
       expect(@wav.samples).to eq(25000)
     end
@@ -153,7 +153,7 @@ describe WaveInfo do
     it "should get the audio duration right" do
       expect((@wav.duration * 1000).to_i).to eq(566)
     end
-    
+
     it "should know the name of the file read from" do
       expect(@wav.filename).to eq(File.basename(@filepath))
     end
@@ -184,19 +184,19 @@ describe WaveInfo do
     it "should get the byte rate right" do
       expect(@wav.byte_rate).to eq(5784)
     end
-    
+
     it "should get the block align value right" do
       expect(@wav.block_align).to eq(128)
     end
-    
+
     it "should get the bits per sample right" do
       expect(@wav.bits_per_sample).to eq(4)
     end
-    
+
     it "should get the audio length in bytes right" do
       expect(@wav.size).to eq(2432)
     end
-    
+
     it "should get the number of samples right" do
       expect(@wav.samples).to eq(4410)
     end
@@ -204,7 +204,7 @@ describe WaveInfo do
     it "should get the audio duration right" do
       expect(@wav.duration).to eq(0.4)
     end
-    
+
     it "should know the name of the file read from" do
       expect(@wav.filename).to eq(File.basename(@filepath))
     end
@@ -235,19 +235,19 @@ describe WaveInfo do
     it "should get the byte rate right" do
       expect(@wav.byte_rate).to eq(11025)
     end
-    
+
     it "should get the block align value right" do
       expect(@wav.block_align).to eq(1)
     end
-    
+
     it "should get the bits per sample right" do
       expect(@wav.bits_per_sample).to eq(8)
     end
-    
+
     it "should get the audio length in bytes right" do
       expect(@wav.size).to eq(4410)
     end
-    
+
     it "should get the number of samples right" do
       expect(@wav.samples).to eq(4410)
     end
@@ -255,7 +255,7 @@ describe WaveInfo do
     it "should get the audio duration right" do
       expect(@wav.duration).to eq(0.4)
     end
-    
+
     it "should know the name of the file read from" do
       expect(@wav.filename).to eq(File.basename(@filepath))
     end
@@ -286,19 +286,19 @@ describe WaveInfo do
     it "should get the byte rate right" do
       expect(@wav.byte_rate).to eq(11025)
     end
-    
+
     it "should get the block align value right" do
       expect(@wav.block_align).to eq(1)
     end
-    
+
     it "should get the bits per sample right" do
       expect(@wav.bits_per_sample).to eq(8)
     end
-    
+
     it "should get the audio length in bytes right" do
       expect(@wav.size).to eq(4410)
     end
-    
+
     it "should get the number of samples right" do
       expect(@wav.samples).to eq(4410)
     end
@@ -306,7 +306,7 @@ describe WaveInfo do
     it "should get the audio duration right" do
       expect(@wav.duration).to eq(0.4)
     end
-    
+
     it "should know the name of the file read from" do
       expect(@wav.filename).to eq(File.basename(@filepath))
     end
@@ -337,19 +337,19 @@ describe WaveInfo do
     it "should get the byte rate right" do
       expect(@wav.byte_rate).to eq(11025)
     end
-    
+
     it "should get the block align value right" do
       expect(@wav.block_align).to eq(1)
     end
-    
+
     it "should get the bits per sample right" do
       expect(@wav.bits_per_sample).to eq(8)
     end
-    
+
     it "should get the audio length in bytes right" do
       expect(@wav.size).to eq(4410)
     end
-    
+
     it "should get the number of samples right" do
       expect(@wav.samples).to eq(4410)
     end
@@ -357,7 +357,7 @@ describe WaveInfo do
     it "should get the audio duration right" do
       expect(@wav.duration).to eq(0.4)
     end
-    
+
     it "should know the name of the file read from" do
       expect(@wav.filename).to eq(File.basename(@filepath))
     end
@@ -388,18 +388,69 @@ describe WaveInfo do
     it "should get the byte rate right" do
       expect(@wav.byte_rate).to eq(5589)
     end
-    
+
     it "should get the block align value right" do
       expect(@wav.block_align).to eq(256)
     end
-    
+
     it "should get the bits per sample right" do
       expect(@wav.bits_per_sample).to eq(4)
     end
-    
+
     it "should get the audio length in bytes right" do
       expect(@wav.size).to eq(2304)
     end
+
+    it "should get the number of samples right" do
+      expect(@wav.samples).to eq(4410)
+    end
+
+    it "should get the audio duration right" do
+      expect(@wav.duration).to eq(0.4)
+    end
+
+    it "should know the name of the file read from" do
+      expect(@wav.filename).to eq(File.basename(@filepath))
+    end
+  end
+
+  describe "parsing a Mono 11kHz PCM file in the RF64 format" do
+    before :each do
+      @filepath = sample_path('sine_11k_mono_16bit_pcm_rf64')
+      @wav = WaveInfo.new( @filepath )
+    end
+
+    it "should get the audio format id right" do
+      expect(@wav.audio_format_id).to eq(65534)
+    end
+
+    it "should get the audio format name right" do
+      expect(@wav.audio_format).to eq('Extensible wave format')
+    end
+
+    it "should get the number of channels right" do
+      expect(@wav.channels).to eq(1)
+    end
+
+    it "should get the sample rate right" do
+      expect(@wav.sample_rate).to eq(11025)
+    end
+
+    it "should get the byte rate right" do
+      expect(@wav.byte_rate).to eq(22050)
+    end
+    
+    it "should get the block align value right" do
+      expect(@wav.block_align).to eq(2)
+    end
+    
+    it "should get the bits per sample right" do
+      expect(@wav.bits_per_sample).to eq(16)
+    end
+    
+    it "should get the audio length in bytes right" do
+      expect(@wav.size).to eq(8820)
+    end
     
     it "should get the number of samples right" do
       expect(@wav.samples).to eq(4410)
@@ -414,7 +465,7 @@ describe WaveInfo do
     end
   end
 
-  describe "parsing a Stereo 96kHz 24bit RF64" do
+  describe "parsing a truncated Stereo 96kHz 24bit RF64" do
     before :each do
       @filepath = sample_path('empty_96k_stereo_24bit_rf64')
       @wav = WaveInfo.new( @filepath )
@@ -449,15 +500,15 @@ describe WaveInfo do
     end
 
     it "should get the audio length in bytes right" do
-      expect(@wav.size).to eq(4294967295)
+      expect(@wav.size).to eq(4298665680)
     end
 
     it "should get the number of samples right" do
-      expect(@wav.samples).to eq(715827882)
+      expect(@wav.samples).to eq(716444280)
     end
 
     it "should get the audio duration right" do
-      expect(@wav.duration).to eq(7456.5404375)
+      expect(@wav.duration).to eq(7462.96125)
     end
 
     it "should know the name of the file read from" do
@@ -480,31 +531,50 @@ describe WaveInfo do
       data = StringIO.new("RIFF\4\0\0\0WAVE")
       expect { WaveInfo.new( data ) }.not_to raise_error
     end
-    
+
     it "should set the audio format name to Unknown for an unknown audio codec" do
       data = StringIO.new("RIFF\x14\0\0\0WAVEfmt \x0a\0\0\0\xff\x00\x02\0\0\0\0\0\0\0\0\0\0\0\0\0")
       expect(WaveInfo.new( data ).audio_format).to eq('Unknown (0xff)')
     end
+    
+    it "duration should be zero if WAVE file is valid but has no sub-chunks" do
+      data = StringIO.new("RIFF\4\0\0\0WAVE")
+      expect(WaveInfo.new( data ).duration).to eq(0)
+    end
+    
+    it "samples should be zero if WAVE file is valid but has no sub-chunks" do
+      data = StringIO.new("RIFF\4\0\0\0WAVE")
+      expect(WaveInfo.new( data ).samples).to eq(0)
+    end
+    
   end
 
-  describe "outputs stderr when debug is true" do
-    it "should default to true" do
-      expect($stderr).to receive(:puts).with("Warning: unsupported sub-chunk at 0xc: ds64")
-      @filepath = sample_path('empty_96k_stereo_24bit_rf64')
+  describe "WaveInfo.debug" do
+    before :each do
+      $realstderr = $stderr
+      $stderr = StringIO.new
+      @filepath = sample_path('unsupported_subchunk')
+      @wav = WaveInfo.new( @filepath )
+    end
+
+    after :each do
+      $stderr = $realstderr unless $realstderr.nil?
+    end
+
+    it "should default to outputting to stderr" do
+      expect($stderr).to receive(:puts).with("Warning: unsupported sub-chunk at 0x22a0: XYZZ")
       @wav = WaveInfo.new( @filepath )
     end
 
     it "should output to stderr when true" do
       WaveInfo.debug = true
-      expect($stderr).to receive(:puts).with("Warning: unsupported sub-chunk at 0xc: ds64")
-      @filepath = sample_path('empty_96k_stereo_24bit_rf64')
+      expect($stderr).to receive(:puts).with("Warning: unsupported sub-chunk at 0x22a0: XYZZ")
       @wav = WaveInfo.new( @filepath )
     end
 
     it "should not output to stderr when false" do
       WaveInfo.debug = false
-      expect($stderr).to_not receive(:puts).with("Warning: unsupported sub-chunk at 0xc: ds64")
-      @filepath = sample_path('empty_96k_stereo_24bit_rf64')
+      expect($stderr).to_not receive(:puts).with("Warning: unsupported sub-chunk at 0x22a0: XYZZ")
       @wav = WaveInfo.new( @filepath )
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waveinfo
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nicholas J Humfrey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,73 +16,73 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 10.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 10.2.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
 description: waveinfo is a pure-ruby gem to get the information from the headers of
   Wave (.wav) files.
-email: njh@aelius.com
+email: 
 executables:
 - waveinfo
 extensions: []
@@ -114,10 +114,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: waveinfo
-rubygems_version: 2.2.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Pure-ruby gem to get the information from the headers of Wave (.wav) files.
 test_files:
 - spec/waveinfo_spec.rb
-has_rdoc: