ffmpeg-cli-wrapper

FFmpeg CLI Wrapper for Java

by Andrew Brampton (bramp.net) (c) 2013-2024 A fluent interface for running FFmpeg from Java.

GitHub | API docs | Examples

Install

We currently support Java 11 and above. Use Maven to install the dependency.

<dependency>
  <groupId>net.bramp.ffmpeg</groupId>
  <artifactId>ffmpeg</artifactId>
  <version>0.9.1</version>
</dependency>

Compatibility

• Java: 11 and above (tested on JDK 11, 17, and 21).
• FFmpeg: Any reasonably modern version of FFmpeg should work (5.x, 6.x, 7.x, etc.). The library generates command-line arguments, so compatibility depends on which FFmpeg features you use.
• OS: Pure Java — runs anywhere Java and FFmpeg are available (Linux, macOS, Windows).

Usage

Video Encoding

Code:

…

Get Media Information

Code:

FFprobe ffprobe = new FFprobe("/path/to/ffprobe");
FFmpegProbeResult probeResult = ffprobe.probe("input.mp4");

FFmpegFormat format = probeResult.getFormat();
System.out.format(
    "%nFile: '%s' ; Format: '%s' ; Duration: %.3fs",
    format.filename, format.format_long_name, format.duration);

FFmpegStream stream = probeResult.getStreams().get(0);
System.out.format(
    "%nCodec: '%s' ; Width: %dpx ; Height: %dpx",
    stream.codec_long_name, stream.width, stream.height);

Get progress while encoding

…

Building & Releasing

If you wish to make changes, then building and testing is simple:

# To build
mvn compile

# To test
mvn test

# To test across all supported JDKs (11, 17, 21)
make test

Releasing

Releasing is automated via GitHub Actions. To trigger a release to Maven Central:

1. Update the version in pom.xml (remove -SNAPSHOT).
2. Commit and push the change.
3. Create and push a tag:

git tag ffmpeg-0.9.1
git push origin ffmpeg-0.9.1

The GitHub Action will:

1. Run the full test matrix across all supported JDKs.
2. If successful, sign and publish the artifacts to the Sonatype Central Portal.
3. Create a GitHub Release with automatically generated release notes.

Bumpings Deps

# Update Maven Plugins
mvn versions:display-plugin-updates

# Library Dependencies
mvn versions:display-dependency-updates

Install FFmpeg on Ubuntu

We only the support the original FFmpeg, not the libav version. Before Ubuntu 12.04, and in 15.04 and later the original FFmpeg is shipped. If you have to run on a version with libav, you can install FFmpeg from a PPA, or using the static build. More information here

Get involved

We welcome contributions. Please check the issue tracker. If you see something you wish to work on, please either comment on the issue, or just send a pull request. Want to work on something else, then just open a issue, and we can discuss! We appreciate documentation improvements, code cleanup, or new features. Please be mindful that all work is done on a volunteer basis, thus we can be slow to reply.

Licence (Simplified BSD License)

…