jstrait-wavefile 0.1.0 → 0.2.0

data/README

@@ -6,13 +6,21 @@ First, install the WaveFile gem...
 
 ...and include it in your Ruby program:
 
-    require 'WaveFile'
+    require 'wavefile'
 
 To open a wave file and get the raw sample data:
 
     w = WaveFile.open("myfile.wav")
     samples = w.sample_data
 
+Sample data is stored in an array. For mono files, each sample is a single number. For stereo files, each sample is represented by an array containing a value for the left and right channel.
+
+    # Mono example
+    [0, 128, 255, 128]
+    
+    # Stereo example
+    [[0, 255], [128, 128], [255, 0], [128, 128]]
+
 You can also get the sample data in a normalized form, with each sample between -1.0 and 1.0:
 
     normalized_samples = w.normalized_sample_data
@@ -20,6 +28,8 @@ You can also get the sample data in a normalized form, with each sample between
 You can get basic metadata:
 
     w.num_channels      # 1 for mono, 2 for stereo
+    w.mono?             # Alias for num_channels == 1
+    w.stereo?           # Alias for num_channels == 2
     w.sample_rate       # 11025, 22050, 44100, etc.
     w.bits_per_sample   # 8 or 16
 
@@ -32,3 +42,9 @@ To create and save a new wave file:
     w.save("myfile.wav")
 
 When calling the sample_data=() method, the passed in array can contain either raw samples or normalized samples. If the first item in the array is a Float, the entire array is assumed to be normalized. Normalized samples are automatically converted into raw samples when saving.
+
+You can reverse a file with the reverse() method:
+
+	w = WaveFile.open("myfile.wav")
+	w.reverse()
+	w.save("myfile_reversed.wav")

data/lib/wavefile.rb

@@ -55,13 +55,19 @@ class WaveFile
   HEADER_SIZE = 36
 
   def initialize(num_channels, sample_rate, bits_per_sample, sample_data = [])
-    @num_channels = num_channels
+    if num_channels == :mono
+      @num_channels = 1
+    elsif num_channels == :stereo
+      @num_channels = 2
+    else
+      @num_channels = num_channels
+    end
     @sample_rate = sample_rate
     @bits_per_sample = bits_per_sample
     @sample_data = sample_data
     
-    @byte_rate = sample_rate * num_channels * (bits_per_sample / 8)
-    @block_align = num_channels * (bits_per_sample / 8)
+    @byte_rate = sample_rate * @num_channels * (bits_per_sample / 8)
+    @block_align = @num_channels * (bits_per_sample / 8)
   end
   
   def self.open(path)
@@ -70,6 +76,7 @@ class WaveFile
     if valid_header?(header)
       sample_data = read_sample_data(path,
                                      header[:sub_chunk1_size],
+                                     header[:num_channels],
                                      header[:bits_per_sample],
                                      header[:sub_chunk2_size])
       
@@ -78,7 +85,7 @@ class WaveFile
                            header[:bits_per_sample],
                            sample_data)
     else
-      raise StandardError, "#{path} is not a valid wave file"
+      raise StandardError, "#{path} is either not a valid wave file, or is in an unsupported format"
     end
     
     return wave_file
@@ -105,10 +112,21 @@ class WaveFile
     file_contents += [sample_data_size].pack("V")
 
     # Write the sample data
+    if !mono?
+      output_sample_data = []
+      @sample_data.each{|sample|
+        sample.each{|sub_sample|
+          output_sample_data << sub_sample
+        }
+      }
+    else
+      output_sample_data = @sample_data
+    end
+    
     if @bits_per_sample == 8
-      file_contents += @sample_data.pack("C*")
+      file_contents += output_sample_data.pack("C*")
     elsif @bits_per_sample == 16
-      file_contents += @sample_data.pack("s*")
+      file_contents += output_sample_data.pack("s*")
     else
       raise StandardError, "Bits per sample is #{@bits_per_samples}, only 8 or 16 are supported"
     end
@@ -124,34 +142,97 @@ class WaveFile
   
   def normalized_sample_data()
     if @bits_per_sample == 8
-      normalized_sample_data = @sample_data.map {|sample| (sample.to_f / 511.0) * 2.0 }
+      min_value = 128.0
+      max_value = 127.0
+      midpoint = 128
     elsif @bits_per_sample == 16
