add support for avif images

Fixes #138
This commit is contained in:
Henry Hiles 2026-10-16 20:35:42 -04:00
commit 6d42477041
Signed by: Henry-Hiles
SSH key fingerprint: SHA256:VKQUdS31Q90KvX7EkKMHMBpUspcmItAh86a+v7PGiIs
10 changed files with 219 additions and 8 deletions

View file

@ -16,6 +16,23 @@ subprojects {
project.layout.buildDirectory.value(newSubprojectBuildDir) project.layout.buildDirectory.value(newSubprojectBuildDir)
} }
subprojects {
if (name == "flutter_avif_android") {
tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach {
exclude("**/FlutterAvifPlugin.kt")
}
afterEvaluate {
extensions.configure<com.android.build.api.dsl.LibraryExtension> {
compileSdk = 36
compileOptions {
sourceCompatibility = JavaVersion.VERSION_21
targetCompatibility = JavaVersion.VERSION_21
}
}
}
}
}
subprojects { subprojects {
project.evaluationDependsOn(":app") project.evaluationDependsOn(":app")
} }

View file

@ -1,6 +1,8 @@
import "dart:ui"; import "dart:io";
import "dart:ui" as ui;
import "package:flutter/widgets.dart"; import "package:flutter/widgets.dart";
import "package:flutter_avif/flutter_avif.dart";
import "package:flutter_riverpod/flutter_riverpod.dart"; import "package:flutter_riverpod/flutter_riverpod.dart";
import "package:nexus/controllers/client.dart"; import "package:nexus/controllers/client.dart";
import "package:nexus/models/requests/download_media.dart"; import "package:nexus/models/requests/download_media.dart";
@ -15,13 +17,23 @@ class MxcImage(final WidgetRef ref, final DownloadMediaRequest request)
ImageStreamCompleter loadImage(MxcImage key, ImageDecoderCallback decode) => ImageStreamCompleter loadImage(MxcImage key, ImageDecoderCallback decode) =>
MultiFrameImageStreamCompleter(codec: _loadAsync(decode), scale: 1.0); MultiFrameImageStreamCompleter(codec: _loadAsync(decode), scale: 1.0);
Future<Codec> _loadAsync(ImageDecoderCallback decode) async { Future<ui.Codec> _loadAsync(ImageDecoderCallback decode) async {
final file = await ref final file = await ref
.read(ClientController.provider.notifier) .read(ClientController.provider.notifier)
.downloadMedia(request); .downloadMedia(request);
final buffer = await ImmutableBuffer.fromFilePath(file.path); final bytes = await File(file.path).readAsBytes();
return decode(buffer); // Flutter can't decode AVIF on Linux/Windows (or older Android/iOS), so we do it ourselves
final avifType = isAvifFile(bytes.sublist(0, 16.clamp(0, bytes.length)));
if (avifType != .unknown) {
final codec = avifType == .avif
? SingleFrameAvifCodec(bytes: bytes)
: MultiFrameAvifCodec(key: hashCode, avifBytes: bytes);
await codec.ready();
return AvifCodecAdapter(codec);
}
return decode(await ui.ImmutableBuffer.fromUint8List(bytes));
} }
@override @override
@ -31,3 +43,25 @@ class MxcImage(final WidgetRef ref, final DownloadMediaRequest request)
@override @override
int get hashCode => request.hashCode; int get hashCode => request.hashCode;
} }
class AvifCodecAdapter(final AvifCodec codec) implements ui.Codec {
@override
int get frameCount => codec.frameCount;
@override
int get repetitionCount => frameCount > 1 ? -1 : 0;
@override
Future<ui.FrameInfo> getNextFrame() async {
final frame = await codec.getNextFrame();
return AvifFrameInfo(frame.duration, frame.image);
}
@override
void dispose() => codec.dispose();
}
class AvifFrameInfo(
@override final Duration duration,
@override final ui.Image image,
) implements ui.FrameInfo;

View file

