julik-timecode 0.1.7 → 0.1.8

data/History.txt

@@ -1,4 +1,10 @@
-=== 0.1.6 / 2009-01-31
+=== 0.1.8 / 2009-01-31
+
+* Bail out with empty or whitespace strings passed to Timecode.parse
+* Add Timecode#to_seconds that returns a float value (useful for Quicktime)
+* Move the validation routine into the class itself
+
+=== 0.1.7 / 2009-01-31
 
 * Simplified parsing code, more safeguards and needless exceptions removed
 

data/SPECS.txt

@@ -1,11 +1,18 @@
 
-== Timecode.new() should
+== Timecode.new should
 * instantiate from int
 * always coerce FPS to float
 * create a zero TC with no arguments
 * accept full string SMPTE timecode as well
 
-== Timecode.at() should
+== Timecode.validate_atoms! should
+* disallow more than 99 hrs
+* disallow more than 59 minutes
+* disallow more than 59 seconds
+* disallow more frames than what the framerate permits
+* pass validation with usable values
+
+== Timecode.at should
 * disallow more than 99 hrs
 * disallow more than 59 minutes
 * disallow more than 59 seconds
@@ -30,6 +37,10 @@
 == A Timecode of zero should
 * properly respond to zero?
 
+== Timecode#to_seconds should
+* return a float
+* return the value in seconds
+
 == An existing Timecode on inspection should
 * properly present himself via inspect
 * properly print itself
@@ -64,8 +75,6 @@
 
 == Timecode.parse should
 * handle complete SMPTE timecode
-* handle complete SMPTE timecode via new
-* refuse to handle timecode that is out of range for the framerate
 * parse a row of numbers as parts of a timecode starting from the right
 * parse a number with f suffix as frames
 * parse a number with s suffix as seconds
@@ -78,6 +87,7 @@
 * parse timecode with fractional second instead of frames
 * raise when trying to parse DF timecode
 * raise on improper format
+* raise on empty argument
 
 == Timecode.soft_parse should
 * parse the timecode
@@ -87,4 +97,4 @@
 * parse from a 4x4bits packed 32bit unsigned int
 * properly convert itself back to 4x4 bits 32bit unsigned int
 
-60 specifications (101 requirements), 0 failures
+66 specifications (109 requirements), 0 failures

data/lib/timecode.rb

@@ -12,7 +12,7 @@
 #     :mapping => [%w(source_tc_frames total), %w(tape_fps fps)]
 
 class Timecode
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 
   include Comparable
   
@@ -78,13 +78,13 @@ class Timecode
     # * 00:00:00:00 - will be parsed as zero TC
     def parse(input, with_fps = DEFAULT_FPS)
       # Drop frame goodbye
-      raise Error, "We do not support drop frame" if (input =~ DF_TC_RE)
-      
-      hrs, mins, secs, frames = 0,0,0,0
-      atoms = []
-      
+      if (input =~ DF_TC_RE)
+        raise Error, "We do not support drop-frame TC"
+      # No empty values
+      elsif (input =~ /A(\s+)Z/)
+        raise CannotParse, "Empty timecode"
       # 00:00:00:00
-      if (input =~ COMPLETE_TC_RE)
+      elsif (input =~ COMPLETE_TC_RE)
         atoms_and_fps = input.scan(COMPLETE_TC_RE).to_a.flatten.map{|e| Integer(e)} + [with_fps]
         return at(*atoms_and_fps)
       # 00:00:00.0
@@ -92,7 +92,9 @@ class Timecode
         parse_with_fractional_seconds(input, with_fps)
       # 10h 20m 10s 1f 00:00:00:01 - space separated is a sum of parts
       elsif input =~ /\s/
-        return input.split.map{|part|  parse(part, with_fps) }.inject { |sum, p| sum + p.total }
+        parts = input.gsub(/\s/, ' ').split.reject{|e| e.strip.empty? }
+        raise CannotParse, "No atoms" if parts.empty?
+        parts.map{|part|  parse(part, with_fps) }.inject{|sum, p| sum + p.total }
       # 10s
       elsif input =~ /^(\d+)s$/
         return new(input.to_i * with_fps, with_fps)
@@ -119,6 +121,13 @@ class Timecode
     
     # Initialize a Timecode object at this specfic timecode
     def at(hrs, mins, secs, frames, with_fps = DEFAULT_FPS)
+      validate_atoms!(hrs, mins, secs, frames, with_fps)
+      total = (hrs*(60*60*with_fps) +  mins*(60*with_fps) + secs*with_fps + frames).round
+      new(total, with_fps)
+    end
+    
+    # Validate the passed atoms for the concrete framerate
+    def validate_atoms!(hrs, mins, secs, frames, with_fps)
       case true
         when hrs > 99
           raise RangeError, "There can be no more than 99 hours, got #{hrs}"
@@ -129,9 +138,6 @@ class Timecode
         when frames > (with_fps -1)
           raise RangeError, "There can be no more than #{with_fps -1} frames @#{with_fps}, got #{frames}"
       end
-    
-      total = (hrs*(60*60*with_fps) +  mins*(60*with_fps) + secs*with_fps + frames).round
-      new(total, with_fps)
     end
     
     # Parse a timecode with fractional seconds instead of frames. This is how ffmpeg reports
