format_parser 2.8.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3557085da1447c801981d805786c74a9f319ac5715a1da54e70509fc7c1e99
-  data.tar.gz: b21520eac5fd8f7e776b8cb28c06b95bb372b293ce4426482470935ce67dcb55
+  metadata.gz: 922909c34fc304a86a75f6396bd9627cdacf009aba5191da863064811ca2906f
+  data.tar.gz: 864b73aa70b7ec650dab326f677b17f7ed1905d05560deb669a564bb9fdc3d37
 SHA512:
-  metadata.gz: 1bc06e885bba567bfef0f1d97fe83f6785044e6476cac6b4502349ce40208d0c0f9a5f1c1042c90492f8ca093085de1c84e46345c948fb820cb5d507db52ba9b
-  data.tar.gz: 61569171e518c30b984155765f823d2ee77633061b70abd0ad8a2ce0122a95f4c2e042be291c7ac48ec9e57a1ef2630bdf4ed5d5216876bea29d9330b84a430a
+  metadata.gz: 5f2527d385f3270f9b11976d478030108787a165e4440825c4ffa8c6a56054e67e5a7fb1a88d18d25dcb945ab6c2befc97156e7a2a5d5ad98f2e11e7c558ce2a
+  data.tar.gz: 788254d0f2e40625a6f2fd17c3c7f8959456ad1018fceb62305c5a877a3a8fd52ad5587915b0d3711a8ab68c6dc0ca6d283d9556f68a3234bbd3ecb7a50ece95

data/CHANGELOG.md

@@ -1,5 +1,11 @@
+## 2.10.0
+* Improve WAV parser by focusing on performance rather than on attempting a best-effort when extracting metadata from files that do not strictly follow the format spec.
+
+## 2.9.0
+* Improve WAV parser by performing a best-effort when extracting metadata from files that do not strictly follow the format spec.
+
 ## 2.8.0
-* Add support for Ruby 3.2 and 3.3
+* Add support for Ruby 3.2 and 3.3.
 
 ## 2.7.2
 * Improved stability for mp4 parser when dealing with corrupted FTYP boxes.

data/lib/format_parser/version.rb

@@ -1,3 +1,3 @@
 module FormatParser
-  VERSION = '2.8.0'
+  VERSION = '2.10.0'
 end

data/lib/parsers/wav_parser.rb

@@ -20,75 +20,57 @@ class FormatParser::WAVParser
     # with the exception that the Format chunk must precede the Data chunk.
     # The specification does not require the Format chunk to be the first chunk
     # after the RIFF header.
-    # http://soundfile.sapp.org/doc/WaveFormat/
-    # For WAVE files containing PCM audio format we parse the 'fmt ' and
-    # 'data' chunks while for non PCM audio formats the 'fmt ' and 'fact'
-    # chunks. In the latter case the order fo appearence of the chunks is
-    # arbitrary.
+    # https://www.mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html
     fmt_processed = false
-    fact_processed = false
+    data_processed = false
     fmt_data = {}
-    total_sample_frames = 0
+    data_size = 0
     loop do
       chunk_type, chunk_size = safe_read(io, 8).unpack('a4l')
       case chunk_type
       when 'fmt ' # watch out: the chunk ID of the format chunk ends with a space
         fmt_data = unpack_fmt_chunk(io, chunk_size)
-        return process_non_pcm(fmt_data, total_sample_frames) if fmt_data[:audio_format] != 1 and fact_processed
         fmt_processed = true
       when 'data'
-        return unless fmt_processed # the 'data' chunk cannot preceed the 'fmt ' chunk
-        return process_pcm(fmt_data, chunk_size) if fmt_data[:audio_format] == 1
-        safe_skip(io, chunk_size)
-      when 'fact'
-        total_sample_frames = safe_read(io, 4).unpack('l').first
-        safe_skip(io, chunk_size - 4)
-        return process_non_pcm(fmt_data, total_sample_frames) if fmt_processed and fmt_data[:audio_format] != 1
-        fact_processed = true
+        data_size = chunk_size
+        data_processed = true
       else
         # Skip this chunk until a known chunk is encountered
         safe_skip(io, chunk_size)
       end
+      break if fmt_processed && data_processed
     end
