fps-timecode 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bee6909b4895c0ae50ca281054110e484471dfecbf2aae6f2039f95d07064c0d
-  data.tar.gz: 0a73524f38e44d6c71cab41602fd20907462427524d16d07b6e08129df51fad7
+  metadata.gz: 498b16edd03cf2f17e81c5fd10cbf2e4bb2f3e06ca0106a89c9ca2e622edb956
+  data.tar.gz: 9424a42bb0c1b461b5a830f45a63e0bca07ad6ea233cdf000beb3ae5c6df1e0e
 SHA512:
-  metadata.gz: fb3d21965488524acb71f3f0ffca6c6326f0a224204eaf0f250152878a01e6bfa1c8c16a9a1e906b7b8c49c620bd595ba620672acee1af292ce039709f2deb9d
-  data.tar.gz: 8aceab438ede0db64ab92a6b5266a4f8a827f3e3199660c10df4cb58da10b362a6a1a5da43b0f030a2db23023ead8683729daa89be11fa40b15b0c4b75606614
+  metadata.gz: edb1706e09d57528482fb0e917e068737e8b8b58adb1b3d2775a4c6c2701b7658d3b0c99e403ede8b36738ee8518ba03df31489914a5d8f3b98903b8f3711081
+  data.tar.gz: e1c3f57b40a82c1806a7e807494c3ff4f58b8babbc3e3101ff5f3f9d35fd5e1df5be1c832f4d10b3ff6eb04d47d52ca8b1fcab72aadabccb6d559659f24ed760

data/doc/FPS/Timecode.html

@@ -101,7 +101,45 @@
 
   <section class="description">
     
-<p>Since there are many class methods, often there is no need to create  an
+<p>The Focal Point Systems timecode library has two main purposes.</p>
+<ul><li>
+<p>1.) Given the timecode address of the first frame of a sequence of frames,
+and given n, what is the timecode address of the nth frame of a sequence?</p>
+</li><li>
+<p>2.) Given the timecode address of the first frame of a sequence, and given
+the timecode address for the nth frame of the sequence,  what is n?</p>
+</li></ul>
+
+<p>Example 1.  A non-drop-frame 30 fps sequence starts at 00:01:00:00.  What
+is the timecode address of the 100th frame of the sequence? <a
+href="Timecode.html#method-c-count_to_string">::count_to_string</a>(:fps_30_ndf,
+<a
+href="Timecode.html#method-c-string_to_count">::string_to_count</a>(:fps_30_ndf,“00:01:00:00”)
++ 100)  =&gt; “00:01:03:10”</p>
+
+<p>Example 2.  A non-drop-frame 30 fps sequence starts at 00:01:00:00. What is
+n for the frame with the address 00:01:03:10? <a
+href="Timecode.html#method-c-string_to_count">::string_to_count</a>(:fps_30_ndf,“00:01:03:10”)
+- <a
+href="Timecode.html#method-c-string_to_count">::string_to_count</a>(:fps_30_ndf,“00:01:00:00”)
+=&gt; 100</p>
+
+<p>An instance of the <a href="Timecode.html">Timecode</a> class represents
+one timecode address. A timecode mode is always required to be given.  The
+mode determines the frame rate and the dropness (drop-frame or
+non-drop-frame) of the timecode address. The mode must be one of
+Timecode::Counts.keys.  E.g. :fps_24, :fps_25, :fps_30_df, :fps_30_ndf</p>
+
+<p>Create an instance of a <a href="Timecode.html">Timecode</a> using either a
+string in the format “xx:xx:xx:xx” or a frame count.  The frame count
+represents n for the nth frame of a sequence that begins with timecode
+address “00:00:00:00” (the zeroeth frame of the sequence).</p>
+
+<p>When creating a timecode instance, the default is to use the string
+argument ignoring the frame count argument and falling back to using the
+frame count argument if the string is invalid.</p>
+
+<p>Since there are many class methods, often there is no need to create an
 instance of class <a href="Timecode.html">Timecode</a>.</p>
 
   </section>
@@ -199,16 +237,15 @@ instance of class <a href="Timecode.html">Timecode</a>.</p>
 
         <div class="method-description">
           
-          <p><a href="Timecode.html#method-c-count_to_string">::count_to_string</a></p>
-
-<p>Class method to compute a string from a frame count</p>
+          <p><a href="Timecode.html#method-c-count_to_string">::count_to_string</a>
+Class method to produce a timecode string from a frame count</p>
           
           
 
           
           <div class="method-source-code" id="count_to_string-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 57</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">count_to_string</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_count</span>, <span class="ruby-identifier">duration</span> = <span class="ruby-keyword">false</span>) 
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 56</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">count_to_string</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_count</span>, <span class="ruby-identifier">duration</span> = <span class="ruby-keyword">false</span>)
   <span class="ruby-identifier">tc_count</span> = <span class="ruby-constant">Timecode</span>.<span class="ruby-identifier">normalize</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_count</span>)
 
   <span class="ruby-identifier">counts</span> = <span class="ruby-constant">Counts</span>[<span class="ruby-identifier">tc_mode</span>]
