From 0cda2d38d4f28da190ca043516ea8ed21a4c21fe Mon Sep 17 00:00:00 2001 From: Kingtous Date: Mon, 20 Feb 2023 15:42:22 +0800 Subject: [PATCH] bump: 0.0.7 --- CHANGELOG.md | 3 + README.md | 68 ++++++++++++++++--- example/lib/main.dart | 55 ++++----------- example/pubspec.lock | 56 +++++++++++---- lib/texture_rgba_ffi.dart | 20 ++++++ lib/texture_rgba_renderer.dart | 2 + lib/texture_rgba_renderer_method_channel.dart | 4 +- pubspec.yaml | 2 +- 8 files changed, 144 insertions(+), 66 deletions(-) create mode 100644 lib/texture_rgba_ffi.dart diff --git a/CHANGELOG.md b/CHANGELOG.md index cd617fa..777106b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 0.0.7 +* add the FFI function and ptr getter for macOS. + ## 0.0.6 * Please use `BGRA` format instead. * Memory leak fix for Linux. diff --git a/README.md b/README.md index 46eb771..ed2bded 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,10 @@ A texture helper which brings a high level api to handle **BGRA** data. No frame The plugin aims to provide opengl impl for the texture, which bring a better performance instead of `FFI` + `CustomPainter`. - [x] Linux -- [x] Windows (No gpu acceleration yet due to the limitation of Flutter.) - -```c++ -// The available texture variants. -// Only PixelBufferTexture is currently implemented. -// Other variants are expected to be added in the future. -typedef std::variant TextureVariant; -``` - +- [x] Windows - [x] MacOS -Note: Please use the `BGRA` format. +Note: Please use the `BGRA` format for ALL platforms. ## Getting Started @@ -61,6 +53,13 @@ Check the example for details. ## API +To improving better convienent interface for both dart and native developers, the plugin provides two kinds of APi to render the frame. + + +### Dart API + +You can create/close a texure with the dart API provided by this plugin. And you can also provide the BGRA data to the texure via `onRgba` function. + ```dart class TextureRgbaRenderer { @@ -85,12 +84,61 @@ class TextureRgbaRenderer { Future onRgba(int key, Uint8List data, int height, int width) { return TextureRgbaRendererPlatform.instance.onRgba(key, data, height, width); } + + /// For native API. + Future getTexturePtr(int key) async { + final ptr = + await methodChannel.invokeMethod('getTexturePtr', {"key": key}) ?? + false; + return ptr; + } } ``` +## Native API + +Note that the `onRgba` function is not called immediately. It depends on the execution scheduler of Flutter. To solve the problem, the plugin provide the low level function on all 3 pc platforms, which can make them be executed immediately. + +```c +void FlutterRgbaRendererPluginOnRgba(void* texture_rgba_ptr, const uint8_t* buffer, int width, int height) +``` + +You could use the native API in other programing languages. A dart quick example: + +```dart +/// The `Native` class is bundled in this plugin. +typedef F1 = Void Function( + Pointer ptr, Pointer buffer, Int32 width, Int32 height); +typedef F1Dart = void Function( + Pointer ptr, Pointer buffer, int width, int height); + +class Native { + Native._(); + + static Native get _instance => Native._()..init(); + static Native get instance => _instance; + + late F1Dart onRgba; + + init() { + final lib = DynamicLibrary.process(); + onRgba = lib.lookupFunction("FlutterRgbaRendererPluginOnRgba"); + } +} +... + +// Call +Native.instance.onRgba(ptr_from_method_getTexturePtr, bgra_data, width, height); +``` + +Note that the `buffer` is not taken by the plugin, you should handle the lifecycle of the `buffer` yourself. + +Both example usages of two kinds of `onRgba` can be found in `example` folder. + ## Thanks - [Flutter](https://github.com/flutter/flutter) +- [Flutter Engine](https://github.com/flutter/engine) - [Dart VLC](https://github.com/alexmercerind/dart_vlc) ## License diff --git a/example/lib/main.dart b/example/lib/main.dart index b802b36..5b247c8 100644 --- a/example/lib/main.dart +++ b/example/lib/main.dart @@ -9,28 +9,7 @@ import 'dart:async'; import 'package:flutter/services.dart'; import 'package:texture_rgba_renderer/texture_rgba_renderer.dart'; -typedef F1 = Void Function( - Pointer ptr, Pointer buffer, Int32 width, Int32 height); -typedef F1Dart = void Function( - Pointer ptr, Pointer buffer, int width, int height); - -class Native { - Native._(); - - static get _instance => Native._()..init(); - static get instance => _instance; - - late F1Dart onRgba; - - init() { - final lib = DynamicLibrary.process(); - onRgba = lib.lookupFunction("FlutterRgbaRendererPluginOnRgba"); - } -} - void main() { - // Load the native instance. - final instance = Native.instance; runApp(const MyApp()); } @@ -51,6 +30,7 @@ class _MyAppState extends State { int texturePtr = 0; final random = Random(); Uint8List? data; + Timer? _timer; @override void initState() { @@ -75,7 +55,8 @@ class _MyAppState extends State { void start() { debugPrint("start mockPic"); - Timer.periodic(const Duration(milliseconds: 30), (timer) async { + _timer?.cancel(); + _timer = Timer.periodic(const Duration(milliseconds: 30), (timer) async { // data = mockPicture(width, height); // Method.1: with MethodChannel // final res = @@ -93,6 +74,7 @@ class _MyAppState extends State { @override void dispose() { + _timer?.cancel(); if (key != -1) { _textureRgbaRendererPlugin.closeTexture(key); } @@ -110,20 +92,19 @@ class _MyAppState extends State { final pic = List.generate(width * height * 4, (index) { return random.nextInt(255); }); - final pic_addr = malloc.allocate(pic.length).cast(); - final list = pic_addr.asTypedList(pic.length); + final picAddr = malloc.allocate(pic.length).cast(); + final list = picAddr.asTypedList(pic.length); list.setRange(0, pic.length, pic); - return pic_addr; + return picAddr; } @override Widget build(BuildContext context) { return MaterialApp( home: Scaffold( - appBar: AppBar( - title: const Text('Plugin example app'), - ), - body: Stack( + body: Column( + crossAxisAlignment: CrossAxisAlignment.center, + mainAxisAlignment: MainAxisAlignment.center, children: [ textureId == -1 ? const Offstage() @@ -135,18 +116,12 @@ class _MyAppState extends State { height: height.toDouble(), child: Texture(textureId: textureId)), ), - Align( - alignment: Alignment.topLeft, - child: Text( - "texture id: $textureId, texture memory address: ${texturePtr.toRadixString(16)}"), + Text( + "texture id: $textureId, texture memory address: ${texturePtr.toRadixString(16)}"), + IconButton( + icon: const Icon(Icons.play_arrow), + onPressed: start, ), - Align( - alignment: Alignment.bottomCenter, - child: IconButton( - icon: const Icon(Icons.play_arrow), - onPressed: start, - ), - ) ], ), ), diff --git a/example/pubspec.lock b/example/pubspec.lock index 8b2f832..b997cd3 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -5,20 +5,23 @@ packages: dependency: transitive description: name: async + sha256: bfe67ef28df125b7dddcea62755991f807aa39a2492a23e1550161692950bbe0 url: "https://pub.flutter-io.cn" source: hosted - version: "2.9.0" + version: "2.10.0" boolean_selector: dependency: transitive description: name: boolean_selector + sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66" url: "https://pub.flutter-io.cn" source: hosted - version: "2.1.0" + version: "2.1.1" characters: dependency: transitive description: name: characters + sha256: e6a326c8af69605aec75ed6c187d06b349707a27fbff8222ca9cc2cff167975c url: "https://pub.flutter-io.cn" source: hosted version: "1.2.1" @@ -26,6 +29,7 @@ packages: dependency: transitive description: name: clock + sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf url: "https://pub.flutter-io.cn" source: hosted version: "1.1.1" @@ -33,13 +37,15 @@ packages: dependency: transitive description: name: collection + sha256: cfc915e6923fe5ce6e153b0723c753045de46de1b4d63771530504004a45fae0 url: "https://pub.flutter-io.cn" source: hosted - version: "1.16.0" + version: "1.17.0" cupertino_icons: dependency: "direct main" description: name: cupertino_icons + sha256: e35129dc44c9118cee2a5603506d823bab99c68393879edb440e0090d07586be url: "https://pub.flutter-io.cn" source: hosted version: "1.0.5" @@ -47,6 +53,7 @@ packages: dependency: transitive description: name: fake_async + sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78" url: "https://pub.flutter-io.cn" source: hosted version: "1.3.1" @@ -54,6 +61,7 @@ packages: dependency: "direct main" description: name: ffi + sha256: a38574032c5f1dd06c4aee541789906c12ccaab8ba01446e800d9c5b79c4a978 url: "https://pub.flutter-io.cn" source: hosted version: "2.0.1" @@ -66,6 +74,7 @@ packages: dependency: "direct dev" description: name: flutter_lints + sha256: aeb0b80a8b3709709c9cc496cdc027c5b3216796bc0af0ce1007eaf24464fd4c url: "https://pub.flutter-io.cn" source: hosted version: "2.0.1" @@ -74,10 +83,19 @@ packages: description: flutter source: sdk version: "0.0.0" + js: + dependency: transitive + description: + name: js + sha256: "5528c2f391ededb7775ec1daa69e65a2d61276f7552de2b5f7b8d34ee9fd4ab7" + url: "https://pub.flutter-io.cn" + source: hosted + version: "0.6.5" lints: dependency: transitive description: name: lints + sha256: "5e4a9cd06d447758280a8ac2405101e0e2094d2a1dbdd3756aec3fe7775ba593" url: "https://pub.flutter-io.cn" source: hosted version: "2.0.1" @@ -85,20 +103,23 @@ packages: dependency: transitive description: name: matcher + sha256: "16db949ceee371e9b99d22f88fa3a73c4e59fd0afed0bd25fc336eb76c198b72" url: "https://pub.flutter-io.cn" source: hosted - version: "0.12.12" + version: "0.12.13" material_color_utilities: dependency: transitive description: name: material_color_utilities + sha256: d92141dc6fe1dad30722f9aa826c7fbc896d021d792f80678280601aff8cf724 url: "https://pub.flutter-io.cn" source: hosted - version: "0.1.5" + version: "0.2.0" meta: dependency: transitive description: name: meta + sha256: "6c268b42ed578a53088d834796959e4a1814b5e9e164f147f580a386e5decf42" url: "https://pub.flutter-io.cn" source: hosted version: "1.8.0" @@ -106,6 +127,7 @@ packages: dependency: transitive description: name: path + sha256: db9d4f58c908a4ba5953fcee2ae317c94889433e5024c27ce74a37f94267945b url: "https://pub.flutter-io.cn" source: hosted version: "1.8.2" @@ -113,6 +135,7 @@ packages: dependency: transitive description: name: plugin_platform_interface + sha256: dbf0f707c78beedc9200146ad3cb0ab4d5da13c246336987be6940f026500d3a url: "https://pub.flutter-io.cn" source: hosted version: "2.1.3" @@ -125,34 +148,39 @@ packages: dependency: transitive description: name: source_span + sha256: dd904f795d4b4f3b870833847c461801f6750a9fa8e61ea5ac53f9422b31f250 url: "https://pub.flutter-io.cn" source: hosted - version: "1.9.0" + version: "1.9.1" stack_trace: dependency: transitive description: name: stack_trace + sha256: c3c7d8edb15bee7f0f74debd4b9c5f3c2ea86766fe4178eb2a18eb30a0bdaed5 url: "https://pub.flutter-io.cn" source: hosted - version: "1.10.0" + version: "1.11.0" stream_channel: dependency: transitive description: name: stream_channel + sha256: "83615bee9045c1d322bbbd1ba209b7a749c2cbcdcb3fdd1df8eb488b3279c1c8" url: "https://pub.flutter-io.cn" source: hosted - version: "2.1.0" + version: "2.1.1" string_scanner: dependency: transitive description: name: string_scanner + sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde" url: "https://pub.flutter-io.cn" source: hosted - version: "1.1.1" + version: "1.2.0" term_glyph: dependency: transitive description: name: term_glyph + sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84 url: "https://pub.flutter-io.cn" source: hosted version: "1.2.1" @@ -160,23 +188,25 @@ packages: dependency: transitive description: name: test_api + sha256: ad540f65f92caa91bf21dfc8ffb8c589d6e4dc0c2267818b4cc2792857706206 url: "https://pub.flutter-io.cn" source: hosted - version: "0.4.12" + version: "0.4.16" texture_rgba_renderer: dependency: "direct main" description: path: ".." relative: true source: path - version: "0.0.6" + version: "0.0.7" vector_math: dependency: transitive description: name: vector_math + sha256: "80b3257d1492ce4d091729e3a67a60407d227c27241d6927be0130c98e741803" url: "https://pub.flutter-io.cn" source: hosted - version: "2.1.2" + version: "2.1.4" sdks: - dart: ">=2.17.0 <3.0.0" + dart: ">=2.18.0 <3.0.0" flutter: ">=2.5.0" diff --git a/lib/texture_rgba_ffi.dart b/lib/texture_rgba_ffi.dart new file mode 100644 index 0000000..f9dea82 --- /dev/null +++ b/lib/texture_rgba_ffi.dart @@ -0,0 +1,20 @@ +import 'dart:ffi'; + +typedef F1 = Void Function( + Pointer ptr, Pointer buffer, Int32 width, Int32 height); +typedef F1Dart = void Function( + Pointer ptr, Pointer buffer, int width, int height); + +class Native { + Native._(); + + static Native get _instance => Native._()..init(); + static Native get instance => _instance; + + late F1Dart onRgba; + + init() { + final lib = DynamicLibrary.process(); + onRgba = lib.lookupFunction("FlutterRgbaRendererPluginOnRgba"); + } +} \ No newline at end of file diff --git a/lib/texture_rgba_renderer.dart b/lib/texture_rgba_renderer.dart index 4fb4b94..3be03b0 100644 --- a/lib/texture_rgba_renderer.dart +++ b/lib/texture_rgba_renderer.dart @@ -1,5 +1,7 @@ import 'dart:typed_data'; +export './texture_rgba_ffi.dart'; + import 'texture_rgba_renderer_platform_interface.dart'; class TextureRgbaRenderer { diff --git a/lib/texture_rgba_renderer_method_channel.dart b/lib/texture_rgba_renderer_method_channel.dart index 693c2c4..0078f18 100644 --- a/lib/texture_rgba_renderer_method_channel.dart +++ b/lib/texture_rgba_renderer_method_channel.dart @@ -1,7 +1,7 @@ -// ignore: unused_import +// ignore: unused_import, unnecessary_import import 'dart:io'; // Compatible with lint in Flutter 3.0.5 -// ignore: unused_import +// ignore: unused_import, unnecessary_import import 'dart:typed_data'; import 'package:flutter/foundation.dart'; diff --git a/pubspec.yaml b/pubspec.yaml index c793ddc..9a08074 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: texture_rgba_renderer description: A texture helper which brings a high level api to handle BGRA data. -version: 0.0.6 +version: 0.0.7 homepage: https://github.com/Kingtous/flutter_texture_rgba_renderer environment: