LightCompressor

LightCompressor can now be used in Flutter through light_compressor plugin.

A powerful and easy-to-use video compression library for android uses MediaCodec API. This library generates a compressed MP4 video with a modified width, height, and bitrate (the number of bits per seconds that determines the video and audio files’ size and quality). It is based on Telegram for Android project.

The general idea of how the library works is that, extreme high bitrate is reduced while maintaining a good video quality resulting in a smaller size.

I would like to mention that the set attributes for size and quality worked just great in my projects and met the expectations. It may or may not meet yours. I’d appreciate your feedback so I can enhance the compression process.

LightCompressor is now available in iOS, have a look at LightCompressor_iOS.

Change Logs

What's new in 1.3.3

• Thanks to LiewJunTung for improving the error handling.
• Thanks to CristianMG for improving the storage configuration and making the library testable.
• Thanks to dan3988 for replacing video size with resizer which made using the library way more flexible.
• Thanks to imSzukala for changing min supported api to 21.
• Thanks to josebraz for improving codec profile approach.
• Thanks to ryccoatika for improving exception handling for the coroutines.

How it works

When the video file is called to be compressed, the library checks if the user wants to set a min bitrate to avoid compressing low resolution videos. This becomes handy if you don’t want the video to be compressed every time it is to be processed to avoid having very bad quality after multiple rounds of compression. The minimum is;

• Bitrate: 2mbps

You can as well pass custom resizer and videoBitrate values if you don't want the library to auto-generate the values for you.

These values were tested on a huge set of videos and worked fine and fast with them. They might be changed based on the project needs and expectations.

Demo

Usage

To use this library, you must add the following permission to allow read and write to external storage. Refer to the sample app for a reference on how to start compression with the right setup.

API < 29

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission
    android:name="android.permission.WRITE_EXTERNAL_STORAGE"
    android:maxSdkVersion="28"
    tools:ignore="ScopedStorage" />

API >= 29

    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"
    android:maxSdkVersion="32"/>

API >= 33

 <uses-permission android:name="android.permission.READ_MEDIA_VIDEO"/>

 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
     // request READ_MEDIA_VIDEO run-time permission
 } else {
     // request WRITE_EXTERNAL_STORAGE run-time permission
 }

And import the following dependencies to use kotlin coroutines

Groovy

implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:${Version.coroutines}"
implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:${Version.coroutines}"

Then just call [VideoCompressor.start()] and pass context, uris, isStreamable, configureWith, and either sharedStorageConfiguration OR appSpecificStorageConfiguration.

The method has a callback for 5 functions;

1. OnStart - called when compression started
2. OnSuccess - called when compression completed with no errors/exceptions
3. OnFailure - called when an exception occurred or video bitrate and size are below the minimum required for compression.
4. OnProgress - called with progress new value
5. OnCancelled - called when the job is cancelled

Important Notes:

• All the callback functions returns an index for the video being compressed in the same order of the urls passed to the library. You can use this index to update the UI or retrieve information about the original uri/file.
• The source video must be provided as a list of content uris.
• OnSuccess returns the path of the stored video.
• If you want an output video that is optimised to be streamed, ensure you pass [isStreamable] flag is true.

Configuration values

• VideoQuality: VERY_HIGH (original-bitrate * 0.6) , HIGH (original-bitrate * 0.4), MEDIUM (original-bitrate * 0.3), LOW (original-bitrate * 0.2), OR VERY_LOW (original-bitrate * 0.1)

• isMinBitrateCheckEnabled: this means, don't compress if bitrate is less than 2mbps

• videoBitrateInMbps: any custom bitrate value in Mbps.

• disableAudio: true/false to generate a video without audio. False by default.

• resizer: Function to resize the video dimensions. VideoResizer.auto by default.

The StorageConfiguration is an interface which indicate library where will be saved the File

Library provides some behaviors defined to be more easy to use, specified the next

AppSpecificStorageConfiguration Configuration values

• subFolderName: a subfolder name created in app's specific storage.

SharedStorageConfiguration Configuration values

• saveAt: the directory where the video should be saved in. Must be one of the following; [SaveLocation.pictures], [SaveLocation.movies], or [SaveLocation.downloads].
• subFolderName: a subfolder name created in shared storage.

CacheStorageConfiguration

• There are no configuration values create a file in cache directory as Google defined, to get more info go to here

Fully custom configuration

• If any of these behaviors fit with your needs, you can create your own StorageConfiguration, just implement the interface and pass it to the library

class FullyCustomizedStorageConfiguration(
) : StorageConfiguration {
    override fun createFileToSave(
        context: Context,
        videoFile: File,
        fileName: String,
        shouldSave: Boolean
    ): File = ??? What you need 
}

To cancel the compression job, just call [VideoCompressor.cancel()]

Kotlin

VideoCompressor.start(
   context = applicationContext, // => This is required
   uris = List<Uri>, // => Source can be provided as content uris
   isStreamable = false, 
   // THIS STORAGE
   storageConfiguration = SharedStorageConfiguration(
       saveAt = SaveLocation.movies, // => default is movies
       subFolderName = "my-videos" // => optional
   )
   configureWith = Configuration(
      videoNames = listOf<String>(), /*list of video names, the size should be similar to the passed uris*/
      quality = VideoQuality.MEDIUM,
      isMinBitrateCheckEnabled = true,
      videoBitrateInMbps = 5, /*Int, ignore, or null*/
      disableAudio = false, /*Boolean, or ignore*/
      resizer = VideoResizer.matchSize(360, 480) /*VideoResizer, ignore, or null*/
   ),
   listener = object : CompressionListener {
       override fun onProgress(index: Int, percent: Float) {
          // Update UI with progress value
          runOnUiThread {
          }
       }

       override fun onStart(index: Int) {
          // Compression start
       }

       override fun onSuccess(index: Int, size: Long, path: String?) {
         // On Compression success
       }

       override fun onFailure(index: Int, failureMessage: String) {
         // On Failure
       }

       override fun onCancelled(index: Int) {
         // On Cancelled
       }

   }
)

Common issues

• Sending the video to whatsapp when disableAudio = false, won't succeed [ at least for now ]. Whatsapp's own compression does not work with LightCompressor library. You can send the video as document.

• You cannot call Toast.makeText() and other functions dealing with the UI directly in onProgress() which is a worker thread. They need to be called from within the main thread. Have a look at the example code above for more information.

Reporting issues

To report an issue, please specify the following:

• Device name
• Android version

Compatibility

Minimum Android SDK: LightCompressor requires a minimum API level of 21.

How to add to your project?

Gradle

Ensure Kotlin version is 1.8.21

Include this in your Project-level build.gradle file:

Groovy

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

Include this in your Module-level build.gradle file:

Groovy

implementation 'com.github.AbedElazizShe:LightCompressor:1.3.3'

If you're facing problems with the setup, edit settings.gradle by adding this at the beginning of the file:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

Getting help

For questions, suggestions, or anything else, email elaziz.shehadeh(at)gmail.com

Credits

Telegram for Android.