Skip to content

editors

Contains functions used to edit a VideoFileClip or np.ndarray prior to extraction.

trim_clip 

trim_clip(clip, start_second=None, stop_second=None)

Trim a VideoFileClip to a specific time range and return the trimmed clip.

Args:

`clip` (moviepy.editor.VideoFileClip):
    The clip to trim.
`start_second` (float | None):
    The start time in seconds. If None, the trim will start at the beginning.
`stop_second` (float | None):
    The stop time in seconds. If None, the clip will be trimmed to the end.

Returns:

`moviepy.editor.VideoFileClip`: The trimmed clip.
Source code in videoxt/editors.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def trim_clip(
    clip: VideoFileClip,
    start_second: float | None = None,
    stop_second: float | None = None,
) -> VideoFileClip:
    """
    Trim a VideoFileClip to a specific time range and return the trimmed clip.

    Args:
    -----
        `clip` (moviepy.editor.VideoFileClip):
            The clip to trim.
        `start_second` (float | None):
            The start time in seconds. If None, the trim will start at the beginning.
        `stop_second` (float | None):
            The stop time in seconds. If None, the clip will be trimmed to the end.

    Returns:
    -----
        `moviepy.editor.VideoFileClip`: The trimmed clip.
    """
    if start_second is None and stop_second is None:
        return clip

    if start_second is None:
        start_second = 0.0

    if stop_second is None:
        stop_second = clip.duration

    return clip.subclip(start_second, stop_second)

edit_clip_audio 

edit_clip_audio(clip, volume=None, normalize=None)

Edit the audio of a VideoFileClip by adjusting its volume and normalizing the audio if specified and return the edited clip.

Args:

`clip` (moviepy.editor.VideoFileClip):
    The clip to edit.
`volume` (float | None):
    The volume multiplier. If None, the volume will not be adjusted.
`normalize` (bool | None):
    Whether to normalize the audio. If None, the audio will not be normalized.

Returns:

`moviepy.editor.VideoFileClip`: The edited clip.
Source code in videoxt/editors.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def edit_clip_audio(
    clip: VideoFileClip,
    volume: float | None = None,
    normalize: bool | None = None,
) -> VideoFileClip:
    """
    Edit the audio of a VideoFileClip by adjusting its volume and normalizing the
    audio if specified and return the edited clip.

    Args:
    -----
        `clip` (moviepy.editor.VideoFileClip):
            The clip to edit.
        `volume` (float | None):
            The volume multiplier. If None, the volume will not be adjusted.
        `normalize` (bool | None):
            Whether to normalize the audio. If None, the audio will not be normalized.

    Returns:
    -----
        `moviepy.editor.VideoFileClip`: The edited clip.
    """
    if normalize:
        clip = clip.fx(afx.audio_normalize)

    if volume != 1.0:
        clip = clip.volumex(volume)

    return clip

edit_clip_image 

edit_clip_image(clip, dimensions=None, rotate=None, monochrome=None)

Edit the image properties of a VideoFileClip by resizing, rotating, and converting to monochrome if specified and return the edited clip.

Args:

`clip` (moviepy.editor.VideoFileClip):
    The clip to edit.
`dimensions` (tuple[int, int] | None):
    The dimensions to resize the clip to. If None, the clip will not be resized.
`rotate` (int | None):
    The degrees to rotate the clip. If None, the clip will not be rotated.
`monochrome` (bool | None):
    Whether to convert the clip to monochrome. If None, the black and white
    filter will not be applied.

Returns:

`moviepy.editor.VideoFileClip`: The edited clip.
Source code in videoxt/editors.py 
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def edit_clip_image(
    clip: VideoFileClip,
    dimensions: tuple[int, int] | None = None,
    rotate: int | None = None,
    monochrome: bool | None = None,
) -> VideoFileClip:
    """
    Edit the image properties of a VideoFileClip by resizing, rotating, and converting
    to monochrome if specified and return the edited clip.

    Args:
    -----
        `clip` (moviepy.editor.VideoFileClip):
            The clip to edit.
        `dimensions` (tuple[int, int] | None):
            The dimensions to resize the clip to. If None, the clip will not be resized.
        `rotate` (int | None):
            The degrees to rotate the clip. If None, the clip will not be rotated.
        `monochrome` (bool | None):
            Whether to convert the clip to monochrome. If None, the black and white
            filter will not be applied.

    Returns:
    -----
        `moviepy.editor.VideoFileClip`: The edited clip.
    """
    if dimensions is not None:
        clip = clip.resize(dimensions)

    if rotate != 0:
        clip = clip.rotate(rotate)

    if monochrome:
        clip = clip.fx(vfx.blackwhite)

    return clip

