Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-11-04 07:10:57 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibWeb/Loader/ImageLoader.cpp

135 lines
3.5 KiB
C++
Raw Normal View History

LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
/*
* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 01:24:48 -07:00
* SPDX-License-Identifier: BSD-2-Clause
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
*/
Everywhere: Replace a bundle of dbg with dbgln. These changes are arbitrarily divided into multiple commits to make it easier to find potentially introduced bugs with git bisect.
2021-01-17 18:17:00 +01:00
#include <AK/Debug.h>
LibWeb: Move bitmap animation from HTMLImageElement to ImageLoader Since ImageLoader manages the image decoder anyway, let it manage animation as well.
2020-06-14 19:26:25 +02:00
#include <LibCore/Timer.h>
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
#include <LibGfx/Bitmap.h>
LibWeb: Set Cookie header on <img> and <object> resource requests This required passing a reference to the owning HTML*Element to ImageLoader, the same way that CSSLoader has a reference to its owner.
2021-04-14 10:39:12 -04:00
#include <LibWeb/DOM/Document.h>
#include <LibWeb/DOM/Element.h>
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
#include <LibWeb/Loader/ImageLoader.h>
#include <LibWeb/Loader/ResourceLoader.h>
namespace Web {
LibWeb: Set Cookie header on <img> and <object> resource requests This required passing a reference to the owning HTML*Element to ImageLoader, the same way that CSSLoader has a reference to its owner.
2021-04-14 10:39:12 -04:00
ImageLoader::ImageLoader(DOM::Element& owner_element)
: m_owner_element(owner_element)
, m_timer(Core::Timer::construct())
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
{
}
void ImageLoader::load(const URL& url)
{
LibWeb: Until an image has loaded or failed, don't occupy layout size This patch makes images have an implicit zero intrinsic size before they have either loaded or failed to load. This is tracked by the ImageLoader object. This fixes a long-standing issue with images occupying empty 150x150 rectangles of space.
2020-08-12 13:47:55 +02:00
m_loading_state = LoadingState::Loading;
LibWeb: Set Cookie header on <img> and <object> resource requests This required passing a reference to the owning HTML*Element to ImageLoader, the same way that CSSLoader has a reference to its owner.
2021-04-14 10:39:12 -04:00
auto request = LoadRequest::create_for_url_on_page(url, m_owner_element.document().page());
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
set_resource(ResourceLoader::the().load_resource(Resource::Type::Image, request));
}
LibWeb: Move "visible in viewport" state tracking to ImageLoader This should technically apply to any LayoutImage, so let's just move it to ImageLoader.
2020-06-14 19:32:23 +02:00
void ImageLoader::set_visible_in_viewport(bool visible_in_viewport) const
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
{
if (m_visible_in_viewport == visible_in_viewport)
return;
m_visible_in_viewport = visible_in_viewport;
// FIXME: Don't update volatility every time. If we're here, we're probably scanning through
// the whole document, updating "is visible in viewport" flags, and this could lead
// to the same bitmap being marked volatile back and forth unnecessarily.
if (resource())
LibWeb: Move "visible in viewport" state tracking to ImageLoader This should technically apply to any LayoutImage, so let's just move it to ImageLoader.
2020-06-14 19:32:23 +02:00
const_cast<ImageResource*>(resource())->update_volatility();
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
}
void ImageLoader::resource_did_load()
{
Everywhere: Rename ASSERT => VERIFY (...and ASSERT_NOT_REACHED => VERIFY_NOT_REACHED) Since all of these checks are done in release builds as well, let's rename them to VERIFY to prevent confusion, as everyone is used to assertions being compiled out in release. We can introduce a new ASSERT macro that is specifically for debug checks, but I'm doing this wholesale conversion first since we've accumulated thousands of these already, and it's not immediately obvious which ones are suitable for ASSERT.
2021-02-23 20:42:32 +01:00
VERIFY(resource());
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
if (!resource()->mime_type().starts_with("image/")) {
LibWeb: Until an image has loaded or failed, don't occupy layout size This patch makes images have an implicit zero intrinsic size before they have either loaded or failed to load. This is tracked by the ImageLoader object. This fixes a long-standing issue with images occupying empty 150x150 rectangles of space.
2020-08-12 13:47:55 +02:00
m_loading_state = LoadingState::Failed;
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
if (on_fail)
on_fail();
return;
}
LibWeb: Until an image has loaded or failed, don't occupy layout size This patch makes images have an implicit zero intrinsic size before they have either loaded or failed to load. This is tracked by the ImageLoader object. This fixes a long-standing issue with images occupying empty 150x150 rectangles of space.
2020-08-12 13:47:55 +02:00
m_loading_state = LoadingState::Loaded;
Everywhere: Debug macros instead of constexpr. This was done with the following script: find . \( -name '*.cpp' -o -name '*.h' -o -name '*.in' \) -not -path './Toolchain/*' -not -path './Build/*' -exec sed -i -E 's/dbgln<debug_([a-z_]+)>/dbgln<\U\1_DEBUG>/' {} \; find . \( -name '*.cpp' -o -name '*.h' -o -name '*.in' \) -not -path './Toolchain/*' -not -path './Build/*' -exec sed -i -E 's/if constexpr \(debug_([a-z0-9_]+)/if constexpr \(\U\1_DEBUG/' {} \;
2021-01-23 23:59:27 +01:00
if constexpr (IMAGE_LOADER_DEBUG) {
Everywhere: Replace a bundle of dbg with dbgln. These changes are arbitrarily divided into multiple commits to make it easier to find potentially introduced bugs with git bisect.
2021-01-17 18:17:00 +01:00
if (!resource()->has_encoded_data()) {
dbgln("ImageLoader: Resource did load, no encoded data. URL: {}", resource()->url());
} else {
dbgln("ImageLoader: Resource did load, has encoded data. URL: {}", resource()->url());
}
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
}
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
if (resource()->is_animated() && resource()->frame_count() > 1) {
m_timer->set_interval(resource()->frame_duration(0));
m_timer->on_timeout = [this] { animate(); };
m_timer->start();
LibWeb: Move bitmap animation from HTMLImageElement to ImageLoader Since ImageLoader manages the image decoder anyway, let it manage animation as well.
2020-06-14 19:26:25 +02:00
}
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
if (on_load)
on_load();
}
LibWeb: Move bitmap animation from HTMLImageElement to ImageLoader Since ImageLoader manages the image decoder anyway, let it manage animation as well.
2020-06-14 19:26:25 +02:00
void ImageLoader::animate()
{
LibWeb: Don't animate images outside the visible viewport :^)
2020-06-14 19:35:10 +02:00
if (!m_visible_in_viewport)
return;
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
m_current_frame_index = (m_current_frame_index + 1) % resource()->frame_count();
auto current_frame_duration = resource()->frame_duration(m_current_frame_index);
LibWeb: Move bitmap animation from HTMLImageElement to ImageLoader Since ImageLoader manages the image decoder anyway, let it manage animation as well.
2020-06-14 19:26:25 +02:00
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
if (current_frame_duration != m_timer->interval()) {
m_timer->restart(current_frame_duration);
LibWeb: Move bitmap animation from HTMLImageElement to ImageLoader Since ImageLoader manages the image decoder anyway, let it manage animation as well.
2020-06-14 19:26:25 +02:00
}
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
if (m_current_frame_index == resource()->frame_count() - 1) {
LibWeb: Move bitmap animation from HTMLImageElement to ImageLoader Since ImageLoader manages the image decoder anyway, let it manage animation as well.
2020-06-14 19:26:25 +02:00
++m_loops_completed;
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
if (m_loops_completed > 0 && m_loops_completed == resource()->loop_count()) {
LibWeb: Move bitmap animation from HTMLImageElement to ImageLoader Since ImageLoader manages the image decoder anyway, let it manage animation as well.
2020-06-14 19:26:25 +02:00
m_timer->stop();
}
}
if (on_animate)
on_animate();
}
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
void ImageLoader::resource_did_fail()
{
Everywhere: Replace a bundle of dbg with dbgln. These changes are arbitrarily divided into multiple commits to make it easier to find potentially introduced bugs with git bisect.
2021-01-17 18:17:00 +01:00
dbgln("ImageLoader: Resource did fail. URL: {}", resource()->url());
LibWeb: Until an image has loaded or failed, don't occupy layout size This patch makes images have an implicit zero intrinsic size before they have either loaded or failed to load. This is tracked by the ImageLoader object. This fixes a long-standing issue with images occupying empty 150x150 rectangles of space.
2020-08-12 13:47:55 +02:00
m_loading_state = LoadingState::Failed;
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
if (on_fail)
on_fail();
}
LibWeb+Browser: Decode non-animated images out-of-process :^) We now use the ImageDecoder service in LibWeb for everything except GIF images (we'll have to deal with them later, ofc.) This has a little bit of overhead but we should be able to optimize it until it becomes negligible.
2020-06-22 21:41:10 +02:00
bool ImageLoader::has_image() const
{
if (!resource())
return false;
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
return bitmap(0);
LibWeb+Browser: Decode non-animated images out-of-process :^) We now use the ImageDecoder service in LibWeb for everything except GIF images (we'll have to deal with them later, ofc.) This has a little bit of overhead but we should be able to optimize it until it becomes negligible.
2020-06-22 21:41:10 +02:00
}
unsigned ImageLoader::width() const
{
if (!resource())
return 0;
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
return bitmap(0) ? bitmap(0)->width() : 0;
LibWeb+Browser: Decode non-animated images out-of-process :^) We now use the ImageDecoder service in LibWeb for everything except GIF images (we'll have to deal with them later, ofc.) This has a little bit of overhead but we should be able to optimize it until it becomes negligible.
2020-06-22 21:41:10 +02:00
}
unsigned ImageLoader::height() const
{
if (!resource())
return 0;
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
return bitmap(0) ? bitmap(0)->height() : 0;
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
}
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
const Gfx::Bitmap* ImageLoader::bitmap(size_t frame_index) const
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
{
LibWeb+Browser: Decode non-animated images out-of-process :^) We now use the ImageDecoder service in LibWeb for everything except GIF images (we'll have to deal with them later, ofc.) This has a little bit of overhead but we should be able to optimize it until it becomes negligible.
2020-06-22 21:41:10 +02:00
if (!resource())
LibWeb: Move bitmap animation from HTMLImageElement to ImageLoader Since ImageLoader manages the image decoder anyway, let it manage animation as well.
2020-06-14 19:26:25 +02:00
return nullptr;
ImageDecoder+LibImageDecoder+LibWeb: Support animations in ImageDecoder The ImageDecoder service now returns a list of image frames, each with a duration value. The code for in-process image decoding is removed from LibWeb, an all image decode requests are sent out-of-process to ImageDecoder. :^) This won't scale super well to very long and/or large animations, but we can work on improving that separately. The main goal here is simply to stop doing any image decoding inside LibWeb. Fixes #5165.
2021-01-29 22:30:48 +01:00
return resource()->bitmap(frame_index);
LibWeb: Split out image loading logic from HTMLImageElement Since more DOM nodes are going to want to load images (<object>, ...) this patch splits out the image loading logic into an ImageLoader class and then HTMLImageElement simply has an ImageLoader. LayoutImage is then given a const ImageLoader& at construction and can then provide layout and rendering for many kinds of DOM nodes.
2020-06-13 22:22:54 +02:00
}
}
Reference in a new issue Copy permalink