flutter_image_compress 0.6.3

flutter_image_compress #

ImageCompress pub package GitHub GitHub stars Awesome

Compresses image as native plugin (Obj-C/Kotlin)

This library can works on Android and iOS.

Why don't you use dart to do it #

Q:Dart already has image compression libraries. Why use native?

A:For unknown reasons, image compression in Dart language is not efficient, even in release version. Using isolate does not solve the problem.

Usage #

  flutter_image_compress: ^0.6.3
import 'package:flutter_image_compress/flutter_image_compress.dart';

Use as:

See full example

There are several ways to use the library api.

  // 1. compress file and get a List<int>
  Future<List<int>> testCompressFile(File file) async {
    var result = await FlutterImageCompress.compressWithFile(
      minWidth: 2300,
      minHeight: 1500,
      quality: 94,
      rotate: 90,
    return result;

  // 2. compress file and get file.
  Future<File> testCompressAndGetFile(File file, String targetPath) async {
    var result = await FlutterImageCompress.compressAndGetFile(
        file.absolute.path, targetPath,
        quality: 88,
        rotate: 180,


    return result;

  // 3. compress asset and get List<int>.
  Future<List<int>> testCompressAsset(String assetName) async {
    var list = await FlutterImageCompress.compressAssetImage(
      minHeight: 1920,
      minWidth: 1080,
      quality: 96,
      rotate: 180,

    return list;

  // 4. compress List<int> and get another List<int>.
  Future<List<int>> testComporessList(List<int> list) async {
    var result = await FlutterImageCompress.compressWithList(
      minHeight: 1920,
      minWidth: 1080,
      quality: 96,
      rotate: 135,
    return result;

About common params #

minWidth and minHeight #

minWidth and minHeight are constraints on image scaling.

For example, a 4000*2000 image, minWidth set to 1920, minHeight set to 1080, the calculation is as follows:

// Using dart as an example, the actual implementation is Kotlin or OC.
import 'dart:math' as math;

void main() {
  var scale = calcScale(
    srcWidth: 4000,
    srcHeight: 2000,
    minWidth: 1920,
    minHeight: 1080,

  print("scale = $scale"); // scale = 1.8518518518518519
  print("target width = ${4000 / scale}, height = ${2000 / scale}"); // target width = 2160.0, height = 1080.0

double calcScale({
  double srcWidth,
  double srcHeight,
  double minWidth,
  double minHeight,
}) {
  var scaleW = srcWidth / minWidth;
  var scaleH = srcHeight / minHeight;

  var scale = math.max(1.0, math.min(scaleW, scaleH));

  return scale;

If your image width is smaller than minWidth or height samller than minHeight, scale will be 1, that is, the size will not change.

rotate #

If you need to rotate the picture, use this parameter.

autoCorrectionAngle #

This property only exists in the version after 0.5.0.

And for historical reasons, there may be conflicts with rotate attributes, which need to be self-corrected.

Modify rotate to 0 or autoCorrectionAngle to false.

quality #

Quality of target image.

If format is png, the param will be ignored in iOS.

format #

Supports jpeg or png, default is jpeg.

keepExif #

If this parameter is true, EXIF information is saved in the compressed result.

Attention should be paid to the following points:

  1. Default value is false.
  2. Even if set to true, the direction attribute is not included.
  3. Only support jpg format, PNG format does not support.

Result #

The result of returning a List collection will not have null, but will always be an empty array.

The returned file may be null. In addition, please decide for yourself whether the file exists.

About List<int> and Uint8List

You may need to convert List<int> to Uint8List to display images.

To use Uint8List, you need import package to your code like this:


final image = Uint8List.fromList(imageList)
ImageProvider provider = MemoryImage(Uint8List.fromList(imageList));

Usage in Image Widget:

List<int> image = await testCompressFile(file);
ImageProvider provider = MemoryImage(Uint8List.fromList(image));

  image: provider ?? AssetImage("img/img.jpg"),

Write to file usage:

void writeToFile(List<int> image, String filePath) {
  final file = File(filePath);
  file.writeAsBytes(image, flush: true, mode: FileMode.write);

Android #

You may need to update Kotlin to version 1.2.71(Recommend 1.3.21) or higher.

iOS #

No problems currently found.

Troubleshooting or common error #

Compressing returns null

Sometimes, compressing will return null. You should check if you can read/write the file, and the parent folder of the target file must exist.

For example, use the path_provider plugin to access some application folders, and use a permission plugin to request permission to access SD cards on Android/iOS.

Android build error #

Caused by: org.gradle.internal.event.ListenerNotificationException: Failed to notify project evaluation listener.
        at org.gradle.internal.event.AbstractBroadcastDispatch.dispatch(AbstractBroadcastDispatch.java:86)
Caused by: java.lang.AbstractMethodError
        at org.jetbrains.kotlin.gradle.plugin.KotlinPluginKt.resolveSubpluginArtifacts(KotlinPlugin.kt:776)

See flutter/flutter/issues#21473

You need to upgrade your Kotlin version to 1.2.71+(recommended 1.3.31).

If Flutter supports more platforms (Windows, Mac, Linux, etc) in the future and you use this library, propose an issue or PR!

About EXIF information #

Using this library, EXIF information will be removed by default.

EXIF information can be retained by setting keepExif to true, but not direction information.

About Exif handle code #

The iOS code was copied from dvkch/SYPictureMetadata, LICENSE

The android code was copied from flutter/plugin/image_picker and edit some. (BSD 3 style)


0.6.3 #


  • Android: When the register of the calling plugin is not in the main process or there is no Activity.

0.6.2 #


  • Reduce the speed required for ios to add dependencies by copying the SYPictureMetadata source code into the project.

0.6.1 #


  • autoCorrectionAngle switches image width and height.

New feature:

  • Keep exif (no have orientation), use keepExif

0.6.0 #


  • remove method getImageInfo.

For the time being, the follow-dev branch is no longer used, but only the master branch is needed to unify the pub version number.

New Feature:

  • It is now supported to set the compression target to png format.

0.5.2 #


  • #49: A problem of reading Exif information.

0.5.1 #

Change reportError with flutter stable version.

Breaking Change: The autoCorrectionAngle parameter causes a number of situations to behave differently than 0.4.0. See readme for details.

0.5.0 #

(don't use)

Breaking Change: Because FlutterError.reportError method's param context type changed. So this library will add the constraints of flutter SDK so that users before 1.5.9 will not use version 0.5.0 incorrectly.

0.4.0 #

Some code has been added to ensure that parameters that do not pass in native do not trigger crash.

0.3.1 #


  • Android close file output stream.

0.3.0 #


  • optimize compress scale.

0.2.4 #

Updated Kotlin version

Breaking change. Migrate from the deprecated original Android Support Library to AndroidX. This shouldn't result in any functional changes, but it requires any Android apps using this plugin to also migrate if they're using the original support library.

0.2.3 #

change iOS return type

0.2.2 #

add some dart doc

0.2.1 #

update readme

0.2.0 #

The version number is updated so that people who can use the higher version of gradle can use it. see pr #8

if android run error, you must update your kotlin'version to 1.2.71+

0.1.4 #

add optional params rotate

fix bug

update example

0.1.3 #

fix the ios flutter.h bug

0.1.1 #

update readme

0.1.0 #

first version


flutter_image_compress_example #

Demonstrates how to use the flutter_image_compress plugin.

Getting Started #

For help getting started with Flutter, view our online documentation.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  flutter_image_compress: ^0.6.3

2. Install it

You can install packages from the command line:

with Flutter:

$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:flutter_image_compress/flutter_image_compress.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Sep 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.0
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.2


Detected platforms: Flutter

References Flutter, and has no conflicting libraries.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.28.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8