typed-ffmpeg-compatible 3.5.2__py3-none-any.whl → 3.6__py3-none-any.whl

typed_ffmpeg/dag/global_runnable/runnable.py

@@ -56,6 +56,7 @@ class GlobalRunable(GlobalArgs):
             merged = output1.merge_outputs(output2)
             merged.run()  # Creates both output files with one FFmpeg command
             ```
+
         """
         return self._global_node(*streams).stream()
 
@@ -75,6 +76,7 @@ class GlobalRunable(GlobalArgs):
             # Overwrite output file if it already exists
             ffmpeg.input("input.mp4").output("output.mp4").overwrite_output().run()
             ```
+
         """
         return self._global_node(y=True).stream()
 
@@ -113,6 +115,7 @@ class GlobalRunable(GlobalArgs):
             args = ffmpeg.input("input.mp4").output("output.mp4").compile()
             # Result: ['ffmpeg', '-i', 'input.mp4', 'output.mp4']
             ```
+
         """
         from ...compile.compile_cli import compile_as_list
 
@@ -171,6 +174,7 @@ class GlobalRunable(GlobalArgs):
             cmd_str = ffmpeg.input("input.mp4").output("output.mp4").compile_line()
             # Result: 'ffmpeg -i input.mp4 output.mp4'
             ```
+
         """
         return command_line(
             self.compile(
@@ -223,8 +227,8 @@ class GlobalRunable(GlobalArgs):
             # Do something while FFmpeg is running
             process.wait()  # Wait for completion
             ```
-        """
 
+        """
         args = self.compile(
             cmd,
             overwrite_output=overwrite_output,
@@ -294,8 +298,8 @@ class GlobalRunable(GlobalArgs):
             )
             print(stderr.decode())  # Print FFmpeg's progress information
             ```
-        """
 
+        """
         process = self.run_async(
             cmd,
             pipe_stdin=input is not None,

typed_ffmpeg/dag/io/__init__.py

@@ -0,0 +1 @@
+"""Input/output utilities for FFmpeg DAG operations."""

typed_ffmpeg/dag/io/_input.py

@@ -1,11 +1,17 @@
 # NOTE: this file is auto-generated, do not modify
-
+"""Input node."""
 
 from pathlib import Path
 from typing import Any
 
 from ...codecs.schema import FFMpegDecoderOption
 from ...formats.schema import FFMpegDemuxerOption
+from ...options.codec import (
+    FFMpegAVCodecContextDecoderOption,
+)
+from ...options.format import (
+    FFMpegAVFormatContextDecoderOption,
+)
 from ...streams.av import AVStream
 from ...types import (
     Boolean,
@@ -16,7 +22,9 @@ from ...types import (
     Time,
 )
 from ...utils.frozendict import merge
-from ..nodes import InputNode
+from ..nodes import (
+    InputNode,
+)
 
 
 def input(
@@ -76,10 +84,12 @@ def input(
     top: Int = None,
     decoder_options: FFMpegDecoderOption | None = None,
     demuxer_options: FFMpegDemuxerOption | None = None,
+    format_options: FFMpegAVFormatContextDecoderOption | None = None,
+    codec_options: FFMpegAVCodecContextDecoderOption | None = None,
     extra_options: dict[str, Any] | None = None,
 ) -> AVStream:
     """
-    Input file URL (ffmpeg ``-i`` option)
+    Input file URL (ffmpeg ``-i`` option).
 
     Args:
         filename: Input file URL
@@ -137,6 +147,8 @@ def input(
         top: deprecated, use the setfield video filter
         decoder_options: ffmpeg's decoder options
         demuxer_options: ffmpeg's demuxer options
+        format_options: ffmpeg's AVFormatContext options
+        codec_options: ffmpeg's AVCodecContext options
         extra_options: ffmpeg's input file options
 
     Returns:
@@ -147,6 +159,7 @@ def input(
     >>> input('input.mp4')
     <AVStream:input.mp4:0>
     ```