@@ -218,7 +255,7 @@ instance of class <a href="Timecode.html">Timecode</a>.</p>
   <span class="ruby-identifier">rem</span> = <span class="ruby-identifier">rem</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">counts</span>[<span class="ruby-value">:fptm</span>]
   <span class="ruby-identifier">units_mins</span> = <span class="ruby-identifier">rem</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">counts</span>[<span class="ruby-value">:fpm</span>]
   <span class="ruby-identifier">rem</span> = <span class="ruby-identifier">rem</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">counts</span>[<span class="ruby-value">:fpm</span>]
-  
+
   <span class="ruby-keyword">if</span>(<span class="ruby-identifier">duration</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>)  <span class="ruby-comment"># not a duration, do drop-frame processing</span>
       <span class="ruby-comment"># handle 30 fps drop frame</span>
       <span class="ruby-keyword">if</span>(<span class="ruby-identifier">tc_mode</span> <span class="ruby-operator">==</span> <span class="ruby-value">:fps_30_df</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">units_mins</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">rem</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-value">1</span>)
@@ -231,10 +268,10 @@ instance of class <a href="Timecode.html">Timecode</a>.</p>
         <span class="ruby-identifier">rem</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">counts</span>[<span class="ruby-value">:fpm</span>]
       <span class="ruby-keyword">end</span>
   <span class="ruby-keyword">end</span>
-  
+
   <span class="ruby-identifier">secs</span> = <span class="ruby-identifier">rem</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">counts</span>[<span class="ruby-value">:fps</span>]
   <span class="ruby-identifier">frms</span> = <span class="ruby-identifier">rem</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">counts</span>[<span class="ruby-value">:fps</span>]
-  
+
   <span class="ruby-string">&quot;%02d:%d%d:%02d:%02d&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">hours</span>, <span class="ruby-identifier">tens_mins</span>, <span class="ruby-identifier">units_mins</span>, <span class="ruby-identifier">secs</span>, <span class="ruby-identifier">frms</span>]
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -260,15 +297,18 @@ instance of class <a href="Timecode.html">Timecode</a>.</p>
 
         <div class="method-description">
           
-          <p>initialize Construct a new instance of <a
-href="Timecode.html">Timecode</a>, given a mode and either a  timecode
-string or a frame count. Raises ArgumentError</p>
+          <p>initialize</p>
+
+<p>Construct a new instance of <a href="Timecode.html">FPS::Timecode</a>,
+given a mode and either a timecode string or a frame count.</p>
+
+<p>Raises ArgumentError</p>
           
           
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 140</span>
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 150</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_string</span>, <span class="ruby-identifier">tc_count</span> = <span class="ruby-keyword">nil</span>)
   <span class="ruby-comment"># tc_string and tc_count cannot both be nil</span>
   <span class="ruby-keyword">if</span>(<span class="ruby-identifier">tc_string</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">tc_count</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">nil</span>)
@@ -278,9 +318,9 @@ string or a frame count. Raises ArgumentError</p>
   <span class="ruby-keyword">unless</span> <span class="ruby-constant">Counts</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">tc_mode</span>)
     <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,  <span class="ruby-string">&quot;invalid timecode mode&quot;</span>
   <span class="ruby-keyword">end</span>
-  
+
   <span class="ruby-ivar">@tc_mode</span> = <span class="ruby-identifier">tc_mode</span>
- 
+
   <span class="ruby-comment"># Try to use the string to construct the instance and fall back</span>
   <span class="ruby-comment"># to the count if an exception is raised</span>
   <span class="ruby-keyword">begin</span>
@@ -290,7 +330,7 @@ string or a frame count. Raises ArgumentError</p>
   <span class="ruby-keyword">rescue</span>
     <span class="ruby-ivar">@tc_count</span> = <span class="ruby-constant">Timecode</span>.<span class="ruby-identifier">normalize</span>(<span class="ruby-ivar">@tc_mode</span>, <span class="ruby-identifier">tc_count</span>)
     <span class="ruby-ivar">@tc_string</span> = <span class="ruby-constant">Timecode</span>.<span class="ruby-identifier">count_to_string</span>(<span class="ruby-ivar">@tc_mode</span>, <span class="ruby-ivar">@tc_count</span>)
-  <span class="ruby-keyword">end</span>        
+  <span class="ruby-keyword">end</span>
 
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -316,21 +356,21 @@ string or a frame count. Raises ArgumentError</p>
 
         <div class="method-description">
           
-          <p>Class method to normalize a frame count &gt;= 0 and &lt; 24h Correct 24
+          <p>Class method to normalize a frame count &gt;= 0 and &lt; 24h. Corrects 24
 hour overflow or underflow</p>
           
           
 
           
           <div class="method-source-code" id="normalize-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 113</span>
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 112</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">normalize</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_count</span>)
   <span class="ruby-comment"># tc_mode must be given and must be one of the known tc modes</span>
   <span class="ruby-keyword">unless</span> <span class="ruby-constant">Counts</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">tc_mode</span>)
     <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,  <span class="ruby-string">&quot;invalid timecode mode&quot;</span>
   <span class="ruby-keyword">end</span>
 
-  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tc_count</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Fixnum</span> 
+  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tc_count</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Fixnum</span>
     <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">&quot;invalid frame count #{tc_count}&quot;</span>
   <span class="ruby-keyword">end</span>
   <span class="ruby-comment"># normalize to 24 hours</span>
@@ -362,17 +402,23 @@ hour overflow or underflow</p>
 
         <div class="method-description">
           
-          <p>Class method to compute a string as a duration from a frame <a
-href="Timecode.html#method-c-count_to_string">::count_to_string</a></p>
+          <p>Class method to produce a timecode string as a duration from a frame count
+The difference of two timecodes might be used as a duration. For non-drop
+frame, the duration string does not differ from the string as a timecode
+address.  But for drop-frame, timecodes that don&#39;t exist as an address
+can exist as a duration. One minute in drop frame is 1798 frames or
+00:00:59:28. “00:01:00:00” as a drop-frame timecode address does not exist.
+But the difference between 00:01:59:28 and 00:00:59:28 should be displayed
+as “00:01:00:00” – one minute.</p>
           
           
 
           
           <div class="method-source-code" id="string_as_duration-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 130</span>
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 138</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">string_as_duration</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_count</span>)
-  <span class="ruby-constant">Timecode</span>.<span class="ruby-identifier">count_to_string</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_count</span>, <span class="ruby-keyword">true</span>)
-<span class="ruby-keyword">end</span></pre>
+   <span class="ruby-constant">Timecode</span>.<span class="ruby-identifier">count_to_string</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_count</span>, <span class="ruby-keyword">true</span>)
+ <span class="ruby-keyword">end</span></pre>
           </div>
           
         </div>
@@ -397,18 +443,18 @@ href="Timecode.html#method-c-count_to_string">::count_to_string</a></p>
         <div class="method-description">
           
           <p><a href="Timecode.html#method-c-string_to_count">::string_to_count</a>
-Class method to compute a count from a string</p>
+Class method to compute a frame count from a timecode string</p>
           
           
 
           
           <div class="method-source-code" id="string_to_count-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 89</span>
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 88</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">string_to_count</span>(<span class="ruby-identifier">tc_mode</span>, <span class="ruby-identifier">tc_string</span>)
   <span class="ruby-keyword">unless</span> <span class="ruby-constant">Counts</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">tc_mode</span>)
     <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,  <span class="ruby-string">&quot;invalid timecode mode&quot;</span>
   <span class="ruby-keyword">end</span>
-  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tc_string</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span> 
+  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tc_string</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
     <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;invalid timecode string&quot;</span>
   <span class="ruby-keyword">end</span>
   <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tc_string</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\A(\d{2})[:;.](\d{2})[:;.](\d{2})[:;.](\d{2})\Z/</span>
@@ -456,13 +502,13 @@ Class method to compute a count from a string</p>
 
         <div class="method-description">
           
-          <p>compare two timecodes comparison (spaceship) operator does string compare</p>
+          <p>Compare two timecodes. Comparison (spaceship) operator does string compare</p>
           
           
 
           
           <div class="method-source-code" id="3C-3D-3E-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 195</span>
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 196</span>
 <span class="ruby-keyword">def</span> <span class="ruby-operator">&lt;=&gt;</span>(<span class="ruby-identifier">other</span>)
   <span class="ruby-ivar">@tc_string</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">tc_string</span>
 <span class="ruby-keyword">end</span></pre>
@@ -489,16 +535,15 @@ Class method to compute a count from a string</p>
 
         <div class="method-description">
           
-          <p>compare two timecodes for equality</p>
-
-<p>equality operator does string compare two timecodes may be considered equal
-even though their modes and counts may be different.</p>
+          <p>Compare two timecodes for equality. Equality operator does string
+comparison. Two timecodes may be considered equal even though their modes
+and counts may be different.</p>
           
           
 
           
           <div class="method-source-code" id="3D-3D-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 189</span>
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 190</span>
 <span class="ruby-keyword">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">other</span>)
   <span class="ruby-ivar">@tc_string</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">tc_string</span>
 <span class="ruby-keyword">end</span></pre>
@@ -527,19 +572,13 @@ even though their modes and counts may be different.</p>
           
           <p><a
 href="Timecode.html#method-c-string_as_duration">::string_as_duration</a>
