external.ffmpeg#

Contains various utility methods, and convert(), the main method used to convert a source image sequence to a movie file using an external FFMPEG binary.

The FFMpeg ui elements are defined at bookmarks.external.ffmpeg_widget.FFMpegWidget.

Classes:

SafeDict

Utility class.

Functions:

convert(path, preset[, server, job, root, ...])

Start a convert process using ffmpeg.

get_progress_bar(startframe, endframe)

A progress bar used during the conversion process.

class bookmarks.external.ffmpeg.SafeDict[source]#

Bases: dict

Utility class.

bookmarks.external.ffmpeg.convert(path, preset, server=None, job=None, root=None, asset=None, task=None, size=(None, None), timecode=False, output_path=None)[source]#

Start a convert process using ffmpeg.

Parameters
  • path (str) – Path to image file to convert.

  • preset (str) – An ffmpeg preset.

  • server (str) – server path segment.

  • job (str) – job path segment.

  • root (str) – root path segment.

  • asset (str) – asset path segment.

  • task (str) – task path segment.

  • size (tuple(int, int)) – The output video width in pixels.

  • timecode (bool) – Add an informative timecode stamp when True.

  • output_path (str) – Video output path.

Returns

The path to the generated movie file or None when the process fails.

Return type

str

Raises

RuntimeError – If the input path is not a sequence or not found.

bookmarks.external.ffmpeg.get_progress_bar(startframe, endframe)[source]#

A progress bar used during the conversion process.

Returns

A widget instance.

Return type

QProgressBar