timecode 0.2.1 → 1.1.0

data/History.txt

@@ -1,3 +1,15 @@
+=== 1.1.0 / 2011-02-16
+
+* Added timecode with ticks support, used by CineCanvas (wolfgangw)
+
+=== 1.0.0 / 2011-02-16
+
+* After all these years we consider Timecode stable
+
+=== 0.3.0 / 2010-10-25
+
+* Let Timecode.parse and Timecode#to_s handle 24fps timecode with a plus sign (00:00:00+10)
+
 === 0.2.1 / 2010-05-11
 
 * Add Timecode#coerce and Timecode#adjacent_to?

data/Manifest.txt

@@ -1,7 +1,8 @@
+.DS_Store
 History.txt
 Manifest.txt
-README.txt
-SPECS.txt
+README.rdoc
 Rakefile
+SPECS.rdoc
 lib/timecode.rb
-test/test_timecode.rb
+test/test_timecode.rb

data/Rakefile

@@ -4,13 +4,15 @@ require './lib/timecode.rb'
 
 Hoe.spec('timecode') do |p|
   p.version = Timecode::VERSION
+  p.readme_file   = 'README.rdoc'
+  p.extra_rdoc_files  = FileList['*.rdoc']
+  
   p.developer('Julik', 'me@julik.nl')
-  p.extra_deps.reject! {|e| e[0] == 'hoe' }
-  p.extra_deps << ['test-spec', '>=0']
+  p.extra_dev_deps = {"test-spec" => ">=0"}
   p.rubyforge_name = 'guerilla-di'
   p.remote_rdoc_dir = 'timecode'
 end
 
 task "specs" do
-  `specrb test/* --rdox > SPECS.txt`
+  `specrb test/* --rdox > SPECS.rdoc`
 end

data/{SPECS.txt → SPECS.rdoc}

@@ -85,7 +85,11 @@
 
 == Timecode.parse should
 * handle complete SMPTE timecode
+* handle complete SMPTE timecode with plus for 24 frames per second
 * handle timecode with fractional seconds
+* handle timecode with ticks
+* raise when there are more than 249 ticks
+* handle timecode with fractional seconds with spaces at start and end
 * 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
@@ -109,4 +113,4 @@
 * parse from a 4x4bits packed 32bit unsigned int
 * properly convert itself back to 4x4 bits 32bit unsigned int
 
