Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/core/enums/image_format.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
enum ImageFormat {
png('png'),
jpg('jpg'),
ora('ora'),
catrobatImage('catrobat-image');

const ImageFormat(this.extension);
Expand Down
3 changes: 3 additions & 0 deletions lib/core/models/image_from_file.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@ import 'package:paintroid/core/models/catrobat_image.dart';
class ImageFromFile {
final Image? rasterImage;
final CatrobatImage? catrobatImage;
final List<Image>? oraImageLayers;

const ImageFromFile.catrobatImage(
CatrobatImage image, {
Image? backgroundImage,
}) : catrobatImage = image,
oraImageLayers = null,
rasterImage = backgroundImage;

const ImageFromFile.rasterImage(Image image)
: rasterImage = image,
oraImageLayers = null,
catrobatImage = null;
}
4 changes: 4 additions & 0 deletions lib/core/models/image_meta_data.dart
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,7 @@ class CatrobatImageMetaData extends ImageMetaData {
const CatrobatImageMetaData(String name)
: super(name, ImageFormat.catrobatImage);
}

class OraMetaData extends ImageMetaData {
const OraMetaData(String name) : super(name, ImageFormat.ora);
}
61 changes: 61 additions & 0 deletions lib/core/models/ora_image.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import 'dart:convert';
import 'dart:typed_data';
import 'package:image/image.dart' as img;
import 'package:archive/archive.dart';

class OraImage {
final int width;
final int height;
final List<img.Image> layers;
final String xmlMetadata;

OraImage({
required this.width,
required this.height,
required this.layers,
required this.xmlMetadata,
});

Uint8List toBytes() {
final archive = Archive();

final mimetypeContent = utf8.encode('image/openraster');
archive.addFile(
ArchiveFile('mimetype', mimetypeContent.length, mimetypeContent)
..compress = false,
);

for (int i = 0; i < layers.length; i++) {
final layer = layers[i];
final encoder = img.PngEncoder();
final layerData = encoder.encodeImage(layer);
archive.addFile(
ArchiveFile('data/layer_$i.png', layerData.length, layerData));
}

final encodedXml = utf8.encode(xmlMetadata);
archive.addFile(ArchiveFile('stack.xml', encodedXml.length, encodedXml));

final zipEncoder = ZipEncoder();
return Uint8List.fromList(zipEncoder.encode(archive)!);
}

static String generateXmlMetadataForOra(
List<img.Image> layers, int width, int height) {
var buffer = StringBuffer();
buffer.writeln('<?xml version="1.0" encoding="UTF-8"?>');
buffer.writeln('<image w="$width" h="$height">');
buffer.writeln(' <stack>');

for (int i = 0; i < layers.length; i++) {
final layerName = 'Layer $i';
final layerSrc = 'data/layer_$i.png';
buffer.writeln(
' <layer name="$layerName" src="$layerSrc" x="0" y="0" opacity="1.0" visibility="visible"/>');
}

buffer.writeln(' </stack>');
buffer.writeln('</image>');
return buffer.toString();
}
}
88 changes: 88 additions & 0 deletions lib/core/models/process_ora.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import 'dart:typed_data';
import 'dart:ui' as ui;
import 'package:archive/archive.dart';
import 'package:image/image.dart' as img;
import 'package:xml/xml.dart' as xml;
import 'package:paintroid/core/models/loggable_mixin.dart';

class ProcessOra with LoggableMixin {
Future<List<ui.Image>> processOraFile(Archive archive) async {
List<ui.Image> layers = [];
ArchiveFile? stackXmlFile = archive.findFile('stack.xml');

if (stackXmlFile == null) {
logger.severe('Error: stack.xml not found in ORA file.');
return layers;
}

if (stackXmlFile.content == null || stackXmlFile.content is! List<int>) {
logger.severe('Error: stack.xml content is invalid.');
return layers;
}

String xmlContent = String.fromCharCodes(stackXmlFile.content as List<int>);
xml.XmlDocument document;
try {
document = xml.XmlDocument.parse(xmlContent);
} catch (e, s) {
logger.severe('Error parsing stack.xml', e, s);
return layers;
}

var imageElement = document.rootElement;
var stackElement = imageElement.findElements('stack').firstOrNull;

if (stackElement == null) {
logger.severe('Error: <stack> element not found in stack.xml.');
return layers;
}

for (var layerElement in stackElement.findElements('layer')) {
String? layerSrc = layerElement.getAttribute('src');
if (layerSrc == null) {
logger
.warning('Warning: Layer element missing src attribute. Skipping.');
continue;
}

ArchiveFile? imageFile = archive.findFile(layerSrc);
if (imageFile == null || !imageFile.isFile) {
logger.warning(
'Warning: Image file $layerSrc not found in archive for a layer. Skipping.');
continue;
}

if (imageFile.content == null || imageFile.content is! List<int>) {
logger.warning(
'Warning: Image file $layerSrc content is invalid. Skipping.');
continue;
}

img.Image? decodedImage;
try {
decodedImage = img.decodeImage(imageFile.content as List<int>);
if (decodedImage == null) {
logger.warning(
'Warning: decodeImage returned null for $layerSrc. Skipping.');
continue;
}
} catch (e, s) {
logger.severe('Error decoding image $layerSrc. Skipping.', e, s);
continue;
}

ui.Image layerUiImage = await convertImgImageToUiImage(decodedImage);
layers.add(layerUiImage);
}

return layers;
}

Future<ui.Image> convertImgImageToUiImage(img.Image image) async {
List<int> pngBytes = img.encodePng(image);

final codec = await ui.instantiateImageCodec(Uint8List.fromList(pngBytes));
final frame = await codec.getNextFrame();
return frame.image;
}
}
12 changes: 7 additions & 5 deletions lib/core/providers/object/file_service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,15 @@ class FileService with LoggableMixin implements IFileService {
@override
Future<Result<File, Failure>> save(String filename, Uint8List data) async {
try {
final saveDirectory = await FilePicker.platform.getDirectoryPath();
if (saveDirectory == null) {
final savePath = await FilePicker.platform.saveFile(
dialogTitle: 'Save As',
fileName: filename,
bytes: data,
);
if (savePath == null) {
return const Result.err(SaveImageFailure.userCancelled);
}
final file =
await File('$saveDirectory/$filename').create(recursive: true);
return Result.ok(await file.writeAsBytes(data));
return Result.ok(File(savePath));
} catch (err, stacktrace) {
logger.severe('Could not save file', err, stacktrace);
return const Result.err(SaveImageFailure.unidentified);
Expand Down
70 changes: 62 additions & 8 deletions lib/core/providers/object/io_handler.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import 'dart:convert';
import 'dart:io';
import 'dart:typed_data';
import 'dart:ui' as ui;
import 'package:image/image.dart' as img;

import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
Expand All @@ -10,12 +12,15 @@ import 'package:paintroid/core/enums/image_format.dart';
import 'package:paintroid/core/enums/image_location.dart';
import 'package:paintroid/core/models/catrobat_image.dart';
import 'package:paintroid/core/models/image_meta_data.dart';
import 'package:paintroid/core/models/loggable_mixin.dart';
import 'package:paintroid/core/models/ora_image.dart';
import 'package:paintroid/core/providers/object/file_service.dart';
import 'package:paintroid/core/providers/object/image_service.dart';
import 'package:paintroid/core/providers/object/load_image_from_file_manager.dart';
import 'package:paintroid/core/providers/object/load_image_from_photo_library.dart';
import 'package:paintroid/core/providers/object/render_image_for_export.dart';
import 'package:paintroid/core/providers/object/save_as_catrobat_image.dart';
import 'package:paintroid/core/providers/object/save_as_ora_image.dart';
import 'package:paintroid/core/providers/object/save_as_raster_image.dart';
import 'package:paintroid/core/providers/state/app_bar_provider.dart';
import 'package:paintroid/core/providers/state/canvas_state_provider.dart';
Expand All @@ -27,14 +32,13 @@ import 'package:paintroid/ui/shared/dialogs/load_image_dialog.dart';
import 'package:paintroid/ui/shared/dialogs/save_image_dialog.dart';
import 'package:paintroid/ui/utils/toast_utils.dart';

class IOHandler {
class IOHandler with LoggableMixin {
final Ref ref;

const IOHandler(this.ref);
IOHandler(this.ref);

static final provider = Provider((ref) => IOHandler(ref));

/// Returns [true] if the image was saved successfully
Future<bool> saveImage(BuildContext context) async {
final workspaceStateNotifier = ref.read(workspaceStateProvider.notifier);
final imageMetaData = await showSaveImageDialog(context, false);
Expand Down Expand Up @@ -62,9 +66,6 @@ class IOHandler {
return savedFile;
}

/// Returns [true] if -
/// - There was no unsaved work, or
/// - The unsaved work was saved successfully
Future<bool> handleUnsavedChanges(BuildContext context, State state) async {
final workspaceStateNotifier = ref.read(workspaceStateProvider.notifier);
if (!workspaceStateNotifier.hasSavedLastWork) {
Expand All @@ -79,7 +80,6 @@ class IOHandler {
return true;
}

/// Returns [true] if the image was loaded successfully
Future<bool> loadImage(
BuildContext context, State state, bool unsavedChanges) async {
if (unsavedChanges) {
Expand All @@ -101,7 +101,6 @@ class IOHandler {
}
}

/// Returns [true] if a new image canvas was created successfully
Future<bool> newImage(BuildContext context, State state) async {
final shouldContinue = await handleUnsavedChanges(context, state);
if (!shouldContinue) return false;
Expand Down Expand Up @@ -178,10 +177,65 @@ class IOHandler {
} else if (imageData is CatrobatImageMetaData) {
final savedFile = await _saveAsCatrobatImage(imageData, false);
isImageSaved = (savedFile != null);
} else if (imageData is OraMetaData) {
isImageSaved = await _saveAsOraImage(imageData);
}
return isImageSaved;
}

Future<img.Image> convertUiImageToImgImage(ui.Image uiImage) async {
final ByteData? byteData =
await uiImage.toByteData(format: ui.ImageByteFormat.png);
if (byteData == null) {
const message = 'Failed to convert ui.Image to PNG byte data.';
logger.severe(message);
throw Exception(message);
}
final Uint8List pngBytes = byteData.buffer.asUint8List();
final img.Image? decodedImage = img.decodePng(pngBytes);
if (decodedImage == null) {
const message = 'Failed to decode PNG bytes to img.Image.';
logger.severe(message);
throw Exception(message);
}
return decodedImage;
}

Future<bool> _saveAsOraImage(OraMetaData imageData) async {
final oraImageService = ref.read(SaveAsOraImage.provider);

final ui.Image imageToExport = await ref
.read(RenderImageForExport.provider)
.call(keepTransparency: true);

final imgWidth = imageToExport.width;
final imgHeight = imageToExport.height;

img.Image layer = await convertUiImageToImgImage(imageToExport);

final oraImage = OraImage(
width: imgWidth,
height: imgHeight,
layers: [layer],
xmlMetadata:
OraImage.generateXmlMetadataForOra([layer], imgWidth, imgHeight),
);

final fileName = '${imageData.name}.ora';
final result = await oraImageService.call(oraImage, fileName);

return result.match(
(file) {
ToastUtils.showShortToast(message: 'Saved successfully');
return true;
},
(error) {
ToastUtils.showShortToast(message: error.message);
return false;
},
);
}

Future<bool> _saveAsRasterImage(ImageMetaData imageData) async {
final image = await ref
.read(RenderImageForExport.provider)
Expand Down
19 changes: 16 additions & 3 deletions lib/core/providers/object/load_image_from_file_manager.dart
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
import 'dart:convert';
import 'dart:io';
import 'dart:typed_data';
import 'dart:ui';
import 'dart:ui' as ui;
import 'package:archive/archive.dart';

import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:oxidized/oxidized.dart';

import 'package:paintroid/core/models/catrobat_image.dart';
import 'package:paintroid/core/models/image_from_file.dart';
import 'package:paintroid/core/models/loggable_mixin.dart';
import 'package:paintroid/core/models/process_ora.dart';
import 'package:paintroid/core/providers/object/file_service.dart';
import 'package:paintroid/core/providers/object/image_service.dart';
import 'package:paintroid/core/providers/object/permission_service.dart';
Expand Down Expand Up @@ -61,12 +63,23 @@ class LoadImageFromFileManager with LoggableMixin {
case 'catrobat-image':
Uint8List bytes = await file.readAsBytes();
CatrobatImage catrobatImage = CatrobatImage.fromBytes(bytes);
Image? backgroundImage =
ui.Image? backgroundImage =
await rebuildBackgroundImage(catrobatImage);
return Result.ok(ImageFromFile.catrobatImage(
catrobatImage,
backgroundImage: backgroundImage,
));
case 'ora':
Uint8List bytes = await file.readAsBytes();
Archive archive = ZipDecoder().decodeBytes(bytes);
ProcessOra processOra = ProcessOra();
List<ui.Image> layers = await processOra.processOraFile(archive);

if (layers.isNotEmpty) {
return Result.ok(ImageFromFile.rasterImage(layers.first));
} else {
return const Result.err(LoadImageFailure.invalidImage);
}
default:
return const Result.err(LoadImageFailure.invalidImage);
}
Expand All @@ -80,7 +93,7 @@ class LoadImageFromFileManager with LoggableMixin {
});
}

Future<Image?> rebuildBackgroundImage(CatrobatImage catrobatImage) async {
Future<ui.Image?> rebuildBackgroundImage(CatrobatImage catrobatImage) async {
if (catrobatImage.backgroundImage.isNotEmpty) {
final backgroundImageData = base64Decode(catrobatImage.backgroundImage);
final result =
Expand Down
Loading