ogginfo-rb 0.0.2 → 0.0.3

data/lib/ogginfo-rb.rb

@@ -1,19 +1,26 @@
-# Useful sites:
-# http://en.wikipedia.org/wiki/Ogg#Page_structure
-# http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-600004.2
+# This code is distributed under the terms of the Ruby license.
+# See README for information on using ogginfo-rb.
 
 require 'stringio'
 
 module Ogg
+  # See README for usage information.
   class Info
     attr_reader :comments
     attr_reader :duration, :sample_rate, :nominal_bitrate, :channels, :bitrate
 
     def initialize path
+      raise ArgumentError.new "Argument is not a string" unless path.respond_to? :to_str
+      
+      raise Ogg::ReadError.new "File does not exist" unless File.exists? path
       file = File.new(path.to_str, 'rb')
+      raise Ogg::ReadError.new "File is empty" if file.stat.size == 0
+      
+      first_page = Page.find_page(file)
+      raise Ogg::ReadError.new "File does not contain valid Ogg data" unless first_page
 
       # Identification header
-      id_packet = Vorbis::IdentificationHeaderPacket.new(Page.find_page(file))
+      id_packet = Vorbis::IdentificationHeaderPacket.new(first_page)
       @sample_rate = id_packet.audio_sample_rate
       @nominal_bitrate = id_packet.bitrate_nominal
       @channels = id_packet.audio_channels
@@ -39,6 +46,8 @@ module Ogg
       file.close
     end
 
+    # Get information about the Ogg file at the path specified. An Ogg::Info
+    # object is returned and also passed to the block if one is provided.
     def self.open(path)
       info = Ogg::Info.new(path)
       yield info if block_given?
@@ -47,19 +56,33 @@ module Ogg
 
     private
     def calculate_duration file
-      # This seek is a dirty performance hack (saves reading whole file)
-      file.seek(-5000, IO::SEEK_END)
+      if file.stat.size > 5000
+        # This seek is a dirty performance hack (saves reading whole file)
+        file.seek(-5000, IO::SEEK_END)
+      else
+        file.rewind
+      end
+      
       # Find last page
       pg = page = Page.find_page(file)
       while pg
         page = pg
         pg = pg.next_page
       end
-      # Duration is last granule position divided by sample right
+      
+      # Duration is last granule position divided by sample rate
       return page.granule_position.to_f / @sample_rate
     end
   end
 
+  # This is a superclass for all custom defined Ogg errors
+  class Error < StandardError
+  end
+  
+  # This error is raised when there is a problem reading the file
+  class ReadError < Error
+  end
+
   class Page
     CAPTURE = 'OggS'
 
@@ -129,11 +152,14 @@ module Ogg
       return @last_page.next_page
     end
   end
-
+  
+  # This module specifies packets typically found in Vorbis audio files.
   module Vorbis
-    attr_reader :packet_type
-
+    # This class forms a basis for other Vorbis header packets.
+    # See http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-610004.2.1
     class HeaderPacket < Ogg::Packet
+      attr_reader :packet_type
+      
       def initialize page
         super
 
@@ -144,7 +170,8 @@ module Ogg
         end
       end
     end
-
+    
+    # See http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-620004.2.2
     class IdentificationHeaderPacket < HeaderPacket
       attr_reader :vorbis_version, :audio_channels, :audio_sample_rate
       attr_reader :bitrate_maximum, :bitrate_nominal, :bitrate_minimum
@@ -161,7 +188,8 @@ module Ogg
         blocksizes = @data.read(1).unpack('C').first
       end
     end
-
+    
+    # See http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.3
     class CommentHeaderPacket < HeaderPacket
       attr_reader :comments, :vendor_string
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ogginfo-rb
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Aiden Nibali