-The difference of two timecodes might be used as a duration. For non-drop
-frame, the duration string does not differ from the string as a timecode
-address.  But for drop-frame, timecodes  that don&#39;t exist as an address
-can exist as a duration. One minute in drop frame is 1798 frames or
-00:00:59:28. “00:01:00:00” as a drop-frame timecode address does not exist.
-But the difference between 00:01:59:28 and 00:00:59:28 should be displayed
-as “00:01:00:00” – one minute.</p>
+instance method</p>
           
           
 
           
           <div class="method-source-code" id="string_as_duration-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 175</span>
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 177</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">string_as_duration</span>
   <span class="ruby-constant">Timecode</span>.<span class="ruby-identifier">string_as_duration</span>(<span class="ruby-ivar">@tc_mode</span>, <span class="ruby-ivar">@tc_count</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -566,13 +605,13 @@ as “00:01:00:00” – one minute.</p>
 
         <div class="method-description">
           
-          <p>succ return the next timecode address in the sequence</p>
+          <p>Return the next timecode address in the sequence</p>
           
           
 
           
           <div class="method-source-code" id="succ-source">
-            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 181</span>
+            <pre><span class="ruby-comment"># File lib/fps-timecode.rb, line 182</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">succ</span>
   <span class="ruby-constant">Timecode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@tc_mode</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-ivar">@tc_count</span><span class="ruby-operator">+</span><span class="ruby-value">1</span>)
 <span class="ruby-keyword">end</span></pre>

data/doc/created.rid

@@ -1,5 +1,5 @@
-Mon, 29 Jan 2018 15:35:51 -0800
+Sat, 03 Feb 2018 13:50:01 -0800
 ./test/test_fps-timecode.rb	Mon, 29 Jan 2018 14:20:36 -0800
 ./fps-timecode.gemspec	Mon, 29 Jan 2018 14:25:07 -0800
-./lib/fps-timecode.rb	Mon, 29 Jan 2018 15:27:35 -0800
-./fps-timecode-0.0.3.gem	Mon, 29 Jan 2018 15:35:08 -0800
+./lib/fps-timecode.rb	Sat, 03 Feb 2018 13:49:54 -0800
+./fps-timecode-0.0.3.gem	Mon, 29 Jan 2018 15:36:06 -0800

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["fps","timecode","testfpstimecode","<=>()","==()","count_to_string()","new()","normalize()","string_as_duration()","string_as_duration()","string_to_count()","succ()","test_class_methods()","test_comparison_works_on_strings_regardless_of_counts()","test_create_count_if_given_must_be_fixnum()","test_create_counts_greater_than_24_hours_will_be_normalized()","test_create_fall_back_to_count_when_string_is_invalid()","test_create_legally_doesnt_fail()","test_create_must_have_valid_tc_mode()","test_create_negative_counts_will_be_normalized()","test_create_nonexistent_drop_frame_times_will_be_corrected()","test_create_string_all_fields_must_be_within_bounds()","test_create_string_and_count_cannot_both_be_nil()","test_create_string_must_be_valid_if_no_count_given()","test_create_use_string_by_default()","test_dropframe_string_as_duration()","test_succ()","fps-timecode.gemspec"],"longSearchIndex":["fps","fps::timecode","testfpstimecode","fps::timecode#<=>()","fps::timecode#==()","fps::timecode::count_to_string()","fps::timecode::new()","fps::timecode::normalize()","fps::timecode::string_as_duration()","fps::timecode#string_as_duration()","fps::timecode::string_to_count()","fps::timecode#succ()","testfpstimecode#test_class_methods()","testfpstimecode#test_comparison_works_on_strings_regardless_of_counts()","testfpstimecode#test_create_count_if_given_must_be_fixnum()","testfpstimecode#test_create_counts_greater_than_24_hours_will_be_normalized()","testfpstimecode#test_create_fall_back_to_count_when_string_is_invalid()","testfpstimecode#test_create_legally_doesnt_fail()","testfpstimecode#test_create_must_have_valid_tc_mode()","testfpstimecode#test_create_negative_counts_will_be_normalized()","testfpstimecode#test_create_nonexistent_drop_frame_times_will_be_corrected()","testfpstimecode#test_create_string_all_fields_must_be_within_bounds()","testfpstimecode#test_create_string_and_count_cannot_both_be_nil()","testfpstimecode#test_create_string_must_be_valid_if_no_count_given()","testfpstimecode#test_create_use_string_by_default()","testfpstimecode#test_dropframe_string_as_duration()","testfpstimecode#test_succ()",""],"info":[["FPS","","FPS.html","","<p>Timecode library Implements Timecode class Version 0.0.2\n<p>Author: Loran Kary Copyright 2013 Focal Point …\n"],["FPS::Timecode","","FPS/Timecode.html","","<p>Since there are many class methods, often there is no need to create  an\ninstance of class Timecode. …\n"],["TestFpsTimecode","","TestFpsTimecode.html","",""],["<=>","FPS::Timecode","FPS/Timecode.html#method-i-3C-3D-3E","(other)","<p>compare two timecodes comparison (spaceship) operator does string compare\n"],["==","FPS::Timecode","FPS/Timecode.html#method-i-3D-3D","(other)","<p>compare two timecodes for equality\n<p>equality operator does string compare two timecodes may be considered …\n"],["count_to_string","FPS::Timecode","FPS/Timecode.html#method-c-count_to_string","(tc_mode, tc_count, duration = false)","<p>count_to_string\n<p>Class method to compute a string from a frame count\n"],["new","FPS::Timecode","FPS/Timecode.html#method-c-new","(tc_mode, tc_string, tc_count = nil)","<p>initialize Construct a new instance of Timecode, given a mode and either a \ntimecode string or a frame …\n"],["normalize","FPS::Timecode","FPS/Timecode.html#method-c-normalize","(tc_mode, tc_count)","<p>Class method to normalize a frame count &gt;= 0 and &lt; 24h Correct 24\nhour overflow or underflow\n"],["string_as_duration","FPS::Timecode","FPS/Timecode.html#method-c-string_as_duration","(tc_mode, tc_count)","<p>Class method to compute a string as a duration from a frame count_to_string\n"],["string_as_duration","FPS::Timecode","FPS/Timecode.html#method-i-string_as_duration","()","<p>string_as_duration The difference of two timecodes might be used as a\nduration. For non-drop frame, the …\n"],["string_to_count","FPS::Timecode","FPS/Timecode.html#method-c-string_to_count","(tc_mode, tc_string)","<p>string_to_count Class method to compute a count from a string\n"],["succ","FPS::Timecode","FPS/Timecode.html#method-i-succ","()","<p>succ return the next timecode address in the sequence\n"],["test_class_methods","TestFpsTimecode","TestFpsTimecode.html#method-i-test_class_methods","()",""],["test_comparison_works_on_strings_regardless_of_counts","TestFpsTimecode","TestFpsTimecode.html#method-i-test_comparison_works_on_strings_regardless_of_counts","()",""],["test_create_count_if_given_must_be_fixnum","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_count_if_given_must_be_fixnum","()",""],["test_create_counts_greater_than_24_hours_will_be_normalized","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_counts_greater_than_24_hours_will_be_normalized","()",""],["test_create_fall_back_to_count_when_string_is_invalid","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_fall_back_to_count_when_string_is_invalid","()",""],["test_create_legally_doesnt_fail","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_legally_doesnt_fail","()",""],["test_create_must_have_valid_tc_mode","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_must_have_valid_tc_mode","()",""],["test_create_negative_counts_will_be_normalized","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_negative_counts_will_be_normalized","()",""],["test_create_nonexistent_drop_frame_times_will_be_corrected","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_nonexistent_drop_frame_times_will_be_corrected","()",""],["test_create_string_all_fields_must_be_within_bounds","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_string_all_fields_must_be_within_bounds","()",""],["test_create_string_and_count_cannot_both_be_nil","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_string_and_count_cannot_both_be_nil","()",""],["test_create_string_must_be_valid_if_no_count_given","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_string_must_be_valid_if_no_count_given","()",""],["test_create_use_string_by_default","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_use_string_by_default","()",""],["test_dropframe_string_as_duration","TestFpsTimecode","TestFpsTimecode.html#method-i-test_dropframe_string_as_duration","()",""],["test_succ","TestFpsTimecode","TestFpsTimecode.html#method-i-test_succ","()",""],["fps-timecode.gemspec","","fps-timecode_gemspec.html","","<p>Gem::Specification.new do |s|\n\n<pre>s.name = &#39;fps-timecode&#39;\ns.version = &#39;0.0.3&#39;\ns.summary = &#39;Implements timecode ...</pre>\n"]]}}
+var search_data = {"index":{"searchIndex":["fps","timecode","testfpstimecode","<=>()","==()","count_to_string()","new()","normalize()","string_as_duration()","string_as_duration()","string_to_count()","succ()","test_class_methods()","test_comparison_works_on_strings_regardless_of_counts()","test_create_count_if_given_must_be_fixnum()","test_create_counts_greater_than_24_hours_will_be_normalized()","test_create_fall_back_to_count_when_string_is_invalid()","test_create_legally_doesnt_fail()","test_create_must_have_valid_tc_mode()","test_create_negative_counts_will_be_normalized()","test_create_nonexistent_drop_frame_times_will_be_corrected()","test_create_string_all_fields_must_be_within_bounds()","test_create_string_and_count_cannot_both_be_nil()","test_create_string_must_be_valid_if_no_count_given()","test_create_use_string_by_default()","test_dropframe_string_as_duration()","test_succ()","fps-timecode.gemspec"],"longSearchIndex":["fps","fps::timecode","testfpstimecode","fps::timecode#<=>()","fps::timecode#==()","fps::timecode::count_to_string()","fps::timecode::new()","fps::timecode::normalize()","fps::timecode::string_as_duration()","fps::timecode#string_as_duration()","fps::timecode::string_to_count()","fps::timecode#succ()","testfpstimecode#test_class_methods()","testfpstimecode#test_comparison_works_on_strings_regardless_of_counts()","testfpstimecode#test_create_count_if_given_must_be_fixnum()","testfpstimecode#test_create_counts_greater_than_24_hours_will_be_normalized()","testfpstimecode#test_create_fall_back_to_count_when_string_is_invalid()","testfpstimecode#test_create_legally_doesnt_fail()","testfpstimecode#test_create_must_have_valid_tc_mode()","testfpstimecode#test_create_negative_counts_will_be_normalized()","testfpstimecode#test_create_nonexistent_drop_frame_times_will_be_corrected()","testfpstimecode#test_create_string_all_fields_must_be_within_bounds()","testfpstimecode#test_create_string_and_count_cannot_both_be_nil()","testfpstimecode#test_create_string_must_be_valid_if_no_count_given()","testfpstimecode#test_create_use_string_by_default()","testfpstimecode#test_dropframe_string_as_duration()","testfpstimecode#test_succ()",""],"info":[["FPS","","FPS.html","","<p>Timecode library Implements Timecode class Version 0.0.2\n<p>Author: Loran Kary Copyright 2013 Focal Point …\n"],["FPS::Timecode","","FPS/Timecode.html","","<p>The Focal Point Systems timecode library has two main purposes.\n<p>1.) Given the timecode address of the …\n"],["TestFpsTimecode","","TestFpsTimecode.html","",""],["<=>","FPS::Timecode","FPS/Timecode.html#method-i-3C-3D-3E","(other)","<p>Compare two timecodes. Comparison (spaceship) operator does string compare\n"],["==","FPS::Timecode","FPS/Timecode.html#method-i-3D-3D","(other)","<p>Compare two timecodes for equality. Equality operator does string\ncomparison. Two timecodes may be considered …\n"],["count_to_string","FPS::Timecode","FPS/Timecode.html#method-c-count_to_string","(tc_mode, tc_count, duration = false)","<p>count_to_string Class method to produce a timecode string from a frame\ncount\n"],["new","FPS::Timecode","FPS/Timecode.html#method-c-new","(tc_mode, tc_string, tc_count = nil)","<p>initialize\n<p>Construct a new instance of FPS::Timecode, given a mode and either a\ntimecode string or a frame …\n"],["normalize","FPS::Timecode","FPS/Timecode.html#method-c-normalize","(tc_mode, tc_count)","<p>Class method to normalize a frame count &gt;= 0 and &lt; 24h. Corrects 24\nhour overflow or underflow …\n"],["string_as_duration","FPS::Timecode","FPS/Timecode.html#method-c-string_as_duration","(tc_mode, tc_count)","<p>Class method to produce a timecode string as a duration from a frame count\nThe difference of two timecodes …\n"],["string_as_duration","FPS::Timecode","FPS/Timecode.html#method-i-string_as_duration","()","<p>string_as_duration instance method\n"],["string_to_count","FPS::Timecode","FPS/Timecode.html#method-c-string_to_count","(tc_mode, tc_string)","<p>string_to_count Class method to compute a frame count from a timecode\nstring\n"],["succ","FPS::Timecode","FPS/Timecode.html#method-i-succ","()","<p>Return the next timecode address in the sequence\n"],["test_class_methods","TestFpsTimecode","TestFpsTimecode.html#method-i-test_class_methods","()",""],["test_comparison_works_on_strings_regardless_of_counts","TestFpsTimecode","TestFpsTimecode.html#method-i-test_comparison_works_on_strings_regardless_of_counts","()",""],["test_create_count_if_given_must_be_fixnum","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_count_if_given_must_be_fixnum","()",""],["test_create_counts_greater_than_24_hours_will_be_normalized","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_counts_greater_than_24_hours_will_be_normalized","()",""],["test_create_fall_back_to_count_when_string_is_invalid","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_fall_back_to_count_when_string_is_invalid","()",""],["test_create_legally_doesnt_fail","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_legally_doesnt_fail","()",""],["test_create_must_have_valid_tc_mode","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_must_have_valid_tc_mode","()",""],["test_create_negative_counts_will_be_normalized","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_negative_counts_will_be_normalized","()",""],["test_create_nonexistent_drop_frame_times_will_be_corrected","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_nonexistent_drop_frame_times_will_be_corrected","()",""],["test_create_string_all_fields_must_be_within_bounds","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_string_all_fields_must_be_within_bounds","()",""],["test_create_string_and_count_cannot_both_be_nil","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_string_and_count_cannot_both_be_nil","()",""],["test_create_string_must_be_valid_if_no_count_given","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_string_must_be_valid_if_no_count_given","()",""],["test_create_use_string_by_default","TestFpsTimecode","TestFpsTimecode.html#method-i-test_create_use_string_by_default","()",""],["test_dropframe_string_as_duration","TestFpsTimecode","TestFpsTimecode.html#method-i-test_dropframe_string_as_duration","()",""],["test_succ","TestFpsTimecode","TestFpsTimecode.html#method-i-test_succ","()",""],["fps-timecode.gemspec","","fps-timecode_gemspec.html","","<p>Gem::Specification.new do |s|\n\n<pre>s.name = &#39;fps-timecode&#39;\ns.version = &#39;0.0.3&#39;\ns.summary = &#39;Implements timecode ...</pre>\n"]]}}