@ -9,6 +9,7 @@
#include <app_links_linux/app_links_plugin_linux.h> #include <app_links_linux/app_links_plugin_linux.h>
#include <dynamic_color/dynamic_color_plugin.h> #include <dynamic_color/dynamic_color_plugin.h>
#include <file_selector_linux/file_selector_plugin.h> #include <file_selector_linux/file_selector_plugin.h>
#include <flutter_avif_linux/flutter_avif_linux_plugin.h>
#include <media_kit_libs_linux/media_kit_libs_linux_plugin.h> #include <media_kit_libs_linux/media_kit_libs_linux_plugin.h>
#include <media_kit_video/media_kit_video_plugin.h> #include <media_kit_video/media_kit_video_plugin.h>
#include <pasteboard/pasteboard_plugin.h> #include <pasteboard/pasteboard_plugin.h>
@ -27,6 +28,9 @@ void fl_register_plugins(FlPluginRegistry* registry) {
g_autoptr(FlPluginRegistrar) file_selector_linux_registrar = g_autoptr(FlPluginRegistrar) file_selector_linux_registrar =
fl_plugin_registry_get_registrar_for_plugin(registry, "FileSelectorPlugin"); fl_plugin_registry_get_registrar_for_plugin(registry, "FileSelectorPlugin");
file_selector_plugin_register_with_registrar(file_selector_linux_registrar); file_selector_plugin_register_with_registrar(file_selector_linux_registrar);
g_autoptr(FlPluginRegistrar) flutter_avif_linux_registrar =
fl_plugin_registry_get_registrar_for_plugin(registry, "FlutterAvifLinuxPlugin");
flutter_avif_linux_plugin_register_with_registrar(flutter_avif_linux_registrar);
g_autoptr(FlPluginRegistrar) media_kit_libs_linux_registrar = g_autoptr(FlPluginRegistrar) media_kit_libs_linux_registrar =
fl_plugin_registry_get_registrar_for_plugin(registry, "MediaKitLibsLinuxPlugin"); fl_plugin_registry_get_registrar_for_plugin(registry, "MediaKitLibsLinuxPlugin");
media_kit_libs_linux_plugin_register_with_registrar(media_kit_libs_linux_registrar); media_kit_libs_linux_plugin_register_with_registrar(media_kit_libs_linux_registrar);

View file

@ -6,6 +6,7 @@ list(APPEND FLUTTER_PLUGIN_LIST
app_links_linux app_links_linux
dynamic_color dynamic_color
file_selector_linux file_selector_linux
flutter_avif_linux
media_kit_libs_linux media_kit_libs_linux
media_kit_video media_kit_video
pasteboard pasteboard

View file

@ -9,6 +9,7 @@ let
]; ];
cmakeVersions = [ "3.22.1" ]; cmakeVersions = [ "3.22.1" ];
platformVersions = [ platformVersions = [
"31"
"34" "34"
"36" "36"
]; ];
@ -47,7 +48,17 @@ pkgs.mkShell {
GRADLE_OPTS = "-Dorg.gradle.project.android.aapt2FromMavenOverride=${ANDROID_HOME}/build-tools/36.0.0/aapt2"; GRADLE_OPTS = "-Dorg.gradle.project.android.aapt2FromMavenOverride=${ANDROID_HOME}/build-tools/36.0.0/aapt2";
} }
// lib.optionalAttrs pkgs.stdenv.isLinux { // lib.optionalAttrs pkgs.stdenv.isLinux (
LD_LIBRARY_PATH = "./build/native_assets/linux:${lib.makeLibraryPath [ pkgs.zlib ]}"; let
}; arch = if pkgs.stdenv.hostPlatform.isAarch64 then "arm64" else "x64";
in
{
LD_LIBRARY_PATH = lib.concatStringsSep ":" [
"./build/native_assets/linux"
"./build/linux/${arch}/debug/bundle/lib"
"./build/linux/${arch}/release/bundle/lib"
(lib.makeLibraryPath [ pkgs.zlib ])
];
}
);
} }

View file

