FFmpeg for Android, iOS and tvOS.
Not maintained anymore as explained in What’s next for MobileFFmpeg?. Superseded by FFmpegKit.
-
Includes both
FFmpegandFFprobe -
Use binaries available at
Github/Maven Central/CocoaPodsor build your own version with external libraries you need -
Supports
-
Android, iOS and tvOS
-
FFmpeg
v3.4.x,v4.0.x,v4.1,v4.2,v4.3andv4.4-devreleases -
29 external libraries
chromaprint,fontconfig,freetype,fribidi,gmp,gnutls,kvazaar,lame,libaom,libass,libiconv,libilbc,libtheora,libvorbis,libvpx,libwebp,libxml2,opencore-amr,openh264,opus,sdl,shine,snappy,soxr,speex,tesseract,twolame,vo-amrwbenc,wavpack -
5 external libraries with GPL license
rubberband,vid.stab,x264,x265,xvidcore -
Concurrent execution
-
-
Exposes both FFmpeg library and MobileFFmpeg wrapper library capabilities
-
Includes cross-compile instructions for 47 open-source libraries
chromaprint,expat,ffmpeg,fontconfig,freetype,fribidi,giflib,gmp,gnutls,kvazaar,lame,leptonica,libaom,libass,libiconv,libilbc,libjpeg,libjpeg-turbo,libogg,libpng,libsamplerate,libsndfile,libtheora,libuuid,libvorbis,libvpx,libwebp,libxml2,nettle,opencore-amr,openh264,opus,rubberband,sdl,shine,snappy,soxr,speex,tesseract,tiff,twolame,vid.stab,vo-amrwbenc,wavpack,x264,x265,xvidcore -
Licensed under LGPL 3.0, can be customized to support GPL v3.0
- Builds
arm-v7a,arm-v7a-neon,arm64-v8a,x86andx86_64architectures - Supports
zlibandMediaCodecsystem libraries - Camera access on supported devices
- Builds shared native libraries (.so)
- Creates Android archive with .aar extension
- Supports
API Level 16+
- Builds
armv7,armv7s,arm64,arm64e,i386,x86_64andx86_64(Mac Catalyst) architectures - Supports
bzip2,iconv,libuuid,zlibsystem libraries andAudioToolbox,VideoToolbox,AVFoundationsystem frameworks - Objective-C API
- Camera access
ARCenabled library- Built with
-fembed-bitcodeflag - Creates static frameworks, static xcframeworks and static universal (fat) libraries (.a)
- Supports
iOS SDK 9.3or later
- Builds
arm64andx86_64architectures - Supports
bzip2,iconv,libuuid,zlibsystem libraries andAudioToolbox,VideoToolboxsystem frameworks - Objective-C API
ARCenabled library- Built with
-fembed-bitcodeflag - Creates static frameworks and static universal (fat) libraries (.a)
- Supports
tvOS SDK 9.2or later
Prebuilt binaries are available at Github, Maven Central and CocoaPods.
There are eight different mobile-ffmpeg packages. Below you can see which system libraries and external libraries are enabled in each of them.
Please remember that some parts of FFmpeg are licensed under the GPL and only GPL licensed mobile-ffmpeg packages include them.
| min | min-gpl | https | https-gpl | audio | video | full | full-gpl | |
|---|---|---|---|---|---|---|---|---|
| external libraries | - | vid.stab x264 x265 xvidcore |
gmp gnutls |
gmp gnutls vid.stab x264 x265 xvidcore |
lame libilbc libvorbis opencore-amr opus shine soxr speex twolame vo-amrwbenc wavpack |
fontconfig freetype fribidi kvazaar libaom libass libiconv libtheora libvpx libwebp snappy |
fontconfig freetype fribidi gmp gnutls kvazaar lame libaom libass libiconv libilbc libtheora libvorbis libvpx libwebp libxml2 opencore-amr opus shine snappy soxr speex twolame vo-amrwbenc wavpack |
fontconfig freetype fribidi gmp gnutls kvazaar lame libaom libass libiconv libilbc libtheora libvorbis libvpx libwebp libxml2 opencore-amr opus shine snappy soxr speex twolame vid.stab vo-amrwbenc wavpack x264 x265 xvidcore |
| android system libraries | zlib MediaCodec |
|||||||
| ios system libraries | zlib AudioToolbox AVFoundation iconv VideoToolbox bzip2 |
|||||||
| tvos system libraries | zlib AudioToolbox iconv VideoToolbox bzip2 |
|||||||
-
libilbc,opus,snappy,x264andxvidcoreare supported sincev1.1 -
libaomandsoxrare supported sincev2.0 -
chromaprint,vid.stabandx265are supported sincev2.1 -
sdl,tesseract,twolameexternal libraries;zlib,MediaCodecAndroid system libraries;bzip2,zlibiOS system libraries andAudioToolbox,VideoToolbox,AVFoundationiOS system frameworks are supported sincev3.0 -
Since
v4.2,chromaprint,sdlandtesseractlibraries are not included in binary releases. You can still build them and include in your releases -
AVFoundationis not available ontvOS,VideoToolboxis not available ontvOSLTS releases -
Since
v4.3.1,iOSandtvOSreleases started to useiconvsystem library instead oficonvexternal library -
vo-amrwbencis supported sincev4.4
- For versions
4.4and4.4.LTS, addmavenCentral()to yourbuild.gradleand make sure that it is listed beforejcenter() - For
4.3.2and older releases, addjcenter()repositories { mavenCentral() }
-
Add MobileFFmpeg dependency to your
build.gradleinmobile-ffmpeg-<package name>pattern.dependencies { implementation 'com.arthenica:mobile-ffmpeg-full:4.4' } -
Execute synchronous FFmpeg commands.
import com.arthenica.mobileffmpeg.Config; import com.arthenica.mobileffmpeg.FFmpeg; int rc = FFmpeg.execute("-i file1.mp4 -c:v mpeg4 file2.mp4"); if (rc == RETURN_CODE_SUCCESS) { Log.i(Config.TAG, "Command execution completed successfully."); } else if (rc == RETURN_CODE_CANCEL) { Log.i(Config.TAG, "Command execution cancelled by user."); } else { Log.i(Config.TAG, String.format("Command execution failed with rc=%d and the output below.", rc)); Config.printLastCommandOutput(Log.INFO); } -
Execute asynchronous FFmpeg commands.
import com.arthenica.mobileffmpeg.Config; import com.arthenica.mobileffmpeg.FFmpeg; long executionId = FFmpeg.executeAsync("-i file1.mp4 -c:v mpeg4 file2.mp4", new ExecuteCallback() { @Override public void apply(final long executionId, final int returnCode) { if (returnCode == RETURN_CODE_SUCCESS) { Log.i(Config.TAG, "Async command execution completed successfully."); } else if (returnCode == RETURN_CODE_CANCEL) { Log.i(Config.TAG, "Async command execution cancelled by user."); } else { Log.i(Config.TAG, String.format("Async command execution failed with returnCode=%d.", returnCode)); } } }); -
Execute FFprobe commands.
import com.arthenica.mobileffmpeg.Config; import com.arthenica.mobileffmpeg.FFprobe; int rc = FFprobe.execute("-i file1.mp4"); if (rc == RETURN_CODE_SUCCESS) { Log.i(Config.TAG, "Command execution completed successfully."); } else { Log.i(Config.TAG, String.format("Command execution failed with rc=%d and the output below.", rc)); Config.printLastCommandOutput(Log.INFO); } -
Check execution output later.
int rc = Config.getLastReturnCode(); if (rc == RETURN_CODE_SUCCESS) { Log.i(Config.TAG, "Command execution completed successfully."); } else if (rc == RETURN_CODE_CANCEL) { Log.i(Config.TAG, "Command execution cancelled by user."); } else { Log.i(Config.TAG, String.format("Command execution failed with rc=%d and the output below.", rc)); Config.printLastCommandOutput(Log.INFO); } -
Stop ongoing FFmpeg operations.
- Stop all executions
FFmpeg.cancel(); - Stop a specific execution
FFmpeg.cancel(executionId);
- Stop all executions
-
Get media information for a file.
MediaInformation info = FFprobe.getMediaInformation("<file path or uri>"); -
Record video using Android camera.
FFmpeg.execute("-f android_camera -i 0:0 -r 30 -pixel_format bgr0 -t 00:00:05 <record file path>"); -
Enable log callback.
Config.enableLogCallback(new LogCallback() { public void apply(LogMessage message) { Log.d(Config.TAG, message.getText()); } }); -
Enable statistics callback.
Config.enableStatisticsCallback(new StatisticsCallback() { public void apply(Statistics newStatistics) { Log.d(Config.TAG, String.format("frame: %d, time: %d", newStatistics.getVideoFrameNumber(), newStatistics.getTime())); } }); -
Ignore the handling of a signal.
Config.ignoreSignal(Signal.SIGXCPU); -
List ongoing executions.
final List<FFmpegExecution> ffmpegExecutions = FFmpeg.listExecutions(); for (int i = 0; i < ffmpegExecutions.size(); i++) { FFmpegExecution execution = ffmpegExecutions.get(i); Log.d(TAG, String.format("Execution %d = id:%d, startTime:%s, command:%s.", i, execution.getExecutionId(), execution.getStartTime(), execution.getCommand())); } -
Set default log level.
Config.setLogLevel(Level.AV_LOG_FATAL); -
Register custom fonts directory.
Config.setFontDirectory(this, "<folder with fonts>", Collections.EMPTY_MAP);
-
Add MobileFFmpeg dependency to your
Podfileinmobile-ffmpeg-<package name>pattern.- iOS
pod 'mobile-ffmpeg-full', '~> 4.4'- tvOS
pod 'mobile-ffmpeg-tvos-full', '~> 4.4' -
Execute synchronous FFmpeg commands.
#import <mobileffmpeg/MobileFFmpegConfig.h> #import <mobileffmpeg/MobileFFmpeg.h> int rc = [MobileFFmpeg execute: @"-i file1.mp4 -c:v mpeg4 file2.mp4"]; if (rc == RETURN_CODE_SUCCESS) { NSLog(@"Command execution completed successfully.\n"); } else if (rc == RETURN_CODE_CANCEL) { NSLog(@"Command execution cancelled by user.\n"); } else { NSLog(@"Command execution failed with rc=%d and output=%@.\n", rc, [MobileFFmpegConfig getLastCommandOutput]); } -
Execute asynchronous FFmpeg commands.
#import <mobileffmpeg/MobileFFmpegConfig.h> #import <mobileffmpeg/MobileFFmpeg.h> long executionId = [MobileFFmpeg executeAsync:@"-i file1.mp4 -c:v mpeg4 file2.mp4" withCallback:self]; - (void)executeCallback:(long)executionId :(int)returnCode { if (rc == RETURN_CODE_SUCCESS) { NSLog(@"Async command execution completed successfully.\n"); } else if (rc == RETURN_CODE_CANCEL) { NSLog(@"Async command execution cancelled by user.\n"); } else { NSLog(@"Async command execution failed with rc=%d.\n", rc); } } -
Execute FFprobe commands.
#import <mobileffmpeg/MobileFFmpegConfig.h> #import <mobileffmpeg/MobileFFprobe.h> int rc = [MobileFFprobe execute: @"-i file1.mp4"]; if (rc == RETURN_CODE_SUCCESS) { NSLog(@"Command execution completed successfully.\n"); } else if (rc == RETURN_CODE_CANCEL) { NSLog(@"Command execution cancelled by user.\n"); } else { NSLog(@"Command execution failed with rc=%d and output=%@.\n", rc, [MobileFFmpegConfig getLastCommandOutput]); } -
Check execution output later.
int rc = [MobileFFmpegConfig getLastReturnCode]; NSString *output = [MobileFFmpegConfig getLastCommandOutput]; if (rc == RETURN_CODE_SUCCESS) { NSLog(@"Command execution completed successfully.\n"); } else if (rc == RETURN_CODE_CANCEL) { NSLog(@"Command execution cancelled by user.\n"); } else { NSLog(@"Command execution failed with rc=%d and output=%@.\n", rc, output); } -
Stop ongoing FFmpeg operations.
- Stop all executions
[MobileFFmpeg cancel]; - Stop a specific execution
[MobileFFmpeg cancel:executionId];
- Stop all executions
-
Get media information for a file.
MediaInformation *mediaInformation = [MobileFFprobe getMediaInformation:@"<file path or uri>"]; -
Record video and audio using iOS camera. This operation is not supported on
tvOSsinceAVFoundationis not available ontvOS.[MobileFFmpeg execute: @"-f avfoundation -r 30 -video_size 1280x720 -pixel_format bgr0 -i 0:0 -vcodec h264_videotoolbox -vsync 2 -f h264 -t 00:00:05 %@", recordFilePath]; -
Enable log callback.
[MobileFFmpegConfig setLogDelegate:self]; - (void)logCallback:(long)executionId :(int)level :(NSString*)message { dispatch_async(dispatch_get_main_queue(), ^{ NSLog(@"%@", message); }); } -
Enable statistics callback.
[MobileFFmpegConfig setStatisticsDelegate:self]; - (void)statisticsCallback:(Statistics *)newStatistics { dispatch_async(dispatch_get_main_queue(), ^{ NSLog(@"frame: %d, time: %d\n", newStatistics.getVideoFrameNumber, newStatistics.getTime); }); } -
Ignore the handling of a signal.
[MobileFFmpegConfig ignoreSignal:SIGXCPU]; -
List ongoing executions.
NSArray* ffmpegExecutions = [MobileFFmpeg listExecutions]; for (int i = 0; i < [ffmpegExecutions count]; i++) { FFmpegExecution* execution = [ffmpegExecutions objectAtIndex:i]; NSLog(@"Execution %d = id: %ld, startTime: %@, command: %@.\n", i, [execution getExecutionId], [execution getStartTime], [execution getCommand]); } -
Set default log level.
[MobileFFmpegConfig setLogLevel:AV_LOG_FATAL]; -
Register custom fonts directory.
[MobileFFmpegConfig setFontDirectory:@"<folder with fonts>" with:nil];
You can import MobileFFmpeg aar packages in Android Studio using the File -> New -> New Module -> Import .JAR/.AAR Package menu.
iOS and tvOS frameworks can be installed manually using the Importing Frameworks guide. If you want to use universal binaries please refer to Using Universal Binaries guide.
You can see how MobileFFmpeg is used inside an application by running test applications provided.
There is an Android test application under the android/test-app folder, an iOS test application under the
ios/test-app folder and a tvOS test application under the tvos/test-app folder.
All applications are identical and supports command execution, video encoding, accessing https, encoding audio, burning subtitles, video stabilisation, pipe operations and concurrent command execution.
MobileFFmpeg version number is aligned with FFmpeg since version 4.2.
In previous versions, MobileFFmpeg version of a release and FFmpeg version included in that release was different.
The following table lists FFmpeg versions used in MobileFFmpeg releases.
devpart inFFmpegversion number indicates thatFFmpegsource is pulled from theFFmpegmasterbranch. Exact version number is obtained usinggit describe --tags.
| MobileFFmpeg Version | FFmpeg Version | Release Date |
|---|---|---|
| 4.4 | 4.4-dev-416 | Jul 25, 2020 |
| 4.4.LTS | 4.4-dev-416 | Jul 24, 2020 |
| 4.3.2 | 4.3-dev-2955 | Apr 15, 2020 |
| 4.3.1 | 4.3-dev-1944 | Jan 25, 2020 |
| 4.3.1.LTS | 4.3-dev-1944 | Jan 25, 2020 |
| 4.3 | 4.3-dev-1181 | Oct 27, 2019 |
| 4.2.2 | 4.2-dev-1824 | July 3, 2019 |
| 4.2.2.LTS | 4.2-dev-1824 | July 3, 2019 |
| 4.2.1 | 4.2-dev-1156 | Apr 2, 2019 |
| 4.2 | 4.2-dev-480 | Jan 3, 2019 |
| 4.2.LTS | 4.2-dev-480 | Jan 3, 2019 |
| 3.1 | 4.1-10 | Dec 11, 2018 |
| 3.0 | 4.1-dev-1517 | Oct 25, 2018 |
| 2.2 | 4.0.3 | Nov 10, 2018 |
| 2.1.1 | 4.0.2 | Sep 19, 2018 |
| 2.1 | 4.0.2 | Sep 5, 2018 |
| 2.0 | 4.0.1 | Jun 30, 2018 |
| 1.2 | 3.4.4 | Aug 30, 2018 |
| 1.1 | 3.4.2 | Jun 18, 2018 |
| 1.0 | 3.4.2 | Jun 6, 2018 |
Starting from v4.2, MobileFFmpeg binaries are published in two different variants: Main Release and LTS Release.
-
Main releases include complete functionality of the library and support the latest SDK/API features.
-
LTS releases are customized to support a wider range of devices. They are built using older API/SDK versions, so some features are not available on them.
This table shows the differences between two variants.
| Main Release | LTS Release | |
|---|---|---|
| Android API Level | 24 | 16 |
| Android Camera Access | Yes | - |
| Android Architectures | arm-v7a-neon arm64-v8a x86 x86-64 |
arm-v7a arm-v7a-neon arm64-v8a x86 x86-64 |
| Xcode Support | 10.1 | 7.3.1 |
| iOS SDK | 12.1 | 9.3 |
| iOS AVFoundation | Yes | - |
| iOS Architectures | arm64 arm64e1 x86-64 x86-64-mac-catalyst2 |
armv7 arm64 i386 x86-64 |
| tvOS SDK | 10.2 | 9.2 |
| tvOS Architectures | arm64 x86-64 |
arm64 x86-64 |
1 - Included until v4.3.2
2 - Included since v4.3.2
Build scripts from master and development branches are tested periodically. See the latest status from the table below.
| branch | status |
|---|---|
| master |  |
| development |  |
-
Use your package manager (apt, yum, dnf, brew, etc.) to install the following packages.
autoconf automake libtool pkg-config curl cmake gcc gperf texinfo yasm nasm bison autogen patch git
Some of these packages are not mandatory for the default build. Please visit Android Prerequisites, iOS Prerequisites and tvOS Prerequisites for the details.
-
Android builds require these additional packages.
- Android SDK 4.1 Jelly Bean (API Level 16) or later
- Android NDK r21 or later with LLDB and CMake
-
iOS builds need these extra packages and tools.
- Xcode 7.3.1 or later
- iOS SDK 9.3 or later
- Command Line Tools
-
tvOS builds need these extra packages and tools.
- Xcode 7.3.1 or later
- tvOS SDK 9.2 or later
- Command Line Tools
Use android.sh, ios.sh and tvos.sh to build MobileFFmpeg for each platform.
All three scripts support additional options and can be customized to enable/disable specific external libraries and/or architectures. Please refer to wiki pages of android.sh, ios.sh and tvos.sh to see all available build options.
export ANDROID_HOME=<Android SDK Path>
export ANDROID_NDK_ROOT=<Android NDK Path>
./android.sh
./ios.sh
./tvos.sh
Use --lts option to build lts binaries for each platform.
All libraries created by the top level build scripts (android.sh, ios.sh and tvos.sh) can be found under
the prebuilt directory.
Androidarchive (.aar file) is located under theandroid-aarfolderiOSframeworks are located under theios-frameworkfolderiOSxcframeworks are located under theios-xcframeworkfolderiOSuniversal binaries are located under theios-universalfoldertvOSframeworks are located under thetvos-frameworkfoldertvOSuniversal binaries are located under thetvos-universalfolder
It is possible to enable GPL licensed libraries x264, xvidcore since v1.1; vid.stab, x265 since v2.1 and
rubberband since v4.3.2 from the top level build scripts. Their source code is not included in the repository and
downloaded when enabled.
build directory includes build scripts of all external libraries. Two scripts exist for each external library,
one for Android and one for iOS / tvOS. Each of these two scripts contains options/flags used to cross-compile the
library on the specified mobile platform.
CPU optimizations (ASM) are enabled for most of the external libraries. Details and exceptions can be found under the
ASM Support wiki page.
A more detailed documentation is available at Wiki.
This project exists thanks to all the people who contribute. [Contribute].
Become a financial contributor and help us sustain our community. [Contribute]
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
MobileFFmpeg is licensed under the LGPL v3.0. However, if source code is built using the optional --enable-gpl flag
or prebuilt binaries with -gpl postfix are used, then MobileFFmpeg is subject to the GPL v3.0 license.
The source code of all external libraries included is in compliance with their individual licenses.
openh264 source code included in this repository is licensed under the 2-clause BSD License but this license does
not cover the MPEG LA licensing fees. If you build mobile-ffmpeg with openh264 and distribute that library, then
you are subject to pay MPEG LA licensing fees. Refer to OpenH264 FAQ page for
the details. Please note that mobile-ffmpeg does not publish a binary with openh264 inside.
strip-frameworks.sh script included and distributed (until v4.x) is published under the
Apache License version 2.0.
In test applications; embedded fonts are licensed under the SIL Open Font License, other digital assets are published in the public domain.
Please visit License page for the details.
It is not clearly explained in their documentation but it is believed that FFmpeg, kvazaar, x264 and x265
include algorithms which are subject to software patents. If you live in a country where software algorithms are
patentable then you'll probably need to pay royalty fees to patent holders. We are not lawyers though, so we recommend
that you seek legal advice first. See FFmpeg Patent Mini-FAQ.
openh264 clearly states that it uses patented algorithms. Therefore, if you build mobile-ffmpeg with openh264 and
distribute that library, then you are subject to pay MPEG LA licensing fees. Refer to
OpenH264 FAQ page for the details.
Feel free to submit issues or pull requests.
Please note that master branch includes only the latest released source code. Changes planned for the next release
are implemented under the development branch. Therefore, if you want to create a pull request, please open it against
the development.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent