Compositor: stream operators for WorkPackages.

Helps developers during debugging.

source/blender/compositor/CMakeLists.txt

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

source/blender/compositor/COM_defines.h

@@ -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_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
 
 // chunk size determination

source/blender/compositor/intern/COM_CompositorContext.h

@@ -19,14 +19,18 @@
 #pragma once
 
 #include "BLI_rect.h"
-#include "COM_defines.h"
+
+#include "COM_Enums.h"
+
 #include "DNA_color_types.h"
 #include "DNA_node_types.h"
 #include "DNA_scene_types.h"
+
 #include <string>
 #include <vector>
 
-namespace blender::compositor {
+    namespace blender::compositor
+{
 
   /**
    * \brief Overall context of the compositor
@@ -35,8 +39,8 @@ 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.
+     * editor) This field is initialized in ExecutionSystem and must only be read from that point
-   * \see ExecutionSystem
+     * on. \see ExecutionSystem
      */
     bool m_rendering;
 

source/blender/compositor/intern/COM_Enums.cc

@@ -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

source/blender/compositor/intern/COM_Enums.h

@@ -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

source/blender/compositor/intern/COM_NodeOperation.h

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

source/blender/compositor/intern/COM_WorkPackage.cc

@@ -18,6 +18,20 @@
 
 #include "COM_WorkPackage.h"
 
+#include "COM_Enums.h"
+#include "COM_ExecutionGroup.h"
+
 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

source/blender/compositor/intern/COM_WorkPackage.h

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

source/blender/compositor/operations/COM_QualityStepHelper.h

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