wavefile 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 345be2bed4e76c59bfb0163cc844399ff54bc7ca2643b82ba555c4bf167d5b5e
-  data.tar.gz: 1923c71c3af5438319425709de665acd6bf6be53f67058f7bf4b99c43d7a2493
+  metadata.gz: ee407af48a824f261cca687280e449d0cf8a865e9eb5b17c7b707d0f2df0b691
+  data.tar.gz: f5dae672a110107b4b572d47ed08a16c1a1cb87b913686b6d3c1a0aa100892a8
 SHA512:
-  metadata.gz: 3134a277c3c239e41e0dc60dda461223664a316e2ea16b299b61d137deee8cb545ccde99bac35566a8834571da2538aa973551d6f27b0521be9f78c0c8d88765
-  data.tar.gz: '069c9654d04eabb25c5125983b658ff468697de5eb551b7673be42fe6775a470899d20ba19e7e44c9fcd280377866ade72b1bf1aa672523065155e75c17c0604'
+  metadata.gz: 9ebaf573b2e015968616acac11c333f0a1a98bdcdaa9baf85d67987251eb649aaa31a8fb5f7c8a079e652e6ece7ebeae39fccbc079b61c51c2c6696109bcdbd1
+  data.tar.gz: 5d481c271766b50114450bf483189bd7038b0989a87c813af0d2f3b0d57f6eb4cda3ba95a3d62caff441e1ec97e9575c53c9517f5ff5cc2df3e01e85c310dbea

data/README.markdown

@@ -37,7 +37,12 @@ This gem lets you read and write audio data! You can use it to create Ruby progr
 * Written in pure Ruby, so it's easy to include in your program. There's no need to compile a separate extension in order to use it.
 
 
-# Current Release: v1.0.0
+# Current Release: v1.0.1
+
+Released on August 2, 2018, this version contains a bug fix: the file(s) written to an arbitrary `IO` instance are no longer corrupt if the initial seek position is greater than 0.
+
+
+# Previous Release: v1.0.0
 
 Released on June 10, 2018, this version has these changes:
 

data/lib/wavefile.rb

@@ -7,7 +7,7 @@ require 'wavefile/unvalidated_format'
 require 'wavefile/writer'
 
 module WaveFile
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 
   WAVEFILE_FORMAT_CODE = "WAVE"    # :nodoc:
   FORMAT_CODES = {:pcm => 1, :float => 3, :extensible => 65534}.freeze    # :nodoc:

data/lib/wavefile/buffer.rb

@@ -57,7 +57,17 @@ module WaveFile
     # Public: Creates a new Buffer containing the sample data of this Buffer, but converted
     # to a different format.
     #
-    # new_format - The format that the sample data should be converted to
+    # new_format - The format that the sample data should be converted to. If the new format
+    #              has a different number of channels than the original buffer format, the sample data
+    #              will be converted in the following way:
+    #
+    #              1 -> n: Each mono sample will be duplicated into the new number of channels.
+    #
+    #              n -> 1: Each sample in each sample frame will be averaged into a single sample.
+    #
+    #              (n > 2) -> 2: The first two channels will be kept, all other channels discarded.
+    #
+    #              other: Unsupported, will cause BufferConversionError to be raised.
     #
     # Examples
     #
@@ -75,7 +85,9 @@ module WaveFile
     # Public: Converts the sample data contained in the Buffer to a new format. The sample
     # data is converted in place, so the existing Buffer is modified.
     #
-    # new_format - The format that the sample data should be converted to
+    # new_format - The format that the sample data should be converted to. See Buffer#create
+    #              for how samples will be mapped if the new number of channels differs from
+    #              the original number of channels.
     #
     # Examples
     #

data/lib/wavefile/duration.rb

@@ -7,8 +7,6 @@ module WaveFile
   # stopwatch running for exactly 2 hours would show something like "2:00:00.000".
   # Accordingly, if the given sample frame count and sample rate add up to exactly
   # 2 hours, then hours will be 2, and minutes, seconds, and milliseconds will all be 0.
-  #
-  # This class is immutable - once a new Duration is constructed, it can't be modified.
   class Duration
     # Public: Constructs a new immutable Duration.
     #

data/lib/wavefile/format.rb

@@ -17,8 +17,6 @@ module WaveFile
   # channels, bits per sample, sample rate, and so forth. A Format instance is used
   # by Reader to indicate what format to read samples out as, and by Writer to
   # indicate what format to write samples as.
-  #
-  # This class is immutable - once a new Format is constructed, it can't be modified.
   class Format
 
     # Public: Constructs a new immutable Format.

data/lib/wavefile/reader.rb

@@ -18,7 +18,7 @@ module WaveFile
   #     # Read sample data here
   #     reader.close
   class Reader
-    # Public: Returns a Reader object that is ready to start reading the specified file's
+    # Public: Constructs a Reader object that is ready to start reading the specified file's
     # sample data.
     #
     # io_or_file_name - The name of the wave file to read from,
@@ -27,8 +27,8 @@ module WaveFile
     #          (default: the wave file's internal format).
     #
     # Returns a Reader object that is ready to start reading the specified file's sample data.
-    # Raises +Errno::ENOENT+ if the specified file can't be found
-    # Raises InvalidFormatError if the specified file isn't a valid wave file
+    # Raises +Errno::ENOENT+ if the specified file can't be found.
+    # Raises InvalidFormatError if the specified file isn't a valid wave file.
     def initialize(io_or_file_name, format=nil)
       if io_or_file_name.is_a?(String)
         @io = File.open(io_or_file_name, "rb")
