feature: Native assets Rust implementation

.fvmrc

@@ -0,0 +1,3 @@
+{
+  "flutter": "master"
+}

.gitignore

@@ -28,3 +28,11 @@ migrate_working_dir/
 .dart_tool/
 .packages
 build/
+
+# Rust related
+rust/target/
+rust/pkg/
+
+# FVM Version Cache
+.fvm/
+.fvmrc/

.vscode/launch.json

@@ -4,39 +4,22 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
-        {
-            "name": "blurhash_ffi",
-            "request": "launch",
-            "type": "dart"
-        },
-        {
-            "name": "blurhash_ffi (profile mode)",
-            "request": "launch",
-            "type": "dart",
-            "flutterMode": "profile"
-        },
-        {
-            "name": "blurhash_ffi (release mode)",
-            "request": "launch",
-            "type": "dart",
-            "flutterMode": "release"
-        },
         {
             "name": "example",
-            "cwd": "example",
+            "cwd": "packages/flutter_blurhash_ffi/example",
             "request": "launch",
             "type": "dart"
         },
         {
             "name": "example (profile mode)",
-            "cwd": "example",
+            "cwd": "packages/flutter_blurhash_ffi/example",
             "request": "launch",
             "type": "dart",
             "flutterMode": "profile"
         },
         {
             "name": "example (release mode)",
-            "cwd": "example",
+            "cwd": "packages/flutter_blurhash_ffi/example",
             "request": "launch",
             "type": "dart",
             "flutterMode": "release"

.vscode/settings.json

@@ -4,5 +4,13 @@
   "editor.fontWeight": "normal",
   "files.associations": {
     "blurhash_ffi.h": "c"
-  }
-}
+  },
+  "yaml.schemas": {
+    "https://taskfile.dev/schema.json": [
+      "**/Taskfile.yml"
+    ]
+  },
+  "task": {
+    "outputTo": "terminal"
+  },
+}

README.md

@@ -1,142 +1,144 @@
 # blurhash_ffi
 
