typed-ffmpeg-compatible 3.0.0__py3-none-any.whl → 3.0.1__py3-none-any.whl

typed_ffmpeg/compile/compile_cli.py

@@ -3,8 +3,15 @@ Compiles FFmpeg filter graphs into command-line arguments.
 
 This module provides functionality to convert the internal DAG (Directed Acyclic Graph)
 representation of an FFmpeg filter chain into the actual command-line arguments
-that would be passed to FFmpeg. It traverses the graph in the correct order,
-handling global options, inputs, complex filtergraphs, and outputs.
+that would be passed to FFmpeg. It handles the following components:
+
+1. Global Options: General FFmpeg settings like log level, overwrite flags
+2. Input Files: Source media files with their specific options
+3. Filter Graphs: Complex filter chains with proper stream labeling
+4. Output Files: Destination files with codec and format settings
+
+The module ensures proper ordering of arguments and handles stream mapping,
+filter graph syntax, and escaping of special characters in FFmpeg commands.
 """
 
 from __future__ import annotations
@@ -15,11 +22,29 @@ from ..exceptions import FFMpegValueError
 from ..schema import Default
 from ..utils.escaping import escape
 from ..utils.lazy_eval.schema import LazyValue
+from ..utils.run import command_line
 from .context import DAGContext
 from .validate import validate
 
 
-def compile(stream: Stream, auto_fix: bool = True) -> list[str]:
+def compile(stream: Stream, auto_fix: bool = True) -> str:
+    """
+    Compile a stream into a command-line string.
+
+    This function takes a Stream object representing an FFmpeg filter graph
+    and converts it into a command-line string that can be passed to FFmpeg.
+
+    Args:
+        stream: The Stream object to compile into a command-line string
+        auto_fix: Whether to automatically fix issues in the stream
+
+    Returns:
+        A command-line string that can be passed to FFmpeg
+    """
+    return command_line(compile_as_list(stream, auto_fix))
+
+
+def compile_as_list(stream: Stream, auto_fix: bool = True) -> list[str]:
     """
     Compile a stream into a list of FFmpeg command-line arguments.
 
@@ -32,7 +57,8 @@ def compile(stream: Stream, auto_fix: bool = True) -> list[str]:
     4. Output nodes (output files and their options)
 
     The function validates the graph before compilation to ensure it's properly
-    formed. If auto_fix is enabled, it will attempt to fix common issues.
+    formed. If auto_fix is enabled, it will attempt to fix common issues like
+    disconnected nodes or invalid stream mappings.
 
     Args:
         stream: The Stream object to compile into arguments
@@ -42,6 +68,9 @@ def compile(stream: Stream, auto_fix: bool = True) -> list[str]:
     Returns:
         A list of strings representing FFmpeg command-line arguments
 
