## 3.5.0

* Breaking Change: remove loadBuffer method, and add loadImage method [flutter/flutter#118966]
* Migrate to 3.7.0

Author: zmtzawqlp

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.5.0
+
+* Breaking Change: remove loadBuffer method, and add loadImage method [https://github.com/flutter/flutter/pull/118966]
+* Migrate to 3.7.0
+
 ## 3.4.2
 
 * Fix issue that cannot compile ExtendedImage.file on the web (566#)

lib/extended_image_library.dart

@@ -6,6 +6,6 @@ export 'src/extended_asset_bundle_image_provider.dart';
 export 'src/extended_file_image_provider.dart';
 export 'src/extended_image_provider.dart';
 export 'src/extended_memory_image_provider.dart';
-export 'src/extended_network_image_provider.dart';
 export 'src/extended_resize_image_provider.dart';
+export 'src/network/extended_network_image_provider.dart';
 export 'src/platform.dart';

lib/src/_platform_web.dart

@@ -1,4 +1,3 @@
-import 'dart:ui' as ui show Codec;
 import 'package:flutter/foundation.dart';
 import 'package:flutter/widgets.dart';
 
@@ -46,23 +45,6 @@ class FileImage extends ImageProvider<FileImage> {
     return SynchronousFuture<FileImage>(this);
   }
 
-  @override
-  ImageStreamCompleter loadBuffer(FileImage key, DecoderBufferCallback decode) {
-    return MultiFrameImageStreamCompleter(
-      codec: _loadAsync(key, decode),
-      scale: key.scale,
-      debugLabel: key.file.path,
-      informationCollector: () sync* {
-        yield ErrorDescription('Path: ${file.path}');
-      },
-    );
-  }
-
-  Future<ui.Codec> _loadAsync(
-      FileImage key, DecoderBufferCallback decode) async {
-    return Future<ui.Codec>.error(StateError('not support on web'));
-  }
-
   @override
   bool operator ==(Object other) {
     if (other.runtimeType != runtimeType) {

lib/src/extended_asset_bundle_image_provider.dart

@@ -45,8 +45,8 @@ class ExtendedExactAssetImageProvider extends ExactAssetImage
   }
 
   @override
-  ImageStreamCompleter loadBuffer(
-      AssetBundleImageKey key, DecoderBufferCallback decode) {
+  ImageStreamCompleter loadImage(
+      AssetBundleImageKey key, ImageDecoderCallback decode) {
     return MultiFrameImageStreamCompleter(
       codec: _loadAsync(key, decode),
       scale: key.scale,
@@ -63,7 +63,7 @@ class ExtendedExactAssetImageProvider extends ExactAssetImage
   /// This function is used by [load].
   @protected
   Future<ui.Codec> _loadAsync(
-      AssetBundleImageKey key, DecoderBufferCallback decode) async {
+      AssetBundleImageKey key, ImageDecoderCallback decode) async {
     ByteData data;
     // Hot reload/restart could change whether an asset bundle or key in a
     // bundle are available, or if it is a network backed bundle.
@@ -117,8 +117,8 @@ class ExtendedAssetImageProvider extends AssetImage
   }
 
   @override
-  ImageStreamCompleter loadBuffer(
-      AssetBundleImageKey key, DecoderBufferCallback decode) {
+  ImageStreamCompleter loadImage(
+      AssetBundleImageKey key, ImageDecoderCallback decode) {
     return MultiFrameImageStreamCompleter(
       codec: _loadAsync(key, decode),
       scale: key.scale,
@@ -135,7 +135,7 @@ class ExtendedAssetImageProvider extends AssetImage
   /// This function is used by [load].
   @protected
   Future<ui.Codec> _loadAsync(
-      AssetBundleImageKey key, DecoderBufferCallback decode) async {
+      AssetBundleImageKey key, ImageDecoderCallback decode) async {
     ByteData data;
     // Hot reload/restart could change whether an asset bundle or key in a
     // bundle are available, or if it is a network backed bundle.

lib/src/extended_file_image_provider.dart

@@ -26,7 +26,7 @@ class ExtendedFileImageProvider extends FileImage
   final String? imageCacheName;
 
   @override
-  ImageStreamCompleter loadBuffer(FileImage key, DecoderBufferCallback decode) {
+  ImageStreamCompleter loadImage(FileImage key, ImageDecoderCallback decode) {
     return MultiFrameImageStreamCompleter(
       codec: _loadAsync(key, decode),
       scale: key.scale,
@@ -38,7 +38,7 @@ class ExtendedFileImageProvider extends FileImage
   }
 
   Future<ui.Codec> _loadAsync(
-      FileImage key, DecoderBufferCallback decode) async {
+      FileImage key, ImageDecoderCallback decode) async {
     assert(key == this);
 
     final Uint8List bytes = await file.readAsBytes();

lib/src/extended_image_provider.dart

@@ -56,7 +56,7 @@ mixin ExtendedImageProvider<T extends Object> on ImageProvider<T> {
   /// for example, compress
   Future<ui.Codec> instantiateImageCodec(
     Uint8List data,
-    DecoderBufferCallback decode,
+    ImageDecoderCallback decode,
   ) async {
     if (cacheRawData) {
       rawImageDataMap[this] = data;
@@ -104,8 +104,10 @@ mixin ExtendedImageProvider<T extends Object> on ImageProvider<T> {
     }
     final ImageStreamCompleter? completer = imageCache.putIfAbsent(
       key,
-      () => loadBuffer(
-          key, PaintingBinding.instance.instantiateImageCodecFromBuffer),
+      () => loadImage(
+        key,
+        PaintingBinding.instance.instantiateImageCodecWithSize,
+      ),
       onError: handleError,
     );
     if (completer != null) {

lib/src/extended_memory_image_provider.dart

@@ -25,16 +25,16 @@ class ExtendedMemoryImageProvider extends MemoryImage
 
   @override
   Uint8List get rawImageData => bytes;
+
   @override
-  ImageStreamCompleter loadBuffer(
-      MemoryImage key, DecoderBufferCallback decode) {
+  ImageStreamCompleter loadImage(MemoryImage key, ImageDecoderCallback decode) {
     return MultiFrameImageStreamCompleter(
       codec: _loadAsync(key, decode),
       scale: key.scale,
     );
   }
 
-  Future<ui.Codec> _loadAsync(MemoryImage key, DecoderBufferCallback decode) {
+  Future<ui.Codec> _loadAsync(MemoryImage key, ImageDecoderCallback decode) {
     assert(key == this);
     return instantiateImageCodec(bytes, decode);
   }

lib/src/extended_resize_image_provider.dart

@@ -25,6 +25,7 @@ class ExtendedResizeImage extends ImageProvider<_SizeAwareCacheKey>
     this.allowUpscaling = false,
     this.cacheRawData = false,
     this.imageCacheName,
+    this.policy = ResizeImagePolicy.exact,
   }) : assert((compressionRatio != null &&
                 compressionRatio > 0 &&
                 compressionRatio < 1) ||
@@ -52,6 +53,11 @@ class ExtendedResizeImage extends ImageProvider<_SizeAwareCacheKey>
   /// The height the image should decode to and cache.
   final int? height;
 
+  /// The policy that determines how [width] and [height] are interpreted.
+  ///
+  /// Defaults to [ResizeImagePolicy.exact].
+  final ResizeImagePolicy policy;
+
   /// Whether the [width] and [height] parameters should be clamped to the
   /// intrinsic width and height of the image.
   ///
@@ -108,17 +114,21 @@ class ExtendedResizeImage extends ImageProvider<_SizeAwareCacheKey>
   }
 
   @override
-  ImageStreamCompleter loadBuffer(
-      _SizeAwareCacheKey key, DecoderBufferCallback decode) {
-    Future<Codec> decodeResize(ImmutableBuffer buffer,
-        {int? cacheWidth, int? cacheHeight, bool? allowUpscaling}) {
+  ImageStreamCompleter loadImage(
+      _SizeAwareCacheKey key, ImageDecoderCallback decode) {
+    Future<Codec> decodeResize(
+      ImmutableBuffer buffer, {
+      TargetImageSizeCallback? getTargetSize,
+    }) {
       assert(
-        cacheWidth == null && cacheHeight == null && allowUpscaling == null,
+        getTargetSize == null,
         'ResizeImage cannot be composed with another ImageProvider that applies '
         'cacheWidth, cacheHeight, or allowUpscaling.',
       );
+
       return _instantiateImageCodec(
         buffer,
+        decode,
         compressionRatio: compressionRatio,
         maxBytes: maxBytes,
         targetWidth: width,
@@ -127,7 +137,7 @@ class ExtendedResizeImage extends ImageProvider<_SizeAwareCacheKey>
     }
 
     final ImageStreamCompleter completer =
-        imageProvider.loadBuffer(key._providerCacheKey, decodeResize);
+        imageProvider.loadImage(key._providerCacheKey, decodeResize);
     if (!kReleaseMode) {
       completer.debugLabel =
           '${completer.debugLabel} - Resized(${key._width}×${key._height})';
@@ -178,7 +188,8 @@ class ExtendedResizeImage extends ImageProvider<_SizeAwareCacheKey>
   }
 
   Future<Codec> _instantiateImageCodec(
-    ImmutableBuffer buffer, {
+    ImmutableBuffer buffer,
+    ImageDecoderCallback decode, {
     double? compressionRatio,
     int? maxBytes,
     int? targetWidth,
@@ -205,14 +216,71 @@ class ExtendedResizeImage extends ImageProvider<_SizeAwareCacheKey>
       );
       targetWidth = size.width;
       targetHeight = size.height;
-    } else if (!allowUpscaling) {
-      if (targetWidth != null && targetWidth > descriptor.width) {
-        targetWidth = descriptor.width;
-      }
-      if (targetHeight != null && targetHeight > descriptor.height) {
-        targetHeight = descriptor.height;
-      }
     }
+    // else if (!allowUpscaling) {
+    //   if (targetWidth != null && targetWidth > descriptor.width) {
+    //     targetWidth = descriptor.width;
+    //   }
+    //   if (targetHeight != null && targetHeight > descriptor.height) {
+    //     targetHeight = descriptor.height;
+    //   }
+    // }
+    else {
+      return decode(buffer,
+          getTargetSize: (int intrinsicWidth, int intrinsicHeight) {
+        switch (policy) {
+          case ResizeImagePolicy.exact:
+            int? targetWidth = width;
+            int? targetHeight = height;
+
+            if (!allowUpscaling) {
+              if (targetWidth != null && targetWidth > intrinsicWidth) {
+                targetWidth = intrinsicWidth;
+              }
+              if (targetHeight != null && targetHeight > intrinsicHeight) {
+                targetHeight = intrinsicHeight;
+              }
+            }
+
+            return TargetImageSize(width: targetWidth, height: targetHeight);
+          case ResizeImagePolicy.fit:
+            final double aspectRatio = intrinsicWidth / intrinsicHeight;
+            final int maxWidth = width ?? intrinsicWidth;
+            final int maxHeight = height ?? intrinsicHeight;
+            int targetWidth = intrinsicWidth;
+            int targetHeight = intrinsicHeight;
+
+            if (targetWidth > maxWidth) {
+              targetWidth = maxWidth;
+              targetHeight = targetWidth ~/ aspectRatio;
+            }
+
+            if (targetHeight > maxHeight) {
+              targetHeight = maxHeight;
+              targetWidth = (targetHeight * aspectRatio).floor();
+            }
+
+            if (allowUpscaling) {
+              if (width == null) {
+                assert(height != null);
+                targetHeight = height!;
+                targetWidth = (targetHeight * aspectRatio).floor();
+              } else if (height == null) {
+                targetWidth = width!;
+                targetHeight = targetWidth ~/ aspectRatio;
+              } else {
+                final int derivedMaxWidth = (maxHeight * aspectRatio).floor();
+                final int derivedMaxHeight = maxWidth ~/ aspectRatio;
+                targetWidth = min(maxWidth, derivedMaxWidth);
+                targetHeight = min(maxHeight, derivedMaxHeight);
+              }
+            }
+
+            return TargetImageSize(width: targetWidth, height: targetHeight);
+        }
+      });
+    }
+
     return descriptor.instantiateCodec(
       targetWidth: targetWidth,
       targetHeight: targetHeight,

lib/src/extended_network_image_provider.dart renamed to lib/src/network/extended_network_image_provider.dart

@@ -1,11 +1,12 @@
 import 'dart:async';
 import 'dart:typed_data';
+import 'package:extended_image_library/src/extended_image_provider.dart';
 import 'package:flutter/painting.dart';
 import 'package:http_client_helper/http_client_helper.dart';
-import '_network_image_io.dart' if (dart.library.html) '_network_image_web.dart'
+import 'network_image_io.dart' if (dart.library.html) '_network_image_web.dart'
     as network_image;
-import 'extended_image_provider.dart';
 
+/// [NetworkImage]
 abstract class ExtendedNetworkImageProvider
     extends ImageProvider<ExtendedNetworkImageProvider>
     with ExtendedImageProvider<ExtendedNetworkImageProvider> {
@@ -62,10 +63,6 @@ abstract class ExtendedNetworkImageProvider
   /// After this time the cache is expired and the image is reloaded.
   Duration? get cacheMaxAge;
 
-  @override
-  ImageStreamCompleter loadBuffer(
-      ExtendedNetworkImageProvider key, DecoderBufferCallback decode);
-
   ///get network image data from cached
   Future<Uint8List?> getNetworkImageData({
     StreamController<ImageChunkEvent>? chunkEvents,

lib/src/_network_image_io.dart renamed to lib/src/network/network_image_io.dart

@@ -1,14 +1,15 @@
 import 'dart:async';
 import 'dart:io';
 import 'dart:ui' as ui show Codec;
+import 'package:extended_image_library/src/extended_image_provider.dart';
+import 'package:extended_image_library/src/platform.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/widgets.dart';
 import 'package:http_client_helper/http_client_helper.dart';
 import 'package:path/path.dart';
 import 'package:path_provider/path_provider.dart';
-import 'extended_image_provider.dart';
+
 import 'extended_network_image_provider.dart' as image_provider;
-import 'platform.dart';
 
 class ExtendedNetworkImageProvider
     extends ImageProvider<image_provider.ExtendedNetworkImageProvider>
@@ -90,9 +91,10 @@ class ExtendedNetworkImageProvider
   final Duration? cacheMaxAge;
 
   @override
-  ImageStreamCompleter loadBuffer(
-      image_provider.ExtendedNetworkImageProvider key,
-      DecoderBufferCallback decode) {
+  ImageStreamCompleter loadImage(
+    image_provider.ExtendedNetworkImageProvider key,
+    ImageDecoderCallback decode,
+  ) {
     // Ownership of this controller is handed off to [_loadAsync]; it is that
     // method's responsibility to close the controller's stream when the image
     // has been loaded or an error is thrown.
@@ -127,7 +129,7 @@ class ExtendedNetworkImageProvider
   Future<ui.Codec> _loadAsync(
     ExtendedNetworkImageProvider key,
     StreamController<ImageChunkEvent> chunkEvents,
-    DecoderBufferCallback decode,
+    ImageDecoderCallback decode,
   ) async {
     assert(key == this);
     final String md5Key = cacheKey ?? keyToMd5(key.url);