Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various typos #1633

Merged
merged 1 commit into from
Jul 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ FAQ and troubleshooting

This section will fill up as MoviePy advances through the next steps of
development (currently on the roadmap: MoviePy Studio, MoviePy WebApp, MoviePy OS, MoviePy
Trust Inc., and the MoviePy Charity Fundation).
Trust Inc., and the MoviePy Charity Foundation).

Common errors that are not bugs
--------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/docker.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Moviepy Docker
===============

Prequisites
Prerequisites
-------------

1. Docker installed `Docker for Mac, Docker for windows, linux, etc <https://www.docker.com/get-docker/>`_
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/the_end.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

So let's explain this one: there is a clip with "The End" written in the middle, and *above* this
clip there is the actual movie. The actual movie has a mask which represents
a white (=opaque) circle on a black (=transparent) background. At the begining,
a white (=opaque) circle on a black (=transparent) background. At the beginning,
that circle is so large that you see all the actual movie and you don't see
the "The End" clip. Then the circle becomes progressively smaller and as a
consequence you see less of the actual movie and more of the "The End" clip.
Expand Down
6 changes: 3 additions & 3 deletions docs/gallery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ This `vector animations tutorial <https://zulko.github.io/blog/2014/09/20/vector
style="max-width:50%; height:'auto'; display:block; margin-left: auto;margin-right: auto; margin-bottom:30px;" /></a>


It is also possible to combine MoviePy with other graphic librairies like matplotlib, etc.
It is also possible to combine MoviePy with other graphic libraries like matplotlib, etc.


3D animations
Expand Down Expand Up @@ -111,7 +111,7 @@ Or use `this script <https://gist.github.com/Zulko/b910c8b22e8e1c01fae6>`_ to ma
Data animations
----------------

This `data animation tutorial <https://zulko.github.io/blog/2014/11/13/things-you-can-do-with-python-and-pov-ray/>`_ shows how to use MoviePy to animate the different Python vizualization libraries: Mayavi, Vispy, Scikit-image, Matplotlib, etc.
This `data animation tutorial <https://zulko.github.io/blog/2014/11/13/things-you-can-do-with-python-and-pov-ray/>`_ shows how to use MoviePy to animate the different Python visualization libraries: Mayavi, Vispy, Scikit-image, Matplotlib, etc.


Scientific or technological projects
Expand Down Expand Up @@ -147,7 +147,7 @@ Kapwing
Rinconcam
----------

`Rincomcam <http://www.rinconcam.com/month/2014-03>`_ is a camera which films surfers on the Californian beach of Point Rincon. At the end of each day it cuts together a video, puts it online, and tweets it. Everything is entirely automatized with Python.
`Rincomcam <http://www.rinconcam.com/month/2014-03>`_ is a camera which films surfers on the Californian beach of Point Rincon. At the end of each day it cuts together a video, puts it online, and tweets it. Everything is entirely automated with Python.
MoviePy is used to add transitions, titles and music to the videos.


Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/compositing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Concatenation is done with the function ``concatenate_videoclips``: ::
final_clip.write_videofile("my_concatenation.mp4")


The ``final_clip`` is a clip that plays the clips 1, 2, and 3 one after the other. Note that the clips do not need to be the same size. If they arent's they will all appear centered in a clip large enough to contain the biggest of them, with optionnally a color of your choosing to fill the borders. You have many other options there (see the doc of the function). You can for instance play a transition clip between the clips with the option ``transition=my_clip``.
The ``final_clip`` is a clip that plays the clips 1, 2, and 3 one after the other. Note that the clips do not need to be the same size. If they arent's they will all appear centered in a clip large enough to contain the biggest of them, with optionally a color of your choosing to fill the borders. You have many other options there (see the doc of the function). You can for instance play a transition clip between the clips with the option ``transition=my_clip``.

Stacking is done with ``clip_array``: ::

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/efficient_moviepy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Most of the time, just having one frame of the video can tell you if you are doi
clip.show and clip.preview
""""""""""""""""""""""""""""

The methods ``clip.show`` and ``clip.preview`` enable you to vizualise the clip in a Pygame window. They are the fastest way to preview, as the clips are generated and displayed at the same time, and they can be useful to get the coordinates or colors of pixels. These methods require to have PyGame installed, and to use the ``moviepy.editor`` module.
The methods ``clip.show`` and ``clip.preview`` enable you to visualise the clip in a Pygame window. They are the fastest way to preview, as the clips are generated and displayed at the same time, and they can be useful to get the coordinates or colors of pixels. These methods require to have PyGame installed, and to use the ``moviepy.editor`` module.

The method ``clip.show`` enables preview one frame of a clip without having to write it to a file: the following lines display the frame in a PyGame window ::

Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/quick_presentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Do I need MoviePy?
Here are a few reasons why you may want to edit videos in Python:

- You have many videos to process or to compose in a complicated way.
- You want to automatize the creation of videos or GIFs on a web server (Django, Flask, etc.)
- You want to automatize tedious tasks, like title insertions tracking objects, cutting scenes, making end credits, subtitles, etc...
- You want to automate the creation of videos or GIFs on a web server (Django, Flask, etc.)
- You want to automate tedious tasks, like title insertions tracking objects, cutting scenes, making end credits, subtitles, etc...
- You want to code your own video effects to do something no existing video editor can.
- You want to create animations from images generated by another python library (Matplotlib, Mayavi, Gizeh, scikit-images...)

Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/videoclips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Creating and exporting video clips
===================================

Video and audio clips are the central objects of MoviePy. In this section we present the different sorts of clips, how to create them, and how to write them to a file. For informations on modifying a clip (cuts, effects, etc.), see :ref:`effects`. For how to put clips together see :ref:`CompositeVideoClips` and to see how to preview clips before writing a file, refer to :ref:`efficient`.
Video and audio clips are the central objects of MoviePy. In this section we present the different sorts of clips, how to create them, and how to write them to a file. For information on modifying a clip (cuts, effects, etc.), see :ref:`effects`. For how to put clips together see :ref:`CompositeVideoClips` and to see how to preview clips before writing a file, refer to :ref:`efficient`.

The following code summarizes the base clips that you can create with moviepy: ::

Expand Down Expand Up @@ -189,7 +189,7 @@ There are many options to optimize the quality and size of a gif. Please refer t

Note that for editing gifs the best way is to preview them in the notebook as explained here: :ref:`ipython_display`

For examples of use, see `this blog post <https://zulko.github.io/blog/2014/01/23/making-animated-gifs-from-video-files-with-python>`_ for informations on making GIFs from video files, and `this other post <https://zulko.github.io/blog/2014/09/20/vector-animations-with-python/>`_ for GIF animations with vector graphics.
For examples of use, see `this blog post <https://zulko.github.io/blog/2014/01/23/making-animated-gifs-from-video-files-with-python>`_ for information on making GIFs from video files, and `this other post <https://zulko.github.io/blog/2014/09/20/vector-animations-with-python/>`_ for GIF animations with vector graphics.

Export images
"""""""""""""""
Expand Down
2 changes: 1 addition & 1 deletion docs/ref/code_origanization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The folder ``moviepy/`` the classes and modules relative to the video and the au

- ``Clip.py`` defines the base object for ``AudioClip`` and ``VideoClip`` and the simple methods that can be used by both, like ``clip.subclip``, ``clip.with_duration``, etc.
- Files ``config.py`` and ``config_defaults.py`` store the default paths to the external programs FFMPEG and ImageMagick.
- ``decorators.py`` provides very useful decorators that automatize some tasks, like the fact that some effects, when applied to a clip, should also be applied to it's mask, or to its audio track.
- ``decorators.py`` provides very useful decorators that automate some tasks, like the fact that some effects, when applied to a clip, should also be applied to it's mask, or to its audio track.
- ``tools.py`` provides misc. functions that are useful everywhere in the library, like a standardized call to subprocess, a time converter, a standardized way to print messages in the console, etc.
- ``editor.py`` is a helper module to easily load and initiate many functionalities of moviepy (see :ref:`efficient` for more details)

Expand Down
8 changes: 4 additions & 4 deletions moviepy/Clip.py
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ def with_start(self, t, change_end=True):
change_end : bool optional
Indicates if the ``end`` attribute value must be changed accordingly,
if possible. If ``change_end=True`` and the clip has a ``duration``
attribute, the ``end`` atrribute of the clip will be updated to
attribute, the ``end`` attribute of the clip will be updated to
``start + duration``. If ``change_end=False`` and the clip has a
``end`` attribute, the ``duration`` attribute of the clip will be
updated to ``end - start``.
Expand Down Expand Up @@ -277,7 +277,7 @@ def with_duration(self, duration, change_end=True):

change_end : bool, optional
If ``True``, the ``end`` attribute value of the clip will be adjusted
acordingly to the new duration using ``clip.start + duration``.
accordingly to the new duration using ``clip.start + duration``.
"""
self.duration = duration

Expand Down Expand Up @@ -328,7 +328,7 @@ def with_fps(self, fps, change_duration=False):

@outplace
def with_is_mask(self, is_mask):
"""Says wheter the clip is a mask or not.
"""Says whether the clip is a mask or not.

Parameters
----------
Expand All @@ -340,7 +340,7 @@ def with_is_mask(self, is_mask):

@outplace
def with_memoize(self, memoize):
"""Sets wheter the clip should keep the last frame read in memory.
"""Sets whether the clip should keep the last frame read in memory.

Parameters
----------
Expand Down
4 changes: 2 additions & 2 deletions moviepy/audio/AudioClip.py
Original file line number Diff line number Diff line change
Expand Up @@ -325,14 +325,14 @@ def __init__(self, clips):
self.clips = clips
self.nchannels = max(clip.nchannels for clip in self.clips)

# self.duration is setted at AudioClip
# self.duration is set at AudioClip
duration = None
for end in self.ends:
if end is None:
break
duration = max(end, duration or 0)

# self.fps is setted at AudioClip
# self.fps is set at AudioClip
fps = None
for clip in self.clips:
if hasattr(clip, "fps") and isinstance(clip.fps, numbers.Number):
Expand Down
2 changes: 1 addition & 1 deletion moviepy/audio/io/ffmpeg_audiowriter.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def write_frames(self, frames_array):

elif "bitrate not specified" in ffmpeg_error:
error += (
"\n\nThe audio export failed, possily because the "
"\n\nThe audio export failed, possibly because the "
"bitrate you specified was too high or too low for "
"the audio codec."
)
Expand Down
2 changes: 1 addition & 1 deletion moviepy/tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ def deprecated_func(*args, **kwargs):
return deprecated_func


# Non-exhaustive dictionary to store default informations.
# Non-exhaustive dictionary to store default information.
# Any addition is most welcome.
# Note that 'gif' is complicated to place. From a VideoFileClip point of view,
# it is a video, but from a HTML5 point of view, it is an image.
Expand Down
2 changes: 1 addition & 1 deletion moviepy/video/VideoClip.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class VideoClip(Clip):
----------

size
The size of the clip, (width,heigth), in pixels.
The size of the clip, (width,height), in pixels.

w, h
The width and height of the clip, in pixels.
Expand Down
4 changes: 2 additions & 2 deletions moviepy/video/compositing/CompositeVideoClip.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class CompositeVideoClip(VideoClip):
clips
A list of videoclips.

Clips with a higher ``layer`` attribute will be dislayed
Clips with a higher ``layer`` attribute will be displayed
on top of other clips in a lower layer.
If two or more clips share the same ``layer``,
then the one appearing latest in ``clips`` will be displayed
Expand Down Expand Up @@ -183,7 +183,7 @@ def clips_array(array, rows_widths=None, cols_heights=None, bg_color=None):
Widths of the different rows in pixels. If ``None``, is set automatically.

cols_heights
Heights of the different colums in pixels. If ``None``, is set automatically.
Heights of the different columns in pixels. If ``None``, is set automatically.

bg_color
Fill color for the masked and unfilled regions. Set to ``None`` for these
Expand Down
2 changes: 1 addition & 1 deletion moviepy/video/compositing/concatenate.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def concatenate_videoclips(
There are two methods:

- method="chain": will produce a clip that simply outputs
the frames of the succesive clips, without any correction if they are
the frames of the successive clips, without any correction if they are
not of the same size of anything. If none of the clips have masks the
resulting clip has no mask, else the mask is a concatenation of masks
(using completely opaque for clips that don't have masks, obviously).
Expand Down
2 changes: 1 addition & 1 deletion moviepy/video/fx/painting.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def painting(clip, saturation=1.4, black=0.006):
"""
Transforms any photo into some kind of painting. Saturation
tells at which point the colors of the result should be
flashy. ``black`` gives the anount of black lines wanted.
flashy. ``black`` gives the amount of black lines wanted.
Requires Scikit-image or Scipy installed.
"""
return clip.image_transform(lambda im: to_painting(im, saturation, black))
Expand Down
2 changes: 1 addition & 1 deletion moviepy/video/fx/resize.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def resize(clip, new_size=None, height=None, width=None, apply_to_mask=True):
--------

>>> myClip.resize( (460,720) ) # New resolution: (460,720)
>>> myClip.resize(0.6) # width and heigth multiplied by 0.6
>>> myClip.resize(0.6) # width and height multiplied by 0.6
>>> myClip.resize(width=800) # height computed automatically.
>>> myClip.resize(lambda t : 1+0.02*t) # slow swelling of the clip
"""
Expand Down
2 changes: 1 addition & 1 deletion moviepy/video/io/VideoFileClip.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class VideoFileClip(VideoClip):
has_mask:
Set this to 'True' if there is a mask included in the videofile.
Video files rarely contain masks, but some video codecs enable
that. For istance if you have a MoviePy VideoClip with a mask you
that. For instance if you have a MoviePy VideoClip with a mask you
can save it to a videofile with a mask. (see also
``VideoClip.write_videofile`` for more details).