edit_clip_motion 

edit_clip_motion(clip, speed=None, reverse=None, bounce=None)

Edit the moving image properties of a VideoFileClip by adjusting its speed, reversing, and bouncing if specified and return the edited clip.

Args:

`clip` (moviepy.editor.VideoFileClip):
    The clip to edit.
`speed` (float | None):
    The speed multiplier. If None, the speed will not be adjusted.
`reverse` (bool | None):
    Whether to reverse the clip. If None, the clip will not be reversed.
`bounce` (bool | None):
    Whether to bounce the clip. If None, the clip will not be bounced.

Returns:

`moviepy.editor.VideoFileClip`: The edited clip.
Source code in videoxt/editors.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def edit_clip_motion(
    clip: VideoFileClip,
    speed: float | None = None,
    reverse: bool | None = None,
    bounce: bool | None = None,
) -> VideoFileClip:
    """
    Edit the moving image properties of a VideoFileClip by adjusting its speed,
    reversing, and bouncing if specified and return the edited clip.

    Args:
    -----
        `clip` (moviepy.editor.VideoFileClip):
            The clip to edit.
        `speed` (float | None):
            The speed multiplier. If None, the speed will not be adjusted.
        `reverse` (bool | None):
            Whether to reverse the clip. If None, the clip will not be reversed.
        `bounce` (bool | None):
            Whether to bounce the clip. If None, the clip will not be bounced.

    Returns:
    -----
        `moviepy.editor.VideoFileClip`: The edited clip.
    """
    if reverse:
        clip = clip.fx(vfx.time_mirror)

    if bounce:
        clip = clip.fx(vfx.time_symmetrize)

    if speed != 1.0:
        clip = clip.fx(vfx.speedx, speed)

    return clip

edit_image 

edit_image(image, dimensions=None, rotate=None, monochrome=None)

Edit a numpy.ndarray image by resizing, rotating, and converting to monochrome if specified and return the edited image.

Args:

`image` (np.ndarray[Any, Any]):
    The image to edit.
`dimensions` (tuple[int, int] | None):
    The dimensions to resize the image to. If None, the image will not be
    resized.
`rotate` (int | None):
    The degrees to rotate the image. If None, the image will not be rotated.
`monochrome` (bool | None):
    Whether to convert the image to monochrome. If None, the black and white
    filter will not be applied.

Returns:

`np.ndarray[Any, Any]`: The edited image.
Source code in videoxt/editors.py 
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
def edit_image(
    image: np.ndarray[Any, Any],
    dimensions: tuple[int, int] | None = None,
    rotate: int | None = None,
    monochrome: bool | None = None,
) -> np.ndarray[Any, Any]:
    """
    Edit a numpy.ndarray image by resizing, rotating, and converting to monochrome
    if specified and return the edited image.

    Args:
    -----
        `image` (np.ndarray[Any, Any]):
            The image to edit.
        `dimensions` (tuple[int, int] | None):
            The dimensions to resize the image to. If None, the image will not be
            resized.
        `rotate` (int | None):
            The degrees to rotate the image. If None, the image will not be rotated.
        `monochrome` (bool | None):
            Whether to convert the image to monochrome. If None, the black and white
            filter will not be applied.

    Returns:
    -----
        `np.ndarray[Any, Any]`: The edited image.
    """
    if dimensions is not None and dimensions != image.shape:
        image = cv2.resize(image, dimensions)

    if rotate != 0 and rotate is not None:
        try:
            rotate_value = C.ROTATION_MAP[rotate]
        except KeyError:
            pass  # XXX: log
        else:
            image = cv2.rotate(image, rotate_value)

    if monochrome:
        image = cv2.cvtColor(image, cv2.COLOR_BGR2GRAY)

    return image