-A [Blurhash](https://blurha.sh) compact Image placeholder encoder and decoder FFI implementation for flutter in C, Supports Android, iOS, Linux, macOS and Windows.
+A [Blurhash](https://blurha.sh) compact Image placeholder encoder and decoder FFI implementation for Flutter in Rust via experemental feature [Native Assets](https://github.com/flutter/flutter/issues/129757).
 
 Matches the official [Blurhash](https://github.com/woltapp/blurhash) implementation in performance and quality.
 
-
 ![blurhash_ffi](https://firebasestorage.googleapis.com/v0/b/folksable-d4dc8.appspot.com/o/blurhash_ffi.png?alt=media&token=e6c7e81b-1798-403b-b055-68a1f767d21f)
 
+# Supports
+
+| Platform | Status | Description                                                                                                                                                                                                                                                                                                                                       |
+| -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Android  | ✅      | -                                                                                                                                                                                                                                                                                                                                                 |
+| iOS      | ✅      | -                                                                                                                                                                                                                                                                                                                                                 |
+| macOS    | ⚠️      | Worked if merge this [PR](https://github.com/irondash/native_toolchain_rust/pull/26)                                                                                                                                                                                                                                                              |
+| Linux    | ⚠️      | Not tested                                                                                                                                                                                                                                                                                                                                        |
+| Windows  | ⚠️      | Worked but exist problem: long path length error via compilation ([meta issue](https://github.com/rust-lang/cargo/issues/9770) and [issue](https://github.com/rust-lang/cargo/issues/13141) which describe this )                                                                                                                                 |
+| Web      | ❌      | Rust can compiled to WebAssembly, but no supported yet. This library compiled on standalone wasm module (not in Empscripten, AssemblyScript) that Dart can't be use non-JS enviroments. Also, Dart should use FFI bindings for call wasm module. Stopped issues: [comment](https://github.com/dart-lang/sdk/issues/37355#issuecomment-2135064545) |
+
+# Installation
+
+Add dependency to your `pubspec.yaml` file following the command below:
+
+
+For dart projects:
+
+```sh
+dart pub add dart_blurhash_ffi
+```
+
+For flutter projects:
+
+```sh
+dart pub add flutter_blurhash_ffi
+```
 
 ## Usage
+
 To use this plugin, add `blurhash_ffi` as a dependency in your pubspec.yaml file
 
-**One Step (both Encoding & Decoding) Usage**
+**Flutter usage**
+
 ```dart
-import 'package:blurhash_ffi/blurhash_ffi.dart';
+import 'package:flutter_blurhash_ffi/flutter_blurhash_ffi.dart';
 
 /// Encoding and Decoding all in One Step
 ///
 /// `ImageProvider` in    -> Send your Image to be encoded.
 /// `ImageProvider` out   -> Get your blurry image version.
-
 class BlurhashMyImage extends StatelessWidget {
   final String imageUrl;
   const BlurhashMyImage({required this.imageUrl, super.key});
 
   @override
   Widget build(BuildContext context) {
     return Image(
-      image: BlurhashTheImage(
+      image: BlurhashFfiImage.fromImageProvider(
         NetworkImage(imageUrl),  // you can use any image provider of your choice.
-          decodingHeight: 1920, decodingWidth: 1080),
+        decodingHeight: 1920,
+        decodingWidth: 1080,
+      ),
       alignment: Alignment.center,
       fit: BoxFit.cover
     );
   }
 }
 
 
+class BlurhashMyImage2 extends StatelessWidget {
+  final String blurhash;
+  const BlurhashMyImage2({required this.blurhash, super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Image(
+      image: BlurhashFfiImage(blurhash),
+      width: 200,
+      height: 200,
+      alignment: Alignment.center,
+      fit: BoxFit.cover
+    );
+  }
+}
+
 ```
 
+> [!WARNING]
+> Not recommend use it (without _blurhash string param_), because in this case, encoding and decoding will be performed. This effect can be obtained almost through [ImageFiltered](https://api.flutter.dev/flutter/widgets/ImageFiltered-class.html).
+
 **Encoding**
 
+Encoding now uses sync interface (without `Future`).
+
 <?code-excerpt "readme_excerpts.dart (Example)"?>
+
 ```dart
-import 'package:blurhash_ffi/blurhash_ffi.dart';
+import 'package:dart_blurhash_ffi/dart_blurhash_ffi.dart';
 
-/// Encoding a blurhash from an image provider
-///
-/// You can use any ImageProvider you want, including NetworkImage, FileImage, MemoryImage, AssetImage, etc.
-final imageProvider = NetworkImage('https://picsum.photos/512');
-final imageProvider2 = AssetImage('assets/image.jpg');
+final Uint8List blurhashImageBytes = File('assets/image.webp').readAsBytesSync();
 
 /// Signature
-/// static Future<String> encode(
-///   ImageProvider imageProvider, {
+/// static String encode(
+///   Uint8List data, {
 ///   int componentX = 4,
 ///   int componentY = 3,
 /// })
 /// may throw `BlurhashFFIException` if encoding fails.
-final String blurHash = await BlurhashFFI.encode(imageProvider);
+final String blurHash = BlurhashFFI.encode(blurhashImageBytes);
+
+// Or via codec
+
+final String blurHashSame = BlurhashFfiCodec().encoder.convert(blurhashImageBytes);
 
 ```
 
 **Decoding**
-```dart
-import 'package:blurhash_ffi/blurhash_ffi.dart';
-import 'dart:ui' as ui;
-/// You have 3 ways to decode a blurhash 
-///
-/// 1. Using the `BlurhashFfi` widget
-/// 2. Using the `BlurhashFfiImage` ImageProvider
-/// 3. Using the `BlurhashFfi.decode` static method
 
-/// 1. Using the `BlurhashFfi` widget (same constructor as flutter_blurhash's Blurhash widget)
-class BlurHashApp extends StatelessWidget {
-  const BlurHashApp({Key? key}) : super(key: key);
+Decoding now uses sync interface (without `Future`).
 
-  @override
-  Widget build(BuildContext context) => MaterialApp(
-    home: Scaffold(
-      appBar: AppBar(title: const Text("BlurHash")),
-      body: const SizedBox.expand(
-        child: Center(
-          child: AspectRatio(
-            aspectRatio: 1.6,
-            child: BlurhashFfi(hash: "L5H2EC=PM+yV0g-mq.wG9c010J}I"),
-          ),
-        ),
-      ),
-    ),
-  );
-}
-
-/// 2. Using the `BlurhashFfiImage` ImageProvider
-final imageProvider = BlurhashFfiImage("L5H2EC=PM+yV0g-mq.wG9c010J}I");
-class BlurHashApp2 extends StatelessWidget {
-  const BlurHashApp2({Key? key}) : super(key: key);
+```dart
+import 'package:dart_blurhash_ffi/dart_blurhash_ffi.dart';
 
-  @override
-  Widget build(BuildContext context) => MaterialApp(
-    home: Scaffold(
-      appBar: AppBar(title: const Text("BlurHash")),
-      body: const SizedBox.expand(
-        child: Center(
-          child: AspectRatio(
-            aspectRatio: 1.6,
-            child: Image(
-              image: imageProvider,
-              fit: BoxFit.cover, 
-            ),
-          ),
-        ),
-      ),
-    ),
-  );
-}
+final String blurhash = 'LGFO~6Yk^6#M@-5c,1Ex@@or[j6o';
 
-/// 3. Using the `BlurhashFfi.decode` static method which returns dart:ui.Image
-/// Signature 
-/// static Future<ui.Image> decode(
-///   String blurHash, {
+/// Signature
+///
+/// static Uint8List decode(
+///   String blurhash, {
 ///   int width = 32,
 ///   int height = 32,
 ///   int punch = 1,
 /// })
 /// may throw `BlurhashFFIException` if decoding fails.
-final ui.Image image = await BlurhashFFI.decode("L5H2EC=PM+yV0g-mq.wG9c010J}I");
-```
+final decoded = BlurhashFFI.decode(blurhash);
 
-**Release Isolate and it's memory**
+// or via codec
 
-do this only when you are done with encoding/decoding blurhashes
-```dart
-import 'package:blurhash_ffi/blurhash_ffi.dart';
-
-BlurhashFFi.free();
+final String decodedSame = BlurhashFfiCodec().decoder.convert(blurhash);
 
 ```
-check the [example](./example/) for more details
+
+Check the [example](./packages/flutter_blurhash_ffi/example/) for more details
 
 **contributions in the form of PR's and Issues are a welcome**