blender
/
blender
133
398
Fork 579
Code Issues 6.3k Pull Requests 748 Projects 19 Wiki Activity

Use ImBuf instead of a raw buffer for compositor previews #110064

Merged
Brecht Van Lommel merged 7 commits from Kdaf/blender:compositor-node-preview-ImBuf into main 2023-07-17 20:14:00 +02:00
Conversation 3 Commits 7 Files Changed 10 +74 -104
Colin Marmond commented 2023-07-13 16:20:15 +02:00
Member
Copy Link

In order to better suit with the upcoming changes of shader node previews, this patch replaces the old implementation of the storage of the compositor previews. It also prevent memory loss for future modification.

In order to better suit with the upcoming changes of shader node previews, this patch replaces the old implementation of the storage of the compositor previews. It also prevent memory loss for future modification.
Colin Marmond added the
Interest
Compositing
Module
Render & Cycles
 labels 2023-07-13 16:20:15 +02:00
Colin Marmond added 2 commits 2023-07-13 16:20:27 +02:00
Colin Marmond requested review from Brecht Van Lommel 2023-07-13 16:21:03 +02:00
Colin Marmond requested review from Sergey Sharybin 2023-07-13 16:21:03 +02:00
Jesse Yurkovich requested changes 2023-07-13 22:23:01 +02:00
source/blender/blenkernel/intern/node.cc Outdated
@ -3136,3 +3130,1 @@
MEM_callocN(4 * xsize + xsize * ysize * sizeof(char[4]), "node preview rect"));
preview->xsize = xsize;
preview->ysize = ysize;
IMB_rect_size_set(preview->image, new uint[2]{(uint)xsize, (uint)ysize});
Jesse Yurkovich commented 2023-07-13 22:13:06 +02:00
Member
Copy Link

The IMB_rect_size_set calls are problematic (here and below). This will leak that 2-element array for starters, but it's also going to allocate the float buffer, if the size changes, which is unused in this scenario. Typically, if you know what the ImBuf is going to be up front (just byte, just float, or both), pass in the IB_* flags to the IMB_allocImBuf call above -- e.g. pass in IB_rect in your case.

If it's possible for this preview to change x,y dimensions after creation then I think it's sufficient to just call IMB_initImBuf with the new set of values. It will handle things from that point. Only call it if the size has changed though.

The `IMB_rect_size_set` calls are problematic (here and below). This will leak that 2-element array for starters, but it's also going to allocate the float buffer, if the size changes, which is unused in this scenario. Typically, if you know what the ImBuf is going to be up front (just byte, just float, or both), pass in the `IB_*` flags to the `IMB_allocImBuf` call above -- e.g. pass in `IB_rect` in your case. If it's possible for this preview to change x,y dimensions after creation then I think it's sufficient to just call `IMB_initImBuf` with the new set of values. It will handle things from that point. Only call it if the size has changed though.
Colin Marmond commented 2023-07-14 09:36:53 +02:00
Author
Member
Copy Link

I do not think they are problematic, because the float buffer is never initialised, and so the float_buffer.data is a nullptr, which will not be allocated. see rectop.cc:276. What the IMB_rect_size_set call does is just to check if the size given is the same as the size stored, and if it not the case, it will reallocate the data of the buffers already allocated.

I dont think that using IMB_initImBuf can a good option, because it will initialise with 0 the ImBuf structure and thus change the data pointers without freeing the data.

I do not think they are problematic, because the float buffer is never initialised, and so the `float_buffer.data` is a nullptr, which will not be allocated. see `rectop.cc:276`. What the `IMB_rect_size_set` call does is just to check if the size given is the same as the size stored, and if it not the case, it will reallocate the data of the buffers already allocated. I dont think that using `IMB_initImBuf` can a good option, because it will initialise with 0 the ImBuf structure and thus change the data pointers without freeing the data.
Jesse Yurkovich commented 2023-07-14 09:43:11 +02:00
Member
Copy Link

Ah, missed that memset to 0. Good spot! That leaves just the leak mentioned then.

Ah, missed that memset to 0. Good spot! That leaves just the leak mentioned then.
Colin Marmond commented 2023-07-14 09:43:57 +02:00
Author
Member
Copy Link

