mronx/php-ffmpeg

FFMpeg PHP,一个用于与 AVconv / ffmpeg 通信的面向对象库

0.14.0 2018-06-11 00:09 UTC

README

Build Status

SensioLabsInsight

一个用于使用 FFmpeg / AVConv 转换视频/音频文件的面向对象库。

请查看另一个令人惊叹的仓库: PHP FFMpeg extras,你将在那里找到许多音频/视频格式。

请注意

这个库是如何工作的

此库需要安装的 FFMpeg。您需要 FFMpeg 和 FFProbe 的二进制文件才能使用它。请确保这些二进制文件可以通过系统 PATH 定位,以获得二进制检测的好处,否则您必须在加载时显式提供二进制文件的路径。

对于 Windows 用户:请在 http://ffmpeg.zeranoe.com/builds/ 找到二进制文件。

已知问题

  • 当使用 libav 0.8 时,使用旋转和缩放将生成损坏的输出。此错误在版本 9 中已修复。此错误在最新版本的 ffmpeg 中不会出现。

安装

安装 PHP-FFMpeg 的推荐方式是通过 Composer

$ composer require php-ffmpeg/php-ffmpeg

基本用法

require 'vendor/autoload.php';

$ffmpeg = FFMpeg\FFMpeg::create();
$video = $ffmpeg->open('video.mpg');
$video
    ->filters()
    ->resize(new FFMpeg\Coordinate\Dimension(320, 240))
    ->synchronize();
$video
    ->frame(FFMpeg\Coordinate\TimeCode::fromSeconds(10))
    ->save('frame.jpg');
$video
    ->save(new FFMpeg\Format\Video\X264(), 'export-x264.mp4')
    ->save(new FFMpeg\Format\Video\WMV(), 'export-wmv.wmv')
    ->save(new FFMpeg\Format\Video\WebM(), 'export-webm.webm');

文档

此文档是发现 API 的介绍。建议浏览源代码,因为它具有自文档化。

FFMpeg

FFMpeg\FFMpeg 是用于操作媒体的主要对象。要构建它,请使用静态 FFMpeg\FFMpeg::create

$ffmpeg = FFMpeg\FFMpeg::create();

FFMpeg 将自动检测 ffmpeg 和 ffprobe 的二进制文件。如果您想明确提供二进制文件路径,可以传递一个数组作为配置。还可以传递一个 Psr\Logger\LoggerInterface 来记录二进制执行。

$ffmpeg = FFMpeg\FFMpeg::create(array(
    'ffmpeg.binaries'  => '/opt/local/ffmpeg/bin/ffmpeg',
    'ffprobe.binaries' => '/opt/local/ffmpeg/bin/ffprobe',
    'timeout'          => 3600, // The timeout for the underlying process
    'ffmpeg.threads'   => 12,   // The number of threads that FFMpeg should use
), $logger);

操作媒体

FFMpeg\FFMpeg 基于 URI 创建媒体。URI 可以是本地文件系统资源的指针、HTTP 资源或 FFmpeg 支持的任何资源。

注意:要列出您构建的 FFmpeg 支持的所有资源类型,请使用 -protocols 命令

ffmpeg -protocols

要打开资源,请使用 FFMpeg\FFMpeg::open 方法。

$ffmpeg->open('video.mpeg');

可以解析两种类型的媒体:FFMpeg\Media\AudioFFMpeg\Media\Video。通过视频还可以使用第三种类型,即 FFMpeg\Media\Frame

视频

FFMpeg\Media\Video 可以进行转码,即:更改编解码器、分离音频或视频。可以提取帧。

转码

您可以使用 FFMpeg\Media\Video:save 方法进行视频转码。您将传递一个 FFMpeg\Format\FormatInterface

请注意,音频和视频比特率是在格式中设置的。

$format = new FFMpeg\Format\Video\X264();
$format->on('progress', function ($video, $format, $percentage) {
    echo "$percentage % transcoded";
});

$format
    ->setKiloBitrate(1000)
    ->setAudioChannels(2)
    ->setAudioKiloBitrate(256);

$video->save($format, 'video.avi');

实时监控转码进度,请参阅下面的格式文档以获取更多信息。

提取图像

您可以使用 FFMpeg\Media\Video::frame 方法在任何时间码处提取一个帧。

此代码返回一个对应于第 42 秒的 FFMpeg\Media\Frame 实例。您可以将任何 FFMpeg\Coordinate\TimeCode 作为参数传递,请参阅下面的专用文档以获取更多信息。

