ranges ¶
Functions:
-
remap_frames
– -
replace_every
– -
replace_ranges
–Replaces frames in a clip, either with pre-calculated indices or on-the-fly with a callback.
ReplaceRanges ¶
ReplaceRanges(replace_ranges: Callable[P, R])
Bases: Generic[P, R]
Class decorator that wraps the replace_ranges function and extends its functionality.
It is not meant to be used directly.
Methods:
-
__call__
–
Attributes:
Source code
83 84 85 |
|
exclusive instance-attribute
¶
exclusive: bool | None = None
Whether to use exclusive ranges globally (Default: None).
If set to True, all calls of replace_ranges will use exclusive ranges. If set to False, all calls of replace_ranges will use inclusive ranges.
__call__ ¶
__call__(
clip_a: VideoNode,
clip_b: VideoNode,
ranges: FrameRangeN | FrameRangesN,
exclusive: bool | None = None,
mismatch: Literal[False] = ...,
) -> ConstantFormatVideoNode
__call__(
clip_a: VideoNodeT,
clip_b: VideoNodeT,
ranges: FrameRangeN | FrameRangesN,
exclusive: bool | None = None,
mismatch: bool = ...,
) -> VideoNodeT
__call__(
clip_a: VideoNode,
clip_b: VideoNode,
ranges: _RangesCallBack,
*,
mismatch: bool = False
) -> VideoNode
__call__(
clip_a: VideoNode,
clip_b: VideoNode,
ranges: _RangesCallBackF[VideoFrame] | _RangesCallBackNF[VideoFrame],
*,
mismatch: bool = False,
prop_src: VideoNode
) -> VideoNode
__call__(
clip_a: VideoNode,
clip_b: VideoNode,
ranges: (
_RangesCallBackF[Sequence[VideoFrame]]
| _RangesCallBackNF[Sequence[VideoFrame]]
),
*,
mismatch: bool = False,
prop_src: Sequence[VideoNode]
) -> VideoNode
__call__(
clip_a: VideoNode,
clip_b: VideoNode,
ranges: FrameRangeN | FrameRangesN | _RangesCallBackLike | None,
exclusive: bool | None = None,
mismatch: bool = False,
*,
prop_src: VideoNode | Sequence[VideoNode] | None = None
) -> VideoNode
Source code
146 147 |
|
remap_frames ¶
Source code
288 289 290 291 292 293 |
|
replace_every ¶
replace_every(
clipa: VideoNode,
clipb: VideoNode,
cycle: int,
offsets: Sequence[int],
modify_duration: bool = True,
) -> ConstantFormatVideoNode
Source code
296 297 298 299 300 301 302 303 304 305 |
|
replace_ranges ¶
replace_ranges(
clip_a: VideoNode,
clip_b: VideoNode,
ranges: FrameRangeN | FrameRangesN | _RangesCallBackLike | None,
exclusive: bool | None = None,
mismatch: bool = False,
*,
prop_src: VideoNode | Sequence[VideoNode] | None = None
) -> VideoNode
Replaces frames in a clip, either with pre-calculated indices or on-the-fly with a callback.
Frame ranges are inclusive by default. This behaviour can be changed by setting exclusive=True
for one-time use, or set replace_ranges.exclusive = True
to apply the change globally.
Examples with clips black
and white
of equal length:
# Replaces frames 0 and 1 with ``white``
replace_ranges(black, white, [(0, 1)])
# Replaces the entire clip with ``white``
replace_ranges(black, white, [(None, None)])
# Same as previous
replace_ranges(black, white, [(0, None)])
# Replaces 200 until the end with ``white``
replace_ranges(black, white, [(200, None)])
# Replaces 200 until the end with ``white``, leaving 1 frame of ``black``
replace_ranges(black, white, [(200, -1)])
A callback function can be used to replace frames based on frame properties. The function must return a boolean value.
Example of using a callback function
# Replaces frames from ``clip_a`` with ``clip_b`` if the picture type of ``clip_a`` is P.
replace_ranges(clip_a, clip_b, lambda f: get_prop(f, '_PictType', str) == 'P', prop_src=clip_a)``
Optional Dependencies:
- [vs-zip](https://github.com/dnjulek/vapoursynth-zip) (highly recommended!)
Parameters:
-
clip_a
¶VideoNode
) –Original clip.
-
clip_b
¶VideoNode
) –Replacement clip.
-
ranges
¶FrameRangeN | FrameRangesN | _RangesCallBackLike | None
) –Ranges to replace clip_a (original clip) with clip_b (replacement clip).
Integer values in the list indicate single frames, tuple values indicate inclusive ranges. Callbacks must return true to replace a with b. Negative integer values will be wrapped around based on clip_b's length. None values are context dependent:
* None provided as sole value to ranges: no-op * Single None value in list: Last frame in clip_b * None as first value of tuple: 0 * None as second value of tuple: Last frame in clip_b
-
exclusive
¶bool | None
, default:None
) –Force the use of exclusive (Python-style) ranges.
-
mismatch
¶bool
, default:False
) –Accept format or resolution mismatch between clips.
-
prop_src
¶VideoNode | Sequence[VideoNode] | None
, default:None
) –Source clip(s) to use for frame properties in the callback. This is required if you're using a callback.
Raises:
-
CustomValueError
–If
prop_src
isn't specified and a callback needs it. -
CustomValueError
–If a wrong callback signature is provided.
Returns:
-
VideoNode
–Clip with ranges from clip_a replaced with clip_b.
Source code
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
|