ffman 0.1.0__tar.gz

ffman-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+# Nix
+result
+result-*
+.direnv/
+
+# Python
+__pycache__/
+*.egg-info/
+build/
+dist/
+.venv/
+
+# tool caches and data
+.ruff_cache/
+.pytest_cache/
+.hypothesis/
+.coverage
+.coverage.*

ffman-0.1.0/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ffman-0.1.0/LICENSE-MIT

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026 veralvx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

ffman-0.1.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.5
+Name: ffman
+Version: 0.1.0
+Summary: Opinionated media conversion on ffmpeg: resize, effects, subtitles
+Project-URL: Changelog, https://github.com/veramachine/ffsuite/blob/main/packages/ffman/CHANGELOG.md
+Project-URL: Documentation, https://github.com/veramachine/ffsuite
+Project-URL: Homepage, https://github.com/veramachine/ffsuite
+Project-URL: Issues, https://github.com/veramachine/ffsuite/issues
+Project-URL: Releasenotes, https://github.com/veramachine/ffsuite/releases
+Project-URL: Repository, https://github.com/veramachine/ffsuite
+Author-email: VERA LVX <veralvx@veralvx.com>
+Maintainer-email: VERA LVX <veralvx@veralvx.com>
+License-Expression: (MIT OR Apache-2.0) AND OFL-1.1
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+License-File: src/ffman/fonts/OFL.txt
+Keywords: audio,cli,conversion,effects,ffmpeg,media,metadata,resize,subtitles,video
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
+Classifier: Topic :: Multimedia :: Video :: Conversion
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: ffmeta<0.2,>=0.1
+Requires-Dist: subverter<0.2,>=0.1
+Description-Content-Type: text/markdown
+
+# ffman
+
+Opinionated media conversion on ffmpeg: resize, effects, subtitles, encoding.
+One command, `convert`, transforms one media file; `effects` lists the video
+effects. Lossless by default: a resize keeps the source's codec and loses
+nothing.
+
+## Running it
+
+On Linux or macOS; on Windows, in WSL (ffman refuses to run on Windows itself: it handles its
+tools as POSIX does). From its flake -- on Linux (x86_64, aarch64) or macOS (Apple silicon: not
+yet tested) -- the tools it runs come with it:
+
+```sh
+nix run github:veramachine/ffsuite -- convert -i in.mp4 -w 1280
+```
+
+Or as a container image, built from the flake on Linux, its ffmpeg with Fraunhofer's FDK AAC --
+for your own use: ffmpeg's own build calls such an ffmpeg "nonfree and unredistributable", so no
+binary cache holds it either (it builds from source). Docker, from the folder of your files:
+
+```sh
+nix build github:veramachine/ffsuite#image && ./result | docker load
+docker run --rm --user "$(id -u):$(id -g)" -v "$PWD:/work" ffman:0.1.0 convert -i in.mp4 -w 1280
+```
+
+`ffman convert --help` lists every option; `ffman effects`, the effects and
+their values. `--dry-run` prints the plan and every ffmpeg command, and writes
+nothing. Without `-o`, the output is `STEM.ffman.EXT` beside the input;
+`--in-place` replaces the input.
+
+## What it needs
+
+The Nix package and the image bring everything. Installed any other way, ffman needs
+**ffmpeg** (with ffprobe) on `PATH`; the rest only for what they serve:
+
+| Tool                         | For                                                                    | Without it                              |
+| ---------------------------- | ---------------------------------------------------------------------- | --------------------------------------- |
+| ffmpeg-normalize (and `env`) | `--preset youtube`, when the sound needs normalising                   | that job is refused                     |
+| metaflac (flac)              | a FLAC's cue sheet carried into a FLAC                                 | noted and left out; the job completes   |
+| oxipng, jpegoptim, gifsicle  | PNG, JPEG, GIF outputs optimised losslessly                            | noted; written unoptimised              |
+| nproc (coreutils)            | the processor count: FFV1's slices past four, ffmpeg's threads past 16 | Python's count of the processors, noted |
+
+ffman carries its fonts, IBM Plex Sans for burned captions and IBM Plex Mono for
+the camcorder's stamp (`FFMAN_FONTS_DIR` names another folder), and the ffmpeg-normalize
+presets `--preset youtube` uses (`FFMAN_NORMALIZE_HOME` names another: an `XDG_CONFIG_HOME`,
+its presets in `ffmpeg-normalize/presets/`). Converting metadata files alone (with `meta` or
+`convert`, no media) needs none of the tools.
+
+## Examples
+
+```sh
+# a 9:16 story, the bars filled with the picture, blurred
+ffman convert -i trip.mp4 -a 9:16 -w 1080 -b -o trip.story.mp4
+# burned subtitles, the spoken word highlighted (word timings: whisper-cli -ojf, WhisperX)
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-mode pop
+# the same, the spoken word in a colour of your own
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-colorize '#00BFFF'
+# ...or by name, any case: gold, red, orange, amber, yellow, lime, green, emerald, teal, cyan
+# (aqua), sky, blue, indigo, violet, purple, fuchsia (magenta), pink, rose, slate, gray (grey),
+# zinc, neutral, stone, white, black
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-colorize teal
+# the text in a colour, outlined by contrast (black or white) unless --outline-color says
+ffman convert -i talk.mp4 --burn-subs talk.srt --font-color amber
+# the spoken word boxed in reverse video: the box the text's colour, the word its outline's
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-colorize rectangle
+# ...or the text itself in motion, outlines too
+ffman convert -i talk.mp4 --burn-subs talk.srt --font-color iridescent --outline-color lsd
+# ...or its letters in hues that turn: rainbow, lsd, iridescent
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-colorize rainbow
+# a subtitle track, nothing re-encoded
+ffman convert -i film.mkv --add-subs film.srt --language eng --in-place
+# for YouTube: H.264 High, two passes, AAC
+ffman convert -i clip.mov -p youtube -o clip.mp4
+# a cue sheet as Vorbis comments (a .txt: -p ffmetadata, the default, or vorbiscomment)
+ffman convert -i album.cue -o album.txt -p vorbiscomment
+# a media file's tags and chapters, as ffmetadata (or a .txt, a .cue)
+ffman convert -i film.mkv -o film.ffmeta
+# a metadata file edited (keys: ffmpeg's generic ones, any case), or written anew
+ffman meta -i album.cue --in-place --set genre='Alt Rock' --set date=1991
+ffman meta -o tags.txt -p vorbiscomment --set title=Song --add artist=A --add artist=B
+# chapters (a cue's tracks): TIME as 62.5, 1:02.5, 1:01:02.5 or 4650f (frames)
+ffman meta -i book.ffmeta --in-place --chapter 12:30=Road --retitle 1=Departure
+# a cue sheet's own: its media, a track's flags and pregap (INDEX 00)
+ffman meta -i album.cue --in-place --file album.flac --flags 2=PRE --pregap 2=4:15
+# to stdout: a file's tags and chapters, as read (or -p ffmetadata, vorbiscomment, cue)
+ffman meta -i film.mkv -o -
+# a metadata file's tags and chapters, applied: alone (streams copied), or with any job
+ffman convert -i film.mkv -o tagged.mkv --metadata chapters.cue
+# another container: a remux, each stream copied (or encoded, when asked)
+ffman convert -i clip.webm -o clip.mp4
+ffman convert -i clip.mp4 -o clip.webm --video-codec vp9 --audio-codec opus
+# effects, in any combination
+ffman convert -i home.mp4 --vfx vhs --vfx camcorder:date=1998-07-04 -o home.vhs.mp4
+# a GIF that loops
+ffman convert -i trip.mp4 -w 480 --loop -o trip.gif
+```
+
+## What a conversion keeps
+
+Every stream an input carries is kept where the output holds it, and named
+where it does not (`ffman: ... left out`) -- never dropped without a word:
+
+- subtitles, copied or turned into the output's own text (`mov_text` in MP4,
+  WebVTT in WebM);
+- tags and chapters (into Ogg and FLAC, as `CHAPTERxxx` comments);
+- attachments into Matroska; elsewhere an attached cue, ffmetadata or Vorbis
+  comments file is applied as `--metadata` would apply it;
+- the cover, copied, or into Matroska attached as `cover.png` (`cover_land`
+  when wider than tall).
+
+The rules, each measured:
+[`ffman-spec.md`](https://github.com/veramachine/ffsuite/blob/main/docs/ffman-spec.md) 3.12 to 3.15.
+
+## More
+
+- The command line's contract:
+  [`ffman-spec.md`](https://github.com/veramachine/ffsuite/blob/main/docs/ffman-spec.md).
+- Every decision, with its evidence and the module it lives in:
+  [`docs/decisions.md`](https://github.com/veramachine/ffsuite/blob/main/docs/decisions.md).
+- Changes, release by release:
+  [`CHANGELOG.md`](https://github.com/veramachine/ffsuite/blob/main/packages/ffman/CHANGELOG.md).
+- Working on it: [`AGENTS.md`](https://github.com/veramachine/ffsuite/blob/main/AGENTS.md).
+
+It replaced a bash ffman (retired in phase 5 of
+[`ffman-python.md`](https://github.com/veramachine/ffsuite/blob/main/docs/ffman-python.md)),
+after equalling it on every invocation of the bash suites; what it changed on purpose:
+[`ffman-from-bash.md`](https://github.com/veramachine/ffsuite/blob/main/docs/ffman-from-bash.md).
+
+## Licence
+
+Part of [ffsuite](https://github.com/veramachine/ffsuite), beside its libraries ffmeta and
+subverter. Licensed under either of
+[MIT](https://github.com/veramachine/ffsuite/blob/main/packages/ffman/LICENSE-MIT)
+or [Apache-2.0](https://github.com/veramachine/ffsuite/blob/main/packages/ffman/LICENSE-APACHE),
+at your option; its fonts, IBM Plex, under the
+[OFL](https://github.com/veramachine/ffsuite/blob/main/packages/ffman/src/ffman/fonts/OFL.txt).

ffman-0.1.0/README.md

@@ -0,0 +1,137 @@
+# ffman
+
+Opinionated media conversion on ffmpeg: resize, effects, subtitles, encoding.
+One command, `convert`, transforms one media file; `effects` lists the video
+effects. Lossless by default: a resize keeps the source's codec and loses
+nothing.
+
+## Running it
+
+On Linux or macOS; on Windows, in WSL (ffman refuses to run on Windows itself: it handles its
+tools as POSIX does). From its flake -- on Linux (x86_64, aarch64) or macOS (Apple silicon: not
+yet tested) -- the tools it runs come with it:
+
+```sh
+nix run github:veramachine/ffsuite -- convert -i in.mp4 -w 1280
+```
+
+Or as a container image, built from the flake on Linux, its ffmpeg with Fraunhofer's FDK AAC --
+for your own use: ffmpeg's own build calls such an ffmpeg "nonfree and unredistributable", so no
+binary cache holds it either (it builds from source). Docker, from the folder of your files:
+
+```sh
+nix build github:veramachine/ffsuite#image && ./result | docker load
+docker run --rm --user "$(id -u):$(id -g)" -v "$PWD:/work" ffman:0.1.0 convert -i in.mp4 -w 1280
+```
+
+`ffman convert --help` lists every option; `ffman effects`, the effects and
+their values. `--dry-run` prints the plan and every ffmpeg command, and writes
+nothing. Without `-o`, the output is `STEM.ffman.EXT` beside the input;
+`--in-place` replaces the input.
+
+## What it needs
+
+The Nix package and the image bring everything. Installed any other way, ffman needs
+**ffmpeg** (with ffprobe) on `PATH`; the rest only for what they serve:
+
+| Tool                         | For                                                                    | Without it                              |
+| ---------------------------- | ---------------------------------------------------------------------- | --------------------------------------- |
+| ffmpeg-normalize (and `env`) | `--preset youtube`, when the sound needs normalising                   | that job is refused                     |
+| metaflac (flac)              | a FLAC's cue sheet carried into a FLAC                                 | noted and left out; the job completes   |
+| oxipng, jpegoptim, gifsicle  | PNG, JPEG, GIF outputs optimised losslessly                            | noted; written unoptimised              |
+| nproc (coreutils)            | the processor count: FFV1's slices past four, ffmpeg's threads past 16 | Python's count of the processors, noted |
+
+ffman carries its fonts, IBM Plex Sans for burned captions and IBM Plex Mono for
+the camcorder's stamp (`FFMAN_FONTS_DIR` names another folder), and the ffmpeg-normalize
+presets `--preset youtube` uses (`FFMAN_NORMALIZE_HOME` names another: an `XDG_CONFIG_HOME`,
+its presets in `ffmpeg-normalize/presets/`). Converting metadata files alone (with `meta` or
+`convert`, no media) needs none of the tools.
+
+## Examples
+
+```sh
+# a 9:16 story, the bars filled with the picture, blurred
+ffman convert -i trip.mp4 -a 9:16 -w 1080 -b -o trip.story.mp4
+# burned subtitles, the spoken word highlighted (word timings: whisper-cli -ojf, WhisperX)
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-mode pop
+# the same, the spoken word in a colour of your own
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-colorize '#00BFFF'
+# ...or by name, any case: gold, red, orange, amber, yellow, lime, green, emerald, teal, cyan
+# (aqua), sky, blue, indigo, violet, purple, fuchsia (magenta), pink, rose, slate, gray (grey),
+# zinc, neutral, stone, white, black
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-colorize teal
+# the text in a colour, outlined by contrast (black or white) unless --outline-color says
+ffman convert -i talk.mp4 --burn-subs talk.srt --font-color amber
+# the spoken word boxed in reverse video: the box the text's colour, the word its outline's
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-colorize rectangle
+# ...or the text itself in motion, outlines too
+ffman convert -i talk.mp4 --burn-subs talk.srt --font-color iridescent --outline-color lsd
+# ...or its letters in hues that turn: rainbow, lsd, iridescent
+ffman convert -i talk.mp4 --burn-subs talk.json --overlay-mode chunk-word --highlight-colorize rainbow
+# a subtitle track, nothing re-encoded
+ffman convert -i film.mkv --add-subs film.srt --language eng --in-place
+# for YouTube: H.264 High, two passes, AAC
+ffman convert -i clip.mov -p youtube -o clip.mp4
+# a cue sheet as Vorbis comments (a .txt: -p ffmetadata, the default, or vorbiscomment)
+ffman convert -i album.cue -o album.txt -p vorbiscomment
+# a media file's tags and chapters, as ffmetadata (or a .txt, a .cue)
+ffman convert -i film.mkv -o film.ffmeta
+# a metadata file edited (keys: ffmpeg's generic ones, any case), or written anew
+ffman meta -i album.cue --in-place --set genre='Alt Rock' --set date=1991
+ffman meta -o tags.txt -p vorbiscomment --set title=Song --add artist=A --add artist=B
+# chapters (a cue's tracks): TIME as 62.5, 1:02.5, 1:01:02.5 or 4650f (frames)
+ffman meta -i book.ffmeta --in-place --chapter 12:30=Road --retitle 1=Departure
+# a cue sheet's own: its media, a track's flags and pregap (INDEX 00)
+ffman meta -i album.cue --in-place --file album.flac --flags 2=PRE --pregap 2=4:15
+# to stdout: a file's tags and chapters, as read (or -p ffmetadata, vorbiscomment, cue)
+ffman meta -i film.mkv -o -
+# a metadata file's tags and chapters, applied: alone (streams copied), or with any job
+ffman convert -i film.mkv -o tagged.mkv --metadata chapters.cue
+# another container: a remux, each stream copied (or encoded, when asked)
+ffman convert -i clip.webm -o clip.mp4
+ffman convert -i clip.mp4 -o clip.webm --video-codec vp9 --audio-codec opus
+# effects, in any combination
+ffman convert -i home.mp4 --vfx vhs --vfx camcorder:date=1998-07-04 -o home.vhs.mp4
+# a GIF that loops
+ffman convert -i trip.mp4 -w 480 --loop -o trip.gif
+```
+
+## What a conversion keeps
+
+Every stream an input carries is kept where the output holds it, and named
+where it does not (`ffman: ... left out`) -- never dropped without a word:
+
+- subtitles, copied or turned into the output's own text (`mov_text` in MP4,
+  WebVTT in WebM);
+- tags and chapters (into Ogg and FLAC, as `CHAPTERxxx` comments);
+- attachments into Matroska; elsewhere an attached cue, ffmetadata or Vorbis
+  comments file is applied as `--metadata` would apply it;
+- the cover, copied, or into Matroska attached as `cover.png` (`cover_land`
+  when wider than tall).
+
+The rules, each measured:
+[`ffman-spec.md`](https://github.com/veramachine/ffsuite/blob/main/docs/ffman-spec.md) 3.12 to 3.15.
+
+## More
+
+- The command line's contract:
+  [`ffman-spec.md`](https://github.com/veramachine/ffsuite/blob/main/docs/ffman-spec.md).
+- Every decision, with its evidence and the module it lives in:
+  [`docs/decisions.md`](https://github.com/veramachine/ffsuite/blob/main/docs/decisions.md).
+- Changes, release by release:
+  [`CHANGELOG.md`](https://github.com/veramachine/ffsuite/blob/main/packages/ffman/CHANGELOG.md).
+- Working on it: [`AGENTS.md`](https://github.com/veramachine/ffsuite/blob/main/AGENTS.md).
+
+It replaced a bash ffman (retired in phase 5 of
+[`ffman-python.md`](https://github.com/veramachine/ffsuite/blob/main/docs/ffman-python.md)),
+after equalling it on every invocation of the bash suites; what it changed on purpose:
+[`ffman-from-bash.md`](https://github.com/veramachine/ffsuite/blob/main/docs/ffman-from-bash.md).
+
+## Licence
+
+Part of [ffsuite](https://github.com/veramachine/ffsuite), beside its libraries ffmeta and
+subverter. Licensed under either of
+[MIT](https://github.com/veramachine/ffsuite/blob/main/packages/ffman/LICENSE-MIT)
+or [Apache-2.0](https://github.com/veramachine/ffsuite/blob/main/packages/ffman/LICENSE-APACHE),
+at your option; its fonts, IBM Plex, under the
+[OFL](https://github.com/veramachine/ffsuite/blob/main/packages/ffman/src/ffman/fonts/OFL.txt).

ffman-0.1.0/pyproject.toml

@@ -0,0 +1,91 @@
+[build-system]
+# 1.26.0 brought license-files to PEP 639's final form; 1.26.2 fixed the metadata 1.26.0 wrote
+# for older core-metadata versions (hatchling's changelog)
+requires = ["hatchling>=1.26.2"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ffman"
+version = "0.1.0"
+description = "Opinionated media conversion on ffmpeg: resize, effects, subtitles"
+readme = "README.md"
+# the owner's: MIT or Apache-2.0, the user's choice; the wheel carries the OFL fonts. The
+# parentheses are the meaning: SPDX applies AND before OR (3.0.1, Annex B)
+license = "(MIT OR Apache-2.0) AND OFL-1.1"
+license-files = ["LICENSE-MIT", "LICENSE-APACHE", "src/ffman/fonts/OFL.txt"]
+requires-python = ">=3.13"
+authors = [{ name = "VERA LVX", email = "veralvx@veralvx.com" }]
+maintainers = [{ name = "VERA LVX", email = "veralvx@veralvx.com" }]
+keywords = [
+    "ffmpeg",
+    "video",
+    "audio",
+    "subtitles",
+    "media",
+    "conversion",
+    "resize",
+    "effects",
+    "metadata",
+    "cli",
+]
+# https://pypi.org/classifiers/ -- no License :: one: with a license expression, PyPI rejects
+# the upload (PEP 639). POSIX: process groups, killpg, SIGHUP (media/run.py)
+classifiers = [
+    "Development Status :: 4 - Beta", # 0.x, as its libraries: young, not yet stable (the owner's)
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Natural Language :: English",
+    "Operating System :: POSIX",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Multimedia :: Graphics :: Graphics Conversion",
+    "Topic :: Multimedia :: Sound/Audio :: Conversion",
+    "Topic :: Multimedia :: Video :: Conversion",
+    "Typing :: Typed",
+]
+# each library's 0.1 line: in 0.x a minor release may break, so the next is kept out (PEP 440:
+# `<0.2` admits no 0.2 pre-release either)
+dependencies = ["ffmeta>=0.1,<0.2", "subverter>=0.1,<0.2"]
+
+[project.urls]
+Changelog = "https://github.com/veramachine/ffsuite/blob/main/packages/ffman/CHANGELOG.md"
+Documentation = "https://github.com/veramachine/ffsuite"
+Homepage = "https://github.com/veramachine/ffsuite"
+Issues = "https://github.com/veramachine/ffsuite/issues"
+Releasenotes = "https://github.com/veramachine/ffsuite/releases"
+Repository = "https://github.com/veramachine/ffsuite"
+
+[project.scripts]
+ffman = "ffman.__main__:main"
+
+[tool.uv.sources]
+ffmeta = { workspace = true }
+subverter = { workspace = true }
+
+[tool.hatch.build.targets.sdist]
+# hatchling adds pyproject.toml, the README and the licence files itself. Its tests pass from it
+# alone (measured); the repository's own are left out -- test_workspace (it reads the whole
+# workspace) and the outcome harness with its test (it compares the repository's revisions,
+# each run on its own sources)
+only-include = ["src", "tests", "CHANGELOG.md"]
+exclude = ["tests/test_workspace.py", "tests/test_outcome.py", "tests/outcome"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ffman"]
+
+[tool.pytest.ini_options]
+# its own, for its sdist's tests alone; from the repository's root, the root's governs
+minversion = "9.0"
+testpaths = ["tests"]
+pythonpath = ["."]
+addopts = ["--strict-markers", "--strict-config", "-ra", "--import-mode=importlib"]
+xfail_strict = true
+filterwarnings = ["error"]
+timeout = 600
+markers = [
+    "ffmpeg: needs a pinned tool, ffmpeg 8.1 or metaflac 1.5 (integration)",
+    "slow: the combination matrix",
+]