Merge pull request #1 from Netesh5/feat/add_bg

Netesh5 · web-flow · commit 747334b125fc · 2025-01-30T16:11:01.000+05:45
Feat/add bg
diff --git a/.flutter-plugins b/.flutter-plugins
@@ -0,0 +1,2 @@
+# This is a generated file; do not edit or check into version control.
+onnxruntime=/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/
diff --git a/.flutter-plugins-dependencies b/.flutter-plugins-dependencies
@@ -0,0 +1 @@
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"android":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"macos":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"linux":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"windows":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"onnxruntime","dependencies":[]}],"date_created":"2025-01-30 15:37:32.599262","version":"3.24.5","swift_package_manager_enabled":false}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 0.0.6
+
+### Feat
+- Added `addBackground` function to change background of color
+
 ## 0.0.5
 
 ### Fix
diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@ A Flutter package that removes the background from images using an ONNX model. T
 - Works entirely offline, ensuring privacy and reliability.  
 - Lightweight and optimized for efficient performance.  
 - Simple and seamless integration with Flutter projects. 
+- Add a custom background color to images.
 
 ---
 
@@ -31,7 +32,7 @@ dependencies:
 ##  Usage
 # Initialization
 Before using the `removeBg` method, you must initialize the ONNX environment:
-    ```
+    ```dart
     import 'package:image_background_remover/image_background_remover.dart';
 
     @override
@@ -40,11 +41,10 @@ Before using the `removeBg` method, you must initialize the ONNX environment:
         BackgroundRemover.instance.initializeOrt();
     }
 
-    ```
 
 # Remove Background
 To remove the background from an image:
-```
+```dart
 import 'dart:typed_data';
 import 'package:image_background_remover/image_background_remover.dart';
 
@@ -53,16 +53,32 @@ ui.Image resultImage = await BackgroundRemover.instance.removeBg(imageBytes);
 /* resultImage will contain image with transparent background*/
 
 
+```
+
+## 🆕 New Feature: Add Background Color
+
+You can now add a custom background color to images after removing the background.
+
+### Usage:
+
+```dart
+Uint8List modifiedImage = await BackgroundRemover.instance.addBackground(
+  image: originalImageBytes,
+  bgColor: Colors.white, // Set your desired background color
+);
+
 ```
 
 ## API
 
 ### Methods
 
-| Method                  | Description                                                                 | Parameters                      | Returns                           |
-|-------------------------|-----------------------------------------------------------------------------|---------------------------------|-----------------------------------|
-| `initializeOrt()`       | Initializes the ONNX runtime environment. Call this method once before using `removeBg`. | None                            | `Future<void>`                   |
+| Method                          | Description                                                                 | Parameters                                      | Returns                           |
+|---------------------------------|-----------------------------------------------------------------------------|------------------------------------------------|-----------------------------------|
+| `initializeOrt()`               | Initializes the ONNX runtime environment. Call this method once before using `removeBg`. | None                                           | `Future<void>`                   |
 | `removeBg(Uint8List imageBytes)` | Removes the background from an image.                                     | `imageBytes` - The image in byte array format. | `Future<ui.Image>` - The processed image with the background removed. |
+| `addBackground({required Uint8List image, required Color bgColor})` | Adds a background color to the given image. | `image` - The original image in byte array format. <br> `bgColor` - The background color to be applied. | `Future<Uint8List>` - The modified image with the background color applied. |
+
 
 
 ## ⚠️ Warning
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -96,7 +96,31 @@ class _MyHomePageState extends State<MyHomePage> {
                                         return const CircularProgressIndicator();
                                       } else if (snapshot.connectionState ==
                                           ConnectionState.done) {
-                                        return Image.memory(snapshot.data!);
+                                        return Column(
+                                          children: [
+                                            Image.memory(snapshot.data!),
+                                            FutureBuilder(
+                                                future: BackgroundRemover
+                                                    .instance
+                                                    .addBackground(
+                                                        image: snapshot.data!,
+                                                        bgColor: Colors.orange),
+                                                builder: (context, snapshot) {
+                                                  if (snapshot
+                                                          .connectionState ==
+                                                      ConnectionState.waiting) {
+                                                    return const CircularProgressIndicator();
+                                                  } else if (snapshot
+                                                          .connectionState ==
+                                                      ConnectionState.done) {
+                                                    return Image.memory(
+                                                        snapshot.data!);
+                                                  } else {
+                                                    return const Text('Error');
+                                                  }
+                                                }),
+                                          ],
+                                        );
                                       } else {
                                         return const Text('Error');
                                       }
diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -1,6 +1,14 @@
 # Generated by pub
 # See https://dart.dev/tools/pub/glossary#lockfile
 packages:
+  archive:
+    dependency: transitive
+    description:
+      name: archive
+      sha256: "6199c74e3db4fbfbd04f66d739e72fe11c8a8957d5f219f1f4482dbde6420b5a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "4.0.2"
   async:
     dependency: transitive
     description:
@@ -49,6 +57,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "0.3.4+2"
+  crypto:
+    dependency: transitive
+    description:
+      name: crypto
+      sha256: "1e445881f28f22d6140f181e07737b22f1e099a5e1ff94b0af2f9e4a463f4855"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.6"
   cupertino_icons:
     dependency: "direct main"
     description:
