Skip to content

abstracts

Classes:

ALL_PMODES_ST module-attribute

ALL_PMODES_T module-attribute

ProcessMode

Bases: ProcessModeBase, IntEnum

Attributes:

Any class-attribute instance-attribute

Any = -1

Any_ST class-attribute instance-attribute

Any_ST = Callable[
    [
        Any,
        DT_T | SupportsIndexing[DT_T],
        DT_T | SupportsIndexing[DT_T],
        VideoFrame,
        int | None,
        int,
    ],
    None,
]

Any_T class-attribute instance-attribute

Any_T = Callable[
    [
        DT_T | SupportsIndexing[DT_T],
        DT_T | SupportsIndexing[DT_T],
        VideoFrame,
        int | None,
        int,
    ],
    None,
]

MultiSrcIPF class-attribute instance-attribute

MultiSrcIPF = 3

MultiSrcIPF_ST class-attribute instance-attribute

MultiSrcIPF_ST = Callable[
    [Any, SupportsIndexing[DT_T], SupportsIndexing[DT_T], VideoFrame, int], None
]

MultiSrcIPF_T class-attribute instance-attribute

MultiSrcIPF_T = Callable[
    [SupportsIndexing[DT_T], SupportsIndexing[DT_T], VideoFrame, int], None
]

MultiSrcIPP class-attribute instance-attribute

MultiSrcIPP = 1

MultiSrcIPP_ST class-attribute instance-attribute

MultiSrcIPP_ST = Callable[
    [Any, SupportsIndexing[DT_T], DT_T, VideoFrame, int, int], None
]

MultiSrcIPP_T class-attribute instance-attribute

MultiSrcIPP_T = Callable[
    [SupportsIndexing[DT_T], DT_T, VideoFrame, int, int], None
]

SingleSrcIPF class-attribute instance-attribute

SingleSrcIPF = 2

SingleSrcIPF_ST class-attribute instance-attribute

SingleSrcIPF_ST = Callable[
    [Any, DT_T, SupportsIndexing[DT_T], VideoFrame, int], None
]

SingleSrcIPF_T class-attribute instance-attribute

SingleSrcIPF_T = Callable[[DT_T, SupportsIndexing[DT_T], VideoFrame, int], None]

SingleSrcIPP class-attribute instance-attribute

SingleSrcIPP = 0

SingleSrcIPP_ST class-attribute instance-attribute

SingleSrcIPP_ST = Callable[[Any, DT_T, DT_T, VideoFrame, int, int], None]

SingleSrcIPP_T class-attribute instance-attribute

SingleSrcIPP_T = Callable[[DT_T, DT_T, VideoFrame, int, int], None]

ProcessModeBase

Attributes:

Any_ST class-attribute instance-attribute

Any_ST = Callable[
    [
        Any,
        DT_T | SupportsIndexing[DT_T],
        DT_T | SupportsIndexing[DT_T],
        VideoFrame,
        int | None,
        int,
    ],
    None,
]

Any_T class-attribute instance-attribute

Any_T = Callable[
    [
        DT_T | SupportsIndexing[DT_T],
        DT_T | SupportsIndexing[DT_T],
        VideoFrame,
        int | None,
        int,
    ],
    None,
]

MultiSrcIPF_ST class-attribute instance-attribute

MultiSrcIPF_ST = Callable[
    [Any, SupportsIndexing[DT_T], SupportsIndexing[DT_T], VideoFrame, int], None
]

MultiSrcIPF_T class-attribute instance-attribute

MultiSrcIPF_T = Callable[
    [SupportsIndexing[DT_T], SupportsIndexing[DT_T], VideoFrame, int], None
]

MultiSrcIPP_ST class-attribute instance-attribute

MultiSrcIPP_ST = Callable[
    [Any, SupportsIndexing[DT_T], DT_T, VideoFrame, int, int], None
]

MultiSrcIPP_T class-attribute instance-attribute

MultiSrcIPP_T = Callable[
    [SupportsIndexing[DT_T], DT_T, VideoFrame, int, int], None
]

