https://github.com/FedericoCarboni/setup-ffmpeg

Set up your GitHub Actions workflow with ffmpeg
https://github.com/FedericoCarboni/setup-ffmpeg

ffmpeg ffprobe github-action github-actions

Last synced: 7 days ago
JSON representation

Set up your GitHub Actions workflow with ffmpeg

• Host: GitHub
• URL: https://github.com/FedericoCarboni/setup-ffmpeg
• Owner: federicocarboni
• License: mit
• Created: 2020-11-11T16:52:28.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-22T10:14:01.000Z (8 months ago)
• Last Synced: 2024-10-25T12:34:30.533Z (18 days ago)
• Topics: ffmpeg, ffprobe, github-action, github-actions
• Language: JavaScript
• Homepage:
• Size: 2 MB
• Stars: 111
• Watchers: 2
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# setup-ffmpeg

This action sets up and caches a specific FFmpeg version, providing the `ffmpeg`

and `ffprobe` commands.

Builds are downloaded from the following sources:

-  Linux builds

-  Windows builds

-  MacOS builds

## v3 vs v2

Version 3 of this action downloads binaries directly from the sources listed above

instead of periodically updating GitHub releases. In turn this means it receives

updates more frequently and supports git master builds and selecting a specific

version.

By default the latest release version available for the platform is used. As

upstream sources are not guaranteed to update at the same time, the action may

at times install different versions of ffmpeg for different operating systems,

unless a specific version is requested.

## Usage

See [`action.yml`](./action.yml).

```yml

steps:

  - uses: actions/checkout@v3

  - uses: FedericoCarboni/setup-ffmpeg@v3

    id: setup-ffmpeg

    with:

      # A specific version to download, may also be "release" or a specific version

      # like "6.1.0". At the moment semver specifiers (i.e. >=6.1.0) are supported

      # only on Windows, on other platforms they are allowed but version is matched

      # exactly regardless.

      ffmpeg-version: release

      # Target architecture of the ffmpeg executable to install. Defaults to the

      # system architecture. Only x64 and arm64 are supported (arm64 only on Linux).

      architecture: ''

      # Linking type of the binaries. Use "shared" to download shared binaries and 

      # "static" for statically linked ones. Shared builds are currently only available

      # for windows releases. Defaults to "static"

      linking-type: static

      # As of version 3 of this action, builds are no longer downloaded from GitHub

      # except on Windows: https://github.com/GyanD/codexffmpeg/releases.

      github-token: ${{ github.server_url == 'https://github.com' && github.token || '' }}

  - run: ffmpeg -i input.avi output.mkv

```

### Outputs

- `ffmpeg-version`: Installed version of FFmpeg.

- `ffmpeg-path`: Path to the install directory containing `ffmpeg` and `ffprobe`

binaries.

- `cache-hit`: A boolean value indicating whether the tool cache was hit.