UI: remove button to enable auto-save after load factory preferences
[blender.git] / source / blender / compositor / COM_compositor.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * Copyright 2011, Blender Foundation.
17  */
18
19 #ifndef __COM_COMPOSITOR_H__
20 #define __COM_COMPOSITOR_H__
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26 #include "DNA_color_types.h"
27 #include "DNA_node_types.h"
28
29 /* Keep ascii art. */
30 /* clang-format off */
31 /**
32  * \defgroup Model The data model of the compositor
33  * \defgroup Memory The memory management stuff
34  * \defgroup Execution The execution logic
35  * \defgroup Conversion Conversion logic
36  * \defgroup Node All nodes of the compositor
37  * \defgroup Operation All operations of the compositor
38  *
39  * \page Introduction of the Blender Compositor
40  *
41  * \section bcomp Blender compositor
42  * This project redesigns the internals of Blender's compositor.
43  * The project has been executed in 2011 by At Mind.
44  * At Mind is a technology company located in Amsterdam, The Netherlands.
45  * The project has been crowd-funded. This code has been released under GPL2 to be used in Blender.
46  *
47  * \section goals The goals of the project
48  * the new compositor has 2 goals.
49  *   - Make a faster compositor (speed of calculation)
50  *   - Make the compositor work faster for you (workflow)
51  *
52  * \section speed Faster compositor
53  * The speedup has been done by making better use of the hardware Blenders is working on.
54  * The previous compositor only used a single threaded model to calculate a node.
55  * The only exception to this is the Defocus node.
56  * Only when it is possible to calculate two full nodes in parallel a second thread was used.
57  * Current workstations have 8-16 threads available, and most of the time these are idle.
58  *
59  * In the new compositor we want to use as much of threads as possible.
60  * Even new OpenCL capable GPU-hardware can be used for calculation.
61  *
62  * \section workflow Work faster
63  * The previous compositor only showed the final image.
64  * The compositor could wait a long time before seeing the result of his work.
65  * The new compositor will work in a way that it will focus on
66  * getting information back to the user. It will prioritize its work to get earlier user feedback.
67  *
68  * \page memory Memory model
69  * The main issue is the type of memory model to use.
70  * Blender is used by consumers and professionals.
71  * Ranging from low-end machines to very high-end machines.
72  * The system should work on high-end machines and on low-end machines.
73  * \page executing Executing
74  * \section prepare Prepare execution
75  *
76  * during the preparation of the execution All ReadBufferOperation will receive an offset.
77  * This offset is used during execution as an optimization trick
78  * Next all operations will be initialized for execution \see NodeOperation.initExecution
79  * Next all ExecutionGroup's will be initialized for execution \see ExecutionGroup.initExecution
80  * this all is controlled from \see ExecutionSystem.execute
81  *
82  * \section priority Render priority
83  * Render priority is an priority of an output node.
84  * A user has a different need of Render priorities of output nodes
85  * than during editing.
86  * for example. the Active ViewerNode has top priority during editing,
87  * but during rendering a CompositeNode has.
88  * All NodeOperation has a setting for their render-priority,
89  * but only for output NodeOperation these have effect.
90  * In ExecutionSystem.execute all priorities are checked.
91  * For every priority the ExecutionGroup's are check if the
92  * priority do match.
93  * When match the ExecutionGroup will be executed (this happens in serial)
94  *
95  * \see ExecutionSystem.execute control of the Render priority
96  * \see NodeOperation.getRenderPriority receive the render priority
97  * \see ExecutionGroup.execute the main loop to execute a whole ExecutionGroup
98  *
99  * \section order Chunk order
100  *
101  * When a ExecutionGroup is executed, first the order of chunks are determined.
102  * The settings are stored in the ViewerNode inside the ExecutionGroup.
103  * ExecutionGroups that have no viewer-node,
104  * will use a default one.
105  * There are several possible chunk orders
106  *  - [@ref OrderOfChunks.COM_TO_CENTER_OUT]:
107  *    Start calculating from a configurable point and order by nearest chunk.
108  *  - [@ref OrderOfChunks.COM_TO_RANDOM]:
109  *    Randomize all chunks.
110  *  - [@ref OrderOfChunks.COM_TO_TOP_DOWN]:
111  *    Start calculation from the bottom to the top of the image.
112  *  - [@ref OrderOfChunks.COM_TO_RULE_OF_THIRDS]:
113  *    Experimental order based on 9 hot-spots in the image.
114  *
115  * When the chunk-order is determined, the first few chunks will be checked if they can be scheduled.
116  * Chunks can have three states:
117  *  - [@ref ChunkExecutionState.COM_ES_NOT_SCHEDULED]:
118  *    Chunk is not yet scheduled, or dependencies are not met.
119  *  - [@ref ChunkExecutionState.COM_ES_SCHEDULED]:
120  *    All dependencies are met, chunk is scheduled, but not finished.
121  *  - [@ref ChunkExecutionState.COM_ES_EXECUTED]:
122  *    Chunk is finished.
123  *
124  * \see ExecutionGroup.execute
125  * \see ViewerOperation.getChunkOrder
126  * \see OrderOfChunks
127  *
128  * \section interest Area of interest
129  * An ExecutionGroup can have dependencies to other ExecutionGroup's.
130  * Data passing from one ExecutionGroup to another one are stored in 'chunks'.
131  * If not all input chunks are available the chunk execution will not be scheduled.
132  * <pre>
133  * +-------------------------------------+              +--------------------------------------+
134  * | ExecutionGroup A                    |              | ExecutionGroup B                     |
135  * | +----------------+  +-------------+ |              | +------------+   +-----------------+ |
136  * | | NodeOperation a|  | WriteBuffer | |              | | ReadBuffer |   | ViewerOperation | |
137  * | |                *==* Operation   | |              | | Operation  *===*                 | |
138  * | |                |  |             | |              | |            |   |                 | |
139  * | +----------------+  +-------------+ |              | +------------+   +-----------------+ |
140  * |                                |    |              |   |                                  |
141  * +--------------------------------|----+              +---|----------------------------------+
142  *                                  |                       |
143  *                                  |                       |
144  *                                +---------------------------+
145  *                                | MemoryProxy               |
146  *                                | +----------+  +---------+ |
147  *                                | | Chunk a  |  | Chunk b | |
148  *                                | |          |  |         | |
149  *                                | +----------+  +---------+ |
150  *                                |                           |
151  *                                +---------------------------+
152  * </pre>
153  *
154  * In the above example ExecutionGroup B has an outputoperation (ViewerOperation)
155  * and is being executed.
156  * The first chunk is evaluated [@ref ExecutionGroup.scheduleChunkWhenPossible],
157  * but not all input chunks are available.
158  * The relevant ExecutionGroup (that can calculate the missing chunks; ExecutionGroup A)
159  * is asked to calculate the area ExecutionGroup B is missing.
160  * [@ref ExecutionGroup.scheduleAreaWhenPossible]
161  * ExecutionGroup B checks what chunks the area spans, and tries to schedule these chunks.
162  * If all input data is available these chunks are scheduled [@ref ExecutionGroup.scheduleChunk]
163  *
164  * <pre>
165  *
166  * +-------------------------+        +----------------+                           +----------------+
167  * | ExecutionSystem.execute |        | ExecutionGroup |                           | ExecutionGroup |
168  * +-------------------------+        | (B)            |                           | (A)            |
169  *            O                       +----------------+                           +----------------+
170  *            O                                |                                            |
171  *            O       ExecutionGroup.execute   |                                            |
172  *            O------------------------------->O                                            |
173  *            .                                O                                            |
174  *            .                                O-------\                                    |
175  *            .                                .       | ExecutionGroup.scheduleChunkWhenPossible
176  *            .                                .  O----/ (*)                                |
177  *            .                                .  O                                         |
178  *            .                                .  O                                         |
179  *            .                                .  O  ExecutionGroup.scheduleAreaWhenPossible|
180  *            .                                .  O---------------------------------------->O
181  *            .                                .  .                                         O----------\ ExecutionGroup.scheduleChunkWhenPossible
182  *            .                                .  .                                         .          | (*)
183  *            .                                .  .                                         .  O-------/
184  *            .                                .  .                                         .  O
185  *            .                                .  .                                         .  O
186  *            .                                .  .                                         .  O-------\ ExecutionGroup.scheduleChunk
187  *            .                                .  .                                         .  .       |
188  *            .                                .  .                                         .  .  O----/
189  *            .                                .  .                                         .  O<=O
190  *            .                                .  .                                         O<=O
191  *            .                                .  .                                         O
192  *            .                                .  O<========================================O
193  *            .                                .  O                                         |
194  *            .                                O<=O                                         |
195  *            .                                O                                            |
196  *            .                                O                                            |
197  * </pre>
198  *
199  * This happens until all chunks of (ExecutionGroup B) are finished executing or the user break's the process.
200  *
201  * NodeOperation like the ScaleOperation can influence the area of interest by reimplementing the
202  * [@ref NodeOperation.determineAreaOfInterest] method
203  *
204  * <pre>
205  *
206  * +--------------------------+                             +---------------------------------+
207  * | ExecutionGroup A         |                             | ExecutionGroup B                |
208  * |                          |                             |                                 |
209  * +--------------------------+                             +---------------------------------+
210  *           Needed chunks from ExecutionGroup A               |   Chunk of ExecutionGroup B (to be evaluated)
211  *            +-------+ +-------+                              |                  +--------+
212  *            |Chunk 1| |Chunk 2|               +----------------+                |Chunk 1 |
213  *            |       | |       |               | ScaleOperation |                |        |
214  *            +-------+ +-------+               +----------------+                +--------+
215  *
216  *            +-------+ +-------+
217  *            |Chunk 3| |Chunk 4|
218  *            |       | |       |
219  *            +-------+ +-------+
220  *
221  * </pre>
222  *
223  * \see ExecutionGroup.execute Execute a complete ExecutionGroup.
224  * Halts until finished or breaked by user
225  * \see ExecutionGroup.scheduleChunkWhenPossible Tries to schedule a single chunk,
226  * checks if all input data is available. Can trigger dependent chunks to be calculated
227  * \see ExecutionGroup.scheduleAreaWhenPossible
228  * Tries to schedule an area. This can be multiple chunks
229  * (is called from [@ref ExecutionGroup.scheduleChunkWhenPossible])
230  * \see ExecutionGroup.scheduleChunk Schedule a chunk on the WorkScheduler
231  * \see NodeOperation.determineDependingAreaOfInterest Influence the area of interest of a chunk.
232  * \see WriteBufferOperation Operation to write to a MemoryProxy/MemoryBuffer
233  * \see ReadBufferOperation Operation to read from a MemoryProxy/MemoryBuffer
234  * \see MemoryProxy proxy for information about memory image
235  * (a image consist out of multiple chunks)
236  * \see MemoryBuffer Allocated memory for a single chunk
237  *
238  * \section workscheduler WorkScheduler
239  * the WorkScheduler is implemented as a static class. the responsibility of the WorkScheduler
240  * is to balance WorkPackages to the available and free devices.
241  * the work-scheduler can work in 2 states.
242  * For witching these between the state you need to recompile blender
243  *
244  * \subsection multithread Multi threaded
245  * Default the work-scheduler will place all work as WorkPackage in a queue.
246  * For every CPUcore a working thread is created.
247  * These working threads will ask the WorkScheduler if there is work
248  * for a specific Device.
249  * the work-scheduler will find work for the device and the device
250  * will be asked to execute the WorkPackage.
251  *
252  * \subsection singlethread Single threaded
253  * For debugging reasons the multi-threading can be disabled.
254  * This is done by changing the COM_CURRENT_THREADING_MODEL
255  * to COM_TM_NOTHREAD. When compiling the work-scheduler
256  * will be changes to support no threading and run everything on the CPU.
257  *
258  * \section devices Devices
259  * A Device within the compositor context is a Hardware component that can used to calculate chunks.
260  * This chunk is encapsulated in a WorkPackage.
261  * the WorkScheduler controls the devices and selects the device where a
262  * WorkPackage will be calculated.
263  *
264  * \subsection WS_Devices Workscheduler
265  * The WorkScheduler controls all Devices.
266  * When initializing the compositor the WorkScheduler selects all
267  * devices that will be used during compositor.
268  * There are two types of Devices, CPUDevice and OpenCLDevice.
269  * When an ExecutionGroup schedules a Chunk the schedule method of the WorkScheduler
270  * The Workscheduler determines if the chunk can be run on an OpenCLDevice
271  * (and that there are available OpenCLDevice).
272  * If this is the case the chunk will be added to the worklist for OpenCLDevice's
273  * otherwise the chunk will be added to the worklist of CPUDevices.
274  *
275  * A thread will read the work-list and sends a workpackage to its device.
276  *
277  * \see WorkScheduler.schedule method that is called to schedule a chunk
278  * \see Device.execute method called to execute a chunk
279  *
280  * \subsection CPUDevice CPUDevice
281  * When a CPUDevice gets a WorkPackage the Device will get the inputbuffer that is needed to
282  * calculate the chunk. Allocation is already done by the ExecutionGroup.
283  * The outputbuffer of the chunk is being created.
284  * The OutputOperation of the ExecutionGroup is called to execute the area of the outputbuffer.
285  *
286  * \see ExecutionGroup
287  * \see NodeOperation.executeRegion executes a single chunk of a NodeOperation
288  * \see CPUDevice.execute
289  *
290  * \subsection GPUDevice OpenCLDevice
291  *
292  * To be completed!
293  * \see NodeOperation.executeOpenCLRegion
294  * \see OpenCLDevice.execute
295  *
296  * \section executePixel executing a pixel
297  * Finally the last step, the node functionality :)
298  *
299  * \page newnode Creating new nodes
300  */
301
302 /**
303  * \brief The main method that is used to execute the compositor tree.
304  * It can be executed during editing (blenkernel/node.c) or rendering
305  * (renderer/pipeline.c)
306  *
307  * \param rd: [struct RenderData]
308  *   Render data for this composite, this won't always belong to a scene.
309  *
310  * \param editingtree: [struct bNodeTree]
311  *   reference to the compositor editing tree
312  *
313  * \param rendering: [true false]
314  *    This parameter determines whether the function is called from rendering
315  *    (true) or editing (false).
316  *    based on this setting the system will work differently:
317  *     - during rendering only Composite & the File output node will be calculated
318  * \see NodeOperation.isOutputProgram(int rendering) of the specific operations
319  *
320  *     - during editing all output nodes will be calculated
321  * \see NodeOperation.isOutputProgram(int rendering) of the specific operations
322  *
323  *     - another quality setting can be used bNodeTree.
324  *       The quality is determined by the bNodeTree fields.
325  *       quality can be modified by the user from within the node panels.
326  * \see bNodeTree.edit_quality
327  * \see bNodeTree.render_quality
328  *
329  *     - output nodes can have different priorities in the WorkScheduler.
330  * This is implemented in the COM_execute function.
331  *
332  * \param viewSettings:
333  *   reference to view settings used for color management
334  *
335  * \param displaySettings:
336  *   reference to display settings used for color management
337  *
338  * OCIO_TODO: this options only used in rare cases, namely in output file node,
339  *            so probably this settings could be passed in a nicer way.
340  *            should be checked further, probably it'll be also needed for preview
341  *            generation in display space
342  */
343 /* clang-format off */
344
345 void COM_execute(RenderData *rd,
346                  Scene *scene,
347                  bNodeTree *editingtree,
348                  int rendering,
349                  const ColorManagedViewSettings *viewSettings,
350                  const ColorManagedDisplaySettings *displaySettings,
351                  const char *viewName);
352
353 /**
354  * \brief Deinitialize the compositor caches and allocated memory.
355  * Use COM_clearCaches to only free the caches.
356  */
357 void COM_deinitialize(void);
358
359 /**
360  * \brief Clear all compositor caches. (Compositor system will still remain available).
361  * To deinitialize the compositor use the COM_deinitialize method.
362  */
363 // void COM_clearCaches(void); // NOT YET WRITTEN
364
365 #ifdef __cplusplus
366 }
367 #endif
368
369 #endif /* __COM_COMPOSITOR_H__ */