ffmeta 0.1.0__tar.gz

ffmeta-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.*

ffmeta-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.

ffmeta-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.

ffmeta-0.1.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.5
+Name: ffmeta
+Version: 0.1.0
+Summary: Media metadata files -- ffmetadata, Vorbis comments, cue sheets -- read, written and converted through one model
+Project-URL: Changelog, https://github.com/veramachine/ffsuite/blob/main/packages/ffmeta/CHANGELOG.md
+Project-URL: Homepage, https://github.com/veramachine/ffsuite/tree/main/packages/ffmeta
+Project-URL: Issues, https://github.com/veramachine/ffsuite/issues
+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
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Keywords: chapters,cue,cuesheet,ffmetadata,flac,metadata,opus,tags,vorbis,vorbiscomment
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+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 :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# ffmeta
+
+Media metadata files read, written and converted through one model: FFmpeg's
+ffmetadata, Vorbis comments, and cue sheets.
+
+It is pure -- text in, text out: no ffmpeg, no file opened. A file read becomes
+one model -- its tags, its streams' tags, its chapters, a cue sheet's disc;
+written in another format, what that format cannot hold is told as a note, never
+dropped in silence.
+
+| Format         | What it is                                                           |
+| -------------- | -------------------------------------------------------------------- |
+| ffmetadata     | FFmpeg's `;FFMETADATA1` text: global and stream tags, chapters       |
+| Vorbis comment | `NAME=value` lines, as `vorbiscomment` and `metaflac` read and write |
+| Cue sheet      | the CDRWIN format: an album's tracks, their times and fields         |
+
+What crosses between them, field by field and with its reasons, is
+[ffsuite's mappings skill](https://github.com/veramachine/ffsuite/blob/main/.agents/skills/metadata-mappings/SKILL.md).
+
+## Installing
+
+```sh
+pip install ffmeta
+```
+
+Python 3.13 or later; the standard library alone.
+
+## Using it
+
+```pycon
+>>> import ffmeta
+>>> text = ";FFMETADATA1\ntitle=Album\n\n[CHAPTER]\nTIMEBASE=1/1000\nSTART=0\nEND=60000\ntitle=One\n"
+>>> meta = ffmeta.read(text, "ffmetadata", "album.ffmeta")
+>>> converted = ffmeta.convert(meta, "ffmetadata", "vorbis")
+>>> written = ffmeta.write(converted.meta, "vorbis")
+>>> print(written.text, end="")
+title=Album
+CHAPTER000=00:00:00.000
+CHAPTER000NAME=One
+>>> converted.notes + written.notes
+('chapter ends: Vorbis comments hold none (a chapter ends where the next begins): left out',)
+>>> ffmeta.read("title=x\n", "ffmetadata", "bad.ffmeta")
+Traceback (most recent call last):
+  ...
+ffmeta.Error: bad.ffmeta:1: not ffmetadata: the first line must begin ;FFMETADATA: title=x
+```
+
+What crosses into the target is converted; what does not is a note, from
+`convert` (a field the target lacks) or `write` (a structure it lacks). A text
+that cannot be read is refused: `ffmeta.Error`, its message the reason.
+
+## Licence
+
+Part of [ffsuite](https://github.com/veramachine/ffsuite), beside ffman: its own package.
+Licensed under either of
+[MIT](https://github.com/veramachine/ffsuite/blob/main/packages/ffmeta/LICENSE-MIT)
+or [Apache-2.0](https://github.com/veramachine/ffsuite/blob/main/packages/ffmeta/LICENSE-APACHE),
+at your option.

ffmeta-0.1.0/README.md

@@ -0,0 +1,58 @@
+# ffmeta
+
+Media metadata files read, written and converted through one model: FFmpeg's
+ffmetadata, Vorbis comments, and cue sheets.
+
+It is pure -- text in, text out: no ffmpeg, no file opened. A file read becomes
+one model -- its tags, its streams' tags, its chapters, a cue sheet's disc;
+written in another format, what that format cannot hold is told as a note, never
+dropped in silence.
+
+| Format         | What it is                                                           |
+| -------------- | -------------------------------------------------------------------- |
+| ffmetadata     | FFmpeg's `;FFMETADATA1` text: global and stream tags, chapters       |
+| Vorbis comment | `NAME=value` lines, as `vorbiscomment` and `metaflac` read and write |
+| Cue sheet      | the CDRWIN format: an album's tracks, their times and fields         |
+
+What crosses between them, field by field and with its reasons, is
+[ffsuite's mappings skill](https://github.com/veramachine/ffsuite/blob/main/.agents/skills/metadata-mappings/SKILL.md).
+
+## Installing
+
+```sh
+pip install ffmeta
+```
+
+Python 3.13 or later; the standard library alone.
+
+## Using it
+
+```pycon
+>>> import ffmeta
+>>> text = ";FFMETADATA1\ntitle=Album\n\n[CHAPTER]\nTIMEBASE=1/1000\nSTART=0\nEND=60000\ntitle=One\n"
+>>> meta = ffmeta.read(text, "ffmetadata", "album.ffmeta")
+>>> converted = ffmeta.convert(meta, "ffmetadata", "vorbis")
+>>> written = ffmeta.write(converted.meta, "vorbis")
+>>> print(written.text, end="")
+title=Album
+CHAPTER000=00:00:00.000
+CHAPTER000NAME=One
+>>> converted.notes + written.notes
+('chapter ends: Vorbis comments hold none (a chapter ends where the next begins): left out',)
+>>> ffmeta.read("title=x\n", "ffmetadata", "bad.ffmeta")
+Traceback (most recent call last):
+  ...
+ffmeta.Error: bad.ffmeta:1: not ffmetadata: the first line must begin ;FFMETADATA: title=x
+```
+
+What crosses into the target is converted; what does not is a note, from
+`convert` (a field the target lacks) or `write` (a structure it lacks). A text
+that cannot be read is refused: `ffmeta.Error`, its message the reason.
+
+## Licence
+
+Part of [ffsuite](https://github.com/veramachine/ffsuite), beside ffman: its own package.
+Licensed under either of
+[MIT](https://github.com/veramachine/ffsuite/blob/main/packages/ffmeta/LICENSE-MIT)
+or [Apache-2.0](https://github.com/veramachine/ffsuite/blob/main/packages/ffmeta/LICENSE-APACHE),
+at your option.

ffmeta-0.1.0/pyproject.toml

@@ -0,0 +1,73 @@
+[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 = "ffmeta"
+version = "0.1.0"
+description = "Media metadata files -- ffmetadata, Vorbis comments, cue sheets -- read, written and converted through one model"
+readme = "README.md"
+# the owner's: MIT or Apache-2.0, the user's choice
+license = "MIT OR Apache-2.0"
+license-files = ["LICENSE-MIT", "LICENSE-APACHE"]
+requires-python = ">=3.13"
+authors = [{ name = "VERA LVX", email = "veralvx@veralvx.com" }]
+maintainers = [{ name = "VERA LVX", email = "veralvx@veralvx.com" }]
+keywords = [
+    "metadata",
+    "ffmetadata",
+    "vorbis",
+    "vorbiscomment",
+    "flac",
+    "opus",
+    "cue",
+    "cuesheet",
+    "chapters",
+    "tags",
+]
+# https://pypi.org/classifiers/ -- no License :: one (PEP 639); OS Independent: nothing
+# platform-bound imported (measured)
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [] # the standard library alone
+
+[project.urls]
+Changelog = "https://github.com/veramachine/ffsuite/blob/main/packages/ffmeta/CHANGELOG.md"
+Homepage = "https://github.com/veramachine/ffsuite/tree/main/packages/ffmeta"
+Issues = "https://github.com/veramachine/ffsuite/issues"
+Repository = "https://github.com/veramachine/ffsuite"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ffmeta"]
+
+[tool.hatch.build.targets.sdist]
+# test_skills reads the repository's .agents/skills, which no sdist holds (an upward path
+# breaks one, 6.7.4): left out, the rest of its tests run from it
+exclude = ["tests/test_skills.py"]
+
+[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 = ["tests"]
+addopts = ["--strict-markers", "--strict-config", "-ra", "--import-mode=importlib"]
+xfail_strict = true
+filterwarnings = ["error"]
+markers = [ # the root's, as each rule here (test_workspace)
+    "ffmpeg: needs a pinned tool, ffmpeg 8.1 or metaflac 1.5 (integration)",
+    "slow: the combination matrix",
+]

ffmeta-0.1.0/src/ffmeta/__init__.py

@@ -0,0 +1,31 @@
+"""Metadata files: ffmetadata, Vorbis comments and cue sheets, read into one model, written from it.
+
+Pure: text in, text out -- no ffmpeg, no file. The formats are ffman's skills'
+(``.agents/skills/ffmetadata``, ``vorbiscomment``, ``cue``); what crosses between them is
+``metadata-mappings``'s -- all in ffman's repository.
+"""
+
+from ffmeta._errors import Error
+from ffmeta.convert import Converted, convert
+from ffmeta.fields import Format
+from ffmeta.files import read, write
+from ffmeta.model import Chapter, Disc, File, Index, Metadata, Tag, Track, Written
+
+__all__ = [
+    "Chapter",
+    "Converted",
+    "Disc",
+    "Error",
+    "File",
+    "Format",
+    "Index",
+    "Metadata",
+    "Tag",
+    "Track",
+    "Written",
+    "convert",
+    "read",
+    "write",
+]
+
+Error.__module__ = "ffmeta"  # tracebacks name the public ffmeta.Error, not its private module

ffmeta-0.1.0/src/ffmeta/_errors.py

@@ -0,0 +1,42 @@
+"""The one way ffmeta refuses: an ffmeta.Error, its message the reason; input shown safe."""
+
+from typing import Final, Never
+
+_SHOWN: Final = 60  # input quoted in a message: its characters, at most
+_ESCAPED: Final = {"\r": "\\r", "\n": "\\n", "\t": "\\t"}
+
+
+class Error(Exception):
+    """ffmeta's refusal: the input cannot be read, converted or written as it stands.
+
+    The message says why.
+    """
+
+
+def refuse(message: str) -> Never:
+    """Refuse with ``message``."""
+    raise Error(message)
+
+
+def shown(text: str) -> str:
+    r"""Input quoted in a message: on one line, each character visible, 60 characters at most.
+
+    A line break or tab as its escape; any other character that prints nothing (a NUL, a BOM, a
+    no-break space) as Python writes it, ``\x00``, ``\ufeff``.
+    """
+    one = "".join(
+        _ESCAPED.get(char, char if char.isprintable() else repr(char)[1:-1]) for char in text
+    )
+    return one if len(one) <= _SHOWN else one[: _SHOWN - 3] + "..."
+
+
+def refuse_at(source: str, line: int, message: str) -> Never:
+    """Refuse at ``source``'s ``line``: ``SOURCE:LINE: message``, lines from 1.
+
+    The GNU Coding Standards' form for a program reading a file (4.4, "Formatting Error
+    Messages").
+    """
+    if line < 1:
+        msg = f"lines count from 1, not {line}"
+        raise ValueError(msg)
+    refuse(f"{source}:{line}: {message}")

ffmeta-0.1.0/src/ffmeta/_values.py

@@ -0,0 +1,8 @@
+"""Numbers exactly: the one rounding ffmeta needs."""
+
+from fractions import Fraction
+
+
+def round_half_up(value: Fraction) -> int:
+    """The nearest integer, halves up: the floor of ``value`` + 1/2, exactly -- (2n + d) // 2d."""
+    return (2 * value.numerator + value.denominator) // (2 * value.denominator)