ffmpeg-skill 1.22.0 → 1.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/contract.md +20 -16
- package/mcp/server.py +7 -2
- package/package.json +1 -1
- package/scripts/_contract.py +6 -2
package/docs/contract.md
CHANGED
|
@@ -21,7 +21,7 @@ The contract is derived from the code that runs, not maintained beside it:
|
|
|
21
21
|
| Field | Meaning | Changes when |
|
|
22
22
|
|---|---|---|
|
|
23
23
|
| `contract_version` | shape of this document (`1.0`) | a key is renamed, removed or changes meaning |
|
|
24
|
-
| `skill.version` | the npm / package.json version (`1.
|
|
24
|
+
| `skill.version` | the npm / package.json version (`1.23.0`) | any release |
|
|
25
25
|
|
|
26
26
|
A release that adds a tool or a flag keeps `contract_version`; a breaking change to the
|
|
27
27
|
ToolSpec shape bumps it. Consumers pin on `contract_version` and read `skill.version`
|
|
@@ -88,19 +88,19 @@ spelling keeps working until 2.0.
|
|
|
88
88
|
|
|
89
89
|
| What 2.0 removes | Since | Replacement | To be ready today |
|
|
90
90
|
|---|---|---|---|
|
|
91
|
-
| The per-tool v1 success keys next to `result_v2` (`output`, `probe`, `commands`, `verified`, `verification` and each tool's own keys at the top level) | 1.
|
|
92
|
-
| `--crf` as an alias of `--quality` on every re-encoding tool that takes `--quality` (`export.py` keeps `--crf`: its preset chooses the encoder) | 1.
|
|
93
|
-
| `json` and `progress` in the MCP `inputSchema` | 1.
|
|
94
|
-
| `hdr` meaning "BT.2020 primaries *or* a PQ/HLG transfer" in `probe` | 1.
|
|
95
|
-
| Overwriting an existing output with only a warning | 1.
|
|
91
|
+
| The per-tool v1 success keys next to `result_v2` (`output`, `probe`, `commands`, `verified`, `verification` and each tool's own keys at the top level) | 1.23.0 | `result_v2`, promoted to the top level in 2.0 | Run with `FFMPEG_SKILL_RESULT_V2=1` and read `result_v2` (`metrics`, `notes`, `details`) instead of the top-level keys |
|
|
92
|
+
| `--crf` as an alias of `--quality` on every re-encoding tool that takes `--quality` (`export.py` keeps `--crf`: its preset chooses the encoder) | 1.23.0 | `--quality N` (the same CRF scale, codec-neutral) | Pass `--quality`; `--crf` warns on stderr and is marked in `--help` |
|
|
93
|
+
| `json` and `progress` in the MCP `inputSchema` | 1.23.0 | nothing: the transport sets them itself | Stop sending them from an MCP client; run the server with `FFMPEG_SKILL_MCP_LEAN=1` to see the 2.0 schema |
|
|
94
|
+
| `hdr` meaning "BT.2020 primaries *or* a PQ/HLG transfer" in `probe` | 1.23.0 | `hdr_signal` (true only for PQ / HLG / Dolby Vision); in 2.0 `hdr` takes that meaning | Key on `hdr_signal` for "is this a real HDR signal" and on `hdr_format` for the `BT.2020 SDR` case |
|
|
95
|
+
| Overwriting an existing output with only a warning | 1.23.0 | `--overwrite` as explicit consent (refused without it from 2.0) | Set `FFMPEG_SKILL_NO_OVERWRITE=1` (the recommended agent setting) and pass `--overwrite` where a replacement is intended |
|
|
96
96
|
|
|
97
97
|
## Skill
|
|
98
98
|
|
|
99
99
|
```json
|
|
100
100
|
{
|
|
101
101
|
"contract_version": "1.0",
|
|
102
|
-
"deprecated": [{"what": "...", "since": "1.
|
|
103
|
-
"skill": {"id": "ffmpeg-skill", "version": "1.
|
|
102
|
+
"deprecated": [{"what": "...", "since": "1.23.0", "replacement": "...", "removed_in": "2.0.0", "where": "cli | json | mcp | behaviour"}],
|
|
103
|
+
"skill": {"id": "ffmpeg-skill", "version": "1.23.0", "execution_mode": "local", "kind": "execution",
|
|
104
104
|
"entrypoints": {"cli": "...", "mcp": "...", "contract": "...", "doctor": "..."},
|
|
105
105
|
"not_provided": ["AI reasoning", "decisions", "production plans", "project IR", "approvals", "network access", "transcription engine"]},
|
|
106
106
|
"requirements": {"python": ">=3.9 (standard library only)", "ffmpeg": ">=5.0", "ffprobe": ">=5.0"},
|
|
@@ -120,7 +120,7 @@ One entry per tool under `tools`, sorted by id. Tool ids are stable:
|
|
|
120
120
|
| Field | Meaning |
|
|
121
121
|
|---|---|
|
|
122
122
|
| `id`, `name`, `version`, `executable` | `ffmpeg-skill/cut`, `cut`, skill version, `scripts/cut.py` |
|
|
123
|
-
| `examples[]` | `{prompts[], command}` (1.
|
|
123
|
+
| `examples[]` | `{prompts[], command}` (1.23.0): SKILL.md's own "User says" / "Do" table rows for this tool, machine-readable — `prompts` is the row's phrasing(s), `command` the row's `Do` text with the markdown backticks stripped. Every tool has at least one; parsed from SKILL.md at read time, so it never drifts from the table a person reads |
|
|
124
124
|
| `role` | `analysis`, `analysis_and_execution`, `execution` or `verification` (see below) |
|
|
125
125
|
| `capabilities.required` | ffmpeg components the tool always needs |
|
|
126
126
|
| `capabilities.optional[]` | `{capability, when}`: needed only for that flag or input |
|
|
@@ -129,7 +129,7 @@ One entry per tool under `tools`, sorted by id. Tool ids are stable:
|
|
|
129
129
|
| `output_schema` | what `--json` prints on stdout |
|
|
130
130
|
| `supports_dry_run`, `dry_run` | whether `--dry-run` plans without running ffmpeg or writing files |
|
|
131
131
|
| `supports_json` | whether `--json` exists |
|
|
132
|
-
| `supports_json_brief` | whether `--json-brief` exists (1.
|
|
132
|
+
| `supports_json_brief` | whether `--json-brief` exists (1.23.0): the same success document with `probe` replaced by a compact `summary` (`duration_s`, `width`, `height`, `fps`, `vcodec`, `acodec`, `channels`, and `lufs` when the tool measured one), `commands` replaced by the number of commands run, and the per-step `verification` list dropped (its verdict stays in `verified`). Tool-specific keys are unchanged, `--json`'s own output is unchanged, and a failure prints the same failure document either way |
|
|
133
133
|
| `mutates_input` | always `false`: no tool overwrites its input |
|
|
134
134
|
| `produces_artifact` | writes a file (media, PNG, HTML, EDL) |
|
|
135
135
|
| `verification` | `{required, tools}`: which tools to run on the output afterwards |
|
|
@@ -435,7 +435,7 @@ given a different type):
|
|
|
435
435
|
|
|
436
436
|
| key | tool | what it holds |
|
|
437
437
|
|---|---|---|
|
|
438
|
-
| `caption` | `caption.py` | the cue-layout counts the run only printed before (`shifted`, `wrapped`, `rebalanced`, `split`, `extended`, `dropped`) plus `wrap` (`"phrase"` or `"measured"`) and `phrase_breaks`, the number of cues a phrase rule broke somewhere the 1.15 width rule would not. `broken_inside_word` (1.
|
|
438
|
+
| `caption` | `caption.py` | the cue-layout counts the run only printed before (`shifted`, `wrapped`, `rebalanced`, `split`, `extended`, `dropped`) plus `wrap` (`"phrase"` or `"measured"`) and `phrase_breaks`, the number of cues a phrase rule broke somewhere the 1.15 width rule would not. `broken_inside_word` (1.23.0) counts atoms hard-sliced at the live column's edge because they did not fit alone even at the size floor — never a rewrite, the sliced pieces are the exact original characters. `overlong` is now residual: it fires only when even a single character is wider than the column |
|
|
439
439
|
| `tracks`, `subtitle_tracks` | `caption.py --mode mux` | one entry per subtitle stream in the output — `{index, file, language, title, codec, default, cues, kept_from_input}`; a stream the input already carried has `file: null` and `kept_from_input: true`. `subtitle_tracks` is the total. Every field describes the file as written, not as asked for: an MPEG-4 output reports `title: null` (the muxer stores none) and `default: true` on its first track (the muxer always enables it), each with a `notes` line |
|
|
440
440
|
| `auto_chapters` | `metadata.py --auto-chapters` | `{source, min_chapter, max_chapters, proposed, kept, titles, chapters, description_block, files}`. `titles` is always `"placeholder"`: the machine-readable form of "the skill did not name these". Each chapter carries its `evidence` (`start`, `silence`, `scene`, or `silence+scene` with the span, its length and the cut time) |
|
|
441
441
|
| `audiogram` | `waveform.py` (every run) | `{style, background, image, position, vis_height, platform, captions, title, stages, verified}`. `background` is `"image"` or `"color"`; `verified` is true when the render probes at the asked-for frame size, frame rate and within 0.05 s of the source audio, and is `false` under `--dry-run`, where nothing was rendered to verify |
|
|
@@ -451,7 +451,7 @@ Per-tool keys added in 1.17, all additive:
|
|
|
451
451
|
| `jobs`, `jobs_requested`, `wall_seconds`, `item_seconds_total`, `timed_out` | `batch.py` | the parallelism actually applied and the number asked for, the batch's wall clock, the sum of the per-item times (so the speed-up can be quoted), and whether the shared timeout budget ran out. A timed-out item carries `"skipped": "timeout"` in its result row |
|
|
452
452
|
| `cache` | `render.py --cache` | `{dir, ffmpeg, hits, misses, saved_seconds, entries}`, plus `would_hit` under `--dry-run`. The ffmpeg build banner, the skill version, the contract version, the forwarded flags (`--fast`, `--codec`, …) and the output's extension are all part of every key, so a cache is never reused across any of them — a `--fast` draft is never served to a run that did not ask for one |
|
|
453
453
|
|
|
454
|
-
Per-tool keys added in 1.
|
|
454
|
+
Per-tool keys added in 1.23.0, all additive:
|
|
455
455
|
|
|
456
456
|
| key | tool | what it holds |
|
|
457
457
|
|---|---|---|
|
|
@@ -459,7 +459,7 @@ Per-tool keys added in 1.22.0, all additive:
|
|
|
459
459
|
| `text_unchanged` | `caption.py` | a sibling inside the `caption` block, **burn mode only** (`--mode mux` never touches the text and omits the key): `true` when the drawn text equals the cues that were handed in — nothing transcribed, no cue dropped, no cue **split** across two consecutive cues and no glyph stripped (`--emoji none`). Wrapping, line breaks and timing do not count: the words are the same. This tool never rewrites, shortens or translates a cue, so the key is a statement of what happened, not a judgement of the text |
|
|
460
460
|
|
|
461
461
|
|
|
462
|
-
Per-tool keys added in 1.
|
|
462
|
+
Per-tool keys added in 1.23.0, all additive:
|
|
463
463
|
|
|
464
464
|
| key | tool | what it holds |
|
|
465
465
|
|---|---|---|
|
|
@@ -541,8 +541,12 @@ argparse parser → ToolSpec.input_schema → contract → MCP tools/list
|
|
|
541
541
|
|
|
542
542
|
At start-up the server builds the ToolSpecs (`_contract.build(detect=False)`) and
|
|
543
543
|
derives each `tools/list` entry with `_contract.mcp_tool`: the name is the ToolSpec
|
|
544
|
-
name,
|
|
545
|
-
`
|
|
544
|
+
name, `description` is the ToolSpec's own one-line description (unchanged from the
|
|
545
|
+
CLI's `--help` first line), the order is the contract's sorted order, and `inputSchema` is
|
|
546
|
+
`_contract.mcp_input_schema(ToolSpec)`. The structured-arguments note that explains how to
|
|
547
|
+
call a tool (`_contract.MCP_STRUCTURED_NOTE`) is server-wide, not per-tool: it is sent once,
|
|
548
|
+
in `initialize`'s `instructions` field, rather than appended to all 42 descriptions (1.20.0).
|
|
549
|
+
`tools/call` maps structured arguments to
|
|
546
550
|
argv with the ToolSpec's `mcp.positional` and `mcp.argument_exceptions`. A new
|
|
547
551
|
public script, a removed one, or a changed parser therefore changes the MCP surface
|
|
548
552
|
with no edit to `mcp/`; `tests/test_contract.py` proves this by copying the skill,
|
|
@@ -589,7 +593,7 @@ most often across the corpus in `evals/agent_prompts*.json`. Every tool -- inclu
|
|
|
589
593
|
-- is still callable by name through `tools/call` regardless of what `tools/list` advertised; the
|
|
590
594
|
contract (`ffmpeg-skill contract --json`) still describes all 42 unconditionally. Set
|
|
591
595
|
`FFMPEG_SKILL_MCP_FULL=1` (anything but "" or `0`) in the server's environment to make `tools/list`
|
|
592
|
-
return all 42, as every version before 1.
|
|
596
|
+
return all 42, as every version before 1.23.0 did.
|
|
593
597
|
|
|
594
598
|
## Consuming the contract from an agent
|
|
595
599
|
|
package/mcp/server.py
CHANGED
|
@@ -147,7 +147,12 @@ def handle(req: Dict[str, Any]) -> Dict[str, Any]:
|
|
|
147
147
|
method = req.get("method")
|
|
148
148
|
params = req.get("params") or {}
|
|
149
149
|
if method == "initialize":
|
|
150
|
-
|
|
150
|
+
# 1.20.0: the structured-arguments note used to be appended to every one of the 42 tool
|
|
151
|
+
# descriptions verbatim; it's server-wide, not per-tool, so it now lives here once instead
|
|
152
|
+
# -- `tools/list` descriptions stay each tool's own one-line sentence.
|
|
153
|
+
return {"protocolVersion": PROTOCOL_VERSION, "capabilities": {"tools": {}},
|
|
154
|
+
"serverInfo": {"name": "ffmpeg-skill", "version": version()},
|
|
155
|
+
"instructions": _contract.MCP_STRUCTURED_NOTE}
|
|
151
156
|
if method == "tools/list":
|
|
152
157
|
return {"tools": tool_list()}
|
|
153
158
|
if method == "tools/call":
|
|
@@ -167,7 +172,7 @@ def version() -> str:
|
|
|
167
172
|
def main() -> int:
|
|
168
173
|
if "--list" in sys.argv:
|
|
169
174
|
for t in tool_list():
|
|
170
|
-
print(f"{t['name']:10s} {t['description']
|
|
175
|
+
print(f"{t['name']:10s} {t['description']}")
|
|
171
176
|
return 0
|
|
172
177
|
if "--call" in sys.argv: # debugging helper: --call NAME '{"input": "..."}'
|
|
173
178
|
i = sys.argv.index("--call")
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ffmpeg-skill",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.23.0",
|
|
4
4
|
"description": "Agent Skill that gives coding agents (Claude Code, Cursor, Codex) a local video editor: 42 FFmpeg tools with a machine-readable contract, contract-derived MCP server, FFmpeg capability detection, probe-first / verify-last workflow. Cut, join, silence removal, fit, captions and karaoke, overlays, motion graphics, HDR to SDR, LUTs, audio clean-up and typed dynamics, sync with drift correction, multicam, loudness, delivery checks, project rendering, batch. No API keys, no cloud, no dependencies.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ffmpeg",
|
package/scripts/_contract.py
CHANGED
|
@@ -1187,8 +1187,12 @@ def mcp_input_schema(spec: Dict[str, Any]) -> Dict[str, Any]:
|
|
|
1187
1187
|
|
|
1188
1188
|
|
|
1189
1189
|
def mcp_tool(spec: Dict[str, Any]) -> Dict[str, Any]:
|
|
1190
|
-
"""The MCP tools/list entry for a ToolSpec: name, description and the derived
|
|
1191
|
-
|
|
1190
|
+
"""The MCP tools/list entry for a ToolSpec: name, one-line description and the derived
|
|
1191
|
+
inputSchema. 1.20.0: MCP_STRUCTURED_NOTE used to be appended to every one of the 42
|
|
1192
|
+
descriptions verbatim (the same ~250 characters repeated 42 times in every tools/list dump);
|
|
1193
|
+
it now goes once into the server's `initialize` response (`instructions`) instead, so a tool's
|
|
1194
|
+
own description stays its own one-line sentence."""
|
|
1195
|
+
return {"name": spec["name"], "description": spec["description"], "inputSchema": mcp_input_schema(spec)}
|
|
1192
1196
|
|
|
1193
1197
|
|
|
1194
1198
|
def mcp_tools(detect: bool = False) -> List[Dict[str, Any]]:
|