Skip to content

cache

Classes:

Functions:

FrameT module-attribute 

FrameT = TypeVar('FrameT', bound=RawFrame)

NodeT module-attribute 

NodeT = TypeVar('NodeT', bound=RawNode)

ClipFramesCache

Bases: NodeFramesCache[VideoNode, VideoFrame]

ClipsCache

Bases: vs_object, dict[VideoNode, VideoNode]

DynamicClipsCache 

DynamicClipsCache(cache_size: int = 2)

Bases: vs_object, dict[T, VideoNodeT]

Methods:

Attributes:

Source code in vstools/utils/cache.py 
44
45
def __init__(self, cache_size: int = 2) -> None:
    self.cache_size = cache_size

cache_size instance-attribute 

cache_size = cache_size

get_clip abstractmethod 

get_clip(key: T) -> VideoNodeT
Source code in vstools/utils/cache.py 
47
48
@abstractmethod
def get_clip(self, key: T) -> VideoNodeT: ...

FramesCache 

FramesCache(clip: NodeT, cache_size: int = 10)

Bases: vs_object, dict[int, FrameT], Generic[NodeT, FrameT]

Methods:

Attributes:

Source code in vstools/utils/cache.py 
64
65
66
def __init__(self, clip: NodeT, cache_size: int = 10) -> None:
    self.clip = clip
    self.cache_size = cache_size

cache_size instance-attribute 

cache_size = cache_size

clip instance-attribute 

clip = clip

add_frame 

add_frame(n: int, f: FrameT) -> FrameT
Source code in vstools/utils/cache.py 
68
69
70
def add_frame(self, n: int, f: FrameT) -> FrameT:
    self[n] = f.copy()
    return self[n]

get_frame 

get_frame(n: int, f: FrameT) -> FrameT
Source code in vstools/utils/cache.py 
72
73
def get_frame(self, n: int, f: FrameT) -> FrameT:
    return self[n]

NodeFramesCache

Bases: vs_object, dict[NodeT, FramesCache[NodeT, FrameT]]

NodesPropsCache

Bases: vs_object, dict[tuple[NodeT, int], MutableMapping[str, '_PropValue']]

SceneBasedDynamicCache 

SceneBasedDynamicCache(
    clip: VideoNode, keyframes: Keyframes | str, cache_size: int = 5
)

Bases: DynamicClipsCache[int, VideoNode]

Methods:

Attributes:

Source code in vstools/utils/cache.py 
115
116
117
118
119
def __init__(self, clip: vs.VideoNode, keyframes: Keyframes | str, cache_size: int = 5) -> None:
    super().__init__(cache_size)

    self.clip = clip
    self.keyframes = Keyframes.from_param(clip, keyframes)

cache_size instance-attribute 

cache_size = cache_size

clip instance-attribute 

clip = clip

keyframes instance-attribute 

keyframes = from_param(clip, keyframes)

from_clip classmethod 

from_clip(
    clip: VideoNode, keyframes: Keyframes | str, *args: Any, **kwargs: Any
) -> VideoNode
Source code in vstools/utils/cache.py 
127
128
129
@classmethod
def from_clip(cls, clip: vs.VideoNode, keyframes: Keyframes | str, *args: Any, **kwargs: Any) -> vs.VideoNode:
    return cls(clip, keyframes, *args, **kwargs).get_eval()

get_clip abstractmethod 

get_clip(key: int) -> VideoNode
Source code in vstools/utils/cache.py 
121
122
@abstractmethod
def get_clip(self, key: int) -> vs.VideoNode: ...

get_eval 

get_eval() -> VideoNode
Source code in vstools/utils/cache.py 
124
125
def get_eval(self) -> vs.VideoNode:
    return self.clip.std.FrameEval(lambda n: self[self.keyframes.scenes.indices[n]])

cache_clip 

cache_clip(_clip: NodeT, cache_size: int = 10) -> NodeT
Source code in vstools/utils/cache.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def cache_clip(_clip: NodeT, cache_size: int = 10) -> NodeT:
    if isinstance(_clip, vs.VideoNode):
        cache = FramesCache[vs.VideoNode, vs.VideoFrame](_clip, cache_size)

        blank = vs.core.std.BlankClip(_clip)

        _to_cache_node = vs.core.std.ModifyFrame(blank, _clip, cache.add_frame)
        _from_cache_node = vs.core.std.ModifyFrame(blank, blank, cache.get_frame)

        return cast(NodeT, vs.core.std.FrameEval(blank, lambda n: _from_cache_node if n in cache else _to_cache_node))

    # elif isinstance(_clip, vs.AudioNode):
    #     ...

    return _clip