data/lib/fps-timecode.rb

@@ -7,35 +7,34 @@
 
 module FPS      # Focal Point Software
 
-# A timecode library has two main purposes.
-# 1.) Given the timecode address of the first frame of a sequence of frames, 
-#     and given n, what is the timecode address of the nth frame of a sequence?
-# 2.) Given the timecode address of the first frame of a sequence, and
-#     given the timecode address for the nth frame of the sequence,  what is n?
-
+# The Focal Point Systems timecode library has two main purposes.
+# * 1.) Given the timecode address of the first frame of a sequence of frames, and given n, what is the timecode address of the nth frame of a sequence?
+# * 2.) Given the timecode address of the first frame of a sequence, and given the timecode address for the nth frame of the sequence,  what is n?
+#
 # Example 1.  A non-drop-frame 30 fps sequence starts at 00:01:00:00.  What is
-#           the timecode address of the 100th frame of the sequence?
-#  FPS::Timecode.count_to_string(:fps_30_ndf, 
-#       FPS::Timecode.string_to_count(:fps_30_ndf,"00:01:00:00") + 100)
-#   => "00:01:03:10"
-
+# the timecode address of the 100th frame of the sequence?
+# FPS::Timecode.count_to_string(:fps_30_ndf,
+# FPS::Timecode.string_to_count(:fps_30_ndf,"00:01:00:00") + 100)  => "00:01:03:10"
+#
 # Example 2.  A non-drop-frame 30 fps sequence starts at 00:01:00:00. What is n
