[Bf-blender-cvs] [45b46e5de9f] master: Compositor: Buffer iterators

Manuel Castilla noreply at git.blender.org
Mon Jul 19 22:06:46 CEST 2021


Commit: 45b46e5de9fbfb4985d81ac43cf61a6dcb339ff7
Author: Manuel Castilla
Date:   Mon Jul 19 17:55:46 2021 +0200
Branches: master
https://developer.blender.org/rB45b46e5de9fbfb4985d81ac43cf61a6dcb339ff7

Compositor: Buffer iterators

Currently we mostly iterate buffer areas using x/y loops or through
utility methods extending from base classes.

To simplify code in simple operations this commit adds wrappers for
specifying buffer areas and their iterators for raw buffers with any
element stride:
- BufferRange: Specifies a range of contiguous buffer elements from a
 given element index.
- BufferRangeIterator: Iterates elements in a BufferRange.
- BufferArea: Specifies a rectangle area of elements in a 2D buffer.
- BufferAreaIterator: Iterates elements in a BufferArea.
- BuffersIterator: Simultaneously iterates an area of elements in an
 output buffer and any number of input buffers.
- BuffersIteratorBuilder: Helper for building BuffersIterator adding
 buffers one by one.
For iterating areas coordinates it adds `XRange` and `YRange` methods
that return `IndexRange`.

Reviewed By: jbakker

Differential Revision: https://developer.blender.org/D11882

===================================================================

M	source/blender/compositor/CMakeLists.txt
M	source/blender/compositor/COM_defines.h
A	source/blender/compositor/intern/COM_BufferArea.h
A	source/blender/compositor/intern/COM_BufferRange.h
A	source/blender/compositor/intern/COM_BuffersIterator.h
M	source/blender/compositor/intern/COM_MemoryBuffer.cc
M	source/blender/compositor/intern/COM_MemoryBuffer.h

===================================================================

