Soluble\MediaTools\Video\Filter\CropFilter

Complexity

Total Complexity

8

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	getFFmpegCLIValue()	0	14	7
A	__construct()	0	14	1

<?php

declare(strict_types=1);

/**
 * @see       https://github.com/soluble-io/soluble-mediatools for the canonical repository
 *
 * @copyright Copyright (c) 2018-2020 Sébastien Vanvelthem. (https://github.com/belgattitude)
 * @license   https://github.com/soluble-io/soluble-mediatools/blob/master/LICENSE.md MIT
 */

namespace Soluble\MediaTools\Video\Filter;

use Soluble\MediaTools\Video\Filter\Type\FFMpegVideoFilterInterface;

final class CropFilter implements FFMpegVideoFilterInterface
{
    /** @var int|string|null */
    private $height;

    /** @var int|string|null */
    private $width;

    /** @var int|string|null */
    private $x;

    /** @var int|string|null */
    private $y;

    /** @var bool */
    private $keepAspect;

    /** @var bool */
    private $exact;

    /**
     * Crop filter.
     *
     * @see https://ffmpeg.org/ffmpeg-filters.html#crop
     *
     * @param string|int|null $width      The width of the output video, it defaults to 'iw'
     * @param string|int|null $height     The height of the output video, it defaults to 'ih'
     * @param string|int|null $x          The horizontal position, in the input video, of the left edge of the output video. It defaults to '(in_w-out_w)/2'
     * @param string|int|null $y          The vertical position, in the input video, of the top edge of the output video. It defaults to '(in_h-out_h)/2'
     * @param bool            $keepAspect will force the output display aspect ratio to be the same of the input, by changing the output sample aspect ratio
     * @param bool            $exact      Enable exact cropping. If enabled, subsampled videos will be cropped at exact width/height/x/y as specified and will not be rounded to nearest smaller value.
     */
    public function __construct(
        $width = null,
        $height = null,
        $x = null,
        $y = null,
        bool $keepAspect = false,
        bool $exact = false
    ) {
        $this->width      = $width;
        $this->height     = $height;
        $this->x          = $x;
        $this->y          = $y;
        $this->keepAspect = $keepAspect;
        $this->exact      = $exact;
    }

    public function getFFmpegCLIValue(): string
    {
        $args = array_filter([
            ($this->width !== null) ? "w={$this->width}" : false,
            ($this->height !== null) ? "h={$this->height}" : false,
            ($this->x !== null) ? "x={$this->x}" : false,
            ($this->y !== null) ? "y={$this->y}" : false,
            ($this->keepAspect) ? 'keep_aspect=1' : false,
            ($this->exact) ? 'exact=1' : false,
        ]);

        return sprintf(
            'crop=%s',
            implode(':', $args)
        );
    }
}