Repository navigation
Expand file tree
/
Copy pathmodels.py
More file actions
265 lines (226 loc) · 10.4 KB
/
Copy pathmodels.py
File metadata and controls
265 lines (226 loc) · 10.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
from __future__ import annotations
import re
from typing import Literal
from pydantic import BaseModel, Field, field_validator, model_validator
from common.enums import RateControlMode
from common.media.language import normalize_language
from common.metadata import MetadataValues
_LANGUAGE = re.compile(r"^[a-z]{3}$")
_CONTAINERS = ("mkv", "mp4", "original")
_SUBTITLE_EXTENSIONS = ("srt", "ass", "ssa", "vtt")
def _checked_language(code: str) -> str:
if _LANGUAGE.fullmatch(code) is None:
msg = f"Language codes must contain three lowercase letters: {code!r}"
raise ValueError(msg)
return normalize_language(code)
class StreamSelection(BaseModel):
# None keeps every language. [] applies forced-track retention only.
# The renderer never drops the last audio stream.
keep_languages: list[str] | None = None
drop_descriptive: bool = False
max_per_language: int | None = Field(default=None, ge=1)
set_default_language: str | None = None
retag_und_as: str | None = None
title_from_channel_layout: bool = False
keep_forced: bool = True
keep_all_if_empty: bool = False
@field_validator("keep_languages")
@classmethod
def check_keep_languages(cls, value: list[str] | None) -> list[str] | None:
if value is None:
return None
return [_checked_language(code) for code in value]
@field_validator("set_default_language", "retag_und_as")
@classmethod
def check_language_fields(cls, value: str | None) -> str | None:
if value is None:
return None
return _checked_language(value)
class StreamPolicy(BaseModel):
audio: StreamSelection | None = None
subtitle: StreamSelection | None = None
drop_data: bool = False
drop_cover_art: bool = False
class StreamPolicyInputs(BaseModel):
audio_keep_languages: list[str] = Field(
default=[], description="Keep audio in these languages, such as eng or jpn. Leave empty to keep all languages."
)
audio_drop_descriptive: bool = Field(default=False, description="Remove commentary and descriptive audio tracks.")
audio_keep_forced: bool = Field(
default=True, description="Keep forced audio tracks even if their language isn't selected."
)
audio_keep_all_if_empty: bool = Field(
default=False, description="Keep all audio tracks if the other audio filters would remove them all."
)
audio_max_per_language: int | None = Field(
default=None, ge=1, description="Limit audio tracks per language. Leave empty for no limit."
)
subtitle_keep_languages: list[str] = Field(
default=[],
description="Keep subtitles in these languages, such as eng or jpn. Leave empty to keep all languages.",
)
subtitle_strip_all: bool = Field(default=False, description="Remove subtitles, keeping forced tracks if enabled.")
subtitle_keep_forced: bool = Field(
default=True, description="Keep forced subtitles even if their language isn't selected."
)
drop_data: bool = Field(default=False, description="Remove data streams.")
drop_cover_art: bool = Field(default=False, description="Remove embedded cover art.")
def stream_policy(self) -> StreamPolicy | None:
audio = None
if self.audio_keep_languages or self.audio_drop_descriptive or self.audio_max_per_language is not None:
audio = StreamSelection(
keep_languages=self.audio_keep_languages or None,
drop_descriptive=self.audio_drop_descriptive,
max_per_language=self.audio_max_per_language,
keep_forced=self.audio_keep_forced,
keep_all_if_empty=self.audio_keep_all_if_empty,
)
subtitle = None
if self.subtitle_strip_all:
subtitle = StreamSelection(keep_languages=[], keep_forced=self.subtitle_keep_forced)
elif self.subtitle_keep_languages:
subtitle = StreamSelection(
keep_languages=self.subtitle_keep_languages, keep_forced=self.subtitle_keep_forced
)
if audio is None and subtitle is None and not (self.drop_data or self.drop_cover_art):
return None
return StreamPolicy(
audio=audio, subtitle=subtitle, drop_data=self.drop_data, drop_cover_art=self.drop_cover_art
)
class AudioPlanInputs(StreamPolicyInputs):
audio_codec: str | None = Field(default=None, description="Choose the output audio codec.")
audio_bitrate: str | None = Field(default=None, description="Set the output audio bitrate, such as 192k.")
audio_when_codecs: list[str] = Field(
default=[],
description="Convert audio tracks with these source codecs. Leave empty to convert all selected tracks.",
)
@field_validator("audio_codec", "audio_bitrate", mode="before")
@classmethod
def empty_audio(cls, value: str | None) -> str | None:
return None if value == "" else value
@model_validator(mode="after")
def check_audio_pair(self) -> AudioPlanInputs:
if (self.audio_codec is None) != (self.audio_bitrate is None):
msg = "audio_codec and audio_bitrate must be supplied together"
raise ValueError(msg)
return self
def audio_targets(self) -> list[AudioTarget]:
if self.audio_codec is None or self.audio_bitrate is None:
return []
return [AudioTarget(codec=self.audio_codec, bitrate=self.audio_bitrate, when_codec_in=self.audio_when_codecs)]
class RateControl(BaseModel):
mode: RateControlMode = RateControlMode.QUALITY
from_source_bitrate: float = 1.0
bitrate_source: Literal["video", "container", "average"] = "video"
quality: int | None = None
quality_option: Literal["crf", "cq", "global_quality", "qp"] = "crf"
tolerance: float = 0.25
@field_validator("from_source_bitrate")
@classmethod
def check_multiplier(cls, value: float) -> float:
if not 0 < value <= 1:
msg = f"from_source_bitrate must be in (0, 1], got {value}"
raise ValueError(msg)
return value
@field_validator("tolerance")
@classmethod
def check_tolerance(cls, value: float) -> float:
if not 0 < value <= 1:
msg = f"tolerance must be in (0, 1], got {value}"
raise ValueError(msg)
return value
class VideoTarget(BaseModel):
encoder: str
encoder_priority: list[str] = Field(default_factory=list)
rate: RateControl | None = None
pixel_format: str | None = None
preset: str | None = None
max_width: int | None = Field(default=None, ge=1)
max_height: int | None = Field(default=None, ge=1)
class AudioTarget(BaseModel):
codec: str
bitrate: str
when_codec_in: list[str] = []
class VerificationSpec(BaseModel):
min_duration_ratio: float = 0.98
size_ceiling_ratio: float = 1.05
@field_validator("min_duration_ratio", "size_ceiling_ratio")
@classmethod
def check_positive(cls, value: float) -> float:
if value <= 0:
msg = f"verification ratios must be positive, got {value}"
raise ValueError(msg)
return value
class SubtitleBurn(BaseModel):
filename: str
@field_validator("filename")
@classmethod
def check_filename(cls, value: str) -> str:
path = value.lower()
if value in (".", "..") or any(char in value for char in ("/", "\\", "\x00")):
raise ValueError("subtitle filename must be a safe basename")
if "." not in value or path.rsplit(".", 1)[1] not in _SUBTITLE_EXTENSIONS:
raise ValueError("subtitle filename must have an srt, ass, ssa, or vtt extension")
return value
class FFmpegPlan(BaseModel):
container: str = "mkv"
metadata: MetadataValues | None = None
streams: StreamPolicy | None = None
video: VideoTarget | None = None
burn_subtitle: SubtitleBurn | None = None
audio_encode: list[AudioTarget] = []
chapters: bool = True
generate_timestamps: bool = False
expected: VerificationSpec = Field(default_factory=VerificationSpec)
extras: list[str] = []
def select_encoder(self, encoders: list[str]) -> FFmpegPlan:
if self.video is None or not self.video.encoder_priority:
return self
encoder = next((name for name in self.video.encoder_priority if name in encoders), None)
if encoder is None:
msg = f"no compatible encoder: {', '.join(self.video.encoder_priority)}"
raise ValueError(msg)
plan = self.model_copy(deep=True)
assert plan.video is not None
video = plan.video
video.encoder, video.encoder_priority = encoder, []
vendor = encoder.rsplit("_", 1)[-1]
hardware = vendor in {"nvenc", "qsv", "vaapi", "amf"}
if video.rate is not None:
video.rate.quality_option = (
"cq"
if vendor == "nvenc"
else "global_quality"
if vendor == "qsv"
else "qp"
if vendor in {"vaapi", "amf"}
else "crf"
)
if video.rate.mode == RateControlMode.QUALITY and video.rate.quality is None:
video.rate.quality = 19 if hardware else {"libx264": 23, "libx265": 21, "libsvtav1": 30}.get(encoder)
if video.pixel_format in {"yuv420p10le", "p010le"}:
video.pixel_format = "p010le" if hardware else "yuv420p10le"
elif vendor == "vaapi":
video.pixel_format = "nv12"
if vendor in {"vaapi", "amf"}:
video.preset = None
defaults = [("-spatial_aq:v", "1"), ("-rc-lookahead:v", "32")] if vendor == "nvenc" else []
if encoder.startswith("hevc_") and video.pixel_format == "p010le":
defaults.append(("-profile:v", "main10"))
flags = {arg.split(":", 1)[0] for arg in plan.extras}
for flag, value in defaults:
if flag.split(":", 1)[0] not in flags:
plan.extras += [flag, value]
return plan
@model_validator(mode="after")
def check_burn_subtitle(self) -> FFmpegPlan:
if self.burn_subtitle is not None and self.video is None:
raise ValueError("burn_subtitle requires video")
return self
@field_validator("container")
@classmethod
def check_container(cls, value: str) -> str:
if value not in _CONTAINERS:
msg = f"container must be one of {', '.join(_CONTAINERS)}, got {value!r}"
raise ValueError(msg)
return value