@ -8,6 +8,7 @@ import Foundation
import app_links import app_links
import dynamic_color import dynamic_color
import file_selector_macos import file_selector_macos
import flutter_avif_macos
import flutter_local_notifications import flutter_local_notifications
import media_kit_libs_macos_video import media_kit_libs_macos_video
import media_kit_video import media_kit_video
@ -15,6 +16,7 @@ import package_info_plus
import pasteboard import pasteboard
import screen_retriever_macos import screen_retriever_macos
import shared_preferences_foundation import shared_preferences_foundation
import sqflite_darwin
import url_launcher_macos import url_launcher_macos
import wakelock_plus import wakelock_plus
import webcrypto import webcrypto
@ -24,6 +26,7 @@ func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
AppLinksMacosPlugin.register(with: registry.registrar(forPlugin: "AppLinksMacosPlugin")) AppLinksMacosPlugin.register(with: registry.registrar(forPlugin: "AppLinksMacosPlugin"))
DynamicColorPlugin.register(with: registry.registrar(forPlugin: "DynamicColorPlugin")) DynamicColorPlugin.register(with: registry.registrar(forPlugin: "DynamicColorPlugin"))
FileSelectorPlugin.register(with: registry.registrar(forPlugin: "FileSelectorPlugin")) FileSelectorPlugin.register(with: registry.registrar(forPlugin: "FileSelectorPlugin"))
FlutterAvifPlugin.register(with: registry.registrar(forPlugin: "FlutterAvifPlugin"))
FlutterLocalNotificationsPlugin.register(with: registry.registrar(forPlugin: "FlutterLocalNotificationsPlugin")) FlutterLocalNotificationsPlugin.register(with: registry.registrar(forPlugin: "FlutterLocalNotificationsPlugin"))
MediaKitLibsMacosVideoPlugin.register(with: registry.registrar(forPlugin: "MediaKitLibsMacosVideoPlugin")) MediaKitLibsMacosVideoPlugin.register(with: registry.registrar(forPlugin: "MediaKitLibsMacosVideoPlugin"))
MediaKitVideoPlugin.register(with: registry.registrar(forPlugin: "MediaKitVideoPlugin")) MediaKitVideoPlugin.register(with: registry.registrar(forPlugin: "MediaKitVideoPlugin"))
@ -31,6 +34,7 @@ func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
PasteboardPlugin.register(with: registry.registrar(forPlugin: "PasteboardPlugin")) PasteboardPlugin.register(with: registry.registrar(forPlugin: "PasteboardPlugin"))
ScreenRetrieverMacosPlugin.register(with: registry.registrar(forPlugin: "ScreenRetrieverMacosPlugin")) ScreenRetrieverMacosPlugin.register(with: registry.registrar(forPlugin: "ScreenRetrieverMacosPlugin"))
SharedPreferencesPlugin.register(with: registry.registrar(forPlugin: "SharedPreferencesPlugin")) SharedPreferencesPlugin.register(with: registry.registrar(forPlugin: "SharedPreferencesPlugin"))
SqflitePlugin.register(with: registry.registrar(forPlugin: "SqflitePlugin"))
UrlLauncherPlugin.register(with: registry.registrar(forPlugin: "UrlLauncherPlugin")) UrlLauncherPlugin.register(with: registry.registrar(forPlugin: "UrlLauncherPlugin"))
WakelockPlusMacosPlugin.register(with: registry.registrar(forPlugin: "WakelockPlusMacosPlugin")) WakelockPlusMacosPlugin.register(with: registry.registrar(forPlugin: "WakelockPlusMacosPlugin"))
WebcryptoPlugin.register(with: registry.registrar(forPlugin: "WebcryptoPlugin")) WebcryptoPlugin.register(with: registry.registrar(forPlugin: "WebcryptoPlugin"))

View file