SingleSrcIPF_ST class-attribute instance-attribute

SingleSrcIPF_ST = Callable[
    [Any, DT_T, SupportsIndexing[DT_T], VideoFrame, int], None
]

SingleSrcIPF_T class-attribute instance-attribute

SingleSrcIPF_T = Callable[[DT_T, SupportsIndexing[DT_T], VideoFrame, int], None]

SingleSrcIPP_ST class-attribute instance-attribute

SingleSrcIPP_ST = Callable[[Any, DT_T, DT_T, VideoFrame, int, int], None]

SingleSrcIPP_T class-attribute instance-attribute

SingleSrcIPP_T = Callable[[DT_T, DT_T, VideoFrame, int, int], None]

PyPluginBackendBase

Bases: Generic[DT_T]

Methods:

Attributes:

DT class-attribute instance-attribute

DTA class-attribute instance-attribute

DTA: TypeAlias = DT_T | SupportsIndexing[DT_T]

DTL class-attribute instance-attribute

DTL: TypeAlias = SupportsIndexing[DT_T]

process_MultiSrcIPF instance-attribute

process_MultiSrcIPF: MultiSrcIPF_T[DT_T] | None

process_MultiSrcIPP instance-attribute

process_MultiSrcIPP: MultiSrcIPP_T[DT_T] | None

process_SingleSrcIPF instance-attribute

process_SingleSrcIPF: SingleSrcIPF_T[DT_T] | None

process_SingleSrcIPP instance-attribute

process_SingleSrcIPP: SingleSrcIPP_T[DT_T] | None

ensure_output staticmethod

ensure_output(func: F_VD) -> F_VD
Source code
167
168
169
170
171
172
173
@staticmethod
def ensure_output(func: F_VD) -> F_VD:
    @wraps(func)
    def _wrapper(self: CLS_T[FD_T], *args: Any, **kwargs: Any) -> Any:
        return self.options.ensure_output(self, func(self, *args, **kwargs))

    return cast(F_VD, _wrapper)

process staticmethod

process(mode: Literal[Any]) -> PassthroughC[Any_T[DT_T]]
process(mode: Literal[SingleSrcIPP]) -> PassthroughC[SingleSrcIPP_ST[DT_T]]
process(mode: Literal[MultiSrcIPP]) -> PassthroughC[MultiSrcIPP_ST[DT_T]]
process(mode: Literal[SingleSrcIPF]) -> PassthroughC[SingleSrcIPF_ST[DT_T]]
process(mode: Literal[MultiSrcIPF]) -> PassthroughC[MultiSrcIPF_ST[DT_T]]
process(func: Any_ST[DT_T]) -> Any_ST[DT_T]
process(func: None) -> PassthroughC[PassthroughC[Any_ST[DT_T]]]
process(
    mode_or_func: ProcessMode | ALL_PMODES_ST[DT_T] | None = None,
) -> PassthroughC[ALL_PMODES_ST[DT_T]] | Any_ST[DT_T]
Source code
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
@staticmethod  # type: ignore
def process(mode_or_func: ProcessMode | ALL_PMODES_ST[DT_T] | None = None, /) -> (
    PassthroughC[ALL_PMODES_ST[DT_T]] | ProcessMode.Any_ST[DT_T]
):
    if mode_or_func is None:
        return PyPluginBackendBase.process  # type: ignore
    elif not isinstance(mode_or_func, ProcessMode):
        return PyPluginBackendBase.process(ProcessMode.Any)(mode_or_func)  # type: ignore

    def _wrapper(func: Callable[..., None]) -> Callable[..., None]:
        func.__dict__.update(
            __pybackend_overload__=True,
            __pybackend_mode__=mode_or_func
        )

        return func

    return _wrapper

PyPluginBackendMeta

Bases: type

PyPluginBackendOverloadedDict

Bases: dict[str, Any]

Methods:

get_key staticmethod

get_key(mode: ProcessMode) -> str
Source code
88
89
90
@staticmethod
def get_key(mode: ProcessMode) -> str:
    return f'process_{mode.name}'