Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

ffmpeg_kit_flutter (EasyJoy self-hosted)

Self-hosted FFmpeg-Kit for Flutter. Runs FFmpeg & FFprobe on Android, iOS, macOS and Windows from a single Dart API.

  • Based on ffmpeg_kit_flutter_new (maintained fork of the retired arthenica/ffmpeg-kit).
  • All native binaries are bundled inside this repository — no runtime/build-time network downloads, no dependency on third-party release assets staying online.
  • Variant: nicenote (FFmpeg 8.1.2, LGPL v3.0) — the min line (no external libraries, no GPL components) trimmed to the audio components NiceNote uses, built from source in this repo (ffmpeg-build/); safe for closed-source store distribution.

Why self-hosted?

The original FFmpegKit was retired in Jan 2025 and its binaries were deleted in Apr 2025, breaking every project that depended on them. This repo vendors both the plugin code and the native binaries so our apps never break from upstream deletions.

Platforms

Platform Min version Architectures
Android API 24 arm64-v8a, armeabi-v7a (NEON)
iOS 14.0 arm64 (device), arm64 + x86_64 (simulator)
macOS 10.15 arm64, x86_64
Windows 10+ (x86_64) x86_64

Enabled components

No external libraries. The single component list in ffmpeg-build/components.sh (all four platforms): every FFmpeg audio decoder (211), all demuxers except reference/playlist ones, all parsers, aac/alac/flac/pcm encoders and the m4a/wav/aiff/caf/flac/raw-PCM muxers, local file protocols only. No video/image/subtitle codecs — sufficient for probing/decoding audio inputs (including the audio track of video containers) and transcoding to m4a(AAC)/wav/pcm. Details: ffmpeg-build/README.md.

MP3 encoding is intentionally out of scope here: consumers that need it encode MP3 in Dart (e.g. a lame Dart binding), so the heavy lame/shine/twolame/opencore-amr/opus/speex/soxr/vorbis/ilbc/vo-amrwbenc external encoders bundled by the audio variant are not needed.

No video encoders, no x264/x265 (GPL), no network protocols beyond file I/O.

Migrated from the audio variant to min (2026-07) to cut binary size — the extra audio external encoders were unused.

Usage

dependencies:
  ffmpeg_kit_flutter:
    git:
      url: [email protected]:EasyJoy-Technologies/ffmpeg-kit-flutter.git
      ref: main
import 'package:ffmpeg_kit_flutter/ffmpeg_kit.dart';
import 'package:ffmpeg_kit_flutter/return_code.dart';

final session = await FFmpegKit.execute('-i input.mp3 -ar 44100 output.m4a');
if (ReturnCode.isSuccess(await session.getReturnCode())) {
  // done
}

The Dart API is identical to the original ffmpeg_kit_flutter (and ffmpeg_kit_flutter_new) — migrating only requires changing the dependency and import package name.

Binary layout (self-hosted)

Platform Location in repo Consumed by
Android android/libs/maven/com/easyjoy/nicenote/ffmpeg-kit-nicenote/8.1.2-1/ (built by ffmpeg-build/build_android.sh) Gradle local maven repo
iOS ios/Frameworks/*.xcframework (built by ffmpeg-build/build_apple.sh) podspec vendored_frameworks
macOS macos/Frameworks/*.framework (built by ffmpeg-build/build_apple.sh, ad-hoc signed) podspec vendored_frameworks; scripts/sign_macos_frameworks.sh re-signs (prepare_command)
Windows windows/dist/ffmpeg-kit-windows-x86_64-nicenote-8.1.2.zip (built by ffmpeg-build/build_windows.sh) windows/CMakeLists.txt

All four platforms are built from source in this repo with NiceNote's audio-only component list — see ffmpeg-build/README.md (scripts, pinned commits, checks, build record). The ffmpeg-kit-min-2.2.1.aar kept under android/libs/maven/com/antonkarpenko/ is the source of the unchanged Java layer and the rollback reference; it is not a dependency any more.

Up to 1.1.0 the binaries were the sk3llo/ffmpeg_kit_flutter release 8.1.2-min and Maven Central com.antonkarpenko:ffmpeg-kit-min:2.2.1 (tag v1.1.0, the rollback point).

macOS note: the committed macos/Frameworks/ are ad-hoc signed when they are built. The podspec prepare_command re-signs them idempotently via scripts/sign_macos_frameworks.sh (you can also run it manually); without a signature the consuming macOS app's CodeSign step fails with "code object is not signed at all".

License

  • Plugin code: LGPL v3.0 (see LICENSE)
  • Bundled FFmpeg binaries: LGPL v3.0 (audio variant — contains no GPL components)
  • Apps using this library must include an FFmpeg/LGPL attribution notice.

Versioning

Same scheme as NiceNote:

  • Every code change bumps the patch by 1 via tool/bump_version.sh; the first two digits change only on explicit human instruction (--line X.Y). Doc-only changes (*.md, docs/) keep the version. Up to 1.2.0 releases bumped the minor version.
  • The version hooks do this automatically (enable once per clone: tool/version/install_hooks.sh, which sets core.hooksPath .githooks and push.followTags true):
    • pre-commit bumps the patch of every series whose code is staged and stages the pubspecs (files outside every series bump the first series in tool/version/series.conf; an amend is not bumped twice);
    • prepare-commit-msg adds the new tag to the subject line;
    • post-commit creates the annotated tag, and git push carries it;
    • commit-msg is the final gate (rejects a missing, skipped or out-of-sync bump). Keep every version unchanged only on explicit human instruction: KEEP_VERSION=1 git commit. Self-tests: tool/version/test_check_version_commit.sh, tool/version/test_hooks.sh.
  • Every bump adds a CHANGELOG.md entry; consumers reference tags only.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages