riff 0.1 → 0.2

data/examples/maketone.rb

@@ -0,0 +1,54 @@
+# Author:: Jamie Hardt
+# maketone.rb is a simple program that creates a 
+# simple PCM WAVE file of a 1K tone and encodes some
+# metadata into it.
+
+require 'lib/riff/base.rb'
+require 'lib/riff/writer.rb'
+
+
+include Riff
+
+SAMPLES_PER_SECOND = 48000
+FREQ = 1000
+AMPLITUDE = 0x0fff
+FILE_TO_MAKE = "test.wav"
+
+Builder.create(FILE_TO_MAKE,"WAVE") do |w|
+  w.list("INFO") { |info|
+    info.chunk("ICOP") { |c| #"copyright"
+      c << "(c) 2007 Jamie Hardt. All Rights Reserved."
+    }
+    info.chunk("ICMT") {|c| # "comment"
+      c << "This file is a 1K tone generated programatically with Ruby libRiff"
+    }
+    info.chunk("INAM") {|c| # "name" or "title"
+      c<< "1K tone with metadata"
+    }
+    info.chunk("ISFT") {|c|  # "software"
+      c<< "libRiff v" + "%i.%i" % [Riff::VERSION::MAJOR, Riff::VERSION::MINOR] 
+    }
+    info.chunk("IART") {|c|  # "artist" (maps to kMDItemAuthors in Spotlight)
+      c << "Jamie Hardt"
+    }
+  }
+  w.chunk("fmt ") { |c|
+    c.putc(1);c.putc(0); #format 1, PCM
+    c.putc(1);c.putc(0) #1 channel
+    
+    # samples per second
+    int_to_four_little_endian_bytes(SAMPLES_PER_SECOND).each {|byte| c.putc(byte)}
+    
+    # avg. bytes per second
+    int_to_four_little_endian_bytes(SAMPLES_PER_SECOND * 2).each {|byte| c.putc(byte)}
+    c.putc(2);c.putc(0) #block alignment 2
+    c.putc(16);c.putc(0) #16 bits per sample
+  }
+  w.chunk("data") { |c|
+    denom = SAMPLES_PER_SECOND / (FREQ * 2)
+    0.upto(SAMPLES_PER_SECOND) do |i|
+      val = (Math::sin(Math::PI * i/denom) * AMPLITUDE).floor
+      int_to_four_little_endian_bytes(val)[0,2].each {|byte| c.putc(byte)}
+    end
+  }
+end

data/lib/riff/base.rb

@@ -60,7 +60,7 @@ module Riff
   
   module VERSION
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
   end #module version
   
   class Base
@@ -87,35 +87,6 @@ module Riff
       end
       riff_obj
     end
-
-    # Class method for called by subclasses to set-up validations.  If you
-    # write a subclass of the Riff object, say for reading AVIs, you can
-    # add validation code by calling this class method in your class like so:
-    #
-    #   class RiffAVI
-    #     
-    #     validate do |riff|
-    #        riff.root_chunk.signature == 'AVI '
-    #     end
-    #
-    #     ... class continues...
-    #   end
-    #
-    # You provide a block, which is yielded the Riff object at the time
-    # it is created, and ths block should return either +true+ or +false+.
-    # If it returns +true+, the Riff subclass instance will be created.  If 
-    # the block returns +false+, the .new class method will return nil.
-    #
-    # Subclass validation methods are called in the order of the subclasses
-    # inheiritance, so that if you wrote a broadcast-wav class that inheirited
-    # from a wave class that inheirited from Riff, Riff's validate()
-    # would be called first, and then the wave validate(), and the bwav's validate().
-    # Thus, a subclass can run its validations with the guarantee that the Riff
-    # in question passed its validations for its superclass.
-    def self.validate(&block)
-      raise ArgumentError unless block.arity == 1
-
-    end
   
     # Returns the Root Chunk of the RIFF file as a ListChunk
     def root_chunk
@@ -199,8 +170,7 @@ module Riff
   
       def each_byte
         while @file.pos < @offset + 8 + @length
-          yield @file.getc
-          @file.pos +=1
+          yield @file.getc  
         end
       end
   
@@ -280,6 +250,7 @@ module Riff
       end
     
     end #class ListChunk
+    
   end #class Riff
 
 end #module

data/lib/riff/writer.rb