-#       for the frame with the address 00:01:03:10?
-#  FPS::Timecode.string_to_count(:fps_30_ndf,"00:01:03:10") -
-#        FPS::Timecode.string_to_count(:fps_30_ndf,"00:01:00:00")
-#   => 100
-
+# for the frame with the address 00:01:03:10?
+# FPS::Timecode.string_to_count(:fps_30_ndf,"00:01:03:10") -
+# FPS::Timecode.string_to_count(:fps_30_ndf,"00:01:00:00") => 100
+#
 # An instance of the Timecode class represents one timecode address.
 # A timecode mode is always required to be given.  The mode determines the frame
 # rate and the dropness (drop-frame or non-drop-frame) of the timecode address.
-# The mode must be one of Timecode::Counts.keys.  E.g. :fps_24, :fps_25.
+# The mode must be one of Timecode::Counts.keys.  E.g. :fps_24, :fps_25, :fps_30_df, :fps_30_ndf
+#
 # Create an instance of a Timecode using either a string in the format "xx:xx:xx:xx"
 # or a frame count.  The frame count represents n for the nth frame of a sequence
 # that begins with timecode address "00:00:00:00" (the zeroeth frame of the sequence).
-# When creating a timecode instance, default to using the string argument
-# and fall back to using the frame count argument if the string is invalid. 
-
-# Since there are many class methods, often there is no need to create 
+#
+# When creating a timecode instance, the default is to use the string argument
+# ignoring the frame count argument
+# and falling back to using the frame count argument if the string is invalid.
+#
+# Since there are many class methods, often there is no need to create
 # an instance of class Timecode.
 
 class Timecode
