mobile-ffmpeg

FFmpeg for Android, iOS and tvOS

View the Project on GitHub tanersener/mobile-ffmpeg

FFmpeg for Android, iOS and tvOS

1. Features

2. Using

Binaries are available at Github, JCenter and CocoaPods.

There are eight different prebuilt packages. Below you can see which 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
- vid.stab
x264
x265
xvidcore
gmp
gnutls
gmp
gnutls
vid.stab
x264
x265
xvidcore
lame
libilbc
libvorbis
opencore-amr
opus
shine
soxr
speex
twolame
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
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
wavpack
x264
x265
xvidcore

2.1 Android

  1. Add MobileFFmpeg dependency to your build.gradle in mobile-ffmpeg-<package name> format
     dependencies {
         implementation 'com.arthenica:mobile-ffmpeg-full:4.3.1'
     }
    
  2. Execute 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);
     }
    
  3. 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);
     }
    
  4. 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);
     }
    
  5. Stop an ongoing FFmpeg operation.
     FFmpeg.cancel();
    
  6. Get media information for a file.
     MediaInformation info = FFprobe.getMediaInformation("<file path or uri>");
    
  7. 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>");
    
  8. List enabled external libraries.
     List<String> externalLibraries = Config.getExternalLibraries();
    
  9. Enable log callback.
     Config.enableLogCallback(new LogCallback() {
         public void apply(LogMessage message) {
             Log.d(Config.TAG, message.getText());
         }
     });
    
  10. 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()));
        }
    });
    
  11. Set log level.
    Config.setLogLevel(Level.AV_LOG_FATAL);
    
  12. Register custom fonts directory.
    Config.setFontDirectory(this, "<folder with fonts>", Collections.EMPTY_MAP);
    

2.2 iOS / tvOS

  1. Add MobileFFmpeg dependency to your Podfile in mobile-ffmpeg-<package name> format

    • iOS
       pod 'mobile-ffmpeg-full', '~> 4.3.1'
      
    • tvOS
       pod 'mobile-ffmpeg-tvos-full', '~> 4.3.1'
      
  2. Execute 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]);
     }
    
  3. 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]);
     }
    
  4. 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);
     }
    
  5. Stop an ongoing FFmpeg operation.
     [MobileFFmpeg cancel];
    
  6. Get media information for a file.
     MediaInformation *mediaInformation = [MobileFFprobe getMediaInformation:@"<file path or uri>"];
    
  7. Record video and audio using iOS camera. This operation is not supported on tvOS since AVFoundation is not available on tvOS.

     [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];
    
  8. List enabled external libraries.
     NSArray *externalLibraries = [MobileFFmpegConfig getExternalLibraries];
    
  9. Enable log callback.
     [MobileFFmpegConfig setLogDelegate:self];
    
     - (void)logCallback: (int)level :(NSString*)message {
         dispatch_async(dispatch_get_main_queue(), ^{
             NSLog(@"%@", message);
         });
     }
    
  10. 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);
        });
    }
    
  11. Set log level.
    [MobileFFmpegConfig setLogLevel:AV_LOG_FATAL];
    
  12. Register custom fonts directory.
    [MobileFFmpegConfig setFontDirectory:@"<folder with fonts>" with:nil];
    

3. Versions

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.

MobileFFmpeg Version FFmpeg Version Release Date
4.3.1 4.3-dev-1944 Jan 13, 2020
4.3.1.LTS 4.3-dev-1944 Jan 13, 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

4. LTS Releases

Starting from v4.2, MobileFFmpeg binaries are published in two different variants: Main Release and LTS Release.

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 Architectures arm64
arm64e
x86-64
armv7
arm64
i386
x86-64
tvOS SDK 10.2 9.2
tvOS Architectures arm64
x86-64
arm64
x86-64

5. Building

5.1 Prerequisites

  1. 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
    
  2. Android builds require these additional packages.
    • Android SDK 4.1 Jelly Bean (API Level 16) or later
    • Android NDK r20 or later with LLDB and CMake
  3. iOS builds need these extra packages and tools.
    • Xcode 7.3.1 or later
    • iOS SDK 9.3 or later
    • Command Line Tools
  4. tvOS builds need these extra packages and tools.
    • Xcode 7.3.1 or later
    • tvOS SDK 9.2 or later
    • Command Line Tools

5.2 Build Scripts

Use android.sh, ios.sh and tvos.sh to build MobileFFmpeg for each platform.

After a successful build, compiled FFmpeg and MobileFFmpeg libraries can be found under prebuilt directory.

5.2.1 Android
export ANDROID_HOME=<Android SDK Path>
export ANDROID_NDK_ROOT=<Android NDK Path>
./android.sh

5.2.2 iOS
./ios.sh

5.2.3 tvOS
./tvos.sh

5.3 GPL Support

It is possible to enable GPL licensed libraries x264, xvidcore since v1.1 and vid.stab, x265 since v2.1 from the top level build scripts. Their source code is not included in the repository and downloaded when enabled.

5.4 External Libraries

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.

6. Documentation

A more detailed documentation is available at Wiki.

7. License

This project is licensed under the LGPL v3.0. However, if source code is built using optional --enable-gpl flag or prebuilt binaries with -gpl postfix are used then MobileFFmpeg is subject to the GPL v3.0 license.

Source code of FFmpeg and external libraries is included 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.

8. See Also