@ -313,6 +313,14 @@ packages:
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.1.0" version: "2.1.0"
exif:
dependency: transitive
description:
name: exif
sha256: a7980fdb3b7ffcd0b035e5b8a5e1eef7cadfe90ea6a4e85ebb62f87b96c7a172
url: "https://pub.dev"
source: hosted
version: "3.3.0"
fab_m3e: fab_m3e:
dependency: "direct overridden" dependency: "direct overridden"
description: description:
@ -447,6 +455,70 @@ packages:
description: flutter description: flutter
source: sdk source: sdk
version: "0.0.0" version: "0.0.0"
flutter_avif:
dependency: "direct main"
description:
name: flutter_avif
sha256: "6035f073189c1ae134affa73338c2eca79bf412e9abdb8f8628fdefcccff4444"
url: "https://pub.dev"
source: hosted
version: "3.1.0"
flutter_avif_android:
dependency: transitive
description:
name: flutter_avif_android
sha256: "1da135ea0d74225fae3154f954f9ba4cf7aa5e56b30d9851fcfc0ddecab9d8c5"
url: "https://pub.dev"
source: hosted
version: "3.1.0"
flutter_avif_ios:
dependency: transitive
description:
name: flutter_avif_ios
sha256: "3daaa599d8fe0193d3ade6cafa1fd4f166d4063b8d499c7c311ce1d170b2759f"
url: "https://pub.dev"
source: hosted
version: "3.1.0"
flutter_avif_linux:
dependency: transitive
description:
name: flutter_avif_linux
sha256: dd6179edca12c720761b3acc678d7f15208eb8647adbac5a6a90f52d4ba56e2d
url: "https://pub.dev"
source: hosted
version: "3.1.0"
flutter_avif_macos:
dependency: transitive
description:
name: flutter_avif_macos
sha256: "8e39f365dfc5713d4527f07a92399184857ea30eced85f82171bfd0a45e2c73b"
url: "https://pub.dev"
source: hosted
version: "3.1.0"
flutter_avif_platform_interface:
dependency: transitive
description:
name: flutter_avif_platform_interface
sha256: f5c110bdb7de2d4ab4902bfe2ec331fe24bc19b6d54f00ac4fa165effc0edcda
url: "https://pub.dev"
source: hosted
version: "3.1.0"
flutter_avif_web:
dependency: transitive
description:
name: flutter_avif_web
sha256: db2ff395b08cbfe9116e48ac65c428ba21a9159972ea019f8d7be580ff6cf6e8
url: "https://pub.dev"
source: hosted
version: "3.1.0"
flutter_avif_windows:
dependency: transitive
description:
name: flutter_avif_windows
sha256: e0c7722df305a6621f4ecdd83098025c705bcf0e8ce9519e03c6f515abcf351d
url: "https://pub.dev"
source: hosted
version: "3.1.0"
flutter_blurhash: flutter_blurhash:
dependency: "direct main" dependency: "direct main"
description: description:
@ -455,6 +527,14 @@ packages:
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "0.9.1" version: "0.9.1"
flutter_cache_manager:
dependency: transitive
description:
name: flutter_cache_manager
sha256: f94fc6f5480977e3eb7b622ed488f671ba96c971bd0e274e6bd0f0ba9b044816
url: "https://pub.dev"
source: hosted
version: "3.4.5"
flutter_file_dialog: flutter_file_dialog:
dependency: "direct main" dependency: "direct main"
description: description:
@ -1185,6 +1265,14 @@ packages:
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "5.0.6" version: "5.0.6"
protobuf:
dependency: transitive
description:
name: protobuf
sha256: "68645b24e0716782e58948f8467fd42a880f255096a821f9e7d0ec625b00c84d"
url: "https://pub.dev"
source: hosted
version: "3.1.0"
pub_semver: pub_semver:
dependency: transitive dependency: transitive
description: description:
@ -1398,6 +1486,54 @@ packages:
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.10.2" version: "1.10.2"
sprintf:
dependency: transitive
description:
name: sprintf
sha256: "1fc9ffe69d4df602376b52949af107d8f5703b77cda567c4d7d86a0693120f23"
url: "https://pub.dev"
source: hosted
version: "7.0.0"
sqflite:
dependency: transitive
description:
name: sqflite
sha256: "273218a1678360a3127fcf15e543381d9b813d413d783bc6e9a53eed4d2eb8fe"
url: "https://pub.dev"
source: hosted
version: "2.4.4+2"
sqflite_android:
dependency: transitive
description:
name: sqflite_android
sha256: e4f659c14bdd14464127fcd234a7a96f61fe0f539b8568e5a38f99f5a568a835
url: "https://pub.dev"
source: hosted
version: "2.4.4+1"
sqflite_common:
dependency: transitive
description:
name: sqflite_common
sha256: b80e94ff0d551d5f1f8c7d14348d29b576cca3ae30f6e195a7c380552c32b1e0
url: "https://pub.dev"
source: hosted
version: "2.5.14"
sqflite_darwin:
dependency: transitive
description:
name: sqflite_darwin
sha256: "8de68fc306040f992aaf378750c16f95e4298c4bb150dd45091d75e42b1f08ee"
url: "https://pub.dev"
source: hosted
version: "2.4.4+1"
sqflite_platform_interface:
dependency: transitive
description:
name: sqflite_platform_interface
sha256: c9177b2f3150ed0647b90a94307c28452fe0a5401863044216aed83addd6c7c5
url: "https://pub.dev"
source: hosted
version: "2.4.2"
stack_trace: stack_trace:
dependency: transitive dependency: transitive
description: description:

