Reducing bitmap memory footprint #5276

ouchadam · 2022-02-21T17:29:14Z

Type of change

Feature
Bugfix
Technical
Other :

Content

Stops the shortcut bitmap creation from always creating new bitmaps by doing the adaptive icon changes as a cachable glide transformation
Removes our notification bitmap caches in favour of relying on glide instead (which already has an in memory cache)

Motivation and context

To reduce our memory footprint, currently the app is constantly creating resized bitmaps for the shortcuts each time the room list changes.

Screenshots / GIFs

ACCOUNT	BEFORE	AFTER

BEFORE	AFTER

Tests

Add multiple large rooms to an account
Using the IDE profiler, perform a heap dump and check the bitmap allocations

Tested devices

Physical
Emulator
OS version(s): 8.1.0

- this effectively halves the amount of image memory used by notifications

…e is relatively small and there's no cap on the image size

- avoid creating new bitmaps each time the room list changes

ouchadam · 2022-02-21T17:31:58Z

vector/src/main/java/im/vector/app/features/home/ShortcutCreator.kt

@@ -83,11 +87,7 @@ class ShortcutCreator @Inject constructor(

    private fun Bitmap.toProfileImageIcon(): IconCompat {
        return if (useAdaptiveIcon) {
-            val insetBmp = Bitmap.createBitmap(adaptiveIconSize, adaptiveIconSize, Bitmap.Config.ARGB_8888)


this was the cause of our extra allocations, the fix was to transform the bitmap transformation into a cachable glide transformation https://github.com./vector-im/element-android/pull/5276/files#diff-1f9afdb46350b185b8e9cfc6698b2885bb19fb15d98c1c65dfedfe5371615d81R173

github-actions · 2022-02-21T17:49:19Z

Matrix SDK

Integration Tests Results:

[org.matrix.android.sdk.session]
passed=
[org.matrix.android.sdk.account]
passed=
[org.matrix.android.sdk.internal]
passed=
[org.matrix.android.sdk.ordering]
passed=
[org.matrix.android.sdk.PermalinkParserTest]
passed=

…e stored with unique keys

ouchadam · 2022-02-21T17:58:26Z

vector/src/main/java/im/vector/app/features/home/AvatarRenderer.kt

+                .asBitmap()
+                .avatarOrText(matrixItem, iconSize)
+                .transform(CenterCrop(), AdaptiveIconTransformation(adaptiveIconSize, adaptiveIconOuterSides))
+                .signature(ObjectKey("adaptive-icon"))


caches the transformed icon under with an extra unique key, to avoid overwriting other cached images on the same room url

ouchadam · 2022-02-21T17:59:39Z

vector/src/main/java/im/vector/app/features/notifications/NotificationBitmapLoader.kt

+import javax.inject.Singleton
+
+@Singleton
+class NotificationBitmapLoader @Inject constructor(private val context: Context) {


the notification helpers have been flattened into a single Notification Loader to help give more context to the usage

ouchadam · 2022-02-21T18:00:29Z

vector/src/main/java/im/vector/app/features/notifications/NotificationBitmapLoader.kt

+
+    @WorkerThread
+    private fun loadRoomBitmap(path: String): Bitmap? {
+        return try {


the previous in memory caches have been removed, they were repeating the glide in memory cache and potentially causing leaks (as we never cleaned up the references)

github-actions · 2022-02-21T18:27:50Z

Unit Test Results

  84 files ±0   84 suites ±0 1m 2s ⏱️ -4s
157 tests ±0 157 ✔️ ±0 0 💤 ±0 0 ❌ ±0
504 runs ±0 504 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit bad4579. ± Comparison against base commit 95c00a1.

♻️ This comment has been updated with latest results.

ariskotsomitopoulos · 2022-02-21T20:47:21Z

vector/src/main/java/im/vector/app/features/home/ShortcutCreator.kt

-            avatarRenderer.shortcutDrawable(GlideApp.with(context), roomSummary.toMatrixItem(), iconSize)
+            val glideRequests = GlideApp.with(context)
+            val matrixItem = roomSummary.toMatrixItem()
+            when (useAdaptiveIcon) {


haha +1 for the boolean when

ariskotsomitopoulos · 2022-02-21T20:52:46Z

Nice work Adam 🦾 ! Do you think we should do more tests in different devices & android versions or the fix do not depend that much on that?

ouchadam · 2022-02-22T10:48:31Z

@ariskotsomitopoulos for this case the extra bitmaps were being created as part of the adaptive icon logic which is only applied to android 8+

it's possible that different android versions handle garbage collecting the orphaned bitmap native memory differently but I'm not sure if it's worth testing now that we avoid creating all the extra bitmaps 🤔

ganfra

Nice work, thanks!

bmarty

LGTM, thanks!

bmarty · 2022-02-22T12:55:10Z

vector/src/main/java/im/vector/app/features/home/AdaptiveIconTransformation.kt

+        }
+    }
+
+    override fun hashCode() = Util.hashCode(ADAPTIVE_TRANSFORMATION_ID.hashCode(), Util.hashCode(adaptiveIconSize, Util.hashCode(adaptiveIconOuterSides)))


Not sure if it is clearer, but I could not resist to try to rewrite it like:

override fun hashCode() = listOf(ADAPTIVE_TRANSFORMATION_ID.hashCode(), adaptiveIconSize, floatToIntBits(adaptiveIconOuterSides)) .fold(0) { acc, i -> Util.hashCode(acc, i) }

Please just ignore me :)

the glide transformation api is a bit clunky, I didn't want to stray tooo far from the examples 😅

bmarty · 2022-02-22T12:56:49Z

vector/src/main/java/im/vector/app/features/home/AdaptiveIconTransformation.kt

+
+    override fun equals(other: Any?): Boolean {
+        return if (other is AdaptiveIconTransformation) {
+            other.adaptiveIconSize == adaptiveIconSize && other.adaptiveIconOuterSides == adaptiveIconOuterSides


Why not just compare hashCodes here?

ouchadam added 5 commits February 21, 2022 12:04

relying on the glide caches (persisted and in memory) instead of our own

65239e4

- this effectively halves the amount of image memory used by notifications

limiting the room bitmap loader image size, the notification icon siz…

eeb9785

…e is relatively small and there's no cap on the image size

tranforming images for adaptive shortcuts within glides transformations

9f44975

- avoid creating new bitmaps each time the room list changes

flattening the room and user icon loading into the same file

33c30e2

adding changelog entry

5bbb3f2

ouchadam commented Feb 21, 2022

View reviewed changes

ouchadam closed this Feb 21, 2022

fixing wrong shortcut icon size and ensuring the transformed files ar…

506690a

…e stored with unique keys

ouchadam reopened this Feb 21, 2022

ouchadam commented Feb 21, 2022

View reviewed changes

ariskotsomitopoulos reviewed Feb 21, 2022

View reviewed changes

reducing line length (using existing formatting style)

bad4579

ganfra approved these changes Feb 22, 2022

View reviewed changes

ganfra added the Z-NextRelease For issues and PRs which should be included in the NextRelease. label Feb 22, 2022

bmarty approved these changes Feb 22, 2022

View reviewed changes

bmarty merged commit 211e1c2 into develop Feb 22, 2022

bmarty deleted the feature/adm/limit-inmemory-image-caches branch February 22, 2022 12:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reducing bitmap memory footprint #5276

Reducing bitmap memory footprint #5276

ouchadam commented Feb 21, 2022 •

edited

Loading

ouchadam Feb 21, 2022

github-actions bot commented Feb 21, 2022

ouchadam Feb 21, 2022 •

edited

Loading

ouchadam Feb 21, 2022

ouchadam Feb 21, 2022

github-actions bot commented Feb 21, 2022 •

edited

Loading

ariskotsomitopoulos Feb 21, 2022

ariskotsomitopoulos commented Feb 21, 2022

ouchadam commented Feb 22, 2022

ganfra left a comment

bmarty left a comment

bmarty Feb 22, 2022

ouchadam Feb 22, 2022

bmarty Feb 22, 2022

Reducing bitmap memory footprint #5276

Reducing bitmap memory footprint #5276

Conversation

ouchadam commented Feb 21, 2022 • edited Loading

Type of change

Content

Motivation and context

Screenshots / GIFs

Tests

Tested devices

ouchadam Feb 21, 2022

Choose a reason for hiding this comment

github-actions bot commented Feb 21, 2022

Matrix SDK

Integration Tests Results:

ouchadam Feb 21, 2022 • edited Loading

Choose a reason for hiding this comment

ouchadam Feb 21, 2022

Choose a reason for hiding this comment

ouchadam Feb 21, 2022

Choose a reason for hiding this comment

github-actions bot commented Feb 21, 2022 • edited Loading

Unit Test Results

ariskotsomitopoulos Feb 21, 2022

Choose a reason for hiding this comment

ariskotsomitopoulos commented Feb 21, 2022

ouchadam commented Feb 22, 2022

ganfra left a comment

Choose a reason for hiding this comment

bmarty left a comment

Choose a reason for hiding this comment

bmarty Feb 22, 2022

Choose a reason for hiding this comment

ouchadam Feb 22, 2022

Choose a reason for hiding this comment

bmarty Feb 22, 2022

Choose a reason for hiding this comment

ouchadam commented Feb 21, 2022 •

edited

Loading

ouchadam Feb 21, 2022 •

edited

Loading

github-actions bot commented Feb 21, 2022 •

edited

Loading