archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Compositor: stream operators for WorkPackages.

Browse Source 
Helps developers during debugging.
This commit is contained in:
Jeroen Bakker
2021-04-02 15:41:16 +02:00
parent a0f705f18c
commit 210f7f0f8e
9 changed files with 382 additions and 267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
source/blender/compositor/CMakeLists.txt
View File

@@ -59,6 +59,7 @@ set(SRC
intern/COM_CompositorContext.h intern/COM_CompositorContext.h
intern/COM_Converter.cc intern/COM_Converter.cc
intern/COM_Converter.h intern/COM_Converter.h
intern/COM_Enums.cc
intern/COM_Debug.cc intern/COM_Debug.cc
intern/COM_Debug.h intern/COM_Debug.h
intern/COM_Device.cc intern/COM_Device.cc

46
source/blender/compositor/COM_defines.h
View File

@@ -52,52 +52,6 @@ constexpr int COM_data_type_num_channels(const DataType datatype)
constexpr int COM_DATA_TYPE_VALUE_CHANNELS = COM_data_type_num_channels(DataType::Value); constexpr int COM_DATA_TYPE_VALUE_CHANNELS = COM_data_type_num_channels(DataType::Value);
constexpr int COM_DATA_TYPE_COLOR_CHANNELS = COM_data_type_num_channels(DataType::Color); constexpr int COM_DATA_TYPE_COLOR_CHANNELS = COM_data_type_num_channels(DataType::Color);
/**
* \brief Possible quality settings
* \see CompositorContext.quality
* \ingroup Execution
*/
enum class CompositorQuality {
/** \brief High quality setting */
High = 0,
/** \brief Medium quality setting */
Medium = 1,
/** \brief Low quality setting */
Low = 2,
};
/**
* \brief Possible priority settings
* \ingroup Execution
*/
enum class CompositorPriority {
/** \brief High quality setting */
High = 2,
/** \brief Medium quality setting */
Medium = 1,
/** \brief Low quality setting */
Low = 0,
};
/**
* \brief the execution state of a chunk in an ExecutionGroup
* \ingroup Execution
*/
enum class eChunkExecutionState {
/**
* \brief chunk is not yet scheduled
*/
NotScheduled = 0,
/**
* \brief chunk is scheduled, but not yet executed
*/
Scheduled = 1,
/**
* \brief chunk is executed.
*/
Executed = 2,
};
// configurable items // configurable items
// chunk size determination // chunk size determination

442
source/blender/compositor/intern/COM_CompositorContext.h
View File

@@ -19,265 +19,269 @@
#pragma once #pragma once
#include "BLI_rect.h" #include "BLI_rect.h"
#include "COM_defines.h"
#include "COM_Enums.h"
#include "DNA_color_types.h" #include "DNA_color_types.h"
#include "DNA_node_types.h" #include "DNA_node_types.h"
#include "DNA_scene_types.h" #include "DNA_scene_types.h"
#include <string> #include <string>
#include <vector> #include <vector>
namespace blender::compositor { namespace blender::compositor
{
/**
* \brief Overall context of the compositor
*/
class CompositorContext {
private:
/**
* \brief The rendering field describes if we are rendering (F12) or if we are editing (Node
* editor) This field is initialized in ExecutionSystem and must only be read from that point on.
* \see ExecutionSystem
*/
bool m_rendering;
/** /**
* \brief The quality of the composite. * \brief Overall context of the compositor
* This field is initialized in ExecutionSystem and must only be read from that point on.
* \see ExecutionSystem
*/ */
CompositorQuality m_quality; class CompositorContext {
private:
/**
* \brief The rendering field describes if we are rendering (F12) or if we are editing (Node
* editor) This field is initialized in ExecutionSystem and must only be read from that point
* on. \see ExecutionSystem
*/
bool m_rendering;
Scene *m_scene; /**
* \brief The quality of the composite.
* This field is initialized in ExecutionSystem and must only be read from that point on.
* \see ExecutionSystem
*/
CompositorQuality m_quality;
/** Scene *m_scene;
* \brief Reference to the render data that is being composited.
* This field is initialized in ExecutionSystem and must only be read from that point on.
* \see ExecutionSystem
*/
RenderData *m_rd;
/** /**
* \brief reference to the bNodeTree * \brief Reference to the render data that is being composited.
* This field is initialized in ExecutionSystem and must only be read from that point on. * This field is initialized in ExecutionSystem and must only be read from that point on.
* \see ExecutionSystem * \see ExecutionSystem
*/ */
bNodeTree *m_bnodetree; RenderData *m_rd;
/** /**
* \brief Preview image hash table * \brief reference to the bNodeTree
* This field is initialized in ExecutionSystem and must only be read from that point on. * This field is initialized in ExecutionSystem and must only be read from that point on.
*/ * \see ExecutionSystem
bNodeInstanceHash *m_previews; */
bNodeTree *m_bnodetree;
/** /**
* \brief does this system have active opencl devices? * \brief Preview image hash table
*/ * This field is initialized in ExecutionSystem and must only be read from that point on.
bool m_hasActiveOpenCLDevices; */
bNodeInstanceHash *m_previews;
/** /**
* \brief Skip slow nodes * \brief does this system have active opencl devices?
*/ */
bool m_fastCalculation; bool m_hasActiveOpenCLDevices;
/* \brief color management settings */ /**
const ColorManagedViewSettings *m_viewSettings; * \brief Skip slow nodes
const ColorManagedDisplaySettings *m_displaySettings; */
bool m_fastCalculation;
/** /* \brief color management settings */
* \brief active rendering view name const ColorManagedViewSettings *m_viewSettings;
*/ const ColorManagedDisplaySettings *m_displaySettings;
const char *m_viewName;
public: /**
/** * \brief active rendering view name
* \brief constructor initializes the context with default values. */
*/ const char *m_viewName;
CompositorContext();
/** public:
* \brief set the rendering field of the context /**
*/ * \brief constructor initializes the context with default values.
void setRendering(bool rendering) */
{ CompositorContext();
this->m_rendering = rendering;
}
/** /**
* \brief get the rendering field of the context * \brief set the rendering field of the context
*/ */
bool isRendering() const void setRendering(bool rendering)
{ {
return this->m_rendering; this->m_rendering = rendering;
} }
/** /**
* \brief set the scene of the context * \brief get the rendering field of the context
*/ */
void setRenderData(RenderData *rd) bool isRendering() const
{ {
this->m_rd = rd; return this->m_rendering;
} }
/** /**
* \brief set the bnodetree of the context * \brief set the scene of the context
*/ */
void setbNodeTree(bNodeTree *bnodetree) void setRenderData(RenderData *rd)
{ {
this->m_bnodetree = bnodetree; this->m_rd = rd;
} }
/** /**
* \brief get the bnodetree of the context * \brief set the bnodetree of the context
*/ */
const bNodeTree *getbNodeTree() const void setbNodeTree(bNodeTree *bnodetree)
{ {
return this->m_bnodetree; this->m_bnodetree = bnodetree;
} }
/** /**
* \brief get the scene of the context * \brief get the bnodetree of the context
*/ */
const RenderData *getRenderData() const const bNodeTree *getbNodeTree() const
{ {
return this->m_rd; return this->m_bnodetree;
} }
void setScene(Scene *scene) /**
{ * \brief get the scene of the context
m_scene = scene; */
} const RenderData *getRenderData() const
Scene *getScene() const {
{ return this->m_rd;
return m_scene; }
}
/** void setScene(Scene *scene)
* \brief set the preview image hash table {
*/ m_scene = scene;
void setPreviewHash(bNodeInstanceHash *previews) }
{ Scene *getScene() const
this->m_previews = previews; {
} return m_scene;
}
/** /**
* \brief get the preview image hash table * \brief set the preview image hash table
*/ */
bNodeInstanceHash *getPreviewHash() const void setPreviewHash(bNodeInstanceHash *previews)
{ {
return this->m_previews; this->m_previews = previews;
} }
/** /**
* \brief set view settings of color color management * \brief get the preview image hash table
*/ */
void setViewSettings(const ColorManagedViewSettings *viewSettings) bNodeInstanceHash *getPreviewHash() const
{ {
this->m_viewSettings = viewSettings; return this->m_previews;
} }
/** /**
* \brief get view settings of color color management * \brief set view settings of color color management
*/ */
const ColorManagedViewSettings *getViewSettings() const void setViewSettings(const ColorManagedViewSettings *viewSettings)
{ {
return this->m_viewSettings; this->m_viewSettings = viewSettings;
} }
/** /**
* \brief set display settings of color color management * \brief get view settings of color color management
*/ */
void setDisplaySettings(const ColorManagedDisplaySettings *displaySettings) const ColorManagedViewSettings *getViewSettings() const
{ {
this->m_displaySettings = displaySettings; return this->m_viewSettings;
} }
/** /**
* \brief get display settings of color color management * \brief set display settings of color color management
*/ */
const ColorManagedDisplaySettings *getDisplaySettings() const void setDisplaySettings(const ColorManagedDisplaySettings *displaySettings)
{ {
return this->m_displaySettings; this->m_displaySettings = displaySettings;
} }
/** /**
* \brief set the quality * \brief get display settings of color color management
*/ */
void setQuality(CompositorQuality quality) const ColorManagedDisplaySettings *getDisplaySettings() const
{ {
this->m_quality = quality; return this->m_displaySettings;
} }
/** /**
* \brief get the quality * \brief set the quality
*/ */
CompositorQuality getQuality() const void setQuality(CompositorQuality quality)
{ {
return this->m_quality; this->m_quality = quality;
} }
/** /**
* \brief get the current frame-number of the scene in this context * \brief get the quality
*/ */
int getFramenumber() const; CompositorQuality getQuality() const
{
return this->m_quality;
}
/** /**
* \brief has this system active openclDevices? * \brief get the current frame-number of the scene in this context
*/ */
bool getHasActiveOpenCLDevices() const int getFramenumber() const;
{
return this->m_hasActiveOpenCLDevices;
}
/** /**
* \brief set has this system active openclDevices? * \brief has this system active openclDevices?
*/ */
void setHasActiveOpenCLDevices(bool hasAvtiveOpenCLDevices) bool getHasActiveOpenCLDevices() const
{ {
this->m_hasActiveOpenCLDevices = hasAvtiveOpenCLDevices; return this->m_hasActiveOpenCLDevices;
} }
/** /**
* \brief get the active rendering view * \brief set has this system active openclDevices?
*/ */
const char *getViewName() const void setHasActiveOpenCLDevices(bool hasAvtiveOpenCLDevices)
{ {
return this->m_viewName; this->m_hasActiveOpenCLDevices = hasAvtiveOpenCLDevices;
} }
/** /**
* \brief set the active rendering view * \brief get the active rendering view
*/ */
void setViewName(const char *viewName) const char *getViewName() const
{ {
this->m_viewName = viewName; return this->m_viewName;
} }
int getChunksize() const /**
{ * \brief set the active rendering view
return this->getbNodeTree()->chunksize; */
} void setViewName(const char *viewName)
{
this->m_viewName = viewName;
}
void setFastCalculation(bool fastCalculation) int getChunksize() const
{ {
this->m_fastCalculation = fastCalculation; return this->getbNodeTree()->chunksize;
} }
bool isFastCalculation() const
{
return this->m_fastCalculation;
}
bool isGroupnodeBufferEnabled() const
{
return (this->getbNodeTree()->flag & NTREE_COM_GROUPNODE_BUFFER) != 0;
}
/** void setFastCalculation(bool fastCalculation)
* \brief Get the render percentage as a factor. {
* The compositor uses a factor i.o. a percentage. this->m_fastCalculation = fastCalculation;
*/ }
float getRenderPercentageAsFactor() const bool isFastCalculation() const
{ {
return m_rd->size * 0.01f; return this->m_fastCalculation;
} }
}; bool isGroupnodeBufferEnabled() const
{
return (this->getbNodeTree()->flag & NTREE_COM_GROUPNODE_BUFFER) != 0;
}
/**
* \brief Get the render percentage as a factor.
* The compositor uses a factor i.o. a percentage.
*/
float getRenderPercentageAsFactor() const
{
return m_rd->size * 0.01f;
}
};
} // namespace blender::compositor } // namespace blender::compositor

61
source/blender/compositor/intern/COM_Enums.cc Normal file
View File

@@ -0,0 +1,61 @@
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright 2021, Blender Foundation.
*/
#include "COM_Enums.h"
namespace blender::compositor {
std::ostream &operator<<(std::ostream &os, const CompositorPriority &priority)
{
switch (priority) {
case CompositorPriority::High: {
os << "Priority::High";
break;
}
case CompositorPriority::Medium: {
os << "Priority::Medium";
break;
}
case CompositorPriority::Low: {
os << "Priority::Low";
break;
}
}
return os;
}
std::ostream &operator<<(std::ostream &os, const eChunkExecutionState &execution_state)
{
switch (execution_state) {
case eChunkExecutionState::NotScheduled: {
os << "ExecutionState::NotScheduled";
break;
}
case eChunkExecutionState::Scheduled: {
os << "ExecutionState::Scheduled";
break;
}
case eChunkExecutionState::Executed: {
os << "ExecutionState::Executed";
break;
}
}
return os;
}
} // namespace blender::compositor

76
source/blender/compositor/intern/COM_Enums.h Normal file
View File

@@ -0,0 +1,76 @@
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright 2021, Blender Foundation.
*/
#pragma once
#include "COM_defines.h"
#include <ostream>
namespace blender::compositor {
/**
* \brief Possible quality settings
* \see CompositorContext.quality
* \ingroup Execution
*/
enum class CompositorQuality {
/** \brief High quality setting */
High = 0,
/** \brief Medium quality setting */
Medium = 1,
/** \brief Low quality setting */
Low = 2,
};
/**
* \brief Possible priority settings
* \ingroup Execution
*/
enum class CompositorPriority {
/** \brief High quality setting */
High = 2,
/** \brief Medium quality setting */
Medium = 1,
/** \brief Low quality setting */
Low = 0,
};
/**
* \brief the execution state of a chunk in an ExecutionGroup
* \ingroup Execution
*/
enum class eChunkExecutionState {
/**
* \brief chunk is not yet scheduled
*/
NotScheduled = 0,
/**
* \brief chunk is scheduled, but not yet executed
*/
Scheduled = 1,
/**
* \brief chunk is executed.
*/
Executed = 2,
};
std::ostream &operator<<(std::ostream &os, const CompositorPriority &priority);
std::ostream &operator<<(std::ostream &os, const eChunkExecutionState &execution_state);
} // namespace blender::compositor

