Skip to content

amitshekhariitbhu/GlideBitmapPool

Repository files navigation

Glide Bitmap Pool

About Glide Bitmap Pool

Glide Bitmap Pool is a memory management library for reusing the bitmap memory. As it reuses bitmap memory , so no more GC calling again and again , hence smooth running application. It uses inBitmap while decoding the bitmap on the supported android versions. All the version use-cases has been handled to optimize it better.

Why use this library ?

An Image heavy Application decodes many images , so there will be continuous allocation and deallocation of memory in application , and that results in very frequent calling of GC(Garbage Collector). And finally because of very frequent calling of GC , the application UI freezes. Use Bitmap pool to avoid continuous allocation and deallocation of memory in application and reduce GC overhead that will result in smooth running application. Suppose we have to load few bitmap in Android Application. When we load bitmapOne , it will allocate the memory for bitmapOne. Then if we don’t need bitmapOne , do not recycle bitmap (as if you recycle, it will make GC to be called) , so use this bitmapOne as an inBitmap for bitmapTwo so that , the same memory can be reused for bitmapTwo. In this way , we can avoid continuous allocation and deallocation of memory in application and reduce GC overhead. But the problem is that there are few restrictions as android version less than Honeycomb does not supports it , few android version less than Kitkat only when we use inSampleSize = 1 , above that it supports completely and few other issues. So , all these types of cases are handled in this library

Join Outcome School and get high paying tech job: Outcome School

GET RID OF : GC_FOR_ALLOC freed 1568K, 23% free 37664K/48844K, paused 141ms, total 143ms - (whenever you see this log , your application is lagging)

Requirements

Glide Bitmap Pool can be included in any Android or Java application.

Glide Bitmap Pool supports Android 2.3 (Gingerbread) and later.

Using Glide Bitmap Pool in your application

Add this in your settings.gradle:

maven { url 'https://jitpack.io' }

If you are using settings.gradle.kts, add the following:

maven { setUrl("https://jitpack.io") }

Add this in your build.gradle

implementation 'com.github.amitshekhariitbhu:GlideBitmapPool:1.0.0'

If you are using build.gradle.kts, add the following:

implementation("com.github.amitshekhariitbhu:GlideBitmapPool:1.0.0")

Then initialize it in onCreate() Method of application class, :

GlideBitmapPool.initialize(10 * 1024 * 1024); // 10mb max memory size

Decoding the bitmap from file path

Bitmap bitmap = GlideBitmapFactory.decodeFile(filePath);

Decoding the bitmap from resources

Bitmap bitmap = GlideBitmapFactory.decodeResource(getResources(), R.drawable.testImage);

Decoding the down sample bitmap

Bitmap bitmap = GlideBitmapFactory.decodeFile(filePath,100,100);

Making the bitmap available for recycle or reuse

GlideBitmapPool.putBitmap(bitmap);

Getting the empty bitmap from the pool

Bitmap bitmap = GlideBitmapPool.getBitmap(width, height, config);

Clearing or Trimming Memory

GlideBitmapPool.clearMemory();
GlideBitmapPool.trimMemory(level);

Migrating to Glide Bitmap Pool

// ------   decoding -------

// old code 
Bitmap bitmap = BitmapFactory.decodeResource(getResources(), R.drawable.test1);

// new code 
Bitmap bitmap = GlideBitmapFactory.decodeResource(getResources(), R.drawable.test1);

// ------   recycling ------- 

// old code
bitmap.recycle();

// new code
GlideBitmapPool.putBitmap(bitmap);

//  ------   creating a bitmap -------

// old code 
Bitmap bitmap = Bitmap.create(width, height, config);

// new code
Bitmap bitmap = GlideBitmapPool.getBitmap(width, height, config);

Important

// Do not use bitmap.recycle();
// use GlideBitmapPool.putBitmap(bitmap); as it will put bitmap in the pool for further reuse.

// Do not use Bitmap.create(width, height, config);
// use GlideBitmapPool.getBitmap(width, height, config); as it returns bitmap from the pool that can be reused.

Find this project useful ? ❤️

  • Support it by clicking the ⭐ button on the upper right of this page. ✌️

Credits and references

TODO

  • More Optimization with further updates.

Check out another awesome library for fast and simple networking in Android.

Another awesome library for debugging databases and shared preferences.

You can connect with me on:

Read all of our blogs here.

License

   Copyright (C) 2024 Amit Shekhar

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Contributing to Glide Bitmap Pool

All pull requests are welcome, make sure to follow the contribution guidelines when you submit pull request.