Download the PHP package kimdongwan121/laravel-ffmpeg without Composer
On this page you can find all versions of the php package kimdongwan121/laravel-ffmpeg. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kimdongwan121/laravel-ffmpeg
More information about kimdongwan121/laravel-ffmpeg
Files in kimdongwan121/laravel-ffmpeg
Package laravel-ffmpeg
Short Description FFMpeg for Laravel
License MIT
Homepage https://github.com/pascalbaljetmedia/laravel-ffmpeg
Informations about the package laravel-ffmpeg
Laravel FFMpeg
This package provides an integration with FFmpeg for Laravel 6.0 and higher. Laravel's Filesystem handles the storage of the files.
Features
- Super easy wrapper around PHP-FFMpeg, including support for filters and other advanced features.
- Integration with Laravel's Filesystem, configuration system and logging handling.
- Compatible with Laravel 6.0 and higher, support for Package Discovery.
- Built-in support for HLS.
- Built-in support for encrypted HLS (AES-128) and rotating keys (optional).
- Built-in support for concatenation, multiple inputs/outputs, image sequences (timelapse), complex filters (and mapping), frame/thumbnail exports.
- Built-in support for watermarks (positioning and manipulation).
- PHP 7.3 and higher.
- Lots of integration tests, GitHub Actions with both Ubuntu and Windows.
Support
We proudly support the community by developing Laravel packages and giving them away for free. Keeping track of issues and pull requests takes time, but we're happy to help! If this package saves you time or if you're relying on it professionally, please consider supporting the maintenance and development.
Installation
You can install the package via composer:
Add the Service Provider and Facade to your config file if you're not using Package Discovery.
Publish the config file using the artisan CLI tool:
Upgrading to v7
- The namespace has changed to
ProtoneMedia\LaravelFFMpeg
, the facade has been renamed toProtoneMedia\LaravelFFMpeg\Support\FFMpeg
, and the Service Provider has been renamed toProtoneMedia\LaravelFFMpeg\Support\ServiceProvider
. - Chaining exports are still supported, but you have to reapply filters for each export.
- HLS playlists now include bitrate, framerate and resolution data. The segments also use a new naming pattern (read more). Please verify your exports still work in your player.
- HLS export is now executed as one job instead of exporting each format/stream separately. This uses FFMpeg's
map
andfilter_complex
features. It might be sufficient to replace all calls toaddFilter
withaddLegacyFilter
, but some filters should be migrated manually. Please read the documentation on HLS to find out more about adding filters.
Usage
Convert an audio or video file:
Instead of the method you can also use the method, where is an instance of .
Progress monitoring
You can monitor the transcoding progress. Use the method to provide a callback, which gives you the completed percentage. In previous versions of this package you had to pass the callback to the format object.
As of version 7.0, the callback also exposes $remaining
(in seconds) and $rate
:
Open files from the web
You can open files from the web by using the openUrl
method. You can specify custom HTTP headers with the optional second parameter:
Handling exceptions
When the encoding fails, a ProtoneMedia\LaravelFFMpeg\Exporters\EncodingException
shall be thrown, which extends the underlying FFMpeg\Exception\RuntimeException
class. This class has two methods that can help you identify the problem. Using the getCommand
method, you can get the executed command with all parameters. The getErrorOutput
method gives you a full output log.
For legacy reasons, the message of the exception is always Encoding failed. You can replace this message with a more informative message by updating the set_command_and_error_output_on_exception
configuration key to true
.
Filters
You can add filters through a or by using PHP-FFMpeg's Filter objects:
As of version 7.0, you can also call the addFilter
method after the export
method:
Resizing
Since resizing is a common operation, we've added a dedicated method for it:
The first argument is the width, and the second argument the height. The optional third argument is the mode. You can choose between fit
(default), inset
, width
or height
. The optional fourth argument is a boolean whether or not to force the use of standards ratios. You can find about these modes in the FFMpeg\Filters\Video\ResizeFilter
class.
Custom filters
Sometimes you don't want to use the built-in filters. You can apply your own filter by providing a set of options. This can be an array or multiple strings as arguments:
Watermark filter
As of version 7.3, you can easily add a watermark using the addWatermark
method. With the WatermarkFactory
, you can open your watermark file from a specific disk, just like opening an audio or video file. When you discard the fromDisk
method, it uses the default disk specified in the filesystems.php
configuration file.
After opening your watermark file, you can position it with the top
, right
, bottom
, and left
methods. The first parameter of these methods is the offset, which is optional and can be negative.
Instead of using the position methods, you can also use the horizontalAlignment
and verticalAlignment
methods.
For horizontal alignment, you can use the WatermarkFactory::LEFT
, WatermarkFactory::CENTER
and WatermarkFactory::RIGHT
constants. For vertical alignment, you can use the WatermarkFactory::TOP
, WatermarkFactory::CENTER
and WatermarkFactory::BOTTOM
constants. Both methods take an optional second parameter, which is the offset.
The WatermarkFactory
also supports opening files from the web with the openUrl
method. It supports custom HTTP headers as well.
If you want more control over the GET request, you can pass in an optional third parameter, which gives you the Curl resource.
Watermark manipulation
This package can manipulate watermarks by using Spatie's Image package. To get started, install the package with Composer:
Now you can chain one more manipulation methods on the WatermarkFactory
instance:
Check out the documentation for all available methods.
Export without transcoding
This package comes with a ProtoneMedia\LaravelFFMpeg\FFMpeg\CopyFormat
class that allows you to export a file without transcoding the streams. You might want to use this to use another container:
Chain multiple convertions
Create a frame from a video
You can also get the raw contents of the frame instead of saving it to the filesystem:
Multiple exports using loops
Chaining multiple conversions works because the save
method of the MediaExporter
returns a fresh instance of the MediaOpener
. You can use this to loop through items, for example, to exports multiple frames from one video:
The MediaOpener
comes with an each
method as well. The example above could be refactored like this:
Create a timelapse
You can create a timelapse from a sequence of images by using the asTimelapseWithFramerate
method on the exporter
Multiple inputs
As of version 7.0 you can open multiple inputs, even from different disks. This uses FFMpeg's map
and filter_complex
features. You can open multiple files by chaining the open
method of by using an array. You can mix inputs from different disks.
When you open multiple inputs, you have to add mappings so FFMpeg knows how to route them. This package provides a addFormatOutputMapping
method, which takes three parameters: the format, the output, and the output labels of the -filter_complex
part.
The output (2nd argument) should be an instanceof ProtoneMedia\LaravelFFMpeg\Filesystem\Media
. You can instantiate with the make
method, call it with the name of the disk and the path (see example).
Check out this example, which maps separate video and audio inputs into one output.
This is an example from the underlying library:
Just like single inputs, you can also pass a callback to the addFilter
method. This will give you an instance of \FFMpeg\Filters\AdvancedMedia\ComplexFilters
:
Opening files from the web works similarly. You can pass an array of URLs to the openUrl
method, optionally with custom HTTP headers.
If you want to use another set of HTTP headers for each URL, you can chain the openUrl
method:
Concat files without transcoding
Concat files with transcoding
Determinate duration
With the class you can determinate the duration of a file:
Handling remote disks
When opening or saving files from or to a remote disk, temporary files will be created on your server. After you're done exporting or processing these files, you could clean them up by calling the method:
By default, the root of the temporary directories is evaluated by PHP's sys_get_temp_dir()
method, but you can modify it by setting the temporary_files_root
configuration key to a custom path.
HLS
You can create a M3U8 playlist to do HLS.
The method of the HLS exporter takes an optional second parameter which can be a callback method. This allows you to add different filters per format. First, check out the Multiple inputs section to understand how complex filters are handled.
You can use the addFilter
method to add a complex filter (see $lowBitrate
example). Since the scale
filter is used a lot, there is a helper method (see $midBitrate
example). You can also use a callable to get access to the ComplexFilters
instance. The package provides the $in
and $out
arguments so you don't have to worry about it (see $highBitrate
example).
As of version 7.0, HLS export is built using FFMpeg's map
and filter_complex
features. This is a breaking change from previous versions which performed a single export for each format. If you're upgrading, replace the addFilter
calls with addLegacyFilter
calls and verify the result (see $superBitrate
example). Not all filters will work this way and some need to be upgraded manually.
Using custom segment patterns
You can use a custom pattern to name the segments and playlists. The useSegmentFilenameGenerator
gives you 5 arguments. The first, second and third argument provide information about the basename of the export, the format of the current iteration and the key of the current iteration. The fourth argument is a callback you should call with your segments pattern. The fifth argument is a callback you should call with your playlist pattern. Note that this is not the name of the primary playlist, but the name of the playlist of each format.
Encrypted HLS
As of version 7.5, you can encrypt each HLS segment using AES-128 encryption. To do this, call the withEncryptionKey
method on the HLS exporter with a key. We provide a generateEncryptionKey
helper method on the HLSExporter
class to generate a key. Make sure you store the key well, as the exported result is worthless without the key. By default, the filename of the key is secret.key
, but you can change that with the optional second parameter of the withEncryptionKey
method.
To secure your HLS export even further, you can rotate the key on each exported segment. By doing so, it will generate multiple keys that you'll need to store. Use the withRotatingEncryptionKey
method to enable this feature and provide a callback that implements the storage of the keys.
The withRotatingEncryptionKey
method has an optional second argument to set the number of segments that use the same key. This defaults to 1
.
Protecting your HLS encryption keys
To make working with encrypted HLS even better, we've added a DynamicHLSPlaylist
class that modifies playlists on-the-fly and specifically for your application. This way, you can add your authentication and authorization logic. As we're using a plain Laravel controller, you can use features like Gates and Middleware.
In this example, we've saved the HLS export to the public
disk, and we've stored the encryption keys to the secrets
disk, which isn't publicly available. As the browser can't access the encryption keys, it won't play the video. Each playlist has paths to the encryption keys, and we need to modify those paths to point to an accessible endpoint.
This implementation consists of two routes. One that responses with an encryption key and one that responses with a modified playlist. The first route (video.key
) is relatively simple, and this is where you should add your additional logic.
The second route (video.playlist
) uses the DynamicHLSPlaylist
class. Call the dynamicHLSPlaylist
method on the FFMpeg
facade, and similar to opening media files, you can open a playlist utilizing the fromDisk
and open
methods. Then you must provide three callbacks. Each of them gives you a relative path and expects a full path in return. As the DynamicHLSPlaylist
class implements the Illuminate\Contracts\Support\Responsable
interface, you can return the instance.
The first callback (KeyUrlResolver) gives you the relative path to an encryption key. The second callback (MediaUrlResolver) gives you the relative path to a media segment (.ts files). The third callback (PlaylistUrlResolver) gives you the relative path to a playlist.
Now instead of using Storage::disk('public')->url('adaptive_steve.m3u8')
to get the full url to your primary playlist, you can use route('video.playlist', ['playlist' => 'adaptive_steve.m3u8'])
. The DynamicHLSPlaylist
class takes care of all the paths and urls.
Live Coding Session
Here you can find a Live Coding Session about HLS encryption:
https://www.youtube.com/watch?v=WlbzWoAcez4
Process Output
You can get the raw process output by calling the getProcessOutput
method. Though the use-case is limited, you can use it to analyze a file (for example, with the volumedetect
filter). It returns a ProtoneMedia\LaravelFFMpeg\Support\ProcessOutput
class that has three methods: all
, errors
and output
. Each method returns an array with the corresponding lines.
Advanced
The Media object you get when you 'open' a file, actually holds the Media object that belongs to the underlying driver. It handles dynamic method calls as you can see here. This way all methods of the underlying driver are still available to you.
If you want direct access to the underlying object, call the object as a function (invoke):
Experimental
The progress listener exposes the transcoded percentage, but the underlying package also has an internal AbstractProgressListener
that exposes the current pass and the current time. Though the use-case is limited, you might want to get access to this listener instance. You can do this by decorating the format with the ProgressListenerDecorator
. This feature is highly experimental, so be sure the test this thoroughly before using it in production.
Since we can't get rid of some of the underlying options, you can interact with the final FFmpeg command by adding a callback to the exporter. You can add one or more callbacks by using the beforeSaving
method:
Note: this does not work with concatenation and frame exports
Example app
Here's a blog post that will help you get started with this package:
https://protone.media/en/blog/how-to-use-ffmpeg-in-your-laravel-projects
Using Video.js to play HLS in any browser
Here's a 20-minute overview how to get started with Video.js. It covers including Video.js from a CDN, importing it as an ES6 module with Laravel Mix (Webpack) and building a reusable Vue.js component.
https://www.youtube.com/watch?v=nA1Jy8BPjys
Wiki
- Custom filters
- FFmpeg failed to execute command
- Get the dimensions of a Video file
- Monitoring the transcoding progress
- Unable to load FFProbe
Changelog
Please see CHANGELOG for more information about what has changed recently.
Testing
Contributing
Please see CONTRIBUTING for details.
Other Laravel packages
Laravel Analytics Event Tracking
: Laravel package to easily send events to Google Analytics.Laravel Blade On Demand
: Laravel package to compile Blade templates in memory.Laravel Cross Eloquent Search
: Laravel package to search through multiple Eloquent models.Laravel Eloquent Scope as Select
: Stop duplicating your Eloquent query scopes and constraints in PHP. This package lets you re-use your query scopes and constraints by adding them as a subquery.Laravel Eloquent Where Not
: This Laravel package allows you to flip/invert an Eloquent scope, or really any query constraint.Laravel Form Components
: Blade components to rapidly build forms with Tailwind CSS Custom Forms and Bootstrap 4. Supports validation, model binding, default values, translations, includes default vendor styling and fully customizable!Laravel Mixins
: A collection of Laravel goodies.Laravel Paddle
: Paddle.com API integration for Laravel with support for webhooks/events.Laravel Verify New Email
: This package adds support for verifying new email addresses: when a user updates its email address, it won't replace the old one until the new one is verified.Laravel WebDAV
: WebDAV driver for Laravel's Filesystem.
Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker. Please do not email any questions, open an issue if you have a question.
Credits
- Pascal Baljet
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-ffmpeg with dependencies
evenement/evenement Version ^3.0
league/flysystem Version ^1.0.34
illuminate/bus Version ^6.0|^7.0|^8.0
illuminate/config Version ^6.0|^7.0|^8.0
illuminate/filesystem Version ^6.0|^7.0|^8.0
illuminate/log Version ^6.0|^7.0|^8.0
illuminate/support Version ^6.0|^7.0|^8.0
php-ffmpeg/php-ffmpeg Version ^0.18.0