$frame = $video->frame(FFMpeg\Coordinate\TimeCode::fromSeconds(42));
$frame->save('image.jpg');

如果您想从视频中提取多个图像,可以使用以下过滤器

$video
    ->filters()
    ->extractMultipleFrames(FFMpeg\Filters\Video\ExtractMultipleFramesFilter::FRAMERATE_EVERY_10SEC, '/path/to/destination/folder/')
    ->synchronize();

$video
    ->save(new FFMpeg\Format\Video\X264(), '/path/to/new/file');
生成波形

您可以使用 FFMpeg\Media\Audio::waveform 方法生成音频文件的波形。

此代码返回一个 FFMpeg\Media\Waveform 实例。您可以可选地传递前两个参数作为尺寸,以及一个用于 ffmpeg 波形的十六进制字符串颜色数组。更多详细信息,请参阅下面的专用文档。

输出文件必须使用 PNG 扩展名。

$waveform = $audio->waveform(640, 120, array('#00FF00'));
$waveform->save('waveform.png');

如果您想从视频中获取波形,请先将其转换为音频文件。

// Open your video file
$video = $ffmpeg->open( 'video.mp4' );

// Set an audio format
$audio_format = new FFMpeg\Format\Audio\Mp3();

// Extract the audio into a new file as mp3
$video->save($audio_format, 'audio.mp3');

// Set the audio file
$audio = $ffmpeg->open( 'audio.mp3' );

// Create the waveform
$waveform = $audio->waveform();
$waveform->save( 'waveform.png' );
过滤器

您可以使用 FFMpeg\Media\Video::addFilter 方法在 FFMpeg\Media\Video 上应用过滤器。视频接受音频和视频过滤器。

您可以构建自己的过滤器,PHP-FFMpeg 中包含一些,它们可以通过 FFMpeg\Media\Video::filters 方法访问。

过滤器可链式使用

$video
    ->filters()
    ->resize($dimension, $mode, $useStandards)
    ->framerate($framerate, $gop)
    ->synchronize();
旋转

将视频旋转到指定角度。

$video->filters()->rotate($angle);

参数 $angle 必须是以下常量之一

  • FFMpeg\Filters\Video\RotateFilter::ROTATE_90:顺时针 90°
  • FFMpeg\Filters\Video\RotateFilter::ROTATE_180:180°
  • FFMpeg\Filters\Video\RotateFilter::ROTATE_270:逆时针 90°
调整大小

将视频调整到指定大小。

$video->filters()->resize($dimension, $mode, $useStandards);

调整大小过滤器接受三个参数

  • $dimension,一个 FFMpeg\Coordinate\Dimension 实例
  • $modeFFMpeg\Filters\Video\ResizeFilter::RESIZEMODE_* 常量之一
  • $useStandards,一个布尔值,用于强制使用最接近的宽高比标准。

如果您想以非标准比例的视频,您可以使用填充过滤器以所需大小调整您的视频,并将其包裹在黑色边框中。

$video->filters()->pad($dimension);

填充过滤器接受一个参数

  • $dimension,一个 FFMpeg\Coordinate\Dimension 实例

别忘了保存。

$video->save(new FFMpeg\Format\Video\X264(), $new_file);
水印

使用指定图像水印视频。

$video
    ->filters()
    ->watermark($watermarkPath, array(
        'position' => 'relative',
        'bottom' => 50,
        'right' => 50,
    ));

水印过滤器接受两个参数

$watermarkPath,水印文件路径。 $coordinates,一个数组,定义您想要的水印位置。您可以使用上面的相对定位或绝对定位

$video
    ->filters()
    ->watermark($watermarkPath, array(
        'position' => 'absolute',
        'x' => 1180,
        'y' => 620,
    ));
帧率

更改视频的帧率。

$video->filters()->framerate($framerate, $gop);

帧率过滤器接受两个参数

  • $framerate,一个 FFMpeg\Coordinate\Framerate 实例
  • $gop,一个 GOP 值(整数)
同步

同步音频和视频。

某些容器可能使用延迟,导致输出不同步。此过滤器可解决此问题。

$video->filters()->synchronize();
裁剪

在所需点裁剪视频。

$video->filters()->clip(FFMpeg\Coordinate\TimeCode::fromSeconds(30), FFMpeg\Coordinate\TimeCode::fromSeconds(15));

裁剪过滤器接受两个参数

  • $start,一个 FFMpeg\Coordinate\TimeCode 实例,指定裁剪的开始点
  • $duration,可选,一个 FFMpeg\Coordinate\TimeCode 实例,指定裁剪的持续时间
