bump: 0.0.7

This commit is contained in:
Kingtous 2023-02-20 15:42:22 +08:00
parent 4f059a9138
commit 0cda2d38d4
8 changed files with 144 additions and 66 deletions

View file

@ -1,3 +1,6 @@
## 0.0.7
* add the FFI function and ptr getter for macOS.
## 0.0.6 ## 0.0.6
* Please use `BGRA` format instead. * Please use `BGRA` format instead.
* Memory leak fix for Linux. * Memory leak fix for Linux.

View file

@ -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`. The plugin aims to provide opengl impl for the texture, which bring a better performance instead of `FFI` + `CustomPainter`.
- [x] Linux - [x] Linux
- [x] Windows (No gpu acceleration yet due to the limitation of Flutter.) - [x] Windows
```c++
// The available texture variants.
// Only PixelBufferTexture is currently implemented.
// Other variants are expected to be added in the future.
typedef std::variant<PixelBufferTexture, GpuSurfaceTexture> TextureVariant;
```
- [x] MacOS - [x] MacOS
Note: Please use the `BGRA` format. Note: Please use the `BGRA` format for ALL platforms.
## Getting Started ## Getting Started
@ -61,6 +53,13 @@ Check the example for details.
## API ## 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 ```dart
class TextureRgbaRenderer { class TextureRgbaRenderer {
@ -85,12 +84,61 @@ class TextureRgbaRenderer {
Future<bool> onRgba(int key, Uint8List data, int height, int width) { Future<bool> onRgba(int key, Uint8List data, int height, int width) {
return TextureRgbaRendererPlatform.instance.onRgba(key, data, height, width); return TextureRgbaRendererPlatform.instance.onRgba(key, data, height, width);
} }
/// For native API.
Future<int> 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<Void> ptr, Pointer<Uint8> buffer, Int32 width, Int32 height);
typedef F1Dart = void Function(
Pointer<Void> ptr, Pointer<Uint8> 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<F1, F1Dart>("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 ## Thanks
- [Flutter](https://github.com/flutter/flutter) - [Flutter](https://github.com/flutter/flutter)
- [Flutter Engine](https://github.com/flutter/engine)
- [Dart VLC](https://github.com/alexmercerind/dart_vlc) - [Dart VLC](https://github.com/alexmercerind/dart_vlc)
## License ## License

View file

@ -9,28 +9,7 @@ import 'dart:async';
import 'package:flutter/services.dart'; import 'package:flutter/services.dart';
import 'package:texture_rgba_renderer/texture_rgba_renderer.dart'; import 'package:texture_rgba_renderer/texture_rgba_renderer.dart';
typedef F1 = Void Function(
Pointer<Void> ptr, Pointer<Uint8> buffer, Int32 width, Int32 height);
typedef F1Dart = void Function(
Pointer<Void> ptr, Pointer<Uint8> 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<F1, F1Dart>("FlutterRgbaRendererPluginOnRgba");
}
}
void main() { void main() {
// Load the native instance.
final instance = Native.instance;
runApp(const MyApp()); runApp(const MyApp());
} }
@ -51,6 +30,7 @@ class _MyAppState extends State<MyApp> {
int texturePtr = 0; int texturePtr = 0;
final random = Random(); final random = Random();
Uint8List? data; Uint8List? data;
Timer? _timer;
@override @override
void initState() { void initState() {
@ -75,7 +55,8 @@ class _MyAppState extends State<MyApp> {
void start() { void start() {
debugPrint("start mockPic"); 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); // data = mockPicture(width, height);
// Method.1: with MethodChannel // Method.1: with MethodChannel
// final res = // final res =
@ -93,6 +74,7 @@ class _MyAppState extends State<MyApp> {
@override @override
void dispose() { void dispose() {
_timer?.cancel();
if (key != -1) { if (key != -1) {
_textureRgbaRendererPlugin.closeTexture(key); _textureRgbaRendererPlugin.closeTexture(key);
} }
@ -110,20 +92,19 @@ class _MyAppState extends State<MyApp> {
final pic = List.generate(width * height * 4, (index) { final pic = List.generate(width * height * 4, (index) {
return random.nextInt(255); return random.nextInt(255);
}); });
final pic_addr = malloc.allocate(pic.length).cast<Uint8>(); final picAddr = malloc.allocate(pic.length).cast<Uint8>();
final list = pic_addr.asTypedList(pic.length); final list = picAddr.asTypedList(pic.length);
list.setRange(0, pic.length, pic); list.setRange(0, pic.length, pic);
return pic_addr; return picAddr;
} }
@override @override
Widget build(BuildContext context) { Widget build(BuildContext context) {
return MaterialApp( return MaterialApp(
home: Scaffold( home: Scaffold(
appBar: AppBar( body: Column(
title: const Text('Plugin example app'), crossAxisAlignment: CrossAxisAlignment.center,
), mainAxisAlignment: MainAxisAlignment.center,
body: Stack(
children: [ children: [
textureId == -1 textureId == -1
? const Offstage() ? const Offstage()
@ -135,18 +116,12 @@ class _MyAppState extends State<MyApp> {
height: height.toDouble(), height: height.toDouble(),
child: Texture(textureId: textureId)), child: Texture(textureId: textureId)),
), ),
Align( Text(
alignment: Alignment.topLeft,
child: Text(
"texture id: $textureId, texture memory address: ${texturePtr.toRadixString(16)}"), "texture id: $textureId, texture memory address: ${texturePtr.toRadixString(16)}"),
), IconButton(
Align(
alignment: Alignment.bottomCenter,
child: IconButton(
icon: const Icon(Icons.play_arrow), icon: const Icon(Icons.play_arrow),
onPressed: start, onPressed: start,
), ),
)
], ],
), ),
), ),

View file

@ -5,20 +5,23 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: async name: async
sha256: bfe67ef28df125b7dddcea62755991f807aa39a2492a23e1550161692950bbe0
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "2.9.0" version: "2.10.0"
boolean_selector: boolean_selector:
dependency: transitive dependency: transitive
description: description:
name: boolean_selector name: boolean_selector
sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66"
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "2.1.0" version: "2.1.1"
characters: characters:
dependency: transitive dependency: transitive
description: description:
name: characters name: characters
sha256: e6a326c8af69605aec75ed6c187d06b349707a27fbff8222ca9cc2cff167975c
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.2.1" version: "1.2.1"
@ -26,6 +29,7 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: clock name: clock
sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.1.1" version: "1.1.1"
@ -33,13 +37,15 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: collection name: collection
sha256: cfc915e6923fe5ce6e153b0723c753045de46de1b4d63771530504004a45fae0
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.16.0" version: "1.17.0"
cupertino_icons: cupertino_icons:
dependency: "direct main" dependency: "direct main"
description: description:
name: cupertino_icons name: cupertino_icons
sha256: e35129dc44c9118cee2a5603506d823bab99c68393879edb440e0090d07586be
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.0.5" version: "1.0.5"
@ -47,6 +53,7 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: fake_async name: fake_async
sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78"
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.3.1" version: "1.3.1"
@ -54,6 +61,7 @@ packages:
dependency: "direct main" dependency: "direct main"
description: description:
name: ffi name: ffi
sha256: a38574032c5f1dd06c4aee541789906c12ccaab8ba01446e800d9c5b79c4a978
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "2.0.1" version: "2.0.1"
@ -66,6 +74,7 @@ packages:
dependency: "direct dev" dependency: "direct dev"
description: description:
name: flutter_lints name: flutter_lints
sha256: aeb0b80a8b3709709c9cc496cdc027c5b3216796bc0af0ce1007eaf24464fd4c
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "2.0.1" version: "2.0.1"
@ -74,10 +83,19 @@ packages:
description: flutter description: flutter
source: sdk source: sdk
version: "0.0.0" 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: lints:
dependency: transitive dependency: transitive
description: description:
name: lints name: lints
sha256: "5e4a9cd06d447758280a8ac2405101e0e2094d2a1dbdd3756aec3fe7775ba593"
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "2.0.1" version: "2.0.1"
@ -85,20 +103,23 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: matcher name: matcher
sha256: "16db949ceee371e9b99d22f88fa3a73c4e59fd0afed0bd25fc336eb76c198b72"
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "0.12.12" version: "0.12.13"
material_color_utilities: material_color_utilities:
dependency: transitive dependency: transitive
description: description:
name: material_color_utilities name: material_color_utilities
sha256: d92141dc6fe1dad30722f9aa826c7fbc896d021d792f80678280601aff8cf724
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "0.1.5" version: "0.2.0"
meta: meta:
dependency: transitive dependency: transitive
description: description:
name: meta name: meta
sha256: "6c268b42ed578a53088d834796959e4a1814b5e9e164f147f580a386e5decf42"
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.8.0" version: "1.8.0"
@ -106,6 +127,7 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: path name: path
sha256: db9d4f58c908a4ba5953fcee2ae317c94889433e5024c27ce74a37f94267945b
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.8.2" version: "1.8.2"
@ -113,6 +135,7 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: plugin_platform_interface name: plugin_platform_interface
sha256: dbf0f707c78beedc9200146ad3cb0ab4d5da13c246336987be6940f026500d3a
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "2.1.3" version: "2.1.3"
@ -125,34 +148,39 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: source_span name: source_span
sha256: dd904f795d4b4f3b870833847c461801f6750a9fa8e61ea5ac53f9422b31f250
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.9.0" version: "1.9.1"
stack_trace: stack_trace:
dependency: transitive dependency: transitive
description: description:
name: stack_trace name: stack_trace
sha256: c3c7d8edb15bee7f0f74debd4b9c5f3c2ea86766fe4178eb2a18eb30a0bdaed5
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.10.0" version: "1.11.0"
stream_channel: stream_channel:
dependency: transitive dependency: transitive
description: description:
name: stream_channel name: stream_channel
sha256: "83615bee9045c1d322bbbd1ba209b7a749c2cbcdcb3fdd1df8eb488b3279c1c8"
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "2.1.0" version: "2.1.1"
string_scanner: string_scanner:
dependency: transitive dependency: transitive
description: description:
name: string_scanner name: string_scanner
sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.1.1" version: "1.2.0"
term_glyph: term_glyph:
dependency: transitive dependency: transitive
description: description:
name: term_glyph name: term_glyph
sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "1.2.1" version: "1.2.1"
@ -160,23 +188,25 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: test_api name: test_api
sha256: ad540f65f92caa91bf21dfc8ffb8c589d6e4dc0c2267818b4cc2792857706206
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "0.4.12" version: "0.4.16"
texture_rgba_renderer: texture_rgba_renderer:
dependency: "direct main" dependency: "direct main"
description: description:
path: ".." path: ".."
relative: true relative: true
source: path source: path
version: "0.0.6" version: "0.0.7"
vector_math: vector_math:
dependency: transitive dependency: transitive
description: description:
name: vector_math name: vector_math
sha256: "80b3257d1492ce4d091729e3a67a60407d227c27241d6927be0130c98e741803"
url: "https://pub.flutter-io.cn" url: "https://pub.flutter-io.cn"
source: hosted source: hosted
version: "2.1.2" version: "2.1.4"
sdks: sdks:
dart: ">=2.17.0 <3.0.0" dart: ">=2.18.0 <3.0.0"
flutter: ">=2.5.0" flutter: ">=2.5.0"

20
lib/texture_rgba_ffi.dart Normal file
View file

@ -0,0 +1,20 @@
import 'dart:ffi';
typedef F1 = Void Function(
Pointer<Void> ptr, Pointer<Uint8> buffer, Int32 width, Int32 height);
typedef F1Dart = void Function(
Pointer<Void> ptr, Pointer<Uint8> 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<F1, F1Dart>("FlutterRgbaRendererPluginOnRgba");
}
}

View file

@ -1,5 +1,7 @@
import 'dart:typed_data'; import 'dart:typed_data';
export './texture_rgba_ffi.dart';
import 'texture_rgba_renderer_platform_interface.dart'; import 'texture_rgba_renderer_platform_interface.dart';
class TextureRgbaRenderer { class TextureRgbaRenderer {

View file

@ -1,7 +1,7 @@
// ignore: unused_import // ignore: unused_import, unnecessary_import
import 'dart:io'; import 'dart:io';
// Compatible with lint in Flutter 3.0.5 // Compatible with lint in Flutter 3.0.5
// ignore: unused_import // ignore: unused_import, unnecessary_import
import 'dart:typed_data'; import 'dart:typed_data';
import 'package:flutter/foundation.dart'; import 'package:flutter/foundation.dart';

View file

@ -1,6 +1,6 @@
name: texture_rgba_renderer name: texture_rgba_renderer
description: A texture helper which brings a high level api to handle BGRA data. 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 homepage: https://github.com/Kingtous/flutter_texture_rgba_renderer
environment: environment: