Video
August 14, 2025 ยท View on GitHub
Auto-generated documentation for musicalgestures._video module.
- Mgt-python / Modules / Musicalgestures / Video
MgVideo
class MgVideo(MgAudio):
def __init__(
filename: Union[str, List[str]],
array=None,
fps=None,
path=None,
filtertype='Regular',
thresh=0.05,
starttime=0,
endtime=0,
blur='None',
skip=0,
frames=0,
rotate=0,
color=True,
contrast=0,
brightness=0,
crop='None',
keep_all=False,
returned_by_process=False,
sr=22050,
n_fft=2048,
hop_length=512,
):
This is the class for working with video files in the Musical Gestures Toolbox. It inherites from the class MgAudio for working with audio files as well. There is a set of preprocessing tools you can use when you load a video, such as:
- trimming: to extract a section of the video,
- skipping: to shrink the video by skipping N frames after keeping one,
- rotating: to rotate the video by N degrees,
- applying brightness and contrast
- cropping: to crop the video either automatically (by assessing the area of motion) or manually with a pop-up user interface,
- converting to grayscale
These preprocesses will apply upon creating the MgVideo. Further processes are available as class methods.
See also
MgVideo().average
def average(**kwargs):
Backward compatibility alias for blend(component_mode='average'). Creates an average image of all frames in the video.
Arguments
**kwargs- Additional arguments passed to blend method. -Note- 'normalize' parameter is accepted for backward compatibility but ignored.
Returns
MgImage- A new MgImage pointing to the output average image file.
MgVideo().extract_frame
def extract_frame(**kwargs):
Extracts a frame from the video at a given time. see _utils.extract_frame for details.
Arguments
frameint - The frame number to extract.timestr - The time in HH:MM:ss.ms where to extract the frame from.target_namestr, optional - The name for the output file. If None, the name will be <input name>FRAME<frame number>.<file extension>. Defaults to None.overwritebool, optional - Whether to allow overwriting existing files or to automatically increment target filename to avoid overwriting. Defaults to False.
Returns
MgImage- An MgImage object referring to the extracted frame.
MgVideo().from_numpy
def from_numpy(array, fps, target_name=None):
MgVideo().get_video
def get_video():
Creates a video attribute to the Musical Gestures object with the given correct settings.
MgVideo().numpy
def numpy():
Pipe all video frames from FFmpeg to numpy array
MgVideo().test_input
def test_input():
Gives feedback to user if initialization from input went wrong.