View file

@ -109,7 +109,7 @@ dependencies:
pasteboard: 0.5.0 pasteboard: 0.5.0
flutter_file_dialog: 3.3.3 flutter_file_dialog: 3.3.3
mime: 2.1.0 mime: 2.1.0
flutter_avif: 3.1.0
dev_dependencies: dev_dependencies:
build_runner: 2.16.2 build_runner: 2.16.2
flutter_lints: 6.0.0 flutter_lints: 6.0.0

View file

@ -9,6 +9,7 @@
#include <app_links/app_links_plugin_c_api.h> #include <app_links/app_links_plugin_c_api.h>
#include <dynamic_color/dynamic_color_plugin_c_api.h> #include <dynamic_color/dynamic_color_plugin_c_api.h>
#include <file_selector_windows/file_selector_windows.h> #include <file_selector_windows/file_selector_windows.h>
#include <flutter_avif_windows/flutter_avif_windows_plugin.h>
#include <media_kit_libs_windows_video/media_kit_libs_windows_video_plugin_c_api.h> #include <media_kit_libs_windows_video/media_kit_libs_windows_video_plugin_c_api.h>
#include <media_kit_video/media_kit_video_plugin_c_api.h> #include <media_kit_video/media_kit_video_plugin_c_api.h>
#include <pasteboard/pasteboard_plugin.h> #include <pasteboard/pasteboard_plugin.h>
@ -24,6 +25,8 @@ void RegisterPlugins(flutter::PluginRegistry* registry) {
registry->GetRegistrarForPlugin("DynamicColorPluginCApi")); registry->GetRegistrarForPlugin("DynamicColorPluginCApi"));
FileSelectorWindowsRegisterWithRegistrar( FileSelectorWindowsRegisterWithRegistrar(
registry->GetRegistrarForPlugin("FileSelectorWindows")); registry->GetRegistrarForPlugin("FileSelectorWindows"));
FlutterAvifWindowsPluginRegisterWithRegistrar(
registry->GetRegistrarForPlugin("FlutterAvifWindowsPlugin"));
MediaKitLibsWindowsVideoPluginCApiRegisterWithRegistrar( MediaKitLibsWindowsVideoPluginCApiRegisterWithRegistrar(
registry->GetRegistrarForPlugin("MediaKitLibsWindowsVideoPluginCApi")); registry->GetRegistrarForPlugin("MediaKitLibsWindowsVideoPluginCApi"));
MediaKitVideoPluginCApiRegisterWithRegistrar( MediaKitVideoPluginCApiRegisterWithRegistrar(

View file

@ -6,6 +6,7 @@ list(APPEND FLUTTER_PLUGIN_LIST
app_links app_links
dynamic_color dynamic_color
file_selector_windows file_selector_windows
flutter_avif_windows
media_kit_libs_windows_video media_kit_libs_windows_video
media_kit_video media_kit_video
pasteboard pasteboard