+    Raises:
+        FFMpegValueError: If the stream contains invalid configurations that cannot be fixed
+
     Example:
         ```python
         # Create a simple video scaling filter graph
@@ -108,6 +137,7 @@ def get_stream_label(stream: Stream, context: DAGContext | None = None) -> str:
     - Multi-output filters: "filterlabel#index"
 
     Args:
+        stream: The stream to generate a label for
         context: Optional DAG context for resolving node labels.
                 If not provided, a new context will be built.
 
@@ -130,8 +160,16 @@ def get_stream_label(stream: Stream, context: DAGContext | None = None) -> str:
                 case AVStream():
                     return f"{get_node_label(stream.node, context)}"
                 case VideoStream():
+                    if stream.index is not None:
+                        return (
+                            f"{get_node_label(stream.node, context)}:v:{stream.index}"
+                        )
                     return f"{get_node_label(stream.node, context)}:v"
                 case AudioStream():
+                    if stream.index is not None:
+                        return (
+                            f"{get_node_label(stream.node, context)}:a:{stream.index}"
+                        )
                     return f"{get_node_label(stream.node, context)}:a"
                 case _:
                     raise FFMpegValueError(
@@ -156,9 +194,12 @@ def get_args_filter_node(node: FilterNode, context: DAGContext) -> list[str]:
     FFmpeg's syntax where input labels are followed by the filter name
     and parameters, and then output labels.
 
+    The filter string format is:
+    [input_label]filter_name=param1=value1:param2=value2[output_label]
+
     Args:
-        context: Optional DAG context for resolving stream labels.
-                If not provided, a new context will be built.
+        node: The FilterNode to generate arguments for
+        context: DAG context for resolving stream labels
 
     Returns:
         A list of strings that, when joined, form the filter string
@@ -207,9 +248,12 @@ def get_args_input_node(node: InputNode, context: DAGContext) -> list[str]:
 
     This method creates the command-line arguments needed to specify
     this input file to FFmpeg, including any input-specific options.
+    Options are converted to FFmpeg's command-line format, with boolean
+    options using -option or -nooption syntax.
 
     Args:
-        context: Optional DAG context (not used for input nodes)
+        node: The InputNode to generate arguments for
+        context: DAG context (not used for input nodes)
 
     Returns:
         A list of strings representing FFmpeg command-line arguments
@@ -237,11 +281,12 @@ def get_args_output_node(node: OutputNode, context: DAGContext) -> list[str]:
 
     This method creates the command-line arguments needed to specify
     this output file to FFmpeg, including stream mapping and output-specific
-    options like codecs and formats.
+    options like codecs and formats. It handles both direct input streams
+    and filter output streams appropriately.
 
     Args:
-        context: Optional DAG context for resolving stream labels.
-                If not provided, a new context will be built.
+        node: The OutputNode to generate arguments for
+        context: DAG context for resolving stream labels
 
     Returns:
         A list of strings representing FFmpeg command-line arguments
@@ -278,10 +323,12 @@ def get_args_global_node(node: GlobalNode, context: DAGContext) -> list[str]:
 
     This method creates the command-line arguments needed to specify
     global options to FFmpeg, such as -y for overwrite or -loglevel for
-    controlling log output.
+    controlling log output. Boolean options are converted to -option or
+    -nooption syntax.
 
     Args:
-        context: Optional DAG context (not used for global options)
+        node: The GlobalNode to generate arguments for
+        context: DAG context (not used for global options)
 
     Returns:
         A list of strings representing FFmpeg command-line arguments
@@ -304,7 +351,22 @@ def get_args_global_node(node: GlobalNode, context: DAGContext) -> list[str]:
 
 def get_args(node: Node, context: DAGContext | None = None) -> list[str]:
     """
-    Get the arguments for a node.
+    Get the FFmpeg command-line arguments for a specific node.
+
+    This function dispatches to the appropriate argument generation function
+    based on the node type. It handles all node types in the FFmpeg DAG:
+    FilterNode, InputNode, OutputNode, and GlobalNode.
+
+    Args:
+        node: The node to generate arguments for
+        context: Optional DAG context for resolving stream labels.
+                If not provided, a new context will be built.
+
+    Returns:
+        A list of strings representing FFmpeg command-line arguments
+
+    Raises:
+        FFMpegValueError: If the node type is not recognized
     """
 
     context = context or DAGContext.build(node)
@@ -330,9 +392,11 @@ def get_node_label(node: Node, context: DAGContext) -> str:
     filter graph notation. The label format depends on the node type:
     - Input nodes: sequential numbers (0, 1, 2...)
     - Filter nodes: 's' prefix followed by a number (s0, s1, s2...)
+    - Output nodes: 'out'
 
     Args:
-        node: The node to get the label for (must be an InputNode or FilterNode)
+        node: The node to get the label for
+        context: DAG context containing node ID mappings
 
     Returns:
         The string label for the node

typed_ffmpeg/compile/compile_json.py

@@ -0,0 +1,38 @@
+from ..common.serialize import dumps, loads
+from ..dag.schema import Stream
+from .validate import validate
+
+
+def compile(stream: Stream, auto_fix: bool = True) -> str:
+    """
+    Compile a stream into a JSON string.
+
+    This function takes a Stream object representing an FFmpeg filter graph
+    and converts it into a JSON string that can be passed to FFmpeg.
+
+    Args:
+        stream: The Stream object to compile into a JSON string
+        auto_fix: Whether to automatically fix issues in the stream
+
+    Returns:
+        A JSON string that can be passed to FFmpeg
+    """
+    stream = validate(stream, auto_fix=auto_fix)
+
+    return dumps(stream)
+
+
+def parse(json: str) -> Stream:
+    """
+    Parse a JSON string into a Stream object.
+
+    This function takes a JSON string that can be passed to FFmpeg
+    and converts it into a Stream object.
+
+    Args:
+        json: The JSON string to parse into a Stream object
+
+    Returns:
+        A Stream object
+    """
+    return loads(json)

typed_ffmpeg/compile/compile_python.py

@@ -77,7 +77,10 @@ def get_input_var_name(
         case VideoStream():
             match stream.node:
                 case InputNode():
-                    return f"{get_output_var_name(stream.node, context)}.video"
+                    if stream.index is not None:
+                        return f"{get_output_var_name(stream.node, context)}.video_stream({stream.index})"
+                    else:
+                        return f"{get_output_var_name(stream.node, context)}.video"
                 case FilterNode():
                     if filter_data_dict[stream.node.name].is_dynamic_output:
                         return f"{get_output_var_name(stream.node, context)}.video({filter_stream_typed_index(stream, context)})"
@@ -91,7 +94,10 @@ def get_input_var_name(
         case AudioStream():
             match stream.node:
                 case InputNode():
-                    return f"{get_output_var_name(stream.node, context)}.audio"
+                    if stream.index is not None:
+                        return f"{get_output_var_name(stream.node, context)}.audio_stream({stream.index})"
+                    else:
+                        return f"{get_output_var_name(stream.node, context)}.audio"
                 case FilterNode():
                     if filter_data_dict[stream.node.name].is_dynamic_output:
                         return f"{get_output_var_name(stream.node, context)}.audio({filter_stream_typed_index(stream, context)})"
@@ -191,7 +197,7 @@ def compile_fluent(code: list[str]) -> list[str]:
     return [f"{k.strip()} = {v.strip()}" for k, v in buffer]
 
 
-def compile(stream: Stream, auto_fix: bool = True, fluent: bool = True) -> list[str]:
+def compile(stream: Stream, auto_fix: bool = True, fluent: bool = True) -> str:
     """
     Compile the python code.
 
@@ -295,10 +301,10 @@ def compile(stream: Stream, auto_fix: bool = True, fluent: bool = True) -> list[
     if fluent:
         code = compile_fluent(code)
 
-    return ["import ffmpeg", *code]
+    return "\n".join(["import ffmpeg", *code])
 
 
-def parse(code: list[str]) -> Stream:
+def parse(code: str) -> Stream:
     """
     Parse the python code.
 
@@ -312,7 +318,7 @@ def parse(code: list[str]) -> Stream:
         The parsed stream.
     """
     local_vars: dict[str, Any] = {}
-    exec("\n".join(code), {}, local_vars)
+    exec(code, {}, local_vars)
     result = local_vars["result"]
 
     assert isinstance(result, Stream)

typed_ffmpeg/dag/global_runnable/runnable.py

@@ -81,7 +81,7 @@ class GlobalRunable(GlobalArgs):
     def compile(
         self,
         cmd: str | list[str] = "ffmpeg",
-        overwrite_output: bool = None,
+        overwrite_output: bool | None = None,
         auto_fix: bool = True,
     ) -> list[str]:
         """
@@ -111,7 +111,7 @@ class GlobalRunable(GlobalArgs):
             # Result: ['ffmpeg', '-i', 'input.mp4', 'output.mp4']
             ```
         """
-        from ...compile.compile_cli import compile
+        from ...compile.compile_cli import compile_as_list
 
         if isinstance(cmd, str):
             cmd = [cmd]
@@ -121,12 +121,12 @@ class GlobalRunable(GlobalArgs):
         elif overwrite_output is False:
             return self.global_args(n=True).compile(cmd, auto_fix=auto_fix)
 
-        return cmd + compile(self._global_node().stream(), auto_fix=auto_fix)
+        return cmd + compile_as_list(self._global_node().stream(), auto_fix=auto_fix)
 
     def compile_line(
         self,
         cmd: str | list[str] = "ffmpeg",
-        overwrite_output: bool = None,
+        overwrite_output: bool | None = None,
         auto_fix: bool = True,
     ) -> str:
         """