What leak ? Could you explain me a bit more ?
Edit: I see now what is the problem, but I dont know what is the best practice in this case; creating the array right before ?

What leak ? Could you explain me a bit more ? Edit: I see now what is the problem, but I dont know what is the best practice in this case; creating the array right before ?
Jesse Yurkovich commented 2023-07-14 09:49:21 +02:00
Member
Copy Link

The new uint[2]{(uint)xsize, (uint)ysize} leaks. No one calls delete on that array.

The `new uint[2]{(uint)xsize, (uint)ysize}` leaks. No one calls `delete` on that array.
👍 1
Kdaf marked this conversation as resolved
source/blender/editors/space_node/node_draw.cc Outdated
@ -1327,3 +1329,3 @@
/* Not a callback. */
static void node_draw_preview(bNodePreview *preview, rctf *prv)
static void node_draw_preview(Scene *sce, ImBuf *image, rctf *prv)
Jesse Yurkovich commented 2023-07-13 22:21:43 +02:00
Member
Copy Link

Maybe consider using the full word preview as the parameter/variable name here and elsewhere? It would negate the need to use the abbreviation pr_image. In either case, ensure this parameter name is consistent with the others. Here just image is used but other functions use pr_image.

Maybe consider using the full word `preview` as the parameter/variable name here and elsewhere? It would negate the need to use the abbreviation `pr_image`. In either case, ensure this parameter name is consistent with the others. Here just `image` is used but other functions use `pr_image`.
👍 1
Kdaf marked this conversation as resolved
Colin Marmond added 1 commit 2023-07-14 09:43:16 +02:00
Colin Marmond added 1 commit 2023-07-14 09:54:09 +02:00
Hans Goudey reviewed 2023-07-14 14:43:42 +02:00
source/blender/blenkernel/intern/node.cc Outdated
@ -3236,4 +3223,2 @@
} // namespace blender::bke
void BKE_node_preview_clear_tree(bNodeTree *ntree)
Hans Goudey commented 2023-07-14 14:41:31 +02:00
Member
Copy Link

Looks like this function is removed? Don't forget to remove it from the header too

Looks like this function is removed? Don't forget to remove it from the header too
Kdaf marked this conversation as resolved
source/blender/blenkernel/intern/node.cc Outdated
@ -3136,3 +3130,1 @@
MEM_callocN(4 * xsize + xsize * ysize * sizeof(char[4]), "node preview rect"));
preview->xsize = xsize;
preview->ysize = ysize;
uint size[2] = {(uint)xsize, (uint)ysize};
Hans Goudey commented 2023-07-14 14:41:14 +02:00
Member
Copy Link

const uint size[2] = {uint(xsize), uint(ysize)};