+
+    file_info(fmt_data, data_size)
   end
 
   def unpack_fmt_chunk(io, chunk_size)
     # The size of the fmt chunk is at least 16 bytes. If the format tag's value is not
     # 1 compression might be in use for storing the data
     # and the fmt chunk might contain extra fields appended to it.
-    # The last 4 fields of the fmt tag are always:
+    # The first 6 fields of the fmt tag are always:
+    # * unsigned short     audio format
     # * unsigned short     channels
     # * unsigned long      samples per sec
     # * unsigned long      average bytes per sec
     # * unsigned short     block align
     # * unsigned short     bits per sample
 
-    fmt_info = safe_read(io, 16).unpack('S_2I2S_2')
+    _, channels, sample_rate, byte_rate, _, bits_per_sample = safe_read(io, 16).unpack('S_2I2S_2')
     safe_skip(io, chunk_size - 16) # skip the extra fields
 
     {
-      audio_format: fmt_info[0],
-      channels: fmt_info[1],
-      sample_rate: fmt_info[2],
-      byte_rate: fmt_info[3],
-      block_align: fmt_info[4],
-      bits_per_sample: fmt_info[5],
+      channels: channels,
+      sample_rate: sample_rate,
+      byte_rate: byte_rate,
+      bits_per_sample: bits_per_sample,
     }
   end
 
-  def process_pcm(fmt_data, data_size)
-    return unless fmt_data[:channels] > 0 and fmt_data[:bits_per_sample] > 0
-    sample_frames = data_size / (fmt_data[:channels] * fmt_data[:bits_per_sample] / 8)
-    file_info(fmt_data, sample_frames)
-  end
-
-  def process_non_pcm(fmt_data, total_sample_frames)
-    file_info(fmt_data, total_sample_frames)
-  end
-
-  def file_info(fmt_data, sample_frames)
-    return unless fmt_data[:sample_rate] > 0
-    duration_in_seconds = sample_frames / fmt_data[:sample_rate].to_f
+  def file_info(fmt_data, data_size)
+    # NOTE: Each sample includes information for each channel
+    sample_frames = data_size / (fmt_data[:channels] * fmt_data[:bits_per_sample] / 8) if fmt_data[:channels] > 0 && fmt_data[:bits_per_sample] > 0
+    duration_in_seconds = sample_frames / fmt_data[:sample_rate].to_f if sample_frames && fmt_data[:byte_rate] > 0
     FormatParser::Audio.new(
       format: :wav,
       num_audio_channels: fmt_data[:channels],

data/spec/parsers/wav_parser_spec.rb

@@ -20,8 +20,9 @@ describe FormatParser::WAVParser do
     expect(parse_result.format).to eq(:wav)
     expect(parse_result.num_audio_channels).to eq(1)
     expect(parse_result.audio_sample_rate_hz).to eq(8000)
-    expect(parse_result.media_duration_frames).to eq(110488)
-    expect(parse_result.media_duration_seconds).to be_within(0.01).of(13.81)
+    # Fixture does not define bits_per_sample in the fmt chunk
+    expect(parse_result.media_duration_frames).to be_nil
+    expect(parse_result.media_duration_seconds).to be_nil
   end
 
   it 'returns correct info about pcm files with more channels' do
@@ -46,9 +47,14 @@ describe FormatParser::WAVParser do
     expect(parse_result.media_duration_seconds).to be_within(0.01).of(13.81)
   end
 
-  it "cannot parse file with audio format different from 1 and no 'fact' chunk" do
-    expect {
-      subject.call(File.open(__dir__ + '/../fixtures/WAV/invalid_d_6_Channel_ID.wav', 'rb'))
-    }.to raise_error(FormatParser::IOUtils::InvalidRead)
+  it 'returns correct info about non pcm files with no fact chunk' do
+    parse_result = subject.call(File.open(__dir__ + '/../fixtures/WAV/d_6_Channel_ID.wav', 'rb'))
+
+    expect(parse_result.nature).to eq(:audio)
+    expect(parse_result.format).to eq(:wav)
+    expect(parse_result.num_audio_channels).to eq(6)
+    expect(parse_result.audio_sample_rate_hz).to eq(44100)
+    expect(parse_result.media_duration_frames).to eq(257411)
+    expect(parse_result.media_duration_seconds).to be_within(0.01).of(5.83)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: format_parser
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Noah Berman
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exifr