@@ -44,17 +43,17 @@ class Timecode
 
   Counts = { fps_24:     { fp24h: 2073600, fph: 86400,  fptm: 14400, fpm: 1440, fps: 24 },
              fps_25:     { fp24h: 2160000, fph: 90000,  fptm: 15000, fpm: 1500, fps: 25 },
-             fps_30_df:  { fp24h: 2589408, fph: 107892, fptm: 17982, fpm: 1798, fps: 30 },             
+             fps_30_df:  { fp24h: 2589408, fph: 107892, fptm: 17982, fpm: 1798, fps: 30 },
              fps_30_ndf: { fp24h: 2592000, fph: 108000, fptm: 18000, fpm: 1800, fps: 30 },
              fps_48:     { fp24h: 4147200, fph: 172800, fptm: 28800, fpm: 2880, fps: 48 },
              fps_50:     { fp24h: 4320000, fph: 180000, fptm: 30000, fpm: 3000, fps: 50 },
              fps_60_df:  { fp24h: 5178816, fph: 215784, fptm: 35964, fpm: 3596, fps: 60 },
              fps_60_ndf: { fp24h: 5184000, fph: 216000, fptm: 36000, fpm: 3600, fps: 60 },
            }
-     
-  # count_to_string      
-  # Class method to compute a string from a frame count
-  def self.count_to_string(tc_mode, tc_count, duration = false) 
+
+  # count_to_string
+  # Class method to produce a timecode string from a frame count
+  def self.count_to_string(tc_mode, tc_count, duration = false)
     tc_count = Timecode.normalize(tc_mode, tc_count)
 
     counts = Counts[tc_mode]
@@ -64,7 +63,7 @@ class Timecode
     rem = rem % counts[:fptm]
     units_mins = rem / counts[:fpm]
     rem = rem % counts[:fpm]
-    
+
     if(duration == false)  # not a duration, do drop-frame processing
         # handle 30 fps drop frame
         if(tc_mode == :fps_30_df && units_mins > 0 && rem <= 1)
@@ -77,20 +76,20 @@ class Timecode
           rem += counts[:fpm]
         end
     end
-    
+
     secs = rem / counts[:fps]
     frms = rem % counts[:fps]
-    
+
     "%02d:%d%d:%02d:%02d" % [hours, tens_mins, units_mins, secs, frms]
   end