`const uint size[2] = {uint(xsize), uint(ysize)};` - Declaring variable const - Functional style cast (https://wiki.blender.org/wiki/Style_Guide/C_Cpp#C.2B.2B_Type_Cast)
Kdaf marked this conversation as resolved
source/blender/editors/space_node/node_draw.cc Outdated
@ -1327,3 +1329,3 @@
/* Not a callback. */
static void node_draw_preview(bNodePreview *preview, rctf *prv)
static void node_draw_preview(Scene *sce, ImBuf *preview, rctf *prv)
Hans Goudey commented 2023-07-14 14:42:33 +02:00
Member
Copy Link

sce -> scene

Just a more standard variable name (many more uses) that's less ugly :)

Same below

`sce` -> `scene` Just a more standard variable name (many more uses) that's less ugly :) Same below
Kdaf marked this conversation as resolved
source/blender/editors/space_node/node_draw.cc Outdated
@ -2084,3 +2082,3 @@
}
static void node_draw_extra_info_panel(TreeDrawContext &tree_draw_ctx,
static void node_draw_extra_info_panel(Scene *sce,
Hans Goudey commented 2023-07-14 14:43:35 +02:00
Member
Copy Link

Can Scene be const? Might apply elsewhere in the file too

Can `Scene` be `const`? Might apply elsewhere in the file too
Kdaf marked this conversation as resolved
Colin Marmond added 2 commits 2023-07-14 15:25:28 +02:00
Sergey Sharybin reviewed 2023-07-17 11:03:08 +02:00
Sergey Sharybin left a comment
Owner
Copy Link

I am not exactly sure what the upcoming changes you are referring to. Is there a design task for them?
Is it to allow the GPU compositor to output GPUTexture and use that as a node preview?

I am not exactly sure what the upcoming changes you are referring to. Is there a design task for them? Is it to allow the GPU compositor to output `GPUTexture` and use that as a node preview?
source/blender/makesdna/DNA_node_types.h Outdated
@ -516,3 +517,2 @@
unsigned char *rect;
short xsize, ysize;
struct ImBuf *image;
Sergey Sharybin commented 2023-07-17 11:00:55 +02:00
Owner
Copy Link

It would be much better to call it ibuf to not be confused with an Image data-block.

It would be much better to call it `ibuf` to not be confused with an `Image` data-block.
Kdaf marked this conversation as resolved
Colin Marmond commented 2023-07-17 11:13:06 +02:00
Author
Member
Copy Link

@Sergey I did not make a design task about it, but it is about the shader node previews #110065. It would be useful to draw previews as imbuf in the node_draw_preview function. The fact is that the render can deliver ImBuf directly instead of copying it to a buffer.
In this patch I want to prepare the ground for unified ImBuf drawing of previews.

@Sergey I did not make a design task about it, but it is about the shader node previews #110065. It would be useful to draw previews as imbuf in the node_draw_preview function. The fact is that the render can deliver ImBuf directly instead of copying it to a buffer. In this patch I want to prepare the ground for unified ImBuf drawing of previews.
Sergey Sharybin commented 2023-07-17 11:34:50 +02:00
Owner
Copy Link

@Kdaf Ah, I see. Thanks for clarifying.

There is one more thing in the code which is not really clear to me: the removal of the BKE_node_preview_clear_tree . It seems to cause more functional changes than just changing the way how pixels are stored and displayed on the screen.

@Kdaf Ah, I see. Thanks for clarifying. There is one more thing in the code which is not really clear to me: the removal of the `BKE_node_preview_clear_tree `. It seems to cause more functional changes than just changing the way how pixels are stored and displayed on the screen.
Colin Marmond commented 2023-07-17 11:41:53 +02:00
Author
Member
Copy Link

@Sergey
This function was only used for the material node previews which are not used (for now).
The cleaning of those shader node previews is no longer relevant (for years now).

@Sergey This function was only used for the material node previews which are not used (for now). The cleaning of those shader node previews is no longer relevant (for years now).
Colin Marmond added 1 commit 2023-07-17 14:28:11 +02:00
Brecht Van Lommel approved these changes 2023-07-17 14:37:15 +02:00
Brecht Van Lommel left a comment
Owner
Copy Link

Looks good to me now.

I had some outdated pending commits that I can't remove before submitting, will remove them after.

Looks good to me now. I had some outdated pending commits that I can't remove before submitting, will remove them after.
source/blender/compositor/operations/COM_PreviewOperation.cc Outdated
@ -53,3 +50,1 @@
preview_->xsize = get_width();
preview_->ysize = get_height();
preview_->rect = output_buffer_;
IMB_rect_size_set(output_image_, new uint[2]{get_width(), get_height()});
Brecht Van Lommel commented 2023-07-13 16:34:26 +02:00
Owner
Copy Link

This new leaks memory, just define this variable on the stack instead.

This `new` leaks memory, just define this variable on the stack instead.
brecht marked this conversation as resolved
source/blender/makesrna/intern/rna_material.cc Outdated
@ -96,10 +96,6 @@ static void rna_Material_update_previews(Main * /*bmain*/, Scene * /*scene*/, Po
{
Material *ma = (Material *)ptr->owner_id;
if (ma->nodetree) {
Brecht Van Lommel commented 2023-07-13 16:31:59 +02:00
Owner
Copy Link

This is removed because material node previews are no longer stored like this. Which is ok, just noting for clarity.

This is removed because material node previews are no longer stored like this. Which is ok, just noting for clarity.
brecht marked this conversation as resolved
Sergey Sharybin approved these changes 2023-07-17 14:40:12 +02:00
Sergey Sharybin left a comment
Owner
Copy Link

I see. ideally the BKE_node_preview_clear_tree would be removed in a separate PR, so that there is separation between removal of unused/non-relevant code and the change of the storage type used for the previous.

Less ideally it needs to be stated in the final commit message that the change removes this non-relevant function because reasons :)

The code side looks fine to me now. So more matter of logistics of how to get it into the main.

I see. ideally the `BKE_node_preview_clear_tree` would be removed in a separate PR, so that there is separation between removal of unused/non-relevant code and the change of the storage type used for the previous. Less ideally it needs to be stated in the final commit message that the change removes this non-relevant function because reasons :) The code side looks fine to me now. So more matter of logistics of how to get it into the main.
Jesse Yurkovich approved these changes 2023-07-17 20:03:48 +02:00
Brecht Van Lommel merged commit 899f8a8500 into main 2023-07-17 20:14:00 +02:00
Brecht Van Lommel deleted branch compositor-node-preview-ImBuf 2023-07-17 20:14:02 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Brecht Van Lommel
Sergey Sharybin
Jesse Yurkovich
Labels
Clear labels   
Interest
Alembic

  
Interest
Animation & Rigging

  
Interest
Asset Browser

  
Interest
Asset Browser Project Overview

  
Interest
Audio

  
Interest
Automated Testing

  
Interest
Blender Asset Bundle

  
Interest
BlendFile

  
Interest
Collada

  
Interest
Compatibility
This issue affects/is about backward or forward compatibility

  
Interest
Compositing

  
Interest
Core

  
Interest
Cycles

  
Interest
Dependency Graph

  
Interest
Development Management

  
Interest
EEVEE

  
Interest
EEVEE & Viewport

  
Interest
Freestyle

  
Interest
Geometry Nodes

  
Interest
Grease Pencil

  
Interest
ID Management

  
Interest
Images & Movies

  
Interest
Import Export

  
Interest
Line Art

  
Interest
Masking

  
Interest
Metal

  
Interest
Modeling

  
Interest
Modifiers

  
Interest
Motion Tracking

  
Interest
Nodes & Physics

  
Interest
OpenGL

  
Interest
Overlay

  
Interest
Overrides

  
Interest
Performance

  
Interest
Physics

  
Interest
Pipeline, Assets & IO

  
Interest
Platforms, Builds & Tests

  
Interest
Python API

  
Interest
Render & Cycles

  
Interest
Render Pipeline

  
Interest
Sculpt, Paint & Texture

  
Interest
Text Editor

  
Interest
Translations

  
Interest
Triaging

  
Interest
Undo

  
Interest
USD

  
Interest
User Interface

  
Interest
UV Editing

  
Interest
VFX & Video

  
Interest
Video Sequencer

  
Interest
Virtual Reality

  
Interest
Vulkan

  
Interest
Wayland
Issues relating to Wayland windowing support.

  
Interest
Workbench

  
Interest: X11

Issues relating to Xorg/X11 support.

  
Legacy
Blender 2.8 Project

  
Legacy
Milestone 1: Basic, Local Asset Browser

  
Legacy
OpenGL Error

  
Meta
Good First Issue

  
Meta
Papercut

  
Meta
Retrospective

  
Meta
Security
Issues relating to security: https://wiki.blender.org/wiki/Process/Vulnerability_Reports

  
Module
Animation & Rigging

  
Module
Core

  
Module
Development Management

  
Module
EEVEE & Viewport

  
Module
Grease Pencil

  
Module
Modeling

  
Module
Nodes & Physics

  
Module
Pipeline, Assets & IO

  
Module
Platforms, Builds & Tests

  
Module
Python API

  
Module
Render & Cycles

  
Module
Sculpt, Paint & Texture

  
Module
Triaging

  
Module
User Interface

  
Module
VFX & Video

  
Platform
FreeBSD

  
Platform
Linux

  
Platform
macOS

  
Platform
Windows

  
Priority
High

  
Priority
Low

  
Priority
Normal

  
Priority
Unbreak Now!

  
Status
Archived

  
Status
Confirmed

  
Status
Duplicate

  
Status
Needs Info from Developers

  
Status
Needs Information from User

  
Status
Needs Triage

  
Status
Resolved

  
Type
Bug

  
Type
Design

  
Type
Known Issue

  
Type
Patch

  
Type
Report

  
Type
To Do

No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
5 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#110064
No description provided.
Delete Branch "Kdaf/blender:compositor-node-preview-ImBuf"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?