fiftyone.utils.video¶

Video utilities.

Copyright 2017-2021, Voxel51, Inc.
voxel51.com

Functions

`reencode_video`(input_path, output_path[, …])	Re-encodes the video using the H.264 codec.
`reencode_videos`(sample_collection[, …])	Re-encodes the videos in the sample collection as H.264 MP4s that can be visualized in the FiftyOne App.
`transform_video`(input_path, output_path[, …])	Transforms the video according to the provided parameters using `ffmpeg`.
`transform_videos`(sample_collection[, fps, …])	Transforms the videos in the sample collection according to the provided parameters using `ffmpeg`.

fiftyone.utils.video.reencode_videos(sample_collection, force_reencode=True, delete_originals=False, verbose=False, **kwargs)¶

Re-encodes the videos in the sample collection as H.264 MP4s that can be visualized in the FiftyOne App.

The filepath of the samples are updated to point to the re-encoded videos.

By default, the re-encoding is performed via the following ffmpeg command:

ffmpeg \
    -loglevel error -vsync 0 -i $INPUT_PATH \
    -c:v libx264 -preset medium -crf 23 -pix_fmt yuv420p -vsync 0 -an \
    $OUTPUT_PATH

You can configure parameters of the re-encoding such as codec and compression by passing keyword arguments for eta.core.video.FFmpeg(**kwargs) to this function.

Parameters

sample_collection – a fiftyone.core.collections.SampleCollection
force_reencode (True) – whether to re-encode videos that are already MP4s
delete_originals (False) – whether to delete the original videos after re-encoding
verbose (False) – whether to log the ffmpeg commands that are executed
**kwargs – keyword arguments for eta.core.video.FFmpeg(**kwargs)

fiftyone.utils.video.transform_videos(sample_collection, fps=None, min_fps=None, max_fps=None, size=None, min_size=None, max_size=None, reencode=False, force_reencode=False, delete_originals=False, verbose=False, **kwargs)¶

Transforms the videos in the sample collection according to the provided parameters using ffmpeg.

The filepath of the samples are updated to point to the transformed videos.

In addition to the size and frame rate parameters, if reencode == True, the following basic ffmpeg command structure is used to re-encode the videos as H.264 MP4s:

ffmpeg \
    -loglevel error -vsync 0 -i $INPUT_PATH \
    -c:v libx264 -preset medium -crf 23 -pix_fmt yuv420p -vsync 0 -an \
    $OUTPUT_PATH

Parameters

sample_collection – a fiftyone.core.collections.SampleCollection
fps (None) – an optional frame rate at which to resample the videos
min_fps (None) – an optional minimum frame rate. Videos with frame rate below this value are upsampled
max_fps (None) – an optional maximum frame rate. Videos with frame rate exceeding this value are downsampled
size (None) – an optional (width, height) for each frame. One dimension can be -1, in which case the aspect ratio is preserved
min_size (None) – an optional minimum (width, height) for each frame. A dimension can be -1 if no constraint should be applied. The frames are resized (aspect-preserving) if necessary to meet this constraint
max_size (None) – an optional maximum (width, height) for each frame. A dimension can be -1 if no constraint should be applied. The frames are resized (aspect-preserving) if necessary to meet this constraint
reencode (False) – whether to re-encode the videos as H.264 MP4s
force_reencode (False) – whether to re-encode videos whose parameters already satisfy the specified values
delete_originals (False) – whether to delete the original videos after re-encoding
verbose (False) – whether to log the ffmpeg commands that are executed
**kwargs – keyword arguments for eta.core.video.FFmpeg(**kwargs)

fiftyone.utils.video.reencode_video(input_path, output_path, verbose=False, **kwargs)¶

Re-encodes the video using the H.264 codec.

By default, the re-encoding is performed via the following ffmpeg command:

ffmpeg \
    -loglevel error -vsync 0 -i $INPUT_PATH \
    -c:v libx264 -preset medium -crf 23 -pix_fmt yuv420p -vsync 0 -an \
    $OUTPUT_PATH

You can configure parameters of the re-encoding such as codec and compression by passing keyword arguments for eta.core.video.FFmpeg(**kwargs) to this function.

Parameters

input_path – the path to the input video
output_path – the path to write the output video
verbose (False) – whether to log the ffmpeg command that is executed
**kwargs – keyword arguments for eta.core.video.FFmpeg(**kwargs)

fiftyone.utils.video.transform_video(input_path, output_path, fps=None, min_fps=None, max_fps=None, size=None, min_size=None, max_size=None, reencode=False, verbose=False, **kwargs)¶

Transforms the video according to the provided parameters using ffmpeg.

In addition to the size and frame rate parameters, if reencode == True, the following basic ffmpeg command structure is used to re-encode the video as an H.264 MP4:

ffmpeg \
    -loglevel error -vsync 0 -i $INPUT_PATH \
    -c:v libx264 -preset medium -crf 23 -pix_fmt yuv420p -vsync 0 -an \
    $OUTPUT_PATH

Parameters

input_path – the path to the input video
output_path – the path to write the output video
fps (None) – an optional frame rate at which to resample the videos
min_fps (None) – an optional minimum frame rate. Videos with frame rate below this value are upsampled
max_fps (None) – an optional maximum frame rate. Videos with frame rate exceeding this value are downsampled
size (None) – an optional (width, height) for each frame. One dimension can be -1, in which case the aspect ratio is preserved
min_size (None) – an optional minimum (width, height) for each frame. A dimension can be -1 if no constraint should be applied. The frames are resized (aspect-preserving) if necessary to meet this constraint
max_size (None) – an optional maximum (width, height) for each frame. A dimension can be -1 if no constraint should be applied. The frames are resized (aspect-preserving) if necessary to meet this constraint
reencode (False) – whether to reencode the video (see main description)
verbose (False) – whether to log the ffmpeg command that is executed
**kwargs – keyword arguments for eta.core.video.FFmpeg(**kwargs)