1
source/blender/compositor/intern/COM_NodeOperation.h
View File

@@ -26,6 +26,7 @@
#include "BLI_math_vector.h" #include "BLI_math_vector.h"
#include "BLI_threads.h" #include "BLI_threads.h"
#include "COM_Enums.h"
#include "COM_MemoryBuffer.h" #include "COM_MemoryBuffer.h"
#include "COM_MemoryProxy.h" #include "COM_MemoryProxy.h"
#include "COM_MetaData.h" #include "COM_MetaData.h"

14
source/blender/compositor/intern/COM_WorkPackage.cc
View File

@@ -18,6 +18,20 @@
#include "COM_WorkPackage.h" #include "COM_WorkPackage.h"
#include "COM_Enums.h"
#include "COM_ExecutionGroup.h"
namespace blender::compositor { namespace blender::compositor {
std::ostream &operator<<(std::ostream &os, const WorkPackage &work_package)
{
os << "WorkPackage(execution_group=" << *work_package.execution_group;
os << ",chunk=" << work_package.chunk_number;
os << ",state=" << work_package.state;
os << ",rect=(" << work_package.rect.xmin << "," << work_package.rect.ymin << ")-("
<< work_package.rect.xmax << "," << work_package.rect.ymax << ")";
os << ")";
return os;
}
} // namespace blender::compositor } // namespace blender::compositor

6
source/blender/compositor/intern/COM_WorkPackage.h
View File

@@ -18,10 +18,12 @@
#pragma once #pragma once
#include "COM_defines.h" #include "COM_Enums.h"
#include "BLI_rect.h" #include "BLI_rect.h"
#include <ostream>
namespace blender::compositor { namespace blender::compositor {
// Forward Declarations. // Forward Declarations.
class ExecutionGroup; class ExecutionGroup;
@@ -53,4 +55,6 @@ struct WorkPackage {
#endif #endif
}; };
std::ostream &operator<<(std::ostream &os, const WorkPackage &WorkPackage);
} // namespace blender::compositor } // namespace blender::compositor

2
source/blender/compositor/operations/COM_QualityStepHelper.h
View File

@@ -18,7 +18,7 @@
#pragma once #pragma once
#include "COM_defines.h" #include "COM_Enums.h"
namespace blender::compositor { namespace blender::compositor {