Skip to content

subutils

create_document()

Convenience function to create a new ASS Document. With relevant fields already filled in.

Source code in muxtools/subtitle/subutils.py 
12
13
14
15
16
17
18
19
20
21
22
23
def create_document() -> Document:
    """
    Convenience function to create a new ASS Document.
    With relevant fields already filled in.
    """
    doc = Document()
    doc.play_res_x = 1920
    doc.play_res_y = 1080
    doc.wrap_style = 0
    doc.scaled_border_and_shadow = "yes"
    doc.script_type = "v4.00+"
    return doc

dummy_video(width=1920, height=1080, format='yuv420p', quiet=True)

Creates a black dummy video using ffmpeg.

Parameters:

Name Type Description Default
width int

Width of the video

 1920
height int

Height of the video

 1080
format str

Format of the video Do ffmpeg -pix_fmts to see what's available

 'yuv420p'
quiet bool

Enable or disable commandline output

 True

Returns:

Type Description
Path

Path object of the resulting video
Source code in muxtools/subtitle/subutils.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def dummy_video(width: int = 1920, height: int = 1080, format: str = "yuv420p", quiet: bool = True) -> Path:
    """
    Creates a black dummy video using ffmpeg.

    :param width:           Width of the video
    :param height:          Height of the video
    :param format:          Format of the video
                            Do `ffmpeg -pix_fmts` to see what's available
    :param quiet:           Enable or disable commandline output

    :return:                Path object of the resulting video
    """
    from ..utils.files import make_output

    ffmpeg = get_executable("ffmpeg")
    out = make_output("dummy_video.mp4", "mp4", temp=True)
    args = [ffmpeg, "-t", "1", "-f", "lavfi", "-i", f"color=c=black:s={width}x{height}", "-c:v", "libx264", "-pix_fmt", format, str(out)]
    if run_commandline(args, quiet):
        raise error("Failed to create dummy video with ffmpeg!", dummy_video)
    return out