dilneiss/php-ffmpeg

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

1.0.0 2024-05-29 13:30 UTC

This package is auto-updated.

Last update: 2024-08-29 13:57:59 UTC


README

Latest Version on Packagist Software License run-tests Total Downloads

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

请注意

这个库是如何工作的

此库需要一个工作状态的 FFMpeg 安装。您将需要 FFMpeg 和 FFProbe 的二进制文件来使用它。请确保这些二进制文件可以通过系统 PATH 定位,以获得二进制检测的好处,否则您必须在加载时显式给出二进制文件的路径。

已知问题

  • 当使用 libav 0.8 时,使用旋转和调整大小将产生损坏的输出。此错误已在版本 9 中修复。此错误在最新版本的 ffmpeg 中不存在。

安装

此库需要 PHP 8.0 或更高版本。对于旧版本的 PHP,请查看 0.x-branch

安装 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);

您可以通过传递一个 temporary_directory 键来指定临时文件的路径。

$ffmpeg = FFMpeg\FFMpeg::create(array(
    'temporary_directory' => '/var/ffmpeg-tmp'
), $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

请注意,音频和视频比特率是在格式中设置的。您可以通过将千比特率设置为 0 来禁用 -b:v 选项。

$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');

默认情况下,这将保存帧为 jpg 图像。

您可以使用 setFrameFileType 来覆盖此设置,以将帧保存为其他格式

$frameFileType = 'jpg'; // either 'jpg', 'jpeg' or 'png'
$filter = new ExtractMultipleFramesFilter($frameRate, $destinationFolder);
$filter->setFrameFileType($frameFileType);

$video->addFilter($filter);
剪辑

在所需点切割视频。使用输入查找方法。这是比使用过滤器剪辑更快的选择。

$clip = $video->clip(FFMpeg\Coordinate\TimeCode::fromSeconds(30), FFMpeg\Coordinate\TimeCode::fromSeconds(15));
$clip->save(new FFMpeg\Format\Video\X264(), 'video.avi');

剪辑过滤器需要两个参数

  • $start,一个 FFMpeg\Coordinate\TimeCode 的实例,指定剪辑的起点
  • $duration,可选,一个FFMpeg\Coordinate\TimeCode实例,指定剪辑的时长

在剪辑上可以应用与视频相同的过滤器。例如,调整大小过滤器。

$clip = $video->clip(FFMpeg\Coordinate\TimeCode::fromSeconds(30), FFMpeg\Coordinate\TimeCode::fromSeconds(15));
$clip->filters()->resize(new FFMpeg\Coordinate\Dimension(320, 240), FFMpeg\Filters\Video\ResizeFilter::RESIZEMODE_INSET, true);
$clip->save(new FFMpeg\Format\Video\X264(), 'video.avi');
生成波形

您可以使用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实例
  • $mode,以下常量之一FFMpeg\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以获取准确的图像;执行时间会更长。

动图

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

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

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

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

拼接

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

根据源码的编解码器,有两种拼接视频的方法。如果您的源都已使用相同的编解码器编码,您将希望使用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 recommend 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);

保存函数的布尔参数允许您使用copy参数,这可以极大地加速编码文件的生成。

要拼接使用不同编解码器编码的视频,请按照以下步骤操作

// In order to instantiate the video object, you HAVE TO pass a path to a valid video file.
// We recommend 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中拼接的更多详细信息,请参阅此处此处此处

高级媒体

AdvancedMedia可能具有多个输入和多个输出。

此类主要开发用于与-filter_complex一起使用。

因此,其filters()方法仅接受可以在-filter_complex命令中使用的过滤器。AdvancedMedia已包含一些内置的过滤器。

基本用法

例如

$advancedMedia = $ffmpeg->openAdvanced(array('video_1.mp4', 'video_2.mp4'));
$advancedMedia->filters()
    ->custom('[0:v][1:v]', 'hstack', '[v]');
$advancedMedia
    ->map(array('0:a', '[v]'), new X264('aac', 'libx264'), 'output.mp4')
    ->save();

此代码取2个输入视频,将它们水平堆叠在1个输出视频中,并将第一个视频的音频添加到新视频中。(这不可能使用只有1个输入和1个输出的简单过滤器图)。

复杂示例

AdvancedMedia可能性的更复杂示例。假设所有输入视频都具有相同的分辨率和持续时间。(“xstack”过滤器已添加到ffmpeg的4.1版本中)。

$inputs = array(
    'video_1.mp4',
    'video_2.mp4',
    'video_3.mp4',
    'video_4.mp4',
);

$advancedMedia = $ffmpeg->openAdvanced($inputs);
$advancedMedia->filters()
    ->custom('[0:v]', 'negate', '[v0negate]')
    ->custom('[1:v]', 'edgedetect', '[v1edgedetect]')
    ->custom('[2:v]', 'hflip', '[v2hflip]')
    ->custom('[3:v]', 'vflip', '[v3vflip]')
    ->xStack('[v0negate][v1edgedetect][v2hflip][v3vflip]', XStackFilter::LAYOUT_2X2, 4, '[resultv]');
$advancedMedia
    ->map(array('0:a'), new Mp3(), 'video_1.mp3')
    ->map(array('1:a'), new Flac(), 'video_2.flac')
    ->map(array('2:a'), new Wav(), 'video_3.wav')
    ->map(array('3:a'), new Aac(), 'video_4.aac')
    ->map(array('[resultv]'), new X264('aac', 'libx264'), 'output.mp4')
    ->save();

此代码取4个输入视频,然后对第一个视频取反,将结果存储在[v0negate]流中,检测第二个视频中的边缘,将结果存储在[v1edgedetect]流中,水平翻转第三个视频,将结果存储在[v2hflip]流中,垂直翻转第四个视频,将结果存储在[v3vflip]流中,然后取这4个生成的流并将它们组合成一个2x2拼贴视频。然后将原始视频的音频保存到4种不同的格式,并将生成的拼贴视频保存到单独的文件中。

如您所见,您可以使用多个输入源,同时对它们进行复杂处理,并在同一个ffmpeg命令中生成多个输出文件。

只需给我一个映射表!

您不必使用-filter_complex。您只需使用-map选项。例如,只需从视频中提取音频

$advancedMedia = $ffmpeg->openAdvanced(array('video.mp4'));
$advancedMedia
    ->map(array('0:a'), new Mp3(), 'output.mp3')
    ->save();

自定义

如果需要,您可以对AdvancedMedia的ffmpeg命令结果进行额外自定义

$advancedMedia = $ffmpeg->openAdvanced($inputs);
$advancedMedia
    ->setInitialParameters(array('the', 'params', 'that', 'will', 'be', 'added', 'before', '-i', 'part', 'of', 'the', 'command'))
    ->setAdditionalParameters(array('the', 'params', 'that', 'will', 'be', 'added', 'at', 'the', 'end', 'of', 'the', 'command'));

格式

格式实现了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的默认输入编解码器时特别有用。

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

$format = new FFMpeg\Format\Video\X264();
$format->setInitialParameters(array('-acodec', 'libopus'));
$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\FFProbeFFMpeg\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

许可证

本项目采用https://open-source.org.cn/licenses/MIT(MIT许可证)授权。

音乐:"Favorite Secrets" by Waylon Thornton from the Free Music Archive CC BY NC SA

音乐:"Siesta" by Jahzzar from the Free Music Archive CC BY SA