裁剪

根据宽度和高度(一个 Point)裁剪视频。

$video->filters()->crop(new FFMpeg\Coordinate\Point("t*100", 0, true), new FFMpeg\Coordinate\Dimension(200, 600));

它接受两个参数

  • $point,一个 FFMpeg\Coordinate\Point 实例,指定裁剪点
  • $dimension,一个 FFMpeg\Coordinate\Dimension 实例,指定输出视频的尺寸

音频

FFMpeg\Media\Audio 也可以进行转码,即:更改编解码器、隔离音频或视频。可以提取帧。

转码

您可以使用 FFMpeg\Media\Audio:save 方法转码音频。您将传递一个 FFMpeg\Format\FormatInterface

请注意,音频千比特率是在音频格式中设置的。

$ffmpeg = FFMpeg\FFMpeg::create();
$audio = $ffmpeg->open('track.mp3');

$format = new FFMpeg\Format\Audio\Flac();
$format->on('progress', function ($audio, $format, $percentage) {
    echo "$percentage % transcoded";
});

$format
    ->setAudioChannels(2)
    ->setAudioKiloBitrate(256);

$audio->save($format, 'track.flac');

实时监控转码进度,请参阅下面的格式文档以获取更多信息。

过滤器

您可以使用 FFMpeg\Media\Audio::addFilter 方法在 FFMpeg\Media\Audio 上应用过滤器。它仅接受音频过滤器。

您可以构建自己的过滤器,PHP-FFMpeg 中包含一些,它们可以通过 FFMpeg\Media\Audio::filters 方法访问。

剪辑

在所需点剪辑音频。

$audio->filters()->clip(FFMpeg\Coordinate\TimeCode::fromSeconds(30), FFMpeg\Coordinate\TimeCode::fromSeconds(15));
元数据

将元数据添加到音频文件中。只需传递一个包含所有要添加的元数据的键=值对数组的数组。如果没有传递参数到过滤器,则将从输入文件中删除所有元数据。目前支持的数据包括标题、艺术家、专辑、作曲家、曲目、年份、描述、封面

$audio->filters()->addMetadata(["title" => "Some Title", "track" => 1]);

//remove all metadata and video streams from audio file
$audio->filters()->addMetadata();

将封面添加到音频文件中

$audio->filters()->addMetadata(["artwork" => "/path/to/image/file.jpg"]);

注意:目前ffmpeg(版本3.2.2)仅支持.mp3文件的封面输出

重采样

重采样音频文件。

$audio->filters()->resample($rate);

重采样过滤器接受两个参数

  • $rate,有效的音频采样率值(整数)

帧是视频在特定时间码的图像;请参阅关于帧提取的上述文档。

您可以使用FFMpeg\Media\Frame::save方法保存帧。

$frame->save('target.jpg');

此方法有一个可选的第二个布尔参数。将其设置为true以获取准确的图像;这将花费更多时间来执行。

Gif

Gif是从视频序列中提取的动画图像。

您可以使用FFMpeg\Media\Gif::save方法保存gif文件。

$video = $ffmpeg->open( '/path/to/video' );
$video
    ->gif(FFMpeg\Coordinate\TimeCode::fromSeconds(2), new FFMpeg\Coordinate\Dimension(640, 480), 3)
    ->save($new_file);

此方法有一个第三个可选的布尔参数,表示动画的持续时间。如果您不设置它,您将得到一个固定的gif图像。

连接

此功能允许您根据多个源生成一个音频或视频文件。

根据源编解码器的不同,有两种连接视频的方法。如果您的源都使用相同的编解码器进行了编码,您将希望使用FFMpeg\Media\Concatenate::saveFromSameCodecs,它具有更好的性能。如果您的源使用不同的编解码器进行了编码,您将希望使用FFMpeg\Media\Concatenate::saveFromDifferentCodecs

第一个函数将使用初始编解码器作为生成文件的编解码器。在第二个函数中,您可以选择要为生成文件使用的编解码器。

您还需要注意,当使用saveFromDifferentCodecs方法时,您的文件必须具有视频和音频流。

在两种情况下,您都必须提供一个文件数组。

要连接具有相同编解码器的视频,请按以下操作

// In order to instantiate the video object, you HAVE TO pass a path to a valid video file.
// We recommand that you put there the path of any of the video you want to use in this concatenation.
$video = $ffmpeg->open( '/path/to/video' );
$video
    ->concat(array('/path/to/video1', '/path/to/video2'))
    ->saveFromSameCodecs('/path/to/new_file', TRUE);

