From 590809a1af05f0d8e34a6588015bc42ffdf91747 Mon Sep 17 00:00:00 2001 From: moi15moi Date: Tue, 13 Aug 2024 23:05:59 -0400 Subject: [PATCH] Update doc to specify that we support v1, v2 and v4 timecode file --- muxtools/audio/extractors.py | 4 ++-- muxtools/functions.py | 2 +- muxtools/misc/chapters.py | 6 +++--- muxtools/subtitle/sub.py | 8 ++++---- muxtools/utils/parsing.py | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/muxtools/audio/extractors.py b/muxtools/audio/extractors.py index c8a2cb4..04df70a 100644 --- a/muxtools/audio/extractors.py +++ b/muxtools/audio/extractors.py @@ -161,7 +161,7 @@ class Trimmer(Trimmer): :param trim: Can be a single trim or a sequence of trims. :param trim_use_ms: Will use milliseconds instead of frame numbers - :param fps: Fps fraction that will be used for the conversion. Also accepts a timecode (v2) file. + :param fps: Fps fraction that will be used for the conversion. Also accepts a timecode (v1, v2, v4) file. :param preserve_delay: Will preserve existing container delay :param num_frames: Total number of frames used for calculations :param output: Custom output. Can be a dir or a file. @@ -302,7 +302,7 @@ class Sox(Trimmer): :param trim: List of Trims or a single Trim, which is a Tuple of two frame numbers or milliseconds :param preserve_delay: Keeps existing container delay if True :param trim_use_ms: Will use milliseconds instead of frame numbers - :param fps: The fps fraction used for the calculations. Also accepts a timecode (v2) file. + :param fps: The fps fraction used for the calculations. Also accepts a timecode (v1, v2, v4) file. :param num_frames: Total number of frames used for calculations :param output: Custom output. Can be a dir or a file. Do not specify an extension unless you know what you're doing. diff --git a/muxtools/functions.py b/muxtools/functions.py index 58e610f..1a310e3 100644 --- a/muxtools/functions.py +++ b/muxtools/functions.py @@ -30,7 +30,7 @@ def do_audio( :param fileIn: Input file :param track: Audio track number :param trims: Frame ranges to trim and/or combine, e.g. (24, -24) or [(24, 500), (700, 900)] - :param fps: FPS Fraction used for the conversion to time. Also accepts a timecode (v2) file. + :param fps: FPS Fraction used for the conversion to time. Also accepts a timecode (v1, v2, v4) file. :param num_frames: Total number of frames, used for negative numbers in trims :param extractor: Tool used to extract the audio :param trimmer: Tool used to trim the audio diff --git a/muxtools/misc/chapters.py b/muxtools/misc/chapters.py index e53ae15..9b3211f 100644 --- a/muxtools/misc/chapters.py +++ b/muxtools/misc/chapters.py @@ -32,7 +32,7 @@ def __init__( Convenience class for chapters :param chapter_source: Input either txt with ogm chapters, xml or (a list of) self defined chapters. - :param fps: Needed for timestamp convertion. Assumes 24000/1001 by default. Also accepts a timecode (v2) file. + :param fps: Needed for timestamp convertion. Assumes 24000/1001 by default. Also accepts a timecode (v1, v2, v4) file. :param _print: Prints chapters after parsing and after trimming. """ self.fps = fps @@ -205,7 +205,7 @@ def from_sub( Extract chapters from an ass file or a SubFile. :param file: Input ass file or SubFile - :param fps: FPS passed to the chapter class for further operations. Also accepts a timecode (v2) file. + :param fps: FPS passed to the chapter class for further operations. Also accepts a timecode (v1, v2, v4) file. :param use_actor_field: Uses the actor field instead of the effect field for identification. :param markers: Markers to check for. :param _print: Prints the chapters after parsing @@ -251,7 +251,7 @@ def from_mkv(file: PathLike, fps: Fraction | PathLike = Fraction(24000, 1001), _ Extract chapters from mkv. :param file: Input mkv file - :param fps: FPS passed to the chapter class for further operations. Also accepts a timecode (v2) file. + :param fps: FPS passed to the chapter class for further operations. Also accepts a timecode (v1, v2, v4) file. :param _print: Prints the chapters after parsing """ caller = "Chapters.from_mkv" diff --git a/muxtools/subtitle/sub.py b/muxtools/subtitle/sub.py index 7e894cd..0b9c59a 100644 --- a/muxtools/subtitle/sub.py +++ b/muxtools/subtitle/sub.py @@ -299,7 +299,7 @@ def shift_0( This does not currently exactly reproduce the aegisub behaviour but it should have the same effect. - :param fps: The fps fraction used for conversions. Also accepts a timecode (v2) file. + :param fps: The fps fraction used for conversions. Also accepts a timecode (v1, v2, v4) file. :param allowed_styles: A list of style names this will run on. Will run on every line if None. """ @@ -327,7 +327,7 @@ def merge( :param sync: Can be None to not adjust timing at all, an int for a frame number or a string for a syncpoint name. :param sync2: The syncpoint you want to use for the second file. This is needed if you specified a frame for sync and still want to use a specific syncpoint. - :param fps: The fps used for time calculations. Also accepts a timecode (v2) file. + :param fps: The fps used for time calculations. Also accepts a timecode (v1, v2, v4) file. :param use_actor_field: Checks the actor field instead of effect for the names if True. :param no_error: Don't error and warn instead if syncpoint not found. """ @@ -640,7 +640,7 @@ def shift(self: SubFileSelf, frames: int, fps: Fraction | PathLike = Fraction(24 Shifts all lines by any frame number. :param frames: Number of frames to shift by - :param fps: FPS needed for the timing calculations. Also accepts a timecode (v2) file. + :param fps: FPS needed for the timing calculations. Also accepts a timecode (v1, v2, v4) file. :param delete_before_zero: Delete lines that would be before 0 after shifting. """ @@ -695,7 +695,7 @@ def from_srt( :param file: Input srt file :param an8_all_caps: Automatically an8 every full caps line with over 7 characters because they're usually signs. :param style_all_caps: Also set the style of these lines to "Sign" wether it exists or not. - :param fps: FPS needed for the time conversion. Also accepts a timecode (v2) file. + :param fps: FPS needed for the time conversion. Also accepts a timecode (v1, v2, v4) file. :param encoding: Encoding used to read the file. Defaults to UTF8. """ caller = "SubFile.from_srt" diff --git a/muxtools/utils/parsing.py b/muxtools/utils/parsing.py index f24ddc5..a94c595 100644 --- a/muxtools/utils/parsing.py +++ b/muxtools/utils/parsing.py @@ -154,7 +154,7 @@ def parse_chapters_bdmv( Attempts to parse chapters from the bluray metadata :param src: The m2ts file you're currently using - :param clip_fps: The fps of the clip. Also accepts a timecode (v2) file. + :param clip_fps: The fps of the clip. Also accepts a timecode (v1, v2, v4) file. :param clip_frames: Total frames of the clip :param _print: Prints the chapters after parsing if true