-  
+
   # string_to_count
-  # Class method to compute a count from a string  
+  # Class method to compute a frame count from a timecode string
   def self.string_to_count(tc_mode, tc_string)
     unless Counts.include?(tc_mode)
       raise ArgumentError,  "invalid timecode mode"
     end
-    unless tc_string.is_a? String 
+    unless tc_string.is_a? String
       raise ArgumentError, "invalid timecode string"
     end
     unless tc_string =~ /\A(\d{2})[:;.](\d{2})[:;.](\d{2})[:;.](\d{2})\Z/
@@ -107,16 +106,16 @@ class Timecode
       $3.to_i * counts[:fpm] +
       $4.to_i * counts[:fps] + $5.to_i
   end
-  
-  # Class method to normalize a frame count >= 0 and < 24h
-  # Correct 24 hour overflow or underflow
+
+  # Class method to normalize a frame count >= 0 and < 24h.
+  # Corrects 24 hour overflow or underflow
   def self.normalize(tc_mode, tc_count)
     # tc_mode must be given and must be one of the known tc modes
     unless Counts.include?(tc_mode)
       raise ArgumentError,  "invalid timecode mode"
     end
 
-    unless tc_count.is_a? Fixnum 
+    unless tc_count.is_a? Fixnum
       raise ArgumentError, "invalid frame count #{tc_count}"
     end
     # normalize to 24 hours
@@ -125,18 +124,29 @@ class Timecode
     while tc_count >= _24h do tc_count -= _24h end
     tc_count
   end
-  
-  # Class method to compute a string as a duration from a frame count_to_string
-  def self.string_as_duration(tc_mode, tc_count)
+
+# Class method to produce a timecode string as a duration from a frame count
+# The difference of two timecodes might be used as a duration.
+# For non-drop frame, the duration string does not differ from the
+# string as a timecode address.  But for drop-frame, timecodes
+# that don't exist as an address can exist as a duration.
+# One minute in drop frame is 1798 frames or 00:00:59:28.
+# "00:01:00:00" as a drop-frame timecode address does not exist.
+# But the difference between 00:01:59:28 and 00:00:59:28
+# should be displayed as "00:01:00:00" -- one minute.
+
+ def self.string_as_duration(tc_mode, tc_count)
     Timecode.count_to_string(tc_mode, tc_count, true)
   end
 
 
 
 # initialize
-# Construct a new instance of Timecode, given a mode and either a 
+#
+# Construct a new instance of FPS::Timecode, given a mode and either a
 # timecode string or a frame count.
-# Raises ArgumentError           
+#
+# Raises ArgumentError
   def initialize(tc_mode, tc_string, tc_count = nil)
     # tc_string and tc_count cannot both be nil
     if(tc_string === nil && tc_count === nil)
@@ -146,9 +156,9 @@ class Timecode
     unless Counts.include?(tc_mode)
       raise ArgumentError,  "invalid timecode mode"
     end
-    
+
     @tc_mode = tc_mode
-   
+
     # Try to use the string to construct the instance and fall back
     # to the count if an exception is raised
     begin
@@ -158,40 +168,31 @@ class Timecode
     rescue
       @tc_count = Timecode.normalize(@tc_mode, tc_count)
       @tc_string = Timecode.count_to_string(@tc_mode, @tc_count)
-    end        
-  
+    end
+
   end   #initialize
-  
-  # string_as_duration
-  # The difference of two timecodes might be used as a duration.
-  # For non-drop frame, the duration string does not differ from the
-  # string as a timecode address.  But for drop-frame, timecodes 
-  # that don't exist as an address can exist as a duration.
-  # One minute in drop frame is 1798 frames or 00:00:59:28.
-  # "00:01:00:00" as a drop-frame timecode address does not exist.
-  # But the difference between 00:01:59:28 and 00:00:59:28
-  # should be displayed as "00:01:00:00" -- one minute.
-  # 
+
+   # string_as_duration
+   # instance method
   def string_as_duration
     Timecode.string_as_duration(@tc_mode, @tc_count)
   end
-  
-  # succ
-  # return the next timecode address in the sequence
+
+  # Return the next timecode address in the sequence
   def succ
     Timecode.new(@tc_mode, nil, @tc_count+1)
   end
-  
-  # compare two timecodes for equality    
-  # equality operator does string compare
-  # two timecodes may be considered equal even though their modes and counts
+
+  # Compare two timecodes for equality.
+  # Equality operator does string comparison.
+  # Two timecodes may be considered equal even though their modes and counts
   # may be different.
   def ==(other)
     @tc_string == other.tc_string
   end
-  
-  # compare two timecodes
-  # comparison (spaceship) operator does string compare
+
+  # Compare two timecodes.
+  # Comparison (spaceship) operator does string compare
   def <=>(other)
     @tc_string <=> other.tc_string
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fps-timecode
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Loran Kary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-02-04 00:00:00.000000000 Z
 dependencies: []
 description: A library to support drop-frame and non-drop-frame timecodes
 email: lkary@focalpnt.com