soluble/mediatools

FFMpeg video/audio/subs conversions, thumbnails, audio extraction, query...


README

Logo

PHP 7.1+ Build Status Coverage Code Quality Latest Stable Version Total Downloads PHPStan License

Flexible audio/video conversions and thumbnailing for hiphpies. Wraps around ffmpeg and ffprobe and exposes most of their features, like scaling, clipping, filters, transcoding, audio extraction and much more.

To prevent limitations, the API rather focus on providing developer fine-tuned parameters than giving ready-made recipes. Transcoding and conversions generally requires specific processing, judge by yourself. To help starting, the documentation includes a lot of examples and snippets you can easily try and tune later. Check also alternatives wrappers for ffmpeg, they are good and sometimes offer more magic if you're looking for it.

On another side, it likes PSR (psr-log, psr-container, psr-simplecache), tastes php 7.1 in strict mode, tries to fail as early as possible with clear exception messages and ensure that substitution is possible when you need to customize (SOLID friendly).

Under the hood, it relies on the battle-tested symfony/process, its only dependency.

Documentation

All is here: https://soluble-io.github.io/soluble-mediatools/

Requirements

  • PHP 7.1+
  • FFmpeg/FFProbe 3.4+, 4.0+.

Features

Check the doc to get a more detailed overview !!!

Implemented services

VideoConverter

Full doc: here

<?php
use Soluble\MediaTools\Video\Config\FFMpegConfig;
use Soluble\MediaTools\Video\Exception\ConverterExceptionInterface;
use Soluble\MediaTools\Video\{VideoConverter, VideoConvertParams};

$converter = new VideoConverter(new FFMpegConfig('/path/to/ffmpeg'));

$params = (new VideoConvertParams())
    ->withVideoCodec('libx264')    
    ->withStreamable(true)
    ->withCrf(24);                  
    
try {    
    $converter->convert(
        '/path/inputFile.mov', 
        '/path/outputFile.mp4', 
        $params
    );    
} catch(ConverterExceptionInterface $e) {
    // See chapter about exception !!!    
}
       

VideoInfoReader

Full doc: here

<?php
use Soluble\MediaTools\Video\Config\FFProbeConfig;
use Soluble\MediaTools\Video\Exception\InfoReaderExceptionInterface;
use Soluble\MediaTools\Video\VideoInfoReader;
use Soluble\MediaTools\Video\VideoInfo;

$infoReader = new VideoInfoReader(new FFProbeConfig('/path/to/ffprobe'));

// Step 1: Read a media file

try {
    $info = $infoReader->getInfo('/path/video.mp4');
} catch (InfoReaderExceptionInterface $e) {
    // not a valid video (see exception)
}

$duration = $info->getDuration(); // total duration
$format   = $info->getFormatName(); // container format: mkv, mp4

// Step 2: Media streams info (video, subtitle, audio, data).

// Example with first video stream (streams are iterable)

try {    
    $video   = $info->getVideoStreams()->getFirst();
} catch (\Soluble\MediaTools\Video\Exception\NoStreamException $e) {
    // No video stream, 
}
    
$codec   = $video->getCodecName(); // i.e: vp9
$fps     = $video->getFps($decimals=0); // i.e: 24
$width   = $video->getWidth(); // i.e: 1080
$ratio   = $video->getAspectRatio();

// Alternate example  

if ($info->countStreams(VideoInfo::STREAM_TYPE_SUBTITLE) > 0) {
    $sub  = $info->getSubtitleStreams()->getFirst();
    $sub->getCodecName(); // webvtt
}

VideoThumbGenerator

Full doc: here

<?php
use Soluble\MediaTools\Video\Config\FFMpegConfig;
use Soluble\MediaTools\Video\Exception\ConverterExceptionInterface;
use Soluble\MediaTools\Video\{VideoThumbGenerator, VideoThumbParams, SeekTime};

$generator = new VideoThumbGenerator(new FFMpegConfig('/path/to/ffmpeg'));

$params = (new VideoThumbParams())
    ->withTime(1.25);
    
try {    
    $generator->makeThumbnail(
        '/path/inputFile.mov', 
        '/path/outputFile.jpg', 
        $params
    );    
} catch(ConverterExceptionInterface $e) {
    // See chapter about exception !!!    
}
       

VideoAnalyzer

Full doc: here

<?php
use Soluble\MediaTools\Video\Config\FFMpegConfig;
use Soluble\MediaTools\Video\Exception\AnalyzerExceptionInterface;
use Soluble\MediaTools\Video\VideoAnalyzer;

$analyzer = new VideoAnalyzer(new FFMpegConfig('/path/to/ffmpeg'));

try {    
    $interlaceGuess = $analyzer->detectInterlacement(
        '/path/input.mov',
        // Optional:
        //   $maxFramesToAnalyze, default: 1000
        $maxFramesToAnalyze = 200
    );
    
} catch(AnalyzerExceptionInterface $e) {
    // See chapter about exception !!!    
}

$interlaced = $interlaceGuess->isInterlaced(
    // Optional: 
    //  $threshold, default 0.25 (if >=25% interlaced frames, then true) 
    0.25
);

Alternatives

Coding standards and interop