Soluble\MediaTools\Video\Info\VideoStream

Complexity

Total Complexity

46

Size/Duplication

Total Lines	217
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	getCodecName()	0	3	1
A	getBitRate()	0	3	1
A	getColorTransfer()	0	3	1
A	getProfile()	0	3	1
A	getCodecTimeBase()	0	3	1
A	getLevel()	0	3	1
A	getFpsFromDuration()	0	7	3
A	getCodedWidth()	0	3	1
A	getStartTime()	0	3	1
A	isAvc()	0	7	2
A	getDisplayAspectRatio()	0	3	1
A	getIndex()	0	3	1
A	__construct()	0	4	1
A	getRFrameRate()	0	3	1
A	getWidth()	0	3	1
A	getHeight()	0	3	1
A	getCodecLongName()	0	3	1
A	getDurationTs()	0	3	1
A	getCodecTagString()	0	3	1
A	getNbFrames()	0	3	1
A	getCodedHeight()	0	3	1
A	getTags()	0	3	1
B	getFps()	0	22	10
A	getCodecType()	0	3	1
A	getColorSpace()	0	3	1
A	getStreamMetadata()	0	3	1
A	getDuration()	0	6	2
A	getPixFmt()	0	3	1
A	getDimensions()	0	5	1
A	getColorRange()	0	3	1
A	getAvgFrameRate()	0	3	1
A	getSampleAspectRatio()	0	3	1
A	getTimeBase()	0	3	1

<?php

declare(strict_types=1);

namespace Soluble\MediaTools\Video\Info;

use Psr\Log\LoggerInterface;
use Soluble\MediaTools\Video\Exception\UnexpectedMetadataException;
use Soluble\MediaTools\Video\Info\Util\MetadataTypeSafeReader;

class VideoStream implements VideoStreamInterface
{
    /** @var array<string, mixed> */
    private $streamMetadata;

    /** @var MetadataTypeSafeReader */
    private $tsReader;

    /**
     * @param array<string, mixed> $streamMetadata
     */
    public function __construct(array $streamMetadata, ?LoggerInterface $logger = null)
    {
        $this->streamMetadata = $streamMetadata;
        $this->tsReader       = new MetadataTypeSafeReader($streamMetadata, $logger);
    }

    public function getIndex(): int
    {
        return $this->tsReader->getKeyIntValue('index');
    }

    public function getCodecType(): string
    {
        return $this->tsReader->getKeyStringValue('codec_type');
    }

    public function getCodecName(): string
    {
        return $this->tsReader->getKeyStringValue('codec_name');
    }

    public function getCodecLongName(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('codec_long_name');
    }

    public function getCodecTimeBase(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('codec_time_base');
    }

    public function getCodecTagString(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('codec_tag_string');
    }

    public function getWidth(): int
    {
        return $this->tsReader->getKeyIntValue('width');
    }

    public function getHeight(): int
    {
        return $this->tsReader->getKeyIntValue('height');
    }

    public function getCodedWidth(): ?int
    {
        return $this->tsReader->getKeyIntOrNullValue('coded_width');
    }

    public function getCodedHeight(): ?int
    {
        return $this->tsReader->getKeyIntOrNullValue('coded_height');
    }

    public function getSampleAspectRatio(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('sample_aspect_ratio');
    }

    public function getDisplayAspectRatio(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('display_aspect_ratio');
    }

    public function getPixFmt(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('pix_fmt');
    }

    public function getAvgFrameRate(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('avg_frame_rate');
    }

    public function getRFrameRate(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('r_frame_rate');
    }

    public function getTimeBase(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('time_base');
    }

    public function getDurationTs(): ?int
    {
        return $this->tsReader->getKeyIntOrNullValue('duration_ts');
    }

    public function getDuration(): float
    {
        try {
            return $this->tsReader->getKeyFloatValue('duration');
        } catch (UnexpectedMetadataException $e) {
            return 0;
        }
    }

    public function getProfile(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('profile');
    }

    public function getBitRate(): ?int
    {
        return $this->tsReader->getKeyIntOrNullValue('bit_rate');
    }

    public function getNbFrames(): ?int
    {
        return $this->tsReader->getKeyIntOrNullValue('nb_frames');
    }

    public function isAvc(): ?bool
    {
        if (!isset($this->streamMetadata['is_avc'])) {
            return null;
        }

        return $this->streamMetadata['is_avc'] === 'true';
    }

    public function getLevel(): ?int
    {
        return $this->tsReader->getKeyIntOrNullValue('level');
    }

    public function getStartTime(): ?float
    {
        return $this->tsReader->getKeyFloatOrNullValue('start_time');
    }

    public function getColorRange(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('color_range');
    }

    public function getColorSpace(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('color_space');
    }

    public function getColorTransfer(): ?string
    {
        return $this->tsReader->getKeyStringOrNullValue('color_transfer');
    }

    public function getDimensions(): array
    {
        return [
            'width'  => $this->getWidth(),
            'height' => $this->getHeight()
        ];
    }

    public function getFps(?int $decimals = null): ?float
    {
        $rFrame = $this->getRFrameRate();
        $fps    = null;

        if ($rFrame !== null && preg_match('/^[0-9]+\/[0-9]+$/', $rFrame) !== false) {
            // Let's use the rframe_rate
            [$frames, $base] = explode('/', $rFrame);
            if (is_numeric($base) && $base > 0 && is_numeric($frames) && $frames > 0) {
                $fps = (float) ((int) $frames / (int) $base);
            }
        }

        if ($fps === null) {
            $fps = $this->getFpsFromDuration();
        }

        if ($decimals !== null && $fps !== null) {
            $fps = round($fps, $decimals);
        }

        return $fps;
    }

    private function getFpsFromDuration(): ?float
    {
        if (($this->getNbFrames() ?? 0) > 0 && ($this->getDuration() ?? 0) > 0) {
            return (float) $this->getNbFrames() / $this->getDuration();
        }

        return null;
    }

    /**
     * @return array<string, string>
     */
    public function getTags(): array
    {
        return $this->streamMetadata['tags'] ?? [];
    }

    /**
     * Return underlying ffprobe json metadata.
     *
     * @return array<string, mixed>
     */
    public function getStreamMetadata(): array
    {
        return $this->streamMetadata;
    }
}