@@ -165,7 +165,7 @@ class GlobalRunable(GlobalArgs):
         pipe_stdout: bool = False,
         pipe_stderr: bool = False,
         quiet: bool = False,
-        overwrite_output: bool = None,
+        overwrite_output: bool | None = None,
         auto_fix: bool = True,
     ) -> subprocess.Popen[bytes]:
         """
@@ -222,7 +222,7 @@ class GlobalRunable(GlobalArgs):
         capture_stderr: bool = False,
         input: bytes | None = None,
         quiet: bool = False,
-        overwrite_output: bool = None,
+        overwrite_output: bool | None = None,
         auto_fix: bool = True,
     ) -> tuple[bytes, bytes]:
         """

typed_ffmpeg/dag/nodes.py

@@ -337,9 +337,7 @@ class FilterableStream(Stream, OutputArgs):
         )
 
     def __post_init__(self) -> None:
-        if isinstance(self.node, InputNode):
-            assert self.index is None, "Input streams cannot have an index"
-        else:
+        if not isinstance(self.node, InputNode):
             assert self.index is not None, "Filter streams must have an index"
 
 

typed_ffmpeg/streams/av.py

@@ -1,5 +1,4 @@
 from ..dag.nodes import InputNode
-from ..utils.typing import override
 from .audio import AudioStream
 from .video import VideoStream
 
@@ -12,11 +11,45 @@ class AVStream(AudioStream, VideoStream):
     node: InputNode
 
     @property
-    @override
     def video(self) -> VideoStream:
+        """
+        Get the video stream from the input node.
+
+        Returns:
+            VideoStream: The video stream from the input node.
+        """
         return VideoStream(node=self.node, index=self.index)
 
     @property
-    @override
     def audio(self) -> AudioStream:
+        """
+        Get the audio stream from the input node.
+
+        Returns:
+            AudioStream: The audio stream from the input node.
+        """
         return AudioStream(node=self.node, index=self.index)
+
+    def video_stream(self, index: int) -> VideoStream:
+        """
+        Get the video stream from the input node with a specified index.
+
+        Args:
+            index: The index of the video stream.
+
+        Returns:
+            VideoStream: The video stream from the input node.
+        """
+        return VideoStream(node=self.node, index=index)
+
+    def audio_stream(self, index: int) -> AudioStream:
+        """
+        Get the audio stream from the input node with a specified index.
+
+        Args:
+            index: The index of the audio stream.
+
+        Returns:
+            AudioStream: The audio stream from the input node.
+        """
+        return AudioStream(node=self.node, index=index)

{typed_ffmpeg_compatible-3.0.0.dist-info → typed_ffmpeg_compatible-3.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: typed-ffmpeg-compatible
-Version: 3.0.0
+Version: 3.0.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

{typed_ffmpeg_compatible-3.0.0.dist-info → typed_ffmpeg_compatible-3.0.1.dist-info}/RECORD

@@ -43,24 +43,26 @@ typed_ffmpeg/common/cache/FFMpegFilterManuallyDefined/vstack.json,sha256=MMulT4N
 typed_ffmpeg/common/cache/FFMpegFilterManuallyDefined/xmedian.json,sha256=Er7eTcYZCop6QMZT0OXC9QV6tf76mRBYXjqPIqdKDtU,212
 typed_ffmpeg/common/cache/FFMpegFilterManuallyDefined/xstack.json,sha256=6Svn1w2FopoYufK0kWCJR7xZndMyTItRs63-TafWMnk,211
 typed_ffmpeg/common/cache/list/filters.json,sha256=s5-tRP3Jrun2nlj5nV_StPozuC5y3cNcb_xCc4OSulg,2390250
+typed_ffmpeg/common/cache/list/options.json,sha256=bmODg-h8ZI90IWICSW44CllVkPRnUs6nJ4pOOQ__cqw,40453
 typed_ffmpeg/common/cache.py,sha256=j0JvfX7jewLpdJWxgo7Pwze0BkUJdYGHX2uGR8BZ-9M,1386
 typed_ffmpeg/common/schema.py,sha256=qM8yfMX9UU3EAQSNsTrr-SAmyqKx8eQCXTtu3RJWkEk,19673
 typed_ffmpeg/common/serialize.py,sha256=dLim0DBP5CdJ1JiMV9xEmmh1XMSIhBOWs61EopAL15s,7719
 typed_ffmpeg/compile/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-typed_ffmpeg/compile/compile_cli.py,sha256=JGt2U-W8a9JWmBFUJ3CqlW7I6XBXEUD2mM8hqH5NlbM,12210
-typed_ffmpeg/compile/compile_python.py,sha256=moNoInXLENmWBKiBcBOm4pY_lwgtjhJXa8jzzClxegY,11162
+typed_ffmpeg/compile/compile_cli.py,sha256=qwcBtl4-ha7rYAY6dWoM12ngbP8i6QzqwtrQrL3mqC0,14826
+typed_ffmpeg/compile/compile_json.py,sha256=YCiTyfAnUVSbFr7BiQpmJYs13K5sa-xo77Iih33mb6I,992
+typed_ffmpeg/compile/compile_python.py,sha256=rsoF4spI3cq6uMHU3iN-j8QByj2yE5pEqjatWCaf0D4,11522
 typed_ffmpeg/compile/context.py,sha256=macQ3HhEJ73j_WbWYtU9GCQCzcB_KQGAPimcuU-WOac,10946
 typed_ffmpeg/compile/validate.py,sha256=QsWksdvlRwWw6hnatFo-ABakms1qDXRbEmvMQGRLrD8,9579
 typed_ffmpeg/dag/__init__.py,sha256=qAApSNqjbZ1DtUaV5bSku9RwG7MpMPa1HJO764cSBt4,849
 typed_ffmpeg/dag/factory.py,sha256=2IMVKP_2UaTrlGXBg8YDx5KXBqhpScJiJQ87PRrppzY,3147
 typed_ffmpeg/dag/global_runnable/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 typed_ffmpeg/dag/global_runnable/global_args.py,sha256=ehLtx4v-XxqkmODhpE_gik0r79hs4Sa8TJnRsH9Fj1o,8043
-typed_ffmpeg/dag/global_runnable/runnable.py,sha256=tJEloR91lL_-XBYDoLcOxUBbCVnAje8W53YjcLzNBrM,11054
+typed_ffmpeg/dag/global_runnable/runnable.py,sha256=0QGBm3ghM4LFT4H9km9-h_N0w5BR3kTaESRapb-qTv0,11098
 typed_ffmpeg/dag/io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 typed_ffmpeg/dag/io/_input.py,sha256=KRLTSQPEfmgPcPEAJdeWRHZhNsClaJCB9Ac6czMOrmE,7214
 typed_ffmpeg/dag/io/_output.py,sha256=_no6ffAOABznbLNTki8CYr7pvr4Sa0LweRfn38-cszs,12470
 typed_ffmpeg/dag/io/output_args.py,sha256=SThIhZh9PXs2m6Fz5JsSy8oS-Te7GM_oz7HRuZo0-eI,13901
-typed_ffmpeg/dag/nodes.py,sha256=fEySoGvqFFF-5rlWxhSYm83XB_bL-t3LzvBnf3lFqQc,20612
+typed_ffmpeg/dag/nodes.py,sha256=lfHChT8JqRs3UUDWtgrWnnXn845HXSD5S1QmHpIUT4U,20526
 typed_ffmpeg/dag/schema.py,sha256=dSq0o8e9qFazyd55k2yXcxbjoKZJEtqeROd91w1O3Wo,5728
 typed_ffmpeg/dag/utils.py,sha256=hydh7_kjpOCw8WEGhXMxIXR4Ek-3DeoOt6esInuK2Xw,1941
 typed_ffmpeg/exceptions.py,sha256=D4SID6WOwkjVV8O8mAjrEDHWn-8BRDnK_jteaDof1SY,2474
@@ -72,7 +74,7 @@ typed_ffmpeg/schema.py,sha256=KVtmyGeJutjFot70r6Nj8W8WBqwvfg2-rSgjdhPVh-o,1615
 typed_ffmpeg/sources.py,sha256=ASt0l8FMW82X-70qw72167xpyBY7tQQClVuhy8r0HfU,86026
 typed_ffmpeg/streams/__init__.py,sha256=Nt9uWpcVI1sQLl5Qt_kBCBcWOGZA1vczCQ0qvFbSko0,141
 typed_ffmpeg/streams/audio.py,sha256=2oNRhb5UetWtlPG3NW73AjUZoFPl303yMv-6W1sGWt0,259054
-typed_ffmpeg/streams/av.py,sha256=SWcy8Q9hk36ZZJ4WosG08NR-r1f2IzOgZ4tsAZ7nX18,544
+typed_ffmpeg/streams/av.py,sha256=Nu6M7uV4aMNQf_kxADZuBdpDwFx_B7Z7x0p5j32n9iA,1500
 typed_ffmpeg/streams/channel_layout.py,sha256=hGagaoc1tnWS8K1yiITp4f_92qq5e7C_zB15bHOL0DI,1162
 typed_ffmpeg/streams/video.py,sha256=cQwHfew75YO_dbZjmpUYd-nXt1JHN0M7suFKKe5UH5s,453576
 typed_ffmpeg/types.py,sha256=ly3zLtg7KxRa_jsDDrFPAxRZRjTQdWVpiQzOD9NdrFM,4137
@@ -86,8 +88,8 @@ typed_ffmpeg/utils/run.py,sha256=mSoAdcvD-InldqkRgWNc8iXKgJJoEMAOE4PL2gVmtqw,217
 typed_ffmpeg/utils/snapshot.py,sha256=mKILRm6qiQV2egaD-70MSUEl-DFoLD5w_v9GZIequI4,2181
 typed_ffmpeg/utils/typing.py,sha256=DBQn_gCF8C_DTwsfMHeCgfnNUROwAjlIcHrQ7lNDOoE,1187
 typed_ffmpeg/utils/view.py,sha256=QCSlQoQkRBI-T0sWjiywGgM9DlKd8Te3CB2ZYX-pEVU,3413
-typed_ffmpeg_compatible-3.0.0.dist-info/LICENSE,sha256=8Aaya5i_09Cou2i3QMxTwz6uHGzi_fGA4uhkco07-A4,1066
-typed_ffmpeg_compatible-3.0.0.dist-info/METADATA,sha256=aADycfuCev75zMDuT1AAWxycftaNx2J7zFvin99JA9w,7249
-typed_ffmpeg_compatible-3.0.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-typed_ffmpeg_compatible-3.0.0.dist-info/entry_points.txt,sha256=KfZmNsM16GT_lF1otASIN6E3i6xXHXoB1gMeEdlptjA,44
-typed_ffmpeg_compatible-3.0.0.dist-info/RECORD,,
+typed_ffmpeg_compatible-3.0.1.dist-info/LICENSE,sha256=8Aaya5i_09Cou2i3QMxTwz6uHGzi_fGA4uhkco07-A4,1066
+typed_ffmpeg_compatible-3.0.1.dist-info/METADATA,sha256=LfhzfDCrQibFfmOQwWYOh1oPPbkA8LBPkJjvQW_Vmag,7249
+typed_ffmpeg_compatible-3.0.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+typed_ffmpeg_compatible-3.0.1.dist-info/entry_points.txt,sha256=KfZmNsM16GT_lF1otASIN6E3i6xXHXoB1gMeEdlptjA,44
+typed_ffmpeg_compatible-3.0.1.dist-info/RECORD,,