Method __init__

scenedetect/output/image.py:109–161

Multi-threaded implementation of save-images functionality. Uses background threads to handle image encoding and saving images to disk to improve parallelism. This object is thread-safe. Arguments: num_images: Number of images to generate for each scene. Minimu

(
        self,
        num_images: int = 3,
        frame_margin: TimecodeLike = 1,
        image_extension: str = "jpg",
        imwrite_param: list[int] | None = None,
        image_name_template: str = "$VIDEO_NAME-Scene-$SCENE_NUMBER-$IMAGE_NUMBER",
        scale: float | None = None,
        height: int | None = None,
        width: int | None = None,
        interpolation: Interpolation = Interpolation.CUBIC,
    )

class _ImageExtractor:
    def __init__(
        self,
        num_images: int = 3,
        frame_margin: TimecodeLike = 1,
        image_extension: str = "jpg",
        imwrite_param: list[int] | None = None,
        image_name_template: str = "$VIDEO_NAME-Scene-$SCENE_NUMBER-$IMAGE_NUMBER",
        scale: float | None = None,
        height: int | None = None,
        width: int | None = None,
        interpolation: Interpolation = Interpolation.CUBIC,
    ):
        """Multi-threaded implementation of save-images functionality. Uses background threads to
        handle image encoding and saving images to disk to improve parallelism.

        This object is thread-safe.

        Arguments:
            num_images: Number of images to generate for each scene.  Minimum is 1.
            frame_margin: Padding around the beginning and end of each scene used when
                selecting which frames to extract. Accepts an int (frames), float (seconds),
                or str (e.g. ``"0.1s"``, ``"00:00:00.100"``). Can be 0, but some video files
                may then fail to extract the very last frame.
            image_extension: Type of image to save (must be one of 'jpg', 'png', or 'webp').
            encoder_param: Quality/compression efficiency, based on type of image:
                'jpg' / 'webp':  Quality 0-100, higher is better quality.  100 is lossless for webp.
                'png': Compression from 1-9, where 9 achieves best filesize but is slower to encode.
            image_name_template: Template to use for output filanames. Can use template variables
                $VIDEO_NAME, $SCENE_NUMBER, $IMAGE_NUMBER, $TIMECODE, $FRAME_NUMBER, $TIMESTAMP_MS.
                *NOTE*: Should not include the image extension (set `image_extension` instead).
            scale: Optional factor by which to rescale saved images. A scaling factor of 1 would
                not result in rescaling. A value < 1 results in a smaller saved image, while a
                value > 1 results in an image larger than the original. This value is ignored if
                either the height or width values are specified.
            height: Optional value for the height of the saved images. Specifying both the height
                and width will resize images to an exact size, regardless of aspect ratio.
                Specifying only height will rescale the image to that number of pixels in height
                while preserving the aspect ratio.
            width: Optional value for the width of the saved images. Specifying both the width
                and height will resize images to an exact size, regardless of aspect ratio.
                Specifying only width will rescale the image to that number of pixels wide
                while preserving the aspect ratio.
            interpolation: Type of interpolation to use when resizing images.
        """
        self._num_images = num_images
        self._frame_margin = frame_margin
        self._image_extension = image_extension
        self._image_name_template = image_name_template
        self._scale = scale
        self._height = height
        self._width = width
        self._interpolation = interpolation
        self._imwrite_param: list[int] = imwrite_param if imwrite_param is not None else []

    def run(
        self,