Latest 2.1.1
Homepage https://github.com/tanersener/mobile-ffmpeg
License LGPL-3.0
Platforms ios 8.0, requires ARC
Authors

MobileFFmpeg Join the chat at https://gitter.im/mobile-ffmpeg/Lobby GitHub release Bintray CocoaPods

FFmpeg for Android and IOS

mobile-ffmpeg-audio

1. Features

  • Use prebuilt binaries available under Github/JCenter/CocoaPods or build your own version with external libraries you need
  • Supports

    • Both Android and IOS
    • FFmpeg v3.4.x and v4.0.x releases
    • 24 external libraries

      chromaprint, fontconfig, freetype, fribidi, gmp, gnutls, kvazaar, lame, libaom, libass, libiconv, libilbc, libtheora, libvorbis, libvpx, libwebp, libxml2, opencore-amr, opus, shine, snappy, soxr, speex, wavpack

    • 4 external libraries with GPL license

      vid.stab, x264, x265, xvidcore

  • Exposes FFmpeg capabilities both directly from FFmpeg libraries and through MobileFFmpeg wrapper library
  • Creates shared libraries (.so for Android, .dylib for IOS)
  • Includes cross-compile instructions for 38 open-source libraries

    chromaprint, expat, ffmpeg, fontconfig, freetype, fribidi, giflib, gmp, gnutls, kvazaar, lame, libaom, libass, libiconv, libilbc, libjpeg, libjpeg-turbo, libogg, libpng, libtheora, libuuid, libvorbis, libvpx, libwebp, libxml2, nettle, opencore-amr, opus, shine, snappy, soxr, speex, tiff, vid.stab, wavpack, x264, x265, xvidcore

  • Licensed under LGPL 3.0, can be customized to support GPL v3.0

    1.1 Android

  • Supports arm-v7a, arm-v7a-neon, arm64-v8a, x86 and x86_64 architectures
  • Creates Android archive with .aar extension

    1.2 IOS

  • Supports armv7, armv7s, arm64, i386 and x86_64 architectures
  • ARC enabled library
  • Built with -fembed-bitcode flag
  • Creates IOS dynamic universal (fat) library
  • Creates IOS dynamic framework for IOS 8 or later

2. Using

Prebuilt libraries are available under Github, JCenter and CocoaPods

There are eight different prebuilt packages. Below you can see which external libraries are enabled in each of them.

min min-gpl https https-gpl audio video full full-gpl
vid.stab3
x2641
x2653
xvidcore1
gnutls gnutls
vid.stab3
x2641
x2653
xvidcore1
chromaprint3
lame
libilbc1
libvorbis
opencore-amr
opus1
shine
soxr2
speex
wavpack
fontconfig
freetype
fribidi
kvazaar
libaom2
libass
libiconv
libtheora
libvpx
snappy1
chromaprint3
fontconfig
freetype
fribidi
gmp
gnutls
kvazaar
lame
libaom2
libass
libiconv
libilbc1
libtheora
libvorbis
libvpx
libwebp
libxml2
opencore-amr
opus1
shine
snappy1
soxr2
speex
wavpack
chromaprint3
fontconfig
freetype
fribidi
gmp
gnutls
kvazaar
lame
libaom2
libass
libiconv
libilbc1
libtheora
libvorbis
libvpx
libwebp
libxml2
opencore-amr
opus1
shine
snappy1
soxr2
speex
vid.stab3
wavpack
x2641
x2653
xvidcore1

1 – Supported since v1.1

2 – Supported since v2.0

3 – Supported since v2.1

2.1 Android

  1. Add MobileFFmpeg dependency from jcenter()

    dependencies {`
        implementation 'com.arthenica:mobile-ffmpeg-full:2.1'
    }
  2. Execute commands.

    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.", rc));
    }
  3. Stop an ongoing operation.

    FFmpeg.cancel();
  4. Enable log callback.

    Config.enableLogCallback(new LogCallback() {
        public void apply(LogMessage message) {
            Log.d(Config.TAG, message.getText());
        }
    });
  5. 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()));
        }
    });
  6. Set log level.

    Config.setLogLevel(Level.AV_LOG_FATAL);
  7. Register custom fonts directory.
    Config.setFontDirectory(this, "fonts", Collections.EMPTY_MAP);

2.2 IOS

  1. Add MobileFFmpeg pod to your Podfile

    pod 'mobile-ffmpeg-full', '~> 2.1.1'
  2. Create and execute commands.

    #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.n", rc);
    }
  3. Stop an ongoing operation.

    [MobileFFmpeg cancel];
  4. Enable log callback.

    - (void)logCallback: (int)level :(NSString*)message {
        dispatch_async(dispatch_get_main_queue(), ^{
            NSLog(@"%@", message);
        });
    }
    ...
    [MobileFFmpegConfig setLogDelegate:self];
  5. Enable statistics callback.

    - (void)statisticsCallback:(Statistics *)newStatistics {
        dispatch_async(dispatch_get_main_queue(), ^{
            NSLog(@"frame: %d, time: %dn", newStatistics.getVideoFrameNumber, newStatistics.getTime);
        });
    }
    ...
    [MobileFFmpegConfig setStatisticsDelegate:self];
  6. Set log level.

    [MobileFFmpegConfig setLogLevel:AV_LOG_FATAL];
  7. Register custom fonts directory.
    [MobileFFmpegConfig setFontDirectory:@"fonts" with:nil];

2.3 Test Application

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 and an IOS test application under the ios/test-app folder. Both applications are identical and supports command execution, video encoding, accessing https, encoding audio, burning subtitles and video stabilization.

mobile-ffmpeg-audio

3. Versions

  • MobileFFmpeg v1.x is the previous stable, includes FFmpeg v3.4.4

  • MobileFFmpeg v2.x is the current stable, includes FFmpeg v4.0.2

4. Building

4.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

    Some of these packages are not mandatory for the default build.
    Please visit Android Prerequisites and
    IOS Prerequisites for the details.

  2. Android builds require these additional packages.

    • Android SDK 5.0 Lollipop (API Level 21) or later
    • Android NDK r16b or later with LLDB and CMake
    • gradle 4.4 or later
  3. IOS builds need these extra packages and tools.
    • IOS SDK 7.0.x or later
    • Xcode 8.x or later
    • Command Line Tools

4.2 Build Scripts

Use android.sh and ios.sh to build MobileFFmpeg for each platform.
After a successful build, compiled FFmpeg and MobileFFmpeg libraries can be found under prebuilt directory.

Both android.sh and ios.sh can be customized to override default settings,
android.sh and
ios.sh wiki pages include all available build options.

4.2.1 Android
export ANDROID_NDK_ROOT=<Android NDK Path>
./android.sh

mobile-ffmpeg-audio

4.2.2 IOS
./ios.sh    

mobile-ffmpeg-audio

4.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.

4.4 External Libraries

build directory includes build scripts for external libraries. There are two scripts for each library, one for Android
and one for IOS. They include all options/flags used to cross-compile the libraries. ASM is enabled by most of them,
exceptions are listed under the ASM Support page.

5. Documentation

A more detailed documentation is available at Wiki.

6. 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.

strip-frameworks.sh script included and distributed is published under the Apache License version 2.0.

In test applications, fonts embedded are licensed under the SIL Open Font License; other digital assets are published in the public domain.

Please visit License page for the details.

7. Contributing

If you have any recommendations or ideas to improve it, please feel free to submit issues or pull requests. Any help is appreciated.

8. See Also

Latest podspec

{
    "name": "mobile-ffmpeg-audio",
    "version": "2.1.1",
    "summary": "Mobile FFmpeg Audio Dynamic Framework",
    "description": "Includes FFmpeg v4.0.2 with chromaprint v1.4.3, lame v3.100, libilbc v2.0.2, libvorbis v1.3.6, opencore-amr v0.1.5, opus v1.2.1, shine v3.1.1, soxr v0.1.3, speex v1.2.0 and wavpack v5.1.0 libraries enabled.",
    "homepage": "https://github.com/tanersener/mobile-ffmpeg",
    "authors": {
        "Taner Sener": "[email protected]"
    },
    "license": {
        "type": "LGPL-3.0",
        "file": "mobileffmpeg.framework/LICENSE"
    },
    "platforms": {
        "ios": "8.0"
    },
    "requires_arc": true,
    "ios": {
        "frameworks": [
            "Foundation",
            "AudioToolbox",
            "CoreImage"
        ],
        "libraries": [
            "z",
            "bz2"
        ],
        "vendored_frameworks": [
            "mobileffmpeg.framework",
            "libavcodec.framework",
            "libavdevice.framework",
            "libavfilter.framework",
            "libavformat.framework",
            "libavutil.framework",
            "libswresample.framework",
            "libswscale.framework"
        ]
    },
    "source": {
        "http": "https://github.com/tanersener/mobile-ffmpeg/releases/download/v2.1.1/mobile-ffmpeg-audio-2.1.1-ios-framework.zip"
    }
}

Pin It on Pinterest

Share This