timecode 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.3 / 2008-12-25
+
+* Implement the format FFmpeg uses
+
 === 0.1.2 / 2008-12-25
 
 * Fix to_uint

data/lib/timecode.rb

@@ -12,7 +12,7 @@
 #     :mapping => [%w(source_tc_frames total), %w(tape_fps fps)]
 
 class Timecode
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 
   include Comparable
   
@@ -80,6 +80,10 @@ class Timecode
     end
       
     # Parse timecode entered by the user. Will raise if the string cannot be parsed.
+    # The following formats are supported:
+    # * 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)
       # Drop frame goodbye
       raise TimecodeLibError, "We do not support drop frame" if (input =~ /\;/)
@@ -141,6 +145,8 @@ class Timecode
       new(total, with_fps)
     end
     
+    # Parse a timecode with fractional seconds instead of frames. This is how ffmpeg reports
+    # a timecode
     def parse_with_fractional_seconds(tc_with_fractions_of_second, fps = DEFAULT_FPS)
       fraction_expr = /\.(\d+)$/
       fraction_part = ('.' + tc_with_fractions_of_second.scan(fraction_expr)[0][0]).to_f
@@ -153,22 +159,20 @@ class Timecode
       parse(tc_with_frameno, fps)
     end
   
-    # create a timecode from seconds. Seconds can be float (this is how current time is supplied by
-    # QuickTime and other systems which have non-frame-based timescales)
+    # 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
     def from_seconds(seconds_float, the_fps = DEFAULT_FPS)
       total_frames = (seconds_float.to_f * the_fps.to_f).ceil
       new(total_frames, the_fps)
     end
   
-    
-    # Some systems (like SGIs) and DPX format store timecode as unsigned integer, bit-packed
+    # Some systems (like SGIs) and DPX format store timecode as unsigned integer, bit-packed. This method
+    # unpacks such an integer into a timecode.
     def from_uint(uint, fps = DEFAULT_FPS)
-      shift = 4 * TIME_FIELDS
-      tc_elements = (0..TIME_FIELDS).map do 
-        part = ((uint >> shift) & 0x0F)
-        shift -= 4
-        part
+      tc_elements = (0..7).to_a.reverse.map do | multiplier | 
+        ((uint >> (multiplier * 4)) & 0x0F)
       end.join.scan(/(\d{2})/).flatten.map{|e| e.to_i}
+
       tc_elements << fps
       at(*tc_elements)
     end
@@ -296,6 +300,16 @@ class Timecode
     end
   end
   
+  # FFmpeg expects a fraction of a second as the last element instead of number of frames. Use this
+  # method to get the timecode that adheres to that expectation. The return of this method can be fed
+  # to ffmpeg directly.
+  #  Timecode.parse("00:00:10:24", 25).with_frames_as_fraction #=> "00:00:10.96"
+  def with_frames_as_fraction
+    vp = value_parts.dup
+    vp[-1] = (100.0 / @fps) * vp[-1]
+    "%02d:%02d:%02d.%02d" % vp
+  end
+  alias_method :with_fractional_seconds, :with_frames_as_fraction
   
   # Validate that framerates are within a small delta deviation considerable for floats
   def framerate_in_delta(one, two)

data/test/test_timecode.rb

@@ -88,6 +88,19 @@ class TimecodeTest < Test::Unit::TestCase
     a, b = Timecode.new(24, 25.000000000000001), Timecode.new(22, 25.000000000000002)
     assert_equal Timecode.new(24 + 22, 25.000000000000001), (a + b)
   end
+  
+  def test_tc_with_frames_as_fraction
+    tc = Timecode.new(100 -1, fps = 25)
+    assert_equal 24, tc.frames
+    assert_equal "00:00:03.96", tc.with_frames_as_fraction
+    assert_equal "00:00:03.96", tc.with_fractional_seconds
+  end
+  
+  def test_float_framerate
+    tc = Timecode.new(25, 12.5)
+    assert_equal "00:00:02:00", tc.to_s
+  end
+  
 end
 
 class TestParsing < Test::Unit::TestCase
@@ -142,11 +155,6 @@ class TestParsing < Test::Unit::TestCase
     assert_equal '01:00:01:04', Timecode.parse("29f 1h").to_s
   end
   
-  def test_float_framerate
-    tc = Timecode.new(25, 12.5)
-    assert_equal "00:00:02:00", tc.to_s
-  end
-  
   def test_parse_fractional_tc
     fraction = "00:00:07.1"
     tc = Timecode.parse_with_fractional_seconds(fraction, 10)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: timecode
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Julik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-25 00:00:00 +01:00
+date: 2008-12-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency