66

In Flutter/Dart, how can I perform the following 3 steps:

  1. Read an image from disk,
  2. Read its original dimensions (width and height),
  3. Resize it.

Note: I must be able to display the final result with a regular Flutter Image widget.

CLARIFICATION: I don't want to save the image, but I do want to actually resize it in memory.

2
  • Are you looking to write the file back, or display it? Commented Apr 6, 2018 at 22:26
  • As written above, I must be able to DISPLAY the final result with a regular Flutter Image widget. I don't want to write the file back. Commented Apr 6, 2018 at 23:35

11 Answers 11

75

You can read image from the disk using the image.file constructor.

For more features you can use the Image library

A Dart library providing the ability to load, save and manipulate images in a variety of different file formats.

Sample from the documentation examples

Load a jpeg, resize it and save it as a png

    import 'dart:io' as Io;
    import 'package:image/image.dart';
    void main() {
      // Read a jpeg image from file.
      Image image = decodeImage(new Io.File('test.jpg').readAsBytesSync());

      // Resize the image to a 120x? thumbnail (maintaining the aspect ratio).
      Image thumbnail = copyResize(image, width: 120);

      // Save the thumbnail as a PNG.
      new Io.File('out/thumbnail-test.png')
            ..writeAsBytesSync(encodePng(thumbnail));
    }
14
  • But then how do I use this Image with the Flutter Image widget? I need to be able to display it. Commented Apr 6, 2018 at 22:52
  • 3
    You really need to be clearer about what you're trying to do; if you just want to display it at a different scale, flutter will do that for you (if you use Image.file). I believe it will even cache the scaled raw image data... Commented Apr 6, 2018 at 23:10
  • 2
    The process is very expensive. Both saving to file and reading from memory take approximately same time. if I have 200 images which I want to display as thumbnails, this resizing takes at least 15 min before I show the thumbs. So ineffective. Commented Sep 13, 2018 at 7:48
  • 1
    @VijayKumarKanta that's not the use case here Commented Sep 13, 2018 at 9:14
  • 1
    The image.dart package does work, but decodeImage is very slow. (see this: github.com/brendan-duncan/image/issues/55)
    – Assaf S.
    Commented Nov 14, 2018 at 12:17
15

To resize an image that is defined in pubspec.yaml use "BoxFit":

@override
Widget build(BuildContext context) {
  return (new Container(
    width: 250.0,
    height: 250.0,
      alignment: Alignment.center,
      decoration: new BoxDecoration(

      image: DecorationImage(
          image: AssetImage('assets/Launcher_Icon.png'),
          fit: BoxFit.fill
      ),
    ),
  ));
}

also reference how to access images: https://flutter.io/assets-and-images/

1
  • 1
    Hey Stephen, I really wanted to resize the image in memory, not simply keep its original size and display it in a BoxFit. I have added a clarification to my question, to make this clear. Thank you. Commented Oct 23, 2018 at 18:59
15

It's not a very good way to resize picture via Image library, since it blocks ui thread, and it brings very bad UX. There is a a maxWidth argument in image_picker lib, you can set it, so these writing files manipulation will be unnecessary in some cases.

1
  • This works only if you want to get the image from the camera or file. But if you get an image, then crop it and then want to resize the result - you can't use it. Commented Nov 1, 2022 at 22:22
14

Use the ResizeImage image provider.

Using a separate package is nice if you want to use many of the functionality, or if you can't do otherwise. But just to depend on something instead of what the framework itself (and its underlying graphics engine) can do easily... :-)

If you have an ImageProvider now, say, to display an image from the bytes in memory:

Image(image: MemoryImage(bytes))

Just wrap it inside a ResizeImage:

Image(image: ResizeImage(MemoryImage(bytes), width: 50, height: 100))

And if you want even more control, just create your own image provider based on the source code of this one.

6
  • would be nice if you provided example on how to use it, because official page just describes but doesn't show the usage.
    – temirbek
    Commented May 29, 2020 at 9:49
  • thank you, and is it possible to get Unit8List of resized image?
    – temirbek
    Commented Jun 2, 2020 at 6:18
  • If you don't need to display it, just to resize the original bytes, then I wouldn't do either of those. Use the relevant functions in dart.ui instead (eg. instantiateImageCodec() and Image.toByteData()). This one is described in other answers here.
    – Gábor
    Commented Jun 3, 2020 at 20:15
  • I tried it with no luck, can you look at it please? stackoverflow.com/questions/62188074/…
    – temirbek
    Commented Jun 4, 2020 at 6:23
  • I think ResizeImage is of flawed design, and should be deprecated from the Flutter library. From one perspective, I can understand ImageProvider provides the image, and ResizeImage resizes that provided image. But from another perspective, un-resized bytes should not be sent to ImageProvider in the first place, and ResizeImage is doing work that should be done by ImageProvider or another class which is independent of ImageProvider. Either way, these perspectives are not aligned, which hints there is a design flaw. Commented Nov 25, 2021 at 6:49
12

Here's an example Thumbnail widget which does this on the flight

It uses Isolate to offload CPU-intensive work to background thread and have UI thread jank-free

import 'dart:io';
import 'dart:isolate';
import 'package:flutter/material.dart';
import 'package:image/image.dart' as IMG;
import 'package:path/path.dart';

class Thumbnail extends StatefulWidget {
  final Size size;
  final File image;

  const Thumbnail({Key key, this.size, this.image}) : super(key: key);
  @override
  _ThumbnailState createState() => _ThumbnailState();
}

class _ThumbnailState extends State<Thumbnail> {
  List<int> imgBytes;
  Isolate isolate;

  @override
  void initState() {
    _asyncInit();

    super.initState();
  }

  static _isolateEntry(dynamic d) async {
    final ReceivePort receivePort = ReceivePort();
    d.send(receivePort.sendPort);

    final config = await receivePort.first;

    print(config);

    final file = File(config['path']);
    final bytes = await file.readAsBytes();

    IMG.Image image = IMG.decodeImage(bytes);
    IMG.Image thumbnail = IMG.copyResize(
      image,
      width: config['size'].width.toInt(),
    );

    d.send(IMG.encodeNamedImage(thumbnail, basename(config['path'])));
  }

  _asyncInit() async {
    final ReceivePort receivePort = ReceivePort();
    isolate = await Isolate.spawn(_isolateEntry, receivePort.sendPort);

    receivePort.listen((dynamic data) {
      if (data is SendPort) {
        if (mounted) {
          data.send({
            'path': widget.image.path,
            'size': widget.size,
          });
        }
      } else {
        if (mounted) {
          setState(() {
            imgBytes = data;
          });
        }
      }
    });
  }

  @override
  void dispose() {
    if (isolate != null) {
      isolate.kill();
    }
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return SizedBox(
      height: widget.size.height,
      width: widget.size.width,
      child: imgBytes != null
          ? Image.memory(
              imgBytes,
              fit: BoxFit.cover,
            )
          : Container(
              decoration: BoxDecoration(
                gradient: LinearGradient(
                  colors: [Colors.grey[100], Colors.grey[300]],
                  begin: Alignment.centerLeft,
                  end: Alignment.centerRight,
                ),
              ),
            ),
    );
  }
}
1
  • 1
    Jank free - I'm using this technical term! Commented May 18, 2020 at 10:02
7

There are many solutions :

Use ResizeImage class

ResizeImage class instructs Flutter to decode the image at the specified dimensions instead of at its native size.

Usage : Just wrap your ImageProvider with ResizeImage class

Example :

Image(image: ResizeImage(AssetImage('eg.png'), width: 70, height: 80)),

ImageProvider includes AssetImage , NetworkImage , FileImage and MemoryImage.

Use cacheHeight and cacheWidth property in your Image widget

These properties create a widget that displays an [ImageStream] obtained from an asset , network , memory or file .

Example :

Image.asset('assets/image.png', cacheHeight:120 , cacheWidth: 150),

There are these properties in Image.asset ,Image.network , Image.file and Image.memory

1
  • 1
    it is not increase more than the image size
    – appdev
    Commented May 5, 2022 at 4:45
5

you can use the image class from dart ui library, get the image object with your desired width and height using the frameInfo from intantiateImageCodec and then save it in your desired path

 import 'dart:ui' as ui;

        Uint8List m = File(path).readAsBytesSync();
        ui.Image x = await decodeImageFromList(m);
        ByteData bytes = await x.toByteData();
        print('height is ${x.height}'); //height of original image
        print('width is ${x.width}'); //width of oroginal image

        print('array is $m');
        print('original image size is ${bytes.lengthInBytes}');

            ui.instantiateImageCodec(m, targetHeight: 800, targetWidth: 600)
            .then((codec) {
          codec.getNextFrame().then((frameInfo) async {
            ui.Image i = frameInfo.image;
            print('image width is ${i.width}');//height of resized image
            print('image height is ${i.height}');//width of resized image
            ByteData bytes = await i.toByteData();
            File(path).writeAsBytes(bytes.buffer.asUint32List());
            print('resized image size is ${bytes.lengthInBytes}');
          });
        });
4
 final pickedFile = await picker.getImage(
        source: ImageSource.gallery,
        imageQuality: 25,
        maxHeight: 1024,
        maxWidth: 1024);
2
  • 2
    What does this do exactly? Does it just show the image resized? Or does it actually resize the image? I want to upload the image ... I have a rezise function in Cloud Functions, but it doesn't do a great job.
    – William
    Commented Sep 7, 2021 at 7:38
  • I think this is using this library import 'package:image_picker/image_picker.dart';
    – toha
    Commented Apr 17, 2022 at 13:09
4

I would say use the dart image package.

import 'package:image/image.dart' as image show
  decodedImage, copyResize //, encodePng
;
import 'dart:convert' as convert show
  base64encode
;

void resizeImage() async {
  List<int> fileBytes = await file.readAsBytes();
  image.Image decodedImage = image.decodeImage(fileBytes) as image.Image;
  image.Image thumbnail = image.copyResize(decodedImage, width: 60);
  List<int> resizedIntList = thumbnail.getBytes();
  // Or compress as a PNG image
  // List<int> resizedIntList = image.encodePng(thumbnail, level: 6);

  String resizedBase64Image = convert.base64Encode(resizedIntList);
}

You could also reference the following code, if you don't want the overhead of the package.

import 'dart:ui' as ui show
  Codec, instantiateImageCodec, FrameInfo;
import 'dart:typed_data' as typedData show
  ByteData, Uint8List
;
import 'dart:convert' as convert show
  base64Encode
;

void resizeImage() async {
  typedData.Uint8List fileBytes = await file.readAsBytes();

  // Resize image
  // ----------
  ui.Codec codec = await ui.instantiateImageCodec(
    fileBytes,
    targetWidth: 60
  );
  ui.FrameInfo frameInfo = await codec.getNextFrame();
  ui.Image resizedImage = frameInfo.image;
  // ----------

  // Convert to List<int>
  // ----------
  typedData.ByteData resizedByteData = await resizedImage.toByteData() as typedData.ByteData;
  typedData.Uint8List resizedUint8List = resizedByteData.buffer
    .asUint8List(resizedByteData.offsetInBytes, resizedByteData.lengthInBytes);
  List<int> resizedIntList = resizedUint8List.cast<int>();
  // ----------

  String resizedBase64Image = convert.base64Encode(resizedIntList);
}
2

You can use the dart image package: https://pub.dartlang.org/packages/image.

The package provide various services such as resize, crop and rotate.

While this package does work, unfortunately it is very slow.

See discussion: https://github.com/brendan-duncan/image/issues/55

-1

You can use the Image widget in the Scaffold widget,

First of all you need to create assets folder in the root and add an images folder, after that add,

    flutter:
      assets:
        - assets/images/

to the pubspec.yaml file, after that

new Image(
          image: AssetImage('assets/images/pizzaFont.png'),
          height: 12,
          width:12, ......
   )

You can use width and height to change the size of the image.

For more information follow,

https://medium.com/@suragch/how-to-include-images-in-your-flutter-app-863889fc0b29

1
  • Thanks for your answer. But as I said under CLARIFICATION: I don't want to save the image, but I do want to actually resize it in memory. I'd like to have an in memory file with the given size. Not only to display it bigger or smaller in the screen. Commented Sep 28, 2019 at 21:16

Not the answer you're looking for? Browse other questions tagged or ask your own question.