Skip to content

types

Chapter = tuple[timedelta | int, Optional[str]] module-attribute

PathLike = Union[Path, str, None] module-attribute

Paths = Union[PathLike, list[PathLike]] module-attribute

TimeScaleT = Union[TimeScale, Fraction, int, None] module-attribute

Unit of time (in seconds) in terms of which frame timestamps are represented.

While you can pass an int, the needed type is always a Fraction and will be converted via Fraction(your_int).

None will usually fallback to a generic mkv timescale but exact behavior might differ based on the target function.

TimeSourceT = Union[PathLike, Fraction, float, list, VideoMeta, ABCTimestamps, None] module-attribute

The source of timestamps/timecodes.

For actual timestamps, this can be a timestamps (v1/v2/v4) file, a video file or a list of integers.

For FPS based timestamps, this can be a Fraction object, a float or even a string representing a fraction.

Like '24000/1001'.

Can also be an already instantiated Timestamps class from the videotimestamps library.

None will usually fallback to 24000/1001 but exact behavior might differ based on the target function.

Trim = tuple[int | None, int | None] module-attribute

__all__ = ['PathLike', 'Paths', 'Trim', 'TrackType', 'AudioFormat', 'AudioFrame', 'AudioStats', 'AudioInfo', 'Chapter', 'DitherType', 'LossyWavQuality', 'VideoMeta', 'TimeScale'] module-attribute

AudioFormat dataclass

Source code in muxtools/utils/types.py 
92
93
94
95
96
97
@dataclass
class AudioFormat:
    format: str
    ext: str
    codecid: str
    lossy: bool = True

codecid instance-attribute

ext instance-attribute

format instance-attribute

lossy = True class-attribute instance-attribute

__init__

AudioFrame dataclass

A dataclass representing ffmpeg's ashowdata filter output.

Parameters:

Name Type Description Default
n int

The (sequential) number of the input frame, starting from 0

 required
pts int

The presentation timestamp of the input frame, in time base units the time base depends on the filter input pad, and is usually 1/sample_rate

 required
pts_time float

The presentation timestamp of the input frame in seconds

 required
num_samples int

Number of samples in a frame (can also be refered to as frame length or size)

 required
Source code in muxtools/utils/types.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
@dataclass
class AudioFrame:
    """
    A dataclass representing ffmpeg's `ashowdata` filter output.

    :param n:           The (sequential) number of the input frame, starting from 0
    :param pts:         The presentation timestamp of the input frame, in time base units
                        the time base depends on the filter input pad, and is usually 1/sample_rate

    :param pts_time:    The presentation timestamp of the input frame in seconds
    :param num_samples: Number of samples in a frame (can also be refered to as frame length or size)
    """

    n: int
    pts: int
    pts_time: float
    num_samples: int

n instance-attribute

num_samples instance-attribute

pts instance-attribute

pts_time instance-attribute

__init__

AudioInfo dataclass

Source code in muxtools/utils/types.py 
209
210
211
212
213
214
215
216
217
@dataclass
class AudioInfo:
    stats: AudioStats = None
    frames: list[AudioFrame] | None = None

    def num_samples(self) -> int:
        for frame in self.frames:
            if frame.num_samples:
                return frame.num_samples

frames = None class-attribute instance-attribute

stats = None class-attribute instance-attribute

__init__

num_samples

Source code in muxtools/utils/types.py 
214
215
216
217
def num_samples(self) -> int:
    for frame in self.frames:
        if frame.num_samples:
            return frame.num_samples

AudioStats dataclass

A dataclass representing ffmpeg's astats filter output.

Too many attributes to document to be honest.

See https://ffmpeg.org/ffmpeg-filters.html#astats-1

Source code in muxtools/utils/types.py 
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
@dataclass
class AudioStats:
    """
    A dataclass representing ffmpeg's `astats` filter output.

    Too many attributes to document to be honest.

    See https://ffmpeg.org/ffmpeg-filters.html#astats-1
    """

    dc_offset: float = 0.0
    min_level: float = 0.0
    max_level: float = 0.0
    min_difference: float = 0.0
    max_difference: float = 0.0
    mean_difference: float = 0.0
    rms_difference: float = 0.0
    peak_level_db: float = 0.0
    rms_level_db: float = 0.0
    rms_peak_db: float = 0.0
    rms_trough_db: float = 0.0
    flat_factor: float = 0.0
    peak_count: float = 0.0
    noise_floor_db: float = 0.0
    noise_floor_count: float = 0.0
    entropy: float = 0.0
    bit_depth: str = ""
    number_of_samples: int = 0

