Editing Plans
VideoEdit is a multi-segment editing plan modeled as a Pydantic
BaseModel. Each segment selects a time range from a source video and
carries an ordered list of Operation instances to run against it.
At a Glance
- One
operationslist per segment — transforms and effects are sequenced together. post_operationsruns against the concatenated result.validate()is a dry-run via metadata; no frames are loaded.run_to_file()streams directly to disk — the only execution engine.
Quick Start
from videopython.editing import VideoEdit
plan = {
"segments": [
{
"source": "input.mp4",
"start": 5.0,
"end": 12.0,
"operations": [
{"op": "crop", "width": 0.5, "height": 1.0, "mode": "center"},
{"op": "resize", "width": 1080, "height": 1920},
{
"op": "blur_effect",
"mode": "constant",
"iterations": 1,
"window": {"start": 0.0, "stop": 1.0},
},
],
},
{"source": "input.mp4", "start": 20.0, "end": 28.0},
],
"post_operations": [
{"op": "color_adjust", "brightness": 0.05},
],
}
edit = VideoEdit.from_dict(plan)
predicted = edit.validate() # dry-run via VideoMetadata
edit.run_to_file("output.mp4", crf=20, preset="medium") # streams to disk (constant memory, any video length)
JSON Plan Format
{
"segments": [
{
"source": "path/to/video.mp4",
"start": 5.0,
"end": 15.0,
"operations": [
{"op": "resize", "width": 1080, "height": 1920},
{"op": "blur_effect", "mode": "constant", "iterations": 2,
"window": {"start": 0.0, "stop": 3.0}}
]
}
],
"post_operations": [
{"op": "color_adjust", "brightness": 0.05}
],
"match_to_lowest_fps": true,
"match_to_lowest_resolution": true
}
Rules:
segmentsis required and must be non-empty.- Each op object has an
opdiscriminator field; remaining fields belong to that op's Pydantic schema. Unknown fields are rejected. - Effect time windows go in the op's
windowfield ({"start": s, "stop": e}). Either endpoint may be omitted. - Top-level and segment-level keys are strict (
extra="forbid").
Pipeline Order
VideoEdit runs each segment's operations in order, concatenates the
results, then applies post_operations to the assembled output.
The Streaming Engine
run_to_file() is the only execution engine. It streams ffmpeg decode →
filter/effect chain → ffmpeg encode, so memory stays constant (~a frame at a
time) regardless of video length.
Each operation is one of two kinds:
- a filter — compiles to a native ffmpeg filter (
op.to_ffmpeg_filter(ctx)). This is reserved for ops ffmpeg does that numpy can't (or can't do as well): all transforms (resize,crop,resample_fps, the duration-changingspeed_change/freeze_frame, the transcription-consumingsilence_removal, andface_cropfrom the ai extra), and the two text-rendering effectstext_overlay(drawtext) andadd_subtitles(libass). - a per-frame effect — shape-preserving Python over each decoded frame
(
streaming_init+process_frame). Every pixel effect lives here:blur,sharpen,zoom,film_grain,chromatic_aberration,mirror_flip,vignette,color_adjust,kaleidoscope,shake,flash,glitch,pixelate,ken_burns,punch_in, and the image overlays. These run vectorised numpy/cv2 — benchmarks showed the native-filter equivalents were at best ~1.1–1.4x faster (the win came from skipping the rawvideo round-trip, not faster math) and in some cases slower (gblur), so the per-frame path is kept for its simplicity and exact output.
A segment whose ops are all filters renders in a single ffmpeg invocation —
no rawvideo round-trip, no Python loop. A per-frame effect switches that segment
to the decode → Python → encode pipeline, where filters before the effect join
the decode chain and filters after it the encode chain (so [fade, add_subtitles]
streams). Duration-changing transforms fold their predicted metadata through the
chain, so later effect windows and the audio follow the new timeline.
post_operations run as a second pass over the assembled program, so any op —
filter, effect, or transform — applies to the whole concatenated timeline.
A few plan shapes have no streaming strategy and are rejected with structured
STREAMING_UNSUPPORTED errors before any decode: a per-frame effect ordered after
encode-stage filters, a context-requiring op after a duration-changing transform,
face_crop behind per-frame effects, and a time-based-context post-op on a
multi-segment plan (its source-absolute context can't re-base onto the concat).
Reorder the ops, or move the op into a segment, to fix.
add_subtitles renders via libass — the transcription is compiled to an ASS
document at plan-compile time and burned in by ffmpeg's subtitles= filter
(needs an ffmpeg built with libass). Pass context= to run_to_file.
Streamability report
edit.streamability() classifies every op by streaming class without
touching the disk — filter (ffmpeg filter chain), frame_effect
(process_frame), or unstreamable (the plan is rejected, with the
reason and a reorder hint on the entry):
report = edit.streamability()
report.streamable # will the plan run?
report.unstreamable # the offending ops, with reasons
report.errors() # the same as structured STREAMING_UNSUPPORTED PlanErrors
edit.check(meta) reports the same STREAMING_UNSUPPORTED errors after the
regular validity errors, and run_to_file() raises them before any
decode. Streamability is purely structural (op classes, order, plan
shape), so a consumer can gate job admission on the report before
downloading sources.
Context Data
Operations that need side-channel data (e.g. silence_removal and
add_subtitles need a transcription) declare it via
requires: ClassVar[tuple[str, ...]]. The runner picks matching keys out
of the context dict and threads them into the streaming compile —
predict_metadata and either the effect's streaming_init or the
filter-compiled op's FilterCtx.context:
edit = VideoEdit.from_dict(plan)
edit.run_to_file("out.mp4", context={"transcription": my_transcription})
Time-based context values are re-based onto each cut segment's local
timeline, and the resolved values are delivered to the effect's
streaming_init.
Validation
VideoEdit.validate() chains Operation.predict_metadata across the
plan and checks:
- segment
endis within source duration - each operation's metadata prediction succeeds
- effect
windowis within the predicted segment duration - concatenation compatibility (exact fps + dimensions)
Returns the predicted final VideoMetadata. On failure it raises
PlanValidationError (a ValueError subclass, so except ValueError
keeps working) carrying structured .errors — each a PlanError with a
code, location, and the offending field/value/limit.
For dry-run validation without disk access, pass a pre-built
VideoMetadata to validate_with_metadata(meta_or_dict, context=...).
Parse vs. validate
Parsing (from_dict) owns the plan shape (field types, required
fields, unknown ops). The numeric bounds of the skeleton — segment
start/end and effect window ranges — are owned by validation, not
parse: a negative window.start or a start >= end segment parses and
is reported by validate/check. This keeps every numeric violation a
structured, collectable, repairable PlanError.
Collecting every error (check)
check(source_metadata, context=..., clamp_windows=...) is the
non-raising sibling of validate_with_metadata: it runs the same dry-run
but accumulates every PlanError and returns the list ([] == valid),
best-effort isolating failures per segment/op. Use it to re-prompt an LLM
once with all problems instead of one-at-a-time.
Repairing the mechanical violations (repair)
repair(source_metadata, context=..., clamp_op_params=True,
clamp_segment_end=False) returns (repaired_edit, repairs) — a corrected
deep copy plus a list[PlanRepair] changelog (location, field, old,
new, code), leaving the original untouched. It clamps only the
unambiguous cases:
- effect
window.start/window.stopinto[0, duration](segment ops andpost_operations); - op time fields past the clip end (e.g.
freeze_frame.timestamp), generic via each op's declaredtime_fields; - a negative segment
start→0, and withclamp_segment_end=Truea segmentendpast the source → the source end.
It never invents intent — a concat mismatch or end <= start is left for
check() / re-prompting — and never raises on an unrepairable op. A
clampable window.stop overrun (a duration-shrinking op before a windowed
effect) is the case run_to_file() already tolerates; validate(clamp_windows=True)
and check(..., clamp_windows=True) won't report it either.
Normalizing concat geometry (normalize_dimensions)
normalize_dimensions(source_metadata, target, context=...) appends a
per-segment resize to a common canvas — target is an explicit
(width, height), "first", "largest", or "match" (the lowest common
resolution, the same policy match_to_lowest_resolution applies in-stream) — so
the "all segments share dimensions" concat invariant holds by construction. Best-effort and
non-raising like repair()/check(): a segment it can't yet predict is
left untouched for check() to report. Returns (normalized_edit, repairs).
Matching Sources
When multiple segments draw from sources with different fps/resolution,
VideoEdit auto-matches:
match_to_lowest_fps(defaulttrue) — resample all segments to the lowest source fps.match_to_lowest_resolution(defaulttrue) — resize all segments to the lowest source resolution.
Set either flag to false to require sources match natively; otherwise
validate() / run_to_file() raises.
JSON Schema (json_schema)
VideoEdit.json_schema() returns a JSON Schema for the wire format,
including the discriminated union over every LLM-exposed Operation
(server-only ops like image_overlay are excluded — see
Operations). Pass it to
any LLM API as a tool/function schema or structured-output format. AI
operations appear in the union only after import videopython.ai has run.
schema = VideoEdit.json_schema()
# tools=[{"input_schema": schema}] # Anthropic
# tools=[{"type": "function", "function": {"parameters": schema}}] # OpenAI
Pass strict=True (VideoEdit.json_schema(strict=True) /
Operation.json_schema(strict=True)) for a submittable provider strict-mode
grammar: every object closed (additionalProperties: false), every property
required (optionality follows the Pydantic type — genuinely optional fields
stay nullable, defaulted-but-required ones keep their concrete type, so a
grammar-valid response always parses back), the op union expressed as an
anyOf of closed variants without a discriminator, and the union's $defs
hoisted to the document root so every $ref resolves. Numeric constraints are
preserved, so grammar-constrained decoding makes simple bound violations
impossible at decode time.
API Reference
VideoEdit
VideoEdit
Bases: BaseModel
A multi-segment editing plan.
Parse vs. validate. Parsing (from_dict/model_validate) owns the
shape: field types, required fields, unknown-op/extra-field rejection, and
op-local structural rules (e.g. resize needs a dimension) surface as a
Pydantic ValidationError. The numeric bounds of the plan skeleton --
segment start/end and effect window ranges -- are deliberately
not enforced at parse; they are owned by :meth:validate / :meth:check
/ :meth:repair, which report them as structured :class:PlanErrors. This
keeps one code path for the LLM refine loop: from_dict (permissive) ->
:meth:repair (clamp the mechanical ones) -> :meth:check (collect whatever
remains) -> re-prompt with the full structured error list.
Source code in src/videopython/editing/video_edit.py
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 | |
json_schema
classmethod
LLM-facing schema: a discriminated union of operations per slot.
A thin transform over the Pydantic models, so it cannot drift from
them: the operations union is :meth:Operation.json_schema (LLM-exposed
ops by default, per the llm_exposed ClassVar), and every other field
shape and description is derived from SegmentConfig/VideoEdit
model_json_schema() rather than hand-typed. Adding a model field thus
surfaces here automatically; in particular source carries its
"format": "path". The Draft-07 $schema envelope and the default
operations array shape are preserved for downstream LLM tooling.
With strict=True the result is a submittable provider strict-mode
grammar: a closed object root, all properties required (optionality
kept as Pydantic emitted it -- no synthesized nulls), the op union as
anyOf of closed variants, and the union's $defs hoisted to the
document root so every $ref resolves. See :meth:Operation.json_schema
for the strict-mode contract. Use it as a response_format: json_schema
grammar so simple bound violations (window.start >= 0, enums, required
fields) become impossible at decode time. Cross-field constraints
(timestamp < duration, segment-dim equality) cannot live in a grammar
and stay with :meth:check / :meth:repair / :meth:normalize_dimensions.
Source code in src/videopython/editing/video_edit.py
validate
Dry-run the plan via metadata. Requires source files on disk.
Shadows Pydantic v1's deprecated BaseModel.validate classmethod;
use VideoEdit.from_dict/model_validate for plan parsing.
When clamp_windows is True, an :class:Effect's window.stop that
overruns the running predicted duration (e.g. after a duration-shrinking
op like speed_change/cut) is clamped to that duration -- the same
min(stop, total_seconds) value the streaming engine applies at run
time -- instead of raising. Only window.stop is clamped: a window.start past the
duration still hard-raises (a residual divergence from run_to_file(), which
degrades it to a zero-width no-op).
Source code in src/videopython/editing/video_edit.py
validate_with_metadata
validate_with_metadata(
source_metadata: VideoMetadata
| dict[str, VideoMetadata],
context: dict[str, Any] | None = None,
*,
clamp_windows: bool = False,
) -> VideoMetadata
Dry-run with pre-built metadata, avoiding disk access.
See :meth:validate for the clamp_windows semantics.
Source code in src/videopython/editing/video_edit.py
check
check(
source_metadata: VideoMetadata
| dict[str, VideoMetadata],
context: dict[str, Any] | None = None,
*,
clamp_windows: bool = False,
) -> list[PlanError]
Collect every plan error in one pass; [] means valid.
The non-raising sibling of :meth:validate_with_metadata: it runs the
same dry-run but accumulates instead of aborting on the first failure,
so an LLM refine loop can fix all problems in a single re-prompt instead
of playing whack-a-mole across a retry budget. Best-effort: each segment
is checked against its own source metadata, per-op and per-segment errors
collected; a check that cannot run because an earlier one failed (a
segment's op chain past a bad cut, the cross-segment concat check when a
segment did not produce an output) is skipped rather than aborting.
Returns the same :class:PlanError list that
:attr:PlanValidationError.errors carries -- every failure is structured
(no bare ValueError escapes the walk), so a consumer branches on
code rather than substring-matching prose. clamp_windows matches
:meth:validate: a clampable window.stop overrun is not reported.
Streaming is the only engine, so ops that cannot stream at their
plan position are real plan errors: one STREAMING_UNSUPPORTED per
offending op is appended after the validity errors, in plan order,
with the actionable cause in :attr:PlanError.detail. See
:meth:streamability for the full per-op report including the ops
that do stream.
Source code in src/videopython/editing/video_edit.py
streamability
Classify every op by streaming class, without touching the disk.
Streamability is purely structural -- it depends on op classes, their
order, and the plan shape, never on source metadata or runtime context
-- so this needs no source files and is safe to call before a job is
admitted. report.streamable answers "will :meth:run_to_file
stream this plan in O(1) memory, or is an op unstreamable at its
plan position?"; each entry carries the op's memory class and, for
unstreamable ops, the reason.
Source code in src/videopython/editing/video_edit.py
repair
repair(
source_metadata: VideoMetadata
| dict[str, VideoMetadata],
context: dict[str, Any] | None = None,
*,
clamp_op_params: bool = True,
clamp_segment_end: bool = False,
) -> tuple[VideoEdit, list[PlanRepair]]
Return a copy of this plan with the unambiguous violations clamped.
Walks the chain (cut, fps/resolution matching, per-op prediction) and
clamps only the mechanical faults whose fix is not a judgement call,
recording each as a :class:PlanRepair. The returned plan is a deep copy
(self is untouched); the changelog is meant to be surfaced to the
user ("we trimmed your effect to fit"). repair never invents intent
-- genuinely semantic problems (a concat dimension mismatch, an
end <= start range) are left for :meth:check / re-prompting.
With clamp_op_params (default True) it clamps each effect
window.start/window.stop into [0, duration] and each declared
:attr:Operation.time_fields value (e.g. freeze_frame.timestamp past
the clip end) into range, plus a negative segment start to 0.
With clamp_segment_end (default False, since it changes editorial
intent) it also clamps a segment end past the source to the source
end; left False, that case hard-raises as before. Always
:meth:check / :meth:validate the returned plan before running it.
Source code in src/videopython/editing/video_edit.py
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 | |
normalize_dimensions
normalize_dimensions(
source_metadata: VideoMetadata
| dict[str, VideoMetadata],
target: tuple[int, int]
| Literal["first", "largest", "match"],
context: dict[str, Any] | None = None,
) -> tuple[VideoEdit, list[PlanRepair]]
Make every segment concat-compatible by resizing to a common canvas.
CONCAT_MISMATCH is the one class a consumer cannot cleanly repair in
its own layer: detecting it needs each segment's predicted post-op
dimensions, and fixing it needs a per-segment resize inserted before
concat. videopython owns both, so it does it here: predict each segment's
output dimensions, pick the target -- an explicit (width, height),
"first" (the first predictable segment's output), or "largest"
(greatest area) -- and append a resize op to every segment whose
output differs, recording a :class:PlanRepair per insertion. The
returned plan satisfies the "all segments share dimensions" invariant for
every segment it could predict.
Best-effort and non-raising, matching :meth:repair / :meth:check: a
segment that cannot be cut (bad range) or whose op chain fails prediction
is left untouched and its fault deferred to :meth:check, rather than
aborting the whole call. This keeps the documented refine flow
(repair -> normalize_dimensions -> check) a single non-raising path.
When no segment is predictable the plan is returned unchanged with an
empty changelog.
Expressed purely as appended resize ops, so the normal
validate/run/stream paths need no special casing. Resizing to an exact
canvas can distort aspect when segments genuinely differ -- intended for
a plan whose segments already share a target aspect (resolve that
upstream).
Source code in src/videopython/editing/video_edit.py
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 | |
run_to_file
run_to_file(
output_path: str | Path,
format: ALLOWED_VIDEO_FORMATS = "mp4",
preset: ALLOWED_VIDEO_PRESETS = "medium",
crf: int = 23,
context: dict[str, Any] | None = None,
) -> Path
Execute the plan, streaming directly to a file.
Memory usage is O(1) w.r.t. video length (video; segment audio is
in-memory). Streaming is the only engine: a plan with an unstreamable
shape raises :class:PlanValidationError carrying one
STREAMING_UNSUPPORTED :class:PlanError per offending op -- before
any decode. Gate plans early with :meth:check or
:meth:streamability, which report the same errors without running
anything.
Source code in src/videopython/editing/video_edit.py
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 | |
SegmentConfig
SegmentConfig is exported, but most users should construct plans via
VideoEdit.from_dict(...) / VideoEdit.from_json(...).
SegmentConfig
Bases: BaseModel
A single source segment with its operation chain.
Source code in src/videopython/editing/video_edit.py
load
Load the raw segment from disk with optional decode-time matching.