ffmpeg-mappable-media/README.md

# Mappable Media for PHP-FFMPEG

[![Latest Version on Packagist](https://img.shields.io/packagist/v/danjones000/ffmpeg-mappable-media.svg?style=flat-square)](https://packagist.org/packages/danjones000/ffmpeg-mappable-media)
[![Total Downloads](https://img.shields.io/packagist/dt/danjones000/ffmpeg-mappable-media.svg?style=flat-square)](https://packagist.org/packages/danjones000/ffmpeg-mappable-media)

Mappable Media is a plugin for [PHP-FFMpeg](https://github.com/PHP-FFMpeg/PHP-FFMpeg/) which provides a mechanism for mapping individual streams from input to output files.

It allows for greater control regarding specific codecs and metadata from a particular input stream to a particular output stream than the built-in [AdvancedMedia](https://github.com/PHP-FFMpeg/PHP-FFMpeg/#advancedmedia) provides.

## Installation

You can install the package via composer:

```bash
composer require danjones000/ffmpeg-mappable-media
```

## Usage

```php
use Danjones\FFMpeg\MappableMedia;
use FFMpeg\FFMpeg;

$ffmpeg = FFMpeg::create();
$media = MappableMedia::make($ffmpeg);

$media->addInput('video.mp4');
$media->addInput('audio.opus');
$media->addInput('sub.srt');

$output1 = $media->map();
$output1->saveAs('no-subs.webm');
$output1->metadata('title', 'The Greatest Stury Ever Hulaed');

$stream1 = $output1->stream();
$stream1->setInput('0:0');
$stream1->video('libvp9');
$stream1->saveStream();

$stream2 = $output1->stream();
$stream2->setInput('1:0');
$stream2->copy();
$stream2->saveStream();

$output1->saveMap();

$output2 = $media->map();
$output2->saveAs('all-copy.mkv');

// Most methods return the object that calls them.
$output2->stream()->setInput('0:0')->copy()->saveStream();
$output2->stream()->setInput('1:0')->copy()->saveStream();
$output2->stream()->setInput('2:0')->copy()->metadata('language', 'eng')->saveStream();
$output2->saveMap();

$media->save();
```

The `saveStream` method returns the `Map` that created it. Likewise, the `saveMap` returns the `MappableMedia` that created it. All other methods are chainable.

So, this could be written as a very long single call like this:

```php
MappableMedia::make($ffmpeg)
    ->addInput('video.mp4')
    ->addInput('audio.opus')
    ->addInput('sub.srt')
    ->map()
        ->saveAs('no-subs.webm')
        ->metadata('title', 'The Greatest Story Ever Hulaed')
        ->stream()->setInput('0:0')->video('libvp9')->saveStream()
        ->stream()->setInput('1:0')->copy()->saveStream()
        ->saveMap()
    ->map()
        ->saveAs('all-copy.mkv')
        ->stream()->setInput('0:0')->copy()->saveStream()
        ->stream()->setInput('1:0')->copy()->saveStream()
        ->stream()->setInput('2:0')->copy()->metadata('language', 'eng')->saveStream()
        ->saveMap()
    ->save()
 ```

Both of these calls would result in the following command being run:

```shell
ffmpeg -y -i video.mp4 -i audio.opus -i sub.srt -map 0:0 -c:0 libvp9 -map 1:0 -c:1 copy -metadata title="The Greatest Story Ever Hulaed" no-subs.webm -map 0:0 -c:0 copy -map 1:0 -c:1 copy -map 2:0 -c:2 copy -metadata:s:2 language=eng all-copy.mkv
```

This will result in two files. The first will be a webm file (suitable for play in a browser) with a `title` field on the file set to "The Greatest Story Ever Hulaed". The second file will copy the first stream from each file directly, and set the language of the subtitle stream to English.

## What's not yet done?

Mostly documentation. There are a lot more ways to use this, including using the `Format` objects from PHP-FFMpeg to set the codecs, and the ability to use callbacks to set additional data on both maps and individual streams.

I also need to figure out how to set the listeners on the codecs to get realtime progress updates (see [Formats](https://github.com/PHP-FFMpeg/PHP-FFMpeg/#formats)). Once that's figured out, I need to document it properly here.

## Contributing

Please see [CONTRIBUTING](https://codeberg.org/spatie/.github/blob/main/CONTRIBUTING.md) for details.

## Credits

- [Dan Jones](https://codeberg.org/danjones000)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.