@@ -114,10 +114,10 @@ module WaveFile
     # sample_frame_count - The number of sample frames to read. Note that each sample frame includes a sample for
     #                      each channel.
     #
-    # Returns a Buffer containing sample_frame_count sample frames
-    # Raises UnsupportedFormatError if file is in a format that can't be read by this gem
+    # Returns a Buffer containing sample_frame_count sample frames.
+    # Raises UnsupportedFormatError if file is in a format that can't be read by this gem.
     # Raises ReaderClosedError if the Writer has been closed.
-    # Raises EOFError if no samples could be read due to reaching the end of the file
+    # Raises EOFError if no samples could be read due to reaching the end of the file.
     def read(sample_frame_count)
       if @closed
         raise ReaderClosedError

data/lib/wavefile/unvalidated_format.rb

@@ -3,8 +3,6 @@ module WaveFile
   # channels, bits per sample, sample rate, and so forth. A Format instance is used
   # by Reader to indicate what format to read samples out as, and by Writer to
   # indicate what format to write samples as.
-  #
-  # This class is immutable - once a new Format is constructed, it can't be modified.
   class UnvalidatedFormat < Format    # :nodoc:
     # Constructs a new immutable UnvalidatedFormat.
     def initialize(fields)

data/lib/wavefile/writer.rb

@@ -19,10 +19,10 @@ module WaveFile
   #    writer.close
   class Writer
 
-    # Public: Returns a constructed Writer object which is available for writing sample data to the
-    # specified file (via the write method). When all sample data has been written, the Writer should
-    # be closed. Note that the wave file being written to will NOT be valid (and playable in other programs)
-    # until the Writer has been closed.
+    # Public: Constructs a Writer object which is available for writing sample data to the specified file
+    # (via the write method). When all sample data has been written, the Writer should be closed. Note
+    # that the wave file being written to will NOT be valid (and playable in other programs) until the
+    # Writer has been closed.
     #
     # If a block is given to this method, sample data can be written inside the given block. When the
     # block terminates, the Writer will be automatically closed (and no more sample data can be written).
@@ -44,6 +44,10 @@ module WaveFile
         @io = io_or_file_name
         @io_source = :io
       end
+
+      # The position to seek back to when re-writing the header on close
+      @start_pos = @io.pos
+
       @format = format
 
       @closed = false
@@ -90,7 +94,7 @@ module WaveFile
     #
     # Returns the number of sample frames that have been written to the file so far.
     # Raises WriterClosedError if the Writer has been closed.
-    # Raises BufferConversionError if the Buffer can't be converted to the Writer's format
+    # Raises BufferConversionError if the Buffer can't be converted to the Writer's format.
     def write(buffer)
       if @closed
         raise WriterClosedError
@@ -187,7 +191,7 @@ module WaveFile
       # We can't know what chunk sizes to write for the RIFF and data chunks until all
       # samples have been written, so go back to the beginning of the file and re-write
       # those chunk headers with the correct sizes.
-      @io.seek(0)
+      @io.seek(@start_pos)
       write_header(@total_sample_frames)
 
       if @io_source == :file_name

data/test/writer_test.rb

@@ -252,6 +252,8 @@ class WriterTest < Minitest::Test
     assert_equal(false, io.closed?)
     assert_equal(0, io.pos)
 
+
+    # Write first file
     writer = Writer.new(io, Format.new(:mono, :pcm_16, 44100))
     assert_equal(false, writer.closed?)
 
@@ -262,6 +264,36 @@ class WriterTest < Minitest::Test
 
     assert_equal(false, io.closed?)
     assert_equal(2092, io.pos)    # 44 bytes for header, plus 2 bytes per sample, with 8 * 128 samples
+
+    # Verify the first file header was written correctly
+    io.seek(0)
+    header = io.read(44).unpack("a4Va4a4VvvVVvva4V")
+    assert_equal(["RIFF", 2084, "WAVE", "fmt ", 16, 1, 1, 44100, 88200, 2, 16, "data", 2048], header)
+    io.seek(2092)
+
+
+    # Write 2nd file to same IO
+    writer = Writer.new(io, Format.new(:stereo, :float, 22050))
+    assert_equal(false, writer.closed?)
+
+    writer.write(Buffer.new(SQUARE_WAVE_CYCLE[:stereo][:float_32] * 10, Format.new(:stereo, :float_32, 44100)))
+
+    writer.close
+    assert(writer.closed?)
+
+    assert_equal(false, io.closed?)
+    assert_equal(2790, io.pos)    # 44 bytes for header, plus 2 bytes per sample, with 8 * 128 samples
+
+    # Verify the first file header was not over-written
+    io.seek(0)
+    header = io.read(44).unpack("a4Va4a4VvvVVvva4V")
+    assert_equal(["RIFF", 2084, "WAVE", "fmt ", 16, 1, 1, 44100, 88200, 2, 16, "data", 2048], header)
+
+    # Verify the 2nd file header was written in the correct location
+    io.seek(2092)
+    header = io.read(58).unpack("a4Va4a4VvvVVvvva4VVa4V")
+    assert_equal(["RIFF", 690, "WAVE", "fmt ", 18, 3, 2, 22050, 176400, 8, 32, 0, "fact", 4, 80, "data", 640], header)
+
     io.close
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefile
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Joel Strait
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-10 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies: []
 description: You can use this gem to create Ruby programs that work with audio, by
   reading and writing Wave sound files (*.wav). Since it is written in pure Ruby (as