+
     """
     return InputNode(
         filename=str(filename),
@@ -205,8 +218,10 @@ def input(
                 "dn": dn,
                 "top": top,
             },
-            decoder_options.kwargs if decoder_options else {},
-            demuxer_options.kwargs if demuxer_options else {},
+            decoder_options,
+            demuxer_options,
+            format_options,
+            codec_options,
             extra_options,
         ),
     ).stream()

typed_ffmpeg/dag/io/_output.py

@@ -1,11 +1,17 @@
 # NOTE: this file is auto-generated, do not modify
-
+"""Output node."""
 
 from pathlib import Path
 from typing import Any
 
 from ...codecs.schema import FFMpegEncoderOption
 from ...formats.schema import FFMpegMuxerOption
+from ...options.codec import (
+    FFMpegAVCodecContextEncoderOption,
+)
+from ...options.format import (
+    FFMpegAVFormatContextEncoderOption,
+)
 from ...types import (
     Boolean,
     Float,
@@ -16,7 +22,11 @@ from ...types import (
     Time,
 )
 from ...utils.frozendict import merge
-from ..nodes import FilterableStream, OutputNode, OutputStream
+from ..nodes import (
+    FilterableStream,
+    OutputNode,
+    OutputStream,
+)
 
 
 def output(
@@ -118,10 +128,12 @@ def output(
     top: Int = None,
     encoder_options: FFMpegEncoderOption | None = None,
     muxer_options: FFMpegMuxerOption | None = None,
+    format_options: FFMpegAVFormatContextEncoderOption | None = None,
+    codec_options: FFMpegAVCodecContextEncoderOption | None = None,
     extra_options: dict[str, Any] | None = None,
 ) -> OutputStream:
-    """
-    Output file URL
+    r"""
+    Output file URL.
 
     Args:
         *streams: the streams to output
@@ -142,8 +154,7 @@ def output(
         program: add program with specified streams
         stream_group: add stream group with specified streams and group type-specific arguments
         dframes: set the number of data frames to output
-        target: specify target file type (\"vcd\", \"svcd\", \"dvd\", \"dv\" or \"dv50\
-        "with optional prefixes \"pal-\", \"ntsc-\" or \"film-\")
+        target: specify target file type (\"vcd\", \"svcd\", \"dvd\", \"dv\" or \"dv50\ "with optional prefixes \"pal-\", \"ntsc-\" or \"film-\")
         shortest: finish encoding within shortest input
         shortest_buf_duration: maximum buffering duration (in seconds) for the -shortest option
         bitexact: bitexact mode
@@ -223,12 +234,14 @@ def output(
         top: deprecated, use the setfield video filter
         encoder_options: ffmpeg's encoder options
         muxer_options: ffmpeg's muxer options
+        format_options: ffmpeg's AVFormatContext options
+        codec_options: ffmpeg's AVCodecContext options
         extra_options: the arguments for the output
 
     Returns:
         the output stream
-    """
 
+    """
     return OutputNode(
         inputs=streams,
         filename=str(filename),
@@ -329,8 +342,10 @@ def output(
                 "dn": dn,
                 "top": top,
             },
-            encoder_options.kwargs if encoder_options else {},
-            muxer_options.kwargs if muxer_options else {},
+            encoder_options,
+            muxer_options,
+            format_options,
+            codec_options,
             extra_options,
         ),
     ).stream()

typed_ffmpeg/dag/io/output_args.py

@@ -1,5 +1,5 @@
 # NOTE: this file is auto-generated, do not modify
-
+"""Output arguments."""
 
 from __future__ import annotations
 
@@ -9,6 +9,12 @@ from typing import TYPE_CHECKING, Any
 
 from ...codecs.schema import FFMpegEncoderOption
 from ...formats.schema import FFMpegMuxerOption
+from ...options.codec import (
+    FFMpegAVCodecContextEncoderOption,
+)
+from ...options.format import (
+    FFMpegAVFormatContextEncoderOption,
+)
 from ...types import (
     Boolean,
     Float,
@@ -25,6 +31,8 @@ if TYPE_CHECKING:
 
 
 class OutputArgs(ABC):
+    """Output arguments interface."""
+
     @abstractmethod
     def _output_node(
         self, *streams: FilterableStream, filename: str | Path, **kwargs: Any
@@ -130,10 +138,12 @@ class OutputArgs(ABC):
         top: Int = None,
         encoder_options: FFMpegEncoderOption | None = None,
         muxer_options: FFMpegMuxerOption | None = None,
+        format_options: FFMpegAVFormatContextEncoderOption | None = None,
+        codec_options: FFMpegAVCodecContextEncoderOption | None = None,
         extra_options: dict[str, Any] | None = None,
     ) -> OutputStream:
-        """
-        Output file URL
+        r"""
+        Output file URL.
 
         Args:
             *streams: the streams to output
@@ -234,13 +244,15 @@ class OutputArgs(ABC):
             dn: disable data
             top: deprecated, use the setfield video filter
             encoder_options: ffmpeg's encoder options
-            muxer_options: FFMpegMuxerOption | None = None,
+            muxer_options: FFMpegMuxerOption
+            format_options: FFMpegAVFormatContextEncoderOption
+            codec_options: FFMpegAVCodecContextEncoderOption
             extra_options: the arguments for the output
 
         Returns:
             the output stream
-        """
 
