-
Notifications
You must be signed in to change notification settings - Fork 499
/
images.rs
617 lines (556 loc) · 23.2 KB
/
images.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
// Copyright © SixtyFPS GmbH <info@slint-ui.com>
// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-commercial
use std::cell::RefCell;
use std::collections::HashMap;
use std::rc::Rc;
use i_slint_core::graphics::{IntSize, SharedImageBuffer};
#[cfg(target_arch = "wasm32")]
use i_slint_core::Property;
use i_slint_core::{items::ImageRendering, slice::Slice, ImageInner, SharedString};
use super::{CanvasRc, GLItemRenderer};
struct Texture {
id: femtovg::ImageId,
canvas: CanvasRc,
}
impl Texture {
fn size(&self) -> Option<IntSize> {
self.canvas
.borrow()
.image_info(self.id)
.map(|info| [info.width() as u32, info.height() as u32].into())
.ok()
}
}
impl Drop for Texture {
fn drop(&mut self) {
self.canvas.borrow_mut().delete_image(self.id);
}
}
#[cfg(target_arch = "wasm32")]
struct HTMLImage {
dom_element: web_sys::HtmlImageElement,
/// If present, this boolean property indicates whether the image has been uploaded yet or
/// if that operation is still pending. If not present, then the image *is* available. This is
/// used for remote HTML image loading and the property will be used to correctly track dependencies
/// to graphics items that query for the size.
image_load_pending: core::pin::Pin<Rc<Property<bool>>>,
}
#[cfg(target_arch = "wasm32")]
impl HTMLImage {
fn new(url: &str) -> Self {
let dom_element = web_sys::HtmlImageElement::new().unwrap();
let image_load_pending = Rc::pin(Property::new(true));
let event_loop_proxy = crate::event_loop::with_window_target(|event_loop| {
event_loop.event_loop_proxy().clone()
});
dom_element.set_cross_origin(Some("anonymous"));
dom_element.set_onload(Some(
&wasm_bindgen::closure::Closure::once_into_js({
let image_load_pending = image_load_pending.clone();
move || {
image_load_pending.as_ref().set(false);
// As you can paint on a HTML canvas at any point in time, request_redraw()
// on a winit window only queues an additional internal event, that'll be
// be dispatched as the next event. We are however not in an event loop
// call, so we also need to wake up the event loop and redraw then.
event_loop_proxy
.send_event(crate::event_loop::CustomEvent::RedrawAllWindows)
.ok();
}
})
.into(),
));
dom_element.set_src(&url);
Self { dom_element, image_load_pending }
}
fn size(&self) -> Option<IntSize> {
match self.image_load_pending.as_ref().get() {
true => None,
false => Some(IntSize::new(self.dom_element.width(), self.dom_element.height())),
}
}
}
#[derive(derive_more::From)]
enum ImageData {
Texture(Texture),
DecodedImage {
image: image::DynamicImage,
premultiplied_alpha: bool,
},
EmbeddedImage(SharedImageBuffer),
#[cfg(feature = "svg")]
Svg(usvg::Tree),
#[cfg(target_arch = "wasm32")]
HTMLImage(HTMLImage),
}
impl std::fmt::Debug for ImageData {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
ImageData::Texture(t) => {
write!(f, "ImageData::Texture({:?})", t.id.0)
}
ImageData::DecodedImage { image, premultiplied_alpha } => {
write!(
f,
"ImageData::DecodedImage({}x{}; premultiplied_alpha = {})",
image.width(),
image.height(),
premultiplied_alpha
)
}
ImageData::EmbeddedImage(buffer) => {
write!(f, "ImageData::EmbeddedImage({}x{})", buffer.width(), buffer.height())
}
ImageData::Svg(_) => {
write!(f, "ImageData::SVG(...)")
}
#[cfg(target_arch = "wasm32")]
ImageData::HTMLImage(html_image) => {
write!(
f,
"ImageData::HTMLImage({}x{})",
html_image.dom_element.width(),
html_image.dom_element.height()
)
}
}
}
}
#[derive(Debug)]
pub(crate) struct CachedImage(RefCell<ImageData>);
impl CachedImage {
fn new_on_cpu(decoded_image: image::DynamicImage, premultiplied_alpha: bool) -> Self {
Self(RefCell::new(ImageData::DecodedImage { image: decoded_image, premultiplied_alpha }))
}
pub fn new_on_gpu(canvas: &CanvasRc, image_id: femtovg::ImageId) -> Self {
Self(RefCell::new(Texture { id: image_id, canvas: canvas.clone() }.into()))
}
pub fn new_empty_on_gpu(canvas: &CanvasRc, width: u32, height: u32) -> Option<Self> {
if width == 0 || height == 0 {
return None;
}
let image_id = canvas
.borrow_mut()
.create_image_empty(
width as usize,
height as usize,
femtovg::PixelFormat::Rgba8,
femtovg::ImageFlags::PREMULTIPLIED | femtovg::ImageFlags::FLIP_Y,
)
.unwrap();
Self::new_on_gpu(canvas, image_id).into()
}
#[cfg(feature = "svg")]
fn new_on_cpu_svg(tree: usvg::Tree) -> Self {
Self(RefCell::new(ImageData::Svg(tree)))
}
pub fn new_from_resource(resource: &ImageInner) -> Option<Self> {
match resource {
ImageInner::None => None,
ImageInner::AbsoluteFilePath(path) => Self::new_from_path(path),
ImageInner::EmbeddedData { data, format } => Self::new_from_data(data, format),
ImageInner::EmbeddedImage(buffer) => {
Some(Self(RefCell::new(ImageData::EmbeddedImage(buffer.clone()))))
}
ImageInner::StaticTextures { .. } => todo!(),
}
}
fn new_from_path(path: &SharedString) -> Option<Self> {
#[cfg(not(target_arch = "wasm32"))]
{
#[cfg(feature = "svg")]
if path.ends_with(".svg") || path.ends_with(".svgz") {
return Some(Self::new_on_cpu_svg(
super::svg::load_from_path(std::path::Path::new(&path.as_str())).map_or_else(
|err| {
eprintln!("Error loading SVG from {}: {}", &path, err);
None
},
Some,
)?,
));
}
Some(Self::new_on_cpu(
image::open(std::path::Path::new(&path.as_str())).map_or_else(
|decode_err| {
eprintln!("Error loading image from {}: {}", &path, decode_err);
None
},
Some,
)?,
false, // We don't really really know if it's pre-multiplied, but let's assume not
))
}
#[cfg(target_arch = "wasm32")]
Some(Self(RefCell::new(ImageData::HTMLImage(HTMLImage::new(path)))))
}
fn new_from_data(data: &Slice<u8>, format: &Slice<u8>) -> Option<Self> {
#[cfg(feature = "svg")]
if format.as_slice() == b"svg" || format.as_slice() == b"svgz" {
return Some(CachedImage::new_on_cpu_svg(
super::svg::load_from_data(data.as_slice()).map_or_else(
|svg_err| {
eprintln!("Error loading SVG: {}", svg_err);
None
},
Some,
)?,
));
}
let format = std::str::from_utf8(format.as_slice())
.ok()
.and_then(image::ImageFormat::from_extension);
let image = if let Some(format) = format {
image::load_from_memory_with_format(data.as_slice(), format)
} else {
image::load_from_memory(data.as_slice())
};
Some(CachedImage::new_on_cpu(
image.map_or_else(
|decode_err| {
eprintln!("Error decoding image: {}", decode_err);
None
},
Some,
)?,
false, // We don't really really know if it's pre-multiplied, but let's assume not
))
}
// Upload the image to the GPU? if that hasn't happened yet. This function could take just a canvas
// as parameter, but since an upload requires a current context, this is "enforced" by taking
// a renderer instead (which implies a current context).
pub fn ensure_uploaded_to_gpu(
&self,
current_renderer: &GLItemRenderer,
scaling: Option<ImageRendering>,
) -> femtovg::ImageId {
let canvas = ¤t_renderer.canvas;
let image_flags = match scaling.unwrap_or_default() {
ImageRendering::smooth => femtovg::ImageFlags::empty(),
ImageRendering::pixelated => femtovg::ImageFlags::NEAREST,
};
let img = &mut *self.0.borrow_mut();
if let ImageData::DecodedImage { image: decoded_image, premultiplied_alpha } = img {
let image_id = match femtovg::ImageSource::try_from(&*decoded_image) {
Ok(image_source) => canvas.borrow_mut().create_image(image_source, image_flags),
Err(_) => {
let converted = image::DynamicImage::ImageRgba8(decoded_image.to_rgba8());
let image_source = femtovg::ImageSource::try_from(&converted).unwrap();
let image_flags = if *premultiplied_alpha {
image_flags | femtovg::ImageFlags::PREMULTIPLIED
} else {
image_flags
};
canvas.borrow_mut().create_image(image_source, image_flags)
}
}
.unwrap();
*img = Texture { id: image_id, canvas: canvas.clone() }.into()
} else if let ImageData::EmbeddedImage(buffer) = img {
let (image_source, flags) = image_buffer_to_image_source(buffer);
let image_id =
canvas.borrow_mut().create_image(image_source, flags | image_flags).unwrap();
*img = Texture { id: image_id, canvas: canvas.clone() }.into()
}
#[cfg(target_arch = "wasm32")]
if let ImageData::HTMLImage(html_image) = img {
let image_id =
canvas.borrow_mut().create_image(&html_image.dom_element, image_flags).unwrap();
*img = Texture { id: image_id, canvas: canvas.clone() }.into()
}
match &img {
ImageData::Texture(Texture { id, .. }) => *id,
_ => unreachable!(),
}
}
// Upload the image to the GPU. This function could take just a canvas as parameter,
// but since an upload requires a current context, this is "enforced" by taking
// a renderer instead (which implies a current context).
pub fn upload_to_gpu(
&self,
current_renderer: &GLItemRenderer,
target_size_for_scalable_source: Option<euclid::default::Size2D<u32>>,
scaling: ImageRendering,
) -> Option<Self> {
let canvas = ¤t_renderer.canvas;
let image_flags = match scaling {
ImageRendering::smooth => femtovg::ImageFlags::empty(),
ImageRendering::pixelated => femtovg::ImageFlags::NEAREST,
};
match &*self.0.borrow() {
ImageData::Texture(_) => None, // internal error: Cannot call upload_to_gpu on previously uploaded image,
ImageData::DecodedImage { image: decoded_image, premultiplied_alpha } => {
let image_id = match femtovg::ImageSource::try_from(&*decoded_image) {
Ok(image_source) => canvas.borrow_mut().create_image(image_source, image_flags),
Err(_) => {
let converted = image::DynamicImage::ImageRgba8(decoded_image.to_rgba8());
let image_source = femtovg::ImageSource::try_from(&converted).unwrap();
let image_flags = if *premultiplied_alpha {
image_flags | femtovg::ImageFlags::PREMULTIPLIED
} else {
image_flags
};
canvas.borrow_mut().create_image(image_source, image_flags)
}
}
.unwrap();
Some(Self::new_on_gpu(canvas, image_id))
}
ImageData::EmbeddedImage(_) => {
// embedded images have no cache key and therefore it would be a bug if they entered this code path
// that is used to transition images from the image cache to the texture cache.
eprintln!("internal error: upload_to_gpu called on embedded image, which implies that the image was entered into the cache");
None
}
#[cfg(feature = "svg")]
ImageData::Svg(svg_tree) => {
match super::svg::render(
svg_tree,
target_size_for_scalable_source.unwrap_or_default(),
) {
Ok(rendered_svg_image) => Self::new_on_cpu(
rendered_svg_image,
// resvg creates images with pre-multipled alpha
true,
)
.upload_to_gpu(current_renderer, None, scaling),
Err(err) => {
eprintln!("Error rendering SVG: {}", err);
None
}
}
}
#[cfg(target_arch = "wasm32")]
ImageData::HTMLImage(html_image) => html_image.size().map(|_| {
// Anecdotal evidence suggests that HTMLImageElement converts to a texture with
// pre-multipled alpha. It's possible that this is not generally applicable, but it
// is the case for SVGs.
let image_flags = if html_image.dom_element.current_src().ends_with(".svg") {
image_flags | femtovg::ImageFlags::PREMULTIPLIED
} else {
image_flags
};
let image_id =
canvas.borrow_mut().create_image(&html_image.dom_element, image_flags).unwrap();
Self::new_on_gpu(canvas, image_id)
}),
}
}
pub fn size(&self) -> Option<IntSize> {
use image::GenericImageView;
match &*self.0.borrow() {
ImageData::Texture(texture) => texture.size(),
ImageData::DecodedImage { image: decoded_image, .. } => {
Some(decoded_image.dimensions().into())
}
ImageData::EmbeddedImage(buffer) => Some(buffer.size()),
#[cfg(feature = "svg")]
ImageData::Svg(tree) => {
let size = tree.svg_node().size.to_screen_size();
Some([size.width(), size.height()].into())
}
#[cfg(target_arch = "wasm32")]
ImageData::HTMLImage(html_image) => html_image.size(),
}
}
pub(crate) fn as_render_target(&self) -> femtovg::RenderTarget {
match &*self.0.borrow() {
ImageData::Texture(tex) => femtovg::RenderTarget::Image(tex.id),
_ => panic!(
"internal error: CachedImage::as_render_target() called on non-texture image"
),
}
}
pub(crate) fn filter(&self, canvas: &CanvasRc, filter: femtovg::ImageFilter) -> Self {
let (image_id, size) = match &*self.0.borrow() {
ImageData::Texture(texture) => texture.size().map(|size| (texture.id, size)),
_ => None,
}
.expect("internal error: Cannot filter non-GPU images");
let filtered_image = Self::new_empty_on_gpu(canvas, size.width, size.height).expect(
"internal error: this can only fail if the filtered image was zero width or height",
);
let filtered_image_id = match &*filtered_image.0.borrow() {
ImageData::Texture(tex) => tex.id,
_ => panic!("internal error: CachedImage::new_empty_on_gpu did not return texture!"),
};
canvas.borrow_mut().filter_image(filtered_image_id, filter, image_id);
filtered_image
}
pub(crate) fn as_paint(&self) -> femtovg::Paint {
self.as_paint_with_alpha(1.0)
}
pub(crate) fn as_paint_with_alpha(&self, alpha_tint: f32) -> femtovg::Paint {
match &*self.0.borrow() {
ImageData::Texture(tex) => {
let size = tex
.size()
.expect("internal error: CachedImage::as_paint() called on zero-sized texture");
femtovg::Paint::image(
tex.id,
0.,
0.,
size.width as f32,
size.height as f32,
0.,
alpha_tint,
)
}
_ => panic!("internal error: CachedImage::as_paint() called on non-texture image"),
}
}
pub(crate) fn is_on_gpu(&self) -> bool {
matches!(&*self.0.borrow(), ImageData::Texture(_))
}
pub(crate) fn to_rgba(&self) -> Option<image::RgbaImage> {
if let ImageData::DecodedImage { image, .. } = &*self.0.borrow() {
Some(image.to_rgba8())
} else {
None
}
}
}
#[derive(PartialEq, Eq, Hash, Debug, derive_more::From)]
pub enum ImageCacheKey {
Path(String),
EmbeddedData(by_address::ByAddress<&'static [u8]>),
}
impl ImageCacheKey {
pub fn new(resource: &ImageInner) -> Option<Self> {
Some(match resource {
ImageInner::None => return None,
ImageInner::AbsoluteFilePath(path) => {
if path.is_empty() {
return None;
}
path.to_string().into()
}
ImageInner::EmbeddedData { data, format: _ } => {
by_address::ByAddress(data.as_slice()).into()
}
ImageInner::EmbeddedImage { .. } => return None,
ImageInner::StaticTextures { .. } => return None,
})
}
}
// Cache used to avoid repeatedly decoding images from disk. Entries with a count
// of 1 are drained after flushing the renderer commands to the screen.
#[derive(Default)]
pub(crate) struct ImageCache(HashMap<ImageCacheKey, Rc<CachedImage>>);
impl ImageCache {
// Look up the given image cache key in the image cache and upgrade the weak reference to a strong one if found,
// otherwise a new image is created/loaded from the given callback.
pub fn lookup_image_in_cache_or_create(
&mut self,
cache_key: ImageCacheKey,
image_create_fn: impl Fn() -> Option<Rc<CachedImage>>,
) -> Option<Rc<CachedImage>> {
Some(match self.0.entry(cache_key) {
std::collections::hash_map::Entry::Occupied(existing_entry) => {
existing_entry.get().clone()
}
std::collections::hash_map::Entry::Vacant(vacant_entry) => {
let new_image = image_create_fn()?;
vacant_entry.insert(new_image.clone());
new_image
}
})
}
// Try to load the image the given resource points to
pub(crate) fn load_image_resource(&mut self, resource: &ImageInner) -> Option<Rc<CachedImage>> {
ImageCacheKey::new(resource)
.and_then(|cache_key| {
self.lookup_image_in_cache_or_create(cache_key, || {
CachedImage::new_from_resource(resource).map(Rc::new)
})
})
.or_else(|| CachedImage::new_from_resource(resource).map(Rc::new))
}
}
#[derive(PartialEq, Eq, Hash, Debug)]
pub struct TextureCacheKey {
source_key: ImageCacheKey,
target_size_for_scalable_source: Option<euclid::default::Size2D<u32>>,
gpu_image_flags: ImageRendering,
}
impl TextureCacheKey {
pub fn new(
resource: &ImageInner,
target_size_for_scalable_source: Option<euclid::default::Size2D<u32>>,
gpu_image_flags: ImageRendering,
) -> Option<Self> {
ImageCacheKey::new(resource).map(|source_key| Self {
source_key,
target_size_for_scalable_source,
gpu_image_flags,
})
}
}
// Cache used to avoid repeatedly decoding images from disk. Entries with a count
// of 1 are drained after flushing the renderer commands to the screen.
#[derive(Default)]
pub struct TextureCache(HashMap<TextureCacheKey, Rc<CachedImage>>);
impl TextureCache {
// Look up the given image cache key in the image cache and upgrade the weak reference to a strong one if found,
// otherwise a new image is created/loaded from the given callback.
pub(crate) fn lookup_image_in_cache_or_create(
&mut self,
cache_key: TextureCacheKey,
image_create_fn: impl Fn() -> Option<Rc<CachedImage>>,
) -> Option<Rc<CachedImage>> {
Some(match self.0.entry(cache_key) {
std::collections::hash_map::Entry::Occupied(existing_entry) => {
existing_entry.get().clone()
}
std::collections::hash_map::Entry::Vacant(vacant_entry) => {
let new_image = image_create_fn()?;
debug_assert!(new_image.is_on_gpu());
vacant_entry.insert(new_image.clone());
new_image
}
})
}
pub(crate) fn drain(&mut self) {
self.0.retain(|_, cached_image| {
// * Retain images that are used by elements, so that they can be effectively
// shared (one image element refers to foo.png, another element is created
// and refers to the same -> share).
// * Also retain images that are still loading (async HTML), where the size
// is not known yet. Otherwise we end up in a loop where an image is not loaded
// yet, we report (0, 0) to the layout, the image gets removed here, the closure
// still triggers a load and marks the layout as dirt, which loads the
// image again, etc.
Rc::strong_count(cached_image) > 1 || cached_image.size().is_none()
});
}
pub(crate) fn clear(&mut self) {
self.0.clear();
}
}
fn image_buffer_to_image_source(
buffer: &SharedImageBuffer,
) -> (femtovg::ImageSource<'_>, femtovg::ImageFlags) {
match buffer {
SharedImageBuffer::RGB8(buffer) => (
{
imgref::ImgRef::new(buffer.as_slice(), buffer.width() as _, buffer.height() as _)
.into()
},
femtovg::ImageFlags::empty(),
),
SharedImageBuffer::RGBA8(buffer) => (
{
imgref::ImgRef::new(buffer.as_slice(), buffer.width() as _, buffer.height() as _)
.into()
},
femtovg::ImageFlags::empty(),
),
SharedImageBuffer::RGBA8Premultiplied(buffer) => (
{
imgref::ImgRef::new(buffer.as_slice(), buffer.width() as _, buffer.height() as _)
.into()
},
femtovg::ImageFlags::PREMULTIPLIED,
),
}
}