Skip to content

Commit 3665a79

Browse files
committed
Image swapping without frame advancement
This is a combination of 5 commits, the older 4 being: WIP Image swapping WIP exploring swapping image sources and caching frames WIP swapping works without frame advancement, but some tests are failing WIP Works, but seems to be leaking
1 parent bc34df9 commit 3665a79

2 files changed

Lines changed: 510 additions & 23 deletions

File tree

‎packages/flutter/lib/src/widgets/image.dart‎

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1108,7 +1108,15 @@ class Image extends StatefulWidget {
11081108

11091109
class _ImageState extends State<Image> with WidgetsBindingObserver {
11101110
ImageStream? _imageStream;
1111+
1112+
// The currently displayed ImageInfo, if any.
11111113
ImageInfo? _imageInfo;
1114+
1115+
// The ImageProvider of _imageInfo.
1116+
ImageProvider? _imageProvider;
1117+
1118+
// The most recently loaded ImageInfo of all `widget.image` ImageInfos.
1119+
final Map<ImageProvider, ImageInfo?> _imageInfosCache = <ImageProvider, ImageInfo?>{};
11121120
ImageChunkEvent? _loadingProgress;
11131121
bool _isListeningToStream = false;
11141122
late bool _invertColors;
@@ -1124,9 +1132,7 @@ class _ImageState extends State<Image> with WidgetsBindingObserver {
11241132
/// true.
11251133
bool _isPaused = false;
11261134

1127-
/// False when the class first is instantiated and true forever after the
1128-
/// first frame of the image is received.
1129-
bool _hasReceivedFirstFrame = false;
1135+
bool get _hasReceivedFirstFrame => _imageInfosCache[widget.image] != null;
11301136

11311137
@override
11321138
void initState() {
@@ -1143,6 +1149,9 @@ class _ImageState extends State<Image> with WidgetsBindingObserver {
11431149
_completerHandle?.dispose();
11441150
_scrollAwareContext.dispose();
11451151
_replaceImage(info: null);
1152+
_imageInfosCache.forEach((ImageProvider imageProvider, ImageInfo? imageInfo) {
1153+
imageInfo?.dispose();
1154+
});
11461155
super.dispose();
11471156
}
11481157

@@ -1153,10 +1162,10 @@ class _ImageState extends State<Image> with WidgetsBindingObserver {
11531162

11541163
_isPaused = !TickerMode.of(context) || (MediaQuery.maybeDisableAnimationsOf(context) ?? false);
11551164

1156-
if (!_isPaused || !_hasReceivedFirstFrame) {
1157-
_listenToStream();
1158-
} else {
1165+
if (_isPaused && _hasReceivedFirstFrame) {
11591166
_stopListeningToStream(keepStreamAlive: true);
1167+
} else {
1168+
_listenToStream();
11601169
}
11611170

11621171
super.didChangeDependencies();
@@ -1172,7 +1181,15 @@ class _ImageState extends State<Image> with WidgetsBindingObserver {
11721181
_imageStream!.removeListener(oldListener);
11731182
}
11741183
if (widget.image != oldWidget.image) {
1175-
_resolveImage();
1184+
final ImageInfo? cachedImageInfo = _imageInfosCache[widget.image];
1185+
if (cachedImageInfo != null && _isPaused) {
1186+
_replaceImage(info: cachedImageInfo);
1187+
} else {
1188+
_resolveImage();
1189+
if (!_isPaused || !_hasReceivedFirstFrame) {
1190+
_listenToStream();
1191+
}
1192+
}
11761193
}
11771194
}
11781195

@@ -1241,11 +1258,6 @@ class _ImageState extends State<Image> with WidgetsBindingObserver {
12411258
}
12421259

12431260
void _handleImageFrame(ImageInfo imageInfo, bool synchronousCall) {
1244-
if (_hasReceivedFirstFrame && _isPaused) {
1245-
_stopListeningToStream(keepStreamAlive: true);
1246-
return;
1247-
}
1248-
_hasReceivedFirstFrame = true;
12491261
setState(() {
12501262
_replaceImage(info: imageInfo);
12511263
_loadingProgress = null;
@@ -1254,6 +1266,9 @@ class _ImageState extends State<Image> with WidgetsBindingObserver {
12541266
_frameNumber = _frameNumber == null ? 0 : _frameNumber! + 1;
12551267
_wasSynchronouslyLoaded = _wasSynchronouslyLoaded | synchronousCall;
12561268
});
1269+
if (_isPaused) {
1270+
_stopListeningToStream(keepStreamAlive: true);
1271+
}
12571272
}
12581273

12591274
void _handleImageChunk(ImageChunkEvent event) {
@@ -1267,11 +1282,21 @@ class _ImageState extends State<Image> with WidgetsBindingObserver {
12671282

12681283
void _replaceImage({required ImageInfo? info}) {
12691284
final ImageInfo? oldImageInfo = _imageInfo;
1270-
SchedulerBinding.instance.addPostFrameCallback(
1271-
(_) => oldImageInfo?.dispose(),
1272-
debugLabel: 'Image.disposeOldInfo',
1273-
);
1285+
final ImageProvider? oldImageProvider = _imageProvider;
1286+
if (oldImageInfo != null) {
1287+
SchedulerBinding.instance.addPostFrameCallback((Duration duration) {
1288+
// If oldImageInfo is still in the cache, then it will be disposed when
1289+
// the widget is disposed. Otherwise it has been evicted, so dispose it
1290+
// here.
1291+
if (_imageInfosCache[oldImageProvider] != oldImageInfo) {
1292+
oldImageInfo.dispose();
1293+
}
1294+
}, debugLabel: 'Image.disposeOldInfo');
1295+
}
1296+
12741297
_imageInfo = info;
1298+
_imageProvider = widget.image;
1299+
_imageInfosCache[widget.image] = info;
12751300
}
12761301

12771302
// Updates _imageStream to newStream, and moves the stream listener
@@ -1309,11 +1334,10 @@ class _ImageState extends State<Image> with WidgetsBindingObserver {
13091334
return;
13101335
}
13111336

1337+
_isListeningToStream = true;
13121338
_imageStream!.addListener(_getListener());
13131339
_completerHandle?.dispose();
13141340
_completerHandle = null;
1315-
1316-
_isListeningToStream = true;
13171341
}
13181342

13191343
/// Stops listening to the image stream, if this state object has attached a

0 commit comments

Comments
 (0)