Merge pull request #66 from nickswalker/feature/hfr

Support SMPTE ST12-3 high frame rate variants

Author: eoyilmaz

README.md

@@ -1,19 +1,21 @@
 About
 -----
 
-Python module for manipulating SMPTE timecode. Supports any arbitrary integer frame
-rates and some default str values of 23.976, 23.98, 24, 25, 29.97, 30, 50, 59.94, 60
-frame rates and milliseconds (1000 fps) and fractional frame rates like "30001/1001".
+Python module for manipulating SMPTE timecode. Supports all formats in the ST12
+standard,  as well as any arbitrary integer frame rates and some default str
+values of 23.976, 23.98, 24, 25, 29.97, 30, 50, 59.94, 60 frame rates and
+milliseconds (1000 fps) and fractional frame rates like "30000/1001".
 
-This library is a fork of the original PyTimeCode python library. You should  not use
-the two library together (PyTimeCode is not maintained and has known bugs).
+This library is a fork of the original PyTimeCode python library. You should
+not use the two library together (PyTimeCode is not maintained and has known
+bugs).
 
 The math behind the drop frame calculation is based on the
 [blog post of David Heidelberger](http://www.davidheidelberger.com/blog/?p=29).
 
-Simple math operations like, addition, subtraction, multiplication or division  with an
-integer value or with a timecode is possible. Math operations between timecodes with
-different frame rates are supported. So:
+Simple math operations like, addition, subtraction, multiplication or division
+with an integer value or with a timecode is possible. Math operations between
+timecodes with different frame rates are supported. So:
 
 ```py
 from timecode import Timecode
@@ -26,8 +28,8 @@ assert tc3.frames == 12
 assert tc3 == '00:00:00:11'
 ```
 
-Creating a Timecode instance with a start timecode of '00:00:00:00' will result a
-timecode object where the total number of frames is 1. So:
+Creating a Timecode instance with a start timecode of '00:00:00:00' will result
+a timecode object where the total number of frames is 1. So:
 
 ```py
 tc4 = Timecode('24', '00:00:00:00')
@@ -41,14 +43,14 @@ assert tc4.frame_number == 0
 ```
 
 > [!NOTE]
-> A common misconception is that `00:00:00:00` should have 0 frames. This is wrong
-> because Timecode is a label given for each frame in a media, and it happens to be
-> using numbers which are seemingly incremented one after another. So, for a Timecode to
-> exist there should be a frame. and 00:00:00:00 is generally the label given to the
-> first frame.
+> A common misconception is that `00:00:00:00` should have 0 frames. This is
+> wrong because Timecode is a label given for each frame in a media, and it
+> happens to be using numbers which are seemingly incremented one after
+> another. So, for a Timecode to exist there should be a frame. and 00:00:00:00
+> is generally the label given to the first frame.
 
-Frame rates 29.97 and 59.94 are always drop frame, and all the others are non drop
-frame.
+Frame rates 29.97, 59.94 and 119.88 are always drop frame, and all the others
+are non drop frame.
 
 The timecode library supports fractional frame rates passed as a string:
 
@@ -67,8 +69,8 @@ assert repr(tc6) == '19:23:14:23'
 This is useful for parsing timecodes stored in OpenEXR's and extracted through
 OpenImageIO for instance.
 
-Timecode also supports passing start timecodes formatted like HH:MM:SS.sss where SS.sss
-is seconds and fractions of seconds:
+Timecode also supports passing start timecodes formatted like HH:MM:SS.sss
+where SS.sss is seconds and fractions of seconds:
 
 ```py
 tc8 = Timecode(25, '00:00:00.040')
@@ -87,10 +89,11 @@ assert repr(tc9) == '19:23:14.958'
 
 Fraction of seconds is useful when working with tools like FFmpeg.
 
-The SMPTE standard limits the timecode with 24 hours. Even though, Timecode instance
-will show the current timecode inline with the SMPTE standard, it will keep counting the
-total frames without clipping it.
+The SMPTE standard limits the timecode with 24 hours. Even though, Timecode
+instance will show the current timecode inline with the SMPTE standard, it will
+keep counting the total frames without clipping it.
 
-Please report any bugs to the [GitHub](https://github.com/eoyilmaz/timecode) page.
+Please report any bugs to the [GitHub](https://github.com/eoyilmaz/timecode)
+page.
 
 Copyright 2014 Joshua Banton and PyTimeCode developers.