FFMpeg::capture() - Code Metrics - Inspection of "Support Laravel 9" - mostafaznv/larupload - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Pull Request — master (#6)

by Mostafa
created 2022-04-21 15:40 UTC
FFMpeg::capture() B

↳ Parent: FFMpeg
Complexity

Conditions	8
Paths	12
Size

Total Lines	29
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes	7
Bugs	1	Features	0
Metric	Value
cc	8
eloc	19
c	7
b	1
f	0
nc	12
nop	4
dl	0
loc	29
rs	8.4444
<?php

namespace Mostafaznv\Larupload\Storage;

use Exception;
use Illuminate\Http\UploadedFile;
use Mostafaznv\Larupload\Helpers\LaraTools;
use Mostafaznv\Larupload\LaruploadEnum;
use Symfony\Component\HttpFoundation\File\File;
use Illuminate\Support\Facades\Storage;
use Symfony\Component\Process\Process;

class FFMpeg
{
    use LaraTools;


    /**
     * Attached file
     *
     * @var UploadedFile
     */
    protected UploadedFile $file;

    /**
     * Storage Disk
     *
     * @var string
     */
    protected string $disk;

    /**
     * Storage local disk
     *
     * @var string
     */
    protected string $localDisk;

    /**
     * Video Metadata
     *
     * @var array
     */
    protected array $meta = [];

    /**
     * FFMPEG binary address
     *
     * @var string
     */
    protected string $ffmpeg;

    /**
     * FFProbe binary address
     *
     * @var string
     */
    protected string $ffprobe;

    /**
     * Timeout
     *
     * @var ?int
     */
    protected ?int $timeout = null;

    /**
     * Default scale size
     * we use this value if width and height both were undefined
     *
     * @var integer
     */
    const DEFAULT_SCALE = 850;

    /**
     * FFMpeg constructor
     *
     * @param UploadedFile $file
     * @param string $disk
     * @param string $localDisk
     */
    public function __construct(UploadedFile $file, string $disk, string $localDisk)
    {
        $this->file = $file;
        $this->disk = $disk;
        $this->localDisk = $localDisk;

        $config = config('larupload.ffmpeg');

        $this->ffmpeg = $config['ffmpeg-binaries'];
        $this->ffprobe = $config['ffprobe-binaries'];
        $this->timeout = $config['timeout'];
    }

    /**
     * Get Metadata from media file using ffprobe
     *
     * @return array
     * @throws Exception
     */
    public function getMeta(): array
    {
        if (empty($this->meta)) {
            $path = $this->file->getRealPath();
            $meta = [
                'width'    => null,
                'height'   => null,
                'duration' => 0,
            ];

            $cmd = $this->cmd("$this->ffprobe -i $path -loglevel quiet -show_format -show_streams -print_format json");

            $process = new Process($cmd);
            $process->setTimeout($this->timeout);
            $process->setIdleTimeout($this->timeout);
            $process->run();
            $output = $process->getOutput();

            if ($process->isSuccessful()) {
                $output = json_decode($output);

                if ($output !== null) {
                    $rotate = 0;

                    foreach ($output->streams as $stream) {
                        if (isset($stream->width)) {
                            $meta['width'] = (int)$stream->width;
                        }

                        if (isset($stream->height)) {
                            $meta['height'] = (int)$stream->height;
                        }

                        if (isset($stream->duration)) {
                            $meta['duration'] = (int)$stream->duration;
                        }

                        if (isset($stream->tags->rotate)) {
                            $rotate = $stream->tags->rotate;
                        }
                    }

                    if ($rotate == 90 or $rotate == 270) {
                        list($meta['height'], $meta['width']) = array($meta['width'], $meta['height']);
                    }
                }
                else {
                    $process->addErrorOutput('ffprobe output is null');
                    throw new Exception($process->getErrorOutput());
                }
            }
            else {
                throw new Exception($process->getErrorOutput());
            }

            $this->meta = $meta;
        }

        return $this->meta;
    }

    /**
     * Capture screen shot from video file
     *
     * @param $fromSecond
     * @param array $style
     * @param string $saveTo
     * @param bool $withDominantColor
     * @return string|null
     * @throws Exception
     */
    public function capture($fromSecond, array $style, string $saveTo, bool $withDominantColor): ?string
    {
        $meta = $this->getMeta();
        $width = $style['width'] ?? null;
        $height = $style['height'] ?? null;
        $scale = $width ?: ($height ?: self::DEFAULT_SCALE);
        $scaleType = $meta['width'] >= $meta['height'] ? "-1:$scale" : "$scale:-1";
        $mode = $style['mode'] ?? null;
        $path = $this->file->getRealPath();
        $saveTo = Storage::disk($this->disk)->path($saveTo);

        if (is_null($fromSecond)) {
            $fromSecond = floor($meta['duration'] / 2);
            $fromSecond = number_format($fromSecond, 1);
        }

        if ($mode == LaruploadEnum::CROP_STYLE_MODE) {
            if ($width and $height) {
                $cmd = escapeshellcmd("$this->ffmpeg -ss $fromSecond -i $path -vframes 1 -filter scale=$scaleType,crop=$width:$height");
            }
            else {
                $cmd = escapeshellcmd("$this->ffmpeg -ss $fromSecond -i $path -vframes 1 -filter scale=$scaleType,crop=$scale:$scale");
            }
        }
        else {
            $cmd = escapeshellcmd("$this->ffmpeg -ss $fromSecond -i $path -vframes 1 -filter scale=$scaleType");
        }

        return $this->run($cmd, $saveTo, null, $withDominantColor);
    }

    /**
     * Manipulate original video file to crop/resize
     *
     * @param array $style
     * @param string $saveTo
     * @throws Exception
     */
    public function manipulate(array $style, string $saveTo): void
    {
        $width = $style['width'] ?? null;
        $height = $style['height'] ?? null;
        $mode = $style['mode'] ?? null;
        $scale = $this->calculateScale($mode, $width, $height);
        $path = $this->file->getRealPath();
        $saveTo = Storage::disk($this->disk)->path($saveTo);

        if ($mode == LaruploadEnum::CROP_STYLE_MODE) {
            if ($scale) {
                $cmd = escapeshellcmd("$this->ffmpeg -i $path -vf scale=$scale,crop=$width:$height,setsar=1");
            }
            else {
                $cmd = escapeshellcmd("$this->ffmpeg -i $path -vf crop=$width:$height,setsar=1");
            }
        }
        else {
            $cmd = escapeshellcmd("$this->ffmpeg -i $path -vf scale=$scale,setsar=1");
        }

        $this->run($cmd, $saveTo);
    }

    /**
     * Stream - Generate HLS video from source file
     *
     * @param array $styles
     * @param string $basePath
     * @param string $fileName
     * @return bool
     * @throws Exception
     */
    public function stream(array $styles, string $basePath, string $fileName): bool
    {
        $playlist = "#EXTM3U\n#EXT-X-VERSION:3\n";
        $converted = [];
        $driverIsLocal = $this->diskDriverIsLocal($this->disk);
        $disk = $driverIsLocal ? $this->disk : $this->localDisk;

        // generate multiple video qualities from uploaded video.
        foreach ($styles as $name => $style) {
            $width = $style['width'];
            $height = $style['height'];
            $path = $this->file->getRealPath();
            $audioBitRate = $style['bitrate']['audio'];
            $videoBitRate = $style['bitrate']['video'];
            $styleBasePath = "$basePath/$name-convert";

            Storage::disk($disk)->makeDirectory($styleBasePath);
            $saveTo = Storage::disk($disk)->path("$styleBasePath/$name.mp4");

            $cmd = escapeshellcmd("$this->ffmpeg -y -i $path -s {$width}x$height -y -strict experimental -acodec aac -b:a $audioBitRate -ac 2 -ar 48000 -vcodec libx264 -vprofile main -g 48 -b:v $videoBitRate -threads 64");
            $this->run($cmd, $saveTo, $disk);

            $converted[$name] = [
                'path'      => $styleBasePath,
                'file'      => $saveTo,
                'bandwidth' => $videoBitRate,
                'width'     => $width,
                'height'    => $height,
            ];
        }

        // convert generated videos to ts
        foreach ($converted as $name => $value) {
            $m3u8 = 'chunk-list.m3u8';
            $streamBasePath = "$basePath/$name";
            Storage::disk($this->disk)->makeDirectory($streamBasePath);
            $streamBasePath = Storage::disk($this->disk)->path($streamBasePath);

            $cmd = escapeshellcmd("$this->ffmpeg -y -i {$value['file']} -hls_time 9 -hls_segment_filename :stream-path/file-sequence-%d.ts -hls_playlist_type vod :stream-path/$m3u8");
            $this->streamRun($cmd, $streamBasePath);

            $playlist .= "#EXT-X-STREAM-INF:BANDWIDTH={$value['bandwidth']},RESOLUTION={$value['width']}x{$value['height']}\n";
            $playlist .= "$name/$m3u8\n";

            Storage::disk($disk)->deleteDirectory($value['path']);
        }

        if (count($converted)) {
            Storage::disk($this->disk)->put("$basePath/$fileName", $playlist);
            return true;
        }

        return false;
    }

    /**
     * Calculate scale
     *
     * @param string|null $mode
     * @param int|null $width
     * @param int|null $height
     * @return string
     * @throws Exception
     */
    protected function calculateScale(string $mode = null, int $width = null, int $height = null): string
    {
        $meta = $this->getMeta();

        if ($mode == LaruploadEnum::CROP_STYLE_MODE) {
            if ($width >= $meta['width'] or $height >= $meta['height']) {
                if ($meta['width'] >= $meta['height']) {
                    $scale = ceil(($meta['width'] * $height) / $meta['height']);

                    if ($scale < $width) {
                        $scale = $width;
                    }

                    $scale = "$scale:-2";
                }
                else {
                    $scale = ceil(($meta['height'] * $width) / $meta['width']);

                    if ($scale < $height) {
                        $scale = $height;
                    }

                    $scale = "-2:$scale";
                }
            }
            else {
                $scale = '';
            }
        }
        else {
            $scale = $width ? "$width:-2" : ($height ? "-2:$height" : (self::DEFAULT_SCALE . ':-2'));
        }

        return $scale;
    }

    /**
     * Run ffmpeg command.
     * Handle local/non-local drivers
     *
     * @param string $cmd
     * @param string $saveTo
     * @param string|null $disk
     * @param bool $withDominantColor
     * @return string|null
     * @throws Exception
     */
    protected function run(string $cmd, string $saveTo, string $disk = null, bool $withDominantColor = false): ?string
    {
        $disk = $disk ?? $this->disk;

        if ($this->diskDriverIsLocal($disk)) {
            $cmd = $this->cmd("$cmd $saveTo");
            $process = new Process($cmd);
            $process->setTimeout($this->timeout);
            $process->setIdleTimeout($this->timeout);
            $process->run();

            if ($process->isSuccessful()) {
                return $withDominantColor ? $this->calcDominantColor($saveTo) : null;
            }

            throw new Exception($process->getErrorOutput());
        }
        else {
            list($path, $name) = $this->splitPath($saveTo);

            $tempDir = $this->tempDir();
            $tempName = time() . '-' . $name;
            $tempName = time() . '-' . /** @scrutinizer ignore-type */ $name;
            $temp = "$tempDir/$tempName";

            $cmd = $this->cmd("$cmd $temp");
            $process = new Process($cmd);
            $process->setTimeout($this->timeout);
            $process->setIdleTimeout($this->timeout);
            $process->run();

            if ($process->isSuccessful()) {
                $file = new File($temp);

                $dominantColor = $withDominantColor ? $this->calcDominantColor($temp) : null;
                Storage::disk($disk)->putFileAs($path, $file, $name);
                Storage::disk($disk)->putFileAs($path, $file, /** @scrutinizer ignore-type */ $name);

                @unlink($temp);
                /** @scrutinizer ignore-unhandled */ @unlink($temp);

                return $dominantColor;
            }

            throw new Exception($process->getErrorOutput());
        }
    }

    /**
     * Run ffmpeg command for stream videos
     * Handle local/non-local drivers
     *
     * @param string $cmd
     * @param string $streamPath
     * @throws Exception
     */
    protected function streamRun(string $cmd, string $streamPath): void
    {
        if ($this->diskDriverIsLocal($this->disk)) {
            $cmd = $this->cmd(str_replace(':stream-path', $streamPath, $cmd));

            $process = new Process($cmd);
            $process->setTimeout($this->timeout);
            $process->setIdleTimeout($this->timeout);
            $process->run();

            if ($process->isSuccessful()) {
                return;
            }

            throw new Exception($process->getErrorOutput());
        }
        else {
            $name = basename($streamPath);
            $temp = $name . '-' . time();

            Storage::disk($this->localDisk)->makeDirectory($temp);
            $path = Storage::disk($this->localDisk)->path($temp);

            $cmd = $this->cmd(str_replace(':stream-path', $path, $cmd));

            $process = new Process($cmd);
            $process->setTimeout($this->timeout);
            $process->setIdleTimeout($this->timeout);
            $process->run();

            if ($process->isSuccessful()) {
                $files = Storage::disk($this->localDisk)->files($temp);
                $path = Storage::disk($this->localDisk)->path('');

                foreach ($files as $file) {
                    $fileObject = new File("$path/$file");

                    Storage::disk($this->disk)->putFileAs($streamPath, $fileObject, $fileObject->getFilename());

                    unset($fileObject);
                }

                Storage::disk($this->localDisk)->deleteDirectory($temp);

                return;
            }

            throw new Exception($process->getErrorOutput());
        }
    }

    /**
     * Make Normal CMD
     *
     * @param string $cmd
     * @return array
     */
    protected function cmd(string $cmd): array
    {
        $cmd = str_replace('\\', '/', $cmd);

        return explode(' ', escapeshellcmd($cmd));
    }

    /**
     * Calculate Dominant Color
     *
     * @param $path
     * @return string|null
     */
    protected function calcDominantColor($path): ?string
    {
        $file = new UploadedFile($path, basename($path));

        return (new Image($file, $this->disk, $this->localDisk, LaruploadEnum::GD_IMAGE_LIBRARY))->getDominantColor();
    }
}

mostafaznv / larupload

Pull Request — master (#6)

FFMpeg::capture() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