bit_depth = '' class-attribute instance-attribute

dc_offset = 0.0 class-attribute instance-attribute

entropy = 0.0 class-attribute instance-attribute

flat_factor = 0.0 class-attribute instance-attribute

max_difference = 0.0 class-attribute instance-attribute

max_level = 0.0 class-attribute instance-attribute

mean_difference = 0.0 class-attribute instance-attribute

min_difference = 0.0 class-attribute instance-attribute

min_level = 0.0 class-attribute instance-attribute

noise_floor_count = 0.0 class-attribute instance-attribute

noise_floor_db = 0.0 class-attribute instance-attribute

number_of_samples = 0 class-attribute instance-attribute

peak_count = 0.0 class-attribute instance-attribute

peak_level_db = 0.0 class-attribute instance-attribute

rms_difference = 0.0 class-attribute instance-attribute

rms_level_db = 0.0 class-attribute instance-attribute

rms_peak_db = 0.0 class-attribute instance-attribute

rms_trough_db = 0.0 class-attribute instance-attribute

__init__

DitherType

Bases: IntEnum

FFMPEG Dither Methods, see https://ffmpeg.org/ffmpeg-resampler.html#Resampler-Options

Source code in muxtools/utils/types.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
class DitherType(IntEnum):
    """
    FFMPEG Dither Methods, see https://ffmpeg.org/ffmpeg-resampler.html#Resampler-Options
    """

    RECTANGULAR = 1
    TRIANGULAR = 2  # Allegedly SoX's default
    TRIANGULAR_HP = 3
    LIPSHITZ = 4
    SHIBATA = 5  # Foobar uses this for example
    LOW_SHIBATA = 6
    HIGH_SHIBATA = 7
    F_WEIGHTED = 8
    MODIFIED_E_WEIGHTED = 9
    IMPROVED_E_WEIGHTED = 10

F_WEIGHTED = 8 class-attribute instance-attribute

HIGH_SHIBATA = 7 class-attribute instance-attribute

IMPROVED_E_WEIGHTED = 10 class-attribute instance-attribute

LIPSHITZ = 4 class-attribute instance-attribute

LOW_SHIBATA = 6 class-attribute instance-attribute

MODIFIED_E_WEIGHTED = 9 class-attribute instance-attribute

RECTANGULAR = 1 class-attribute instance-attribute

SHIBATA = 5 class-attribute instance-attribute

TRIANGULAR = 2 class-attribute instance-attribute

TRIANGULAR_HP = 3 class-attribute instance-attribute

LossyWavQuality

Bases: IntEnum

LossyWAV Quality presets, see https://wiki.hydrogenaud.io/index.php?title=LossyWAV#Quality_presets

TL;DR: Insane the least lossy, ExtraPortable the most lossy.

Source code in muxtools/utils/types.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
137
class LossyWavQuality(IntEnum):
    """
    LossyWAV Quality presets, see https://wiki.hydrogenaud.io/index.php?title=LossyWAV#Quality_presets

    TL;DR: Insane the least lossy, ExtraPortable the most lossy.
    """

    INSANE = 1
    EXTREME = 2
    HIGH = 3
    STANDARD = 4
    ECONOMIC = 5
    PORTABLE = 6
    EXTRAPORTABLE = 7

ECONOMIC = 5 class-attribute instance-attribute

EXTRAPORTABLE = 7 class-attribute instance-attribute

EXTREME = 2 class-attribute instance-attribute

HIGH = 3 class-attribute instance-attribute

INSANE = 1 class-attribute instance-attribute

PORTABLE = 6 class-attribute instance-attribute

STANDARD = 4 class-attribute instance-attribute

TimeScale

Bases: IntEnum

Convenience enum for some common timescales.