diff --git a/source/blender/compositor/CMakeLists.txt b/source/blender/compositor/CMakeLists.txt
index 20b56ceb55f..830792a2a48 100644
--- a/source/blender/compositor/CMakeLists.txt
+++ b/source/blender/compositor/CMakeLists.txt
@@ -49,8 +49,11 @@ set(SRC
   COM_compositor.h
   COM_defines.h
 
+  intern/COM_BufferArea.h
   intern/COM_BufferOperation.cc
   intern/COM_BufferOperation.h
+  intern/COM_BufferRange.h
+  intern/COM_BuffersIterator.h
   intern/COM_CPUDevice.cc
   intern/COM_CPUDevice.h
   intern/COM_ChunkOrder.cc
diff --git a/source/blender/compositor/COM_defines.h b/source/blender/compositor/COM_defines.h
index 9f8e6f10215..0e97bafbb0b 100644
--- a/source/blender/compositor/COM_defines.h
+++ b/source/blender/compositor/COM_defines.h
@@ -18,6 +18,9 @@
 
 #pragma once
 
+#include "BLI_index_range.hh"
+#include "BLI_rect.h"
+
 namespace blender::compositor {
 
 enum class eExecutionModel {
@@ -109,4 +112,24 @@ constexpr float COM_PREVIEW_SIZE = 140.f;
 constexpr float COM_RULE_OF_THIRDS_DIVIDER = 100.0f;
 constexpr float COM_BLUR_BOKEH_PIXELS = 512;
 
+constexpr IndexRange XRange(const rcti &area)
+{
+  return IndexRange(area.xmin, area.xmax - area.xmin);
+}
+
+constexpr IndexRange YRange(const rcti &area)
+{
+  return IndexRange(area.ymin, area.ymax - area.ymin);
+}
+
+constexpr IndexRange XRange(const rcti *area)
+{
+  return XRange(*area);
+}
+
+constexpr IndexRange YRange(const rcti *area)
+{
+  return YRange(*area);
+}
+
 }  // namespace blender::compositor
diff --git a/source/blender/compositor/intern/COM_BufferArea.h b/source/blender/compositor/intern/COM_BufferArea.h
new file mode 100644
index 00000000000..621ffea5bc3
--- /dev/null
+++ b/source/blender/compositor/intern/COM_BufferArea.h
@@ -0,0 +1,198 @@
+/*
+ * 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 "BLI_rect.h"
+
+#include <iterator>
+
+namespace blender::compositor {
+
+/* Forward declarations. */
+template<typename T> class BufferAreaIterator;
+
+/**
+ * A rectangle area of buffer elements.
+ */
+template<typename T> class BufferArea : rcti {
+ public:
+  using Iterator = BufferAreaIterator<T>;
+  using ConstIterator = BufferAreaIterator<const T>;
+
+ private:
+  T *buffer_;
+  /* Number of elements in a buffer row. */
+  int buffer_width_;
+  /* Buffer element stride. */
+  int elem_stride_;
+
+ public:
+  constexpr BufferArea() = default;
+
+  /**
+   * Create a buffer area containing given rectangle area.
+   */
+  constexpr BufferArea(T *buffer, int buffer_width, const rcti &area, int elem_stride = 1)
+      : rcti(area), buffer_(buffer), buffer_width_(buffer_width), elem_stride_(elem_stride)
+  {
+  }
+
+  /**
+   * Create a buffer area containing whole buffer with no offsets.
+   */
+  constexpr BufferArea(T *buffer, int buffer_width, int buffer_height, int elem_stride = 1)
+      : buffer_(buffer), buffer_width_(buffer_width), elem_stride_(elem_stride)
+  {
+    BLI_rcti_init(this, 0, buffer_width, 0, buffer_height);
+  }
+
+  constexpr friend bool operator==(const BufferArea &a, const BufferArea &b)
+  {
+    return a.buffer_ == b.buffer_ && BLI_rcti_compare(&a, &b) && a.elem_stride_ == b.elem_stride_;
+  }
+
+  constexpr const rcti &get_rect() const
+  {
+    return *this;
+  }
+
+  /**
+   * Number of elements in a row.
+   */
+  constexpr int width() const
+  {
+    return BLI_rcti_size_x(this);
+  }
+
+  /**
+   * Number of elements in a column.
+   */
+  constexpr int height() const
+  {
+    return BLI_rcti_size_y(this);
+  }
+
+  constexpr Iterator begin()
+  {
+    return begin_iterator<Iterator>();
+  }
+
+  constexpr Iterator end()
+  {
+    return end_iterator<Iterator>();
+  }
+
+  constexpr ConstIterator begin() const
+  {
+    return begin_iterator<ConstIterator>();
+  }
+
+  constexpr ConstIterator end() const
+  {
+    return end_iterator<ConstIterator>();
+  }
+
+ private:
+  template<typename TIterator> constexpr TIterator begin_iterator() const
+  {
+    if (elem_stride_ == 0) {
+      /* Iterate a single element. */
+      return TIterator(buffer_, 1, 1, 1);
+    }
+
+    T *begin_ptr = buffer_ + (intptr_t)this->ymin * buffer_width_ * elem_stride_ +
+                   (intptr_t)this->xmin * elem_stride_;
+    return TIterator(begin_ptr, buffer_width_, BLI_rcti_size_x(this), elem_stride_);
+  }
+
+  template<typename TIterator> constexpr TIterator end_iterator() const
+  {
+    if (elem_stride_ == 0) {
+      /* Iterate a single element. */
+      return TIterator(buffer_ + 1, 1, 1, 1);
+    }
+
+    T *end_ptr = buffer_ + (intptr_t)(this->ymax - 1) * buffer_width_ * elem_stride_ +
+                 (intptr_t)this->xmax * elem_stride_;
+    return TIterator(end_ptr, buffer_width_, BLI_rcti_size_x(this), elem_stride_);
+  }
+};
+
+template<typename T> class BufferAreaIterator {
+ public:
+  using iterator_category = std::input_iterator_tag;
+  using value_type = T *;
+  using pointer = T *const *;
+  using reference = T *const &;
+  using difference_type = std::ptrdiff_t;
+
+ private:
+  int elem_stride_;
+  int row_stride_;
+  /* Stride between a row end and the next row start. */
+  int rows_gap_;
+  T *current_;
+  const T *row_end_;
+
+ public:
+  constexpr BufferAreaIterator() = default;
+
+  constexpr BufferAreaIterator(T *current, int buffer_width, int area_width, int elem_stride = 1)
+      : elem_stride_(elem_stride),
+        row_stride_(buffer_width * elem_stride),
+        rows_gap_(row_stride_ - area_width * elem_stride),
+        current_(current),
+        row_end_(current + area_width * elem_stride)
+  {
+  }
+
+  constexpr BufferAreaIterator &operator++()
+  {
+    current_ += elem_stride_;
+    if (current_ == row_end_) {
+      current_ += rows_gap_;
+      row_end_ += row_stride_;
+    }
+    return *this;
+  }
+
+  constexpr BufferAreaIterator operator++(int) const
+  {
+    BufferAreaIterator copied_iterator = *this;
+    ++copied_iterator;
+    return copied_iterator;
+  }
+
+  constexpr friend bool operator!=(const BufferAreaIterator &a, const BufferAreaIterator &b)
+  {
+    return a.current_ != b.current_;
+  }
+
+  constexpr friend bool operator==(const BufferAreaIterator &a, const BufferAreaIterator &b)
+  {
+    return a.current_ == b.current_;
+  }
+
+  constexpr T *operator*() const
+  {
+    return current_;
+  }
+};
+
+}  // namespace blender::compositor
diff --git a/source/blender/compositor/intern/COM_BufferRange.h b/source/blender/compositor/intern/COM_BufferRange.h
new file mode 100644
index 00000000000..ffdf1f2f1e5
--- /dev/null
+++ b/source/blender/compositor/intern/COM_BufferRange.h
@@ -0,0 +1,171 @@
+/*
+ * 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 "BLI_assert.h"
+#include "BLI_rect.h"
+
+#include <iterator>
+
+namespace blender::compositor {
+
+/* Forward declarations. */
+template<typename T> class BufferRangeIterator;
+
+/**
+ * A range of buffer elements.
+ */
+template<typename T> class BufferRange {
+ public:
+  using Iterator = BufferRangeIterator<T>;
+  using ConstIterator = BufferRangeIterator<const T>;
+
+ private:
+  T *start_;
+  /* Number of elements in the range. */
+  int64_t size_;
+  /* Buffer element stride. */
+  int elem_stride_;
+
+ public:
+  constexpr BufferRange() = default;
+
+  /**
+   * Create a buffer range of elements from a given element index.
+   */
+  constexpr BufferRange(T *buffer, int64_t start_elem_index, int64_t size, int elem_stride = 1)
+      : start_(buffer + start_elem_index * elem_stride), size_(size), elem_stride_(elem_stride)
+  {
+  }
+
+  constexpr friend bool operator==(const BufferRange &a, const BufferRange &b)
+  {
+    return a.start_ == b.start_ && a.size_ == b.size_ && a.elem_stride_ == b.elem_stride_;
+  }
+
+  /**
+   * Access an element in the range. Index is relative to range start.
+   */
+  constexpr T *operator[](int64_t index) const
+  {
+    BLI_assert(index >= 0);
+    BLI_assert(index < this->size());
+    return start_ + index * elem_stride_;
+  }
+
+  /**
+   * Get the number of elements in the range.
+   */
+  constexpr int64_t size() const
+  {
+    return size_;
+  }
+
+  constexpr Iterator begin()
+  {
+    return begin_iterator<Iterator>();
+  }
+
+  constexpr Iterator end()
+  {
+    return end_iterator<Iterator>();
+  }
+
+  constexpr ConstIterator begin() const
+  {
+    return begin_iterator<ConstIterator>();
+  }
+
+  constexpr ConstIterator end() const
+  {
+    return end_iterator<ConstIterator>();
+  }
+
+ private:
+  template<typename TIterator> constexpr TIterator begin_iterator() const
+  {
+    if (elem_stride_ == 0) {
+      /* Iterate a single element. */
+      return TIterator(start_, 1);
+    }
+
+    return TIterator(start_, elem_stride_);
+  }
+
+  template<typename TIterator> constexpr TIterator end_iterator() const
+  {

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list