typed-ffmpeg-compatible 2.4.1__tar.gz

typed_ffmpeg_compatible-2.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 livingbio
+
+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.

typed_ffmpeg_compatible-2.4.1/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.1
+Name: typed-ffmpeg-compatible
+Version: 2.4.1
+Summary: Modern Python FFmpeg wrappers offer comprehensive support for complex filters, complete with detailed typing and documentation.
+Home-page: https://livingbio.github.io/typed-ffmpeg/
+License: MIT
+Keywords: ffmpeg,video,audio,multimedia,filter
+Author: lucemia
+Author-email: lucemia@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: graph
+Requires-Dist: graphviz ; extra == "graph"
+Project-URL: Repository, https://github.com/livingbio/typed-ffmpeg
+Description-Content-Type: text/markdown
+
+## typed-ffmpeg
+
+[![CI Package](https://github.com/livingbio/typed-ffmpeg/actions/workflows/ci-package.yml/badge.svg)](https://github.com/livingbio/typed-ffmpeg/actions?query=workflow%3Aci-package)
+[![Documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://livingbio.github.io/typed-ffmpeg/)
+[![PyPI Version](https://img.shields.io/pypi/v/typed-ffmpeg.svg)](https://pypi.org/project/typed-ffmpeg/)
+[![codecov](https://codecov.io/gh/livingbio/typed-ffmpeg/graph/badge.svg?token=B95PR629LP)](https://codecov.io/gh/livingbio/typed-ffmpeg)
+
+**typed-ffmpeg** offers a modern, Pythonic interface to FFmpeg, providing extensive support for complex filters with detailed typing and documentation. Inspired by `ffmpeg-python`, this package enhances functionality by addressing common limitations, such as lack of IDE integration and comprehensive typing, while also introducing new features like JSON serialization of filter graphs and automatic FFmpeg validation.
+
+---
+
+### Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Usage](#quick-usage)
+- [Documentation](https://livingbio.github.io/typed-ffmpeg/)
+- [Acknowledgements](#acknowledgements)
+
+---
+
+## Features
+
+![typed-ffmpeg](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/autocomplete.png)
+
+
+- **Zero Dependencies:** Built purely with the Python standard library, ensuring maximum compatibility and security.
+- **User-Friendly:** Simplifies the construction of filter graphs with an intuitive Pythonic interface.
+- **Comprehensive FFmpeg Filter Support:** Out-of-the-box support for most FFmpeg filters, with IDE auto-completion.
+- **Integrated Documentation:** In-line docstrings provide immediate reference for filter usage, reducing the need to consult external documentation.
+- **Robust Typing:** Offers static and dynamic type checking, enhancing code reliability and development experience.
+- **Filter Graph Serialization:** Enables saving and reloading of filter graphs in JSON format for ease of use and repeatability.
+- **Graph Visualization:** Leverages `graphviz` for visual representation, aiding in understanding and debugging.
+- **Validation and Auto-correction:** Assists in identifying and fixing errors within filter graphs.
+- **Input and Output Options Support:** Provide a more comprehensive interface for input and output options, including support for additional codecs and formats.
+- **Partial Evaluation:** Enhance the flexibility of filter graphs by enabling partial evaluation, allowing for modular construction and reuse.
+
+### Planned Features
+
+Please note that the following features are under consideration or development for future releases:
+
+- **Extended FFmpeg Version Support:** While `typed-ffmpeg` is currently built with FFmpeg version 6.0 in mind, we are working to ensure compatibility across different FFmpeg versions. Feedback and issue reports are welcome to improve version support.
+- **Additional Filter Support:** We aim to expand the range of FFmpeg filters supported by `typed-ffmpeg`. Continuous updates will be made to include more complex and varied filters.
+
+---
+
+## Installation
+
+To install `typed-ffmpeg`, simply use pip:
+
+```bash
+pip install typed-ffmpeg
+```
+
+Note: FFmpeg must be installed on your system.
+
+Note: If you need to install `ffmpeg-python` at the same time, use `pip install typed-ffmpeg-compatible` to prevent conflicts with the module name.​
+
+### Visualization Support
+
+To enable graph visualization features:
+
+```bash
+pip install 'typed-ffmpeg[graph]'
+```
+
+Note: This requires Graphviz to be installed on your system.
+
+---
+
+## Quick Usage
+
+Here's how to quickly start using `typed-ffmpeg`:
+
+
+
+
+```python
+import ffmpeg
+
+# Flip video horizontally and output
+f = (
+    ffmpeg
+    .input(filename='input.mp4')
+    .hflip()
+    .output(filename='output.mp4')
+)
+f
+```
+
+
+
+
+
+![svg](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/README_files/README_1_0.svg)
+
+
+
+
+For a more complex example:
+
+
+
+```python
+import ffmpeg.filters
+import ffmpeg
+
+# Complex filter graph example
+in_file = ffmpeg.input("input.mp4")
+overlay_file = ffmpeg.input("overlay.png")
+
+f = (
+    ffmpeg.filters
+    .concat(
+        in_file.trim(start_frame=10, end_frame=20),
+        in_file.trim(start_frame=30, end_frame=40),
+    )
+    .video(0)
+    .overlay(overlay_file.hflip())
+    .drawbox(x="50", y="50", width="120", height="120", color="red", thickness="5")
+    .output(filename="out.mp4")
+)
+f
+```
+
+
+
+
+
+![svg](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/README_files/README_3_0.svg)
+
+
+
+
+See the [Usage](https://livingbio.github.io/typed-ffmpeg/usage/typed/) section in our documentation for more examples and detailed guides.
+
+
+---
+
+## Acknowledgements
+
+This project was initially inspired by the capabilities of GPT-3, with the original concept focusing on using GPT-3 to generate an FFmpeg filter SDK directly from the FFmpeg documentation. However, during the development process, I encountered limitations with GPT-3's ability to fully automate this task.
+
+As a result, I shifted to traditional code generation methods to complete the SDK, ensuring a more robust and reliable tool. Despite this change in approach, both GitHub Copilot and GPT-3 were instrumental in accelerating the development process, providing valuable insights and saving significant time.
+
+I would also like to extend my gratitude to the `ffmpeg-python` project, which inspired this project significantly. The API style and design ideas from `ffmpeg-python` have been influential, and I have utilized these aspects to shape the development of our SDK.
+
+This project is dedicated to my son, Austin, on his seventh birthday (February 24, 2024), whose curiosity and zest for life continually inspire me.
+
+---
+
+Feel free to check the [Documentation](https://livingbio.github.io/typed-ffmpeg/) for detailed information and more advanced features.
+

typed_ffmpeg_compatible-2.4.1/README.md

@@ -0,0 +1,152 @@
+## typed-ffmpeg
+
+[![CI Package](https://github.com/livingbio/typed-ffmpeg/actions/workflows/ci-package.yml/badge.svg)](https://github.com/livingbio/typed-ffmpeg/actions?query=workflow%3Aci-package)
+[![Documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://livingbio.github.io/typed-ffmpeg/)
+[![PyPI Version](https://img.shields.io/pypi/v/typed-ffmpeg.svg)](https://pypi.org/project/typed-ffmpeg/)
+[![codecov](https://codecov.io/gh/livingbio/typed-ffmpeg/graph/badge.svg?token=B95PR629LP)](https://codecov.io/gh/livingbio/typed-ffmpeg)
+
+**typed-ffmpeg** offers a modern, Pythonic interface to FFmpeg, providing extensive support for complex filters with detailed typing and documentation. Inspired by `ffmpeg-python`, this package enhances functionality by addressing common limitations, such as lack of IDE integration and comprehensive typing, while also introducing new features like JSON serialization of filter graphs and automatic FFmpeg validation.
+
+---
+
+### Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Usage](#quick-usage)
+- [Documentation](https://livingbio.github.io/typed-ffmpeg/)
+- [Acknowledgements](#acknowledgements)
+
+---
+
+## Features
+
+![typed-ffmpeg](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/autocomplete.png)
+
+
+- **Zero Dependencies:** Built purely with the Python standard library, ensuring maximum compatibility and security.
+- **User-Friendly:** Simplifies the construction of filter graphs with an intuitive Pythonic interface.
+- **Comprehensive FFmpeg Filter Support:** Out-of-the-box support for most FFmpeg filters, with IDE auto-completion.
+- **Integrated Documentation:** In-line docstrings provide immediate reference for filter usage, reducing the need to consult external documentation.
+- **Robust Typing:** Offers static and dynamic type checking, enhancing code reliability and development experience.
+- **Filter Graph Serialization:** Enables saving and reloading of filter graphs in JSON format for ease of use and repeatability.
+- **Graph Visualization:** Leverages `graphviz` for visual representation, aiding in understanding and debugging.
+- **Validation and Auto-correction:** Assists in identifying and fixing errors within filter graphs.
+- **Input and Output Options Support:** Provide a more comprehensive interface for input and output options, including support for additional codecs and formats.
+- **Partial Evaluation:** Enhance the flexibility of filter graphs by enabling partial evaluation, allowing for modular construction and reuse.
+
+### Planned Features
+
+Please note that the following features are under consideration or development for future releases:
+
+- **Extended FFmpeg Version Support:** While `typed-ffmpeg` is currently built with FFmpeg version 6.0 in mind, we are working to ensure compatibility across different FFmpeg versions. Feedback and issue reports are welcome to improve version support.
+- **Additional Filter Support:** We aim to expand the range of FFmpeg filters supported by `typed-ffmpeg`. Continuous updates will be made to include more complex and varied filters.
+
+---
+
+## Installation
+
+To install `typed-ffmpeg`, simply use pip:
+
+```bash
+pip install typed-ffmpeg
+```
+
+Note: FFmpeg must be installed on your system.
+
+Note: If you need to install `ffmpeg-python` at the same time, use `pip install typed-ffmpeg-compatible` to prevent conflicts with the module name.​
+
+### Visualization Support
+
+To enable graph visualization features:
+
+```bash
+pip install 'typed-ffmpeg[graph]'
+```
+
+Note: This requires Graphviz to be installed on your system.
+
+---
+
+## Quick Usage
+
+Here's how to quickly start using `typed-ffmpeg`:
+
+
+
+
+```python
+import ffmpeg
+
+# Flip video horizontally and output
+f = (
+    ffmpeg
+    .input(filename='input.mp4')
+    .hflip()
+    .output(filename='output.mp4')
+)
+f
+```
+
+
+
+
+
+![svg](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/README_files/README_1_0.svg)
+
+
+
+
+For a more complex example:
+
+
+
+```python
+import ffmpeg.filters
+import ffmpeg
+
+# Complex filter graph example
+in_file = ffmpeg.input("input.mp4")
+overlay_file = ffmpeg.input("overlay.png")
+
+f = (
+    ffmpeg.filters
+    .concat(
+        in_file.trim(start_frame=10, end_frame=20),
+        in_file.trim(start_frame=30, end_frame=40),
+    )
+    .video(0)
+    .overlay(overlay_file.hflip())
+    .drawbox(x="50", y="50", width="120", height="120", color="red", thickness="5")
+    .output(filename="out.mp4")
+)
+f
+```
+
+
+
+
+
+![svg](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/README_files/README_3_0.svg)
+
+
+
+
+See the [Usage](https://livingbio.github.io/typed-ffmpeg/usage/typed/) section in our documentation for more examples and detailed guides.
+
+
+---
+
+## Acknowledgements
+
+This project was initially inspired by the capabilities of GPT-3, with the original concept focusing on using GPT-3 to generate an FFmpeg filter SDK directly from the FFmpeg documentation. However, during the development process, I encountered limitations with GPT-3's ability to fully automate this task.
+
+As a result, I shifted to traditional code generation methods to complete the SDK, ensuring a more robust and reliable tool. Despite this change in approach, both GitHub Copilot and GPT-3 were instrumental in accelerating the development process, providing valuable insights and saving significant time.
+
+I would also like to extend my gratitude to the `ffmpeg-python` project, which inspired this project significantly. The API style and design ideas from `ffmpeg-python` have been influential, and I have utilized these aspects to shape the development of our SDK.
+
+This project is dedicated to my son, Austin, on his seventh birthday (February 24, 2024), whose curiosity and zest for life continually inspire me.
+
+---
+
+Feel free to check the [Documentation](https://livingbio.github.io/typed-ffmpeg/) for detailed information and more advanced features.

typed_ffmpeg_compatible-2.4.1/pyproject.toml

@@ -0,0 +1,102 @@
+[tool.poetry]
+name = "typed-ffmpeg-compatible"
+version = "2.4.1"
+description = "Modern Python FFmpeg wrappers offer comprehensive support for complex filters, complete with detailed typing and documentation."
+authors = ["lucemia <lucemia@gmail.com>"]
+readme = "README.md"
+packages = [{ include = "typed_ffmpeg", from = "src" }]
+include = ["typed_ffmpeg/py.typed"]
+exclude = ["**/tests", "**/scripts"]
+license = "MIT"
+homepage = "https://livingbio.github.io/typed-ffmpeg/"
+repository = "https://github.com/livingbio/typed-ffmpeg"
+keywords = [
+    "ffmpeg",
+    "video",
+    "audio",
+    "multimedia",
+    "filter",
+]
+classifiers = [
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Natural Language :: English',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Topic :: Multimedia :: Video',
+        'Topic :: Multimedia :: Sound/Audio',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: Software Development :: Libraries :: Application Frameworks',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+
+# graph
+graphviz = {"version" = "*", optional=true}
+
+[tool.poetry.extras]
+graph = [
+    "graphviz",
+]
+
+[tool.poetry.group.dev]
+optional = true
+
+[tool.poetry.group.dev.dependencies]
+# test
+pytest-cov = ">=4.1,<6.0"
+pytest-datadir = "^1.5.0"
+pytest-recording = "^0.13.1"
+syrupy = "^4.6.0"
+pre-commit = "*"
+mypy = "*"
+graphviz = "*"
+
+# codegen
+typer = "*"
+jinja2 = "*"
+devtools = "*"
+beautifulsoup4 = "*"
+html2text = "*"
+
+# Doc
+mkdocs = "*"
+markdown-callouts = "^0.4.0"
+mkdocs-material = "^9.5.9"
+mkdocstrings = ">=0.24,<0.27"
+mkdocstrings-python = "^1.8.0"
+pymdown-extensions = "^10.7"
+griffe_inherited_docstrings = "*"
+black = "*"
+ipykernel = "^6.29.4"
+mknotebooks = "*"
+
+[tool.mypy]
+exclude = "^(migrations|commands|sandbox|samples|sdk)/"
+show_error_codes = true       # Enables showing error codes in messages for easier issue identification.
+implicit_optional = true      # Assumes arguments with a default `None` value are `Optional`.
+follow_imports = "silent"     # Ignores import errors for a cleaner output on external libraries.
+warn_redundant_casts = true   # Issues warnings for unnecessary type casts.
+warn_unused_ignores = true    # Alerts on unnecessary '# type: ignore' comments.
+disallow_any_generics = true  # Forces specifying types for generics, like `List[int]` instead of just `List`.
+check_untyped_defs = true     # Would type-check functions without type annotations, but it's commented out.
+no_implicit_reexport = true   # Requires explicit re-export of imported names.
+disallow_untyped_defs = true  # Forces all functions to have type annotations.
+
+[tool.poetry.scripts]
+scripts = "scripts.main:app"
+
+[tool.poetry-dynamic-versioning]
+enable = false
+pattern = "default-unprefixed"
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
+build-backend = "poetry_dynamic_versioning.backend"

typed_ffmpeg_compatible-2.4.1/src/typed_ffmpeg/__init__.py

@@ -0,0 +1,25 @@
+from . import dag, filters
+from .base import afilter, filter_multi_output, input, merge_outputs, output, vfilter
+from .dag import Stream
+from .exceptions import FFMpegExecuteError, FFMpegTypeError, FFMpegValueError
+from .probe import probe
+from .streams import AudioStream, AVStream, VideoStream
+
+__all__ = [
+    "filters",
+    "input",
+    "output",
+    "merge_outputs",
+    "FFMpegExecuteError",
+    "FFMpegTypeError",
+    "FFMpegValueError",
+    "Stream",
+    "probe",
+    "AudioStream",
+    "VideoStream",
+    "AVStream",
+    "vfilter",
+    "afilter",
+    "filter_multi_output",
+    "dag",
+]

typed_ffmpeg_compatible-2.4.1/src/typed_ffmpeg/base.py

@@ -0,0 +1,114 @@
+"""
+This module defined the basic functions for creating the ffmpeg filter graph.
+"""
+
+from typing import Any
+
+from .dag.io._input import input
+from .dag.io._output import output
+from .dag.nodes import FilterableStream, FilterNode, GlobalNode, GlobalStream, OutputStream
+from .schema import StreamType
+from .streams.audio import AudioStream
+from .streams.video import VideoStream
+
+
+def merge_outputs(*streams: OutputStream) -> GlobalStream:
+    """
+    Merge multiple output streams into one.
+
+    Args:
+        *streams: The output streams to merge.
+
+    Returns:
+        The merged output stream.
+    """
+    return GlobalNode(inputs=streams).stream()
+
+
+def vfilter(
+    *streams: FilterableStream, name: str, input_typings: tuple[StreamType, ...] = (StreamType.video,), **kwargs: Any
+) -> VideoStream:
+    """
+    Apply a custom video filter which has only one output to this stream
+
+    Args:
+        *streams: the streams to apply the filter to
+        name: the name of the filter
+        input_typings: the input typings of the filter
+        **kwargs: the arguments for the filter
+
+    Returns:
+        the output stream
+
+    Note:
+        This function is for custom filter which is not implemented in typed-ffmpeg
+    """
+    return FilterNode(
+        name=name,
+        inputs=streams,
+        output_typings=(StreamType.video,),
+        input_typings=input_typings,
+        kwargs=tuple(kwargs.items()),
+    ).video(0)
+
+
+def afilter(
+    *streams: FilterableStream, name: str, input_typings: tuple[StreamType, ...] = (StreamType.audio,), **kwargs: Any
+) -> AudioStream:
+    """
+    Apply a custom audio filter which has only one output to this stream
+
+    Args:
+        *streams: the streams to apply the filter to
+        name: the name of the filter
+        input_typings: the input typings of the filter
+        **kwargs: the arguments for the filter
+
+    Returns:
+        the output stream
+
+    Note:
+        This function is for custom filter which is not implemented in typed-ffmpeg
+    """
+    return FilterNode(
+        name=name,
+        inputs=streams,
+        output_typings=(StreamType.audio,),
+        input_typings=input_typings,
+        kwargs=tuple(kwargs.items()),
+    ).audio(0)
+
+
+def filter_multi_output(
+    *streams: FilterableStream,
+    name: str,
+    input_typings: tuple[StreamType, ...] = (),
+    output_tyings: tuple[StreamType, ...] = (),
+    **kwargs: Any
+) -> FilterNode:
+    """
+    Apply a custom filter which has multiple outputs to this stream
+
+    Args:
+        *streams: the streams to apply the filter to
+        name: the name of the filter
+        input_typings: the input typings of the filter
+        output_tyings: the output typings of the filter
+        **kwargs: the arguments for the filter
+
+    Returns:
+        the FilterNode
+
+    Note:
+        This function is for custom filter which is not implemented in typed-ffmpeg
+    """
+    return FilterNode(
+        name=name,
+        kwargs=tuple(kwargs.items()),
+        inputs=streams,
+        input_typings=input_typings,
+        output_typings=output_tyings,
+    )
+
+
+__all__ = ["input", "output", "merge_outputs", "vfilter", "afilter", "filter_multi_output"]