Source code in muxtools/utils/types.py 
63
64
65
66
67
68
69
70
71
class TimeScale(IntEnum):
    """Convenience enum for some common timescales."""

    MKV = 1000
    """Typical matroska timescale"""
    MATROSKA = MKV
    """Alias for MKV"""
    M2TS = 90000
    """Typical m2ts timescale"""

M2TS = 90000 class-attribute instance-attribute

Typical m2ts timescale

MATROSKA = MKV class-attribute instance-attribute

Alias for MKV

MKV = 1000 class-attribute instance-attribute

Typical matroska timescale

TrackType

Bases: IntEnum

Source code in muxtools/utils/types.py 
37
38
39
40
41
42
43
class TrackType(IntEnum):
    VIDEO = 1
    AUDIO = 2
    SUB = 3
    ATTACHMENT = 4
    CHAPTERS = 5
    MKV = 6

ATTACHMENT = 4 class-attribute instance-attribute

AUDIO = 2 class-attribute instance-attribute

CHAPTERS = 5 class-attribute instance-attribute

MKV = 6 class-attribute instance-attribute

SUB = 3 class-attribute instance-attribute

VIDEO = 1 class-attribute instance-attribute

ValidInputType

Bases: IntEnum

Source code in muxtools/utils/types.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
class ValidInputType(IntEnum):
    FLAC = 1
    W64 = 3
    RF64 = 4
    W64_OR_FLAC = 6
    RF64_OR_FLAC = 7

    def allows_flac(self) -> bool:
        return "_OR_FLAC" in str(self.name)

    def remove_flac(self):
        match self:
            case ValidInputType.RF64_OR_FLAC:
                return ValidInputType.RF64
            case ValidInputType.W64_OR_FLAC:
                return ValidInputType.W64

        return ValidInputType.RF64

FLAC = 1 class-attribute instance-attribute

RF64 = 4 class-attribute instance-attribute

RF64_OR_FLAC = 7 class-attribute instance-attribute

W64 = 3 class-attribute instance-attribute

W64_OR_FLAC = 6 class-attribute instance-attribute

allows_flac

Source code in muxtools/utils/types.py 
147
148
def allows_flac(self) -> bool:
    return "_OR_FLAC" in str(self.name)

remove_flac

Source code in muxtools/utils/types.py 
150
151
152
153
154
155
156
157
def remove_flac(self):
    match self:
        case ValidInputType.RF64_OR_FLAC:
            return ValidInputType.RF64
        case ValidInputType.W64_OR_FLAC:
            return ValidInputType.W64

    return ValidInputType.RF64

VideoMeta dataclass

Source code in muxtools/utils/types.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@dataclass
class VideoMeta:
    pts: list[int]
    fps: Fraction
    timescale: Fraction
    source: str

    def to_json(self) -> str:
        return json.dumps(asdict(self), cls=FractionEncoder, indent=4)

    @staticmethod
    def from_json(file: PathLike) -> "VideoMeta":
        with open(file, "r", encoding="utf-8") as f:
            meta_json = json.loads(f.read(), object_hook=fraction_hook)
            return VideoMeta(**meta_json)

fps instance-attribute

pts instance-attribute

source instance-attribute

timescale instance-attribute

__init__

from_json staticmethod

Source code in muxtools/utils/types.py 
56
57
58
59
60
@staticmethod
def from_json(file: PathLike) -> "VideoMeta":
    with open(file, "r", encoding="utf-8") as f:
        meta_json = json.loads(f.read(), object_hook=fraction_hook)
        return VideoMeta(**meta_json)

to_json

Source code in muxtools/utils/types.py 
53
54
def to_json(self) -> str:
    return json.dumps(asdict(self), cls=FractionEncoder, indent=4)

qAAC_MODE

Bases: IntEnum

Source code in muxtools/utils/types.py 
117
118
119
120
121
class qAAC_MODE(IntEnum):
    TVBR = 1
    CVBR = 2
    ABR = 3
    CBR = 4

ABR = 3 class-attribute instance-attribute

CBR = 4 class-attribute instance-attribute

CVBR = 2 class-attribute instance-attribute

TVBR = 1 class-attribute instance-attribute