Expand Down
10 changes: 5 additions & 5 deletions moviepy/video/io/ffmpeg_reader.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ def get_frame(self, t):
whenever possible, by moving between adjacent frames.
"""
# + 1 so that it represents the frame position that it will be
# after the frame is read. This makes the later comparisions easier.
# after the frame is read. This makes the later comparisons easier.
pos = self.get_frame_number(t) + 1

# Initialize proc if it is not open
Expand Down Expand Up @@ -333,12 +333,12 @@ def _reset_state(self):
initialization and at the end of the parsing process.
"""
# could be 2 possible types of metadata:
# - file_metadata: Metadata of the container. Here are the tags setted
# - file_metadata: Metadata of the container. Here are the tags set
# by the user using `-metadata` ffmpeg option
# - stream_metadata: Metadata for each stream of the container.
self._inside_file_metadata = False

# this state is neeeded if `duration_tag_separator == "time="` because
# this state is needed if `duration_tag_separator == "time="` because
# execution of ffmpeg decoding the whole file using `-f null -` appends
# to the output the blocks "Stream mapping:" and "Output:", which
# should be ignored
Expand Down Expand Up @@ -761,7 +761,7 @@ def ffmpeg_parse_infos(
- ``"audio_metadata"``

Note that "video_duration" is slightly smaller than "duration" to avoid
fetching the uncomplete frames at the end, which raises an error.
fetching the incomplete frames at the end, which raises an error.

Parameters
----------
Expand Down Expand Up @@ -822,4 +822,4 @@ def ffmpeg_parse_infos(
raise IsADirectoryError(f"'{filename}' is a directory")
elif not os.path.exists(filename):
raise FileNotFoundError(f"'{filename}' not found")
raise IOError(f"Error pasing `ffmpeg -i` command output:\n\n{infos}") from exc
raise IOError(f"Error passing `ffmpeg -i` command output:\n\n{infos}") from exc
2 changes: 1 addition & 1 deletion moviepy/video/io/gif_writers.py
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ def write_gif(
look for the clip's ``fps`` attribute.

with_mask : bool, optional
Includes tha mask of the clip in the output (the clip must have a mask
Includes the mask of the clip in the output (the clip must have a mask
if this argument is ``True``).

program : str, optional
Expand Down
2 changes: 1 addition & 1 deletion moviepy/video/io/preview.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ def preview(
audio = audio and (clip.audio is not None)

if audio:
# the sound will be played in parrallel. We are not
# the sound will be played in parallel. We are not
# parralellizing it on different CPUs because it seems that
# pygame and openCV already use several cpus it seems.

Expand Down
6 changes: 3 additions & 3 deletions moviepy/video/tools/cuts.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Contains everything that can help automatize the cuts in MoviePy."""
"""Contains everything that can help automate the cuts in MoviePy."""

from collections import defaultdict

Expand Down Expand Up @@ -99,7 +99,7 @@ def __eq__(self, other):
class FramesMatches(list):
"""Frames matches inside a set of frames.

You can instanciate it passing a list of FramesMatch objects or
You can instantiate it passing a list of FramesMatch objects or
using the class methods ``load`` and ``from_clip``.

Parameters
Expand Down Expand Up @@ -290,7 +290,7 @@ def distance(t1, t2):
for t3 in t_F[i + 1 :]:
# For all the next times t3, use d(F(t), F(end_time)) to
# update the bounds on d(F(t), F(t3)). See if you can
# conclude on wether F(t) and F(t3) match.
# conclude on whether F(t) and F(t3) match.
t3t, t2t3 = frame_dict[t3][t], frame_dict[t2][t3]
t3t["max"] = min(t3t["max"], dist + t2t3["max"])
t3t["min"] = max(t3t["min"], dist - t2t3["max"], t2t3["min"] - dist)
Expand Down
Loading