Explained timecode rate snapping

Signed-off-by: Joshua Minor <[email protected]>
AcademySoftwareFoundation · Nov 14, 2024 · f8aaf84 · f8aaf84
1 parent 0ab3b19
commit f8aaf84
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/opentime/rationalTime.cpp b/src/opentime/rationalTime.cpp
@@ -453,6 +453,10 @@ RationalTime::to_timecode(
         return std::string();
     }
 
+    // It is common practice to use truncated or rounded values
+    // like 29.97 instead of exact SMPTE rates like 30000/1001
+    // so as a convenience we will snap the rate to the nearest
+    // SMPTE rate if it is close enough.
     double nearest_smpte_rate = nearest_smpte_timecode_rate(rate);
     if (abs(nearest_smpte_rate - rate) > 0.1)
     {