保存函数的布尔参数允许您使用复制参数,该参数可以极大地加快编码文件的生成。

要连接具有相同编解码器的视频,请按以下操作

// In order to instantiate the video object, you HAVE TO pass a path to a valid video file.
// We recommand that you put there the path of any of the video you want to use in this concatenation.
$video = $ffmpeg->open( '/path/to/video' );

$format = new FFMpeg\Format\Video\X264();
$format->setAudioCodec("libmp3lame");

$video
    ->concat(array('/path/to/video1', '/path/to/video2'))
    ->saveFromDifferentCodecs($format, '/path/to/new_file');

有关FFMPEG中连接的更多详细信息,请参阅此处此处此处

格式

格式实现了FFMpeg\Format\FormatInterface。要将视频保存到文件,请使用FFMpeg\Format\VideoInterface,对于音频文件请使用FFMpeg\Format\AudioInterface

格式还可以扩展FFMpeg\Format\ProgressableInterface以获取实时转码信息。

预定义的格式已提供进度信息作为事件。

$format = new FFMpeg\Format\Video\X264();
$format->on('progress', function ($video, $format, $percentage) {
    echo "$percentage % transcoded";
});

$video->save($format, 'video.avi');

为事件提供的回调可以是任何可调用的。

添加附加参数

您可以根据视频格式添加附加参数到您的编码请求中。

setAdditionalParameters方法的参数是一个数组。

$format = new FFMpeg\Format\Video\X264();
$format->setAdditionalParameters(array('foo', 'bar'));
$video->save($format, 'video.avi');
创建自己的格式

创建格式的最简单方法是扩展抽象的FFMpeg\Format\Video\DefaultVideoFFMpeg\Format\Audio\DefaultAudio,并实现以下方法。

class CustomWMVFormat extends FFMpeg\Format\Video\DefaultVideo
{
    public function __construct($audioCodec = 'wmav2', $videoCodec = 'wmv2')
    {
        $this
            ->setAudioCodec($audioCodec)
            ->setVideoCodec($videoCodec);
    }

    public function supportBFrames()
    {
        return false;
    }

    public function getAvailableAudioCodecs()
    {
        return array('wmav2');
    }

    public function getAvailableVideoCodecs()
    {
        return array('wmv2');
    }
}

坐标

FFMpeg使用许多时间和空间坐标单位。

  • FFMpeg\Coordinate\AspectRatio表示一个宽高比。
  • FFMpeg\Coordinate\Dimension表示一个维度。
  • FFMpeg\Coordinate\FrameRate表示一个帧率。
  • FFMpeg\Coordinate\Point表示一个点。(从v0.10.0开始支持动态点)
  • FFMpeg\Coordinate\TimeCode表示一个时间码。

FFProbe

FFMpeg\FFProbe 是由 FFMpeg\FFMpeg 内部用于探测媒体文件的。您也可以用它来提取媒体元数据。

$ffprobe = FFMpeg\FFProbe::create();
$ffprobe
    ->streams('/path/to/video/mp4') // extracts streams informations
    ->videos()                      // filters video streams
    ->first()                       // returns the first video stream
    ->get('codec_name');            // returns the codec_name property
$ffprobe = FFMpeg\FFProbe::create();
$ffprobe
    ->format('/path/to/video/mp4') // extracts file informations
    ->get('duration');             // returns the duration property

验证媒体文件

(自 0.10.0 版本起) 您可以使用 PHP-FFMpeg 的 FFProbe 封装来验证媒体文件。

$ffprobe = FFMpeg\FFProbe::create();
$ffprobe->isValid('/path/to/file/to/check'); // returns bool

与 Silex 微框架一起使用

服务提供者易于设置

$app = new Silex\Application();
$app->register(new FFMpeg\FFMpegServiceProvider());

$video = $app['ffmpeg']->open('video.mpeg');

可用的选项如下

$app->register(new FFMpeg\FFMpegServiceProvider(), array(
    'ffmpeg.configuration' => array(
        'ffmpeg.threads'   => 4,
        'ffmpeg.timeout'   => 300,
        'ffmpeg.binaries'  => '/opt/local/ffmpeg/bin/ffmpeg',
        'ffprobe.timeout'  => 30,
        'ffprobe.binaries' => '/opt/local/ffmpeg/bin/ffprobe',
    ),
    'ffmpeg.logger' => $logger,
));

许可证

本项目采用 MIT 许可证