-      normalized_sample_data = @sample_data.map {|sample| (sample.to_f / 32767.0) }
+      min_value = 32768.0
+      max_value = 32767.0
+      midpoint = 0
     else
       raise StandardError, "Bits per sample is #{@bits_per_samples}, only 8 or 16 are supported"
     end
     
+    if mono?
+      normalized_sample_data = @sample_data.map {|sample|
+        sample -= midpoint
+        if sample < 0
+          sample.to_f / min_value
+        else
+          sample.to_f / max_value
+        end
+      }
+    else
+      normalized_sample_data = @sample_data.map {|sample|
+        sample.map {|sub_sample|
+          sub_sample -= midpoint
+          if sub_sample < 0
+            sub_sample.to_f / min_value
+          else
+            sub_sample.to_f / max_value
+          end
+        }
+      }
+    end
+    
     return normalized_sample_data
   end
   
   def sample_data=(sample_data)
-    if sample_data.length > 0 && sample_data[0].class == Float
+    if sample_data.length > 0 && ((mono? && sample_data[0].class == Float) ||
+                                  (!mono? && sample_data[0][0].class == Float))
       if @bits_per_sample == 8
         # Samples in 8-bit wave files are stored as a unsigned byte
-        # Effective values are 0 to 255
-        @sample_data = sample_data.map {|sample| ((sample * 127.0).to_i) + 127 }
+        # Effective values are 0 to 255, midpoint at 128
+        min_value = 128.0
+        max_value = 127.0
+        midpoint = 128
       elsif @bits_per_sample == 16
         # Samples in 16-bit wave files are stored as a signed little-endian short
-        # Effective values are -32768 to 32767
-        @sample_data = sample_data.map {|sample| (sample * 32767.0).to_i }
+        # Effective values are -32768 to 32767, midpoint at 0
+        min_value = 32768.0
+        max_value = 32767.0
+        midpoint = 0
       else
         raise StandardError, "Bits per sample is #{@bits_per_samples}, only 8 or 16 are supported"
       end
+      
+      if mono?
+        @sample_data = sample_data.map {|sample|
+          if(sample < 0.0)
+            (sample * min_value).round + midpoint
+          else
+            (sample * max_value).round + midpoint
+          end
+        }
+      else
+        @sample_data = sample_data.map {|sample|
+          sample.map {|sub_sample|
+            if(sub_sample < 0.0)
+              (sub_sample * min_value).round + midpoint
+            else
+              (sub_sample * max_value).round + midpoint
+            end
+          }
+        }
+      end
     else
       @sample_data = sample_data
     end
   end
 
+  def mono?()
+    return num_channels == 1
+  end
+  
+  def stereo?()
+    return num_channels == 2
+  end
+  
+  def reverse()
+    sample_data.reverse!()
+  end
+
   attr_reader :num_channels, :sample_rate, :bits_per_sample, :byte_rate, :block_align
   
 private
@@ -192,8 +273,8 @@ private
   def self.valid_header?(header)
     valid_bits_per_sample = header[:bits_per_sample] == 8   ||
                             header[:bits_per_sample] == 16
-                            
-    valid_num_channels = header[:num_channels] == 1 # Only mono files supported for now
+    
+    valid_num_channels = (1..65535) === header[:num_channels]
     
     return valid_bits_per_sample                    &&
            valid_num_channels                       &&
@@ -204,7 +285,7 @@ private
            header[:sub_chunk2_id] == SUB_CHUNK2_ID
   end
   
-  def self.read_sample_data(path, sub_chunk1_size, bits_per_sample, sample_data_size)
+  def self.read_sample_data(path, sub_chunk1_size, num_channels, bits_per_sample, sample_data_size)
     offset = 20 + sub_chunk1_size + 8
     file = File.open(path, "rb")
 
@@ -217,7 +298,19 @@ private
           data = file.sysread(sample_data_size).unpack("s*")
         else
           data = []
-        end 
+        end
+        
+        if(num_channels > 1)
+          multichannel_data = []
+          
+          i = 0
+          while i < data.length
+            multichannel_data << data[i..(num_channels + i)]
+            i += num_channels
+          end
+          
+          data = stereo_data
+        end
     rescue EOFError
       file.close()
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jstrait-wavefile
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Joel Strait