+        """
         return self._output_node(
             *streams,
             filename=filename,
@@ -341,8 +353,10 @@ class OutputArgs(ABC):
                     "dn": dn,
                     "top": top,
                 },
-                encoder_options.kwargs if encoder_options else {},
-                muxer_options.kwargs if muxer_options else {},
+                encoder_options,
+                muxer_options,
+                format_options,
+                codec_options,
                 extra_options,
             ),
         ).stream()

typed_ffmpeg/dag/nodes.py

@@ -1,3 +1,5 @@
+"""DAG node definitions for FFmpeg filter graphs."""
+
 from __future__ import annotations
 
 import logging
@@ -60,6 +62,7 @@ class FilterNode(Node):
 
         Returns:
             The name of the filter
+
         """
         return self.name
 
@@ -81,6 +84,7 @@ class FilterNode(Node):
 
         Raises:
             FFMpegValueError: If the specified index is out of range
+
         """
         from ..streams.video import VideoStream
 
@@ -111,6 +115,7 @@ class FilterNode(Node):
 
         Raises:
             FFMpegValueError: If the specified index is out of range
+
         """
         from ..streams.audio import AudioStream
 
@@ -136,6 +141,7 @@ class FilterNode(Node):
         Raises:
             FFMpegValueError: If the number of inputs doesn't match input_typings
             FFMpegTypeError: If an input stream doesn't match its expected type