@@ -0,0 +1,97 @@
+require 'stringio'
+
+module Riff
+  
+  def int_to_four_little_endian_bytes(i) # :nodoc:
+    n =i # [ i.abs , 2^32 ].min
+    [(n.to_i & 0xff) , (n.to_i & 0xff00)>>8, 
+      (n.to_i & 0xff0000)>>16,(n.to_i & 0xff000000)>>24 ]
+  end
+
+  def sanitize_fourcc(fourcc)
+    fourcc[0,4].ljust(4,"\0")
+  end
+  
+  # A Builder allows you to create a 'de novo' RIFF file.  At this time
+  # we do not support modifying RIFF files, only creating new ones.
+  class Builder
+    
+    class IOProxy
+      
+      def initialize(i)
+        @io = i
+        @startPos = i.pos
+      end
+      
+      def write(data)
+        @io.write data
+      end
+      
+      def <<(data)
+        write(data)
+      end
+      
+      def pos
+        @io.pos
+      end
+      
+      def seek(offset,whence)
+        @io.seek(offset,whence)
+      end
+      
+      def putc(c)
+        @io.putc(c)
+      end
+      
+    end #class IOProxy
+
+    class << self
+      # Create a new RIFF file at +path+, using +type+ for the top-level chunk's type or signature.
+      def create(path,type) #:yields: riff_file
+        file = File.open(path,"w")
+        w = Builder.new(file)
+        w.container('RIFF',type) do |body_io|
+          yield Builder.new(body_io)
+        end
+        file.close
+      end
+    
+    end #class << self
+    
+    attr_reader :io
+    
+    def chunk(fourcc) #:yields: stream
+      $stderr.print("descending into chunk     #{fourcc}, starts at #{@io.pos}\n")
+      @io.write(sanitize_fourcc(fourcc))
+      4.times {@io.putc(0)}
+      oldPos = @io.pos
+      yield IOProxy.new(@io)
+      length = @io.pos - oldPos
+      @io.putc(0) if (length % 2) == 1
+      @io.seek(oldPos-4,IO::SEEK_SET)
+      bytes = int_to_four_little_endian_bytes(length)
+      $stderr.print("will write bytes size: #{bytes.inspect}\n")
+      bytes.each {|byte| @io.putc(byte)}
+      @io.seek(0,IO::SEEK_END)
+      $stderr.print("ascending from chunk      #{fourcc}, total written #{length}\n")
+    end
+    
+    def list(type)
+      container("LIST",type) do |io|
+        yield Builder.new(io)
+      end
+    end
+    
+    def initialize(stream)
+      @io = stream
+    end
+    
+    def container(fourcc,type)
+      chunk(sanitize_fourcc(fourcc)) do |io|
+        io.write(sanitize_fourcc(type))
+        yield io
+      end
+    end
+  end #class Wrtier
+
+end #module Riff

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.1
 specification_version: 1
 name: riff
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2006-06-03 00:00:00 -07:00
-summary: "Library for accessing chunks of RIFF (Resource Interchange File Format) files.
-  RIFF is a meta-format which is a common wrapper for multimedia files, such as
-  .wav and .avi files."
+  version: "0.2"
+date: 2007-12-24 00:00:00 -08:00
+summary: Library for reading and writing RIFF (Resource Interchange File Format) files. RIFF is a meta-format which is a common wrapper for multimedia files, such as .wav and .avi files.
 require_paths: 
-  - lib
+- lib
 email: 
 homepage: http://riff.rubyforge.org
 rubyforge_project: riff
@@ -20,32 +18,38 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.2
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: []
+
 files: 
-  - lib/riff/base.rb
-  - lib/riff/bwav.rb
-  - lib/riff/wav.rb
-  - Rakefile
-  - test/riff_test.rb
-  - test/riff_test_suite.rb
-  - test/wav_test.rb
-  - test_media/bad.riff
-  - test_media/Pop.wav
-  - examples/example1.rb
-  - examples/example2.rb
+- lib/riff/base.rb
+- lib/riff/writer.rb
+- Rakefile
+- test/riff_test.rb
+- test/riff_test_suite.rb
+- test/wav_test.rb
+- test_media/bad.riff
+- test_media/Pop.wav
+- examples/maketone.rb
+- examples/readchunks.rb
 test_files: 
-  - test/riff_test_suite.rb
+- test/riff_test_suite.rb
 rdoc_options: []
+
 extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+

data/examples/example2.rb

@@ -1,6 +0,0 @@
-$: << "lib/"
-
-require 'riff/bwav.rb'
-
-Riff::WaveRiff.open(ARGV[0],"r").close
-puts "This file is a WAV file."

data/lib/riff/bwav.rb

@@ -1,8 +0,0 @@
-require 'riff/wav'
-
-module Riff
-  class BroadcastWave < WaveRiff
-  
-
-  end
-end

data/lib/riff/wav.rb

@@ -1,8 +0,0 @@
-require 'riff/base'
-
-module Riff
-  class WaveRiff < Riff::Base
-  
-
-  end
-end