@@ -152,13 +168,21 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "4.0.2"
+  image:
+    dependency: transitive
+    description:
+      name: image
+      sha256: "8346ad4b5173924b5ddddab782fc7d8a6300178c8b1dc427775405a01701c4a6"
+      url: "https://pub.dev"
+    source: hosted
+    version: "4.5.2"
   image_background_remover:
     dependency: "direct main"
     description:
       path: ".."
       relative: true
     source: path
-    version: "0.0.2"
+    version: "0.0.5"
   image_picker:
     dependency: "direct main"
     description:
@@ -303,6 +327,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.9.0"
+  petitparser:
+    dependency: transitive
+    description:
+      name: petitparser
+      sha256: c15605cd28af66339f8eb6fbe0e541bfe2d1b72d5825efc6598f3e0a31b9ad27
+      url: "https://pub.dev"
+    source: hosted
+    version: "6.0.2"
   plugin_platform_interface:
     dependency: transitive
     description:
@@ -311,6 +343,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.8"
+  posix:
+    dependency: transitive
+    description:
+      name: posix
+      sha256: a0117dc2167805aa9125b82eee515cc891819bac2f538c83646d355b16f58b9a
+      url: "https://pub.dev"
+    source: hosted
+    version: "6.0.1"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -396,6 +436,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.1.0"
+  xml:
+    dependency: transitive
+    description:
+      name: xml
+      sha256: b015a8ad1c488f66851d762d3090a21c600e479dc75e68328c52774040cf9226
+      url: "https://pub.dev"
+    source: hosted
+    version: "6.5.0"
 sdks:
   dart: ">=3.5.4 <4.0.0"
   flutter: ">=3.24.0"
diff --git a/lib/src/background_remover.dart b/lib/src/background_remover.dart
@@ -7,6 +7,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:image_background_remover/assets.dart';
 import 'package:onnxruntime/onnxruntime.dart';
+import 'package:image/image.dart' as img;
 
 class BackgroundRemover {
   BackgroundRemover._internal();
@@ -59,8 +60,20 @@ class BackgroundRemover {
 
   /// Removes the background from an image.
   ///
+  /// This function processes the input image and removes its background,
+  /// returning a new image with the background removed.
+  ///
   /// - [imageBytes]: The input image as a byte array.
   /// - Returns: A [ui.Image] with the background removed.
+  ///
+  /// Example usage:
+  /// ```dart
+  /// final imageBytes = await File('path_to_image').readAsBytes();
+  /// final ui.Image imageWithoutBackground = await removeBackground(imageBytes);
+  /// ```
+  ///
+  /// Note: This function may take some time to process depending on the size
+  /// and complexity of the input image.
   Future<ui.Image> removeBg(Uint8List imageBytes) async {
     if (_session == null) {
       throw Exception("ONNX session not initialized");
@@ -149,6 +162,14 @@ class BackgroundRemover {
   }
 
   /// Applies the mask to the original image and generates the final output.
+  ///
+  /// This method takes the mask generated by the background removal algorithm
+  /// and applies it to the original image to produce the final image with the
+  /// background removed. The resulting image will have the background pixels
+  /// replaced with transparency or a specified color.
+  ///
+  /// Returns:
+  ///   A new image with the background removed.
   Future<ui.Image> _applyMaskToOriginalSizeImage(
       ui.Image image, List resizedMask) async {
     final byteData = await image.toByteData(format: ui.ImageByteFormat.rawRgba);
@@ -179,4 +200,32 @@ class BackgroundRemover {
 
     return completer.future;
   }
+
+  /// Adds a background color to the given image.
+  ///
+  /// This method takes an image in the form of a [Uint8List] and a background
+  /// color as a [Color]. It decodes the image, creates a new image with the
+  /// same dimensions, fills it with the specified background color, and then
+  /// composites the original image onto the new image with the background color.
+  ///
+  /// Returns a [Future] that completes with the modified image as a [Uint8List].
+  ///
+  /// - Parameters:
+  ///   - image: The original image as a [Uint8List].
+  ///   - bgColor: The background color as a [Color].
+  ///
+  /// - Returns: A [Future] that completes with the modified image as a [Uint8List].
+  Future<Uint8List> addBackground(
+      {required Uint8List image, required Color bgColor}) async {
+    final img.Image decodedImage = img.decodeImage(image)!;
+    final newImage =
+        img.Image(width: decodedImage.width, height: decodedImage.height);
+    img.fill(newImage,
+        color: img.ColorRgb8(bgColor.red, bgColor.green, bgColor.blue));
+    img.compositeImage(newImage, decodedImage);
+    final jpegBytes = img.encodeJpg(newImage);
+    final completer = Completer<Uint8List>();
+    completer.complete(jpegBytes.buffer.asUint8List());
+    return completer.future;
+  }
 }
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: image_background_remover
 description: "A Flutter package that removes the background from images using an ONNX model."
-version: 0.0.5
+version: 0.0.6
 homepage: https://github.com/Netesh5/image_background_remover/tree/main
 
 environment:
@@ -10,6 +10,7 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
+  image: ^4.5.2
   onnxruntime: ^1.4.1
 
 dev_dependencies:

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# This is a generated file; do not edit or check into version control.`
	`2`	`+onnxruntime=/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"android":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"macos":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"linux":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"windows":[{"name":"onnxruntime","path":"/Users/neteshpaudel/.pub-cache/hosted/pub.dev/onnxruntime-1.4.1/","native_build":true,"dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"onnxruntime","dependencies":[]}],"date_created":"2025-01-30 15:37:32.599262","version":"3.24.5","swift_package_manager_enabled":false}