+
         """
         from ..streams.audio import AudioStream
         from ..streams.video import VideoStream
@@ -207,6 +213,7 @@ class FilterableStream(Stream, OutputArgs):
                 filename="output.mp4", c="libx264", crf=23
             )
             ```
+
         """
         return OutputNode(
             inputs=(self, *streams),
@@ -244,6 +251,7 @@ class FilterableStream(Stream, OutputArgs):
             # Apply a blur filter to a video stream
             blurred = stream.vfilter(name="boxblur", luma_radius=2)
             ```
+
         """
         return self.filter_multi_output(
             *streams,
@@ -283,6 +291,7 @@ class FilterableStream(Stream, OutputArgs):
             # Apply a volume filter to an audio stream
             louder = stream.afilter(name="volume", volume=2.0)
             ```
+
         """
         return self.filter_multi_output(
             *streams,
@@ -327,6 +336,7 @@ class FilterableStream(Stream, OutputArgs):
             stream1 = split_node.video(0)
             stream2 = split_node.video(1)
             ```
+
         """
         return FilterNode(
             name=name,
@@ -337,6 +347,7 @@ class FilterableStream(Stream, OutputArgs):
         )
 
     def __post_init__(self) -> None:
+        """Validate that filter streams have an index."""
         if not isinstance(self.node, InputNode):
             assert self.index is not None, "Filter streams must have an index"
 
@@ -368,6 +379,7 @@ class InputNode(Node):
 
         Returns:
             The basename of the input file
+
         """
         return os.path.basename(self.filename)
 
@@ -390,6 +402,7 @@ class InputNode(Node):
             # Apply a filter to the video stream
             scaled = video.scale(width=1280, height=720)
             ```
+
         """
         from ..streams.video import VideoStream
 
@@ -414,6 +427,7 @@ class InputNode(Node):
             # Apply a filter to the audio stream
             volume_adjusted = audio.volume(volume=2.0)
             ```
+
         """
         from ..streams.audio import AudioStream
 
@@ -438,6 +452,7 @@ class InputNode(Node):
             # Output both audio and video to a new file
             output = av_stream.output("output.mp4")
             ```
+
         """
         from ..streams.av import AVStream
 
@@ -471,6 +486,7 @@ class OutputNode(Node):
 
         Returns:
             The basename of the output file
+
         """
         return os.path.basename(self.filename)
 
@@ -492,6 +508,7 @@ class OutputNode(Node):
             output_stream = output_node.stream()
             with_global_opts = output_stream.global_args(y=True)
             ```
+
         """
         return OutputStream(node=self)
 
@@ -531,6 +548,7 @@ class OutputStream(Stream, GlobalRunable):
             # Add global options to an output stream
             global_node = output_stream._global_node(y=True, loglevel="quiet")
             ```
+
         """
         return GlobalNode(inputs=(self, *streams), kwargs=FrozenDict(kwargs))
 
@@ -567,6 +585,7 @@ class GlobalNode(Node):
             # Execute the command
             global_stream.run()
             ```
+
         """
         return GlobalStream(node=self)
 
@@ -607,6 +626,7 @@ class GlobalStream(Stream, GlobalRunable):
             global_stream = ffmpeg.output("output.mp4").global_args(y=True)
             enhanced = global_stream._global_node(loglevel="quiet")
             ```
+
         """
         inputs = (*self.node.inputs, *streams)
         kwargs = dict(self.node.kwargs) | kwargs

typed_ffmpeg/dag/schema.py

@@ -1,3 +1,5 @@
+"""DAG schema definitions for FFmpeg filter graphs."""
+
 from __future__ import annotations
 
 from dataclasses import dataclass, replace
@@ -12,15 +14,11 @@ from .utils import is_dag
 
 @dataclass(frozen=True, kw_only=True)
 class HashableBaseModel(Serializable):
-    """
-    A base class for hashable dataclasses.
-    """
+    """A base class for hashable dataclasses."""
 
     @cached_property
     def hex(self) -> str:
-        """
-        Get the hexadecimal hash of the object.
-        """
+        """Get the hexadecimal hash of the object."""
         return hex(abs(hash(self)))[2:]
 
 
@@ -31,6 +29,7 @@ class Stream(HashableBaseModel):
 
     Note:
         Each stream in the DAG is a sequence of operations that transforms the data from its input form to its output form. The stream is an essential component of the DAG, as it defines the order and the nature of the operations that are performed on the data.
+
     """
 
     node: Node
@@ -66,6 +65,7 @@ class Stream(HashableBaseModel):
 
         Returns:
             The file path of the visualization.
+
         """
         from ..utils.view import view
 
@@ -87,6 +87,7 @@ class Node(HashableBaseModel):
 
     Note:
         Each node in the DAG represents a single operation that transforms the data from its input form to its output form. The node is an essential component of the DAG, as it defines the nature of the operations that are performed on the data.
+
     """
 
     # Filter_Node_Option_Type
@@ -102,6 +103,13 @@ class Node(HashableBaseModel):
     """
 
     def __post_init__(self) -> None:
+        """
+        Validate that the graph is a DAG (Directed Acyclic Graph).
+
+        Raises:
+            ValueError: If the graph is not a DAG
+
+        """
         # Validate the DAG
         passed = set()
         nodes = [self]
@@ -127,6 +135,7 @@ class Node(HashableBaseModel):
 
         Returns:
             The representation of the node.
+
         """
         return repr(self)
 
@@ -140,6 +149,7 @@ class Node(HashableBaseModel):
 
         Returns:
             The new graph with the replaced node.
+
         """
         if self == old_node:
             return new_node
@@ -165,6 +175,7 @@ class Node(HashableBaseModel):
 
         Returns:
             The maximum depth of the node.
+
         """
         return max((i.node.max_depth for i in self.inputs), default=0) + 1
 
@@ -175,6 +186,7 @@ class Node(HashableBaseModel):
 
         Returns:
             The upstream nodes of the node.
+
         """
         output = {self}
         for input in self.inputs:
@@ -191,6 +203,7 @@ class Node(HashableBaseModel):
 
         Returns:
             The file path of the visualization.
+
         """
         from ..utils.view import view
 

typed_ffmpeg/dag/utils.py

@@ -38,9 +38,9 @@ def is_dag(graph: dict[str, set[str]]) -> bool:
         graph = {"A": {"B"}, "B": {"C"}, "C": {"A"}}
         assert is_dag(graph) == False
         ```
-    """
 
-    in_degree = {u: 0 for u in graph}  # Initialize in-degree of each node to 0
+    """
+    in_degree = dict.fromkeys(graph, 0)  # Initialize in-degree of each node to 0
 
     # Calculate in-degree of each node
     for u in graph:

typed_ffmpeg/exceptions.py

@@ -54,6 +54,7 @@ class FFMpegExecuteError(FFMpegError):
         stderr: The standard error output of the failed command
         cmd: The command string that was executed
         retcode: The process return code
+
     """
 
     def __init__(self, retcode: int | None, cmd: str, stdout: bytes, stderr: bytes):
@@ -65,8 +66,8 @@ class FFMpegExecuteError(FFMpegError):
             cmd: The FFmpeg command string that was executed
             stdout: The captured standard output from the process
             stderr: The captured standard error from the process
-        """
 
+        """
         self.stdout = stdout
         self.stderr = stderr
         self.cmd = cmd