-74 specifications (118 requirements), 0 failures
+78 specifications (124 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.2.1'
+  VERSION = '1.1.0'
 
   include Comparable
   
@@ -20,14 +20,19 @@ class Timecode
   
   #:stopdoc:
   NTSC_FPS = (30.0 * 1000 / 1001).freeze
+  FILMSYNC_FPS = (24.0 * 1000 / 1001).freeze
   ALLOWED_FPS_DELTA = (0.001).freeze
   
   COMPLETE_TC_RE = /^(\d{2}):(\d{2}):(\d{2}):(\d{2})$/
+  COMPLETE_TC_RE_24 = /^(\d{2}):(\d{2}):(\d{2})\+(\d{2})$/
   DF_TC_RE = /^(\d{1,2}):(\d{1,2}):(\d{1,2});(\d{2})$/
-  FRACTIONAL_TC_RE = /^(\d{2}):(\d{2}):(\d{2}).(\d{1,8})$/
+  FRACTIONAL_TC_RE = /^(\d{2}):(\d{2}):(\d{2})\.(\d{1,8})$/
+  TICKS_TC_RE = /^(\d{2}):(\d{2}):(\d{2}):(\d{3})$/
   
   WITH_FRACTIONS_OF_SECOND = "%02d:%02d:%02d.%02d"
   WITH_FRAMES = "%02d:%02d:%02d:%02d"
+  WITH_FRAMES_24 = "%02d:%02d:%02d+%02d"
+  
   #:startdoc:
   
   # All Timecode lib errors inherit from this
@@ -76,7 +81,9 @@ class Timecode
     # * 10h 20m 10s 1f (or any combination thereof) - will be disassembled to hours, frames, seconds and so on automatically
     # * 123 - will be parsed as 00:00:01:23
     # * 00:00:00:00 - will be parsed as zero TC
-    def parse(input, with_fps = DEFAULT_FPS)
+    def parse(spaced_input, with_fps = DEFAULT_FPS)
+      input = spaced_input.strip
+      
       # Drop frame goodbye
       if (input =~ DF_TC_RE)
         raise Error, "We do not support drop-frame TC"
@@ -84,9 +91,16 @@ class Timecode
       elsif (input =~ COMPLETE_TC_RE)
         atoms_and_fps = input.scan(COMPLETE_TC_RE).to_a.flatten.map{|e| e.to_i} + [with_fps]
         return at(*atoms_and_fps)
+      # 00:00:00+00
+      elsif (input =~ COMPLETE_TC_RE_24)
+        atoms_and_fps = input.scan(COMPLETE_TC_RE_24).to_a.flatten.map{|e| e.to_i} + [24]
+        return at(*atoms_and_fps)
       # 00:00:00.0
       elsif input =~ FRACTIONAL_TC_RE
         parse_with_fractional_seconds(input, with_fps)
+      # 00:00:00:000
+      elsif input =~ TICKS_TC_RE
+        parse_with_ticks(input, with_fps)
       # 10h 20m 10s 1f 00:00:00:01 - space separated is a sum of parts
       elsif input =~ /\s/
         parts = input.gsub(/\s/, ' ').split.reject{|e| e.strip.empty? }
@@ -150,6 +164,22 @@ class Timecode
 
       parse(tc_with_frameno, fps)
     end
+
+    # Parse a timecode with ticks of a second instead of frames. A 'tick' is defined as 
+    # 4 msec and has a range of 0 to 249. This format can show up in subtitle files for digital cinema
+    # used by CineCanvas systems
+    def parse_with_ticks(tc_with_ticks, fps = DEFAULT_FPS)
+      ticks_expr = /(\d{3})$/
+      num_ticks = tc_with_ticks.scan(ticks_expr).to_s.to_i
+      
+      raise RangeError, "Invalid tick count #{num_ticks}" if num_ticks > 249
+      
+      seconds_per_frame = 1.0 / fps
+      frame_idx = ( (num_ticks * 0.004) / seconds_per_frame ).floor
+      tc_with_frameno = tc_with_ticks.gsub(ticks_expr, "%02d" % frame_idx)
+      
+      parse(tc_with_frameno, fps)
+    end
   
     # create a timecode from the number of seconds. This is how current time is supplied by
     # QuickTime and other systems which have non-frame-based timescales
@@ -248,7 +278,11 @@ class Timecode
   
   # get formatted SMPTE timecode
   def to_s
-    WITH_FRAMES % value_parts
+    if (framerate_in_delta(fps, 24))
+      WITH_FRAMES_24 % value_parts
+    else
+      WITH_FRAMES % value_parts
+    end
   end
   
   # get total frames as float
@@ -352,4 +386,4 @@ class Timecode
     @value ||= validate!
   end
   
-end
+end

data/test/test_timecode.rb

@@ -297,7 +297,7 @@ context "A Timecode used with fractional number of seconds" do
     tc.with_frames_as_fraction.should.equal "00:00:03.96"
     tc.with_fractional_seconds.should.equal "00:00:03.96"
   end
-
+  
   specify "properly translate to frames when instantiated from fractional seconds" do
     fraction = 7.1
     tc = Timecode.from_seconds(fraction, 10)
@@ -348,11 +348,44 @@ context "Timecode.parse should" do
     Timecode.parse(simple_tc).to_s.should.equal(simple_tc)
   end
   
+  specify "handle complete SMPTE timecode with plus for 24 frames per second" do
+    simple_tc = "00:10:34+10"
+    p = Timecode.parse(simple_tc)
+    p.to_s.should.equal(simple_tc)
+    p.fps.should.equal 24
+  end
+  
   specify "handle timecode with fractional seconds" do
     tc = Timecode.parse("10:10:10.2", 25)
     tc.to_s.should.equal "10:10:10:05"
   end
   
+  specify "handle timecode with ticks" do
+    tc = Timecode.parse("10:10:10:103", 25)
+    tc.to_s.should.equal "10:10:10:10"
+    
+    tc = Timecode.parse("10:10:10:249", 25)
+    tc.to_s.should.equal "10:10:10:24"
+  end
+
+  specify "raise when there are more than 249 ticks" do
+    lambda {
+      tc = Timecode.parse("10:10:10:250", 25)
+    }.should.raise(Timecode::RangeError)
+  end
+
+  specify "handle timecode with fractional seconds with spaces at start and end" do
+    tc = Timecode.parse(" 00:00:01.040 ")
+    tc.to_s.should.equal "00:00:01:01"
+  end
+  
+# I am commenting this one out for now, these were present in some odd subtitle file.
+# What we probably need is a way for Timecode to "extract" timecodes from a chunk of text.
+# specify "handle timecode with fractional seconds with weirdo UTF spaces at start and end" do
+#   tc = Timecode.parse("00:00:01.040")
+#   tc.to_s.should.equal "00:00:01:01"
+# 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)
     Timecode.parse("210").should.equal Timecode.new(60)

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: timecode
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  hash: 19
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Julik
@@ -9,39 +15,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-11 00:00:00 +02:00
+date: 2011-05-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: test-spec
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rubyforge
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.0.4
-    version: 
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.6.0
-    version: 
+        hash: 41
+        segments: 
+        - 2
+        - 9
+        - 1
+        version: 2.9.1
+  type: :development
+  version_requirements: *id002
 description: Value class for SMPTE timecode information
 email: 
 - me@julik.nl
@@ -52,16 +58,18 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
-- SPECS.txt
+- README.rdoc
+- SPECS.rdoc
 files: 
+- .DS_Store
 - History.txt
 - Manifest.txt
-- README.txt
-- SPECS.txt
+- README.rdoc
 - Rakefile
+- SPECS.rdoc
 - lib/timecode.rb
 - test/test_timecode.rb
+- .gemtest
 has_rdoc: true
 homepage: http://guerilla-di.org/timecode
 licenses: []
@@ -69,25 +77,31 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: guerilla-di
-rubygems_version: 1.3.5
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Value class for SMPTE timecode information