@@ -217,6 +223,11 @@ class Timecode
     uint
   end
   
+  # get the timecode as a floating-point number of seconds (used in Quicktime)
+  def to_seconds
+    (@total / @fps)
+  end
+  
   # Convert to different framerate based on the total frames. Therefore,
   # 1 second of PAL video will convert to 25 frames of NTSC (this 
   # is suitable for PAL to film TC conversions and back).
@@ -305,7 +316,7 @@ class Timecode
   
   private
   
-  # Formats the actual timecode output from the number of frames
+  # Prepare and format the values for TC output
   def validate!
     frames = @total
     secs = (@total.to_f/@fps).floor
@@ -314,12 +325,9 @@ class Timecode
     secs -= (mins*60)
     hrs = (mins/60).floor
     mins-= (hrs*60)
-  
-    raise RangeError, "Timecode cannot be longer that 99 hrs" if hrs > 99 
-    raise RangeError, "More than 59 minutes" if mins > 59 
-    raise RangeError, "More than 59 seconds" if secs > 59
-    raise RangeError, "More than #{@fps.to_s} frames (#{frames}) in the last second" if frames >= @fps
-  
+
+    self.class.validate_atoms!(hrs, mins, secs, frames, @fps)
+
     [hrs, mins, secs, frames]
   end
   

data/test/test_timecode.rb

@@ -5,7 +5,7 @@ require 'test/spec'
 require File.dirname(__FILE__) + '/../lib/timecode'
 
 
-context "Timecode.new() should" do
+context "Timecode.new should" do
   
   specify "instantiate from int" do
     tc = Timecode.new(10)
@@ -25,9 +25,35 @@ context "Timecode.new() should" do
   specify "accept full string SMPTE timecode as well" do
     Timecode.new("00:25:30:10", 25).should.equal Timecode.parse("00:25:30:10")
   end
+  
+end
+
+context "Timecode.validate_atoms! should" do 
+  
+  specify "disallow more than 99 hrs" do
+    lambda{ Timecode.validate_atoms!(99,0,0,0, 25) }.should.not.raise
+    lambda{ Timecode.validate_atoms!(100,0,0,0, 25) }.should.raise(Timecode::RangeError)
+  end
+  
+  specify "disallow more than 59 minutes" do
+    lambda{ Timecode.validate_atoms!(1,60,0,0, 25) }.should.raise(Timecode::RangeError)
+  end
+
+  specify "disallow more than 59 seconds" do
+    lambda{ Timecode.validate_atoms!(1,0,60,0, 25) }.should.raise(Timecode::RangeError)
+  end
+  
+  specify "disallow more frames than what the framerate permits" do
+    lambda{ Timecode.validate_atoms!(1,0,60,25, 25) }.should.raise(Timecode::RangeError)
+    lambda{ Timecode.validate_atoms!(1,0,60,32, 30) }.should.raise(Timecode::RangeError)
+  end
+  
+  specify "pass validation with usable values" do
+    lambda{ Timecode.validate_atoms!(20, 20, 10, 5, 25)}.should.not.raise
+  end
 end
 
-context "Timecode.at() should" do 
+context "Timecode.at should" do 
   
   specify "disallow more than 99 hrs" do
     lambda{ Timecode.at(99,0,0,0) }.should.not.raise
@@ -130,6 +156,18 @@ context "A Timecode of zero should" do
   end
 end
 
+context "Timecode#to_seconds should" do
+  specify "return a float" do
+    Timecode.new(0).to_seconds.should.be.kind_of Float
+  end
+  
+  specify "return the value in seconds" do
+    fps = 24
+    secs = 126.3
+    Timecode.new(fps * secs, fps).to_seconds.should.be.close 126.3, 0.1
+  end
+end
+
 context "An existing Timecode on inspection should" do
   specify "properly present himself via inspect" do
     Timecode.new(10, 25).inspect.should.equal "#<Timecode:00:00:00:10 (10F@25.00)>"
@@ -271,16 +309,6 @@ context "Timecode.parse should" do
     simple_tc = "00:10:34:10"
     Timecode.parse(simple_tc).to_s.should.equal(simple_tc)
   end
-
-  specify "handle complete SMPTE timecode via new" do
-    simple_tc = "00:10:34:10"
-    Timecode.new(simple_tc).to_s.should.equal(simple_tc)
-  end
-  
-  specify "refuse to handle timecode that is out of range for the framerate" do
-    bad_tc = "00:76:89:30"
-    lambda { Timecode.parse(bad_tc, 25) }.should.raise(Timecode::RangeError)
-  end
   
   specify "parse a row of numbers as parts of a timecode starting from the right" do
     Timecode.parse("10").should.equal Timecode.new(10)
@@ -354,6 +382,9 @@ context "Timecode.parse should" do
     lambda { Timecode.parse("", 25) }.should.raise Timecode::CannotParse
   end
   
+  specify "raise on empty argument" do
+    lambda { Timecode.parse("   \n\n  ", 25) }.should.raise Timecode::CannotParse
+  end
 end
 
 context "Timecode.soft_parse should" do

data/timecode.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{timecode}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: julik-timecode
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Julik